representable 2.0.4 → 2.1.0

data/lib/representable/yaml/binding.rb

@@ -0,0 +1,48 @@
+require 'representable/hash/binding'
+
+module Representable
+  module YAML
+    class Binding < Representable::Hash::Binding
+      def self.build_for(definition, *args)
+        return Collection.new(definition, *args) if definition.array?
+        new(definition, *args)
+      end
+
+      def write(map, fragment)
+        map.children << Psych::Nodes::Scalar.new(as)
+        map.children << node_for(fragment)  # FIXME: should be serialize.
+      end
+    # private
+
+      def node_for(fragment)
+        write_scalar(fragment)
+      end
+
+      def write_scalar(value)
+        return value if typed?
+
+        Psych::Nodes::Scalar.new(value.to_s)
+      end
+
+      def serialize_method
+        :to_ast
+      end
+
+      def deserialize_method
+        :from_hash
+      end
+
+
+      class Collection < self
+        include Representable::Binding::Collection
+
+        def node_for(fragments)
+          Psych::Nodes::Sequence.new.tap do |seq|
+            seq.style = Psych::Nodes::Sequence::FLOW if self[:style] == :flow
+            fragments.each { |frag| seq.children << write_scalar(frag) }
+          end
+        end
+      end
+    end
+  end
+end

data/representable.gemspec

@@ -25,7 +25,7 @@ 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.0.0"
+  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"

data/test/benchmarking.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+require 'benchmark'
+
+SONG_PROPERTIES = 1000.times.collect do |i|
+  "property_#{i}"
+end
+
+
+module SongRepresenter
+  include Representable::JSON
+
+  SONG_PROPERTIES.each { |p| property p }
+end
+
+class SongDecorator < Representable::Decorator
+  include Representable::JSON
+
+  SONG_PROPERTIES.each { |p| property p }
+end
+
+module AlbumRepresenter
+  include Representable::JSON
+
+  # collection :songs, extend: SongRepresenter
+  collection :songs, extend: SongDecorator
+end
+
+def random_song
+  attrs = Hash[SONG_PROPERTIES.collect { |n| [n,n] }]
+  OpenStruct.new(attrs)
+end
+
+times = []
+
+3.times.each do
+  album = OpenStruct.new(songs: 100.times.collect { random_song })
+
+  times << Benchmark.measure do
+    puts "================ next!"
+    album.extend(AlbumRepresenter).to_json
+  end
+end
+
+puts times.join("")
+
+# 100 songs, 100 attrs
+#  0.050000   0.000000   0.050000 (  0.093157)
+
+## 100 songs, 1000 attrs
+#  0.470000   0.010000   0.480000 (  0.483708)
+
+
+### without binding cache:
+  # 2.790000   0.030000   2.820000 (  2.820190)
+
+
+
+### with extend: on Song, with binding cache>
+  # 2.490000   0.030000   2.520000 (  2.517433) 2.4-3.0
+  ### without skip?
+  # 2.030000   0.020000   2.050000 (  2.050796) 2.1-2.3
+
+    ### without :writer
+    # 2.270000   0.010000   2.280000 (  2.284530 1.9-2.2
+      ### without :render_filter
+      #   2.020000   0.000000   2.020000 (  2.030234) 1.5-2.0
+        ###without default_for and skipable?
+        #   1.730000   0.010000   1.740000 (  1.735597 1.4-1.7
+          ### without :serialize
+          #   1.780000   0.010000   1.790000 (  1.786791) 1.4-1.7
+          ### using decorator
+          # 1.400000   0.030000   1.430000 (  1.434206) 1.4-1.6
+            ### with prepare AFTER  representable?
+            # 1.330000   0.010000   1.340000 (  1.335900) 1.1-1.3
+
+
+# representable 2.0
+# 3.000000   0.020000   3.020000 (  3.013031) 2.7-3.0
+
+# no method missing
+# 2.280000   0.030000   2.310000 (  2.313522) 2.2-2.5
+# no def_delegator in Definition
+# 2.130000   0.010000   2.140000 (  2.136115) 1.7-2.1

data/test/binding_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+class BindingTest < MiniTest::Spec
+  Binding = Representable::Binding
+  let (:render_nil_definition) { Representable::Definition.new(:song, :render_nil => true) }
+
+  describe "#skipable_empty_value?" do
+    let (:binding) { Binding.new(render_nil_definition, nil, nil) }
+
+    # don't skip when present.
+    it { binding.skipable_empty_value?("Disconnect, Disconnect").must_equal false }
+
+    # don't skip when it's nil and render_nil: true
+    it { binding.skipable_empty_value?(nil).must_equal false }
+
+    # skip when nil and :render_nil undefined.
+    it { Binding.new(Representable::Definition.new(:song), nil, nil).skipable_empty_value?(nil).must_equal true }
+
+    # don't skip when nil and :render_nil undefined.
+    it { Binding.new(Representable::Definition.new(:song), nil, nil).skipable_empty_value?("Fatal Flu").must_equal false }
+  end
+
+
+  describe "#default_for" do
+    let (:definition) { Representable::Definition.new(:song, :default => "Insider") }
+    let (:binding) { Binding.new(definition, nil, nil) }
+
+    # return value when value present.
+    it { binding.default_for("Black And Blue").must_equal "Black And Blue" }
+
+    # return false when value false.
+    it { binding.default_for(false).must_equal false }
+
+    # return default when value nil.
+    it { binding.default_for(nil).must_equal "Insider" }
+
+    # return nil when value nil and render_nil: true.
+    it { Binding.new(render_nil_definition, nil, nil).default_for(nil).must_equal nil }
+
+    # return nil when value nil and render_nil: true, even when :default is set" do
+    it { Binding.new(Representable::Definition.new(:song, :render_nil => true, :default => "The Quest"), nil, nil).default_for(nil).must_equal nil }
+
+    # return nil if no :default
+    it { Binding.new(Representable::Definition.new(:song), nil, nil).default_for(nil).must_equal nil }
+  end
+end

data/test/definition_test.rb

@@ -88,6 +88,11 @@ class DefinitionTest < MiniTest::Spec
     end
   end
 
+  # #inspect
+  describe "#inspect" do
+    it { Definition.new(:songs).inspect.must_equal "#<Representable::Definition ==>songs @options={:parse_filter=>[], :render_filter=>[], :as=>\"songs\"}>" }
+  end
+
 
   describe "generic API" do
     before do
@@ -186,64 +191,6 @@ class DefinitionTest < MiniTest::Spec
   end
 
 
-  describe "#skipable_empty_value?" do
-    # default if skipable_empty_value?
-    before do
-      @def = Representable::Definition.new(:song, :render_nil => true)
-    end
-
-    it "returns false when not nil" do
-      assert_equal false, @def.skipable_empty_value?("Disconnect, Disconnect")
-    end
-
-    it "returns false when nil and :render_nil => true" do
-      assert_equal false, @def.skipable_empty_value?(nil)
-    end
-
-    it "returns true when nil and :render_nil => false" do
-      assert_equal true, Representable::Definition.new(:song).skipable_empty_value?(nil)
-    end
-
-    it "returns false when not nil and :render_nil => false" do
-      assert_equal false, Representable::Definition.new(:song).skipable_empty_value?("Fatal Flu")
-    end
-  end
-
-
-  describe "#default_for" do
-    before do
-      @def = Representable::Definition.new(:song, :default => "Insider")
-    end
-
-    it "always returns value when value not nil" do
-      assert_equal "Black And Blue", @def.default_for("Black And Blue")
-    end
-
-    it "returns false when value false" do
-      assert_equal false, @def.default_for(false)
-    end
-
-    it "returns default when value nil" do
-      assert_equal "Insider", @def.default_for(nil)
-    end
-
-    it "returns nil when value nil and :render_nil true" do
-      @def = Representable::Definition.new(:song, :render_nil => true)
-      assert_equal nil, @def.default_for(nil)
-    end
-
-    it "returns nil when value nil and :render_nil true even when :default is set" do
-      @def = Representable::Definition.new(:song, :render_nil => true, :default => "The Quest")
-      assert_equal nil, @def.default_for(nil)
-    end
-
-    it "returns nil if no :default" do
-      @def = Representable::Definition.new(:song)
-      assert_equal nil, @def.default_for(nil)
-    end
-  end
-
-
   describe "#binding" do
     it "returns true when :binding is set" do
       assert Representable::Definition.new(:songs, :binding => Object)[:binding]

data/test/exec_context_test.rb

@@ -40,8 +40,8 @@ class ExecContextTest < MiniTest::Spec
         }
       end
 
-      it { render(song).must_equal_document({Representable::Hash::PropertyBinding => "name"}) }
-      it { parse(song, {Representable::Hash::PropertyBinding => "Rebel Fate"}).name.must_equal "Rebel Fate" }
+      it { render(song).must_equal_document({Representable::Hash::Binding => "name"}) }
+      it { parse(song, {Representable::Hash::Binding => "Rebel Fate"}).name.must_equal "Rebel Fate" }
     end
 
 
@@ -85,8 +85,8 @@ class ExecContextTest < MiniTest::Spec
           }
         end
 
-        it { render(song).must_equal_document({Representable::Hash::PropertyBinding => "name"}) }
-        it { parse(song, {Representable::Hash::PropertyBinding => "Rebel Fate"}).name.must_equal "Rebel Fate" }
+        it { render(song).must_equal_document({Representable::Hash::Binding => "name"}) }
+        it { parse(song, {Representable::Hash::Binding => "Rebel Fate"}).name.must_equal "Rebel Fate" }
       end
     end
   end

data/test/hash_bindings_test.rb

@@ -15,7 +15,7 @@ class HashBindingTest < MiniTest::Spec
   describe "PropertyBinding" do
     describe "#read" do
       before do
-        @property = Representable::Hash::PropertyBinding.new(Representable::Definition.new(:song), nil, nil)
+        @property = Representable::Hash::Binding.new(Representable::Definition.new(:song), nil, nil)
       end
 
       it "returns fragment if present" do
@@ -29,61 +29,13 @@ class HashBindingTest < MiniTest::Spec
       end
 
     end
-
-    describe "with plain text" do
-      before do
-        @property = Representable::Hash::PropertyBinding.new(Representable::Definition.new(:song), nil, nil)
-      end
-
-      it "extracts with #read" do
-        assert_equal "Thinning the Herd", @property.read("song" => "Thinning the Herd")
-      end
-
-      it "inserts with #write" do
-        doc = {}
-        assert_equal("Thinning the Herd", @property.write(doc,"Thinning the Herd"))
-        assert_equal({"song"=>"Thinning the Herd"}, doc)
-      end
-    end
-
-    describe "with an object" do
-      before do
-        @property = Representable::Hash::PropertyBinding.new(Representable::Definition.new(:song, :class => SongWithRepresenter), nil, nil)
-        @doc      = {}
-      end
-
-      it "extracts with #read" do
-        assert_equal SongWithRepresenter.new("Thinning the Herd"), @property.read("song" => {"name" => "Thinning the Herd"})
-      end
-
-      it "inserts with #write" do
-        assert_equal({"name"=>"Thinning the Herd"}, @property.write(@doc, SongWithRepresenter.new("Thinning the Herd")))
-        assert_equal({"song" => {"name"=>"Thinning the Herd"}}, @doc)
-      end
-    end
-
-    describe "with an object and :extend" do
-      before do
-        @property = Representable::Hash::PropertyBinding.new(Representable::Definition.new(:song, :class => Song, :extend => SongRepresenter), nil, nil)
-        @doc      = {}
-      end
-
-      it "extracts with #read" do
-        assert_equal Song.new("Thinning the Herd"), @property.read("song" => {"name" => "Thinning the Herd"})
-      end
-
-      it "inserts with #write" do
-        assert_equal({"name"=>"Thinning the Herd"}, @property.write(@doc, Song.new("Thinning the Herd")))
-        assert_equal({"song" => {"name"=>"Thinning the Herd"}}, @doc)
-      end
-    end
   end
 
 
   describe "CollectionBinding" do
     describe "with plain text items" do
       before do
-        @property = Representable::Hash::CollectionBinding.new(Representable::Definition.new(:songs, :collection => true), Album.new, nil)
+        @property = Representable::Hash::Binding::Collection.new(Representable::Definition.new(:songs, :collection => true), Album.new, nil)
       end
 
       it "extracts with #read" do
@@ -104,7 +56,7 @@ class HashBindingTest < MiniTest::Spec
   describe "HashBinding" do
     describe "with plain text items" do
       before do
-        @property = Representable::Hash::HashBinding.new(Representable::Definition.new(:songs, :hash => true), nil, nil)
+        @property = Representable::Hash::Binding::Hash.new(Representable::Definition.new(:songs, :hash => true), nil, nil)
       end
 
       it "extracts with #read" do
@@ -120,7 +72,7 @@ class HashBindingTest < MiniTest::Spec
 
     describe "with objects" do
       before do
-        @property = Representable::Hash::HashBinding.new(Representable::Definition.new(:songs, :hash => true, :class => Song, :extend => SongRepresenter), nil, nil)
+        @property = Representable::Hash::Binding::Hash.new(Representable::Definition.new(:songs, :hash => true, :class => Song, :extend => SongRepresenter), nil, nil)
       end
 
       it "doesn't change the represented hash in #write" do

data/test/hash_test.rb

@@ -14,7 +14,7 @@ class HashTest < MiniTest::Spec
 
 
   describe "property" do
-    let (:hash) { hash_representer do property :best_song end }
+    let (:hsh) { hash_representer do property :best_song end }
 
     let (:album) { Album.new.tap do |album|
       album.best_song = "Liar"
@@ -22,14 +22,14 @@ class HashTest < MiniTest::Spec
 
     describe "#to_hash" do
       it "renders plain property" do
-        album.extend(hash).to_hash.must_equal("best_song" => "Liar")
+        album.extend(hsh).to_hash.must_equal("best_song" => "Liar")
       end
     end
 
 
     describe "#from_hash" do
       it "parses plain property" do
-        album.extend(hash).from_hash("best_song" => "This Song Is Recycled").best_song.must_equal "This Song Is Recycled"
+        album.extend(hsh).from_hash("best_song" => "This Song Is Recycled").best_song.must_equal "This Song Is Recycled"
       end
     end
 
@@ -95,7 +95,7 @@ class HashTest < MiniTest::Spec
 
 
   describe "collection" do
-    let (:hash) { hash_representer do collection :songs end }
+    let (:hsh) { hash_representer do collection :songs end }
 
     let (:album) { Album.new.tap do |album|
       album.songs = ["Jackhammer", "Terrible Man"]
@@ -104,14 +104,14 @@ class HashTest < MiniTest::Spec
 
     describe "#to_hash" do
       it "renders a block style list per default" do
-        album.extend(hash).to_hash.must_equal("songs" => ["Jackhammer", "Terrible Man"])
+        album.extend(hsh).to_hash.must_equal("songs" => ["Jackhammer", "Terrible Man"])
       end
     end
 
 
     describe "#from_hash" do
       it "parses a block style list" do
-        album.extend(hash).from_hash("songs" => ["Off Key Melody", "Sinking"]).must_equal Album.new(["Off Key Melody", "Sinking"])
+        album.extend(hsh).from_hash("songs" => ["Off Key Melody", "Sinking"]).must_equal Album.new(["Off Key Melody", "Sinking"])
 
       end
     end

data/test/json_test.rb

@@ -88,21 +88,21 @@ module JsonTest
 
       describe "#build_for" do
         it "returns TextBinding" do
-          assert_kind_of Representable::Hash::PropertyBinding, Representable::Hash::PropertyBinding.build_for(Def.new(:band), nil, nil)
+          assert_kind_of Representable::Hash::Binding, Representable::Hash::Binding.build_for(Def.new(:band), nil, nil)
         end
 
         it "returns HashBinding" do
-          assert_kind_of Representable::Hash::HashBinding, Representable::Hash::PropertyBinding.build_for(Def.new(:band, :hash => true), nil, nil)
+          assert_kind_of Representable::Hash::Binding::Hash, Representable::Hash::Binding.build_for(Def.new(:band, :hash => true), nil, nil)
         end
 
         it "returns CollectionBinding" do
-          assert_kind_of Representable::Hash::CollectionBinding, Representable::Hash::PropertyBinding.build_for(Def.new(:band, :collection => true), nil, nil)
+          assert_kind_of Representable::Hash::Binding::Collection, Representable::Hash::Binding.build_for(Def.new(:band, :collection => true), nil, nil)
         end
       end
 
       # describe "#representable_bindings_for" do
       #   it "returns bindings for each property" do
-      #     bins = @band.send(:representable_bindings_for, Representable::JSON::PropertyBinding, {})
+      #     bins = @band.send(:representable_bindings_for, Representable::JSON::Binding, {})
       #     assert_equal 2, bins.size
       #     assert_equal "name", bins.first.name
       #   end
@@ -395,15 +395,15 @@ end
 
       describe "parsing" do
         subject { OpenStruct.new.extend(representer) }
-        let (:hash) { {"7"=>{"name"=>"Contemplation"}} }
+        let (:hsh) { {"7"=>{"name"=>"Contemplation"}} }
 
         it "parses incoming hash" do
-          subject.from_hash("songs"=>hash).songs.must_equal({"7"=>Song.new("Contemplation")})
+          subject.from_hash("songs"=>hsh).songs.must_equal({"7"=>Song.new("Contemplation")})
         end
 
         it "doesn't modify the incoming hash" do
-          subject.from_hash("songs"=> incoming_hash = hash.dup)
-          hash.must_equal incoming_hash
+          subject.from_hash("songs"=> incoming_hash = hsh.dup)
+          hsh.must_equal incoming_hash
         end
       end
     end