representable 2.3.0 → 2.4.0.rc1

data/test/represent_test.rb

@@ -6,7 +6,7 @@ class RepresentTest < MiniTest::Spec
 
   for_formats(
     :hash => [Representable::Hash, out=[{"name" => "Days Go By"}, {"name"=>"Can't Take Them All"}], out],
-    :json => [Representable::JSON, out="[{\"name\":\"Days Go By\"},{\"name\":\"Can't Take Them All\"}]", out],
+    # :json => [Representable::JSON, out="[{\"name\":\"Days Go By\"},{\"name\":\"Can't Take Them All\"}]", out],
     # :xml  => [Representable::XML,  out="<a><song></song><song></song></a>", out]
   ) do |format, mod, output, input|
 
@@ -40,7 +40,7 @@ class RepresentTest < MiniTest::Spec
       }
 
       it { render(representer.represent(songs)).must_equal_document output }
-      it { parse(representer.represent([]), input).must_equal songs }
+      it("ficken") { parse(representer.represent([]), input).must_equal songs }
     end
   end
 

data/test/representable_test.rb

@@ -281,39 +281,48 @@ class RepresentableTest < MiniTest::Spec
     end
 
     describe "passing options" do
-      class Track
-        attr_accessor :nr
-      end
-
       module TrackRepresenter
         include Representable::Hash
-        property :nr
 
-        def to_hash(options)
-          @nr = options[:nr]
-          super
-        end
-        def from_hash(data, options)
-          super.tap do
-            @nr = options[:nr]
-          end
-        end
       end
 
       representer! do
-        property :track, :extend => TrackRepresenter, :class => Track
-      end
+        property :track, class: OpenStruct do
+          property :nr
+
+          property :length, class: OpenStruct do
+            def to_hash(options)
+              {seconds: options[:nr]}
+            end
+
+            def from_hash(hash, options)
+              super.tap do
+                self.seconds = options[:nr]
+              end
+            end
+          end
 
-      describe "#to_hash" do
-        it "propagates to nested objects" do
-          Song.new("Ocean Song", Track.new).extend(representer).to_hash(:nr => 9).must_equal({"track"=>{"nr"=>9}})
+          def to_hash(options)
+            super.merge({"nr" => options[:nr]})
+          end
+
+          def from_hash(data, options)
+            super.tap do
+              self.nr = options[:nr]
+            end
+          end
         end
       end
 
-      describe "#from_hash" do
-        it "propagates to nested objects" do
-          Song.new.extend(representer).from_hash({"track"=>{"nr" => "replace me"}}, :nr => 9).track.nr.must_equal 9
-        end
+      it "#to_hash propagates to nested objects" do
+        OpenStruct.new(track: OpenStruct.new(nr: 1, length: OpenStruct.new(seconds: nil))).extend(representer).extend(Representable::Debug).
+          to_hash(nr: 9).must_equal({"track"=>{"nr"=>9, "length"=>{seconds: 9}}})
+      end
+
+      it "#from_hash propagates to nested objects" do
+        song = OpenStruct.new.extend(representer).from_hash({"track"=>{"nr" => "replace me", "length"=>{"seconds"=>"replacing"}}}, :nr => 9)
+        song.track.nr.must_equal 9
+        song.track.length.seconds.must_equal 9
       end
     end
   end
@@ -358,34 +367,6 @@ class RepresentableTest < MiniTest::Spec
       assert_equal({"name"=>"No One's Choice","groupies"=>false}, @band.to_hash)
     end
 
-    describe "when :render_nil is true" do
-      it "includes nil attribute" do
-        mod = Module.new do
-          include Representable::JSON
-          property :name
-          property :groupies, :render_nil => true
-        end
-
-        @band.extend(mod) # FIXME: use clean object.
-        @band.groupies = nil
-        hash = @band.to_hash
-        assert_equal({"name"=>"No One's Choice", "groupies" => nil}, hash)
-      end
-
-      it "includes nil attribute without extending" do
-        mod = Module.new do
-          include Representable::JSON
-          property :name
-          property :groupies, :render_nil => true, :extend => BandRepresentation
-        end
-
-        @band.extend(mod) # FIXME: use clean object.
-        @band.groupies = nil
-        hash = @band.to_hash
-        assert_equal({"name"=>"No One's Choice", "groupies" => nil}, hash)
-      end
-    end
-
     it "does not propagate private options to nested objects" do
       cover_rpr = Module.new do
         include Representable::Hash
@@ -519,7 +500,7 @@ class RepresentableTest < MiniTest::Spec
       representer! do
         class MyBinding < Representable::Binding
           def write(doc, *args)
-            doc[:title] = @represented.title
+            doc[:title] = represented.title
           end
         end
         property :title, :binding => lambda { |*args| MyBinding.new(*args) }
@@ -563,55 +544,4 @@ class RepresentableTest < MiniTest::Spec
       end
     end
   end
-
-
-  describe "#use_decorator" do
-    representer! do
-      property :title, :use_decorator => true do
-        property :lower
-      end
-    end
-
-    it "uses a Decorator for inline representer" do
-      outer = Struct.new(:title, :lower, :band, :bla).new(inner = Struct.new(:lower).new("paper wings"))
-
-      outer.extend(representer).to_hash.must_equal({"title"=>{"lower"=>"paper wings"}})
-      outer.must_be_kind_of Representable::Hash
-      inner.wont_be_kind_of Representable::Hash
-    end
-  end
-
-
-  # using your own Definition class
-  class StaticDefinition < Representable::Definition
-    def initialize(name, options)
-      options[:as] = :Name
-      super
-    end
-  end
-
-
-  module StaticRepresenter
-    def self.build_config
-      Representable::Config.new(StaticDefinition)
-    end
-    include Representable::Hash
-
-    property :title
-  end
-
-  # we currently need an intermediate decorator to inherit ::build_config properly.
-  class BaseDecorator < Representable::Decorator
-    include Representable::Hash
-    def self.build_config
-      Representable::Config.new(StaticDefinition)
-    end
-  end
-
-  class StaticDecorator < BaseDecorator
-    property :title
-  end
-
-  it { OpenStruct.new(:title => "Tarutiri").extend(StaticRepresenter).to_hash.must_equal({"Name"=>"Tarutiri"}) }
-  it { StaticDecorator.new(OpenStruct.new(:title => "Tarutiri")).to_hash.must_equal({"Name"=>"Tarutiri"}) }
 end

data/test/schema_test.rb

@@ -109,7 +109,6 @@ class SchemaTest < MiniTest::Spec
 
 
   class InheritFromDecorator < InheritDecorator
-
     property :label, inherit: true do
       collection :employees do
         property :name
@@ -117,6 +116,9 @@ class SchemaTest < MiniTest::Spec
     end
   end
 
+  require "pp"
+  pp InheritFromDecorator.representable_attrs.get(:label)[:extend].(nil).representable_attrs
+
   it do
     InheritFromDecorator.new(band).to_hash.must_equal({"genre"=>"Punkrock", "label"=>{"name"=>"Fat Wreck", "city"=>"San Francisco", "employees"=>[{"name"=>"Mike"}], "location"=>{"city"=>"Sanfran"}}})
   end
@@ -125,6 +127,8 @@ end
 
 class ApplyTest < MiniTest::Spec
   class AlbumDecorator < Representable::Decorator
+    include Representable::Hash
+
     property :title
 
     property :hit do
@@ -141,18 +145,4 @@ class ApplyTest < MiniTest::Spec
       end
     end
   end
-
-  # #apply
-  it do
-    properties = []
-
-    AlbumDecorator.apply do |dfn|
-      properties << dfn.name
-      dfn.merge! :cool => true
-    end.must_equal AlbumDecorator
-
-    properties.must_equal ["title", "hit", "title", "songs", "title", "band", "label", "name"]
-    # writeable
-    AlbumDecorator.representable_attrs.get(:band).representer_module.representable_attrs.get(:label).representer_module.representable_attrs.get(:name)[:cool].must_equal true
-  end
 end

data/test/serialize_deserialize_test.rb

@@ -7,7 +7,7 @@ class SerializeDeserializeTest < BaseTest
     representer! do
       property :song,
         :instance => lambda { |fragment, *| fragment.to_s.upcase },
-        :prepare  => lambda { |fragment, *| fragment }, # TODO: allow false.
+        :prepare  => lambda { |fragment, *| fragment },
         :deserialize => lambda { |object, fragment, args|
           "#{object} #{fragment} #{args.inspect}"
         }
@@ -20,7 +20,7 @@ class SerializeDeserializeTest < BaseTest
     representer! do
       property :song,
         :representable => true,
-        :prepare  => lambda { |fragment, *| fragment }, # TODO: allow false.
+        :prepare  => lambda { |fragment, *| fragment },
         :serialize => lambda { |object, args|
           "#{object} #{args.inspect}"
         }

data/test/skip_test.rb

@@ -9,7 +9,7 @@ class SkipParseTest < MiniTest::Spec
     end
 
     collection :airplays,
-      skip_parse: lambda { |fragment, opts| puts fragment.inspect; opts[:skip?] and fragment["station"].nil? }, class: OpenStruct do
+      skip_parse: lambda { |fragment, opts| opts[:skip?] and fragment["station"].nil? }, class: OpenStruct do
         property :station
     end
   end

data/test/test_helper.rb

@@ -1,10 +1,16 @@
 require 'representable'
+
+require "json"
+require "psych"
+
 require 'representable/json'
 require 'representable/xml'
 require 'representable/yaml'
 require 'minitest/autorun'
 require 'test_xml/mini_test'
 
+require "representable/debug"
+
 class Album
   attr_accessor :songs, :best_song
   def initialize(songs=nil, best_song=nil)

data/test/uncategorized_test.rb

@@ -0,0 +1,67 @@
+require "test_helper"
+
+class StopWhenIncomingObjectFragmentIsNilTest < MiniTest::Spec
+  Album = Struct.new(:id, :songs)
+  Song  = Struct.new(:title)
+
+  representer!(decorator: true) do
+    property :id
+    collection :songs, class: Song, parse_pipeline: ->(input, options) { # TODO: test if :doc is set for parsing. test if options are ok and contain :user_options!
+                Representable::Pipeline[*parse_functions.insert(3, Representable::StopOnNil)]
+                } do
+      property :title
+    end
+  end
+
+  it do
+    album = Album.new
+    representer.new(album).from_hash({"id"=>1, "songs"=>[{"title"=>"Walkie Talkie"}]}).songs.must_equal [Song.new("Walkie Talkie")]
+  end
+
+  it do
+    album = Album.new(2, ["original"])
+    representer.new(album).from_hash({"id"=>1, "songs"=>nil}).songs.must_equal ["original"]
+  end
+
+end
+
+class RenderPipelineOptionTest < MiniTest::Spec
+  Album   = Struct.new(:id, :songs)
+  NilToNA = ->(input, options) { input.nil? ? "n/a" : input }
+
+  representer!(decorator: true) do
+    property :id, render_pipeline: ->(input, options) do
+      Representable::Pipeline[*render_functions.insert(2, options[:user_options][:function])]
+    end
+  end
+
+  it { representer.new(Album.new).to_hash(function: NilToNA).must_equal({"id"=>"n/a"}) }
+  it { representer.new(Album.new(1)).to_hash(function: NilToNA).must_equal({"id"=>1}) }
+
+  it "is cached" do
+    decorator = representer.new(Album.new)
+    decorator.to_hash(function: NilToNA).must_equal({"id"=>"n/a"})
+    decorator.to_hash(function: nil).must_equal({"id"=>"n/a"}) # non-sense function is not applied.
+  end
+
+end
+
+class ParsePipelineOptionTest < MiniTest::Spec
+  Album   = Struct.new(:id, :songs)
+  NilToNA = ->(input, options) { input.nil? ? "n/a" : input }
+
+  representer!(decorator: true) do
+    property :id, parse_pipeline: ->(input, options) do
+      Representable::Pipeline[*parse_functions.insert(3, options[:user_options][:function])].extend(Representable::Pipeline::Debug)
+    end
+  end
+
+  it { representer.new(Album.new).from_hash({"id"=>nil}, function: NilToNA).id.must_equal "n/a" }
+  it { representer.new(Album.new(1)).to_hash(function: NilToNA).must_equal({"id"=>1}) }
+
+  it "is cached" do
+    decorator = representer.new(Album.new)
+    decorator.from_hash({"id"=>nil}, function: NilToNA).id.must_equal "n/a"
+    decorator.from_hash({"id"=>nil}, function: "nonsense").id.must_equal "n/a" # non-sense function is not applied.
+  end
+end

data/test/xml_bindings_test.rb

@@ -29,16 +29,16 @@ class XMLBindingTest < MiniTest::Spec
   describe "AttributeBinding" do
     describe "with plain text items" do
       before do
-        @property = Representable::XML::Binding::Attribute.new(Representable::Definition.new(:name, :attribute => true), nil)
+        @property = Representable::XML::Binding::Attribute.new(Representable::Definition.new(:name, :attribute => true))
       end
 
       it "extracts with #read" do
-        assert_equal "The Gargoyle", @property.read(Nokogiri::XML("<song name=\"The Gargoyle\" />").root)
+        assert_equal "The Gargoyle", @property.read(Nokogiri::XML("<song name=\"The Gargoyle\" />").root, "name")
       end
 
       it "inserts with #write" do
         parent = Nokogiri::XML::Node.new("song", @doc)
-        @property.write(parent, "The Gargoyle")
+        @property.write(parent, "The Gargoyle", "name")
         assert_xml_equal("<song name=\"The Gargoyle\" />", parent.to_s)
       end
     end
@@ -46,16 +46,16 @@ class XMLBindingTest < MiniTest::Spec
 
   describe "ContentBinding" do
     before do
-      @property = Representable::XML::Binding::Content.new(Representable::Definition.new(:name, :content => true), nil)
+      @property = Representable::XML::Binding::Content.new(Representable::Definition.new(:name, :content => true))
     end
 
     it "extracts with #read" do
-      assert_equal "The Gargoyle", @property.read(Nokogiri::XML("<song>The Gargoyle</song>").root)
+      assert_equal "The Gargoyle", @property.read(Nokogiri::XML("<song>The Gargoyle</song>").root, "song")
     end
 
     it "inserts with #write" do
       parent = Nokogiri::XML::Node.new("song", @doc)
-      @property.write(parent, "The Gargoyle")
+      @property.write(parent, "The Gargoyle", "song")
       assert_xml_equal("<song>The Gargoyle</song>", parent.to_s)
     end
   end

data/test/xml_test.rb

@@ -104,20 +104,20 @@ class XmlTest < MiniTest::Spec
 
     describe "XML::Binding#build_for" do
       it "returns AttributeBinding" do
-        assert_kind_of XML::Binding::Attribute, XML::Binding.build_for(Def.new(:band, :as => "band", :attribute => true), nil)
+        assert_kind_of XML::Binding::Attribute, XML::Binding.build_for(Def.new(:band, :as => "band", :attribute => true))
       end
 
       it "returns Binding" do
-        assert_kind_of XML::Binding, XML::Binding.build_for(Def.new(:band, :class => Hash), nil)
-        assert_kind_of XML::Binding, XML::Binding.build_for(Def.new(:band, :as => :content), nil)
+        assert_kind_of XML::Binding, XML::Binding.build_for(Def.new(:band, :class => Hash))
+        assert_kind_of XML::Binding, XML::Binding.build_for(Def.new(:band, :as => :content))
       end
 
       it "returns CollectionBinding" do
-        assert_kind_of XML::Binding::Collection, XML::Binding.build_for(Def.new(:band, :collection => :true), nil)
+        assert_kind_of XML::Binding::Collection, XML::Binding.build_for(Def.new(:band, :collection => :true))
       end
 
       it "returns HashBinding" do
-        assert_kind_of XML::Binding::Hash, XML::Binding.build_for(Def.new(:band, :hash => :true), nil)
+        assert_kind_of XML::Binding::Hash, XML::Binding.build_for(Def.new(:band, :hash => :true))
       end
     end
 
@@ -387,7 +387,7 @@ class CollectionTest < MiniTest::Spec
       self.representation_wrap = :song
     end
 
-    let (:decorator) { rpr = representer; Class.new(Representable::Decorator) { include rpr } }
+    let (:decorator) { rpr = representer; Class.new(Representable::Decorator) { include Representable::XML; include rpr } }
 
     describe "XML::Collection" do
       describe "with contained objects" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0.rc1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.0.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.0.15
+- !ruby/object:Gem::Dependency
+  name: declarative
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.4.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.4.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +154,6 @@ files:
 - TODO
 - lib/representable.rb
 - lib/representable/TODO.getting_serious
-- lib/representable/apply.rb
 - lib/representable/autoload.rb
 - lib/representable/binding.rb
 - lib/representable/cached.rb
@@ -150,6 +163,7 @@ files:
 - lib/representable/declarative.rb
 - lib/representable/decorator.rb
 - lib/representable/definition.rb
+- lib/representable/deprecations.rb
 - lib/representable/deserializer.rb
 - lib/representable/for_collection.rb
 - lib/representable/hash.rb
@@ -157,16 +171,15 @@ files:
 - lib/representable/hash/binding.rb
 - lib/representable/hash/collection.rb
 - lib/representable/hash_methods.rb
-- lib/representable/inheritable.rb
+- lib/representable/insert.rb
 - lib/representable/json.rb
 - lib/representable/json/collection.rb
 - lib/representable/json/hash.rb
-- lib/representable/mapper.rb
 - lib/representable/object.rb
 - lib/representable/object/binding.rb
 - lib/representable/parse_strategies.rb
 - lib/representable/pipeline.rb
-- lib/representable/populator.rb
+- lib/representable/pipeline_factories.rb
 - lib/representable/represent.rb
 - lib/representable/serializer.rb
 - lib/representable/version.rb
@@ -177,6 +190,7 @@ files:
 - lib/representable/yaml.rb
 - lib/representable/yaml/binding.rb
 - representable.gemspec
+- test/---deserialize-pipeline_test.rb
 - test/as_test.rb
 - test/benchmarking.rb
 - test/binding_test.rb
@@ -187,6 +201,8 @@ files:
 - test/config_test.rb
 - test/decorator_scope_test.rb
 - test/decorator_test.rb
+- test/default_test.rb
+- test/defaults_options_test.rb
 - test/definition_test.rb
 - test/example.rb
 - test/examples/object.rb
@@ -198,9 +214,9 @@ files:
 - test/getter_setter_test.rb
 - test/hash_bindings_test.rb
 - test/hash_test.rb
+- test/heritage_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
@@ -211,10 +227,13 @@ files:
 - test/object_test.rb
 - test/parse_strategy_test.rb
 - test/pass_options_test.rb
+- test/pipeline_test.rb
+- test/populator_test.rb
 - test/prepare_test.rb
 - test/private_options_test.rb
 - test/reader_writer_test.rb
 - test/realistic_benchmark.rb
+- test/render_nil_test.rb
 - test/represent_test.rb
 - test/representable_test.rb
 - test/schema_test.rb
@@ -223,6 +242,7 @@ files:
 - test/stringify_hash_test.rb
 - test/test_helper.rb
 - test/test_helper_test.rb
+- test/uncategorized_test.rb
 - test/wrap_test.rb
 - test/xml_bindings_test.rb
 - test/xml_test.rb
@@ -242,9 +262,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8