representable 1.2.0 → 1.2.1

data/CHANGES.textile

@@ -1,3 +1,8 @@
+h2. 1.2.1
+
+* Deprecated @:represent_nil@ favor of @:render_nil@.
+* API change: if a property is missing in an incoming document and there is no default set it is completely ignored and *not* set in the represented object.
+
 h2. 1.2.0
 
 * Deprecated @:except@ in favor of @:exclude@.

data/README.rdoc

@@ -251,11 +251,11 @@ When rendering or parsing, the +friends+ property is considered only if the cond
 
 === False and Nil Values
 
-Since 1.2 +false+ values are considered when parsing and rendering. That particularly means properties that used to be unset (i.e. @nil@) after parsing might be @false@ now. Vice versa, +false+ values that weren't included in the rendered document will be visible now.
+Since 1.2 +false+ values are considered when parsing and rendering. That particularly means properties that used to be unset (i.e. +nil+) after parsing might be +false+ now. Vice versa, +false+ values that weren't included in the rendered document will be visible now.
 
-If you want +nil+ values to be included when rendering, use the +:represent_nil+ option.
+If you want +nil+ values to be included when rendering, use the +:render_nil+ option.
 
-  property :surename, :represent_nil => true
+  property :surename, :render_nil => true
 
 == DCI
 

data/lib/representable.rb

@@ -1,5 +1,5 @@
-require 'representable/definition'
 require 'representable/deprecations'
+require 'representable/definition'
 
 # Representable can be used in two ways.
 #
@@ -96,7 +96,11 @@ private
   # Parse value from doc and update the model property.
   def uncompile_fragment(bin, doc)
     value = read_fragment_for(bin, doc)
-    value = bin.definition.default_for(value)
+    
+    if value == Binding::FragmentNotFound
+      return unless bin.definition.has_default?
+      value = bin.definition.default
+    end
     
     send(bin.definition.setter, value)
   end

data/lib/representable/binding.rb

@@ -1,5 +1,9 @@
 module Representable
   class Binding
+    class FragmentNotFound
+    end
+    
+    
     attr_reader :definition # TODO: merge Binding and Definition.
   
     def initialize(definition)

data/lib/representable/bindings/json_bindings.rb

@@ -27,6 +27,8 @@ module Representable
       end
       
       def read(hash)
+        return FragmentNotFound unless hash.has_key?(definition.from) # DISCUSS: put it all in #read for performance. not really sure if i like returning that special thing.
+        
         fragment = hash[definition.from]
         deserialize_from(fragment)
       end
@@ -54,7 +56,6 @@ module Representable
       end
       
       def deserialize_from(fragment)
-        fragment ||= {}
         fragment.collect { |item_fragment| deserialize(item_fragment) }
       end
     end

data/lib/representable/bindings/xml_bindings.rb

@@ -40,7 +40,7 @@ module Representable
       
       def read(node)
         nodes = node.search("./#{xpath}")
-        return if nodes.size == 0 # TODO: write dedicated test!
+        return FragmentNotFound if nodes.size == 0 # TODO: write dedicated test!
         
         deserialize_from(nodes)
       end

data/lib/representable/definition.rb

@@ -7,6 +7,8 @@ module Representable
     def initialize(sym, options={})
       @name     = sym.to_s
       @options  = options
+      
+      options[:default] ||= [] if array?  # FIXME: move to CollectionBinding!
     end
     
     def clone
@@ -42,6 +44,10 @@ module Representable
       value
     end
     
+    def has_default?
+      options.has_key?(:default)
+    end
+    
     def representer_module
       options[:extend]
     end
@@ -51,12 +57,10 @@ module Representable
     end
     
     def skipable_nil_value?(value)
-      value.nil? and not options[:represent_nil]
+      value.nil? and not options[:render_nil]
     end
     
-  private
     def default
-      options[:default] ||= [] if array?  # FIXME: move to CollectionBinding!
       options[:default]
     end
   end

data/lib/representable/deprecations.rb

@@ -1,9 +1,11 @@
-module Representable::Deprecations
-  def skip_excluded_property?(binding, options) # TODO: remove with 1.3.
-    if options[:except]
-      options[:exclude] = options[:except]
-      warn "The :except option is deprecated and will be removed in 1.3. Please use :exclude."
-    end # i wanted a one-liner but failed :)
-    super
+module Representable
+  module Deprecations
+    def skip_excluded_property?(binding, options) # TODO: remove with 1.3.
+      if options[:except]
+        options[:exclude] = options[:except]
+        warn "The :except option is deprecated and will be removed in 1.3. Please use :exclude."
+      end # i wanted a one-liner but failed :)
+      super
+    end
   end
 end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/test/definition_test.rb

@@ -55,25 +55,41 @@ class DefinitionTest < MiniTest::Spec
     end
   end
   
+  describe "#has_default?" do
+    it "returns false if no :default set" do
+      assert_equal false, Representable::Definition.new(:song).has_default?
+    end
+    
+    it "returns true if :default set" do
+      assert_equal true, Representable::Definition.new(:song, :default => nil).has_default?
+    end
+    
+    it "returns true if :collection" do
+      assert_equal true, Representable::Definition.new(:songs, :collection => true).has_default?
+    end
+    
+  end
+  
+  
   describe "#skipable_nil_value?" do
     # default if skipable_nil_value?
     before do
-      @def = Representable::Definition.new(:song, :represent_nil => true)
+      @def = Representable::Definition.new(:song, :render_nil => true)
     end
     
     it "returns false when not nil" do
       assert_equal false, @def.skipable_nil_value?("Disconnect, Disconnect")
     end
     
-    it "returns false when nil and :represent_nil => true" do
+    it "returns false when nil and :render_nil => true" do
       assert_equal false, @def.skipable_nil_value?(nil)
     end
     
-    it "returns true when nil and :represent_nil => false" do
+    it "returns true when nil and :render_nil => false" do
       assert_equal true, Representable::Definition.new(:song).skipable_nil_value?(nil)
     end
     
-    it "returns false when not nil and :represent_nil => false" do
+    it "returns false when not nil and :render_nil => false" do
       assert_equal false, Representable::Definition.new(:song).skipable_nil_value?("Fatal Flu")
     end
   end
@@ -96,13 +112,13 @@ class DefinitionTest < MiniTest::Spec
       assert_equal "Insider", @def.default_for(nil)
     end
     
-    it "returns nil when value nil and :represent_nil true" do
-      @def = Representable::Definition.new(:song, :represent_nil => true)
+    it "returns nil when value nil and :render_nil true" do
+      @def = Representable::Definition.new(:song, :render_nil => true)
       assert_equal nil, @def.default_for(nil)
     end
     
-    it "returns nil when value nil and :represent_nil true even when :default is set" do
-      @def = Representable::Definition.new(:song, :represent_nil => true, :default => "The Quest")
+    it "returns nil when value nil and :render_nil true even when :default is set" do
+      @def = Representable::Definition.new(:song, :render_nil => true, :default => "The Quest")
       assert_equal nil, @def.default_for(nil)
     end
     

data/test/json_bindings_test.rb

@@ -13,6 +13,23 @@ class JSONBindingTest < MiniTest::Spec
   
   
   describe "PropertyBinding" do
+    describe "#read" do
+      before do
+        @property = Representable::JSON::PropertyBinding.new(Representable::Definition.new(:song))
+      end
+      
+      it "returns fragment if present" do
+        assert_equal "Stick The Flag Up Your Goddamn Ass, You Sonofabitch", @property.read({"song" => "Stick The Flag Up Your Goddamn Ass, You Sonofabitch"})
+        assert_equal "", @property.read({"song" => ""})
+        assert_equal nil, @property.read({"song" => nil})
+      end
+      
+      it "returns FRAGMENT_NOT_FOUND if not in document" do
+        assert_equal Representable::Binding::FragmentNotFound, @property.read({})
+      end
+      
+    end
+    
     describe "with plain text" do
       before do
         @property = Representable::JSON::PropertyBinding.new(Representable::Definition.new(:song))

data/test/json_test.rb

@@ -31,7 +31,7 @@ module JsonTest
         
         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 = @Band.from_json("{}", :new_name => "Diesel Boy") do |band, options|
             band.new_name= options[:new_name]
           end
           assert_equal "Diesel Boy", @band.new_name
@@ -378,8 +378,8 @@ end
           assert_equal ["Cobra Skulls", "Diesel Boy"], cd.bands.map(&:name).sort
         end
         
-        it "creates emtpy array per default" do
-          cd = Compilation.from_json({:compilation => {}}.to_json)
+        it "creates emtpy array from default if configured" do
+          cd = Compilation.from_json({}.to_json)
           assert_equal [], cd.bands
         end
       end

data/test/representable_test.rb

@@ -253,6 +253,26 @@ class RepresentableTest < MiniTest::Spec
       @band.update_properties_from({"groupies"=>false}, {}, Representable::JSON)
       assert_equal false, @band.groupies
     end
+    
+    it "ignores (no-default) properties not present in the incoming document" do
+      { Representable::JSON => {}, 
+        Representable::XML  => xml(%{<band/>})
+      }.each do |format, document|
+        nested_repr = Module.new do # this module is never applied.
+          include format
+          property :created_at
+        end
+        
+        repr = Module.new do
+          include format
+          property :name, :class => Object, :extend => nested_repr
+        end
+        
+        @band = Band.new.extend(repr)
+        @band.update_properties_from(document, {}, format)
+        assert_equal nil, @band.name, "Failed in #{format}"
+      end
+    end
   end
   
   describe "#create_representation_with" do
@@ -290,11 +310,11 @@ class RepresentableTest < MiniTest::Spec
       assert_equal({"name"=>"No One's Choice","groupies"=>false}, @band.send(:create_representation_with, {}, {}, Representable::JSON))
     end
     
-    it "includes nil attribute when :represent_nil is true" do
+    it "includes nil attribute when :render_nil is true" do
       mod = Module.new do
         include Representable::JSON
         property :name
-        property :groupies, :represent_nil => true
+        property :groupies, :render_nil => true
       end
       
       @band.extend(mod) # FIXME: use clean object.

data/test/test_helper.rb

@@ -4,6 +4,7 @@ Bundler.setup
 gem 'minitest'
 require 'representable'
 require 'representable/json'
+require 'representable/xml'
 require 'test/unit'
 require 'minitest/spec'
 require 'minitest/autorun'
@@ -28,3 +29,13 @@ class Song
     name == other.name
   end
 end
+
+module XmlHelper
+  def xml(document)
+    Nokogiri::XML(document).root
+  end
+end
+
+MiniTest::Spec.class_eval do
+  include XmlHelper
+end

data/test/xml_test.rb

@@ -297,7 +297,7 @@ class CollectionTest < MiniTest::Spec
         assert_equal ["Cobra Skulls", "Diesel Boy"], cd.bands.map(&:name).sort
       end
       
-      it "collections can be empty" do
+      it "collections can be empty when default set" do
         cd = Compilation.from_xml(%{
           <compilation>
           </compilation>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000 Z
+date: 2012-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri