representable 1.2.1 → 1.2.2

data/CHANGES.textile

@@ -1,3 +1,8 @@
+h2. 1.2.2
+
+* Added @XML::AttributeHash@ to store hash key-value pairs in attributes instead of dedicated tags.
+* @JSON::Hash@, @XML::Hash@ and @XML::AttributeHash@ now respect @:exclude@ and @:include@ when parsing and rendering.
+
 h2. 1.2.1
 
 * Deprecated @:represent_nil@ favor of @:render_nil@.

data/README.rdoc

@@ -185,7 +185,7 @@ You can use #items to configure the element representations contained in the arr
     items :class => Hero, :extend => HeroRepresenter
   end
 
-Collections and hashes can also be deserialized.
+Collections and hashes can also be deserialized. Note that this also works for XML.
 
 == Lonely Hashes
 
@@ -199,6 +199,8 @@ The same goes with hashes where #values lets you configure the hash's values.
   
   {:stu => Hero.new("Stu"), :clive => Hero.new("Cleavage")}.extend(FriendsRepresenter).to_json
 
+In XML, if you want to store hash attributes in tag attributes instead of dedicated nodes, use XML::AttributeHash.
+
 
 == Customizing
 

data/lib/representable/bindings/xml_bindings.rb

@@ -110,6 +110,24 @@ module Representable
       end
     end
     
+    class AttributeHashBinding < CollectionBinding
+      # DISCUSS: use AttributeBinding here?
+      def write(parent, value)  # DISCUSS: is it correct overriding #write here?
+        value.collect do |k, v|
+          parent[k] = serialize(v.to_s)
+        end
+        parent
+      end
+      
+      def deserialize_from(node)
+        {}.tap do |hash|
+          node.each do |k,v|
+            hash[k] = deserialize(v)
+          end
+        end
+      end
+    end
+    
     
     # Represents a tag attribute. Currently this only works on the top-level tag.
     class AttributeBinding < PropertyBinding

data/lib/representable/hash_methods.rb

@@ -0,0 +1,30 @@
+module Representable
+  module HashMethods
+    # FIXME: refactor Definition so we can simply add options in #items to existing definition.
+    def representable_attrs
+      attrs = super
+      attrs << Definition.new(*definition_opts) if attrs.size == 0
+      attrs
+    end
+    
+    def create_representation_with(doc, options, format)
+      bin   = representable_bindings_for(format).first
+      hash  = filter_keys_for(self, options)
+      bin.write(doc, hash)
+    end
+    
+    def update_properties_from(doc, options, format)
+      bin   = representable_bindings_for(format).first
+      hash  = filter_keys_for(doc, options)
+      value = bin.deserialize_from(hash)
+      replace(value)
+      self
+    end
+    
+  private
+    def filter_keys_for(hash, options)
+      return hash unless props = options[:exclude] || options[:include]
+      hash.reject { |k,v| options[:exclude] ? props.include?(k.to_sym) : !props.include?(k.to_sym) }
+    end
+  end
+end

data/lib/representable/json/hash.rb

@@ -1,6 +1,9 @@
+require 'representable/hash_methods'
+
 module Representable::JSON
   module Hash
     include Representable::JSON
+    include HashMethods
     
     def self.included(base)
       base.class_eval do
@@ -17,22 +20,8 @@ module Representable::JSON
     end
     
     
-    def create_representation_with(doc, options, format)
-      bin   = representable_bindings_for(format).first
-      bin.serialize_for(self)
-    end
-    
-    def update_properties_from(doc, options, format)
-      bin   = representable_bindings_for(format).first
-      value = bin.deserialize_from(doc)
-      replace(value)
-    end
-    
-    # FIXME: refactor Definition so we can simply add options in #items to existing definition.
-    def representable_attrs
-      attrs = super
-      attrs << Definition.new(:_self, :hash => true) if attrs.size == 0
-      attrs
+    def definition_opts
+      [:_self, :hash => true, :use_attributes => true]
     end
   end
 end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/lib/representable/xml.rb

@@ -5,9 +5,10 @@ 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?
-      return AttributeBinding.new(definition)        if definition.attribute
+      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
     

data/lib/representable/xml/hash.rb

@@ -1,6 +1,9 @@
+require 'representable/hash_methods'
+
 module Representable::XML
-  module Hash
+  module AttributeHash
     include Representable::XML
+    include Representable::HashMethods
     
     def self.included(base)
       base.class_eval do
@@ -12,27 +15,37 @@ module Representable::XML
     
     module ClassMethods
       def values(options)
-        hash :_self, options
+        hash :_self, options.merge!(:use_attributes => true)
       end
     end
     
     
-    def create_representation_with(doc, options, format)
-      bin   = representable_bindings_for(format).first
-      bin.serialize_for(self)
+    def definition_opts
+      [:_self, :hash => true, :use_attributes => true]
+    end
+  end
+  
+  module Hash
+    include Representable::XML
+    include HashMethods
+    
+    def self.included(base)
+      base.class_eval do
+        include Representable
+        extend ClassMethods
+      end
     end
     
-    def update_properties_from(doc, options, format)
-      bin   = representable_bindings_for(format).first
-      value = bin.deserialize_from(doc)
-      replace(value)
+    
+    module ClassMethods
+      def values(options)
+        hash :_self, options
+      end
     end
     
-    # FIXME: refactor Definition so we can simply add options in #items to existing definition.
-    def representable_attrs
-      attrs = super
-      attrs << Definition.new(:_self, :hash => true) if attrs.size == 0
-      attrs
+    
+   def definition_opts
+      [:_self, :hash => true]
     end
   end
 end

data/test/json_test.rb

@@ -493,7 +493,7 @@ end
       property :name
     end
     
-    describe "JSON::Hash" do
+    describe "JSON::Hash" do  # TODO: move to HashTest.
       describe "with contained objects" do
         before do
           @songs_representer = Module.new do
@@ -502,12 +502,32 @@ end
           end
         end
         
-        it "renders objects with #to_json" do
-          assert_equal "{\"one\":{\"name\":\"Days Go By\"},\"two\":{\"name\":\"Can't Take Them All\"}}", {:one => Song.new("Days Go By"), :two => Song.new("Can't Take Them All")}.extend(@songs_representer).to_json
+        describe "#to_json" do
+          it "renders objects" do
+            assert_equal "{\"one\":{\"name\":\"Days Go By\"},\"two\":{\"name\":\"Can't Take Them All\"}}", {:one => Song.new("Days Go By"), :two => Song.new("Can't Take Them All")}.extend(@songs_representer).to_json
+          end
+          
+          it "respects :exclude" do
+            assert_equal "{\"two\":{\"name\":\"Can't Take Them All\"}}", {:one => Song.new("Days Go By"), :two => Song.new("Can't Take Them All")}.extend(@songs_representer).to_json(:exclude => [:one])
+          end
+          
+          it "respects :include" do
+            assert_equal "{\"two\":{\"name\":\"Can't Take Them All\"}}", {:one => Song.new("Days Go By"), :two => Song.new("Can't Take Them All")}.extend(@songs_representer).to_json(:include => [:two])
+          end
         end
         
-        it "returns objects array from #from_json" do
-          assert_equal({"one" => Song.new("Days Go By"), "two" => Song.new("Can't Take Them All")}, {}.extend(@songs_representer).from_json("{\"one\":{\"name\":\"Days Go By\"},\"two\":{\"name\":\"Can't Take Them All\"}}"))
+        describe "#from_json" do
+          it "returns objects array" do
+            assert_equal({"one" => Song.new("Days Go By"), "two" => Song.new("Can't Take Them All")}, {}.extend(@songs_representer).from_json("{\"one\":{\"name\":\"Days Go By\"},\"two\":{\"name\":\"Can't Take Them All\"}}"))
+          end
+        
+          it "respects :exclude" do
+            assert_equal({"two" => Song.new("Can't Take Them All")}, {}.extend(@songs_representer).from_json("{\"one\":{\"name\":\"Days Go By\"},\"two\":{\"name\":\"Can't Take Them All\"}}", :exclude => [:one]))
+          end
+          
+          it "respects :include" do
+            assert_equal({"one" => Song.new("Days Go By")}, {}.extend(@songs_representer).from_json("{\"one\":{\"name\":\"Days Go By\"},\"two\":{\"name\":\"Can't Take Them All\"}}", :include => [:one]))
+          end
         end
       end
       

data/test/xml_test.rb

@@ -336,4 +336,42 @@ class CollectionTest < MiniTest::Spec
       assert_equal ["Laundry Basket", "Two Kevins", "Wright and Rong"].sort, album.songs.sort
     end
   end
+  
+  require 'representable/xml/hash'
+  describe "XML::AttributeHash" do  # TODO: move to HashTest.
+    before do
+      @songs_representer = Module.new do
+        include Representable::XML::AttributeHash
+        self.representation_wrap= :favs
+      end
+    end
+    
+    describe "#to_xml" do
+      it "renders values into attributes converting values to strings" do
+        assert_xml_equal "<favs one=\"Graveyards\" two=\"Can't Take Them All\" />", {:one => :Graveyards, :two => "Can't Take Them All"}.extend(@songs_representer).to_xml
+      end
+      
+      it "respects :exclude" do
+        assert_xml_equal "<favs two=\"Can't Take Them All\" />", {:one => :Graveyards, :two => "Can't Take Them All"}.extend(@songs_representer).to_xml(:exclude => [:one])
+      end
+      
+      it "respects :include" do
+        assert_xml_equal "<favs two=\"Can't Take Them All\" />", {:one => :Graveyards, :two => "Can't Take Them All"}.extend(@songs_representer).to_xml(:include => [:two])
+      end
+    end
+    
+    describe "#from_json" do
+      it "returns hash" do
+        assert_equal({"one" => "Graveyards", "two" => "Can't Take Them All"}, {}.extend(@songs_representer).from_xml("<favs one=\"Graveyards\" two=\"Can't Take Them All\" />"))
+      end
+    
+      it "respects :exclude" do
+        assert_equal({"two" => "Can't Take Them All"}, {}.extend(@songs_representer).from_xml("<favs one=\"Graveyards\" two=\"Can't Take Them All\" />", :exclude => [:one]))
+      end
+      
+      it "respects :include" do
+        assert_equal({"one" => "Graveyards"}, {}.extend(@songs_representer).from_xml("<favs one=\"Graveyards\" two=\"Can't Take Them All\" />", :include => [:one]))
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-01 00:00:00.000000000 Z
+date: 2012-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -162,6 +162,7 @@ files:
 - lib/representable/coercion.rb
 - lib/representable/definition.rb
 - lib/representable/deprecations.rb
+- lib/representable/hash_methods.rb
 - lib/representable/json.rb
 - lib/representable/json/collection.rb
 - lib/representable/json/hash.rb