representable 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9d4b0e0fd7f3c2d7f94d5b95ed61118ec72eeed
-  data.tar.gz: e08e6250812c65c6206b5b3d0e64c43996262289
+  metadata.gz: 700ffc8c90d1f0c6b824d39a42b8af702967f2f2
+  data.tar.gz: e593985cdb6e362606b6d4dce794f5b6b4c7af50
 SHA512:
-  metadata.gz: a32f69c330b3e7809a7cdb136d7510beaf78fe59e2157a415e2e0fdcedf3fb09230bc009465ac9407d5870214bfd3b2780e0ca13417e0abce34c73a9fe9ef136
-  data.tar.gz: a0f4b545d84a68432a0738bd5ad2e9ff7597d4122852c66757e0a5b49d412500c694d274a0bf5e2c8c1f69ac2c7faec00f63a658e8c0067bea10b56c1b0c5048
+  metadata.gz: fb0bd53d3eb6750f5ec6e238eec0335566088a9a8f2ab18482c693e3949213d97bd8873b9a0076fa174f70ad96c6db70ad0233198e1fa84c60fb3e4354e3065a
+  data.tar.gz: daa85190ef4bdc5f93f79c161e8443df77d02bfd095231cd3bc2bd5bf4ddfc347c4210b210bea2b2e29717ee088e1ecb825360fc55ec6bd299e9a893e62d33e0

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 2.2.3
+
+* Introduce `Decorator::clone` to make sure cloning properly copies representable_attrs. in former versions, this would partially share definitions with subclasses when the decorator was an `inheritable_attr`.
+
 # 2.2.2
 
 * Bug fix: In 2.2.1 I accidentially removed a `super` call in `Representable::inherited` which leads to wrong behavior when having Representable mixed into a class along with other classes overriding `inherited`. Thanks to @jrmhaig for an [excellent bug report](https://github.com/apotonick/representable/issues/139#issuecomment-105926608) making it really easy to find the problem.

data/lib/representable/decorator.rb

@@ -14,6 +14,12 @@ module Representable
       Representable::Decorator
     end
 
+    # This is called from inheritable_attr when inheriting a decorator class to a subclass.
+    # Explicitly subclassing the Decorator makes sure representable_attrs is a clean version.
+    def self.clone
+      Class.new(self) # DISCUSS: why isn't this called by Ruby?
+    end
+
     include Representable # include after class methods so Decorator::prepare can't be overwritten by Representable::prepare.
 
     # TODO: implement that just by calling ::property(name, options){include mod} on the inheriting representer.
@@ -51,11 +57,9 @@ module Representable
 
   private
     def self.build_inline(base, features, name, options, &block)
-      Class.new(base || default_inline_class).tap do |decorator|
-        decorator.class_eval do # Ruby 1.8.7 wouldn't properly execute the block passed to Class.new!
-          feature *features
-          class_eval &block
-        end
+      Class.new(base || default_inline_class) do
+        feature *features
+        class_eval &block
       end
     end
   end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "2.2.2"
+  VERSION = "2.2.3"
 end

data/test/decorator_test.rb

@@ -73,3 +73,25 @@ class DecoratorTest < MiniTest::Spec
     end
   end
 end
+
+require "uber/inheritable_attr"
+class InheritanceWithDecoratorTest < MiniTest::Spec
+  class Twin
+    extend Uber::InheritableAttr
+    inheritable_attr :representer_class
+    self.representer_class = Representable::Decorator
+  end
+
+  class Album < Twin
+    representer_class.property :title # Twin.representer_class.clone
+  end
+
+  class Song < Twin # Twin.representer_class.clone
+  end
+
+  it do
+    Twin.representer_class.representable_attrs[:definitions].size.must_equal 0
+    Album.representer_class.representable_attrs[:definitions].size.must_equal 1
+    Song.representer_class.representable_attrs[:definitions].size.must_equal 0
+  end
+end

data/test/representable_test.rb

@@ -109,6 +109,56 @@ class RepresentableTest < MiniTest::Spec
       assert_xml_equal "<song name=\"Days Go By\"/>", @song.extend(SongXmlRepresenter).to_xml
       assert_json "{\"name\":\"Days Go By\"}", @song.extend(SongJsonRepresenter).to_json
     end
+
+
+    # test if we call super in
+    #   ::inherited
+    #   ::included
+    #   ::extended
+    module Representer
+      include Representable # overrides ::inherited.
+    end
+
+    class BaseClass
+      def self.inherited(subclass)
+        super
+        subclass.instance_eval { def other; end }
+      end
+
+      include Representable # overrides ::inherited.
+      include Representer
+    end
+
+    class SubClass < BaseClass # triggers Representable::inherited, then OtherModule::inherited.
+    end
+
+    # test ::inherited.
+    it do
+      BaseClass.respond_to?(:other).must_equal false
+      SubClass.respond_to?(:other).must_equal true
+    end
+
+    module DifferentIncluded
+      def included(includer)
+        includer.instance_eval { def different; end }
+      end
+    end
+
+    module CombinedIncluded
+      extend DifferentIncluded # defines ::included.
+      include Representable    # overrides ::included.
+    end
+
+    class IncludingClass
+      include Representable
+      include CombinedIncluded
+    end
+
+    # test ::included.
+    it do
+      IncludingClass.respond_to?(:representable_attrs) # from Representable
+      IncludingClass.respond_to?(:different)
+    end
   end
 
 

data/test/skip_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class SkipParseTest < MiniTest::Spec
   representer! do
-    property :title
+    property :title, skip_parse: lambda { |fragment, opts| opts[:skip?] and fragment == "skip me" }
     property :band,
       skip_parse: lambda { |fragment, opts| opts[:skip?] and fragment["name"].nil? }, class: OpenStruct do
         property :name
@@ -17,17 +17,32 @@ class SkipParseTest < MiniTest::Spec
   let (:song) { OpenStruct.new.extend(representer) }
 
   # do parse.
-  it { song.from_hash({"band" => {"name" => "Mute 98"}}, skip?: true).band.name.must_equal "Mute 98" }
-  it { song.from_hash({"airplays" => [{"station" => "JJJ"}]}, skip?: true).airplays[0].station.must_equal "JJJ" }
+  it do
+    song.from_hash({
+      "title"    => "Victim Of Fate",
+      "band"     => {"name" => "Mute 98"},
+      "airplays" => [{"station" => "JJJ"}]
+    }, skip?: true)
+
+    song.title.must_equal "Victim Of Fate"
+    song.band.name.must_equal "Mute 98"
+    song.airplays[0].station.must_equal "JJJ"
+  end
 
   # skip parsing.
-  it { song.from_hash({"band" => {}}, skip?: true).band.must_equal nil }
-  # skip_parse is _per item_.
   let (:airplay) { OpenStruct.new(station: "JJJ") }
-  it { song.from_hash({"airplays" => [{"station" => "JJJ"}, {}]}, skip?: true).airplays.must_equal [airplay] }
 
-  # it skips parsing of items as if they hadn't been in the document.
-  it { song.from_hash({"airplays" => [{"station" => "JJJ"}, {}, {"station" => "JJJ"}]}, skip?: true).airplays.must_equal [airplay, airplay] }
+  it do
+    song.from_hash({
+      "title"    => "skip me",
+      "band"     => {},
+      "airplays" => [{"station" => "JJJ"}, {}],
+    }, skip?: true)
+
+    song.title.must_equal nil
+    song.band.must_equal nil
+    song.airplays.must_equal [airplay]
+  end
 end
 
 class SkipRenderTest < MiniTest::Spec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -279,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: []