representable 0.11.0 → 0.12.0

data/test/representable_test.rb

@@ -3,24 +3,24 @@ require 'test_helper'
 class RepresentableTest < MiniTest::Spec
   class Band
     include Representable
-    representable_property :name
+    property :name
   end
   
   class PunkBand < Band
-    representable_property :street_cred
+    property :street_cred
   end
   
   module BandRepresentation
     include Representable
     
-    representable_property :name
+    property :name
   end
   
   module PunkBandRepresentation
     include Representable
     include BandRepresentation
     
-    representable_property :street_cred
+    property :street_cred
   end
   
   
@@ -68,7 +68,7 @@ class RepresentableTest < MiniTest::Spec
       #  require 'representable/json'
       #  module RockBandRepresentation
       #    include Representable::JSON
-      #    representable_property :name
+      #    property :name
       #  end
       #  vd = class VH
       #    include RockBandRepresentation
@@ -77,27 +77,10 @@ class RepresentableTest < MiniTest::Spec
       #  assert_equal "{\"name\":\"Van Halen\"}", vd.to_json
       #end
     end
-    
-    it "allows adding the representer by using #extend" do
-      module BandRepresenter
-        include Representable::JSON
-        representable_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
-    
-    # TODO: add test for nested setup.
   end
   
   
-  describe "#representable_property" do
+  describe "#property" do
     it "creates accessors for the attribute" do
       @band = PunkBand.new
       assert @band.name = "Bad Religion"
@@ -107,19 +90,19 @@ class RepresentableTest < MiniTest::Spec
     describe ":from" do
       # TODO: do this with all options.
       it "can be set explicitly" do
-        band = Class.new(Band) { representable_property :friends, :from => :friend }
+        band = Class.new(Band) { property :friends, :from => :friend }
         assert_equal "friend", band.representable_attrs.last.from
       end
       
       it "is infered from the name implicitly" do
-        band = Class.new(Band) { representable_property :friends }
+        band = Class.new(Band) { property :friends }
         assert_equal "friends", band.representable_attrs.last.from
       end
     end
     
     describe ":accessor" do
       it "doesn't add methods when false" do
-        klass = Class.new(Band) { representable_property :friends, :accessors => false }
+        klass = Class.new(Band) { property :friends, :accessors => false }
         band = klass.new
         assert ! band.respond_to?(:friends)
         assert ! band.respond_to?("friends=")
@@ -127,9 +110,9 @@ class RepresentableTest < MiniTest::Spec
     end
   end
   
-  describe "#representable_collection" do
+  describe "#collection" do
     class RockBand < Band
-      representable_collection :albums
+      collection :albums
     end
     
     it "creates correct Definition" do
@@ -178,30 +161,35 @@ class RepresentableTest < MiniTest::Spec
   require 'representable/json'  # DISCUSS: i don't like the JSON requirement here, what about some generic test module?
   class PopBand
     include Representable::JSON
-    representable_property :name
-    representable_property :groupies
+    property :name
+    property :groupies
   end
 
   describe "#update_properties_from" do
+    before do
+      @band = PopBand.new
+    end
+    
     it "copies values from document to object" do
-      band = PopBand.new
-      band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2})
-      assert_equal "No One's Choice", band.name
-      assert_equal 2, band.groupies
+      @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, {})
+      assert_equal "No One's Choice", @band.name
+      assert_equal 2, @band.groupies
     end
     
-    it "skips elements when block returns false" do
-      band = PopBand.new
-      band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}) do |name|
-        name == :name
-      end
-      assert_equal "No One's Choice", band.name
-      assert_equal nil, band.groupies
+    it "accepts :except option" do
+      @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, :except => [:groupies])
+      assert_equal "No One's Choice", @band.name
+      assert_equal nil, @band.groupies
+    end
+    
+    it "accepts :include option" do
+      @band.update_properties_from({"name"=>"No One's Choice", "groupies"=>2}, :include => [:groupies])
+      assert_equal 2, @band.groupies
+      assert_equal nil, @band.name
     end
     
     it "always returns self" do
-      band = PopBand.new
-      assert_equal band, band.update_properties_from({"name"=>"Nofx"})
+      assert_equal @band, @band.update_properties_from({"name"=>"Nofx"}, {})
     end
   end
   
@@ -213,14 +201,21 @@ 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, {}))
+      assert_equal({"name"=>"No One's Choice", "groupies"=>2}, @band.send(:create_representation_with, {}, {}))
+    end
+    
+    it "accepts :except option" do
+      hash = @band.send(:create_representation_with, {}, :except => [:groupies])
+      assert_equal({"name"=>"No One's Choice"}, hash)
     end
     
-    it "skips elements when block returns false" do
-      assert_equal({"name"=>"No One's Choice"}, @band.send(:create_representation_with, {}) do |name| name == :name end)
+    it "accepts :include option" do
+      hash = @band.send(:create_representation_with, {}, :include => [:groupies])
+      assert_equal({"groupies"=>2}, hash)
     end
   end
   
+  
   describe "Config" do
     before do
       @config = Representable::Config.new
@@ -244,4 +239,18 @@ class RepresentableTest < MiniTest::Spec
     end
   end
   
+  describe "Represents" do
+    before do
+      @class = Class.new do
+        extend Representable::Represents
+        represents :json, :with => :whatever
+        represents "application/order-json", :with => :special
+      end
+    end
+    
+    it "allows mapping formats to representers" do
+      assert_equal :whatever, @class.representer[:json]
+      assert_equal :special, @class.representer["application/order-json"]
+    end
+  end
 end

data/test/test_helper.rb

@@ -8,3 +8,16 @@ require 'minitest/spec'
 require 'minitest/autorun'
 require 'test_xml/mini_test'
 require 'mocha'
+
+class Album
+  def initialize(*songs)
+    @songs      = songs
+    @best_song  = songs.last
+  end
+end
+
+class Song
+  def initialize(name=nil)
+    @name = name
+  end
+end

data/test/xml_test.rb

@@ -3,21 +3,14 @@ require 'representable/xml'
 
 class Band
   include Representable::XML
-  representable_property :name
+  property :name
   
   def initialize(name=nil)
     name and self.name = name
   end
 end
 
-class Album
-  include Representable::XML
-  representable_property :band, :as => Band
-  
-  def initialize(band=nil)
-    band and self.band = band
-  end
-end
+
   
   
 class XmlTest < MiniTest::Spec
@@ -29,8 +22,8 @@ class XmlTest < MiniTest::Spec
       @Band = Class.new do
         include Representable::XML
         self.representation_wrap = :band
-        representable_property :name
-        representable_property :label
+        property :name
+        property :label
       end
       
       @band = @Band.new
@@ -39,18 +32,34 @@ class XmlTest < MiniTest::Spec
     
     describe ".from_xml" do
       it "is delegated to #from_xml" do
-        block = lambda {|bind|}
-        @Band.any_instance.expects(:from_xml).with("{}", "yo") # FIXME: how to expect block?
-        @Band.from_xml("{}", "yo", &block)
+        block = lambda {|*args|}
+        @Band.any_instance.expects(:from_xml).with("<document>", "options") # FIXME: how to NOT expect block?
+        @Band.from_xml("<document>", "options", &block)
+      end
+      
+      it "yields new object and options to block" do
+        @Band.class_eval { attr_accessor :new_name }
+        @band = @Band.from_xml("<band/>", :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_node" do
       it "is delegated to #from_node" do
-        block = lambda {|bind|}
-        @Band.any_instance.expects(:from_node).with("{}", "yo") # FIXME: how to expect block?
-        @Band.from_node("{}", "yo", &block)
+        block = lambda {|*args|}
+        @Band.any_instance.expects(:from_node).with("<document>", "options") # FIXME: how to expect block?
+        @Band.from_node("<document>", "options", &block)
+      end
+      
+      it "yields new object and options to block" do
+        @Band.class_eval { attr_accessor :new_name }
+        @band = @Band.from_node(Nokogiri::XML("<band/>"), :new_name => "Diesel Boy") do |band, options|
+          band.new_name= options[:new_name]
+        end
+        assert_equal "Diesel Boy", @band.new_name
       end
     end
     
@@ -65,14 +74,6 @@ class XmlTest < MiniTest::Spec
         @band.from_xml(@xml)
         assert_equal ["Nofx", "NOFX"], [@band.name, @band.label]
       end
-      
-      it "forwards block to #from_node" do
-        @band.from_xml(@xml) do |name|
-          name == :name
-        end
-        
-        assert_equal ["Nofx", nil], [@band.name, @band.label]
-      end
     end
     
     
@@ -86,14 +87,6 @@ class XmlTest < MiniTest::Spec
         @band.from_node(@xml)
         assert_equal ["Nofx", "NOFX"], [@band.name, @band.label]
       end
-      
-      it "forwards block to #update_properties_from" do
-        @band.from_node(@xml) do |name|
-          name == :name
-        end
-        
-        assert_equal ["Nofx", nil], [@band.name, @band.label]
-      end
     end
     
     
@@ -101,17 +94,6 @@ class XmlTest < MiniTest::Spec
       it "delegates to #to_node and returns string" do
         assert_xml_equal "<band><name>Rise Against</name></band>", Band.new("Rise Against").to_xml
       end
-      
-      it "forwards block to #to_node" do
-        band = @Band.new
-        band.name  = "The Guinea Pigs"
-        band.label = "n/a"
-        xml = band.to_xml do |name|
-          name == :name
-        end
-        
-        assert_xml_equal "<band><name>The Guinea Pigs</name></band>", xml
-      end
     end
     
     
@@ -129,7 +111,7 @@ class XmlTest < MiniTest::Spec
       it "respects #representation_wrap=" do
         klass = Class.new(Band) do
           include Representable
-          representable_property :name
+          property :name
         end
         
         klass.representation_wrap = :group
@@ -144,13 +126,64 @@ class XmlTest < MiniTest::Spec
       end
       
       it "returns ObjectBinding" do
-        assert_kind_of XML::ObjectBinding, @band.binding_for_definition(Def.new(:band, :as => Hash))
+        assert_kind_of XML::ObjectBinding, @band.binding_for_definition(Def.new(:band, :class => Hash))
       end
       
       it "returns TextBinding" do
         assert_kind_of XML::TextBinding, @band.binding_for_definition(Def.new(:band, :from => :content))
       end
     end
+    
+    
+    describe "DCI" do
+      module SongRepresenter
+        include Representable::XML
+        property :name
+        representation_wrap = :song
+      end
+      
+      module AlbumRepresenter
+        include Representable::XML
+        property :best_song, :class => Song, :extend => SongRepresenter
+        collection :songs, :class => Song, :from => :song, :extend => SongRepresenter
+        representation_wrap = :album
+      end
+      
+      
+      it "allows adding the representer by using #extend" do
+        module BandRepresenter
+          include Representable::XML
+          property :name
+        end
+        
+        civ = Object.new
+        civ.instance_eval do
+          def name; "CIV"; end
+        end
+        
+        civ.extend(BandRepresenter)
+        assert_xml_equal "<object><name>CIV</name></object>", civ.to_xml
+      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_xml_equal "<album>
+  <song><name>Mr. Charisma</name></song>
+  <song><name>I Hate My Brain</name></song>
+  <song><name>Mr. Charisma</name></song>
+</album>", @album.to_xml
+      end
+      
+      it "extends contained models when deserializing" do
+        @album = Album.new
+        @album.extend(AlbumRepresenter)
+        
+        @album.from_xml("<album><best_song><name>Mr. Charisma</name></best_song><song><name>I Hate My Brain</name></song><song><name>Mr. Charisma</name></song></album>")
+        assert_equal "Mr. Charisma", @album.best_song.name
+      end
+    end
   end
 end
 
@@ -159,8 +192,8 @@ class AttributesTest < MiniTest::Spec
   describe ":from => @rel" do
     class Link
       include Representable::XML
-      representable_property :href,   :from => "@href"
-      representable_property :title,  :from => "@title"
+      property :href,   :from => "@href"
+      property :title,  :from => "@title"
     end
     
     it "#from_xml creates correct accessors" do
@@ -181,9 +214,24 @@ class AttributesTest < MiniTest::Spec
 end
 
 class TypedPropertyTest < MiniTest::Spec
-  describe ":as => Item" do
+  module AlbumRepresenter
+    include Representable::XML
+    property :band, :class => Band
+  end
+  
+  
+  class Album
+    def initialize(band=nil)
+      @band = band
+    end
+  end
+  
+  # TODO:property :group, :class => Band
+  # :class
+  # where to mixin DCI?
+  describe ":class => Item" do
     it "#from_xml creates one Item instance" do
-      album = Album.from_xml(%{
+      album = Album.new.extend(AlbumRepresenter).from_xml(%{
         <album>
           <band><name>Bad Religion</name></band>
         </album>
@@ -194,7 +242,7 @@ class TypedPropertyTest < MiniTest::Spec
     describe "#to_xml" do
       it "doesn't escape xml from Band#to_xml" do
         band = Band.new("Bad Religion")
-        album = Album.new(band)
+        album = Album.new(band).extend(AlbumRepresenter)
         
         assert_xml_equal %{<album>
          <band>
@@ -211,7 +259,7 @@ class TypedPropertyTest < MiniTest::Spec
           end
         end
         
-        assert_xml_equal %{<album><band>Baaaad Religion</band></album>}, Album.new(band).to_xml
+        assert_xml_equal %{<album><band>Baaaad Religion</band></album>}, Album.new(band).extend(AlbumRepresenter).to_xml
       end
     end
   end
@@ -219,10 +267,10 @@ end
 
 
 class CollectionTest < MiniTest::Spec
-  describe ":as => Band, :from => :band, :collection => true" do
+  describe ":class => Band, :from => :band, :collection => true" do
     class Compilation
       include Representable::XML
-      representable_collection :bands, :as => Band, :from => :band
+      collection :bands, :class => Band, :from => :band
     end
     
     describe "#from_xml" do
@@ -260,7 +308,7 @@ class CollectionTest < MiniTest::Spec
   describe ":from" do
     class Album
       include Representable::XML
-      representable_collection :songs, :from => :song
+      collection :songs, :from => :song
     end
 
     it "collects untyped items" do