json 1.5.1-java → 1.5.2-java

data/lib/json.rb

@@ -1,3 +1,55 @@
+##
+# = JavaScript Object Notation (JSON)
+#
+# JSON is a lightweight data-interchange format. It is easy for us
+# humans to read and write. Plus, equally simple for machines to generate or parse.
+# JSON is completely language agnostic, making it the ideal interchange format.
+#
+# Built on two universally available structures:
+#   1. A collection of name/value pairs. Often referred to as an _object_, hash table, record, struct, keyed list, or associative array.
+#   2. An orderd list of values. More commonly named as an _array_, vector, sequence, or list.
+#
+# To read more about JSON visit: http://json.org
+#
+# == Parsing JSON
+#
+# To parse a JSON string received by another application, or generated within
+# your existing application:
+#   
+#   require 'json'
+#
+#   my_hash = JSON.parse('{"hello": "goodbye"}')
+#   puts my_hash["hello"] => "goodbye"
+#
+# Notice the extra quotes <tt>''</tt> around the hash notation. Ruby expects
+# the argument to be a string and can't convert objects like a hash or array.
+#
+# Ruby converts your string into a hash
+#
+# == Generating JSON
+#
+# Creating a JSON string for communication or serialization is
+# just as simple.
+#
+#   require 'json'
+#   
+#   my_hash = {:hello => "goodbye"}
+#   puts JSON.generate(my_hash) => "{\"hello\":\"goodbye\"}"
+#
+# Or an alternative way:
+#
+#   require 'json'
+#   puts {:hello => "goodbye"}.to_json => "{\"hello\":\"goodbye\"}"
+#
+# <tt>JSON.generate</tt> only allows objects or arrays to be converted 
+# to JSON syntax. While <tt>to_json</tt> accepts many Ruby classes 
+# even though it only acts a method for serialization:
+#
+#   require 'json'
+#
+#   1.to_json => "1"
+#
+
 require 'json/common'
 module JSON
   require 'json/version'

data/lib/json/add/core.rb

@@ -6,20 +6,26 @@ unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
 end
 require 'date'
 
+# Symbol serialization/deserialization
 class Symbol
+  # Stores class name (Symbol) with String representation of Symbol as a JSON string.
   def to_json(*a)
     {
       JSON.create_id => self.class.name,
       's' => to_s,
     }.to_json(*a)
   end
-
+  
+  # Deserializes JSON string by converting the <tt>string</tt> value stored in the object to a Symbol
   def self.json_create(o)
     o['s'].to_sym
   end
 end
 
+# Time serialization/deserialization
 class Time
+
+  # Deserializes JSON string by converting time since epoch to Time
   def self.json_create(object)
     if usec = object.delete('u') # used to be tv_usec -> tv_nsec
       object['n'] = usec * 1000
@@ -30,7 +36,8 @@ class Time
       at(object['s'], object['n'] / 1000)
     end
   end
-
+  
+  # Stores class name (Time) with number of seconds since epoch and number of microseconds for Time as JSON string
   def to_json(*args)
     {
       JSON.create_id => self.class.name,
@@ -40,13 +47,17 @@ class Time
   end
 end
 
+# Date serialization/deserialization
 class Date
+  
+  # Deserializes JSON string by converting Julian year <tt>y</tt>, month <tt>m</tt>, day <tt>d</tt> and Day of Calendar Reform <tt>sg</tt> to Date.
   def self.json_create(object)
     civil(*object.values_at('y', 'm', 'd', 'sg'))
   end
 
   alias start sg unless method_defined?(:start)
-
+  
+  # Stores class name (Date) with Julian year <tt>y</tt>, month <tt>m</tt>, day <tt>d</tt> and Day of Calendar Reform <tt>sg</tt> as JSON string
   def to_json(*args)
     {
       JSON.create_id => self.class.name,
@@ -58,7 +69,10 @@ class Date
   end
 end
 
+# DateTime serialization/deserialization
 class DateTime
+
+  # Deserializes JSON string by converting year <tt>y</tt>, month <tt>m</tt>, day <tt>d</tt>, hour <tt>H</tt>, minute <tt>M</tt>, second <tt>S</tt>, offset <tt>of</tt> and Day of Calendar Reform <tt>sg</tt> to DateTime.
   def self.json_create(object)
     args = object.values_at('y', 'm', 'd', 'H', 'M', 'S')
     of_a, of_b = object['of'].split('/')
@@ -72,7 +86,8 @@ class DateTime
   end
 
   alias start sg unless method_defined?(:start)
-
+  
+  # Stores class name (DateTime) with Julian year <tt>y</tt>, month <tt>m</tt>, day <tt>d</tt>, hour <tt>H</tt>, minute <tt>M</tt>, second <tt>S</tt>, offset <tt>of</tt> and Day of Calendar Reform <tt>sg</tt> as JSON string
   def to_json(*args)
     {
       JSON.create_id => self.class.name,
@@ -88,11 +103,15 @@ class DateTime
   end
 end
 
+# Range serialization/deserialization
 class Range
+  
+  # Deserializes JSON string by constructing new Range object with arguments <tt>a</tt> serialized by <tt>to_json</tt>.
   def self.json_create(object)
     new(*object['a'])
   end
 
+  # Stores class name (Range) with JSON array of arguments <tt>a</tt> which include <tt>first</tt> (integer), <tt>last</tt> (integer), and <tt>exclude_end?</tt> (boolean) as JSON string.
   def to_json(*args)
     {
       JSON.create_id   => self.class.name,
@@ -101,11 +120,15 @@ class Range
   end
 end
 
+# Struct serialization/deserialization
 class Struct
+  
+  # Deserializes JSON string by constructing new Struct object with values <tt>v</tt> serialized by <tt>to_json</tt>.
   def self.json_create(object)
     new(*object['v'])
   end
 
+  # Stores class name (Struct) with Struct values <tt>v</tt> as a JSON string. Only named structs are supported.
   def to_json(*args)
     klass = self.class.name
     klass.to_s.empty? and raise JSON::JSONError, "Only named structs are supported!"
@@ -116,13 +139,17 @@ class Struct
   end
 end
 
+# Exception serialization/deserialization
 class Exception
+
+  # Deserializes JSON string by constructing new Exception object with message <tt>m</tt> and backtrace <tt>b</tt> serialized with <tt>to_json</tt>
   def self.json_create(object)
     result = new(object['m'])
     result.set_backtrace object['b']
     result
   end
 
+  # Stores class name (Exception) with message <tt>m</tt> and backtrace array <tt>b</tt> as JSON string
   def to_json(*args)
     {
       JSON.create_id => self.class.name,
@@ -132,11 +159,15 @@ class Exception
   end
 end
 
+# Regexp serialization/deserialization
 class Regexp
+
+  # Deserializes JSON string by constructing new Regexp object with source <tt>s</tt> (Regexp or String) and options <tt>o</tt> serialized by <tt>to_json</tt>
   def self.json_create(object)
     new(object['s'], object['o'])
   end
 
+  # Stores class name (Regexp) with options <tt>o</tt> and source <tt>s</tt> (Regexp or String) as JSON string
   def to_json(*)
     {
       JSON.create_id => self.class.name,

data/lib/json/common.rb

@@ -291,7 +291,8 @@ module JSON
     recurse_proc(result, &proc) if proc
     result
   end
-
+  
+  # Recursively calls passed _Proc_ if the parsed data structure is an _Array_ or _Hash_
   def recurse_proc(result, &proc)
     case result
     when Array
@@ -351,11 +352,13 @@ module JSON
 
   # Shortuct for iconv.
   if ::String.method_defined?(:encode)
+    # Encodes string using Ruby's _String.encode_
     def self.iconv(to, from, string)
       string.encode(to, from)
     end
   else
     require 'iconv'
+    # Encodes string using _iconv_ library
     def self.iconv(to, from, string)
       Iconv.iconv(to, from, string).first
     end
@@ -408,6 +411,7 @@ module ::Kernel
   end
 end
 
+# Extends any Class to include _json_creatable?_ method.
 class ::Class
   # Returns true, if this class can be used to create an instance
   # from a serialised JSON string. The class has to implement a class

data/lib/json/pure/generator.rb

@@ -99,7 +99,7 @@ module JSON
   module Pure
     module Generator
       # This class is used to create State instances, that are use to hold data
-      # while generating a JSON text from a a Ruby data structure.
+      # while generating a JSON text from a Ruby data structure.
       class State
         # Creates a State object from _opts_, which ought to be Hash to create
         # a new State instance configured by _opts_, something else to create

data/lib/json/version.rb

@@ -1,6 +1,6 @@
 module JSON
   # JSON version
-  VERSION         = '1.5.1'
+  VERSION         = '1.5.2'
   VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/tests/test_json.rb

@@ -154,7 +154,16 @@ class TC_JSON < Test::Unit::TestCase
       , [2718.0E-3 ],\r[ null] , [[1, -2, 3 ]], [false ],[ true]\n ]  }))
   end
 
-  class SubArray < Array; end
+  class SubArray < Array
+    def <<(v)
+      @shifted = true
+      super
+    end
+
+    def shifted?
+      @shifted
+    end
+  end
 
   class SubArray2 < Array
     def to_json(*a)
@@ -171,9 +180,10 @@ class TC_JSON < Test::Unit::TestCase
   end
 
   def test_parse_array_custom_class
-    res = parse('[]', :array_class => SubArray)
-    assert_equal([], res)
+    res = parse('[1,2]', :array_class => SubArray)
+    assert_equal([1,2], res)
     assert_equal(SubArray, res.class)
+    assert res.shifted?
   end
 
   def test_parse_object
@@ -184,6 +194,14 @@ class TC_JSON < Test::Unit::TestCase
   end
 
   class SubHash < Hash
+    def []=(k, v)
+      @item_set = true
+      super
+    end
+
+    def item_set?
+      @item_set
+    end
   end
 
   class SubHash2 < Hash
@@ -200,9 +218,10 @@ class TC_JSON < Test::Unit::TestCase
   end
 
   def test_parse_object_custom_class
-    res = parse('{}', :object_class => SubHash2)
-    assert_equal({}, res)
-    assert_equal(SubHash2, res.class)
+    res = parse('{"foo":"bar"}', :object_class => SubHash)
+    assert_equal({"foo" => "bar"}, res)
+    assert_equal(SubHash, res.class)
+    assert res.item_set?
   end
 
   def test_generation_of_core_subclasses_with_new_to_json

data/tests/test_json_generate.rb

@@ -54,6 +54,7 @@ EOT
 
   def test_generate_pretty
     json = pretty_generate(@hash)
+    # hashes aren't (insertion) ordered on every ruby implementation assert_equal(@json3, json)
     assert_equal(JSON.parse(@json3), JSON.parse(json))
     parsed_json = parse(json)
     assert_equal(@hash, parsed_json)

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: json
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-    - 1
-    - 5
-    - 1
-  version: 1.5.1
+  prerelease: 
+  version: 1.5.2
 platform: java
 authors: 
   - Daniel Luz
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 +01:00
+date: 2011-06-15 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -29,64 +25,64 @@ extra_rdoc_files: []
 files: 
   - lib/json.rb
   - lib/json/json.xpm
-  - lib/json/Key.xpm
-  - lib/json/String.xpm
-  - lib/json/Numeric.xpm
-  - lib/json/Hash.xpm
-  - lib/json/common.rb
-  - lib/json/Array.xpm
-  - lib/json/FalseClass.xpm
   - lib/json/TrueClass.xpm
-  - lib/json/pure.rb
   - lib/json/version.rb
+  - lib/json/Array.xpm
+  - lib/json/common.rb
   - lib/json/ext.rb
+  - lib/json/pure.rb
+  - lib/json/Key.xpm
+  - lib/json/FalseClass.xpm
   - lib/json/editor.rb
+  - lib/json/Numeric.xpm
   - lib/json/NilClass.xpm
-  - lib/json/add/rails.rb
+  - lib/json/String.xpm
+  - lib/json/Hash.xpm
   - lib/json/add/core.rb
-  - lib/json/ext/parser.jar
-  - lib/json/ext/generator.jar
+  - lib/json/add/rails.rb
   - lib/json/pure/generator.rb
   - lib/json/pure/parser.rb
-  - tests/test_json_encoding.rb
-  - tests/test_json_addition.rb
-  - tests/test_json.rb
+  - lib/json/ext/generator.jar
+  - lib/json/ext/parser.jar
   - tests/test_json_string_matching.rb
-  - tests/test_json_generate.rb
-  - tests/test_json_unicode.rb
-  - tests/setup_variant.rb
   - tests/test_json_fixtures.rb
-  - tests/fixtures/pass16.json
-  - tests/fixtures/fail4.json
-  - tests/fixtures/fail1.json
+  - tests/setup_variant.rb
+  - tests/test_json_unicode.rb
+  - tests/test_json_addition.rb
+  - tests/test_json_generate.rb
+  - tests/test_json_encoding.rb
+  - tests/test_json.rb
+  - tests/fixtures/fail6.json
+  - tests/fixtures/fail9.json
+  - tests/fixtures/fail10.json
+  - tests/fixtures/fail24.json
   - tests/fixtures/fail28.json
+  - tests/fixtures/fail13.json
+  - tests/fixtures/fail4.json
+  - tests/fixtures/pass3.json
+  - tests/fixtures/fail11.json
+  - tests/fixtures/fail14.json
+  - tests/fixtures/fail3.json
+  - tests/fixtures/fail12.json
+  - tests/fixtures/pass16.json
+  - tests/fixtures/pass15.json
+  - tests/fixtures/fail20.json
   - tests/fixtures/fail8.json
-  - tests/fixtures/fail19.json
   - tests/fixtures/pass2.json
+  - tests/fixtures/fail5.json
+  - tests/fixtures/fail1.json
+  - tests/fixtures/fail25.json
+  - tests/fixtures/pass17.json
+  - tests/fixtures/fail7.json
   - tests/fixtures/pass26.json
-  - tests/fixtures/pass1.json
-  - tests/fixtures/fail3.json
-  - tests/fixtures/fail20.json
-  - tests/fixtures/pass3.json
-  - tests/fixtures/pass15.json
-  - tests/fixtures/fail12.json
-  - tests/fixtures/fail13.json
-  - tests/fixtures/fail22.json
-  - tests/fixtures/fail24.json
-  - tests/fixtures/fail9.json
-  - tests/fixtures/fail2.json
-  - tests/fixtures/fail14.json
-  - tests/fixtures/fail6.json
   - tests/fixtures/fail21.json
-  - tests/fixtures/fail7.json
-  - tests/fixtures/pass17.json
-  - tests/fixtures/fail11.json
-  - tests/fixtures/fail25.json
-  - tests/fixtures/fail5.json
+  - tests/fixtures/pass1.json
+  - tests/fixtures/fail23.json
   - tests/fixtures/fail18.json
+  - tests/fixtures/fail2.json
+  - tests/fixtures/fail22.json
   - tests/fixtures/fail27.json
-  - tests/fixtures/fail10.json
-  - tests/fixtures/fail23.json
+  - tests/fixtures/fail19.json
 has_rdoc: true
 homepage: http://json-jruby.rubyforge.org/
 licenses: []
@@ -97,23 +93,21 @@ rdoc_options: []
 require_paths: 
   - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-          - 0
         version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-          - 0
         version: "0"
 requirements: []
 
 rubyforge_project: json-jruby
-rubygems_version: 1.3.6
+rubygems_version: 1.5.1
 signing_key: 
 specification_version: 3
 summary: JSON implementation for JRuby