son_jay 0.4.1 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTEwY2YzOGQ2MTRkMzUxNTliNGQ3NWUzMWY1ZGVjNDJiMzVkN2FmZg==
+    MTRiYjYyNWM4NGRkZGMxZmRjNGEyYTNlMzU0MzdhMzZjZjZhYTEzMQ==
   data.tar.gz: !binary |-
-    NjVkMGQ5MDNmYmQyZDQ1MTU0NmQ1ZDgzZDczZmZkMWFiNzUxN2NhOA==
+    MTBjNDdmNDcxZDg0MjExY2RlNzEwYzA4MTlkZmMyZTY2NTFjYTZkOQ==
 SHA512:
   metadata.gz: !binary |-
-    YjIxZWJjODE3MDEzNGViMTJlMzQxYTRjODc5M2IxMmJlYTE0OWVjYzMxYjky
-    NThkMzMxYTQ4ZDBkZWE0NzlmYjhkNDY0NDgyNmVlZTI3MWUxYWQxYzUwN2Y1
-    ZTI5NTQyNmMxMmE4YmRhYjNhMTBjZTc0MzUxNDVjZDExMWEwZmM=
+    NjA5NWU3MzMyNDZmMzFkMDBlNTdmNmIxODdlNmFiYjczMjg0OTBlYTRhYjZk
+    ZWZmYWNhMzAyMjJiNDM2MWY3OTJlZGMxNGFlMWQxYmZlMTM5OTA2MDEyZjhj
+    MTIyY2JhODAyNDViNTQ1Njc1YWNlMGQyNjNlMTM3Mjk5MGFjM2U=
   data.tar.gz: !binary |-
-    M2I5Y2ZmYjk3ZTA4NjBiNWFhNmRhNDNkMjgwYjEyY2YxZGM0MDAzNDEyODg3
-    YzM1ZGRhNWNmOTdhNTU1YjljMDQ2ZWY2Nzc3NWVhOGM5Y2ViODc0NzBmNGZk
-    NzA4YzNiNWY0MjRlNTEwZGNmYjdiYTQ0ODEyNjZiOTAwMzNmZjc=
+    ZTRjY2M4ZGExOGQ1MjlhOWE0YmU1ZjM5YWExNDIzOTgwOTQzNjIzMDhkNzY4
+    ZjI5NDE2NzZlNGVmNDAwN2IwZjFmZjQ5ODU3NmM0MWVmMTRmMWI1MDRjYmM5
+    MDI1ODU4ZGU3YTkzNjI4NGRkMjg1OGY5Y2VlMDUwOTFlNjUxMTg=

data/CHANGELOG.md

@@ -1,5 +1,17 @@
+### 0.5.0
+* Enhancements
+  * Allow subclassing/extending model classes
+  * Access content of model instances using #model_content
+    instead of #sonj_content
+  * Implement well-behaved #freeze, #dup, and #clone for model
+    instances
+  * Expose additional Array/Enumerable behavior for model-array
+    instances
+  * Implement #to_a for model-array instances
+  * Implement #to_h for object-model instances
+
 ### 0.4.1
-* Enhamcements
+* Enhancements
   * Add this CHANGELOG.md file
   * Made feature scenarios more informative regarding bracket
     operator behavior for defined properties when extra

data/lib/son_jay/acts_as_model.rb

@@ -5,12 +5,17 @@ module SonJay
       other.extend ClassBehavior
     end
 
+    # Deprecated
+    def sonj_content
+      model_content
+    end
+
     module ClassBehavior
 
       def parse_json(json)
         data = JSON.parse( json )
         instance = new
-        instance.sonj_content.load_data data
+        instance.model_content.load_data data
         instance
       end
 

data/lib/son_jay/model_array.rb

@@ -1,6 +1,7 @@
 require 'forwardable'
 
 module SonJay
+  include Enumerable
 
   def self.ModelArray(entry_class)
     Class.new(ModelArray).tap{ |c|
@@ -21,7 +22,7 @@ module SonJay
       @entries = []
     end
 
-    def sonj_content
+    def model_content
       self
     end
 
@@ -33,17 +34,57 @@ module SonJay
 
     def load_data(data)
       data.each do |entry_data|
-        additional.sonj_content.load_data entry_data
+        additional.model_content.load_data entry_data
       end
     end
 
+    def freeze
+      super
+      @entries.freeze
+      self
+    end
+
+    def dup
+      new_copy = super
+      new_copy.instance_variable_set :@entries, @entries.dup
+      new_copy
+    end
+
+    def clone
+      new_copy = super
+      new_copy.instance_variable_set :@entries, @entries.clone unless new_copy.frozen?
+      new_copy
+    end
+
     def_delegators :@entries, *[
       :[] ,
+      :at ,
+      :choice,
+      :collect,
+      :count ,
+      :cycle ,
+      :drop ,
+      :drop_while ,
+      :each ,
+      :each_index,
       :empty? ,
       :entries ,
+      :fetch ,
+      :find_index ,
+      :first ,
+      :include? ,
+      :index ,
+      :last ,
       :length ,
+      :map ,
+      :product ,
+      :size ,
       :to_json ,
+      :to_yaml ,
+      :zip
     ]
 
+    alias to_a entries
+
   end
 end

data/lib/son_jay/object_model/{properties → content}/abstract.rb

@@ -2,22 +2,21 @@ require 'forwardable'
 
 module SonJay
   class ObjectModel
-    module Properties
+    module Content
 
       class Abstract
         extend Forwardable
+        include Enumerable
 
         attr_reader :model_properties
 
         def initialize(property_definitions)
           @property_definitions = property_definitions
-          @data = {}
+          @data = ObjectModel::ContentData.new
           @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
+
+          init_properties \
+            *property_definitions.partition { |md| !! md.model_class }
         end
 
         def_delegators :@data, *[
@@ -67,11 +66,48 @@ module SonJay
           hash_for_json.to_json( options )
         end
 
+        def each
+          raise NotImplementedError, "Subclass responsibility"
+        end
+
+        def freeze
+          super
+          @data.freeze
+          self
+        end
+
+        def dup
+          new_copy = super
+          new_copy.instance_variable_set :@data,             @data.dup
+          new_copy.instance_variable_set :@model_properties, @model_properties.dup
+          new_copy
+        end
+
+        def clone
+          new_copy = super
+          unless new_copy.frozen?
+            new_copy.instance_variable_set :@data,             @data.clone
+            new_copy.instance_variable_set :@model_properties, @model_properties.clone
+          end
+          new_copy
+        end
+
         private
 
+        def init_properties(model_property_defs, value_property_defs)
+          value_property_defs.each do |d|
+            @data[d.name] = nil
+          end
+
+          model_property_defs.each do |d|
+            @data[d.name] = d.model_class.new
+            @model_properties << d.name
+          end
+        end
+
         def load_defined_property(name_string, value)
           if @model_properties.include?( name_string )
-            @data[ name_string ].sonj_content.load_data value
+            @data[ name_string ].model_content.load_data value
           else
             @data[ name_string ] = value
           end

data/lib/son_jay/object_model/content/content_with_extra.rb

@@ -0,0 +1,63 @@
+module SonJay
+  class ObjectModel
+    module Content
+
+      class ContentWithExtra < Abstract
+
+        def extra
+          @extra ||= ObjectModel::ContentData.new
+        end
+
+        def each
+          @data.each do |(name, value)|
+            yield name, value
+          end
+          @extra.each do |(name, value)|
+            yield name, value
+          end
+        end
+
+        def freeze
+          super
+          @extra.freeze
+          self
+        end
+
+        def dup
+          new_copy = super
+          new_copy.instance_variable_set :@extra, @extra.dup if defined? @extra
+          new_copy
+        end
+
+        def clone
+          new_copy = super
+          if (defined? @extra) && (! new_copy.frozen?)
+            p new_copy.frozen?
+            new_copy.instance_variable_set :@extra, @extra.clone
+          end
+          new_copy
+        end
+
+        def to_h
+          extra.empty? ?
+            @data.dup :
+            extra.hash_merge( @data )
+        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/properties_without_extra.rb → content/content_without_extra.rb}

@@ -1,13 +1,23 @@
 module SonJay
   class ObjectModel
-    module Properties
+    module Content
 
-      class PropertiesWithoutExtra < Abstract
+      class ContentWithoutExtra < Abstract
 
         def extra
           raise SonJay::DisabledMethodError
         end
 
+        def each
+          @data.each do |(name, value)|
+            yield name, value
+          end
+        end
+
+        def to_h
+          @data.dup
+        end
+
         private
 
         def load_extra_property(name_string, value)

data/lib/son_jay/object_model/content.rb

@@ -0,0 +1,20 @@
+require 'son_jay/object_model/content/abstract'
+require 'son_jay/object_model/content/content_without_extra'
+require 'son_jay/object_model/content/content_with_extra'
+
+module SonJay
+  class ObjectModel
+
+    module Content
+
+      def self.new(property_definitions, allow_extra)
+        klass = allow_extra ?
+          self::ContentWithExtra :
+          self::ContentWithoutExtra
+        klass.new( property_definitions )
+      end
+
+    end
+
+  end
+end

data/lib/son_jay/object_model/content_data.rb

@@ -0,0 +1,74 @@
+require 'forwardable'
+
+module SonJay
+  class ObjectModel
+
+    class ContentData
+      extend Forwardable
+      include Enumerable
+
+      def initialize(data = {})
+        @data = data.to_hash
+      end
+
+      def []=(name, value)
+        name = "#{name}" unless String === name
+        @data[name] = value
+      end
+
+      def fetch(name, *args)
+        name = "#{name}" unless String === name
+        block_given? ?
+          @data.fetch(name, *args) { |*args| yield *args } :
+          @data.fetch(name, *args)
+      end
+
+      def [](name)
+        name = "#{name}" unless String === name
+        @data[name]
+      end
+
+      def hash_merge(other)
+        @data.dup.tap { |result|
+          other.each do |name, value|
+            name = "#{name}" unless String === name
+            result[name] = value
+          end
+        }
+      end
+
+      def hash_merge(other)
+        @data.dup.tap { |result|
+          other.each do |name, value|
+            result[name] = value
+          end
+        }
+      end
+
+      def freeze
+        @data.freeze
+        super
+      end
+
+      def to_h
+        @data.dup
+      end
+
+      def dup
+        self.class.new( @data.dup )
+      end
+
+      def clone
+        new_copy = super
+        unless new_copy.frozen?
+          new_copy.instance_variable_set :@data, @data.clone
+        end
+        new_copy
+      end
+
+      def_delegators :@data, :each, :length, :keys, :has_key?, :empty?, :to_json
+
+    end
+
+  end
+end

data/lib/son_jay/object_model/property_definitions.rb

@@ -22,11 +22,23 @@ module SonJay
         @name_symbol_to_string_map = {}
       end
 
+      def +(other)
+        sum = self.class.new
+        each do |property_definition|
+          sum << property_definition
+        end
+        other.each do |property_definition|
+          sum << property_definition
+        end
+        sum
+      end
+
       def <<(definition)
         @definitions << definition
         name = definition.name
         @names << name
         @name_symbol_to_string_map[name.to_sym] = name
+        self
       end
 
       def_delegators :@definitions, :each

data/lib/son_jay/object_model.rb

@@ -1,25 +1,29 @@
 require 'set'
-require 'son_jay/object_model/properties'
+require 'son_jay/object_model/content_data'
+require 'son_jay/object_model/content'
 require 'son_jay/object_model/property_definition'
 require 'son_jay/object_model/property_definitions'
 require 'son_jay/object_model/properties_definer'
-require 'son_jay/object_model/extra_data'
 
 module SonJay
   class ObjectModel
     include ActsAsModel
 
-    attr_reader :sonj_content
+    attr_reader :model_content
 
     def initialize
       definitions = self.class.property_definitions
-      @sonj_content = ObjectModel::Properties.new(
+      @model_content = ObjectModel::Content.new(
         definitions, self.class.extras_allowed?
       )
     end
 
     def to_json(*args)
-      sonj_content.to_json( *args )
+      model_content.to_json( *args )
+    end
+
+    def to_h
+      model_content.to_h
     end
 
     def []=(name, value)
@@ -35,18 +39,18 @@ module SonJay
     end
 
     def fetch(name)
-      sonj_content.fetch( name )
+      model_content.fetch( name )
     end
 
     private
 
     def property_store_for(name_string)
-      store = sonj_content
+      store = model_content
       if (
         self.class.extras_allowed? &&
         (! self.class.property_definitions.include_name?(name_string) )
       ) then
-        store = sonj_content.extra
+        store = model_content.extra
       end
       store
     end
@@ -72,11 +76,27 @@ module SonJay
       end
 
       def _evaluate_property_definitions
-        @property_definitions = PropertyDefinitions.from_initializations(
-          _property_initializations
-        )
+        _populate_property_definitions
         _validate_model_dependencies!
         _apply_property_definitions property_definitions
+        _property_definitions
+      end
+
+      def _populate_property_definitions
+        @property_definitions =
+          _inherited_property_definitions +
+          PropertyDefinitions.from_initializations(
+            _property_initializations
+          )
+      end
+
+      def _inherited_property_definitions
+        self == SonJay::ObjectModel ?
+          PropertyDefinitions.new :
+          superclass.property_definitions
+      end
+
+      def _property_definitions
         @property_definitions
       end
 
@@ -88,8 +108,8 @@ module SonJay
         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
+            def #{name}         ; model_content[#{name.inspect}]         ; end
+            def #{name}=(value) ; model_content[#{name.inspect}] = value ; end
           CODE
         end
       end

data/lib/son_jay/value_array.rb

@@ -2,7 +2,7 @@ module SonJay
   class ValueArray < ::Array
     include ActsAsModel
 
-    def sonj_content
+    def model_content
       self
     end
 

data/lib/son_jay/version.rb

@@ -1,3 +1,3 @@
 module SonJay
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/spec/acts_as_model_spec.rb

@@ -15,16 +15,16 @@ describe SonJay::ActsAsModel do
           end
         end
 
-        def sonj_content
-          @sonj_content ||= Content.new
+        def model_content
+          @model_content ||= Content.new
         end
       end
     }
 
     describe '::parse_json' do
-      it "returns a new instance with parsed JSON data loaded into its #sonj_content object" do
+      it "returns a new instance with parsed JSON data loaded into its #model_content object" do
         instance = klass.parse_json( '{"hello": "world"}' )
-        loaded_data = instance.sonj_content.loaded_data
+        loaded_data = instance.model_content.loaded_data
         expect( loaded_data ).to eq( {'hello' => 'world'} )
       end
     end