representable 1.2.6 → 1.2.7

data/CHANGES.textile

@@ -1,6 +1,10 @@
+h2. 1.2.7
+
+* Moving @Format.binding_for_definition@ to @Format#{format}_binding_for_definition@, making it an instance method in its own "namespace". This allows mixing in multiple representer engines into a user's representer module.
+
 h2. 1.2.6
 
-Extracted @HashRepresenter@ which operates on hash structures. This allows you to "parse" form data, e.g. as in Rails' @params@ hash. Internally, this is used by JSON and partly by YAML.
+* Extracted @HashRepresenter@ which operates on hash structures. This allows you to "parse" form data, e.g. as in Rails' @params@ hash. Internally, this is used by JSON and partly by YAML.
 
 h2. 1.2.5
 

data/lib/representable.rb

@@ -111,7 +111,7 @@ private
   end
   
   def representable_bindings_for(format)
-    representable_attrs.map {|attr| format.binding_for_definition(attr) }
+    representable_attrs.map {|attr| send("#{format}_binding_for_definition", attr) }  # DISCUSS: call that on attr directly?
   end
   
   # Returns the wrapper for the representation. Mostly used in XML.

data/lib/representable/hash.rb

@@ -16,32 +16,34 @@ module Representable
     
     
     module ClassMethods
-      def binding_for_definition(definition)
-        return Representable::Hash::CollectionBinding.new(definition)  if definition.array?
-        return Representable::Hash::HashBinding.new(definition)        if definition.hash?
-        Representable::Hash::PropertyBinding.new(definition)
-      end
-
       def from_hash(*args, &block)
         create_represented(*args, &block).from_hash(*args)
       end
     end
     
     
-    def from_hash(data, options={})
+    def from_hash(data, options={}, format=:hash)
       if wrap = options[:wrap] || representation_wrap
         data = data[wrap.to_s]
       end
       
-      update_properties_from(data, options, JSON)
+      update_properties_from(data, options, format)
     end
     
-    def to_hash(options={})
-      hash = create_representation_with({}, options, JSON)
+    def to_hash(options={}, format=:hash)
+      hash = create_representation_with({}, options, format)
       
       return hash unless wrap = options[:wrap] || representation_wrap
       
       {wrap => hash}
     end
+
+  private
+
+    def hash_binding_for_definition(definition)
+      return Representable::Hash::CollectionBinding.new(definition)  if definition.array?
+      return Representable::Hash::HashBinding.new(definition)        if definition.hash?
+      Representable::Hash::PropertyBinding.new(definition)
+    end
   end
 end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.2.6"
+  VERSION = "1.2.7"
 end

data/lib/representable/xml.rb

@@ -4,14 +4,6 @@ require 'nokogiri'
 
 module Representable
   module XML
-    def self.binding_for_definition(definition)
-      return CollectionBinding.new(definition)      if definition.array?
-      return HashBinding.new(definition)            if definition.hash? and not definition.options[:use_attributes] # FIXME: hate this.
-      return AttributeHashBinding.new(definition)   if definition.hash? and definition.options[:use_attributes]
-      return AttributeBinding.new(definition)       if definition.attribute
-      PropertyBinding.new(definition)
-    end
-    
     def self.included(base)
       base.class_eval do
         include Representable
@@ -45,18 +37,28 @@ module Representable
     end
     
     def from_node(node, options={})
-      update_properties_from(node, options, XML)
+      update_properties_from(node, options, :xml)
     end
     
     # Returns a Nokogiri::XML object representing this object.
     def to_node(options={})
       root_tag = options[:wrap] || representation_wrap
       
-      create_representation_with(Nokogiri::XML::Node.new(root_tag.to_s, Nokogiri::XML::Document.new), options, XML)
+      create_representation_with(Nokogiri::XML::Node.new(root_tag.to_s, Nokogiri::XML::Document.new), options, :xml)
     end
     
     def to_xml(*args)
       to_node(*args).to_s
     end
+
+  private
+
+    def xml_binding_for_definition(definition)
+      return CollectionBinding.new(definition)      if definition.array?
+      return HashBinding.new(definition)            if definition.hash? and not definition.options[:use_attributes] # FIXME: hate this.
+      return AttributeHashBinding.new(definition)   if definition.hash? and definition.options[:use_attributes]
+      return AttributeBinding.new(definition)       if definition.attribute
+      PropertyBinding.new(definition)
+    end
   end
 end

data/lib/representable/yaml.rb

@@ -5,14 +5,6 @@ module Representable
   module YAML
     include Hash
     
-    def self.binding_for_definition(definition)
-      return CollectionBinding.new(definition)      if definition.array?
-      #return HashBinding.new(definition)            if definition.hash? and not definition.options[:use_attributes] # FIXME: hate this.
-      #return AttributeHashBinding.new(definition)   if definition.hash? and definition.options[:use_attributes]
-      #return AttributeBinding.new(definition)       if definition.attribute
-      PropertyBinding.new(definition)
-    end
-    
     def self.included(base)
       base.class_eval do
         include Representable
@@ -36,9 +28,9 @@ module Representable
     end
     
     
-    def from_yaml(doc, *args)
+    def from_yaml(doc, options={})
       hash = Psych.load(doc)
-      from_hash(hash, *args)
+      from_hash(hash, options, :yaml)
     end
     
     # Returns a Nokogiri::XML object representing this object.
@@ -46,7 +38,7 @@ module Representable
       #root_tag = options[:wrap] || representation_wrap
       
       Psych::Nodes::Mapping.new.tap do |map|
-        create_representation_with(map, options, YAML)
+        create_representation_with(map, options, :yaml)
       end
     end
     
@@ -57,5 +49,15 @@ module Representable
       doc.children << to_ast(*args)
       stream.to_yaml
     end
+
+  private
+
+    def yaml_binding_for_definition(definition)
+      return CollectionBinding.new(definition)      if definition.array?
+      #return HashBinding.new(definition)            if definition.hash? and not definition.options[:use_attributes] # FIXME: hate this.
+      #return AttributeHashBinding.new(definition)   if definition.hash? and definition.options[:use_attributes]
+      #return AttributeBinding.new(definition)       if definition.attribute
+      PropertyBinding.new(definition)
+    end
   end
 end

data/test/json_test.rb

@@ -128,26 +128,26 @@ module JsonTest
 
       describe "#binding_for_definition" do
         it "returns ObjectBinding" do
-          assert_kind_of Representable::Hash::ObjectBinding, Json.binding_for_definition(Def.new(:band, :class => Hash))
+          assert_kind_of Representable::Hash::ObjectBinding, @band.send(:hash_binding_for_definition, Def.new(:band, :class => Hash))
         end
 
         it "returns TextBinding" do
-          assert_kind_of Representable::Hash::PropertyBinding, Json.binding_for_definition(Def.new(:band))
+          assert_kind_of Representable::Hash::PropertyBinding, @band.send(:hash_binding_for_definition, Def.new(:band))
         end
 
         it "returns HashBinding" do
-          assert_kind_of Representable::Hash::HashBinding, Json.binding_for_definition(Def.new(:band, :hash => true))
+          assert_kind_of Representable::Hash::HashBinding, @band.send(:hash_binding_for_definition, Def.new(:band, :hash => true))
         end
 
         it "returns CollectionBinding" do
-          assert_kind_of Representable::Hash::CollectionBinding, Json.binding_for_definition(Def.new(:band, :collection => true))
+          assert_kind_of Representable::Hash::CollectionBinding, @band.send(:hash_binding_for_definition, Def.new(:band, :collection => true))
         end
       end
 
       describe "#representable_bindings" do
         it "returns bindings for each property" do
-          assert_equal 2, @band.send(:representable_bindings_for, Json).size
-          assert_equal "name", @band.send(:representable_bindings_for, Json).first.definition.name
+          assert_equal 2, @band.send(:representable_bindings_for, :hash).size
+          assert_equal "name", @band.send(:representable_bindings_for, :hash).first.definition.name
         end
       end
     end

data/test/representable_test.rb

@@ -218,40 +218,40 @@ class RepresentableTest < MiniTest::Spec
     end
     
     it "copies values from document to object" do
-      @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {}, Representable::JSON)
+      @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {}, :hash)
       assert_equal "No One's Choice", @band.name
       assert_equal 2, @band.groupies
     end
     
     it "accepts :exclude option" do
-      @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {:exclude => [:groupies]}, Representable::JSON)
+      @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {:exclude => [:groupies]}, :hash)
       assert_equal "No One's Choice", @band.name
       assert_equal nil, @band.groupies
     end
     
     it "still accepts deprecated :except option" do # FIXME: remove :except option.
-      assert_equal @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {:except => [:groupies]}, Representable::JSON), @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {:exclude => [:groupies]}, Representable::JSON)
+      assert_equal @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {:except => [:groupies]}, :hash), @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {:exclude => [:groupies]}, :hash)
     end
     
     it "accepts :include option" do
-      @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {:include => [:groupies]}, Representable::JSON)
+      @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {:include => [:groupies]}, :hash)
       assert_equal 2, @band.groupies
       assert_equal nil, @band.name
     end
     
     it "always returns self" do
-      assert_equal @band, @band.update_properties_from({"name"=>"Nofx"}, {}, Representable::JSON)
+      assert_equal @band, @band.update_properties_from({"name"=>"Nofx"}, {}, :hash)
     end
     
     it "includes false attributes" do
-      @band.update_properties_from({"groupies"=>false}, {}, Representable::JSON)
+      @band.update_properties_from({"groupies"=>false}, {}, :hash)
       assert_equal false, @band.groupies
     end
     
     it "ignores (no-default) properties not present in the incoming document" do
-      { Representable::JSON => {}, 
-        Representable::XML  => xml(%{<band/>})
-      }.each do |format, document|
+      { Representable::JSON => [{}, :hash], 
+        Representable::XML  => [xml(%{<band/>}), :xml]
+      }.each do |format, config|
         nested_repr = Module.new do # this module is never applied.
           include format
           property :created_at
@@ -263,7 +263,7 @@ class RepresentableTest < MiniTest::Spec
         end
         
         @band = Band.new.extend(repr)
-        @band.update_properties_from(document, {}, format)
+        @band.update_properties_from(config.first, {}, config.last)
         assert_equal nil, @band.name, "Failed in #{format}"
       end
     end
@@ -277,31 +277,31 @@ class RepresentableTest < MiniTest::Spec
     end
     
     it "compiles document from properties in object" do
-      assert_equal({"name"=>"No One's Choice", "groupies"=>2}, @band.send(:create_representation_with, {}, {}, Representable::JSON))
+      assert_equal({"name"=>"No One's Choice", "groupies"=>2}, @band.send(:create_representation_with, {}, {}, :hash))
     end
     
     it "accepts :exclude option" do
-      hash = @band.send(:create_representation_with, {}, {:exclude => [:groupies]}, Representable::JSON)
+      hash = @band.send(:create_representation_with, {}, {:exclude => [:groupies]}, :hash)
       assert_equal({"name"=>"No One's Choice"}, hash)
     end
     
     it "still accepts deprecated :except option" do # FIXME: remove :except option.
-      assert_equal @band.send(:create_representation_with, {}, {:except => [:groupies]}, Representable::JSON), @band.send(:create_representation_with, {}, {:exclude => [:groupies]}, Representable::JSON)
+      assert_equal @band.send(:create_representation_with, {}, {:except => [:groupies]}, :hash), @band.send(:create_representation_with, {}, {:exclude => [:groupies]}, :hash)
     end
     
     it "accepts :include option" do
-      hash = @band.send(:create_representation_with, {}, {:include => [:groupies]}, Representable::JSON)
+      hash = @band.send(:create_representation_with, {}, {:include => [:groupies]}, :hash)
       assert_equal({"groupies"=>2}, hash)
     end
 
     it "does not write nil attributes" do
       @band.groupies = nil
-      assert_equal({"name"=>"No One's Choice"}, @band.send(:create_representation_with, {}, {}, Representable::JSON))
+      assert_equal({"name"=>"No One's Choice"}, @band.send(:create_representation_with, {}, {}, :hash))
     end
 
     it "writes false attributes" do
       @band.groupies = false
-      assert_equal({"name"=>"No One's Choice","groupies"=>false}, @band.send(:create_representation_with, {}, {}, Representable::JSON))
+      assert_equal({"name"=>"No One's Choice","groupies"=>false}, @band.send(:create_representation_with, {}, {}, :hash))
     end
     
     describe "when :render_nil is true" do
@@ -314,7 +314,7 @@ class RepresentableTest < MiniTest::Spec
         
         @band.extend(mod) # FIXME: use clean object.
         @band.groupies = nil
-        hash = @band.send(:create_representation_with, {}, {}, Representable::JSON)
+        hash = @band.send(:create_representation_with, {}, {}, :hash)
         assert_equal({"name"=>"No One's Choice", "groupies" => nil}, hash)
       end
       
@@ -327,7 +327,7 @@ class RepresentableTest < MiniTest::Spec
         
         @band.extend(mod) # FIXME: use clean object.
         @band.groupies = nil
-        hash = @band.send(:create_representation_with, {}, {}, Representable::JSON)
+        hash = @band.send(:create_representation_with, {}, {}, :hash)
         assert_equal({"name"=>"No One's Choice", "groupies" => nil}, hash)
       end
     end
@@ -341,21 +341,21 @@ class RepresentableTest < MiniTest::Spec
     it "respects property when condition true" do
       @pop.class_eval { property :fame, :if => lambda { true } }
       band = @pop.new
-      band.update_properties_from({"fame"=>"oh yes"}, {}, Representable::JSON)
+      band.update_properties_from({"fame"=>"oh yes"}, {}, :hash)
       assert_equal "oh yes", band.fame
     end
     
     it "ignores property when condition false" do
       @pop.class_eval { property :fame, :if => lambda { false } }
       band = @pop.new
-      band.update_properties_from({"fame"=>"oh yes"}, {}, Representable::JSON)
+      band.update_properties_from({"fame"=>"oh yes"}, {}, :hash)
       assert_equal nil, band.fame
     end
     
     it "ignores property when :exclude'ed even when condition is true" do
       @pop.class_eval { property :fame, :if => lambda { true } }
       band = @pop.new
-      band.update_properties_from({"fame"=>"oh yes"}, {:exclude => [:fame]}, Representable::JSON)
+      band.update_properties_from({"fame"=>"oh yes"}, {:exclude => [:fame]}, :hash)
       assert_equal nil, band.fame
     end
     
@@ -364,7 +364,7 @@ class RepresentableTest < MiniTest::Spec
       @pop.class_eval { property :fame, :if => lambda { groupies } }
       band = @pop.new
       band.groupies = true
-      band.update_properties_from({"fame"=>"oh yes"}, {}, Representable::JSON)
+      band.update_properties_from({"fame"=>"oh yes"}, {}, :hash)
       assert_equal "oh yes", band.fame
     end
   end

data/test/xml_test.rb

@@ -126,20 +126,20 @@ class XmlTest < MiniTest::Spec
     
     describe "XML#binding_for_definition" do
       it "returns AttributeBinding" do
-        assert_kind_of XML::AttributeBinding, Representable::XML.binding_for_definition(Def.new(:band, :from => "band", :attribute => true))
+        assert_kind_of XML::AttributeBinding, @band.send(:xml_binding_for_definition, Def.new(:band, :from => "band", :attribute => true))
       end
       
       it "returns PropertyBinding" do
-        assert_kind_of XML::PropertyBinding, Representable::XML.binding_for_definition(Def.new(:band, :class => Hash))
-        assert_kind_of XML::PropertyBinding, Representable::XML.binding_for_definition(Def.new(:band, :from => :content))
+        assert_kind_of XML::PropertyBinding, @band.send(:xml_binding_for_definition, Def.new(:band, :class => Hash))
+        assert_kind_of XML::PropertyBinding, @band.send(:xml_binding_for_definition, Def.new(:band, :from => :content))
       end
       
       it "returns CollectionBinding" do
-        assert_kind_of XML::CollectionBinding, Representable::XML.binding_for_definition(Def.new(:band, :collection => :true))
+        assert_kind_of XML::CollectionBinding, @band.send(:xml_binding_for_definition, Def.new(:band, :collection => :true))
       end
       
       it "returns HashBinding" do
-        assert_kind_of XML::HashBinding, Representable::XML.binding_for_definition(Def.new(:band, :hash => :true))
+        assert_kind_of XML::HashBinding, @band.send(:xml_binding_for_definition, Def.new(:band, :hash => :true))
       end
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-06 00:00:00.000000000 Z
+date: 2012-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri