representable 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 887d742815c848ac3b63287c8858f2988a2de41d
-  data.tar.gz: 78fbbf862aed5b2de60a9bc2ed7375b327a3e058
+  metadata.gz: 23ffadf09dbcb9b8ec2540375586d5d967b4ba84
+  data.tar.gz: 462e4ac711a96341bdc049d30d9cd2b176cce7bd
 SHA512:
-  metadata.gz: a4e93c1474e69fb743ca1072fcee054f2e075e4eaf2902b9c885ee7c86b4156db93900889820a5375d61e97a3585c14b2e70931c91722791aec7cf21606226f6
-  data.tar.gz: 93f25a5475e27863649981e0cb5bd553c81b5c02cfe1e16c4c630c368ec972938c4453aae7660ce0e1caf1e67e640a2ff590c5f58d17e7597e0b1abcbc0644a9
+  metadata.gz: 8166f8d2581b7b54c6b2fbc21f632e09423c3feffae3d253724548f17fcdae9a88a4fe44d83702a1eb2e721a06e667e69e737727e3f602eb773316f0b0c36265
+  data.tar.gz: ce020f9d71a1ab7509f8be5401292c7bb268b05a92ef43817d1edc0ece6220c61a65293da9a5cf6604034b2b137b63d852dd6336d28460df0e9dce00832c8998

data/CHANGES.md

@@ -1,10 +1,19 @@
+# 2.2.1
+
+## API change.
+
+* Options in `Definition` are now Cloneable. That means they will deep-clone when they contain values that are `Cloneable`. This allows clean cloning of deeply nested configuration hashes, e.g. for `deserializer: {instance: ->{}}` in combination with inheritance across representers.
+
+  The former behavior was not to clone, which would allow sub-representers to bleed into the parent options, which is _wrong_. However, this fix shouldn't affect anyone but me.
+
+
 # 2.2.0
 
 ## New Stuff
 
 * Introduce `Representable::Cached` that will keep the mapper, which in turn will keep the bindings, which in turn will keep their representer, in case they're nested. You have to include this feature manually and you can expect a 50% and more speed-up for rendering and parsing. Not to speak about the reduced memory footprint.
 
-  ``ruby
+  ```ruby
   class SongDecorator < Representable::Decorator
     include Representable::JSON
     feature Representable::Cached

data/lib/representable.rb

@@ -88,9 +88,10 @@ private
       base.inherit_module!(self)
     end
 
-    def inherited(base) # DISCUSS: this could be in Decorator? but then we couldn't do B < A(include X) for non-decorators, right?
-      super
-      base.representable_attrs.inherit!(representable_attrs) # this should be inherit_class!
+    def inherited(subclass) # DISCUSS: this could be in Decorator? but then we couldn't do B < A(include X) for non-decorators, right?
+      # FIXME: subclass.representable_attrs is ALWAYS empty at this point.
+      subclass.representable_attrs.inherit!(representable_attrs) # this should be inherit_class!
+      # DISCUSS: this could also just be: subclass.inheritable_attr :representable_attrs --> superclass.representable_attrs.clone
     end
   end
 

data/lib/representable/config.rb

@@ -21,7 +21,7 @@ module Representable
     #
     # Overwrite definition_class if you need a custom Definition object (helpful when using
     # representable in other gems).
-    class Definitions < Inheritable::Hash
+    class Definitions < Inheritable::Hash # TODO: cloneable!
       def initialize(definition_class)
         @definition_class = definition_class
         super()

data/lib/representable/definition.rb

@@ -11,7 +11,7 @@ module Representable
 
     def initialize(sym, options={}, &block)
       @options = {}
-      # @options = Inheritable::Hash.new # allows deep cloning. we then had to set Pipeline cloneable.
+      @options = Cloneable::Hash.new # allows deep cloning. we then had to set Pipeline cloneable.
       @name    = sym.to_s
       options  = options.clone
 

data/lib/representable/deserializer.rb

@@ -84,7 +84,7 @@ module Representable
 
         fragment.each_with_index do |item_fragment, i|
           # add more per-item options here!
-          next if @binding.evaluate_option(:skip_parse, item_fragment)
+          next if @binding.evaluate_option(:skip_parse, item_fragment) # TODO: pass in index!
 
           collection << deserialize!(item_fragment, i) # FIXME: what if obj nil?
         end

data/lib/representable/inheritable.rb

@@ -1,9 +1,28 @@
 module Representable
   # Objects marked cloneable will be cloned in #inherit!.
   module Cloneable
+    # Implements recursive cloning for Hash.
+    # Values to clone have to include Cloneable.
+    class Hash < ::Hash
+      include Cloneable # This class is marked as Cloneable itself.
+
+      module Clone
+        def clone
+          self.class[ collect { |k,v| [k, clone_value(v)] } ]
+        end
+
+      private
+        def clone_value(value)
+          return value.clone if value.is_a?(Cloneable)
+          value
+        end
+      end
+      include Clone
+    end
   end
 
   # Objects marked cloneable will be inherit!ed in #inherit! when available in parent and child.
+  # TODO: #inherit! will be removed in future versions of Representable in favor of #clone, only. manually merging objects sucks.
   module Inheritable
     include Cloneable # all Inheritable are also Cloneable since #clone is one step of our inheritance.
 
@@ -15,10 +34,12 @@ module Representable
       end
     end
 
+    # TODO: remove me.
     class Hash < ::Hash
       include Inheritable
 
       module InstanceMethods
+        # FIXME: this method is currently run exactly once, for representable_attrs.inherit!(parent). it is only used for Config.
         def inherit!(parent)
           #merge!(parent.clone)
           for key in (parent.keys + keys).uniq

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "2.2.0"
+  VERSION = "2.2.1"
 end

data/representable.gemspec

@@ -27,7 +27,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "test_xml", "0.1.6"
   s.add_development_dependency "minitest", ">= 5.4.1"
-  s.add_development_dependency "mocha", ">= 0.13.0"
   s.add_development_dependency "mongoid"
   s.add_development_dependency "virtus"
   s.add_development_dependency "json", '>= 1.7.7'

data/test/definition_test.rb

@@ -171,6 +171,17 @@ class DefinitionTest < MiniTest::Spec
         assert_equal cloned[:volume], 8
       end
 
+      # cloning of Cloneables in @options.
+      it do
+        definition = Representable::Definition.new(:title)
+        definition.merge!(deserializer: Representable::Inheritable::Hash.new)
+
+        clone = definition.clone
+        clone[:deserializer].merge!(b: 2)
+
+        definition[:deserializer].object_id.wont_equal clone[:deserializer].object_id
+      end
+
       # pipeline gets cloned properly
       describe "pipeline cloning" do
         subject { Definition.new(:title, :render_filter => 1) }

data/test/inherit_test.rb

@@ -33,6 +33,7 @@ class InheritTest < MiniTest::Spec
     end
 
     it { SongRepresenter.prepare(Song.new(Struct.new(:string).new("Believe It"), 1)).to_hash.must_equal({"title"=>{"str"=>"Believe It"}, "no"=>1}) }
+    # the block doesn't override the inline representer.
     it { representer.prepare( Song.new(Struct.new(:string).new("Believe It"), 1)).to_hash.must_equal({"title"=>{"str"=>"Believe It"}, "no"=>1}) }
   end
 
@@ -99,7 +100,11 @@ class InheritTest < MiniTest::Spec
   describe ":inherit with decorator" do
     representer!(:decorator => true) do
       property :hit do
-        property :title
+        property :title, exec_context: :decorator
+
+        def title
+          "Cheap Transistor Radio"
+        end
       end
     end
 
@@ -112,8 +117,13 @@ class InheritTest < MiniTest::Spec
       end
     }
 
+    it { representer.new(OpenStruct.new(hit: OpenStruct.new(title: "I WILL BE OVERRIDDEN", :length => "2:59"))).to_hash.must_equal(
+      {"hit"=>{"title"=>"Cheap Transistor Radio"}}) }
+
+    # inheriting decorator inherits inline representer class (InlineRepresenter#title).
+    # inheriting decorator adds :length.
     it { inheriting.new(OpenStruct.new(:hit => OpenStruct.new(:title => "Hole In Your Soul", :length => "2:59"))).to_hash.must_equal(
-      {"hit"=>{"title"=>"Hole In Your Soul", "length"=>"2:59"}}) }
+      {"hit"=>{"title"=>"Cheap Transistor Radio", "length"=>"2:59"}}) }
   end
 
 

data/test/test_helper.rb

@@ -4,7 +4,6 @@ require 'representable/xml'
 require 'representable/yaml'
 require 'minitest/autorun'
 require 'test_xml/mini_test'
-require 'mocha/setup'
 
 class Album
   attr_accessor :songs, :best_song

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.4.1
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -293,53 +279,4 @@ signing_key:
 specification_version: 4
 summary: Renders and parses JSON/XML/YAML documents from and to Ruby objects. Includes
   plain properties, collections, nesting, coercion and more.
-test_files:
-- test/as_test.rb
-- test/benchmarking.rb
-- test/binding_test.rb
-- test/cached_test.rb
-- test/class_test.rb
-- test/coercion_test.rb
-- test/config/inherit_test.rb
-- test/config_test.rb
-- test/decorator_scope_test.rb
-- test/decorator_test.rb
-- test/definition_test.rb
-- test/example.rb
-- test/examples/object.rb
-- test/exec_context_test.rb
-- test/features_test.rb
-- test/filter_test.rb
-- test/for_collection_test.rb
-- test/generic_test.rb
-- test/getter_setter_test.rb
-- test/hash_bindings_test.rb
-- test/hash_test.rb
-- test/if_test.rb
-- test/inherit_test.rb
-- test/inheritable_test.rb
-- test/inline_test.rb
-- test/instance_test.rb
-- test/is_representable_test.rb
-- test/json_test.rb
-- test/lonely_test.rb
-- test/mongoid_test.rb
-- test/nested_test.rb
-- test/object_test.rb
-- test/parse_strategy_test.rb
-- test/pass_options_test.rb
-- test/prepare_test.rb
-- test/reader_writer_test.rb
-- test/realistic_benchmark.rb
-- test/represent_test.rb
-- test/representable_test.rb
-- test/schema_test.rb
-- test/serialize_deserialize_test.rb
-- test/skip_test.rb
-- test/stringify_hash_test.rb
-- test/test_helper.rb
-- test/test_helper_test.rb
-- test/wrap_test.rb
-- test/xml_bindings_test.rb
-- test/xml_test.rb
-- test/yaml_test.rb
+test_files: []