representable 2.3.0 → 2.4.0.rc1

data/test/config/inherit_test.rb

@@ -16,20 +16,21 @@ class ConfigInheritTest < MiniTest::Spec
 
   # end
   module GenreModule
-    include Representable
+    include Representable::Hash
     property :genre
   end
 
 
   # in Decorator ------------------------------------------------
   class Decorator < Representable::Decorator
+    include Representable::Hash
     property :title
     property :artist do
       property :id
     end
   end
 
-  it { Decorator.representable_attrs[:definitions].keys.must_equal ["title", "artist"] }
+  it { Decorator.definitions.keys.must_equal ["title", "artist"] }
 
   # in inheriting Decorator
 
@@ -37,7 +38,7 @@ class ConfigInheritTest < MiniTest::Spec
     property :location
   end
 
-  it { InheritingDecorator.representable_attrs[:definitions].keys.must_equal ["title", "artist", "location"] }
+  it { InheritingDecorator.definitions.keys.must_equal ["title", "artist", "location"] }
   it { assert_cloned(InheritingDecorator, Decorator, "title") }
   it do
     InheritingDecorator.representable_attrs.get(:artist).representer_module.object_id.wont_equal Decorator.representable_attrs.get(:artist).representer_module.object_id
@@ -50,7 +51,7 @@ class ConfigInheritTest < MiniTest::Spec
     property :location
   end
 
-  it { InheritingAndIncludingDecorator.representable_attrs[:definitions].keys.must_equal ["title", "artist", "genre", "location"] }
+  it { InheritingAndIncludingDecorator.definitions.keys.must_equal ["title", "artist", "genre", "location"] }
   it { assert_cloned(InheritingAndIncludingDecorator, GenreModule, :genre) }
 
 
@@ -60,7 +61,7 @@ class ConfigInheritTest < MiniTest::Spec
     property :title
   end
 
-  it { Module.representable_attrs[:definitions].keys.must_equal ["title"] }
+  it { Module.definitions.keys.must_equal ["title"] }
 
 
   # in module including module
@@ -71,7 +72,7 @@ class ConfigInheritTest < MiniTest::Spec
     property :location
   end
 
-  it { SubModule.representable_attrs[:definitions].keys.must_equal ["title", "location"] }
+  it { SubModule.definitions.keys.must_equal ["title", "location"] }
   it { assert_cloned(SubModule, Module, :title) }
 
   # including preserves order
@@ -83,7 +84,7 @@ class ConfigInheritTest < MiniTest::Spec
     property :location
   end
 
-  it { IncludingModule.representable_attrs[:definitions].keys.must_equal ["genre", "title", "location"] }
+  it { IncludingModule.definitions.keys.must_equal ["genre", "title", "location"] }
 
 
   # included in class -------------------------------------------
@@ -92,7 +93,7 @@ class ConfigInheritTest < MiniTest::Spec
     include IncludingModule
   end
 
-  it { Class.representable_attrs[:definitions].keys.must_equal ["genre", "title", "location"] }
+  it { Class.definitions.keys.must_equal ["genre", "title", "location"] }
   it { assert_cloned(Class, IncludingModule, :title) }
   it { assert_cloned(Class, IncludingModule, :location) }
   it { assert_cloned(Class, IncludingModule, :genre) }
@@ -104,7 +105,7 @@ class ConfigInheritTest < MiniTest::Spec
     include IncludingModule
   end
 
-  it { DefiningClass.representable_attrs[:definitions].keys.must_equal ["street_cred", "genre", "title", "location"] }
+  it { DefiningClass.definitions.keys.must_equal ["street_cred", "genre", "title", "location"] }
 
   # in class
   class RepresenterClass
@@ -112,7 +113,7 @@ class ConfigInheritTest < MiniTest::Spec
     property :title
   end
 
-  it { RepresenterClass.representable_attrs[:definitions].keys.must_equal ["title"] }
+  it { RepresenterClass.definitions.keys.must_equal ["title"] }
 
 
   # in inheriting class
@@ -121,7 +122,7 @@ class ConfigInheritTest < MiniTest::Spec
     property :location
   end
 
-  it { InheritingClass.representable_attrs[:definitions].keys.must_equal ["title", "location"] }
+  it { InheritingClass.definitions.keys.must_equal ["title", "location"] }
   it { assert_cloned(InheritingClass, RepresenterClass, :title) }
 
   # in inheriting class and including
@@ -130,5 +131,5 @@ class ConfigInheritTest < MiniTest::Spec
     include GenreModule
   end
 
-  it { InheritingAndIncludingClass.representable_attrs[:definitions].keys.must_equal ["title", "location", "genre"] }
+  it { InheritingAndIncludingClass.definitions.keys.must_equal ["title", "location", "genre"] }
 end

data/test/config_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class ConfigTest < MiniTest::Spec
-  subject { Representable::Config.new }
+  subject { Representable::Config.new(Representable::Definition) }
   PunkRock = Class.new
   Definition = Representable::Definition
 
@@ -10,15 +10,15 @@ class ConfigTest < MiniTest::Spec
       assert_equal nil, subject.wrap_for("Punk", nil)
     end
 
-    it "infers a printable class name if set to true" do
-      subject.wrap = true
-      assert_equal "punk_rock", subject.wrap_for(PunkRock, nil)
-    end
+    # it "infers a printable class name if set to true" do
+    #   subject.wrap = true
+    #   assert_equal "punk_rock", subject.wrap_for(PunkRock, nil)
+    # end
 
-    it "can be set explicitely" do
-      subject.wrap = "Descendents"
-      assert_equal "Descendents", subject.wrap_for(PunkRock, nil)
-    end
+    # it "can be set explicitely" do
+    #   subject.wrap = "Descendents"
+    #   assert_equal "Descendents", subject.wrap_for(PunkRock, nil)
+    # end
   end
 
   describe "#[]" do
@@ -42,7 +42,7 @@ class ConfigTest < MiniTest::Spec
     describe "returns" do
       it do
         # #add returns Definition.`
-        subject = Representable::Config.new.add(:title, {:me => true})
+        subject = Representable::Config.new(Representable::Definition).add(:title, {:me => true})
 
         subject.must_be_kind_of Representable::Definition
         subject[:me].must_equal true
@@ -76,7 +76,7 @@ class ConfigTest < MiniTest::Spec
 
 
   describe "#remove" do
-    subject { Representable::Config.new }
+    subject { Representable::Config.new(Representable::Definition) }
 
     it do
       subject.add(:title, {:me => true})
@@ -109,7 +109,7 @@ class ConfigTest < MiniTest::Spec
   end
 
   describe "#get" do
-    subject       { Representable::Config.new }
+    subject       { Representable::Config.new(Representable::Definition) }
 
     it do
       title  = subject.add(:title, {})
@@ -119,59 +119,4 @@ class ConfigTest < MiniTest::Spec
       subject.get(:length).must_equal length
     end
   end
-
-
-  describe "#inherit!" do
-    let (:title)  { Definition.new(:title) }
-    let (:length) { Definition.new(:length) }
-    let (:stars)  { Definition.new(:stars) }
-
-    it do
-      parent = Representable::Config.new
-      parent.add(:title, {:alias => "Callname"})
-      parent[:features][Object] = true
-      # DISCUSS: build Inheritable::Hash automatically in options? is there a gem for that?
-      parent.options[:additional_features] = Representable::Inheritable::Hash[Object => true]
-
-      subject.inherit!(parent)
-
-      # add to inherited config:
-      subject.add(:stars, {})
-      subject[:features][Module] = true
-      subject.options[:additional_features][Module] = true
-
-      subject[:features].must_equal({Object => true, Module => true})
-
-      parent.options[:additional_features].must_equal({Object => true})
-      subject.options[:additional_features].must_equal({Object => true, Module => true})
-
-      # test Definition interface:
-
-      # definitions.size.must_equal([subject.get(:title), subject.get(:stars)])
-      subject.get(:title).object_id.wont_equal parent.get(:title).object_id
-      # subject.get(:stars).object_id.must_equal stars.object_id
-    end
-
-    # Config with Inheritable::Array
-    it "xx" do
-      parent = Representable::Config.new
-      parent.options[:links] = Representable::Inheritable::Array.new
-      parent.options[:links] << "//1"
-
-      subject.options[:links] = Representable::Inheritable::Array.new
-      subject.options[:links] << "//2"
-
-      subject.inherit!(parent)
-      subject.options[:links].must_equal ["//2", "//1"]
-    end
-  end
-
-  describe "#features" do
-    it do
-      subject[:features][Object] = true
-      subject[:features][Module] = true
-
-      subject.features.must_equal [Object, Module]
-    end
-  end
 end

data/test/decorator_test.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
 class DecoratorTest < MiniTest::Spec
-  # TODO: Move to global place since it's used twice.
   class SongRepresentation < Representable::Decorator
     include Representable::JSON
     property :name
@@ -79,7 +78,7 @@ class InheritanceWithDecoratorTest < MiniTest::Spec
   class Twin
     extend Uber::InheritableAttr
     inheritable_attr :representer_class
-    self.representer_class = Representable::Decorator
+    self.representer_class = Class.new(Representable::Decorator){ include Representable::Hash }
   end
 
   class Album < Twin
@@ -90,8 +89,8 @@ class InheritanceWithDecoratorTest < MiniTest::Spec
   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
+    Twin.representer_class.definitions.size.must_equal 0
+    Album.representer_class.definitions.size.must_equal 1
+    Song.representer_class.definitions.size.must_equal 0
   end
 end

data/test/default_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+
+class DefaultTest < MiniTest::Spec
+  Song = Struct.new(:id, :title)
+
+  representer! do
+    property :id
+    property :title, default: "Huber Breeze" #->(options) { options[:default] }
+  end
+
+  describe "#from_hash" do
+    let (:song) { Song.new.extend(representer) }
+
+    it { song.from_hash({}).must_equal Song.new(nil, "Huber Breeze") }
+    # default doesn't apply when empty string.
+    it { song.from_hash({"title"=>""}).must_equal Song.new(nil, "") }
+    it { song.from_hash({"title"=>nil}).must_equal Song.new(nil, nil) }
+    it { song.from_hash({"title"=>"Blindfold"}).must_equal Song.new(nil, "Blindfold") }
+  end
+
+  describe "#to_json" do
+    it "uses :default when not available from object" do
+      Song.new.extend(representer).to_hash.must_equal({"title"=>"Huber Breeze"})
+    end
+
+    it "uses value from represented object when present" do
+      Song.new(nil, "After The War").extend(representer).to_hash.must_equal({"title"=>"After The War"})
+    end
+
+    it "uses value from represented object when emtpy string" do
+      Song.new(nil, "").extend(representer).to_hash.must_equal({"title"=>""})
+    end
+  end
+end

data/test/defaults_options_test.rb

@@ -0,0 +1,93 @@
+require 'test_helper'
+
+class DefaultsOptionsTest < BaseTest
+  let (:format) { :hash }
+  let (:song) { Struct.new(:title, :author_name, :song_volume, :description).new("Revolution", "Some author", 20, nil) }
+  let (:prepared) { representer.prepare song }
+
+  describe "hash options combined with dynamic options" do
+    representer! do
+      defaults render_nil: true do |name|
+        { as: name.to_s.upcase }
+      end
+
+      property :title
+      property :author_name
+      property :description
+      property :song_volume
+    end
+
+    it { render(prepared).must_equal_document({"TITLE" => "Revolution", "AUTHOR_NAME" => "Some author", "DESCRIPTION" => nil, "SONG_VOLUME" => 20}) }
+  end
+
+  describe "with only dynamic property options" do
+    representer! do
+      defaults do |name|
+        { as: name.to_s.upcase }
+      end
+
+      property :title
+      property :author_name
+      property :description
+      property :song_volume
+    end
+
+    it { render(prepared).must_equal_document({"TITLE" => "Revolution", "AUTHOR_NAME" => "Some author", "SONG_VOLUME" => 20}) }
+  end
+
+  describe "with only hashes" do
+    representer! do
+      defaults render_nil: true
+
+      property :title
+      property :author_name
+      property :description
+      property :song_volume
+    end
+
+    it { render(prepared).must_equal_document({"title" => "Revolution", "author_name" => "Some author", "description" => nil, "song_volume" => 20}) }
+  end
+
+  describe "direct defaults hash" do
+    representer! do
+      defaults render_nil: true
+
+      property :title
+      property :author_name
+      property :description
+      property :song_volume
+    end
+
+    it { render(prepared).must_equal_document({"title" => "Revolution", "author_name" => "Some author", "description" => nil, "song_volume" => 20}) }
+  end
+
+  describe "direct defaults hash with dynamic options" do
+    representer! do
+      defaults render_nil: true do |name|
+        { as: name.to_s.upcase }
+      end
+
+      property :title
+      property :author_name
+      property :description
+      property :song_volume
+    end
+
+    it { render(prepared).must_equal_document({"TITLE" => "Revolution", "AUTHOR_NAME" => "Some author", "DESCRIPTION" => nil, "SONG_VOLUME" => 20}) }
+  end
+
+  describe "prioritizes specific options" do
+    representer! do
+      defaults render_nil: true do |name|
+        { as: name.to_s.upcase }
+      end
+
+      property :title
+      property :author_name
+      property :description, render_nil: false
+      property :song_volume, as: :volume
+    end
+
+    it { render(prepared).must_equal_document({"TITLE" => "Revolution", "AUTHOR_NAME" => "Some author", "volume" => 20}) }
+  end
+end

data/test/definition_test.rb

@@ -14,14 +14,15 @@ class DefinitionTest < MiniTest::Spec
         options[:parse_filter] << 1
 
         # default variables
-        options[:as].must_equal "song"
+        options[:as].must_equal nil
         options[:extend].must_equal Module
       end
+      definition.name.must_equal "song"
 
       #
       definition[:awesome].must_equal true
-      definition[:parse_filter].instance_variable_get(:@value).must_equal Representable::Pipeline[1]
-      definition[:render_filter].instance_variable_get(:@value).must_equal Representable::Pipeline[]
+      definition[:parse_filter].must_equal Representable::Pipeline[1]
+      definition[:render_filter].must_equal Representable::Pipeline[]
     end
   end
 
@@ -62,8 +63,8 @@ class DefinitionTest < MiniTest::Spec
 
       definition[:awesome].must_equal true
       definition[:something].must_equal true
-      definition[:render_filter].instance_variable_get(:@value).must_equal Representable::Pipeline[1]
-      definition[:parse_filter].instance_variable_get(:@value).must_equal Representable::Pipeline[]
+      definition[:render_filter].must_equal Representable::Pipeline[1]
+      definition[:parse_filter].must_equal Representable::Pipeline[]
     end
 
     describe "with :parse_filter" do
@@ -73,12 +74,12 @@ class DefinitionTest < MiniTest::Spec
       it do
         merged = definition.merge!(:parse_filter => 2)[:parse_filter]
 
-        merged.instance_variable_get(:@value).must_be_kind_of Representable::Pipeline
-        merged.instance_variable_get(:@value).size.must_equal 2
+        merged.must_be_kind_of Representable::Pipeline
+        merged.size.must_equal 2
       end
 
       # :parse_filter can also be array.
-      it { definition.merge!(:parse_filter => [2, 3])[:parse_filter].instance_variable_get(:@value).size.must_equal 3 }
+      it { definition.merge!(:parse_filter => [2, 3])[:parse_filter].size.must_equal 3 }
     end
 
     # does not change arguments
@@ -100,7 +101,7 @@ class DefinitionTest < MiniTest::Spec
 
   # #inspect
   describe "#inspect" do
-    it { Definition.new(:songs).inspect.must_equal "#<Representable::Definition ==>songs @options={:parse_filter=>[], :render_filter=>[], :as=>\"songs\"}>" }
+    it { Definition.new(:songs).inspect.must_equal "#<Representable::Definition ==>songs @options={:name=>\"songs\", :parse_filter=>[], :render_filter=>[]}>" }
   end
 
 
@@ -154,6 +155,14 @@ class DefinitionTest < MiniTest::Spec
       assert_equal :"songs=", @def.setter
     end
 
+    describe "nested: FIXME" do
+      it do
+        dfn = Representable::Definition.new(:songs, nested: Module)
+        assert dfn.typed?
+        dfn[:extend].(nil).must_equal Module
+      end
+    end
+
 
     describe "#clone" do
       subject { Representable::Definition.new(:title, :volume => 9, :clonable => Uber::Options::Value.new(1)) }
@@ -170,34 +179,6 @@ class DefinitionTest < MiniTest::Spec
         assert_equal @def[:volume], 9
         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) }
-
-        it ("yy")do
-          cloned = subject.clone
-
-          cloned.merge!(:render_filter => 2)
-
-          subject.instance_variable_get(:@options)[:render_filter].must_equal [1]
-          cloned.instance_variable_get(:@options)[:render_filter].must_equal [1,2]
-
-          subject[:render_filter].instance_variable_get(:@value).must_equal [1]
-          cloned[:render_filter].instance_variable_get(:@value).must_equal [1,2]
-        end
-      end
     end
   end
 
@@ -225,8 +206,7 @@ class DefinitionTest < MiniTest::Spec
   describe "#create_binding" do
     it "executes the block (without special context)" do
       definition = Representable::Definition.new(:title, :binding => lambda { |*args| @binding = Representable::Binding.new(*args) })
-      definition.create_binding(object=Object.new).must_equal @binding
-      @binding.instance_variable_get(:@parent_decorator).must_equal object
+      definition.create_binding.must_equal @binding
     end
   end