representable 1.5.1 → 1.5.2

data/CHANGES.textile

@@ -1,3 +1,10 @@
+h2. 1.5.2
+
+* Rename `:representer_exec` to `:decorator_scope` and make it a documented (!) feature.
+* Accessors for properties defined with `decorator_scope: true` will now be invoked on the decorator, not on the represented instance anymore. This allows having decorators with helper methods.
+* Use `MultiJson` instead of `JSON` when parsing and rendering.
+* Make `Representable::Decorator::Coercion` work.
+
 h2. 1.5.1
 
 * Make lonely collections and hashes work with decorators.

data/README.md

@@ -218,9 +218,21 @@ module SongRepresenter
   end
 ```
 
-That works as the method is mixed into the represented object. Of course, this doesn't work with decorators.
+That works as the method is mixed into the represented object. When adding a helper method to a decorator, representable will still invoke accessors on the represented instance - unless you tell it the scope.
 
-Use `:getter` or `:setter` to dynamically add a method for the represented object.
+```ruby
+class SongRepresenter < Representable::Decorator
+  property :title, decorator_scope: true
+
+  def title
+    represented.name
+  end
+end
+```
+
+This will call `title` getter and setter on the decorator instance, not on the represented object. You can still access the represented object in the decorator method using `represented`. BTW, in a module representer this option is ignored.
+
+Or use `:getter` or `:setter` to dynamically add a method for the represented object.
 
 ```ruby
 class SongRepresenter < Representable::Decorator
@@ -667,6 +679,17 @@ module SongRepresenter
 end
 ```
 
+When using a decorator representer, use the `Representable::Decorator::Coercion` module.
+
+```ruby
+module SongRepresenter < Representable::Decorator
+  include Representable::JSON
+  include Representable::Decorator::Coercion
+
+  property :recorded_at, :type => DateTime
+end
+```
+
 ## Undocumented Features
 
 (Please don't read this section!)
@@ -678,17 +701,6 @@ end
 property :title, :binding => lambda { |*args| JSON::TitleBinding.new(*args) }
 ```
 
-* Lambdas are usually executed in the represented object's context. If your writing a `Decorator` representer and you need to execute lambdas in its context use the `:representer_exec` option.
-
-<!-- and some more in a beautiful cuddle -->
-```ruby
-class SongRepresenter < Representable::Decorator
-  property :title, :representer_exec => true, :getter => lambda {..}
-end
-```
-
-You can still access the represented object in the lambda using `represented`. In a module representer this option is ignored.
-
 ## Copyright
 
 Representable started as a heavily simplified fork of the ROXML gem. Big thanks to Ben Woosley for his inspiring work.

data/TODO

@@ -27,5 +27,4 @@ module ReaderWriter
 
 * make lambda options optional (arity == 0)
 
-* use `representer_exec` not only for lambdas, but also for methods
-	property :title # => calls decorator.title
+* pass args to methods when arity matches

data/lib/representable/binding.rb

@@ -12,14 +12,14 @@ module Representable
       build_for(definition, *args)
     end
 
-    def initialize(definition, represented, user_options={}, lambda_context=represented)  # TODO: remove default arg for user options. # DISCUSS: make lambda_context an options hash?
+    def initialize(definition, represented, user_options={}, exec_context=represented)  # TODO: remove default arg for user options. # DISCUSS: make exec_context an options hash?
       super(definition)
-      @represented    = represented
-      @user_options   = user_options
-      @lambda_context = lambda_context
+      @represented  = represented
+      @user_options = user_options
+      @exec_context = exec_context
     end
 
-    attr_reader :user_options, :represented, :lambda_context # TODO: make private/remove.
+    attr_reader :user_options, :represented # TODO: make private/remove.
 
     # Main entry point for rendering/parsing a property object.
     def serialize(value)
@@ -74,17 +74,19 @@ module Representable
 
     def get
       represented_exec_for(:getter) do
-        represented.send(getter)
+        exec_context.send(getter)
       end
     end
 
     def set(value)
       represented_exec_for(:setter, value) do
-        represented.send(setter, value)
+        exec_context.send(setter, value)
       end
     end
 
   private
+    attr_reader :exec_context
+
     # Execute the block for +option_name+ on the represented object.
     # Executes passed block when there's no lambda for option.
     def represented_exec_for(option_name, *args)
@@ -92,12 +94,12 @@ module Representable
       call_proc_for(options[option_name], *args)
     end
 
-    # All lambdas are executed on lambda_context which is either represented or the decorator instance.
+    # All lambdas are executed on exec_context which is either represented or the decorator instance.
     def call_proc_for(proc, *args)
       return proc unless proc.is_a?(Proc)
       # TODO: call method when proc is sympbol.
       args << user_options # DISCUSS: we assume user_options is a Hash!
-      lambda_context.instance_exec(*args, &proc)
+      exec_context.instance_exec(*args, &proc)
     end
 
 

data/lib/representable/coercion.rb

@@ -7,7 +7,7 @@ module Representable::Coercion
       extend ClassMethods
     end
   end
-  
+
   module ClassMethods
     def property(name, args={})
        attribute(name, args[:type]) if args[:type] # FIXME (in virtus): undefined method `superclass' for VirtusCoercionTest::SongRepresenter:Module

data/lib/representable/decorator.rb

@@ -14,7 +14,7 @@ module Representable
     end
 
     def representable_binding_for(attr, format, options)
-      context = attr.options[:representer_exec] ? self : represented  # DISCUSS: should Decorator know this kinda stuff?
+      context = attr.options[:decorator_scope] ? self : represented  # DISCUSS: should Decorator know this kinda stuff?
 
       format.build(attr, represented, options, context)
     end

data/lib/representable/decorator/coercion.rb

@@ -0,0 +1,45 @@
+class Representable::Decorator
+  module Coercion
+    def self.included(base)
+      base.class_eval do
+        include Virtus
+        extend Representable::Coercion::ClassMethods
+        extend ClassMethods
+
+        def initialize(represented) # override Virtus' #initialize.
+          @represented = represented
+        end
+      end
+    end
+
+    module ClassMethods
+      def property(name, options={})
+        if options[:type]
+          options[:decorator_scope] = true # call setter on decorator so coercion kicks in.
+          create_writer(name)
+          create_reader(name)
+        end
+
+        super # Representable::Coercion.
+      end
+
+    private
+      # FIXME: dear @solnic, please make this better!
+      def create_writer(name)
+        # the call to super makes the actual coercion, which is then delegated to the represented instance.
+        define_method "#{name}=" do |v|
+          coerced_value = super(v).get(self)
+          represented.send("#{name}=", coerced_value)
+        end
+      end
+
+      def create_reader(name)
+        # the call to super makes the actual coercion, which is then delegated to the represented instance.
+        define_method "#{name}" do
+          send("#{name}=", represented.send(name))
+          super()
+        end
+      end
+    end
+  end
+end

data/lib/representable/json.rb

@@ -14,25 +14,25 @@ module Representable
         extend Representable::Hash::ClassMethods  # DISCUSS: this is only for .from_hash, remove in 2.3?
       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
     end
-    
-    
+
+
     # Parses the body as JSON and delegates to #from_hash.
     def from_json(data, *args)
-      data = ::JSON[data]
+      data = MultiJson.load(data)
       from_hash(data, *args)
     end
-    
+
     # Returns a JSON string representing this object.
     def to_json(*args)
-      to_hash(*args).to_json
+      MultiJson.dump to_hash(*args)
     end
   end
 end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.5.1"
+  VERSION = "1.5.2"
 end

data/representable.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "mongoid"
   s.add_development_dependency "virtus", "~> 0.5.0"
   s.add_development_dependency "yajl-ruby"
+  s.add_development_dependency "json", '~> 1.7.7'
 end

data/test/coercion_test.rb

@@ -4,7 +4,7 @@ require 'representable/coercion'
 class VirtusCoercionTest < MiniTest::Spec
   class Song  # note that we don't define accessors for the properties here.
   end
-    
+
   describe "Coercion with Virtus" do
     describe "on object level" do
       module SongRepresenter
@@ -13,7 +13,7 @@ class VirtusCoercionTest < MiniTest::Spec
         property :composed_at,  :type => DateTime
         property :track,        :type => Integer
       end
-     
+
       it "coerces properties in #from_json" do
         song = Song.new.extend(SongRepresenter).from_json("{\"composed_at\":\"November 18th, 1983\",\"track\":\"18\"}")
         assert_kind_of DateTime, song.composed_at
@@ -21,29 +21,47 @@ class VirtusCoercionTest < MiniTest::Spec
         assert_equal DateTime.parse("Fri, 18 Nov 1983 00:00:00 +0000"), song.composed_at
       end
     end
-    
-    
+
+
     describe "on class level" do
       class ImmigrantSong
         include Representable::JSON
         include Representable::Coercion
-        
+
         property :composed_at,  :type => DateTime, :default => "May 12th, 2012"
         property :track,        :type => Integer
       end
-      
+
       it "coerces into the provided type" do
         song = ImmigrantSong.new.from_json("{\"composed_at\":\"November 18th, 1983\",\"track\":\"18\"}")
         assert_equal DateTime.parse("Fri, 18 Nov 1983 00:00:00 +0000"), song.composed_at
         assert_equal 18, song.track
       end
-      
+
       it "respects the :default options" do
         song = ImmigrantSong.new.from_json("{}")
         assert_kind_of DateTime, song.composed_at
         assert_equal DateTime.parse("Mon, 12 May 2012 00:00:00 +0000"), song.composed_at
       end
     end
-    
+
+    require 'representable/decorator/coercion'
+    describe "on decorator" do
+      class SongRepresentation < Representable::Decorator
+        include Representable::JSON
+        include Representable::Decorator::Coercion
+
+        property :composed_at, :type => DateTime
+      end
+
+      it "coerces when parsing" do
+        song = SongRepresentation.new(OpenStruct.new).from_json("{\"composed_at\":\"November 18th, 1983\"}")
+        song.composed_at.must_equal DateTime.parse("Fri, 18 Nov 1983")
+      end
+
+      it "coerces when rendering" do
+        SongRepresentation.new(OpenStruct.new(:composed_at => "November 18th, 1983")).to_json.must_equal "{\"composed_at\":\"1983-11-18T00:00:00+00:00\"}"
+      end
+    end
   end
 end

data/test/representable_test.rb

@@ -683,11 +683,19 @@ class RepresentableTest < MiniTest::Spec
       end
     end
 
-    describe ":representer_exec" do
+    describe ":decorator_scope" do
       representer! do
-        property :title, :getter => lambda { |*| title_from_representer }, :representer_exec => true
+        property :title, :getter => lambda { |*| title_from_representer }, :decorator_scope => true
       end
 
+      let (:representer_with_method) {
+        Module.new do
+          include Representable::Hash
+          property :title, :decorator_scope => true
+          def title; "Crystal Planet"; end
+        end
+       }
+
       it "executes lambdas in represented context" do
         Class.new do
           def title_from_representer
@@ -696,8 +704,11 @@ class RepresentableTest < MiniTest::Spec
         end.new.extend(representer).to_hash.must_equal({"title"=>"Sounds Of Silence"})
       end
 
-      describe "with decorator" do
+      it "executes method in represented context" do
+        Object.new.extend(representer_with_method).to_hash.must_equal({"title"=>"Crystal Planet"})
+      end
 
+      describe "with decorator" do
         it "executes lambdas in representer context" do
           rpr = representer
           Class.new(Representable::Decorator) do
@@ -706,13 +717,20 @@ class RepresentableTest < MiniTest::Spec
             def title_from_representer
               "Sounds Of Silence"
             end
-          end.new(Object.new).to_hash().must_equal({"title"=>"Sounds Of Silence"})
+          end.new(Object.new).to_hash.must_equal({"title"=>"Sounds Of Silence"})
+        end
+
+        it "executes method in representer context" do
+          rpr = representer_with_method
+          Class.new(Representable::Decorator) do
+            include rpr # mixes in #title.
+          end.new(Object.new).to_hash.must_equal({"title"=>"Crystal Planet"})
         end
 
         it "still allows accessing the represented object" do
           Class.new(Representable::Decorator) do
             include Representable::Hash
-            property :title, :getter => lambda { |*| represented.title }, :representer_exec => true
+            property :title, :getter => lambda { |*| represented.title }, :decorator_scope => true
 
             def title
               "Sounds Of Silence"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -155,6 +155,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
 description: Maps representation documents from and to Ruby objects. Includes XML
   and JSON support, plain properties, collections and compositions.
 email:
@@ -178,6 +194,7 @@ files:
 - lib/representable/bindings/yaml_bindings.rb
 - lib/representable/coercion.rb
 - lib/representable/decorator.rb
+- lib/representable/decorator/coercion.rb
 - lib/representable/definition.rb
 - lib/representable/deprecations.rb
 - lib/representable/feature/readable_writeable.rb
@@ -192,7 +209,6 @@ files:
 - lib/representable/xml/hash.rb
 - lib/representable/yaml.rb
 - representable.gemspec
-- test/Gemfile
 - test/coercion_test.rb
 - test/definition_test.rb
 - test/example.rb

data/test/Gemfile

@@ -1,3 +0,0 @@
-source :rubygems
-
-gem 'representable', :path => "../"