summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVipul A M <vipulnsward@gmail.com>2014-07-03 10:46:53 +0530
committerFlorian Frank <flori@ping.de>2015-01-02 23:48:11 +0100
commit1f339fe8d3fd015886d09c06806ddcd128ecf810 (patch)
treea447e4a304e51ea89f9c8c99de6def48cc71b2ac
parent435c25866d7a90d2eea53ca599f27482ea7ec2c4 (diff)
downloadjson-1f339fe8d3fd015886d09c06806ddcd128ecf810.tar.gz
Document `Rational` json generation methods.
-rw-r--r--lib/json/add/rational.rb14
1 files changed, 10 insertions, 4 deletions
diff --git a/lib/json/add/rational.rb b/lib/json/add/rational.rb
index 867cd92..c100d13 100644
--- a/lib/json/add/rational.rb
+++ b/lib/json/add/rational.rb
@@ -4,19 +4,25 @@ end
defined?(::Rational) or require 'rational'
class Rational
+
+ # Deserializes JSON string by converting numerator value <tt>n</tt>, denominator
+ # value <tt>d</tt>, to a Rational object.
def self.json_create(object)
Rational(object['n'], object['d'])
end
+ # Returns a hash, that will be turned into a JSON object and represent this
+ # object.
def as_json(*)
{
- JSON.create_id => self.class.name,
- 'n' => numerator,
- 'd' => denominator,
+ JSON.create_id => self.class.name,
+ 'n' => numerator,
+ 'd' => denominator,
}
end
+ # Stores class name (Rational) along with numerator value <tt>n</tt> and denominator value <tt>d</tt> as JSON string
def to_json(*)
as_json.to_json
end
-end
+end \ No newline at end of file