representable 1.2.9 → 1.3.0

data/TODO

@@ -4,4 +4,14 @@ class: |key, hsh|
 * Allow passing options to Binding#serialize.
 	serialize(.., options{:exclude => ..})
 
-* Allow :writer and :reader / :getter/:setter
+* Allow :writer and :reader / :getter/:setter
+
+document `XML::AttributeHash` etc
+
+* deprecate :from, make :a(lia)s authorative.
+* cleanup ReadableWriteable
+* deprecate Representable::*::ClassMethods (::from_hash and friends)
+
+* Song < OpenStruct in test_helper
+
+* have representable-options (:include, :exclude) and user-options 

data/lib/representable.rb

@@ -42,7 +42,7 @@ module Representable
   
   # Reads values from +doc+ and sets properties accordingly.
   def update_properties_from(doc, options, format)
-    representable_bindings_for(format).each do |bin|
+    representable_bindings_for(format, options).each do |bin|
       deserialize_property(bin, doc, options)
     end
     self
@@ -51,7 +51,7 @@ module Representable
 private
   # Compiles the document going through all properties.
   def create_representation_with(doc, options, format)
-    representable_bindings_for(format).each do |bin|
+    representable_bindings_for(format, options).each do |bin|
       serialize_property(bin, doc, options)
     end
     doc
@@ -88,44 +88,35 @@ private
   # Retrieve value and write fragment to the doc.
   def compile_fragment(bin, doc)
     value = send(bin.getter)
-    value = bin.default_for(value)
     
-    write_fragment_for(bin, value, doc)
+    bin.write_fragment(doc, value)
   end
   
   # Parse value from doc and update the model property.
   def uncompile_fragment(bin, doc)
-    value = read_fragment_for(bin, doc)
-    
-    if value == Binding::FragmentNotFound
-      return unless bin.has_default?
-      value = bin.default
+    bin.read_fragment(doc) do |value|
+      send(bin.setter, value)
     end
-    
-    send(bin.setter, value)
-  end
-  
-  def write_fragment_for(bin, value, doc) # DISCUSS: move to Binding?
-    return if bin.skipable_nil_value?(value)
-    bin.write(doc, value)
-  end
-  
-  def read_fragment_for(bin, doc) # DISCUSS: move to Binding?
-    bin.read(doc)
   end
   
   def representable_attrs
     @representable_attrs ||= self.class.representable_attrs # DISCUSS: copy, or better not?
   end
   
-  def representable_bindings_for(format)
-    representable_attrs.map {|attr| format.build_for(attr, self) }
+  def representable_bindings_for(format, options)
+    options = cleanup_options(options)  # FIXME: make representable-options and user-options two different hashes.
+    representable_attrs.map {|attr| format.build_for(attr, self, options) }
   end
   
   # Returns the wrapper for the representation. Mostly used in XML.
   def representation_wrap
     representable_attrs.wrap_for(self.class.name)
   end
+
+private
+  def cleanup_options(options) # TODO: remove me.
+    options.reject { |k,v| [:include, :exclude].include?(k) }
+  end
   
   module ClassInclusions
     def included(base)

data/lib/representable/binding.rb

@@ -10,9 +10,10 @@ module Representable
       raise "Binding#definition is no longer supported as all Definition methods are now delegated automatically."
     end
 
-    def initialize(definition, represented)
+    def initialize(definition, represented, user_options={})  # TODO: remove default arg.
       super(definition)
-      @represented = represented
+      @represented  = represented
+      @user_options = user_options
     end
     
     # Main entry point for rendering/parsing a property object.
@@ -24,6 +25,33 @@ module Representable
       fragment
     end
     
+
+    def write_fragment(doc, value)
+      value = default_for(value)
+      
+      write_fragment_for(value, doc)
+    end
+
+    def write_fragment_for(value, doc)
+      return if skipable_nil_value?(value)
+      write(doc, value)
+    end
+
+    def read_fragment(doc)
+      value = read_fragment_for(doc)
+      
+      if value == FragmentNotFound
+        return unless has_default?
+        value = default
+      end
+
+      yield value
+    end
+
+    def read_fragment_for(doc)
+      read(doc)
+    end
+    
     
     # Hooks into #serialize and #deserialize to extend typed properties
     # at runtime.
@@ -62,12 +90,12 @@ module Representable
       def serialize(object)
         return object if object.nil?
         
-        super.send(serialize_method, :wrap => false)  # TODO: pass :binding => self
+        super.send(serialize_method, @user_options.merge!({:wrap => false}))  # TODO: pass :binding => self
       end
       
       def deserialize(data)
         # DISCUSS: does it make sense to skip deserialization of nil-values here?
-        super(create_object(data)).send(deserialize_method, data)
+        super(create_object(data)).send(deserialize_method, data, @user_options)
       end
       
       def create_object(fragment)

data/lib/representable/bindings/hash_bindings.rb

@@ -16,10 +16,10 @@ module Representable
     
     
     class PropertyBinding < Representable::Binding
-      def self.build_for(definition, represented)
-        return CollectionBinding.new(definition, represented)  if definition.array?
-        return HashBinding.new(definition, represented)        if definition.hash?
-        new(definition, represented)
+      def self.build_for(definition, *args)  # TODO: remove default arg.
+        return CollectionBinding.new(definition, *args)  if definition.array?
+        return HashBinding.new(definition, *args)        if definition.hash?
+        new(definition, *args)
       end
 
       def initialize(*args) # FIXME. make generic.

data/lib/representable/bindings/xml_bindings.rb

@@ -24,12 +24,12 @@ module Representable
     
     
     class PropertyBinding < Binding
-      def self.build_for(definition, represented)
-        return CollectionBinding.new(definition, represented)      if definition.array?
-        return HashBinding.new(definition, represented)            if definition.hash? and not definition.options[:use_attributes] # FIXME: hate this.
-        return AttributeHashBinding.new(definition, represented)   if definition.hash? and definition.options[:use_attributes]
-        return AttributeBinding.new(definition, represented)       if definition.attribute
-        new(definition, represented)
+      def self.build_for(definition, *args)
+        return CollectionBinding.new(definition, *args)      if definition.array?
+        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
+        new(definition, *args)
       end
 
       def initialize(*args)
@@ -48,10 +48,7 @@ module Representable
       end
       
       def read(node)
-        selector  = "./#{xpath}"
-        selector  = "./#{options[:wrap]}/#{xpath}" if options[:wrap]
-        nodes     = node.search(selector)
-
+        nodes = find_nodes(node)
         return FragmentNotFound if nodes.size == 0 # TODO: write dedicated test!
         
         deserialize_from(nodes)
@@ -83,6 +80,12 @@ module Representable
         from
       end
 
+      def find_nodes(doc)
+        selector  = xpath
+        selector  = "#{options[:wrap]}/#{xpath}" if options[:wrap]
+        nodes     = doc.xpath(selector)
+      end
+
       def node_for(parent, name)
         Nokogiri::XML::Node.new(name.to_s, parent.document)
       end

data/lib/representable/bindings/yaml_bindings.rb

@@ -19,12 +19,9 @@ module Representable
     end
 
     class PropertyBinding < Representable::Hash::PropertyBinding
-      def self.build_for(definition, represented)
-        return CollectionBinding.new(definition, represented)      if definition.array?
-        #return HashBinding.new(definition)            if definition.hash? and not definition.options[:use_attributes] # FIXME: hate this.
-        #return AttributeHashBinding.new(definition)   if definition.hash? and definition.options[:use_attributes]
-        #return AttributeBinding.new(definition)       if definition.attribute
-        new(definition, represented)
+      def self.build_for(definition, *args)
+        return CollectionBinding.new(definition, *args) if definition.array?
+        new(definition, *args)
       end
 
       def initialize(*args) # FIXME. make generic.

data/lib/representable/deprecations.rb

@@ -1,11 +1,4 @@
 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/hash_methods.rb

@@ -8,13 +8,13 @@ module Representable
     end
     
     def create_representation_with(doc, options, format)
-      bin   = representable_bindings_for(format).first
+      bin   = representable_bindings_for(format, options).first
       hash  = filter_keys_for(self, options)
       bin.write(doc, hash)
     end
     
     def update_properties_from(doc, options, format)
-      bin   = representable_bindings_for(format).first
+      bin   = representable_bindings_for(format, options).first
       hash  = filter_keys_for(doc, options)
       value = bin.deserialize_from(hash)
       replace(value)

data/lib/representable/json/collection.rb

@@ -18,12 +18,12 @@ module Representable::JSON
     
     
     def create_representation_with(doc, options, format)
-      bin   = representable_bindings_for(format).first
+      bin   = representable_bindings_for(format, options).first
       bin.serialize_for(self)
     end
     
     def update_properties_from(doc, options, format)
-      bin   = representable_bindings_for(format).first
+      bin   = representable_bindings_for(format, options).first
       value = bin.deserialize_from(doc)
       replace(value)
     end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.2.9"
+  VERSION = "1.3.0"
 end

data/lib/representable/xml/collection.rb

@@ -18,13 +18,13 @@ module Representable::XML
     
     
     def create_representation_with(doc, options, format)
-      bin   = representable_bindings_for(format).first
-      bin.serialize_for(self)
+      bin   = representable_bindings_for(format, options).first
+      bin.write(doc, self)
     end
     
     def update_properties_from(doc, options, format)
-      bin   = representable_bindings_for(format).first
-      value = bin.deserialize_from(doc)
+      bin   = representable_bindings_for(format, options).first
+      value = bin.deserialize_from(doc.search("./*")) # FIXME: use Binding#read.
       replace(value)
     end
     

data/test/example.rb

@@ -4,6 +4,14 @@ Bundler.setup
 require 'representable/yaml'
 require 'ostruct'
 
+def reset_representer(*module_name)
+  module_name.each do |mod|
+    mod.module_eval do
+      @representable_attrs = nil
+    end
+  end
+end
+
 class Song < OpenStruct
 end
 
@@ -37,11 +45,7 @@ puts song.extend(SongRepresenter).to_json
 
 ######### collections
 
-module SongRepresenter
-  include Representable::JSON
-
-  self.representation_wrap= false
-end
+reset_representer(SongRepresenter)
 
 module SongRepresenter
   include Representable::JSON
@@ -76,6 +80,7 @@ end
 album = Album.new(:name => "The Police", :song => song)
 puts album.extend(AlbumRepresenter).to_json
 
+reset_representer(AlbumRepresenter)
 
 module AlbumRepresenter
   include Representable::JSON
@@ -88,23 +93,25 @@ album = Album.new(:name => "The Police", :songs => [song, Song.new(:title => "Sy
 puts album.extend(AlbumRepresenter).to_json
 
 
-SongRepresenter.module_eval do
-  @representable_attrs = nil
-end
+album = Album.new.extend(AlbumRepresenter).from_json(%{{"name":"Offspring","songs":[{"title":"Genocide"},{"title":"Nitro","composers":["Offspring"]}]}
+})
+puts album.inspect
 
+reset_representer(SongRepresenter)
 
 ######### using helpers (customizing the rendering/parsing) 
 module AlbumRepresenter
+  include Representable::JSON
+
   def name
-    super.upper
+    super.upcase
   end
 end
-album = Album.new(:name => "The Police", :songs => [song, Song.new(:title => "Synchronicity")])
-puts album.extend(AlbumRepresenter).to_json
 
-SongRepresenter.module_eval do
-  @representable_attrs = nil
-end
+puts Album.new(:name => "The Police").
+  extend(AlbumRepresenter).to_json
+
+reset_representer(SongRepresenter)
 
 
 ######### inheritance
@@ -139,10 +146,7 @@ end
 song = Song.new(:title => "Fallout", :composers => ["Steward Copeland", "Sting"])
 puts song.extend(SongRepresenter).to_xml
 
-
-SongRepresenter.module_eval do
-  @representable_attrs = nil
-end
+reset_representer(SongRepresenter)
 
 
 ### YAML
@@ -172,8 +176,135 @@ module SongRepresenter
 end
 puts song.extend(SongRepresenter).to_yaml
 
+SongRepresenter.module_eval do
+  @representable_attrs = nil
+end
+
+# R/W support
+song = Song.new(:title => "You're Wrong", :track => 4)
+module SongRepresenter
+  include Representable::Hash
+
+  property :title, :readable => false
+  property :track
+end
+puts song.extend(SongRepresenter).to_hash
+
+SongRepresenter.module_eval do
+  @representable_attrs = nil
+end
+
+module SongRepresenter
+  include Representable::Hash
+
+  property :title, :writeable => false
+  property :track
+end
+song = Song.new.extend(SongRepresenter)
+song.from_hash({:title => "Fallout", :track => 1})
+puts song
 
 ######### custom methods in representer (using helpers)
-######### r/w, conditions
-#########
-######### polymorphic :extend and :class, instance context!, :instance
+######### conditions
+######### :as
+######### XML::Collection
+######### polymorphic :extend and :class, instance context!, :instance
+class CoverSong < Song
+end
+
+songs = [Song.new(title: "Weirdo", track: 5), CoverSong.new(title: "Truth Hits Everybody", track: 6, copyright: "The Police")]
+album = Album.new(name: "Incognito", songs: songs)
+
+
+reset_representer(SongRepresenter, AlbumRepresenter)
+
+module SongRepresenter
+  include Representable::Hash
+
+  property :title
+  property :track
+end
+
+module CoverSongRepresenter
+  include Representable::Hash
+  include SongRepresenter
+
+  property :copyright
+end
+
+module AlbumRepresenter
+  include Representable::Hash
+
+  property :name
+  collection :songs, :extend => lambda { |song| song.is_a?(CoverSong) ? CoverSongRepresenter : SongRepresenter }
+end
+
+puts album.extend(AlbumRepresenter).to_hash
+
+reset_representer(AlbumRepresenter)
+
+module AlbumRepresenter
+  include Representable::Hash
+
+  property :name
+  collection :songs, 
+    :extend => lambda { |song| song.is_a?(CoverSong) ? CoverSongRepresenter : SongRepresenter },
+    :class  => lambda { |hsh| hsh.has_key?("copyright") ? CoverSong : Song } #=> {"title"=>"Weirdo", "track"=>5}
+end
+
+album = Album.new.extend(AlbumRepresenter).from_hash({"name"=>"Incognito", "songs"=>[{"title"=>"Weirdo", "track"=>5}, {"title"=>"Truth Hits Everybody", "track"=>6, "copyright"=>"The Police"}]})
+puts album.inspect
+
+reset_representer(AlbumRepresenter)
+
+module AlbumRepresenter
+  include Representable::Hash
+
+  property :name
+  collection :songs, 
+    :extend   => lambda { |song| song.is_a?(CoverSong) ? CoverSongRepresenter : SongRepresenter },
+    :instance => lambda { |hsh| hsh.has_key?("copyright") ? CoverSong.new : Song.new(original: true) }
+end
+
+album = Album.new.extend(AlbumRepresenter).from_hash({"name"=>"Incognito", "songs"=>[{"title"=>"Weirdo", "track"=>5}, {"title"=>"Truth Hits Everybody", "track"=>6, "copyright"=>"The Police"}]})
+puts album.inspect
+
+######### #hash
+
+reset_representer(SongRepresenter)
+
+module SongRepresenter
+  include Representable::JSON
+
+  property :title
+  hash :ratings
+end
+
+puts Song.new(title: "Bliss", ratings: {"Rolling Stone" => 4.9, "FryZine" => 4.5}).extend(SongRepresenter).to_json
+
+######### JSON::Hash
+
+module FavoriteSongsRepresenter
+  include Representable::JSON::Hash
+end
+
+puts( {"Nick" => "Hyper Music", "El" => "Blown In The Wind"}.extend(FavoriteSongsRepresenter).to_json)
+
+require 'representable/json/hash'
+module FavoriteSongsRepresenter
+  include Representable::JSON::Hash
+
+  values extend: SongRepresenter, class: Song
+end
+
+puts( {"Nick" => Song.new(title: "Hyper Music")}.extend(FavoriteSongsRepresenter).to_json)
+
+
+require 'representable/json/collection'
+module SongsRepresenter
+  include Representable::JSON::Collection
+
+  items extend: SongRepresenter, class: Song
+end
+
+puts [Song.new(title: "Hyper Music"), Song.new(title: "Screenager")].extend(SongsRepresenter).to_json