jinx-json 2.1.1 → 2.1.2

data/Gemfile

@@ -4,6 +4,6 @@ gemspec
 group :development do
   gem 'ruby-debug'
   # Uncomment to use a local gem.
-  gem 'jinx', :path => File.dirname(__FILE__) + '/../core'
+  #gem 'jinx', :path => File.dirname(__FILE__) + '/../core'
   gem 'jinx-json', :path => File.dirname(__FILE__), :require => 'jinx/json'
 end

data/History.md

@@ -1,6 +1,10 @@
 This history lists major release themes. See the GitHub commits (https://github.com/jinx/json)
 for change details.
 
+2.1.2 / 2012-06-12
+------------------
+* Support caSmall web service.
+
 2.1.1 / 2012-04-13
 ------------------
 * Initial public release spun off from caruby/core.

data/lib/jinx/json/date.rb

@@ -0,0 +1,32 @@
+require 'date'
+require 'java'
+
+class DateTime
+  # @param [String] json the JSON to deserialize
+  # @return [Date] the deserialized object
+  def self.json_create(json)
+    parse(json['data'])
+  end
+
+  # Adds JSON serialization to Ruby Date.
+  #
+  # @param args the JSON serialization options
+  # @return [String] the serialized date
+  def to_json(*args)
+    {
+      'json_class' => self.class.name,
+      'data' => to_s
+    }.to_json(*args)
+  end
+end
+
+class Java::JavaUtil::Date
+  # Adds JSON serialization to Java Date.
+  # The JSON is deserialized as a Ruby Date.
+  #
+  # @param args the JSON serialization options
+  # @return [String] the serialized date
+  def to_json(*args)
+    to_ruby_date.to_json(*args)
+  end
+end

data/lib/jinx/json/deserializable.rb

@@ -0,0 +1,17 @@
+require 'jinx/helpers/hashable'
+
+module Jinx
+  module JSON
+    # This Deserializable mix-in adds a {Deserializer} to each class which extends this module.
+    module Deserializable
+      def included(other)
+        super
+        if Class === other then
+          other.extend(Deserializer)
+        else
+          other.extend(Deserializable)
+        end
+      end
+    end
+  end
+end

data/lib/jinx/json/deserializer.rb

@@ -1,16 +1,43 @@
 require 'jinx/helpers/hashable'
 
+module JSON
+  # Bumps the default JSON nesting level to 100.
+  def self.parse(source, opts={})
+    visited = Thread.current[:jinx_json_deserialized] ||= {}
+    opts = opts.merge(:max_nesting => 100) unless opts.has_key?(:max_nesting) 
+    begin
+      Parser.new(source, opts).parse
+    ensure
+      visited.clear
+    end
+  end
+end
+
 module Jinx
   module JSON
     # JSON => {Jinx::Resource} deserializer.
     #
-    # This Deserializer reconstitutes a jinxed object from a JSON string built by a {Serializer}.
+    # This Deserializer reconstitutes a jinxed object from a JSON string built
+    # by a {Serializable}.
     module Deserializer
       # @param [String] json the JSON to deserialize
       # @return [Jinx::Resource] the deserialized object
       def json_create(json)
-        # Make the new object from the json data attribute => value hash.
-        new(json['data'])
+        # the thread-local oid => object hash
+        visited = Thread.current[:jinx_json_deserialized]
+        # the payload
+        vh = json['data']
+        # the oid
+        oid = vh.delete('object_id')
+        # If the object has already been built, then return that object.
+        ref = visited[oid]
+        if ref then
+          # Fill in a place-holder with content.
+          ref.merge_attributes(vh) unless vh.empty?
+          return ref
+        end
+        # Make the new object from the attribute => value hash.
+        visited[oid] = new(vh)
       end
     end
   end

data/lib/jinx/json/serializable.rb

@@ -0,0 +1,88 @@
+require 'json'
+require 'jinx/json/state'
+require 'jinx/json/collection'
+require 'jinx/json/date'
+require 'jinx/json/deserializable'
+require 'jinx/json/deserializer'
+
+module Jinx
+  module JSON
+    # Serializable is the JSON serializer {Jinx::Resource} mix-in.
+    #
+    # {#to_json} creates a JSON string from a jinxed object. The JSON payload is
+    # suitable for transfer to a remote {Deserializer}. This {Serializable} module
+    # is included directly in the jinxed application domain module after
+    # including {Jinx::Resource}, e.g.:
+    #   module MyApp
+    #     include Jinx::JSON::Serializable, Jinx:Resource
+    # which includes +Resource+ followed by the +Serializable+.
+    #
+    # The module which includes Serializable is extended with the {Importer}, which
+    # enables deserialization of the serialized JSON.
+    #
+    # The JSON payload is built as follows:
+    # * non-domain properties are serialized
+    # * dependent references are serialized recursively
+    # * independent reference primary and secondary key content is serialized
+    # * circular references are precluded by truncating the reference with a
+    #   surrogate object id
+    module Serializable
+      def self.included(other)
+        super
+        if Class === other then
+          other.extend(Deserializer)
+        else
+          other.extend(Deserializable)
+        end
+      end
+      
+      # @param [State, Hash, nil] state the JSON state or serialization options
+      # @return [String] the JSON representation of this {Jinx::Resource}
+      def to_json(state=nil)
+        # Make a new State from the options if this is a top-level call.
+        state = State.for(state) unless State === state
+        # the JSON content
+        {
+          'json_class' => json_class_name,
+          'data' => json_value_hash(state.visited)
+        }.to_json(state)
+      end
+
+      private
+
+      # The JSON class name must be scoped by the Resource package module, not the
+      # Java package, in order to recognize the Jinx::Resource JSON hooks.
+      #
+      # @return [String] the class name qualified by the Resource package module name context
+      def json_class_name
+        [self.class.domain_module, self.class.name.demodulize].join('::')
+      end
+
+      # Builds a serializable attribute => value hash with content as follows:
+      # * If this domain object has not yet been visited, then the hash includes all attributes,
+      #   as well as the +Jinx::Resource#proxy_object_id+.
+      # * If this domain object has already been visited, then the hash includes only the
+      #   +proxy_object_id+.
+      # Each +Set+ attribute value is converted to an array, since JSON does not serialize
+      # a +Set+ properly.
+      #
+      # The {Deserializer} is responsible for reconstituting the domain object graph from the
+      # serialized content.
+      #
+      # @param [<Resource>] visited the serialized objects
+      # @return [{Symbol => Object}] the serializable value hash
+      def json_value_hash(visited)
+        # If already visited, then the only content is the object id.
+        if visited.include?(self) then
+          return {:object_id => proxy_object_id}
+        end
+        visited << self
+        vh = value_hash
+        vh.each { |pa, v| vh[pa] = v.to_a if Set === v } 
+        # Add the object id.
+        vh[:object_id] = proxy_object_id
+        vh
+      end
+    end
+  end
+end

data/lib/jinx/json/state.rb

@@ -0,0 +1,24 @@
+require 'set'
+
+module Jinx
+  module JSON
+    # This State module bumps the JSON default +:max_nesting+ to 100 and tracks
+    # the visited objects in a modified +JSON::Pure::Generator::State+.
+    module State
+      # @param [Hash, nil] opts the generator options
+      # return [State] the state for the given options
+      def self.for(opts)
+        opts ||= {}
+        opts[:max_nesting] ||= 100
+        state = ::JSON::Pure::Generator::State.from_state(opts)
+        class << state 
+          # @return [<Jinx::JSON::Serializable>] the serialized objects
+          def visited
+            @visited ||= Set.new
+          end
+        end
+        state
+      end
+    end
+  end
+end

data/lib/jinx/json/version.rb

@@ -1,5 +1,5 @@
 module Jinx
   module JSON
-    VERSION = "2.1.1"
+    VERSION = '2.1.2'
   end
 end

data/spec/serializer_spec.rb

@@ -2,28 +2,28 @@ require 'spec/spec_helper'
 
 module Family
   describe Address do
-    it "should serialize an address" do
-      a = Address.new(:street1 => '16 Elm St', :city => 'Peoria', :state => 'IL')
-      j = JSON[a.to_json]
-      j.street1.should == a.street1
-      j.city.should == a.city
-      j.state.should == a.state
+    it 'should serialize an address' do
+      addr = Address.new(:street1 => '16 Elm St', :city => 'Peoria', :state => 'IL')
+      j = JSON[addr.to_json]
+      j.street1.should == addr.street1
+      j.city.should == addr.city
+      j.state.should == addr.state
     end
   end
   
   describe Household do
-    it "should serialize the address" do
-      a = Address.new(:street1 => '16 Elm St', :city => 'Peoria', :state => 'IL')
-      h = Household.new(:address => a)
-      j = JSON[h.to_json]
-      j.address.street1.should == a.street1
-      j.address.city.should == a.city
-      j.address.state.should == a.state
+    it 'should serialize the address' do
+      addr = Address.new(:street1 => '16 Elm St', :city => 'Peoria', :state => 'IL')
+      hshd = Household.new(:address => addr)
+      j = JSON[hshd.to_json]
+      j.address.street1.should == addr.street1
+      j.address.city.should == addr.city
+      j.address.state.should == addr.state
     end
   end
   
   describe Parent do
-    it "should serialize the children" do
+    it 'should serialize the children' do
       p = Parent.new(:name => 'Oscar')
       c = Child.new(:name => 'Beauregard', :parents => [p])
       p.children << c
@@ -33,14 +33,22 @@ module Family
   end
   
   describe Child do
-    it "should only serialize the owner key" do
-      h = Household.new
-      p = Parent.new(:name => 'Oscar', :household => h)
+    it 'should serialize the parent' do
+      hshd = Household.new
+      p = Parent.new(:name => 'Oscar', :household => hshd)
       c = Child.new(:name => 'Beauregard', :parents => [p])
       p.children << c
       j = JSON[c.to_json]
-      j.parents.first.name.should be nil
-      j.parents.first.household.should be nil
+      j.parents.first.name.should_not be nil
+      j.parents.first.household.should_not be nil
+    end
+    
+    describe 'Date' do
+      it 'should serialize a Java date as a Ruby date' do
+        date = Java.now
+        j = JSON[date.to_json]
+        j.should be_within(0.005).of(date.to_ruby_date)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -6,8 +6,8 @@ Bundler.require(:test, :development)
 require Bundler.environment.specs.detect { |s| s.name == 'jinx' }.full_gem_path + '/examples/family/lib/family'
 
 # Add serialization
-require 'jinx/json/serializer'
+require 'jinx/json/serializable'
 
 module Family
-  include Jinx::JSON::Serializer
+  include Jinx::JSON::Serializable
 end

metadata

@@ -2,7 +2,7 @@
 name: jinx-json
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors: 
   - OHSU
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-13 00:00:00 -07:00
-default_executable: 
+date: 2012-06-12 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: bundler
@@ -81,21 +80,22 @@ files:
   - .rspec
   - .yardopts
   - Gemfile
-  - Gemfile.lock
   - History.md
   - LEGAL
   - LICENSE
   - README.md
   - Rakefile
   - jinx-json.gemspec
-  - lib/jinx/json.rb
   - lib/jinx/json/collection.rb
+  - lib/jinx/json/date.rb
+  - lib/jinx/json/deserializable.rb
   - lib/jinx/json/deserializer.rb
-  - lib/jinx/json/serializer.rb
+  - lib/jinx/json/serializable.rb
+  - lib/jinx/json/set.rb
+  - lib/jinx/json/state.rb
   - lib/jinx/json/version.rb
   - spec/serializer_spec.rb
   - spec/spec_helper.rb
-has_rdoc: yard
 homepage: http://github.com/jinx/json
 licenses: 
   - MIT
@@ -119,10 +119,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: jinx
-rubygems_version: 1.5.1
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Jinx JSON plug-in.
 test_files: 
   - spec/serializer_spec.rb
   - spec/spec_helper.rb
+has_rdoc: yard

data/Gemfile.lock

@@ -1,43 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jinx-json (2.1.1)
-      bundler
-      jinx
-      json_pure
-
-PATH
-  remote: /Users/loneyf/workspace/jinx/core
-  specs:
-    jinx (2.1.1)
-      bundler
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    columnize (0.3.6)
-    diff-lcs (1.1.3)
-    json_pure (1.6.3)
-    rake (0.9.2.2)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    ruby-debug (0.10.4)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.4.0)
-    ruby-debug-base (0.10.4-java)
-
-PLATFORMS
-  java
-
-DEPENDENCIES
-  jinx!
-  jinx-json!
-  rake
-  rspec (>= 2.6)
-  ruby-debug

data/lib/jinx/json/serializer.rb

@@ -1,90 +0,0 @@
-require 'json'
-require 'jinx/json/collection'
-
-module Jinx
-  module JSON
-    # {Jinx::Resource} => JSON serializer.
-    #
-    # This Serializer creates a JSON string from a jinxed object. The JSON payload is
-    # suitable for transfer to a remote {Deserializer}. This {Serializer} is included
-    # directly in the jinxed application domain module after including {Jinx::Resource},
-    # e.g.:
-    #   module MyApp
-    #     include Jinx::JSON::Serializer, Jinx:Resource
-    # which includes +Resource+ followed by the +Serializer+.
-    #
-    # The module which includes this Serializer is extended with the {Importer}, which
-    # enables deserialization of the serialized JSON.
-    #
-    # The JSON payload is built as follows:
-    # * non-domain properties are serialized
-    # * dependent references are serialized recursively
-    # * independent reference primary and secondary key content is serialized
-    module Serializer
-      # @param args the JSON serialization options
-      # @return [String] the JSON representation of this {Jinx::Resource}
-      def to_json(*args)
-        {
-          'json_class' => json_class_name,
-          'data' => json_value_hash
-        }.to_json(*args)
-      end
-      
-      private
-      
-      # The JSON class name must be scoped by the Resource package module, not the
-      # Java package, in order to recognize the Jinx::Resource JSON hooks.
-      #
-      # @return [String] the class name qualified by the Resource package module name context
-      def json_class_name
-        [self.class.domain_module, self.class.name.demodulize].join('::')
-      end
-      
-      # Builds a serializable attribute => value hash. If _key_only _ is true, then only
-      # the key attributes are included in the hash. Otherwise, all properties are included
-      # in the hash.
-      #
-      # An independent or owner attribute value is a copy of the referenced domain object
-      # consisting of only the primary and secondary key attributes.
-      #
-      # @return [{Symbol => Object}] the serializable value hash
-      def json_value_hash
-        vh = value_hash(self.class.nondomain_attributes)
-        vh.merge!(value_hash(self.class.dependent_attributes))
-        self.class.independent_attributes.each do |ia|
-          ref = send(ia)
-          vh[ia] = json_independent_reference(ref) unless ref.nil_or_empty?
-        end
-        vh
-      end
-      
-      # @param [Resource] the referenced object
-      # @return [Resource] a copy of the referenced object which only contains
-      #   key property values
-      def json_independent_reference(ref)
-        return ref.map { |item| json_independent_reference(item) } if ref.collection?
-        vh = json_key_hash(ref)
-        ref.copy(vh) unless vh.empty?
-      end
-      
-      # @param (see #json_independent_reference)
-      # @return [{Symbol => Object}, nil] the key attribute => value hash, or nil
-      #   if there is no complete key
-      def json_key_hash(ref)
-        vh = ref.value_hash(ref.class.primary_key_attributes)
-        ref.class.secondary_key_attributes.each do |ka|
-          value = json_key_value(ref, ka)
-          vh[ka] = value if value
-        end
-      end
-      
-      # @param (see #json_independent_reference)
-      # @param [Symbol] the key value
-      # @return the key attribute value
-      def json_key_value(ref, attribute)
-        value = ref.send(attribute)
-        Resource === value ? json_independent_reference(value) : value
-      end
-    end
-  end
-end

data/lib/jinx/json.rb

@@ -1 +0,0 @@
-require 'json'