jinx-json 2.1.1

data/.gitignore

@@ -0,0 +1,14 @@
+.DS_Store
+*~
+*.pdf
+.project
+.loadpath
+.yardoc
+*.gem
+*.tar*
+**/ext/bin
+**/classes
+/doc/api
+**log
+/test/results
+

data/.rspec

@@ -0,0 +1,3 @@
+--backtrace
+--format Fuubar
+--color

data/.yardopts

@@ -0,0 +1 @@
+-o doc/api --private --protected --name-tag 'quirk:Technology idiosyncracy' - History.md LEGAL LICENSE

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,43 @@
+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/History.md

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

data/LEGAL

@@ -0,0 +1,5 @@
+LEGAL NOTICE INFORMATION
+------------------------
+
+All the files in this distribution are covered under either the MIT
+license (see the file LICENSE).

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Oregon Health & Science University
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+Jinx JSON plug-in
+=================
+
+**Home**:         [http://github.com/jinx/json](http://github.com/jinx/json)    
+**Git**:          [http://github.com/jinx/json](http://github.com/jinx/json)       
+**Author**:       OHSU Knight Cancer Institute    
+**Copyright**:    2012    
+**License**:      MIT License    
+
+Synopsis
+--------
+Jinx JSON enables JSON serialization for [Jinx](http://github.com/jinx/core) resources.
+
+Installing
+----------
+Jinx JSON is installed as a JRuby gem:
+
+    [sudo] jgem install jinx-json
+
+Usage
+-----
+Enable Jinx for a Java package, as described in the [Jinx](http://github.com/jinx/json/core) Usage.
+
+    require 'jinx/json'
+    jsoned = jinxed.to_json #=> the JSON representation of a jinxed resource
+    JSON[jsoned] #=> the deserialized jinxed resource
+
+Copyright
+---------
+Jinx © 2011 by [Oregon Health & Science University](http://www.ohsu.edu/xd/health/services/cancer/index.cfm).
+Jinx is licensed under the MIT license. Please see the LICENSE and LEGAL files for more information.

data/Rakefile

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/lib/jinx/json/version'
+
+# the gem name
+GEM = 'jinx-json'
+GEM_VERSION = Jinx::JSON::VERSION
+
+WINDOWS = (Config::CONFIG['host_os'] =~ /mingw|win32|cygwin/ ? true : false) rescue false
+SUDO = WINDOWS ? '' : 'sudo'
+
+desc "Builds the gem"
+task :gem do
+  sh "jgem build #{GEM}.gemspec"
+end
+
+desc "Installs the gem"
+task :install => :gem do
+  sh "#{SUDO} jgem install #{GEM}-#{GEM_VERSION}.gem"
+end
+
+desc 'Documents the API'
+task :doc do
+  FileUtils.rm_rf 'doc/api'
+  sh 'yardoc'
+end
+
+desc 'Runs the spec tests'
+task :spec do
+  Dir['spec/**/*_spec.rb'].each { |f| sh "rspec #{f}" rescue nil }
+end
+
+desc 'Runs all tests'
+task :test => :spec

data/jinx-json.gemspec

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/lib/jinx/json/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name          = 'jinx-json'
+  s.summary       = 'Jinx JSON plug-in.'
+  s.version       = Jinx::JSON::VERSION
+  s.description   = s.summary + '. See github.com/jinx/json for more information.'
+  s.date          = Date.today
+  s.author        = 'OHSU'
+  s.email         = "jinx.ruby@gmail.com"
+  s.homepage      = 'http://github.com/jinx/json'
+  s.platform      = Gem::Platform::RUBY
+  s.require_path  = 'lib'
+  s.bindir        = 'bin'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files test spec`.split("\n")
+  s.add_dependency 'bundler'
+  s.add_dependency 'jinx'
+  s.add_dependency 'json_pure'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '>= 2.6'
+  s.has_rdoc      = 'yard'
+  s.license       = 'MIT'
+  s.rubyforge_project = 'jinx'
+end

data/lib/jinx/json/collection.rb

@@ -0,0 +1,13 @@
+require 'jinx/helpers/collection'
+
+module Jinx
+  module Collection
+    # Adds JSON serialization to collections.
+    #
+    # @param args the JSON serialization options
+    # @return [String] the JSON representation of this Enumerable as an array
+    def to_json(*args)
+      to_a.to_json(*args)
+    end
+  end
+end

data/lib/jinx/json/deserializer.rb

@@ -0,0 +1,17 @@
+require 'jinx/helpers/hashable'
+
+module Jinx
+  module JSON
+    # JSON => {Jinx::Resource} deserializer.
+    #
+    # This Deserializer reconstitutes a jinxed object from a JSON string built by a {Serializer}.
+    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'])
+      end
+    end
+  end
+end

data/lib/jinx/json/serializer.rb

@@ -0,0 +1,90 @@
+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/version.rb

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

data/lib/jinx/json.rb

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

data/spec/serializer_spec.rb

@@ -0,0 +1,46 @@
+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
+    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
+    end
+  end
+  
+  describe Parent do
+    it "should serialize the children" do
+      p = Parent.new(:name => 'Oscar')
+      c = Child.new(:name => 'Beauregard', :parents => [p])
+      p.children << c
+      j = JSON[p.to_json]
+      j.children.first.name.should == c.name
+    end
+  end
+  
+  describe Child do
+    it "should only serialize the owner key" do
+      h = Household.new
+      p = Parent.new(:name => 'Oscar', :household => h)
+      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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:test, :development)
+
+# Load the Family example.
+require Bundler.environment.specs.detect { |s| s.name == 'jinx' }.full_gem_path + '/examples/family/lib/family'
+
+# Add serialization
+require 'jinx/json/serializer'
+
+module Family
+  include Jinx::JSON::Serializer
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: jinx-json
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 2.1.1
+platform: ruby
+authors: 
+  - OHSU
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: bundler
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: jinx
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: json_pure
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "2.6"
+    type: :development
+    version_requirements: *id005
+description: Jinx JSON plug-in.. See github.com/jinx/json for more information.
+email: jinx.ruby@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - .gitignore
+  - .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/deserializer.rb
+  - lib/jinx/json/serializer.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
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: jinx
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: Jinx JSON plug-in.
+test_files: 
+  - spec/serializer_spec.rb
+  - spec/spec_helper.rb