representable 2.3.0 → 2.4.0.rc1

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "2.3.0"
+  VERSION = "2.4.0.rc1"
 end

data/lib/representable/xml.rb

@@ -25,6 +25,10 @@ module Representable
         representable_attrs.options[:remove_namespaces] = true
       end
 
+      def format_engine
+        Representable::XML
+      end
+
       def collection_representer_class
         Collection
       end

data/lib/representable/xml/binding.rb

@@ -4,34 +4,34 @@ require 'representable/hash/binding.rb'
 module Representable
   module XML
     class Binding < Representable::Binding
-      def self.build_for(definition, *args)
-        return Collection.new(definition, *args)      if definition.array?
-        return Hash.new(definition, *args)            if definition.hash? and not definition[:use_attributes] # FIXME: hate this.
-        return AttributeHash.new(definition, *args)   if definition.hash? and definition[:use_attributes]
-        return Attribute.new(definition, *args)       if definition[:attribute]
-        return Content.new(definition, *args)         if definition[:content]
-        new(definition, *args)
+      def self.build_for(definition)
+        return Collection.new(definition)      if definition.array?
+        return Hash.new(definition)            if definition.hash? and not definition[:use_attributes] # FIXME: hate this.
+        return AttributeHash.new(definition)   if definition.hash? and definition[:use_attributes]
+        return Attribute.new(definition)       if definition[:attribute]
+        return Content.new(definition)         if definition[:content]
+        new(definition)
       end
 
-      def write(parent, fragments)
+      def write(parent, fragments, as)
         wrap_node = parent
 
         if wrap = self[:wrap]
           parent << wrap_node = node_for(parent, wrap)
         end
 
-        wrap_node << serialize_for(fragments, parent)
+        wrap_node << serialize_for(fragments, parent, as)
       end
 
-      def read(node)
-        nodes = find_nodes(node)
+      def read(node, as)
+        nodes = find_nodes(node, as)
         return FragmentNotFound if nodes.size == 0 # TODO: write dedicated test!
 
         deserialize_from(nodes)
       end
 
       # Creates wrapped node for the property.
-      def serialize_for(value, parent)
+      def serialize_for(value, parent, as)
         node = node_for(parent, as)
         serialize_node(node, value)
       end
@@ -57,13 +57,9 @@ module Representable
       end
 
     private
-      def xpath
-        as
-      end
-
-      def find_nodes(doc)
-        selector  = xpath
-        selector  = "#{self[:wrap]}/#{xpath}" if self[:wrap]
+      def find_nodes(doc, as)
+        selector  = as
+        selector  = "#{self[:wrap]}/#{as}" if self[:wrap]
         nodes     = doc.xpath(selector)
       end
 
@@ -81,9 +77,9 @@ module Representable
       class Collection < self
         include Representable::Binding::Collection
 
-        def serialize_for(value, parent)
+        def serialize_for(value, parent, as)
           # return NodeSet so << works.
-          set_for(parent, value.collect { |item| super(item, parent) })
+          set_for(parent, value.collect { |item| super(item, parent, as) })
         end
 
         def deserialize_from(nodes)
@@ -102,9 +98,7 @@ module Representable
 
 
       class Hash < Collection
-        include Representable::Binding::Hash
-
-        def serialize_for(value, parent)
+        def serialize_for(value, parent, as)
           set_for(parent, value.collect do |k, v|
             node = node_for(parent, k)
             serialize_node(node, v)
@@ -123,7 +117,7 @@ module Representable
 
       class AttributeHash < Collection
         # DISCUSS: use AttributeBinding here?
-        def write(parent, value)  # DISCUSS: is it correct overriding #write here?
+        def write(parent, value, as)  # DISCUSS: is it correct overriding #write here?
           value.collect do |k, v|
             parent[k] = v.to_s
           end
@@ -139,22 +133,22 @@ module Representable
 
       # Represents a tag attribute. Currently this only works on the top-level tag.
       class Attribute < self
-        def read(node)
+        def read(node, as)
           node[as]
         end
 
-        def serialize_for(value, parent)
+        def serialize_for(value, parent, as)
           parent[as] = value.to_s
         end
 
-        def write(parent, value)
-          serialize_for(value, parent)
+        def write(parent, value, as)
+          serialize_for(value, parent, as)
         end
       end
 
       # Represents tag content.
       class Content < self
-        def read(node)
+        def read(node, as)
           node.content
         end
 
@@ -162,7 +156,7 @@ module Representable
           parent.content = value.to_s
         end
 
-        def write(parent, value)
+        def write(parent, value, as)
           serialize_for(value, parent)
         end
       end

data/lib/representable/xml/collection.rb

@@ -1,15 +1,17 @@
 module Representable::XML
   module Collection
-    include Representable::XML
-
     def self.included(base)
       base.send :include, Representable::XML
       base.send :include, Representable::Hash::Collection
       base.send :include, Methods
     end
 
-
     module Methods
+      def create_representation_with(doc, options, format)
+        bin = representable_map(options, format).first
+        bin.write(doc, super, bin.name)
+      end
+
       def update_properties_from(doc, *args)
         super(doc.search("./*"), *args) # pass the list of collection items to Hash::Collection#update_properties_from.
       end

data/lib/representable/xml/hash.rb

@@ -10,7 +10,7 @@ module Representable::XML
       base.class_eval do
         include Representable
         extend ClassMethods
-        representable_attrs.add(:_self, {:hash => true, :use_attributes => true})
+        property(:_self, hash: true, use_attributes: true)
       end
     end
 
@@ -20,6 +20,11 @@ module Representable::XML
         hash :_self, options.merge!(:use_attributes => true)
       end
     end
+
+    def create_representation_with(doc, options, format)
+      bin = representable_bindings_for(format, options).first
+      bin.write(doc, super, options)
+    end
   end
 
   module Hash
@@ -30,7 +35,7 @@ module Representable::XML
       base.class_eval do
         include Representable
         extend ClassMethods
-        representable_attrs.add(:_self, {:hash => true})
+        property(:_self, {:hash => true})
       end
     end
 

data/lib/representable/yaml.rb

@@ -8,11 +8,16 @@ module Representable
     def self.included(base)
       base.class_eval do
         include Representable
-        #self.representation_wrap = true # let representable compute it.
         register_feature Representable::YAML
+        extend ClassMethods
       end
     end
 
+    module ClassMethods
+      def format_engine
+        Representable::YAML
+      end
+    end
 
     def from_yaml(doc, options={})
       hash = Psych.load(doc)
@@ -21,8 +26,6 @@ module Representable
 
     # Returns a Nokogiri::XML object representing this object.
     def to_ast(options={})
-      #root_tag = options[:wrap] || representation_wrap
-
       Psych::Nodes::Mapping.new.tap do |map|
         create_representation_with(map, options, Binding)
       end

data/lib/representable/yaml/binding.rb

@@ -3,12 +3,12 @@ require 'representable/hash/binding'
 module Representable
   module YAML
     class Binding < Representable::Hash::Binding
-      def self.build_for(definition, *args)
-        return Collection.new(definition, *args) if definition.array?
-        new(definition, *args)
+      def self.build_for(definition)
+        return Collection.new(definition) if definition.array?
+        new(definition)
       end
 
-      def write(map, fragment)
+      def write(map, fragment, as)
         map.children << Psych::Nodes::Scalar.new(as)
         map.children << node_for(fragment)  # FIXME: should be serialize.
       end

data/representable.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib/', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
@@ -20,11 +19,12 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.license       = "MIT"
 
-  s.add_dependency "uber", "~> 0.0.7"
+  s.add_dependency "uber", "~> 0.0.15"
+  s.add_dependency "declarative", "~> 0.0.4"
 
   s.add_development_dependency "rake"
   s.add_development_dependency "test_xml", "0.1.6"
-  s.add_development_dependency "minitest", ">= 5.4.1"
+  s.add_development_dependency "minitest"
   s.add_development_dependency "mongoid"
   s.add_development_dependency "virtus"
   s.add_development_dependency "json", '>= 1.7.7'

data/test/---deserialize-pipeline_test.rb

@@ -0,0 +1,37 @@
+require "test_helper"
+
+class DeserializePipelineTest < MiniTest::Spec
+  Album  = Struct.new(:artist, :songs)
+  Artist = Struct.new(:email)
+  Song   = Struct.new(:title)
+
+  # tests [Collect[Instance, Prepare, Deserialize], Setter]
+  class Representer < Representable::Decorator
+    include Representable::Hash
+
+    # property :artist, populator: Uber::Options::Value.new(ArtistPopulator.new), pass_options:true do
+    #   property :email
+    # end
+    # DISCUSS: rename to populator_pipeline ?
+    collection :songs, parse_pipeline: ->(*) { [Collect[Instance, Prepare, Deserialize], Setter] }, instance: :instance!, exec_context: :decorator, pass_options: true do
+      property :title
+    end
+
+    def instance!(*options)
+      puts "@@@@@ #{options.inspect}"
+      Song.new
+    end
+
+    def songs=(array)
+      represented.songs=array
+    end
+  end
+
+  it do
+    skip "TODO: implement :parse_pipeline and :render_pipeline, and before/after/replace semantics"
+    album = Album.new
+    Representer.new(album).from_hash({"artist"=>{"email"=>"yo"}, "songs"=>[{"title"=>"Affliction"}, {"title"=>"Dream Beater"}]})
+    album.songs.must_equal([Song.new("Affliction"), Song.new("Dream Beater")])
+    puts album.inspect
+  end
+end

data/test/binding_test.rb

@@ -5,7 +5,7 @@ class BindingTest < MiniTest::Spec
   let (:render_nil_definition) { Representable::Definition.new(:song, :render_nil => true) }
 
   describe "#skipable_empty_value?" do
-    let (:binding) { Binding.new(render_nil_definition, nil) }
+    let (:binding) { Binding.new(render_nil_definition) }
 
     # don't skip when present.
     it { binding.skipable_empty_value?("Disconnect, Disconnect").must_equal false }
@@ -14,16 +14,16 @@ class BindingTest < MiniTest::Spec
     it { binding.skipable_empty_value?(nil).must_equal false }
 
     # skip when nil and :render_nil undefined.
-    it { Binding.new(Representable::Definition.new(:song), nil).skipable_empty_value?(nil).must_equal true }
+    it { Binding.new(Representable::Definition.new(:song)).skipable_empty_value?(nil).must_equal true }
 
     # don't skip when nil and :render_nil undefined.
-    it { Binding.new(Representable::Definition.new(:song), nil).skipable_empty_value?("Fatal Flu").must_equal false }
+    it { Binding.new(Representable::Definition.new(:song)).skipable_empty_value?("Fatal Flu").must_equal false }
   end
 
 
   describe "#default_for" do
     let (:definition) { Representable::Definition.new(:song, :default => "Insider") }
-    let (:binding) { Binding.new(definition, nil) }
+    let (:binding) { Binding.new(definition) }
 
     # return value when value present.
     it { binding.default_for("Black And Blue").must_equal "Black And Blue" }
@@ -35,12 +35,12 @@ class BindingTest < MiniTest::Spec
     it { binding.default_for(nil).must_equal "Insider" }
 
     # return nil when value nil and render_nil: true.
-    it { Binding.new(render_nil_definition, nil).default_for(nil).must_equal nil }
+    it { Binding.new(render_nil_definition).default_for(nil).must_equal nil }
 
     # return nil when value nil and render_nil: true, even when :default is set" do
-    it { Binding.new(Representable::Definition.new(:song, :render_nil => true, :default => "The Quest"), nil).default_for(nil).must_equal nil }
+    it { Binding.new(Representable::Definition.new(:song, :render_nil => true, :default => "The Quest")).default_for(nil).must_equal nil }
 
     # return nil if no :default
-    it { Binding.new(Representable::Definition.new(:song), nil).default_for(nil).must_equal nil }
+    it { Binding.new(Representable::Definition.new(:song)).default_for(nil).must_equal nil }
   end
 end

data/test/cached_test.rb

@@ -14,7 +14,7 @@ class CachedTest < MiniTest::Spec
     include Representable::Hash
     feature Representable::Cached
 
-    property :title, render_filter: lambda { |value, doc, options| "#{value}:#{options.user_options}" }, pass_options: true
+    property :title, render_filter: lambda { |input, options| "#{input}:#{options[:user_options]}" }, pass_options: true
     property :composer, class: Model::Artist do
       property :name
     end
@@ -45,14 +45,16 @@ class CachedTest < MiniTest::Spec
         "songs"=>[{"title"=>"Jailbreak:{:volume=>9}"}, {"title"=>"Southbound:{:volume=>9}"}, {"title"=>"Emerald:{:volume=>9}"}]}) # called in Deserializer/Serializer
 
       # representer becomes reusable as it is stateless.
-      representer.update!(album2)
+      # representer.update!(album2)
 
       # makes sure options are passed correctly.
-      representer.to_hash(volume:10).must_equal(album_hash)
+      # representer.to_hash(volume:10).must_equal(album_hash)
     end
 
     # profiling
-    it "xx" do
+    it do
+      representer.to_hash
+
      RubyProf.start
         representer.to_hash
       res = RubyProf.stop
@@ -65,14 +67,18 @@ class CachedTest < MiniTest::Spec
 
       printer.print(STDOUT)
 
-      # only 1 nested decorators are instantiated, Song.
-      data.must_match "1   <Class::Representable::Decorator>#prepare"
-      # a total of 4 properties in the object graph.
-      data.must_match "4   Representable::Binding#initialize"
+      # 3 songs get decorated.
+      data.must_match "3   Representable::Function::Decorate#call"
+      # 3 nested decorator is instantiated for 3 Songs, though.
+      data.must_match "3   <Class::Representable::Decorator>#prepare"
+      # no Binding is instantiated at runtime.
+      data.wont_match "Representable::Binding#initialize"
       # 2 mappers for Album, Song
-      data.must_match "2   Representable::Mapper::Methods#initialize"
-      # 6 deserializers as the songs collection uses 2.
-      data.must_match "3   Representable::Deserializer#initialize"
+      # data.must_match "2   Representable::Mapper::Methods#initialize"
+      # title, songs, 3x title, composer
+      data.must_match "8   Representable::Binding#render_pipeline"
+      data.wont_match "render_functions"
+      data.wont_match "Representable::Binding::Factories#render_functions"
     end
   end
 
@@ -106,10 +112,12 @@ class CachedTest < MiniTest::Spec
       # TODO: test options.
     end
 
-    it do
+    it "xxx" do
       representer = AlbumRepresenter.new(Model::Album.new)
+      representer.from_hash(album_hash)
 
       RubyProf.start
+        # puts "#{representer.class.representable_attrs.get(:songs).representer_module.representable_attrs.inspect}"
         representer.from_hash(album_hash)
       res = RubyProf.stop
 
@@ -120,15 +128,19 @@ class CachedTest < MiniTest::Spec
       data = data.string
 
       # only 2 nested decorators are instantiated, Song, and Artist.
-      data.must_match "2   <Class::Representable::Decorator>#prepare"
+      data.must_match "5   <Class::Representable::Decorator>#prepare"
       # a total of 5 properties in the object graph.
-      data.must_match "5   Representable::Binding#initialize"
+      data.wont_match "Representable::Binding#initialize"
+
+
+      data.wont_match "parse_functions" # no pipeline creation.
+      data.must_match "10   Representable::Binding#parse_pipeline"
       # three mappers for Album, Song, composer
-      data.must_match "3   Representable::Mapper::Methods#initialize"
-      # 6 deserializers as the songs collection uses 2.
-      data.must_match "6   Representable::Deserializer#initialize"
-      # one populater for every property.
-      data.must_match "5   Representable::Populator#initialize"
+      # data.must_match "3   Representable::Mapper::Methods#initialize"
+      # # 6 deserializers as the songs collection uses 2.
+      # data.must_match "6   Representable::Deserializer#initialize"
+      # # one populater for every property.
+      # data.must_match "5   Representable::Populator#initialize"
       # printer.print(STDOUT)
     end
   end

data/test/coercion_test.rb

@@ -40,8 +40,8 @@ class VirtusCoercionTest < MiniTest::Spec
       include Representable::Coercion
 
       property :length, :type => Float,
-      :parse_filter  => lambda { |fragment, doc, options| "#{fragment}.1" }, # happens BEFORE coercer.
-      :render_filter => lambda { |fragment, doc, options| "#{fragment}.1" }
+      :parse_filter  => lambda { |input, options| "#{input}.1" }, # happens BEFORE coercer.
+      :render_filter => lambda { |fragment,*| "#{fragment}.1" }
     end
 
     # user's :parse_filter(s) are run before coercion.