representable 0.11.0 → 0.12.0

data/lib/representable/bindings/xml_bindings.rb

@@ -1,12 +1,8 @@
+require 'representable/binding'
+
 module Representable
   module XML
-    class Binding
-      attr_reader :definition
-
-      def initialize(definition)
-        @definition = definition
-      end
-      
+    class Binding < Representable::Binding
       def read(xml)
         value_from_node(xml)
       end
@@ -66,12 +62,17 @@ module Representable
 
     # Represents a tag with object binding.
     class ObjectBinding < Binding
+      include Representable::Binding::Hooks # includes #create_object and #write_object.
+      include Representable::Binding::Extend
+      
       # Adds the ref's markup to +xml+. 
-      def write(xml, value)
+      def write(xml, object)
         if definition.array?
-          write_collection(xml, value)
+          object.each do |item|
+            write_entity(xml, item)
+          end
         else
-          write_entity(xml, value)
+          write_entity(xml, object)
         end
       end
 
@@ -79,18 +80,12 @@ module Representable
       # Deserializes the ref's element from +xml+.
       def value_from_node(xml)
         collect_for(xml) do |node|
-          definition.sought_type.from_node(node)
-        end
-      end
-      
-      def write_collection(xml, collection)
-        collection.each do |item|
-          write_entity(xml, item)
+          create_object.from_node(node)
         end
       end
       
       def write_entity(xml, entity)
-        xml.add_child(entity.to_node)
+        xml.add_child(write_object(entity).to_node)
       end
     end
   end

data/lib/representable/definition.rb

@@ -1,16 +1,17 @@
 module Representable
   # Created at class compile time. Keeps configuration options for one property.
   class Definition
-    attr_reader :name, :sought_type, :from, :default
+    attr_reader :name, :sought_type, :from, :default, :representer_module
     alias_method :getter, :name
     
     def initialize(sym, options={})
-      @name         = sym.to_s
-      @array        = options[:collection]
-      @from         = (options[:from] || name).to_s
-      @sought_type  = options[:as] || :text
-      @default      = options[:default]
-      @default      ||= [] if array?
+      @name               = sym.to_s
+      @array              = options[:collection]
+      @from               = (options[:from] || name).to_s
+      @sought_type        = options[:class] || options[:class] || :text  # TODO: deprecate :class in 1.0.
+      @default            = options[:default]
+      @default            ||= [] if array?
+      @representer_module = options[:extend]  # DISCUSS: move to Representable::DCI?
       
       # FIXME: move me to xml.
       if options[:from].to_s =~ /^@/

data/lib/representable/json.rb

@@ -15,7 +15,7 @@ module Representable
     def self.included(base)
       base.class_eval do
         include Representable # either in Hero or HeroRepresentation.
-        extend ClassMethods
+        extend ClassMethods # DISCUSS: do that only for classes?
       end
     end
     
@@ -23,30 +23,31 @@ module Representable
     module ClassMethods
       # Creates a new object from the passed JSON document.
       def from_json(*args, &block)
-        new.from_json(*args, &block)
+        create_represented(*args, &block).from_json(*args)
       end
       
       def from_hash(*args, &block)
-        new.from_hash(*args, &block)
+        create_represented(*args, &block).from_hash(*args)
       end
     end
     
+    
     # Parses the body as JSON and delegates to #from_hash.
-    def from_json(data, *args, &block)
+    def from_json(data, *args)
       data = ::JSON[data]
-      from_hash(data, *args, &block)
+      from_hash(data, *args)
     end
     
-    def from_hash(data, options={}, &block)
+    def from_hash(data, options={})
       if wrap = options[:wrap] || representation_wrap
         data = data[wrap.to_s]
       end
       
-      update_properties_from(data, &block)
+      update_properties_from(data, options)
     end
     
-    def to_hash(options={}, &block)
-      hash = create_representation_with({}, &block)
+    def to_hash(options={})
+      hash = create_representation_with({}, options)
       
       return hash unless wrap = options[:wrap] || representation_wrap
       
@@ -54,8 +55,8 @@ module Representable
     end
     
     # Returns a JSON string representing this object.
-    def to_json(*args, &block)
-      to_hash(*args, &block).to_json
+    def to_json(*args)
+      to_hash(*args).to_json
     end
     
     def binding_for_definition(definition)

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

data/lib/representable/xml.rb

@@ -27,33 +27,33 @@ module Representable
       # Example:
       #   band.from_xml("<band><name>Nofx</name></band>")
       def from_xml(*args, &block)
-        new.from_xml(*args, &block)
+        create_represented(*args, &block).from_xml(*args)
       end
       
       def from_node(*args, &block)
-        new.from_node(*args, &block)
+        create_represented(*args, &block).from_node(*args)
       end
     end
     
     
-    def from_xml(doc, *args, &block)
+    def from_xml(doc, *args)
       node = Nokogiri::XML(doc).root
-      from_node(node, *args, &block)
+      from_node(node, *args)
     end
     
-    def from_node(node, options={}, &block)
-      update_properties_from(node, &block)
+    def from_node(node, options={})
+      update_properties_from(node, options)
     end
     
     # Returns a Nokogiri::XML object representing this object.
-    def to_node(options={}, &block)
+    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), &block)
+      create_representation_with(Nokogiri::XML::Node.new(root_tag.to_s, Nokogiri::XML::Document.new), options)
     end
     
-    def to_xml(*args, &block)
-      to_node(*args, &block).to_s
+    def to_xml(*args)
+      to_node(*args).to_s
     end
     
     def binding_for_definition(definition)

data/test/definition_test.rb

@@ -6,9 +6,16 @@ class DefinitionTest < MiniTest::Spec
       @def = Representable::Definition.new(:songs)
     end
     
+    describe "DCI" do
+      it "responds to #representer_module" do
+        assert_equal nil, Representable::Definition.new(:song).representer_module
+        assert_equal Hash, Representable::Definition.new(:song, :extend => Hash).representer_module
+      end
+    end
+    
     it "responds to #typed?" do
       assert ! @def.typed?
-      assert Representable::Definition.new(:songs, :as => Hash).typed?
+      assert Representable::Definition.new(:songs, :class => Hash).typed?
     end
     
     it "responds to #getter and returns string" do
@@ -68,9 +75,9 @@ class DefinitionTest < MiniTest::Spec
     end
   end
   
-  describe ":as => Item" do
+  describe ":class => Item" do
     before do
-      @def = Representable::Definition.new(:songs, :as => Hash)
+      @def = Representable::Definition.new(:songs, :class => Hash)
     end
     
     it "responds to #sought_type" do

data/test/json_test.rb

@@ -10,8 +10,8 @@ module JsonTest
       before do
         @Band = Class.new do
           include Representable::JSON
-          representable_property :name
-          representable_property :label
+          property :name
+          property :label
           
           def initialize(name=nil)
             self.name = name if name
@@ -24,18 +24,35 @@ module JsonTest
     
       describe ".from_json" do
         it "is delegated to #from_json" do
-          block = lambda {|bind|}
-          @Band.any_instance.expects(:from_json).with("{}", "yo") # FIXME: how to expect block?
-          @Band.from_json("{}", "yo", &block)
+          block = lambda {|*args|}
+          @Band.any_instance.expects(:from_json).with("{document}", "options") # FIXME: how to NOT expect block?
+          @Band.from_json("{document}", "options", &block)
+        end
+        
+        it "yields new object and options to block" do
+          @Band.class_eval { attr_accessor :new_name }
+          @band = @Band.from_json({}, :new_name => "Diesel Boy") do |band, options|
+            band.new_name= options[:new_name]
+          end
+          assert_equal "Diesel Boy", @band.new_name
         end
       end
       
       
       describe ".from_hash" do
-        it "is delegated to #from_hash" do
-          block = lambda {|bind|}
-          @Band.any_instance.expects(:from_hash).with("{}", "yo") # FIXME: how to expect block?
-          @Band.from_hash("{}", "yo", &block)
+        it "is delegated to #from_hash not passing the block" do
+          block = lambda {|*args|}
+          @Band.any_instance.expects(:from_hash).with("{document}", "options") # FIXME: how to NOT expect block?
+          @Band.from_hash("{document}", "options", &block)
+        end
+        
+        it "yields new object and options to block" do
+          @Band.class_eval { attr_accessor :new_name }
+          @band = @Band.from_hash({}, :new_name => "Diesel Boy") do |band, options|
+            band.new_name= options[:new_name]
+          end
+          
+          assert_equal "Diesel Boy", @band.new_name
         end
       end
       
@@ -50,14 +67,6 @@ module JsonTest
           @band.from_json(@json)
           assert_equal ["Nofx", "NOFX"], [@band.name, @band.label]
         end
-        
-        it "forwards block to #from_hash" do
-          @band.from_json(@json) do |name|
-            name == :name
-          end
-          
-          assert_equal ["Nofx", nil], [@band.name, @band.label]
-        end
       end
       
       
@@ -72,14 +81,6 @@ module JsonTest
           assert_equal ["Nofx", "NOFX"], [@band.name, @band.label]
         end
         
-        it "forwards block to #update_properties_from" do
-          @band.from_hash(@hash) do |name|
-            name == :name
-          end
-          
-          assert_equal ["Nofx", nil], [@band.name, @band.label]
-        end
-        
         it "respects :wrap option" do
           @band.from_hash({"band" => {"name" => "This Is A Standoff"}}, :wrap => :band)
           assert_equal "This Is A Standoff", @band.name
@@ -99,17 +100,6 @@ module JsonTest
         it "delegates to #to_hash and returns string" do
           assert_equal "{\"name\":\"Rise Against\"}", @Band.new("Rise Against").to_json
         end
-        
-        it "forwards block to #to_hash" do
-          band = @Band.new
-          band.name  = "The Guinea Pigs"
-          band.label = "n/a"
-          json = band.to_json do |name|
-            name == :name
-          end
-          
-          assert_equal "{\"name\":\"The Guinea Pigs\"}", json
-        end
       end
       
       
@@ -138,7 +128,7 @@ module JsonTest
         
       describe "#binding_for_definition" do
         it "returns ObjectBinding" do
-          assert_kind_of Json::ObjectBinding, @band.binding_for_definition(Def.new(:band, :as => Hash))
+          assert_kind_of Json::ObjectBinding, @band.binding_for_definition(Def.new(:band, :class => Hash))
         end
         
         it "returns TextBinding" do
@@ -153,13 +143,59 @@ module JsonTest
         end
       end
     end
+    
+    
+    describe "DCI" do
+      module SongRepresenter
+        include Representable::JSON
+        property :name
+      end
+      
+      module AlbumRepresenter
+        include Representable::JSON
+        property :best_song, :class => Song, :extend => SongRepresenter
+        collection :songs, :class => Song, :extend => SongRepresenter
+      end
+      
+      
+      it "allows adding the representer by using #extend" do
+        module BandRepresenter
+          include Representable::JSON
+          property :name
+        end
+        
+        civ = Object.new
+        civ.instance_eval do
+          def name; "CIV"; end
+        end
+        
+        civ.extend(BandRepresenter)
+        assert_equal "{\"name\":\"CIV\"}", civ.to_json
+      end
+      
+      it "extends contained models when serializing" do
+        @album = Album.new(Song.new("I Hate My Brain"), Song.new("Mr. Charisma"))
+        @album.extend(AlbumRepresenter)
+        
+        assert_equal "{\"best_song\":{\"name\":\"Mr. Charisma\"},\"songs\":[{\"name\":\"I Hate My Brain\"},{\"name\":\"Mr. Charisma\"}]}", @album.to_json
+      end
+      
+      it "extends contained models when deserializing" do
+        #@album = Album.new(Song.new("I Hate My Brain"), Song.new("Mr. Charisma"))
+        @album = Album.new
+        @album.extend(AlbumRepresenter)
+        
+        @album.from_json("{\"best_song\":{\"name\":\"Mr. Charisma\"},\"songs\":[{\"name\":\"I Hate My Brain\"},{\"name\":\"Mr. Charisma\"}]}")
+        assert_equal "Mr. Charisma", @album.best_song.name
+      end
+    end
   end
 
   class PropertyTest < MiniTest::Spec
-    describe "representable_property :name" do
+    describe "property :name" do
       class Band
         include Representable::JSON
-        representable_property :name
+        property :name
       end
       
       it "#from_json creates correct accessors" do
@@ -175,15 +211,15 @@ module JsonTest
       end
     end
     
-    describe ":as => Item" do
+    describe ":class => Item" do
       class Label
         include Representable::JSON
-        representable_property :name
+        property :name
       end
       
       class Album
         include Representable::JSON
-        representable_property :label, :as => Label
+        property :label, :class => Label
       end
       
       it "#from_json creates one Item instance" do
@@ -198,11 +234,11 @@ module JsonTest
         assert_equal '{"label":{"name":"Fat Wreck"}}', album.to_json
       end
       
-      describe ":different_name, :as => Label" do
+      describe ":different_name, :class => Label" do
         before do
           @Album = Class.new do
             include Representable::JSON
-            representable_property :seller, :as => Label
+            property :seller, :class => Label
           end
         end
         
@@ -218,7 +254,7 @@ module JsonTest
     describe ":from => :songName" do
       class Song
         include Representable::JSON
-        representable_property :name, :from => :songName
+        property :name, :from => :songName
       end
       
       it "respects :from in #from_json" do
@@ -236,7 +272,7 @@ module JsonTest
       before do
         @Album = Class.new do
         include Representable::JSON
-        representable_property :name, :default => "30 Years Live"
+        property :name, :default => "30 Years Live"
       end
     end
       
@@ -279,10 +315,10 @@ end
 
 
   class CollectionTest < MiniTest::Spec
-    describe "representable_collection :name" do
+    describe "collection :name" do
       class CD
         include Representable::JSON
-        representable_collection :songs
+        collection :songs
       end
       
       it "#from_json creates correct accessors" do
@@ -298,10 +334,10 @@ end
       end
     end
     
-    describe "representable_collection :name, :as => Band" do
+    describe "collection :name, :class => Band" do
       class Band
         include Representable::JSON
-        representable_property :name
+        property :name
         
         def initialize(name="")
           self.name = name
@@ -310,7 +346,7 @@ end
       
       class Compilation
         include Representable::JSON
-        representable_collection :bands, :as => Band
+        collection :bands, :class => Band
       end
       
       describe "#from_json" do
@@ -339,7 +375,7 @@ end
     describe ":from => :songList" do
       class Songs
         include Representable::JSON
-        representable_collection :tracks, :from => :songList
+        collection :tracks, :from => :songList
       end
       
       it "respects :from in #from_json" do