son_jay 0.4.1 → 0.5.0

data/spec/object_model_spec.rb

@@ -62,97 +62,21 @@ describe SonJay::ObjectModel do
       end
     end
 
-    describe "#sonj_content" do
-      let( :sonj_content ) { model_instance.sonj_content }
-
-      it "has number of entries equal to number of defined properties" do
-        expect( sonj_content.length ).to eq( 4 )
-      end
-
-      it "has name-indexed settable/gettable value properties by string or symbol" do
-        sonj_content[ :aaa  ] =  1
-        sonj_content[ 'bbb' ] = 'XYZ'
-
-        expect( sonj_content[ 'aaa' ] ).to eq(  1    )
-        expect( sonj_content[ :bbb  ] ).to eq( 'XYZ' )
-      end
-
-      it "has nil defaults for value properties" do
-        expect( sonj_content[ 'aaa' ] ).to be_nil
-        expect( sonj_content[ :bbb  ] ).to be_nil
-      end
-
-      it "has name-indexed gettable values for defined modeled-object properties by string or symbol" do
-        expect( sonj_content['detail_xy'] ).
-          to be_kind_of( subject_module::DetailXY )
-        expect( sonj_content[:detail_z] ).
-          to be_kind_of( subject_module::DetailZ )
-      end
-
-      it "rejects assignment of an undefined property" do
-        expect{ sonj_content['qq'] = 0 }.to raise_exception(
-          SonJay::PropertyNameError
-        )
-      end
-
-      it "returns nil for name-indexed access to a non-existent property" do
-        expect( sonj_content[ 'qq' ] ).to be_nil
-        expect( sonj_content[ :rr  ] ).to be_nil
-      end
-
-      it "has fetchable value properties by name string or symbol" do
-        sonj_content[ :aaa  ] =  1
-        sonj_content[ 'bbb' ] = 'XYZ'
-
-        expect( sonj_content.fetch( 'aaa' ) ).to eq(  1    )
-        expect( sonj_content.fetch( :bbb  ) ).to eq( 'XYZ' )
-      end
-
-      it "has nil defaults for value property fetches" do
-        expect( sonj_content.fetch( 'aaa' ) ).to be_nil
-        expect( sonj_content.fetch( :bbb  ) ).to be_nil
-      end
-
-      it "has name-indexed fetchable values for defined modeled-object properties by string or symbol" do
-        expect( sonj_content.fetch('detail_xy') ).
-          to be_kind_of( subject_module::DetailXY )
-        expect( sonj_content.fetch(:detail_z) ).
-          to be_kind_of( subject_module::DetailZ )
-      end
-
-      it "rejects fetch of an undefined property by name" do
-        expect{ sonj_content.fetch('qq') }.to raise_exception(
-          SonJay::PropertyNameError
-        )
-        expect{ sonj_content.fetch(:rr) }.to raise_exception(
-          SonJay::PropertyNameError
-        )
-      end
-
-      context "without extras allowed" do
-        it "rejects access to extra properties object" do
-          expect{ sonj_content.extra }.
-            to raise_exception( SonJay::DisabledMethodError )
-        end
-      end
+    it "has direct property accessor methods for each property" do
+      model_instance.aaa, model_instance.bbb = 11, 22
+      content = model_instance.model_content
 
-      context "with extras allowed" do
-        before do
-          model_class.class_eval do
-            allow_extras
-          end
-        end
+      expect( [content['aaa'], content['bbb']] ).
+        to eq( [11, 22] )
 
-        it "allows access to extra properties object" do
-          expect( sonj_content.extra.to_h ).to eq( {} )
-        end
-      end
+      expect( [model_instance.aaa, model_instance.bbb] ).
+        to eq( [11, 22] )
 
-    end
+      expect( model_instance.detail_xy ).
+        to equal( content['detail_xy'] )
+      expect( model_instance.detail_z ).
+        to equal( content['detail_z'] )
 
-    it "has direct property accessor methods for each property" do
-      model_instance.aaa, model_instance.bbb = 11, 22
-      expect( [model_instance.aaa, model_instance.bbb] ).to eq( [11, 22] )
       expect( model_instance.detail_xy ).
         to be_kind_of( subject_module::DetailXY )
       expect( model_instance.detail_z ).
@@ -242,7 +166,7 @@ describe SonJay::ObjectModel do
       end
 
       it "has number of entries equal to total number of defined properties" do
-        expect( model_instance.sonj_content.length ).to eq( 6 )
+        expect( model_instance.model_content.length ).to eq( 6 )
       end
       
     end
@@ -257,7 +181,7 @@ describe SonJay::ObjectModel do
         )
       end
 
-      it "parses from JSON with extra properties to an instance with defined properties filled in" do
+      it "parses from JSON with extra properties to an instance with only defined properties filled in" do
         json = <<-JSON
           {
             "aaa":  123  ,
@@ -277,6 +201,21 @@ describe SonJay::ObjectModel do
         expect( instance.detail_xy.yyy ).to eq('y')
         expect( instance.detail_z.zzz  ).to eq('z')
       end
+
+      it "can be explicitly, shallowly converted to an isolated hash" do
+        model_instance.aaa = 111
+        model_instance.bbb = 222
+
+        actual_hash = model_instance.to_h
+
+        model_instance.bbb = 999
+
+        expect( actual_hash.length ).to eq( 4 )
+        expect( actual_hash[ 'aaa' ] ).to eq( 111 )
+        expect( actual_hash[ 'bbb' ] ).to eq( 222 )
+        expect( actual_hash[ 'detail_xy' ] ).to equal( model_instance.detail_xy )
+        expect( actual_hash[ 'detail_z'  ] ).to equal( model_instance.detail_z  )
+      end
     end
 
     context "with extras allowed" do
@@ -298,15 +237,15 @@ describe SonJay::ObjectModel do
         expect( model_instance.aaa ).to eq( 111 )
         expect( model_instance.bbb ).to eq( 222 )
 
-        expect( model_instance.sonj_content.extra.to_h ).
+        expect( model_instance.model_content.extra.to_h ).
           to eq( 'qqq' => 333, 'rrr' => 444 )
       end
 
       it "allows name-index reading of both defined and arbitrary, extra properties" do
         model_instance.aaa = 111
         model_instance.bbb = 222
-        model_instance.sonj_content.extra[ 'qqq' ] = 333
-        model_instance.sonj_content.extra[ :rrr  ] = 444
+        model_instance.model_content.extra[ 'qqq' ] = 333
+        model_instance.model_content.extra[ :rrr  ] = 444
         expect( model_instance[ :aaa  ] ).to eq( 111 )
         expect( model_instance[ 'bbb' ] ).to eq( 222 )
         expect( model_instance[ :qqq  ] ).to eq( 333 )
@@ -355,6 +294,80 @@ describe SonJay::ObjectModel do
       end
     end
 
+    context "with subclasses" do
+      before do
+        module subject_module::M
+          class SubA < RootModel
+            properties do
+              property :ccc
+            end
+          end
+
+          class SubB < RootModel
+            allow_extras
+
+            properties do
+              property :detail_z2, model: DetailZ
+            end
+          end
+        end
+      end
+
+      let( :sub_a_class ) { subject_module::SubA }
+      let( :sub_b_class ) { subject_module::SubB }
+      let!( :sub_a_instance ) { sub_a_class.new }
+      let!( :sub_b_instance ) { sub_b_class.new }
+
+      it "allows a subclass to inherit property definitions from its parent" do
+        missing_property_names_a =
+          model_class.property_definitions.map( &:name ) -
+          sub_a_class.property_definitions.map( &:name )
+        expect( missing_property_names_a ).to eq( [] )
+
+        missing_property_names_b =
+          model_class.property_definitions.map( &:name ) -
+          sub_b_class.property_definitions.map( &:name )
+        expect( missing_property_names_b ).to eq( [] )
+      end
+
+      it "does not leak subclass property definitions to its parent" do
+        property_names = model_class.property_definitions.map(&:name)
+        expect( property_names ).not_to include( 'ccc' )
+        expect( property_names ).not_to include( 'detail_z2' )
+      end
+
+      it "allows a subclass to inherit property access behavior from its parent" do
+        sub_a_instance.aaa = 123
+        expect( sub_a_instance.aaa ).to eq( 123 )
+      end
+
+      it "allows adding value properties to the subclass" do
+        expect( sub_a_instance ).to respond_to( :ccc )
+      end
+
+      it "does not leak subclass value property definitions to its parent class" do
+        expect( model_instance ).not_to respond_to( :ccc )
+      end
+
+      it "allows adding model properties to the subclass" do
+        expect( sub_b_instance.detail_z2 ).to respond_to( :zzz )
+      end
+
+      it "does not leak subclass model property definitions to its parent class" do
+        expect( model_instance ).not_to respond_to( :detail_z2 )
+      end
+
+      it "supports subclass allowing extras when the parent class does not" do
+        sub_b_instance['xyz'] = 123
+        expect( sub_b_instance['xyz'] ).to eq( 123 )
+      end
+
+      it "does not leak allowing of extras to its parent class" do
+        expect{
+          model_instance['xyz'] = 123
+        }.to raise_exception( SonJay::PropertyNameError )
+      end
+    end
   end
 
   describe "a subclass with a directly self-referential property specification" do
@@ -400,6 +413,7 @@ describe SonJay::ObjectModel do
       expect{ subclass.property_definitions }.
         to raise_exception( SonJay::InfiniteRegressError )
     end
+
   end
 
 end

data/spec/son_jay_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe SonJay do
   it 'has a version number' do
-    SonJay::VERSION.should_not be_nil
+    expect( SonJay::VERSION ).not_to be_nil
   end
 end

data/spec/value_array_spec.rb

@@ -6,9 +6,9 @@ describe SonJay::ValueArray do
     expect( subject << 1 << 2 ).to eq( [1, 2] )
   end
 
-  describe '#sonj_content' do
+  describe '#model_content' do
     it "returns the instance itself" do
-      expect( subject.sonj_content ).to eq( subject )
+      expect( subject.model_content ).to eq( subject )
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: son_jay
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Steve Jorgensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,11 +124,11 @@ files:
 - lib/son_jay/acts_as_model.rb
 - lib/son_jay/model_array.rb
 - lib/son_jay/object_model.rb
-- lib/son_jay/object_model/extra_data.rb
-- lib/son_jay/object_model/properties.rb
-- lib/son_jay/object_model/properties/abstract.rb
-- lib/son_jay/object_model/properties/properties_with_extra.rb
-- lib/son_jay/object_model/properties/properties_without_extra.rb
+- lib/son_jay/object_model/content.rb
+- lib/son_jay/object_model/content/abstract.rb
+- lib/son_jay/object_model/content/content_with_extra.rb
+- lib/son_jay/object_model/content/content_without_extra.rb
+- lib/son_jay/object_model/content_data.rb
 - lib/son_jay/object_model/properties_definer.rb
 - lib/son_jay/object_model/property_definition.rb
 - lib/son_jay/object_model/property_definitions.rb
@@ -137,7 +137,9 @@ files:
 - son_jay.gemspec
 - spec/acts_as_model_spec.rb
 - spec/model_array_spec.rb
-- spec/object_model/extra_data_spec.rb
+- spec/object_model/content/content_with_extra_spec.rb
+- spec/object_model/content/content_without_extra_spec.rb
+- spec/object_model/content_data_spec.rb
 - spec/object_model/property_definition_spec.rb
 - spec/object_model_spec.rb
 - spec/son_jay_spec.rb
@@ -179,7 +181,9 @@ test_files:
 - features/support/env.rb
 - spec/acts_as_model_spec.rb
 - spec/model_array_spec.rb
-- spec/object_model/extra_data_spec.rb
+- spec/object_model/content/content_with_extra_spec.rb
+- spec/object_model/content/content_without_extra_spec.rb
+- spec/object_model/content_data_spec.rb
 - spec/object_model/property_definition_spec.rb
 - spec/object_model_spec.rb
 - spec/son_jay_spec.rb

data/lib/son_jay/object_model/extra_data.rb

@@ -1,36 +0,0 @@
-require 'forwardable'
-
-module SonJay
-  class ObjectModel
-
-    class ExtraData
-      extend Forwardable
-
-      def initialize
-        @data = {}
-      end
-
-      def []=(name, value)
-        name = "#{name}" unless String === name
-        @data[name] = value
-      end
-
-      def [](name)
-        name = "#{name}" unless String === name
-        @data[name]
-      end
-
-      def hash_merge(other)
-        @data.merge( other )
-      end
-
-      def to_h
-        @data.dup
-      end
-
-      def_delegator :@data, :empty?
-
-    end
-
-  end
-end

data/lib/son_jay/object_model/properties/properties_with_extra.rb

@@ -1,27 +0,0 @@
-module SonJay
-  class ObjectModel
-    module Properties
-
-      class PropertiesWithExtra < Abstract
-
-        def extra
-          @extra ||= ObjectModel::ExtraData.new
-        end
-
-        private
-
-        def load_extra_property(name_string, value)
-          extra[ name_string ] = value
-        end
-
-        def hash_for_json
-          extra.empty? ?
-            @data :
-            extra.hash_merge( @data )
-        end
-
-      end
-
-    end
-  end
-end

data/lib/son_jay/object_model/properties.rb

@@ -1,20 +0,0 @@
-require 'son_jay/object_model/properties/abstract'
-require 'son_jay/object_model/properties/properties_without_extra'
-require 'son_jay/object_model/properties/properties_with_extra'
-
-module SonJay
-  class ObjectModel
-
-    module Properties
-
-      def self.new(property_definitions, allow_extra)
-        klass = allow_extra ?
-          self::PropertiesWithExtra :
-          self::PropertiesWithoutExtra
-        klass.new( property_definitions )
-      end
-
-    end
-
-  end
-end

data/spec/object_model/extra_data_spec.rb

@@ -1,37 +0,0 @@
-require 'spec_helper'
-
-describe SonJay::ObjectModel::ExtraData do
-
-  it "provides value access by name symbol or string" do
-    subject[ :aaa  ] = 1
-    subject[ 'bbb' ] = 2
-    expect( subject[ 'aaa' ] ).to eq( 1 )
-    expect( subject[ :bbb  ] ).to eq( 2 )
-  end
-
-  it "merges with a hash, returning a hash" do
-    subject[ :aa  ] = 1
-    subject[ :bb  ] = 2
-
-    actual = subject.hash_merge(
-      "bb" => 22,
-      "cc" => 33
-    )
-
-    expect( actual ).to eq(
-      'aa' => 1,
-      'bb' => 22,
-      'cc' => 33
-    )
-  end
-
-  it "indicates when it is empty" do
-    expect( subject ).to be_empty
-  end
-
-  it "indicates when it is not empty" do
-    subject[:a] = 'a'
-    expect( subject ).not_to be_empty
-  end
-
-end