son_jay 0.1.0.alpha

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require_relative('../../lib/son_jay')
+
+module SonJayFeatureSupport
+  def context_data
+    @context_data ||= {}
+  end
+
+  def context_module
+    @context_module ||= Module.new
+  end
+end
+
+World(SonJayFeatureSupport)

data/lib/son_jay/model_array.rb

@@ -0,0 +1,55 @@
+require 'forwardable'
+
+module SonJay
+
+  def self.ModelArray(entry_class)
+    Class.new(ModelArray).tap{ |c|
+      c.send :entry_class=, entry_class
+    }
+  end
+
+  class ModelArray
+    extend Forwardable
+
+    class << self
+      attr_accessor :entry_class
+
+      def array_class
+        #TODO: Factor out duplication w/ ObjectModel::array_class
+        @array_class ||= begin
+          klass = SonJay::ModelArray(self)
+          const_set :Array, klass
+        end
+      end
+    end
+
+    def initialize
+      @entries = []
+    end
+
+    def sonj_content
+      self
+    end
+
+    def additional
+      entry = self.class.entry_class.new
+      @entries << entry
+      entry
+    end
+
+    def load_data(data)
+      data.each do |entry_data|
+        additional.sonj_content.load_data entry_data
+      end
+    end
+
+    def_delegators :@entries, *[
+      :[] ,
+      :empty? ,
+      :entries ,
+      :length ,
+      :to_json ,
+    ]
+
+  end
+end

data/lib/son_jay/object_model/properties.rb

@@ -0,0 +1,70 @@
+require 'forwardable'
+
+module SonJay
+  class ObjectModel
+    class Properties
+      class NameError < KeyError
+        def initialize(name)
+          super "No such property name as %s" % name.inspect
+        end
+      end
+
+      extend Forwardable
+
+      def initialize(property_definitions)
+        @data = {}
+        @model_properties = Set.new
+        property_definitions.each do |d|
+          is_model_property = !! d.model_class
+          @data[d.name] = is_model_property ? d.model_class.new : nil
+          @model_properties << d.name if is_model_property
+        end
+      end
+
+      def_delegators :@data, *[
+        :length ,
+        :values ,
+      ]
+
+      def_delegator :@data, :has_key?, :has_name?
+
+      def [](name)
+        name = "#{name}"
+        @data.fetch(name)
+      rescue KeyError
+        raise NameError.new(name)
+      end
+
+      def []=(name, value)
+        name = "#{name}"
+        raise NameError.new(name) unless @data.has_key?(name)
+        @data[name] = value
+      end
+
+      def load_data(data)
+        data.each_pair do |name, value|
+          load_property name, value
+        end
+      end
+
+      def load_property(name, value)
+        name = "#{name}"
+        return unless @data.has_key?(name)
+        if @model_properties.include?(name)
+          @data[name].sonj_content.load_data value
+        else
+          @data[name] = value
+        end
+      end
+
+      def has_name?(name)
+        @data.has_key?( "#{name}" )
+      end
+
+      def to_json(*args)
+        @data.to_json(*args)
+      end
+
+    end
+  end
+end

data/lib/son_jay/object_model/property_definition.rb

@@ -0,0 +1,38 @@
+module SonJay
+  class ObjectModel
+
+    class PropertyDefinition
+      attr_reader :name, :model_class
+
+      def initialize(name, instruction = nil)
+        @name        = name
+        @model_class = model_class_for_instruction(instruction)
+      end
+
+      private
+
+      def model_class_for_instruction(instruction)
+        if instruction.nil?
+          nil
+        elsif instruction.respond_to?(:to_ary)
+          array_model_class(instruction)
+        elsif instruction.respond_to?( :new )
+          instruction
+        end
+      end
+
+      private
+
+      def array_model_class(instruction)
+        return instruction unless instruction.respond_to?(:to_ary)
+        return SonJay::ValueArray if instruction == []
+
+        sub_instruction = instruction.first
+        sub_model_class = array_model_class( sub_instruction )
+        sub_model_class.array_class
+      end
+
+    end
+
+  end
+end

data/lib/son_jay/object_model.rb

@@ -0,0 +1,71 @@
+require 'son_jay/object_model/properties'
+require 'son_jay/object_model/property_definition'
+
+module SonJay
+  class ObjectModel
+
+    class PropertiesDefiner
+
+      def initialize(property_definitions)
+        @property_definitions = property_definitions
+      end
+
+      def property(name, options={})
+        name = "#{name}"
+        @property_definitions << PropertyDefinition.new( name, options[:model] )
+      end
+
+    end
+
+    class << self
+
+      def json_create(json)
+        data = JSON.parse( json )
+        instance = new
+        instance.sonj_content.load_data data
+        instance
+      end
+
+      def properties(&property_initializations)
+        @property_initializations = property_initializations
+      end
+
+      def property_definitions
+        @property_definitions ||= begin
+          definitions = []
+
+          definer = PropertiesDefiner.new(definitions)
+          definer.instance_eval &@property_initializations
+          definitions.each do |d|
+            name = d.name
+            class_eval <<-CODE
+              def #{name}         ; sonj_content[#{name.inspect}]         ; end
+              def #{name}=(value) ; sonj_content[#{name.inspect}] = value ; end
+            CODE
+          end
+          definitions
+        end
+      end
+
+      def array_class
+        @array_class ||= begin
+          klass = SonJay::ModelArray(self)
+          const_set :Array, klass
+        end
+      end
+
+    end
+
+    attr_reader :sonj_content
+
+    def initialize
+      definitions = self.class.property_definitions
+      @sonj_content = ObjectModel::Properties.new( definitions )
+    end
+
+    def to_json(*args)
+      sonj_content.to_json(*args)
+    end
+
+  end
+end

data/lib/son_jay/value_array.rb

@@ -0,0 +1,17 @@
+module SonJay
+  class ValueArray < ::Array
+    Array = SonJay::ModelArray(self)
+
+    def self.array_class
+      self::Array
+    end
+
+    def sonj_content
+      self
+    end
+
+    def load_data(data)
+      replace data
+    end
+  end
+end

data/lib/son_jay/version.rb

@@ -0,0 +1,3 @@
+module SonJay
+  VERSION = "0.1.0.alpha"
+end

data/lib/son_jay.rb

@@ -0,0 +1,8 @@
+require 'json'
+require 'son_jay/version'
+require 'son_jay/object_model'
+require 'son_jay/model_array'
+require 'son_jay/value_array'
+
+module SonJay
+end

data/son_jay.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'son_jay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "son_jay"
+  spec.version       = SonJay::VERSION
+  spec.authors       = ["Steve Jorgensen"]
+  spec.email         = ["stevej@stevej.name"]
+  spec.summary       = %q{Symmetrical transformation between structured data and JSON}
+  spec.description   = %q{Symmetrical transformation between structured data and JSON}
+  spec.homepage      = "https://github.com/stevecj/son_jay"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "cucumber"
+end

data/spec/model_array_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe 'SonJay::ModelArray()' do
+  it "returns a subclass of ModelArray for entries of given type" do
+    entry_class_1 = Class.new
+    entry_class_2 = Class.new
+
+    array_model_subclass_1 = SonJay::ModelArray( entry_class_1 )
+    array_model_subclass_2 = SonJay::ModelArray( entry_class_2 )
+
+    expect( array_model_subclass_1.entry_class ).to eq( entry_class_1 )
+    expect( array_model_subclass_2.entry_class ).to eq( entry_class_2 )
+  end
+end
+
+describe SonJay::ModelArray do
+  describe "a subclass for entries of a modeled type" do
+    let( :subclass ) { Class.new(described_class).tap{ |c|
+      c.send :entry_class=, entry_class
+    } }
+    let( :entry_class ) { Class.new do
+      class Content
+        def initialize( entry ) ; @entry = entry ; end
+        def load_data(data) ; @entry.loaded_data = data ; end
+      end
+
+      attr_accessor :loaded_data
+      def sonj_content ; Content.new(self) ; end
+    end }
+
+    describe '::array_class' do
+      it "returns a model-array subclass for entries of this model-array type (nested array)" do
+        array_class = subclass.array_class
+        puts array_class.ancestors
+        expect( array_class.ancestors ).to include( SonJay::ModelArray )
+        expect( array_class.entry_class ).to eq( subclass )
+      end
+    end
+
+    it "produces instances that are initially empty" do
+      instance = subclass.new
+      expect( instance ).to be_empty
+      expect( instance.length ).to eq( 0 )
+    end
+
+    describe "#additional" do
+      it "adds a new entry of the modeled type, and returns the entry" do
+        instance = subclass.new
+
+        entry_0 = instance.additional
+        entry_1 = instance.additional
+
+        expect( entry_0 ).to be_kind_of( entry_class )
+        expect( instance.entries ).to eq( [entry_0, entry_1] )
+      end
+    end
+
+    describe '#load_data' do
+      it "loads entries in the given enumerable into its own model instance entries" do
+        instance = subclass.new
+
+        instance.load_data( ['entry 0 data', 'entry 1 data'] )
+
+        expect( instance.length ).to eq( 2 )
+        expect( instance[0].loaded_data ).to eq( 'entry 0 data' )
+        expect( instance[1].loaded_data ).to eq( 'entry 1 data' )
+      end
+    end
+  end
+end

data/spec/object_model/properties_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe SonJay::ObjectModel::Properties do
+  subject{
+    described_class.new( [
+      SonJay::ObjectModel::PropertyDefinition.new( 'aaa' ) ,
+      SonJay::ObjectModel::PropertyDefinition.new( 'bbb' ) ,
+      SonJay::ObjectModel::PropertyDefinition.new( 'ccc' ) ,
+      SonJay::ObjectModel::PropertyDefinition.new( 'ddd', ddd_model_class ) ,
+    ] )
+  }
+
+  let( :ddd_model_class ) { Class.new do
+    class Content
+      def initialize(model) ; @model = model ; end
+      def load_data(data) ; @model.class.loaded_data = data ; end
+    end
+    class << self ; attr_accessor :loaded_data ; end
+    def to_json(*) ; '"ddd..."' ; end
+    def sonj_content ; Content.new(self) ; end
+  end }
+
+  it "has an entry for each property name specified during initialization" do
+    expect( subject.length ).to eq( 4 )
+    expect( subject ).to have_name('aaa')
+    expect( subject ).to have_name('bbb')
+    expect( subject ).to have_name('ccc')
+    expect( subject ).to have_name('ddd')
+  end
+
+  describe "property value access by name" do
+    it "reads nil by default for an existing value property" do
+      expect( subject['aaa'] ).to be_nil
+    end
+
+    it "writes and reads existing value properties" do
+      subject['bbb'] = 10
+      subject['aaa'] = 11
+
+      expect( subject['bbb'] ).to eq( 10 )
+      expect( subject['aaa'] ).to eq( 11 )
+    end
+
+    it "refuses to read a non-existent property" do
+      expect{ subject['abc'] }.to raise_exception( described_class::NameError )
+    end
+
+    it "refuses to write a non-existent property" do
+      expect{ subject['abc'] = 1 }.to raise_exception( described_class::NameError )
+    end
+
+    it "allows reading/writing by symbol or string for property name" do
+      subject['aaa'] = 10
+      subject[:bbb]  = 11
+
+      expect( subject[:aaa]  ).to eq( 10 )
+      expect( subject['bbb'] ).to eq( 11 )
+    end
+
+    it "reads an instance of the model for a modeled attribute" do
+      expect( subject[:ddd] ).to be_kind_of( ddd_model_class )
+    end
+  end
+
+  describe "#to_json" do
+    it "returns a JSON object representation with attribute values" do
+      subject['aaa'] = 'abc'
+      subject['ccc'] = true
+
+      actual_json = subject.to_json
+
+      actual_data = JSON.parse( actual_json )
+      expected_data = {
+        'aaa' => 'abc' ,
+        'bbb' =>  nil ,
+        'ccc' =>  true ,
+        'ddd' => "ddd..." ,
+      }
+      expect( actual_data ).to eq( expected_data )
+    end
+  end
+
+  describe "load_property" do
+    it "writes to existing value properties" do
+      subject.load_property( 'bbb', 11 )
+      subject.load_property( 'ccc', 12 )
+
+      expect( subject['bbb'] ).to eq( 11 )
+      expect( subject['ccc'] ).to eq( 12 )
+    end
+
+    it "loads data into existing modeled properties" do
+      subject.load_property( 'ddd', 'some data' )
+      expect( ddd_model_class.loaded_data ).to eq( 'some data' )
+    end
+
+    it "ignores attempts to write to non-existent properties" do
+      expect{ subject.load_property('xx', 10) }.
+        not_to change{ subject.length }
+    end
+
+    it "allows string or symbol for property name" do
+      subject.load_property( 'aaa' , 888 )
+      subject.load_property( :ccc  , 999 )
+
+      expect( subject['aaa'] ).to eq( 888 )
+      expect( subject['ccc'] ).to eq( 999 )
+    end
+  end
+
+  describe "load_data" do
+    it "populates property values from hash entries" do
+      subject.load_data({
+        'bbb' => 'abc' ,
+        'ccc' =>  false ,
+        'ddd' => 'something...' ,
+      })
+      expect( subject['aaa'] ).to be_nil
+      expect( subject['bbb'] ).to eq( 'abc' )
+      expect( subject['ccc'] ).to eq( false )
+      expect( ddd_model_class.loaded_data ).to eq( 'something...' )
+    end
+  end
+
+end

data/spec/object_model/property_definition_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe SonJay::ObjectModel::PropertyDefinition do
+
+  it "has a nil model class for a nil instruction" do
+    instance = described_class.new( :a, nil )
+    expect( instance.model_class ).to be_nil
+  end
+
+  it "has a model class for a model class instruction" do
+    model_class = Class.new
+
+    instance = described_class.new( :a, model_class )
+    expect( instance.model_class ).to eq( model_class )
+  end
+
+  it "has a value-array class for an empty-array instruction" do
+    instance = described_class.new( :a, [] )
+    expect( instance.model_class ).to eq( SonJay::ValueArray )
+  end
+
+  it "has a model-array class for an array w/ model class entry" do
+    entry_model_class = Class.new do
+      class Array ; end
+      def self.array_class ; Array ; end
+    end
+
+    instance = described_class.new( :a, [ entry_model_class ] )
+    expect( instance.model_class ).to eq( entry_model_class::Array )
+  end
+end

data/spec/object_model_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe SonJay::ObjectModel do
+
+  describe "a subclass that defines value properties" do
+
+    describe '::array_class' do
+      it "returns a model-array subclass for entries of this type" do
+        array_class = subclass.array_class
+        puts array_class.ancestors
+        expect( array_class.ancestors ).to include( SonJay::ModelArray )
+        expect( array_class.entry_class ).to eq( subclass )
+      end
+    end
+
+    let( :subclass ) {
+      Class.new(described_class) do
+        properties do
+          property :abc
+          property :xyz
+        end
+      end
+    }
+
+    describe "#sonj_content" do
+      it "has name-indexed settable/gettable values for defined properties" do
+        instance = subclass.new
+
+        content = instance.sonj_content
+        expect( content.length ).to eq( 2 )
+
+        content[:abc] = 1
+        content[:xyz] = 'XYZ'
+
+        expect( content[:abc] ).to eq( 1 )
+        expect( content[:xyz] ).to eq( 'XYZ' )
+      end
+    end
+
+    it "has direct property accessor methods for each property" do
+      instance = subclass.new
+      instance.abc, instance.xyz = 11, 22
+
+      expect( [instance.abc, instance.xyz] ).to eq( [11, 22] )
+    end
+
+    it "serializes to a JSON object representation w/ property values" do
+      instance = subclass.new
+      instance.abc, instance.xyz = 'ABC', nil
+
+      actual_json = instance.to_json
+
+      actual_data = JSON.parse( actual_json)
+      expected_data = {'abc' => 'ABC', 'xyz' => nil}
+      expect( actual_data ).to eq( expected_data )
+    end
+
+    describe '::json_create' do
+      it "creates an instance with properties filled in from parsed JSON" do
+        json = <<-JSON
+          {
+            "abc":  123  ,
+            "xyz": "XYZ"
+          }
+        JSON
+
+        instance = subclass.json_create( json )
+
+        expect( instance.abc ).to eq(  123  )
+        expect( instance.xyz ).to eq( 'XYZ' )
+      end
+    end
+
+  end
+
+  describe "a subclass that defines value and modeled-object properties" do
+    let( :subclass ) {
+      dmc_1, dmc_2 = detail_model_class_1, detail_model_class_2
+      pbcs = property_block_calls
+      Class.new(described_class) do
+        properties do
+          pbcs << 1
+          property :a
+          property :obj_1, model: dmc_1
+          property :obj_2, model: dmc_2
+        end
+      end
+    }
+
+    let( :property_block_calls ) { [] }
+
+    let( :detail_model_class_1 ) {
+      Class.new(described_class) do
+        properties do
+          property :aaa
+          property :bbb
+        end
+      end
+    }
+
+    let( :detail_model_class_2 ) {
+      Class.new(described_class) do
+        properties do
+          property :ccc
+        end
+      end
+    }
+
+    it "does not immediately invoke its properties block when declared" do
+      _ = subclass
+      expect( property_block_calls ).to be_empty
+    end
+
+    describe "#sonj_content" do
+      it "has an entry for each defined property" do
+        content = subclass.new.sonj_content
+        expect( content.length ).to eq( 3 )
+      end
+    end
+
+    describe "#sonj_content" do
+      it "has name-indexed settable/gettable values for defined value properties" do
+        content = subclass.new.sonj_content
+        content[:a] = 1
+        expect( content[:a] ).to eq( 1 )
+      end
+
+      it "has name-indexed gettable values for defined modeled-object properties" do
+        content = subclass.new.sonj_content
+        expect( content[:obj_1] ).to be_kind_of( detail_model_class_1 )
+      end
+    end
+
+  end
+
+end

data/spec/son_jay_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SonJay do
+  it 'has a version number' do
+    SonJay::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'son_jay'