representable 0.10.3 → 0.11.0

data/CHANGES.textile

@@ -1,3 +1,7 @@
+h2. 0.11.0
+
+* Representer modules can now be injected into objects using @#extend@.
+
 h2. 0.10.3
 
 * Added @representable_property :default => ...@ option which is considered for both serialization and deserialization. The default is applied when the value is @nil@. Note that an empty string ain't @nil@.

data/lib/representable.rb

@@ -9,6 +9,14 @@ module Representable
       def self.included(base)
         base.representable_attrs.push(*representable_attrs) # "inherit".
       end
+      
+      # Copies the representable_attrs to the extended object.
+      def self.extended(object)
+        attrs = representable_attrs
+        object.instance_eval do
+          @representable_attrs = attrs
+        end
+      end
     end
   end
   
@@ -50,6 +58,11 @@ private
     representable_attrs.map {|attr| binding_for_definition(attr) }
   end
   
+  # Returns the wrapper for the representation. Mostly used in XML.
+  def representation_wrap
+    representable_attrs.wrap_for(self.class.name)
+  end
+  
   
   module ClassMethods # :nodoc:
     module Declarations
@@ -57,11 +70,6 @@ private
         Definition
       end
       
-      # Returns bindings for all properties.
-      def representable_bindings
-        representable_attrs.map {|attr| binding_for_definition(attr) }
-      end
-      
       # Declares a represented document node, which is usually a XML tag or a JSON key.
       #
       # Examples:
@@ -100,35 +108,31 @@ private
 
     module Accessors
       def representable_attrs
-        @representable_attrs ||= []
-      end
-      
-      def representable_wrap
-        @representable_wrap ||= false
-      end
-      
-      def representable_wrap=(name)
-        @representable_wrap = name
+        @representable_attrs ||= Config.new
       end
       
       def representation_wrap=(name)
-        self.representable_wrap = name
-      end
-      
-      # Returns the wrapper for the representation. Mostly used in XML.
-      def representation_wrap
-        return unless representable_wrap
-        return infer_representation_name if representable_wrap === true
-        representable_wrap
-      end
-      
-    private
-      def infer_representation_name
-        name.split('::').last.
-         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-         gsub(/([a-z\d])([A-Z])/,'\1_\2').
-         downcase
+        representable_attrs.wrap = name
       end
     end
   end
+  
+  class Config < Array
+    attr_accessor :wrap
+    
+    # Computes the wrap string or returns false.
+    def wrap_for(name)
+      return unless wrap
+      return infer_name_for(name) if wrap === true
+      wrap
+    end
+    
+  private
+    def infer_name_for(name)
+      name.to_s.split('::').last.
+       gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+       gsub(/([a-z\d])([A-Z])/,'\1_\2').
+       downcase
+    end
+  end
 end

data/lib/representable/json.rb

@@ -38,7 +38,7 @@ module Representable
     end
     
     def from_hash(data, options={}, &block)
-      if wrap = options[:wrap] || self.class.representation_wrap
+      if wrap = options[:wrap] || representation_wrap
         data = data[wrap.to_s]
       end
       
@@ -48,7 +48,7 @@ module Representable
     def to_hash(options={}, &block)
       hash = create_representation_with({}, &block)
       
-      return hash unless wrap = options[:wrap] || self.class.representation_wrap
+      return hash unless wrap = options[:wrap] || representation_wrap
       
       {wrap => hash}
     end

data/lib/representable/version.rb

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

data/lib/representable/xml.rb

@@ -47,7 +47,7 @@ module Representable
     
     # Returns a Nokogiri::XML object representing this object.
     def to_node(options={}, &block)
-      root_tag = options[:wrap] || self.class.representation_wrap
+      root_tag = options[:wrap] || representation_wrap
       
       create_representation_with(Nokogiri::XML::Node.new(root_tag.to_s, Nokogiri::XML::Document.new), &block)
     end

data/test/representable_test.rb

@@ -77,6 +77,23 @@ 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
   
   
@@ -123,10 +140,6 @@ class RepresentableTest < MiniTest::Spec
   
   
   describe "#representation_wrap" do
-    class SoundSystem
-      include Representable
-    end
-    
     class HardcoreBand
       include Representable
     end
@@ -134,23 +147,23 @@ class RepresentableTest < MiniTest::Spec
     class SoftcoreBand < HardcoreBand
     end
     
+    before do
+      @band = HardcoreBand.new
+    end
+    
+    
     it "returns false per default" do
-      assert_equal nil, SoundSystem.representation_wrap
+      assert_equal nil, SoftcoreBand.new.send(:representation_wrap)
     end
     
     it "infers a printable class name if set to true" do
       HardcoreBand.representation_wrap = true
-      assert_equal "hardcore_band", HardcoreBand.send(:representation_wrap)
+      assert_equal "hardcore_band", @band.send(:representation_wrap)
     end
     
     it "can be set explicitely" do
       HardcoreBand.representation_wrap = "breach"
-      assert_equal "breach", HardcoreBand.representation_wrap
-    end
-    
-    it "doesn't inherit correctly" do
-      HardcoreBand.representation_wrap = "breach"
-      assert_equal nil, SoftcoreBand.representation_wrap
+      assert_equal "breach", @band.send(:representation_wrap)
     end
   end
   
@@ -208,4 +221,27 @@ class RepresentableTest < MiniTest::Spec
     end
   end
   
+  describe "Config" do
+    before do
+      @config = Representable::Config.new
+      PunkRock = Class.new
+    end
+    
+    describe "wrapping" do
+      it "returns false per default" do
+        assert_equal nil, @config.wrap_for("Punk")
+      end
+      
+      it "infers a printable class name if set to true" do
+        @config.wrap = true
+        assert_equal "punk_rock", @config.wrap_for(PunkRock)
+      end
+      
+      it "can be set explicitely" do
+        @config.wrap = "Descendents"
+        assert_equal "Descendents", @config.wrap_for(PunkRock)
+      end
+    end
+  end
+  
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 10
-  - 3
-  version: 0.10.3
+  - 11
+  - 0
+  version: 0.11.0
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-07 00:00:00 +01:00
+date: 2011-12-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency