representable 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57ca6d3739a88e3c3e38ecb6b4aa0b33b5da43a4
-  data.tar.gz: fc6f1765a152cbbb9300f01c60ae8f55c169ec6d
+  metadata.gz: 585370fa8b9543301be8e4a6804f2aff74639f1d
+  data.tar.gz: dd72e65cd02b0e5215a49957335088aab429be8d
 SHA512:
-  metadata.gz: ff20b22f94094d5bd9b99927c1f9ed28f82b74270d30d9eab5f8cab40facf22a8a9dbe9ccbb258ec68145489c8f81bd03766c6082f6c0a16c5f54d1f45610b61
-  data.tar.gz: 1c6c950c144548a986f55cdff935348ae253eee59339a3219416aba556aef22e59f707bf8ad9a30d3a3104314eb13ad1b67911ef2ccb10489bf6c21d0dda3f7c
+  metadata.gz: 0164fdb08a11640bb6d3a42b24f5ea97f8d0c35b995abd4129adfe859ae4d6fde41767d01298bf969f41771fcb90a50f0824dde32f062fd15765dc6b827e5241
+  data.tar.gz: bf1a835d25ec7ac0d3e5c1465c634ef4ec3e67af5ef914adf7a92c6ff378f0b7d42e51b24a0621bc642a708231c17d552e7695a2f3dcae7d28c8d84139fedd39

data/CHANGES.md

@@ -1,3 +1,8 @@
+h2. 1.7.2
+
+* `Representable#update_properties_from` is private now.
+* Added the `:content` option in XML to map top-level node's content to a property.
+
 h2. 1.7.1
 
 * Introduce `Config#options` hash to store per-representer configuration.

data/Gemfile

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 gemspec
 
 #gem "virtus", :path => "../virtus"
-gem 'rake', "10.1.0"
+gem 'rake', "10.1.0"
+#gem 'debugger'

data/README.md

@@ -595,9 +595,9 @@ composers: [Steward Copeland, Sting]
 
 ## More on XML
 
-### Mapping tag attributes
+### Mapping Tag Attributes
 
-You can also map properties to tag attributes in representable.
+You can also map properties to tag attributes in representable. This works only for the top-level node, thou (seen from the representer's perspective).
 
 ```ruby
 module SongRepresenter
@@ -613,7 +613,24 @@ Song.new(title: "American Idle").to_xml
 
 Naturally, this works for both ways.
 
-### Wrapping collections
+
+### Mapping Content
+
+The same concept can also be applied to content. If you need to map a property to the top-level node's content, use the `:content` option. Again, _top-level_ refers to the document fragment that maps to the representer.
+
+```ruby
+module SongRepresenter
+  include Representable::XML
+
+  property :title, content: true
+end
+
+Song.new(title: "American Idle").to_xml
+#=> <song>American Idle</song>
+```
+
+
+### Wrapping Collections
 
 It is sometimes unavoidable to wrap tag lists in a container tag.
 

data/lib/representable.rb

@@ -17,13 +17,13 @@ module Representable
     end
   end
 
+private
   # Reads values from +doc+ and sets properties accordingly.
   def update_properties_from(doc, options, format)
     # deserialize_for(bindings, mapper ? , options)
     representable_mapper(format, options).deserialize(doc, options)
   end
 
-private
   # Compiles the document going through all properties.
   def create_representation_with(doc, options, format)
     representable_mapper(format, options).serialize(doc, options)

data/lib/representable/bindings/xml_bindings.rb

@@ -11,6 +11,7 @@ module Representable
         return HashBinding.new(definition, *args)            if definition.hash? and not definition.options[:use_attributes] # FIXME: hate this.
         return AttributeHashBinding.new(definition, *args)   if definition.hash? and definition.options[:use_attributes]
         return AttributeBinding.new(definition, *args)       if definition.attribute
+        return ContentBinding.new(definition, *args)         if definition.content
         new(definition, *args)
       end
 
@@ -153,5 +154,20 @@ module Representable
         serialize_for(value, parent)
       end
     end
+
+    # Represents tag content.
+    class ContentBinding < PropertyBinding
+      def read(node)
+        node.content
+      end
+
+      def serialize_for(value, parent)
+        parent.content = serialize(value.to_s)
+      end
+
+      def write(parent, value)
+        serialize_for(value, parent)
+      end
+    end
   end
 end

data/lib/representable/definition.rb

@@ -57,6 +57,10 @@ module Representable
       options[:attribute]
     end
 
+    def content
+      options[:content]
+    end
+
     def skipable_nil_value?(value)
       value.nil? and not options[:render_nil]
     end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.7.1"
+  VERSION = "1.7.2"
 end

data/test/generic_test.rb

@@ -18,9 +18,10 @@ class GenericTest < MiniTest::Spec
       new_album.songs.must_equal [] # DISCUSS: do we really want this?
     end
 
-    it "overrides property with empty array" do
+    it "leaves properties untouched" do
       album.from_hash({})
-      album.songs.must_equal [] # DISCUSS: do we really want this?
+      # TODO: test property.
+      album.songs.must_equal ["Fuck Armageddon"] # DISCUSS: do we really want this?
     end
   end
 
@@ -189,28 +190,6 @@ class GenericTest < MiniTest::Spec
     end
   end
 
-  def render(object)
-    AssertableDocument.new(object.send("to_#{format}"), format)
-  end
-
-  def parse(object, input)
-    object.send("from_#{format}", input)
-  end
-
-  class AssertableDocument
-    attr_reader :document
-
-    def initialize(document, format)
-      @document, @format = document, format
-    end
-
-    def must_equal_document(*args)
-      return document.must_equal_xml(*args) if @format == :xml
-      document.must_equal(*args)
-    end
-  end
-
-
   describe "mix :extend and inline representers" do
     representer! do
       rpr_module = Module.new do

data/test/xml_bindings_test.rb

@@ -150,4 +150,20 @@ class XMLBindingTest < MiniTest::Spec
       end
     end
   end
+
+  describe "ContentBinding" do
+    before do
+      @property = Representable::XML::ContentBinding.new(Representable::Definition.new(:name, :content => true), nil)
+    end
+    
+    it "extracts with #read" do
+      assert_equal "The Gargoyle", @property.read(Nokogiri::XML("<song>The Gargoyle</song>").root)
+    end
+    
+    it "inserts with #write" do
+      parent = Nokogiri::XML::Node.new("song", @doc)
+      @property.write(parent, "The Gargoyle")
+      assert_xml_equal("<song>The Gargoyle</song>", parent.to_s)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2013-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri