son_jay 0.4.1 → 0.5.0

data/spec/model_array_spec.rb

@@ -25,7 +25,7 @@ describe SonJay::ModelArray do
       end
 
       attr_accessor :loaded_data
-      def sonj_content ; Content.new(self) ; end
+      def model_content ; Content.new(self) ; end
     end }
 
     describe '::array_class' do
@@ -36,40 +36,101 @@ describe SonJay::ModelArray do
       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 "an instance" do
+      subject { subclass.new }
+
+      it "is initially empty" do
+        expect( subject ).to be_empty
+        expect( subject.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
+      describe "#additional" do
+        it "adds a new entry of the modeled type, and returns the entry" do
+          entry_0 = subject.additional
+          entry_1 = subject.additional
 
-        entry_0 = instance.additional
-        entry_1 = instance.additional
+          expect( entry_0 ).to be_kind_of( entry_class )
 
-        expect( entry_0 ).to be_kind_of( entry_class )
-        expect( instance.entries ).to eq( [entry_0, entry_1] )
+          expect( subject.entries ).to eq( [
+            entry_0,
+            entry_1
+          ] )
+        end
       end
-    end
 
-    describe '#load_data' do
-      it "loads entries in the given enumerable into its own model instance entries" do
-        instance = subclass.new
+      describe '#load_data' do
+        it "loads entries in the given enumerable into its own model instance entries" do
+          subject.load_data( ['entry 0 data', 'entry 1 data'] )
 
-        instance.load_data( ['entry 0 data', 'entry 1 data'] )
+          expect( subject.length ).to eq( 2 )
+          expect( subject[0].loaded_data ).to eq( 'entry 0 data' )
+          expect( subject[1].loaded_data ).to eq( 'entry 1 data' )
+        end
+      end
 
-        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' )
+      describe "#to_a" do
+        it "returns an isolated array of the entries" do
+          entry_0 = subject.additional
+          entry_1 = subject.additional
+
+          actual_array = subject.to_a
+
+          entry_2 = subject.additional
+
+          expect( actual_array ).to eq( [
+            entry_0,
+            entry_1
+          ] )
+        end
       end
-    end
 
-    describe '#sonj_content' do
-      it "returns the model array" do
-        expect( subject.sonj_content ).to equal( subject )
+      describe '#model_content' do
+        it "returns the model array" do
+          expect( subject.model_content ).to equal( subject )
+        end
       end
+
+      describe '#freeze' do
+        it "causes the instance to behave as frozen" do
+          subject.freeze
+          expect{ subject.additional }.to raise_exception( RuntimeError )
+        end
+      end
+
+      describe '#dup' do
+        it "makes a shallow copy" do
+          subject.additional
+          actual_dup = subject.dup
+          expect( actual_dup[0] ).to eq( subject[0] )
+          actual_dup.additional
+          expect( subject.length ).to eq( 1 )
+        end
+
+        it "returns a thawed copy of a frozen instance" do
+          subject.freeze
+          actual_dup = subject.dup
+          expect( actual_dup ).not_to be_frozen
+          expect{ actual_dup.additional }.not_to raise_exception
+        end
+      end
+
+      describe '#clone' do
+        it "makes a shallow copy" do
+          subject.additional
+          actual_clone = subject.clone
+          expect( actual_clone[0] ).to eq( subject[0] )
+          actual_clone.additional
+          expect( subject.length ).to eq( 1 )
+        end
+
+        it "returns a frozen copy of a frozen instance" do
+          subject.freeze
+          actual_clone = subject.clone
+          expect( actual_clone ).to be_frozen
+          expect{ actual_clone.additional }.to raise_exception( RuntimeError )
+        end
+      end
+
     end
   end
 end

data/spec/object_model/content/content_with_extra_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+module SonJay
+
+  describe ObjectModel::Content::ContentWithExtra do
+    let( :detail_xy_class ) { models_module::DetailXY }
+    let( :detail_z_class  ) { models_module::DetailZ  }
+
+    let( :models_module ) {
+      mod = Module.new
+      mod::M = mod
+
+      module mod::M
+        class DetailXY < SonJay::ObjectModel
+          properties do
+            property :xxx
+            property :yyy
+          end
+        end
+
+        class DetailZ < SonJay::ObjectModel
+          properties do
+            property :zzz
+          end
+        end
+      end
+
+      mod
+    }
+
+    let( :value_property_initializations ) {
+      ->(*) {
+        property :aaa
+        property :bbb
+      }
+    }
+    let( :object_model_property_initializations ) {
+      _xy_class = detail_xy_class
+      _z_class  = detail_z_class
+      ->(*) {
+        property :detail_xy , model: _xy_class
+        property :detail_z  , model: [_z_class]
+      }
+    }
+
+    context "with various properties defined" do
+      subject {
+        described_class.new( property_defs )
+      }
+      let( :property_defs ) {
+        ObjectModel::PropertyDefinitions.from_initializations( [
+          value_property_initializations,
+          object_model_property_initializations
+        ] )
+      }
+
+      it "provides access to an extra-properties object" do
+        expect( subject.extra.to_h ).to eq( {} )
+      end
+
+      it "rejects assignment of an undefined property" do
+        expect{
+          subject['qq'] = 0
+        }.to raise_exception(
+          SonJay::PropertyNameError
+        )
+      end
+
+      it "implements enumerable behaviors" do
+        expect( subject ).to respond_to( :entries )
+      end
+
+      it "enumerates entries for all defined properties and extra assigned property values" do
+        subject['bbb'] = 'B'
+        subject['detail_xy'].xxx = 'X'
+        subject.extra['qqq'] = 'Q'
+        subject.extra['rrr'] = nil
+        actual_pairs = []
+        subject.each do |*pair|
+          actual_pairs << pair
+        end
+        expect( actual_pairs ).to match_array( [
+          [ 'aaa', nil ],
+          [ 'bbb', 'B' ],
+          [ 'qqq', 'Q' ],
+          [ 'rrr', nil ],
+          [ 'detail_xy', subject['detail_xy'] ],
+          [ 'detail_z',  subject['detail_z' ] ],
+        ] )
+      end
+
+      describe '#freeze' do
+        it "causes the instance to behave as frozen" do
+          subject.freeze
+          expect{ subject['aaa'] = 1 }.to raise_exception( RuntimeError )
+          expect{ subject.extra['qq']  = 2 }.to raise_exception( RuntimeError )
+        end
+      end
+
+      describe '#dup' do
+        it "makes a shallow copy" do
+          subject[ 'aaa' ] = 'A'
+          subject[ 'bbb' ] = 'B'
+          subject.extra['qq'] = 'Q'
+          actual_dup = subject.dup
+          expect( actual_dup[ 'aaa' ] ).to eq( 'A' )
+          expect( actual_dup[ 'bbb' ] ).to eq( 'B' )
+          expect( actual_dup[ 'detail_xy' ] ).to equal( subject[ 'detail_xy' ] )
+          expect( actual_dup[ 'detail_z'  ] ).to equal( subject[ 'detail_z'  ] )
+          actual_dup[ 'bbb' ]    = 'BB'
+          actual_dup.extra['qq'] = 'QQ'
+          expect( subject['bbb']      ).to eq( 'B' )
+          expect( subject.extra['qq'] ).to eq( 'Q' )
+        end
+
+        it "returns a thawed copy of a frozen instance" do
+          subject.extra['qq'] = 11
+          subject.freeze
+          actual_dup = subject.dup
+          expect( actual_dup ).not_to be_frozen
+          actual_dup['aaa']      = 98
+          actual_dup.extra['qq'] = 99
+          expect( actual_dup['aaa']      ).to eq( 98 )
+          expect( actual_dup.extra['qq'] ).to eq( 99 )
+        end
+      end
+
+      describe '#clone' do
+        it "makes a shallow copy" do
+          subject[ 'aaa' ] = 'A'
+          subject[ 'bbb' ] = 'B'
+          subject.extra['qq'] = 'Q'
+          actual_clone = subject.clone
+          expect( actual_clone[ 'aaa' ] ).to eq( 'A' )
+          expect( actual_clone[ 'bbb' ] ).to eq( 'B' )
+          expect( actual_clone[ 'detail_xy' ] ).to equal( subject[ 'detail_xy' ] )
+          expect( actual_clone[ 'detail_z'  ] ).to equal( subject[ 'detail_z'  ] )
+          expect( actual_clone.extra['qq'] ).to eq('Q')
+          actual_clone['bbb']      = 'BB'
+          actual_clone.extra['qq'] = 'QQ'
+          expect( subject['bbb']      ).to eq( 'B' )
+          expect( subject.extra['qq'] ).to eq( 'Q' )
+        end
+
+        it "returns a frozen copy of a frozen instance" do
+          subject.extra['qq'] = 1
+          subject.freeze
+          actual_clone = subject.clone
+          expect( actual_clone ).to be_frozen
+          expect{ subject['aaa'] = 9 }.to raise_exception( RuntimeError )
+          expect{ subject.extra['qq'] = 9 }.to raise_exception( RuntimeError )
+        end
+      end
+    end
+
+    context "with value properties defined" do
+      subject {
+        described_class.new( property_defs )
+      }
+      let( :property_defs ) {
+        ObjectModel::PropertyDefinitions.from_initializations( [
+          value_property_initializations
+        ] )
+      }
+
+      it "has an initial number of entries equal to its number of defined properties" do
+        expect( subject.length ).to eq( 2 )
+      end
+
+      it "has name-indexed settable/gettable value properties by string or symbol" do
+        subject[ :aaa  ] =  1
+        subject[ 'bbb' ] = 'XYZ'
+
+        expect( subject[ 'aaa' ] ).to eq(  1    )
+        expect( subject[ :bbb  ] ).to eq( 'XYZ' )
+      end
+
+      it "has all property values nil by default" do
+        expect( subject[ 'aaa' ] ).to be_nil
+        expect( subject[ :bbb  ] ).to be_nil
+      end
+    end
+
+    context "with model properties defined" do
+      subject {
+        described_class.new( property_defs )
+      }
+      let( :property_defs ) {
+        ObjectModel::PropertyDefinitions.from_initializations( [
+          object_model_property_initializations
+        ] )
+      }
+
+      it "has name-indexed gettable values for defined properties by string or symbol" do
+        expect( subject[ 'detail_xy' ] ).to be_kind_of( detail_xy_class )
+        expect( subject[ :detail_z   ] ).to be_kind_of( detail_z_class::Array )
+      end
+    end
+  end
+
+end

data/spec/object_model/content/content_without_extra_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+
+module SonJay
+
+  describe ObjectModel::Content::ContentWithoutExtra do
+    let( :detail_xy_class ) { models_module::DetailXY }
+    let( :detail_z_class  ) { models_module::DetailZ  }
+
+    let( :models_module ) {
+      mod = Module.new
+      mod::M = mod
+
+      module mod::M
+        class DetailXY < SonJay::ObjectModel
+          properties do
+            property :xxx
+            property :yyy
+          end
+        end
+
+        class DetailZ < SonJay::ObjectModel
+          properties do
+            property :zzz
+          end
+        end
+      end
+
+      mod
+    }
+
+    let( :value_property_initializations ) {
+      ->(*) {
+        property :aaa
+        property :bbb
+      }
+    }
+    let( :object_model_property_initializations ) {
+      _xy_class = detail_xy_class
+      _z_class  = detail_z_class
+      ->(*) {
+        property :detail_xy , model: _xy_class
+        property :detail_z  , model: [_z_class]
+      }
+    }
+
+    context "with various properties defined" do
+      subject {
+        described_class.new( property_defs )
+      }
+      let( :property_defs ) {
+        ObjectModel::PropertyDefinitions.from_initializations( [
+          value_property_initializations,
+          object_model_property_initializations
+        ] )
+      }
+
+      it "rejects assignment of an undefined property" do
+        expect{
+          subject['qq'] = 0
+        }.to raise_exception(
+          SonJay::PropertyNameError
+        )
+      end
+
+      it "implements enumerable behaviors" do
+        expect( subject ).to respond_to( :entries )
+      end
+
+      it "enumerates entries for all defined properties" do
+        subject['bbb'] = 'B'
+        subject['detail_xy'].xxx = 'X'
+        actual_pairs = []
+        subject.each do |*pair|
+          actual_pairs << pair
+        end
+        expect( actual_pairs ).to match_array( [
+          [ 'aaa', nil ],
+          [ 'bbb', 'B' ],
+          [ 'detail_xy', subject['detail_xy'] ],
+          [ 'detail_z',  subject['detail_z' ] ],
+        ] )
+      end
+
+      describe '#freeze' do
+        it "causes the instance to behave as frozen" do
+          subject.freeze
+          expect{ subject['aaa'] = 1 }.to raise_exception( RuntimeError )
+        end
+      end
+
+      describe '#dup' do
+        it "makes a shallow copy" do
+          subject[ 'aaa' ] = 'A'
+          subject[ 'bbb' ] = 'B'
+          actual_dup = subject.dup
+          expect( actual_dup[ 'aaa' ] ).to eq( 'A' )
+          expect( actual_dup[ 'bbb' ] ).to eq( 'B' )
+          expect( actual_dup[ 'detail_xy' ] ).to equal( subject[ 'detail_xy' ] )
+          expect( actual_dup[ 'detail_z'  ] ).to equal( subject[ 'detail_z'  ] )
+          actual_dup[ 'bbb' ] = 'BB'
+          expect( subject['bbb'] ).to eq( 'B' )
+        end
+
+        it "returns a thawed copy of a frozen instance" do
+          subject.freeze
+          actual_dup = subject.dup
+          expect( actual_dup ).not_to be_frozen
+          actual_dup['aaa'] = 99
+          expect( actual_dup['aaa'] ).to eq( 99 )
+        end
+      end
+
+      describe '#clone' do
+        it "makes a shallow copy" do
+          subject[ 'aaa' ] = 'A'
+          subject[ 'bbb' ] = 'B'
+          actual_clone = subject.clone
+          expect( actual_clone[ 'aaa' ] ).to eq( 'A' )
+          expect( actual_clone[ 'bbb' ] ).to eq( 'B' )
+          expect( actual_clone[ 'detail_xy' ] ).to equal( subject[ 'detail_xy' ] )
+          expect( actual_clone[ 'detail_z'  ] ).to equal( subject[ 'detail_z'  ] )
+          actual_clone[ 'bbb' ] = 'BB'
+          expect( subject['bbb'] ).to eq( 'B' )
+        end
+
+        it "returns a frozen copy of a frozen instance" do
+          subject.freeze
+          actual_clone = subject.clone
+          expect( actual_clone ).to be_frozen
+          expect{ subject['aaa'] = 1 }.to raise_exception( RuntimeError )
+        end
+      end
+    end
+
+    context "with value properties defined" do
+      subject {
+        described_class.new( property_defs )
+      }
+      let( :property_defs ) {
+        ObjectModel::PropertyDefinitions.from_initializations( [
+          value_property_initializations
+        ] )
+      }
+
+      it "has an initial number of entries equal to its number of defined properties" do
+        expect( subject.length ).to eq( 2 )
+      end
+
+      it "has name-indexed settable/gettable value properties by string or symbol" do
+        subject[ :aaa  ] =  1
+        subject[ 'bbb' ] = 'XYZ'
+
+        expect( subject[ 'aaa' ] ).to eq(  1    )
+        expect( subject[ :bbb  ] ).to eq( 'XYZ' )
+      end
+
+      it "has all property values nil by default" do
+        expect( subject[ 'aaa' ] ).to be_nil
+        expect( subject[ :bbb  ] ).to be_nil
+      end
+    end
+
+    context "with model properties defined" do
+      subject {
+        described_class.new( property_defs )
+      }
+      let( :property_defs ) {
+        ObjectModel::PropertyDefinitions.from_initializations( [
+          object_model_property_initializations
+        ] )
+      }
+
+      it "has name-indexed gettable values for defined properties by string or symbol" do
+        expect( subject[ 'detail_xy' ] ).to be_kind_of( detail_xy_class )
+        expect( subject[ :detail_z   ] ).to be_kind_of( detail_z_class::Array )
+      end
+    end
+  end
+
+end

data/spec/object_model/content_data_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe SonJay::ObjectModel::ContentData 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
+
+  describe '#freeze' do
+    it "causes the instance to behave as frozen" do
+      subject.freeze
+      expect{ subject['a'] = 1 }.to raise_exception( RuntimeError )
+    end
+  end
+
+  describe '#dup' do
+    it "makes a shallow copy" do
+      subject[ 'aa' ] = 'A'
+      subject[ 'bb' ] = 'B'
+      actual_dup = subject.dup
+      expect( actual_dup.keys ).to match_array( ['aa', 'bb'] )
+      expect( actual_dup['aa'] ).to equal( subject['aa'] )
+      actual_dup['bb'] = 'BBB'
+      expect( subject['bb'] ).to eq( 'B' )
+    end
+
+    it "returns a thawed copy of a frozen instance" do
+      subject.freeze
+      actual_dup = subject.dup
+      expect( actual_dup ).not_to be_frozen
+      actual_dup['aa'] = 1
+      expect( actual_dup['aa'] ).to eq( 1 )
+    end
+  end
+
+  describe '#clone' do
+    it "makes a shallow copy" do
+      subject[ 'aa' ] = 'A'
+      subject[ 'bb' ] = 'B'
+      actual_clone = subject.clone
+      expect( actual_clone.keys ).to match_array( ['aa', 'bb'] )
+      expect( actual_clone['aa'] ).to equal( subject['aa'] )
+      actual_clone['bb'] = 'BBB'
+      expect( subject['bb'] ).to eq( 'B' )
+    end
+
+    it "returns a frozen copy of a frozen instance" do
+      subject.freeze
+      expect( subject.clone ).to be_frozen
+    end
+  end
+
+end