representable 1.2.5 → 1.2.6

data/CHANGES.textile

@@ -1,3 +1,7 @@
+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.
+
 h2. 1.2.5
 
 * Add support for YAML.
@@ -21,6 +25,7 @@ h2. 1.2.1
 * Deprecated @:represent_nil@ favor of @:render_nil@.
 * API change: if a property is missing in an incoming document and there is no default set it is completely ignored and *not* set in the represented object.
 
+
 h2. 1.2.0
 
 * Deprecated @:except@ in favor of @:exclude@.

data/README.rdoc

@@ -80,7 +80,7 @@ Those two properties are considered when rendering in #to_json.
 
 == Parsing
 
-The cool thing about Representable is: it works bidirectional. By declaring properties you can not only render but also parse!
+The cool thing about Representable is: it works bidirectional. The document definition in your representer module can also be used for parsing documents and assigning property values.
 
   hook = Hero.from_json('{"forename":"Captain","surename":"Hook"}')
   hook.forename #=> "Captain"

data/lib/representable/binding.rb

@@ -11,17 +11,13 @@ module Representable
     end
     
     # Main entry point for rendering/parsing a property object.
-    module Hooks
-      def serialize(value)
-        value
-      end
-      
-      def deserialize(fragment)
-        fragment
-      end
+    def serialize(value)
+      value
     end
     
-    include Hooks
+    def deserialize(fragment)
+      fragment
+    end
     
     
     # Hooks into #serialize and #deserialize to extend typed properties

data/lib/representable/bindings/{json_bindings.rb → hash_bindings.rb}

@@ -1,7 +1,7 @@
 require 'representable/binding'
 
 module Representable
-  module JSON
+  module Hash
     module ObjectBinding
       include Binding::Object
       
@@ -15,7 +15,7 @@ module Representable
     end
     
     
-    class JSONBinding < Representable::Binding
+    class PropertyBinding < Representable::Binding
       def initialize(definition) # FIXME. make generic.
         super
         extend ObjectBinding if definition.typed?
@@ -31,10 +31,7 @@ module Representable
       def write(hash, value)
         hash[definition.from] = serialize_for(value)
       end
-    end
-    
-    
-    class PropertyBinding < JSONBinding
+      
       def serialize_for(value)
         serialize(value)
       end
@@ -45,7 +42,7 @@ module Representable
     end
     
     
-    class CollectionBinding < JSONBinding
+    class CollectionBinding < PropertyBinding
       def serialize_for(value)
         value.collect { |obj| serialize(obj) }
       end
@@ -56,7 +53,7 @@ module Representable
     end
     
     
-    class HashBinding < JSONBinding
+    class HashBinding < PropertyBinding
       def serialize_for(value)
         # requires value to respond to #each with two block parameters.
         {}.tap do |hash|

data/lib/representable/bindings/yaml_bindings.rb

@@ -18,34 +18,20 @@ module Representable
       end
     end
 
-    class YAMLBinding < Representable::Binding
+    class PropertyBinding < Representable::Hash::PropertyBinding
       def initialize(definition) # FIXME. make generic.
         super
         extend ObjectBinding if definition.typed?
       end
       
-      def read(hash)
-        return FragmentNotFound unless hash.has_key?(definition.from) # DISCUSS: put it all in #read for performance. not really sure if i like returning that special thing.
-        
-        fragment = hash[definition.from]
-        deserialize_from(fragment)
-      end
-      
       def write(map, value)
         map.children << Psych::Nodes::Scalar.new(definition.from)
         map.children << serialize_for(value)  # FIXME: should be serialize.
       end
-    end
-    
-    
-    class PropertyBinding < YAMLBinding
+
       def serialize_for(value)
         write_scalar serialize(value)
       end
-      
-      def deserialize_from(fragment)
-        deserialize(fragment)
-      end
 
       def write_scalar(value)
         Psych::Nodes::Scalar.new(value.to_s)
@@ -61,7 +47,7 @@ module Representable
         end
       end
       
-      def deserialize_from(fragment)
+      def deserialize_from(fragment)  # FIXME: redundant from Hash::Bindings
         fragment.collect { |item_fragment| deserialize(item_fragment) }
       end
     end

data/lib/representable/hash.rb

@@ -0,0 +1,47 @@
+require 'representable'
+require 'representable/bindings/hash_bindings'
+require 'json'
+
+module Representable
+  # The generic representer. Brings #to_hash and #from_hash to your object.
+  # If you plan to write your own representer for a new media type, try to use this module (e.g., check how JSON reuses Hash's internal
+  # architecture).
+  module Hash
+    def self.included(base)
+      base.class_eval do
+        include Representable # either in Hero or HeroRepresentation.
+        extend ClassMethods # DISCUSS: do that only for classes?
+      end
+    end
+    
+    
+    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={})
+      if wrap = options[:wrap] || representation_wrap
+        data = data[wrap.to_s]
+      end
+      
+      update_properties_from(data, options, JSON)
+    end
+    
+    def to_hash(options={})
+      hash = create_representation_with({}, options, JSON)
+      
+      return hash unless wrap = options[:wrap] || representation_wrap
+      
+      {wrap => hash}
+    end
+  end
+end

data/lib/representable/json.rb

@@ -1,23 +1,17 @@
-require 'representable'
-require 'representable/bindings/json_bindings'
+require 'representable/hash'
 require 'json'
 
 module Representable
-  # Brings #to_xml, #to_hash, #from_xml and #from_hash to your object.
-  #
-  # Note: The authorative methods are #to_hash and #from_hash, if you override #to_json instead,
-  # things might work as expected.
+  # Brings #to_json and #from_json to your object.
   module JSON
-    def self.binding_for_definition(definition)
-      return CollectionBinding.new(definition)  if definition.array?
-      return HashBinding.new(definition)        if definition.hash?
-      PropertyBinding.new(definition)
-    end
-    
+    extend Hash::ClassMethods
+    include Hash
+
     def self.included(base)
       base.class_eval do
         include Representable # either in Hero or HeroRepresentation.
         extend ClassMethods # DISCUSS: do that only for classes?
+        extend Representable::Hash::ClassMethods  # DISCUSS: this is only for .from_hash, remove in 2.3?
       end
     end
     
@@ -27,10 +21,6 @@ module Representable
       def from_json(*args, &block)
         create_represented(*args, &block).from_json(*args)
       end
-      
-      def from_hash(*args, &block)
-        create_represented(*args, &block).from_hash(*args)
-      end
     end
     
     
@@ -40,22 +30,6 @@ module Representable
       from_hash(data, *args)
     end
     
-    def from_hash(data, options={})
-      if wrap = options[:wrap] || representation_wrap
-        data = data[wrap.to_s]
-      end
-      
-      update_properties_from(data, options, JSON)
-    end
-    
-    def to_hash(options={})
-      hash = create_representation_with({}, options, JSON)
-      
-      return hash unless wrap = options[:wrap] || representation_wrap
-      
-      {wrap => hash}
-    end
-    
     # Returns a JSON string representing this object.
     def to_json(*args)
       to_hash(*args).to_json

data/lib/representable/version.rb

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

data/lib/representable/yaml.rb

@@ -1,8 +1,10 @@
-require 'representable'
+require 'representable/hash'
 require 'representable/bindings/yaml_bindings'
 
 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.
@@ -28,12 +30,8 @@ module Representable
       #
       # Example:
       #   band.from_xml("<band><name>Nofx</name></band>")
-      def from_xml(*args, &block)
-        create_represented(*args, &block).from_xml(*args)
-      end
-      
-      def from_node(*args, &block)
-        create_represented(*args, &block).from_node(*args)
+      def from_yaml(*args, &block)
+        create_represented(*args, &block).from_yaml(*args)
       end
     end
     
@@ -43,10 +41,6 @@ module Representable
       from_hash(hash, *args)
     end
     
-    def from_hash(hash, options={})
-      update_properties_from(hash, options, YAML)
-    end
-    
     # Returns a Nokogiri::XML object representing this object.
     def to_ast(options={})
       #root_tag = options[:wrap] || representation_wrap

data/test/{json_bindings_test.rb → hash_bindings_test.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class JSONBindingTest < MiniTest::Spec
+class HashBindingTest < MiniTest::Spec
   module SongRepresenter
     include Representable::JSON
     property :name
@@ -15,7 +15,7 @@ class JSONBindingTest < MiniTest::Spec
   describe "PropertyBinding" do
     describe "#read" do
       before do
-        @property = Representable::JSON::PropertyBinding.new(Representable::Definition.new(:song))
+        @property = Representable::Hash::PropertyBinding.new(Representable::Definition.new(:song))
       end
       
       it "returns fragment if present" do
@@ -32,7 +32,7 @@ class JSONBindingTest < MiniTest::Spec
     
     describe "with plain text" do
       before do
-        @property = Representable::JSON::PropertyBinding.new(Representable::Definition.new(:song))
+        @property = Representable::Hash::PropertyBinding.new(Representable::Definition.new(:song))
       end
       
       it "extracts with #read" do
@@ -48,7 +48,7 @@ class JSONBindingTest < MiniTest::Spec
     
     describe "with an object" do
       before do
-        @property = Representable::JSON::PropertyBinding.new(Representable::Definition.new(:song, :class => SongWithRepresenter))
+        @property = Representable::Hash::PropertyBinding.new(Representable::Definition.new(:song, :class => SongWithRepresenter))
         @doc      = {}
       end
       
@@ -64,7 +64,7 @@ class JSONBindingTest < MiniTest::Spec
     
     describe "with an object and :extend" do
       before do
-        @property = Representable::JSON::PropertyBinding.new(Representable::Definition.new(:song, :class => Song, :extend => SongRepresenter))
+        @property = Representable::Hash::PropertyBinding.new(Representable::Definition.new(:song, :class => Song, :extend => SongRepresenter))
         @doc      = {}
       end
       
@@ -83,7 +83,7 @@ class JSONBindingTest < MiniTest::Spec
   describe "CollectionBinding" do
     describe "with plain text items" do
       before do
-        @property = Representable::JSON::CollectionBinding.new(Representable::Definition.new(:songs, :collection => true))
+        @property = Representable::Hash::CollectionBinding.new(Representable::Definition.new(:songs, :collection => true))
       end
       
       it "extracts with #read" do
@@ -104,7 +104,7 @@ class JSONBindingTest < MiniTest::Spec
   describe "HashBinding" do
     describe "with plain text items" do
       before do
-        @property = Representable::JSON::HashBinding.new(Representable::Definition.new(:songs, :hash => true))
+        @property = Representable::Hash::HashBinding.new(Representable::Definition.new(:songs, :hash => true))
       end
       
       it "extracts with #read" do
@@ -120,7 +120,7 @@ class JSONBindingTest < MiniTest::Spec
     
     describe "with objects" do
       before do
-        @property = Representable::JSON::HashBinding.new(Representable::Definition.new(:songs, :hash => true, :class => Song, :extend => SongRepresenter))
+        @property = Representable::Hash::HashBinding.new(Representable::Definition.new(:songs, :hash => true, :class => Song, :extend => SongRepresenter))
       end
       
       it "doesn't change the represented hash in #write" do

data/test/hash_test.rb

@@ -0,0 +1,117 @@
+require 'test_helper'
+require 'representable/hash'
+
+class YamlTest < MiniTest::Spec
+  def self.hash_representer(&block)
+    Module.new do
+      include Representable::Hash
+      instance_exec &block
+    end
+  end
+
+  def hash_representer(&block)
+    self.class.hash_representer(&block)
+  end
+
+
+  describe "property" do
+    let (:hash) { hash_representer do property :best_song end }
+
+    let (:album) { Album.new.tap do |album|
+      album.best_song = "Liar"
+    end }
+
+    describe "#to_hash" do
+      it "renders plain property" do
+        album.extend(hash).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"
+      end
+    end
+
+
+    describe "with :class and :extend" do
+      hash_song = hash_representer do property :name end
+      let (:hash_album) { Module.new do
+        include Representable::Hash
+        property :best_song, :extend => hash_song, :class => Song
+      end }
+
+      let (:album) { Album.new.tap do |album|
+        album.best_song = Song.new("Liar")
+      end }
+
+
+      describe "#to_hash" do
+        it "renders embedded typed property" do
+          album.extend(hash_album).to_hash.must_equal("best_song" => {"name" => "Liar"})
+        end
+      end
+
+      describe "#from_hash" do
+        it "parses embedded typed property" do
+          album.extend(hash_album).from_hash("best_song" => {"name" => "Go With Me"}).must_equal Album.new(nil,Song.new("Go With Me"))
+        end
+      end
+    end
+  end
+
+
+  describe "collection" do
+    let (:hash) { hash_representer do collection :songs end }
+
+    let (:album) { Album.new.tap do |album|
+      album.songs = ["Jackhammer", "Terrible Man"]
+    end }
+
+
+    describe "#to_hash" do
+      it "renders a block style list per default" do
+        album.extend(hash).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"])
+
+      end
+    end
+
+
+    describe "with :class and :extend" do
+      hash_song = hash_representer do 
+        property :name
+        property :track
+      end
+      let (:hash_album) { Module.new do
+        include Representable::Hash
+        collection :songs, :extend => hash_song, :class => Song
+      end }
+
+      let (:album) { Album.new.tap do |album|
+        album.songs = [Song.new("Liar", 1), Song.new("What I Know", 2)]
+      end }
+
+
+      describe "#to_hash" do
+        it "renders collection of typed property" do
+          album.extend(hash_album).to_hash.must_equal("songs" => [{"name" => "Liar", "track" => 1}, {"name" => "What I Know", "track" => 2}])
+        end
+      end
+
+      describe "#from_hash" do
+        it "parses collection of typed property" do
+          album.extend(hash_album).from_hash("songs" => [{"name" => "One Shot Deal", "track" => 4},
+            {"name" => "Three Way Dance", "track" => 5}]).must_equal Album.new([Song.new("One Shot Deal", 4), Song.new("Three Way Dance", 5)])
+        end
+      end
+    end
+  end
+end

data/test/json_test.rb

@@ -128,19 +128,19 @@ module JsonTest
 
       describe "#binding_for_definition" do
         it "returns ObjectBinding" do
-          assert_kind_of Json::ObjectBinding, Json.binding_for_definition(Def.new(:band, :class => Hash))
+          assert_kind_of Representable::Hash::ObjectBinding, Json.binding_for_definition(Def.new(:band, :class => Hash))
         end
 
         it "returns TextBinding" do
-          assert_kind_of Json::PropertyBinding, Json.binding_for_definition(Def.new(:band))
+          assert_kind_of Representable::Hash::PropertyBinding, Json.binding_for_definition(Def.new(:band))
         end
 
         it "returns HashBinding" do
-          assert_kind_of Json::HashBinding, Json.binding_for_definition(Def.new(:band, :hash => true))
+          assert_kind_of Representable::Hash::HashBinding, Json.binding_for_definition(Def.new(:band, :hash => true))
         end
 
         it "returns CollectionBinding" do
-          assert_kind_of Json::CollectionBinding, Json.binding_for_definition(Def.new(:band, :collection => true))
+          assert_kind_of Representable::Hash::CollectionBinding, Json.binding_for_definition(Def.new(:band, :collection => true))
         end
       end
 

data/test/representable_test.rb

@@ -136,12 +136,6 @@ class RepresentableTest < MiniTest::Spec
   
   
   describe "#property" do
-    it "creates accessors for the attribute" do
-      @band = PunkBand.new
-      assert @band.name = "Bad Religion"
-      assert_equal "Bad Religion", @band.name
-    end
-    
     describe ":from" do
       # TODO: do this with all options.
       it "can be set explicitly" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2012-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -158,12 +158,13 @@ files:
 - gemfiles/Gemfile.mongoid-2.4
 - lib/representable.rb
 - lib/representable/binding.rb
-- lib/representable/bindings/json_bindings.rb
+- lib/representable/bindings/hash_bindings.rb
 - lib/representable/bindings/xml_bindings.rb
 - lib/representable/bindings/yaml_bindings.rb
 - lib/representable/coercion.rb
 - lib/representable/definition.rb
 - lib/representable/deprecations.rb
+- lib/representable/hash.rb
 - lib/representable/hash_methods.rb
 - lib/representable/json.rb
 - lib/representable/json/collection.rb
@@ -176,7 +177,8 @@ files:
 - representable.gemspec
 - test/coercion_test.rb
 - test/definition_test.rb
-- test/json_bindings_test.rb
+- test/hash_bindings_test.rb
+- test/hash_test.rb
 - test/json_test.rb
 - test/mongoid_test.rb
 - test/polymorphic_test.rb