representable 1.0.1 → 1.1.0

data/lib/representable/json.rb

@@ -9,8 +9,9 @@ module Representable
   # things might work as expected.
   module JSON
     def self.binding_for_definition(definition)
-      return ObjectBinding.new(definition) if definition.typed?
-      TextBinding.new(definition)
+      return CollectionBinding.new(definition)  if definition.array?
+      return HashBinding.new(definition)        if definition.hash?
+      PropertyBinding.new(definition)
     end
     
     def self.included(base)

data/lib/representable/json/collection.rb

@@ -0,0 +1,38 @@
+module Representable::JSON
+  module Collection
+    include Representable::JSON
+    
+    def self.included(base)
+      base.class_eval do
+        include Representable
+        extend ClassMethods
+      end
+    end
+    
+    
+    module ClassMethods
+      def items(options)
+        collection :_self, options
+      end
+    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, :collection => true) if attrs.size == 0
+      attrs
+    end
+  end
+end

data/lib/representable/json/hash.rb

@@ -0,0 +1,38 @@
+module Representable::JSON
+  module Hash
+    include Representable::JSON
+    
+    def self.included(base)
+      base.class_eval do
+        include Representable
+        extend ClassMethods
+      end
+    end
+    
+    
+    module ClassMethods
+      def values(options)
+        hash :_self, options
+      end
+    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
+    end
+  end
+end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/representable/xml.rb

@@ -5,9 +5,10 @@ require 'nokogiri'
 module Representable
   module XML
     def self.binding_for_definition(definition)
-      return ObjectBinding.new(definition) if definition.typed?
-      return AttributeBinding.new(definition) if definition.attribute
-      TextBinding.new(definition)
+      return CollectionBinding.new(definition)  if definition.array?
+      return HashBinding.new(definition)        if definition.hash?
+      return AttributeBinding.new(definition)        if definition.attribute
+      PropertyBinding.new(definition)
     end
     
     def self.included(base)

data/lib/representable/xml/collection.rb

@@ -0,0 +1,38 @@
+module Representable::XML
+  module Collection
+    include Representable::XML
+    
+    def self.included(base)
+      base.class_eval do
+        include Representable
+        extend ClassMethods
+      end
+    end
+    
+    
+    module ClassMethods
+      def items(options)
+        collection :_self, options
+      end
+    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, :collection => true) if attrs.size == 0
+      attrs
+    end
+  end
+end

data/lib/representable/xml/hash.rb

@@ -0,0 +1,38 @@
+module Representable::XML
+  module Hash
+    include Representable::XML
+    
+    def self.included(base)
+      base.class_eval do
+        include Representable
+        extend ClassMethods
+      end
+    end
+    
+    
+    module ClassMethods
+      def values(options)
+        hash :_self, options
+      end
+    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
+    end
+  end
+end

data/test/definition_test.rb

@@ -13,9 +13,18 @@ class DefinitionTest < MiniTest::Spec
       end
     end
     
-    it "responds to #typed?" do
-      assert ! @def.typed?
-      assert Representable::Definition.new(:songs, :class => Hash).typed?
+    describe "#typed?" do
+      it "is false per default" do
+        assert ! @def.typed?
+      end
+      
+      it "is true when :class is present" do
+        assert Representable::Definition.new(:songs, :class => Hash).typed?
+      end
+      
+      it "is true when :extend is present, only" do
+        assert Representable::Definition.new(:songs, :extend => Hash).typed?
+      end
     end
     
     it "responds to #getter and returns string" do
@@ -26,10 +35,6 @@ class DefinitionTest < MiniTest::Spec
       assert_equal "songs", @def.name 
     end
     
-    it "responds to #instance_variable_name" do
-      assert_equal :"@songs", @def.instance_variable_name
-    end
-    
     it "responds to #setter" do
       assert_equal :"songs=", @def.setter
     end
@@ -39,23 +44,6 @@ class DefinitionTest < MiniTest::Spec
     end
   end
   
-  
-  describe "#apply" do
-    it "works with a single item" do
-      @d = Representable::Definition.new(:song)
-      assert_equal 2, @d.apply(1) { |v| v+1 }
-    end
-    
-    it "works with collection" do
-      @d = Representable::Definition.new(:song, :collection => true)
-      assert_equal [2,3,4], @d.apply([1,2,3]) { |v| v+1 }
-    end
-    
-    it "skips with collection and nil" do
-      @d = Representable::Definition.new(:song, :collection => true)
-      assert_equal nil, @d.apply(nil) { |v| v+1 }
-    end
-  end
     
   describe ":collection => true" do
     before do
@@ -96,4 +84,15 @@ class DefinitionTest < MiniTest::Spec
       assert_equal "Atheist Peace", @def.default
     end
   end
+  
+  describe ":hash => true" do
+    before do
+      @def = Representable::Definition.new(:songs, :hash => true)
+    end
+    
+    it "responds to #hash?" do
+      assert @def.hash?
+      assert ! Representable::Definition.new(:songs).hash?
+    end
+  end
 end

data/test/json_bindings_test.rb

@@ -0,0 +1,119 @@
+require 'test_helper'
+require 'representable/json'
+
+class JSONBindingTest < MiniTest::Spec
+  module SongRepresenter
+    include Representable::JSON
+    property :name
+  end
+  
+  class SongWithRepresenter < ::Song
+    include Representable
+    include SongRepresenter
+  end
+  
+  
+  describe "PropertyBinding" do
+    describe "with plain text" do
+      before do
+        @property = Representable::JSON::PropertyBinding.new(Representable::Definition.new(:song))
+      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::JSON::PropertyBinding.new(Representable::Definition.new(:song, :class => SongWithRepresenter))
+        @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::JSON::PropertyBinding.new(Representable::Definition.new(:song, :class => Song, :extend => SongRepresenter))
+        @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::JSON::CollectionBinding.new(Representable::Definition.new(:songs, :collection => true))
+      end
+      
+      it "extracts with #read" do
+        assert_equal ["The Gargoyle", "Bronx"], @property.read("songs" => ["The Gargoyle", "Bronx"])
+      end
+      
+      it "inserts with #write" do
+        doc = {}
+        assert_equal(["The Gargoyle", "Bronx"], @property.write(doc, ["The Gargoyle", "Bronx"]))
+        assert_equal({"songs"=>["The Gargoyle", "Bronx"]}, doc)
+      end
+    end
+  end
+  
+  
+  
+    
+  describe "HashBinding" do
+    describe "with plain text items" do
+      before do
+        @property = Representable::JSON::HashBinding.new(Representable::Definition.new(:songs, :hash => true))
+      end
+      
+      it "extracts with #read" do
+        assert_equal({"first" => "The Gargoyle", "second" => "Bronx"} , @property.read("songs" => {"first" => "The Gargoyle", "second" => "Bronx"}))
+      end
+      
+      it "inserts with #write" do
+        doc = {}
+        assert_equal({"first" => "The Gargoyle", "second" => "Bronx"}, @property.write(doc, {"first" => "The Gargoyle", "second" => "Bronx"}))
+        assert_equal({"songs"=>{"first" => "The Gargoyle", "second" => "Bronx"}}, doc)
+      end
+    end
+    
+    describe "with objects" do
+      before do
+        @property = Representable::JSON::HashBinding.new(Representable::Definition.new(:songs, :hash => true, :class => Song, :extend => SongRepresenter))
+      end
+      
+      it "doesn't change the represented hash in #write" do
+        song = Song.new("Better Than That")
+        hash = {"first" => song}
+        @property.write({}, hash)
+        assert_equal({"first" => song}, hash)
+      end
+    end
+    
+  end
+end

data/test/json_test.rb

@@ -133,7 +133,15 @@ module JsonTest
         end
         
         it "returns TextBinding" do
-          assert_kind_of Json::TextBinding, Json.binding_for_definition(Def.new(:band))
+          assert_kind_of Json::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))
+        end
+        
+        it "returns CollectionBinding" do
+          assert_kind_of Json::CollectionBinding, Json.binding_for_definition(Def.new(:band, :collection => true))
         end
       end
       
@@ -155,7 +163,7 @@ module JsonTest
       module AlbumRepresenter
         include Representable::JSON
         property :best_song, :class => Song, :extend => SongRepresenter
-        collection :songs, :class => Song, :extend => SongRepresenter
+        collection :songs, :class => Song, :extend => [SongRepresenter]
       end
       
       
@@ -194,7 +202,8 @@ module JsonTest
       end
     end
   end
-
+  
+  
   class PropertyTest < MiniTest::Spec
     describe "property :name" do
       class Band
@@ -405,4 +414,119 @@ end
       end
     end
   end
+  
+  class HashTest < MiniTest::Spec
+    describe "hash :songs" do
+      before do
+        representer = Module.new do
+          include Representable::JSON
+          hash :songs
+        end
+        
+        class SongList
+          attr_accessor :songs
+        end
+        
+        @list = SongList.new.extend(representer)
+      end
+      
+      it "renders with #to_json" do
+        @list.songs = {:one => "65", :two => "Emo Boy"}
+        assert_equal "{\"songs\":{\"one\":\"65\",\"two\":\"Emo Boy\"}}", @list.to_json
+      end
+      
+      it "parses with #from_json" do
+        assert_equal({"one" => "65", "two" => ["Emo Boy"]}, @list.from_json("{\"songs\":{\"one\":\"65\",\"two\":[\"Emo Boy\"]}}").songs)
+      end
+    end
+    
+  end
+  
+  
+  require 'representable/json/collection'
+  class CollectionRepresenterTest < MiniTest::Spec
+    module SongRepresenter
+      include Representable::JSON
+      property :name
+    end
+    
+    describe "JSON::Collection" do
+      describe "with contained objects" do
+        before do
+          @songs_representer = Module.new do
+            include Representable::JSON::Collection
+            items :class => Song, :extend => SongRepresenter
+          end
+        end
+        
+        it "renders objects with #to_json" do
+          assert_equal "[{\"name\":\"Days Go By\"},{\"name\":\"Can't Take Them All\"}]", [Song.new("Days Go By"), Song.new("Can't Take Them All")].extend(@songs_representer).to_json
+        end
+        
+        it "returns objects array from #from_json" do
+          assert_equal [Song.new("Days Go By"), Song.new("Can't Take Them All")], [].extend(@songs_representer).from_json("[{\"name\":\"Days Go By\"},{\"name\":\"Can't Take Them All\"}]")
+        end
+      end
+      
+      describe "with contained text" do
+        before do
+          @songs_representer = Module.new do
+            include Representable::JSON::Collection
+          end
+        end
+        
+        it "renders contained items #to_json" do
+          assert_equal "[\"Days Go By\",\"Can't Take Them All\"]", ["Days Go By", "Can't Take Them All"].extend(@songs_representer).to_json
+        end
+        
+        it "returns objects array from #from_json" do
+          assert_equal ["Days Go By", "Can't Take Them All"], [].extend(@songs_representer).from_json("[\"Days Go By\",\"Can't Take Them All\"]")
+        end
+      end
+    end
+  end
+  
+  
+  require 'representable/json/hash'
+  class HashRepresenterTest < MiniTest::Spec
+    module SongRepresenter
+      include Representable::JSON
+      property :name
+    end
+    
+    describe "JSON::Hash" do
+      describe "with contained objects" do
+        before do
+          @songs_representer = Module.new do
+            include Representable::JSON::Hash
+            values :class => Song, :extend => SongRepresenter
+          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
+        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\"}}"))
+        end
+      end
+      
+      describe "with contained text" do
+        before do
+          @songs_representer = Module.new do
+            include Representable::JSON::Collection
+          end
+        end
+        
+        it "renders contained items #to_json" do
+          assert_equal "[\"Days Go By\",\"Can't Take Them All\"]", ["Days Go By", "Can't Take Them All"].extend(@songs_representer).to_json
+        end
+        
+        it "returns objects array from #from_json" do
+          assert_equal ["Days Go By", "Can't Take Them All"], [].extend(@songs_representer).from_json("[\"Days Go By\",\"Can't Take Them All\"]")
+        end
+      end
+    end
+  end
 end