representable 0.10.2 → 0.10.3

data/CHANGES.textile

@@ -1,6 +1,11 @@
+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@.
+* @representable_attrs@ are now pushed to instance level as soon as possible.
+
 h2. 0.10.2
 
-* Added `representable_property :accessors => false` option to suppress adding accessors.
+* Added @representable_property :accessors => false@ option to suppress adding accessors.
 * @Representable.representation_wrap@ is no longer inherited.
 * Representers can now be defined in modules. They inherit to including modules.
 

data/README.rdoc

@@ -37,7 +37,7 @@ Since you keep forgetting the heroes of your childhood you decide to implement a
 
 This declares two simple properties. Representable will automatically add accessors to the class.
 
-If you don't want declarations in your models, use a module.
+Alternatively, if you don't want declarations in your models, use a module.
 
   module HeroRepresentation
     include Representable

data/lib/representable.rb

@@ -14,10 +14,10 @@ module Representable
   
   # Reads values from +doc+ and sets properties accordingly.
   def update_properties_from(doc, &block)
-    self.class.representable_bindings.each do |bin|
+    representable_bindings.each do |bin|
       next if eval_property_block(bin, &block)  # skip if block is false.
       
-      value = bin.read(doc)
+      value = bin.read(doc) || bin.definition.default
       send(bin.definition.setter, value)
     end
     self
@@ -26,10 +26,10 @@ module Representable
 private
   # Compiles the document going through all properties.
   def create_representation_with(doc, &block)
-    self.class.representable_bindings.each do |bin|
+    representable_bindings.each do |bin|
       next if eval_property_block(bin, &block)  # skip if block is false.
       
-      value = send(bin.definition.getter) # DISCUSS: eventually move back to Ref.
+      value = send(bin.definition.getter) || bin.definition.default # DISCUSS: eventually move back to Ref.
       bin.write(doc, value) if value
     end
     doc
@@ -42,6 +42,14 @@ private
     block_given? and not yield binding.definition.name.to_sym
   end
   
+  def representable_attrs
+    @representable_attrs ||= self.class.representable_attrs # DISCUSS: copy, or better not?
+  end
+  
+  def representable_bindings
+    representable_attrs.map {|attr| binding_for_definition(attr) }
+  end
+  
   
   module ClassMethods # :nodoc:
     module Declarations
@@ -62,6 +70,7 @@ private
       #   representable_property :name, :from => :title
       #   representable_property :name, :as => Name
       #   representable_property :name, :accessors => false
+      #   representable_property :name, :default => "Mike"
       def representable_property(name, options={})
         attr = add_representable_property(name, options)
         

data/lib/representable/bindings/json_bindings.rb

@@ -8,14 +8,10 @@ module Representable
       end
       
       def read(hash)
-        value_from_hash(hash) or default
+        value_from_hash(hash)
       end
       
     private
-      def default
-        ""
-      end
-      
       def collect_for(hash)
         nodes = hash[definition.from] or return
         nodes = [nodes] unless nodes.is_a?(Array)
@@ -51,16 +47,11 @@ module Representable
       end
 
     private
-      def default
-        []
-      end
-      
       def value_from_hash(hash)
         collect_for(hash) do |node|
           definition.sought_type.from_hash(node)  # call #from_hash as it's already deserialized.
         end
       end
-      
     end
   end
 end

data/lib/representable/bindings/xml_bindings.rb

@@ -8,14 +8,10 @@ module Representable
       end
       
       def read(xml)
-        value_from_node(xml) or default
+        value_from_node(xml)
       end
       
     private
-      def default
-        ""
-      end
-      
       def xpath
         definition.from
       end
@@ -80,10 +76,6 @@ module Representable
       end
 
     private
-      def default
-        []
-      end
-      
       # Deserializes the ref's element from +xml+.
       def value_from_node(xml)
         collect_for(xml) do |node|

data/lib/representable/definition.rb

@@ -1,7 +1,7 @@
 module Representable
   # Created at class compile time. Keeps configuration options for one property.
   class Definition
-    attr_reader :name, :sought_type, :from
+    attr_reader :name, :sought_type, :from, :default
     alias_method :getter, :name
     
     def initialize(sym, options={})
@@ -9,6 +9,8 @@ module Representable
       @array        = options[:collection]
       @from         = (options[:from] || name).to_s
       @sought_type  = options[:as] || :text
+      @default      = options[:default]
+      @default      ||= [] if array?
       
       # FIXME: move me to xml.
       if options[:from].to_s =~ /^@/

data/lib/representable/json.rb

@@ -14,17 +14,13 @@ module Representable
     
     def self.included(base)
       base.class_eval do
-        include Representable
+        include Representable # either in Hero or HeroRepresentation.
         extend ClassMethods
       end
     end
     
     
     module ClassMethods
-      def binding_for_definition(definition)
-        (BINDING_FOR_TYPE[definition.sought_type] or ObjectBinding).new(definition)
-      end
-    
       # Creates a new object from the passed JSON document.
       def from_json(*args, &block)
         new.from_json(*args, &block)
@@ -61,5 +57,9 @@ module Representable
     def to_json(*args, &block)
       to_hash(*args, &block).to_json
     end
+    
+    def binding_for_definition(definition)
+      (BINDING_FOR_TYPE[definition.sought_type] or ObjectBinding).new(definition)
+    end
   end
 end

data/lib/representable/version.rb

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

data/lib/representable/xml.rb

@@ -19,10 +19,6 @@ module Representable
     
     
     module ClassMethods
-      def binding_for_definition(definition)
-        (BINDING_FOR_TYPE[definition.sought_type] or ObjectBinding).new(definition)
-      end
-      
       # Creates a new Ruby object from XML using mapping information declared in the class.
       #
       # Accepts a block yielding the currently iterated Definition. If the block returns false 
@@ -59,5 +55,9 @@ module Representable
     def to_xml(*args, &block)
       to_node(*args, &block).to_s
     end
+    
+    def binding_for_definition(definition)
+      (BINDING_FOR_TYPE[definition.sought_type] or ObjectBinding).new(definition)
+    end
   end
 end

data/test/bindings_test.rb

@@ -1,17 +1,6 @@
 require 'test_helper'
 
 class BindingsTest < MiniTest::Spec
-  describe "ObjectRef with []" do
-    before do
-      @ref = Representable::XML::ObjectBinding.new(Representable::Definition.new(:songs, :as => [Hash]))
-    end
-      
-    it "responds to #default" do
-      assert_equal [], @ref.send(:default)
-    end
-  end
-  
-  
   describe "TextRef#read" do
     def parse_xml(xml); Nokogiri::XML(xml).root; end
     

data/test/definition_test.rb

@@ -62,6 +62,10 @@ class DefinitionTest < MiniTest::Spec
     it "responds to #sought_type" do
       assert_equal :text, @def.sought_type
     end
+    
+    it "responds to #default" do
+      assert_equal [], @def.default
+    end
   end
   
   describe ":as => Item" do
@@ -73,4 +77,16 @@ class DefinitionTest < MiniTest::Spec
       assert_equal Hash, @def.sought_type
     end
   end
+  
+  describe ":default => value" do
+    it "responds to #default" do
+      @def = Representable::Definition.new(:song)
+      assert_equal nil, @def.default
+    end
+    
+    it "accepts a default value" do
+      @def = Representable::Definition.new(:song, :default => "Atheist Peace")
+      assert_equal "Atheist Peace", @def.default
+    end
+  end
 end

data/test/json_test.rb

@@ -17,6 +17,8 @@ module JsonTest
             self.name = name if name
           end
         end
+        
+        @band = @Band.new
       end
     
     
@@ -136,18 +138,18 @@ 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, :as => Hash))
         end
         
         it "returns TextBinding" do
-          assert_kind_of Json::TextBinding, @Band.binding_for_definition(Def.new(:band))
+          assert_kind_of Json::TextBinding, @band.binding_for_definition(Def.new(:band))
         end
       end
       
       describe "#representable_bindings" do
         it "returns bindings for each property" do
-          assert_equal 2, @Band.representable_bindings.size
-          assert_equal "name", @Band.representable_bindings.first.definition.name
+          assert_equal 2, @band.send(:representable_bindings).size
+          assert_equal "name", @band.send(:representable_bindings).first.definition.name
         end
       end
     end
@@ -229,7 +231,51 @@ module JsonTest
         assert_equal '{"songName":"Run To The Hills"}', song.to_json
       end
     end
+    
+    describe ":default => :value" do
+      before do
+        @Album = Class.new do
+        include Representable::JSON
+        representable_property :name, :default => "30 Years Live"
+      end
+    end
+      
+    describe "#from_json" do
+      it "uses default when property nil in doc" do
+        album = @Album.from_json({}.to_json)
+        assert_equal "30 Years Live", album.name
+      end
+      
+      it "uses value from doc when present" do
+        album = @Album.from_json({:name => "Live At The Wireless"}.to_json)
+        assert_equal "Live At The Wireless", album.name
+      end
+      
+      it "uses value from doc when empty string" do
+        album = @Album.from_json({:name => ""}.to_json)
+        assert_equal "", album.name
+      end
+    end
+    
+    describe "#to_json" do
+      it "uses default when not available in object" do
+        assert_equal "{\"name\":\"30 Years Live\"}", @Album.new.to_json
+      end
+      
+      it "uses value from represented object when present" do
+        album = @Album.new
+        album.name = "Live At The Wireless"
+        assert_equal "{\"name\":\"Live At The Wireless\"}", album.to_json
+      end
+      
+      it "uses value from represented object when emtpy string" do
+        album = @Album.new
+        album.name = ""
+        assert_equal "{\"name\":\"\"}", album.to_json
+      end
+    end
   end
+end
 
 
   class CollectionTest < MiniTest::Spec
@@ -275,7 +321,7 @@ module JsonTest
           assert_equal ["Cobra Skulls", "Diesel Boy"], cd.bands.map(&:name).sort
         end
         
-        it "collections can be empty" do
+        it "creates emtpy array per default" do
           cd = Compilation.from_json({:compilation => {}}.to_json)
           assert_equal [], cd.bands
         end

data/test/representable_test.rb

@@ -64,6 +64,18 @@ class RepresentableTest < MiniTest::Spec
         assert_equal "{\"name\":\"Vention Dention\",\"street_cred\":1}", vd.to_json
       end
       
+      #it "allows including the concrete representer module only" do
+      #  require 'representable/json'
+      #  module RockBandRepresentation
+      #    include Representable::JSON
+      #    representable_property :name
+      #  end
+      #  vd = class VH
+      #    include RockBandRepresentation
+      #  end.new
+      #  vd.name        = "Van Halen"
+      #  assert_equal "{\"name\":\"Van Halen\"}", vd.to_json
+      #end
     end
   end
   

data/test/xml_test.rb

@@ -32,6 +32,8 @@ class XmlTest < MiniTest::Spec
         representable_property :name
         representable_property :label
       end
+      
+      @band = @Band.new
     end
     
     
@@ -138,15 +140,15 @@ class XmlTest < MiniTest::Spec
     
     describe "#binding_for_definition" do
       it "returns AttributeBinding" do
-        assert_kind_of XML::AttributeBinding, @Band.binding_for_definition(Def.new(:band, :from => "@band"))
+        assert_kind_of XML::AttributeBinding, @band.binding_for_definition(Def.new(:band, :from => "@band"))
       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, :as => Hash))
       end
       
       it "returns TextBinding" do
-        assert_kind_of XML::TextBinding, @Band.binding_for_definition(Def.new(:band, :from => :content))
+        assert_kind_of XML::TextBinding, @band.binding_for_definition(Def.new(:band, :from => :content))
       end
     end
   end

metadata

@@ -1,90 +1,111 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: representable
-version: !ruby/object:Gem::Version
-  version: 0.10.2
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 10
+  - 3
+  version: 0.10.3
 platform: ruby
-authors:
+authors: 
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-03 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-12-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: nokogiri
-  requirement: &75503660 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *75503660
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &75503430 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *75503430
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &75503180 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *75503180
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: test_xml
-  requirement: &75502870 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *75502870
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: minitest
-  requirement: &75502410 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.8'
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 8
+        version: "2.8"
   type: :development
-  prerelease: false
-  version_requirements: *75502410
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: mocha
-  requirement: &75501950 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *75501950
-description: Maps representation documents from and to Ruby objects. Includes XML
-  and JSON support, plain properties, collections and compositions.
-email:
+  version_requirements: *id006
+description: Maps representation documents from and to Ruby objects. Includes XML and JSON support, plain properties, collections and compositions.
+email: 
 - apotonick@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .gitmodules
 - .rspec
@@ -108,29 +129,37 @@ files:
 - test/representable_test.rb
 - test/test_helper.rb
 - test/xml_test.rb
+has_rdoc: true
 homepage: http://representable.apotomo.de
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Maps representation documents from and to Ruby objects. Includes XML and
-  JSON support, plain properties, collections and compositions.
+summary: Maps representation documents from and to Ruby objects. Includes XML and JSON support, plain properties, collections and compositions.
 test_files: []
+