representable 1.8.5 → 2.0.0.rc1

data/lib/representable/deserializer.rb

@@ -5,6 +5,8 @@ module Representable
     end
 
     def deserialize(fragment)
+      # puts "deserialize #{@binding.name}" # TODO: introduce Representable::Debug.
+
       # next step: get rid of collect.
       fragment.enum_for(:each_with_index).collect do |item_fragment, i|
         @deserializer = ObjectDeserializer.new(@binding)

data/lib/representable/for_collection.rb

@@ -0,0 +1,25 @@
+module Representable
+  # Gives us Representer::for_collection and its configuration directive
+  # ::collection_representer.
+  module ForCollection
+    def for_collection
+      # this is done at run-time, not a big fan of this. however, it saves us from inheritance/self problems.
+      @collection_representer ||= collection_representer!({}) # DON'T make it inheritable as it would inherit the wrong singular.
+    end
+
+  private
+    def collection_representer!(options)
+      singular = self
+
+      # what happens here is basically
+      # Module.new { include Representable::JSON::Collection; ... }
+      build_inline(nil, [singular.collection_representer_class], "", {}) {
+        items options.merge(:extend => singular)
+      }
+    end
+
+    def collection_representer(options={})
+      @collection_representer = collection_representer!(options)
+    end
+  end
+end

data/lib/representable/hash.rb

@@ -9,19 +9,15 @@ module Representable
     def self.included(base)
       base.class_eval do
         include Representable # either in Hero or HeroRepresentation.
-        extend ClassMethods # DISCUSS: do that only for classes?
+        extend ClassMethods
+        register_feature Representable::Hash
       end
     end
 
 
     module ClassMethods
-      def from_hash(*args, &block)
-        create_represented(*args, &block).from_hash(*args)
-      end
-
-    private
-      def representer_engine
-        Representable::Hash
+      def collection_representer_class
+        Collection
       end
     end
 

data/lib/representable/hash/collection.rb

@@ -4,9 +4,9 @@ module Representable::Hash
 
     def self.included(base)
       base.class_eval do
-        include Representable
+        include Representable::Hash
         extend ClassMethods
-        extend Representable::Hash::ClassMethods # ::representer_engine.
+        representable_attrs.add(:_self, {:collection => true})
       end
     end
 
@@ -28,12 +28,5 @@ module Representable::Hash
       value = bin.deserialize_from(doc)
       represented.replace(value)
     end
-
-    # FIXME: refactor Definition so we can simply add options in #items to existing definition.
-    def representable_attrs
-      attrs = super
-      attrs << Definition.new(:_self, :collection => true) if attrs.size == 0
-      attrs
-    end
   end
 end

data/lib/representable/hash_methods.rb

@@ -1,12 +1,5 @@
 module Representable
   module HashMethods
-    # FIXME: refactor Definition so we can simply add options in #items to existing definition.
-    def representable_attrs
-      attrs = super
-      attrs << Definition.new(*definition_opts) if attrs.size == 0
-      attrs
-    end
-
     def create_representation_with(doc, options, format)
       bin   = representable_mapper(format, options).bindings.first
       hash  = filter_keys_for(represented, options)

data/lib/representable/inheritable.rb

@@ -0,0 +1,50 @@
+module Representable
+  # Objects marked cloneable will be cloned in #inherit!.
+  module Cloneable
+  end
+
+  # Objects marked cloneable will be inherit!ed in #inherit! when available in parent and child.
+  module Inheritable
+    include Cloneable # all Inheritable are also Cloneable since #clone is one step of our inheritance.
+
+    class Array < ::Array
+      include Inheritable
+
+      def inherit!(parent)
+        push(*parent.clone)
+      end
+    end
+
+    class Hash < ::Hash
+      include Inheritable
+
+      module InstanceMethods
+        def inherit!(parent)
+          #merge!(parent.clone)
+          for key in (parent.keys + keys).uniq
+            next unless parent_value = parent[key]
+
+            self[key].inherit!(parent_value) and next if self[key].is_a?(Inheritable)
+            self[key] = parent_value.clone and next if parent_value.is_a?(Cloneable)
+
+            self[key] = parent_value # merge! behaviour
+          end
+
+          self
+        end
+
+        def clone
+          self.class[ collect { |k,v| [k, clone_value(v)] } ]
+        end
+
+      private
+        def clone_value(value)
+          return value.clone if value.is_a?(Cloneable)
+          value
+        end
+      end
+
+      include InstanceMethods
+    end
+  end
+end

data/lib/representable/json.rb

@@ -11,20 +11,14 @@ module Representable
       base.class_eval do
         include Representable # either in Hero or HeroRepresentation.
         extend ClassMethods # DISCUSS: do that only for classes?
-        extend Representable::Hash::ClassMethods  # DISCUSS: this is only for .from_hash, remove in 2.3?
+        register_feature Representable::JSON
       end
     end
 
 
     module ClassMethods
-      # Creates a new object from the passed JSON document.
-      def from_json(*args, &block)
-        create_represented(*args, &block).from_json(*args)
-      end
-
-    private
-      def representer_engine
-        Representable::JSON
+      def collection_representer_class
+        JSON::Collection
       end
     end
 

data/lib/representable/json/collection.rb

@@ -3,9 +3,7 @@ module Representable::JSON
     include Representable::JSON
 
     def self.included(base)
-      base.class_eval do
-        include Representable::Hash::Collection
-      end
+      base.send :include, Representable::Hash::Collection
     end
   end
 end

data/lib/representable/json/hash.rb

@@ -2,15 +2,15 @@ require 'representable/json'
 require 'representable/hash_methods'
 
 module Representable::JSON
+  # "Lonely Hash" support.
   module Hash
-    include Representable::JSON
-    include Representable::HashMethods
-
     def self.included(base)
       base.class_eval do
         include Representable
         extend ClassMethods
-        extend Representable::Hash::ClassMethods # ::representer_engine.
+        include Representable::JSON
+        include Representable::HashMethods
+        representable_attrs.add(:_self, {:hash => true})
       end
     end
 
@@ -20,10 +20,5 @@ module Representable::JSON
         hash(:_self, options, &block)
       end
     end
-
-
-    def definition_opts
-      [:_self, {:hash => true, :use_attributes => true}]
-    end
   end
 end

data/lib/representable/mapper.rb

@@ -1,5 +1,3 @@
-require 'representable/readable_writeable'
-
 module Representable
   # Render and parse by looping over the representer's properties and dispatching to bindings.
   # Conditionals are handled here, too.
@@ -28,18 +26,19 @@ module Representable
 
     private
       def serialize_property(binding, doc, options)
-        return if skip_property?(binding, options)
+        return if skip_property?(binding, options.merge(:action => :serialize))
         compile_fragment(binding, doc)
       end
 
       def deserialize_property(binding, doc, options)
-        return if skip_property?(binding, options)
+        return if skip_property?(binding, options.merge(:action => :deserialize))
         uncompile_fragment(binding, doc)
       end
 
       # Checks and returns if the property should be included.
       def skip_property?(binding, options)
         return true if skip_excluded_property?(binding, options)  # no need for further evaluation when :exclude'ed
+        return true if skip_protected_property(binding, options)
 
         skip_conditional_property?(binding)
       end
@@ -56,6 +55,11 @@ module Representable
         not binding.send(:evaluate_option, :if)
       end
 
+      # DISCUSS: this could be just another :if option in a Pipeline?
+      def skip_protected_property(binding, options)
+        options[:action] == :serialize ? binding[:readable] == false : binding[:writeable] == false
+      end
+
       def compile_fragment(bin, doc)
         bin.compile_fragment(doc)
       end
@@ -66,6 +70,5 @@ module Representable
     end
 
     include Methods
-    include ReadableWriteable # DISCUSS: make this pluggable.
   end
 end

data/lib/representable/parse_strategies.rb

@@ -21,6 +21,7 @@ module Representable
     end
 
 
+    # Using a lambda as parse_strategy does not set the parsed property for you.
     class Proc
       def self.apply!(name, options)
         options[:setter]       = lambda { |*| }

data/lib/representable/pipeline.rb

@@ -0,0 +1,14 @@
+module Representable
+  # Allows to implement a pipeline of filters where a value gets passed in and the result gets
+  # passed to the next callable object.
+  #
+  # Note: this is still experimental.
+  class Pipeline < Array
+    include Uber::Callable
+    # include Representable::Cloneable
+
+    def call(context, value, *args)
+      inject(value) { |memo, block| block.call(memo, *args) }
+    end
+  end
+end

data/lib/representable/represent.rb

@@ -0,0 +1,6 @@
+module Representable::Represent
+  def represent(represented, array_class=Array)
+    return for_collection.prepare(represented) if represented.is_a?(array_class)
+    prepare(represented)
+  end
+end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.8.5"
+  VERSION = "2.0.0.rc1"
 end

data/lib/representable/xml.rb

@@ -9,6 +9,7 @@ module Representable
         include Representable
         extend ClassMethods
         self.representation_wrap = true # let representable compute it.
+        register_feature Representable::XML
       end
     end
 
@@ -18,24 +19,8 @@ module Representable
         representable_attrs.options[:remove_namespaces] = true
       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
-      # the property is skipped.
-      #
-      # Example:
-      #   band.from_xml("<band><name>Nofx</name></band>")
-      def from_xml(*args, &block)
-        create_represented(*args, &block).from_xml(*args)
-      end
-
-      def from_node(*args, &block)
-        create_represented(*args, &block).from_node(*args)
-      end
-
-    private
-      def representer_engine
-        Representable::XML
+      def collection_representer_class
+        Collection
       end
     end
 

data/lib/representable/xml/collection.rb

@@ -3,10 +3,8 @@ module Representable::XML
     include Representable::XML
 
     def self.included(base)
-      base.class_eval do
-        include Representable::Hash::Collection
-        include Methods
-      end
+      base.send :include, Representable::Hash::Collection
+      base.send :include, Methods
     end
 
     module Methods

data/lib/representable/xml/hash.rb

@@ -10,6 +10,7 @@ module Representable::XML
       base.class_eval do
         include Representable
         extend ClassMethods
+        representable_attrs.add(:_self, {:hash => true, :use_attributes => true})
       end
     end
 
@@ -19,11 +20,6 @@ module Representable::XML
         hash :_self, options.merge!(:use_attributes => true)
       end
     end
-
-
-    def definition_opts
-      [:_self, {:hash => true, :use_attributes => true}]
-    end
   end
 
   module Hash
@@ -34,6 +30,7 @@ module Representable::XML
       base.class_eval do
         include Representable
         extend ClassMethods
+        representable_attrs.add(:_self, {:hash => true})
       end
     end
 
@@ -43,10 +40,5 @@ module Representable::XML
         hash :_self, options
       end
     end
-
-
-   def definition_opts
-      [:_self, {:hash => true}]
-    end
   end
 end

data/lib/representable/yaml.rb

@@ -7,27 +7,8 @@ module Representable
     def self.included(base)
       base.class_eval do
         include Representable
-        extend ClassMethods
         #self.representation_wrap = true # let representable compute it.
-      end
-    end
-
-
-    module ClassMethods
-      # 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
-      # the property is skipped.
-      #
-      # Example:
-      #   band.from_xml("<band><name>Nofx</name></band>")
-      def from_yaml(*args, &block)
-        create_represented(*args, &block).from_yaml(*args)
-      end
-
-    private
-      def representer_engine
-        Representable::YAML
+        register_feature Representable::YAML
       end
     end
 

data/representable.gemspec

@@ -21,13 +21,13 @@ Gem::Specification.new do |s|
 
   s.add_dependency "nokogiri"
   s.add_dependency "multi_json"
-  s.add_dependency "uber"
+  s.add_dependency "uber", "~> 0.0.7"
 
   s.add_development_dependency "rake"
   s.add_development_dependency "test_xml", ">= 0.1.6"
   s.add_development_dependency "minitest", "~> 5.0.0"
   s.add_development_dependency "mocha", ">= 0.13.0"
   s.add_development_dependency "mongoid"
-  s.add_development_dependency "virtus", "~> 0.5.0"
+  s.add_development_dependency "virtus"
   s.add_development_dependency "json", '~> 1.7.7'
 end

data/test/class_test.rb

@@ -39,21 +39,16 @@ class ClassTest < BaseTest
   end
 
 
-  describe "lambda { nil }" do # TODO: remove in 2.0.
+  # this throws a DeserializationError now.
+  describe "lambda { nil }" do
     representer! do
       property :title, :class  => nil
     end
 
-    it "skips creating new instance" do
-      object = Object.new
-      object.instance_eval do
-        def from_hash(hash, *args)
-          hash
-        end
+    it do
+      assert_raises Representable::DeserializeError do
+        OpenStruct.new.extend(representer).from_hash({"title" => {}})
       end
-
-      song = OpenStruct.new.extend(representer).from_hash(hash = {"title" => object})
-      song.title.must_equal object
     end
   end