representable 1.4.0 → 1.4.1

data/CHANGES.textile

@@ -1,3 +1,7 @@
+h2. 1.4.1
+
+* Added `:representer_exec` to have lambdas be executed in decorator instance context.
+
 h2. 1.4.0
 
 * We now have two strategies for representing: the old extend approach and the brand-new decorator which leaves represented objects untouched. See "README":https://github.com/apotonick/representable#decorator-vs-extend for details.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 - 2013 Nick Sutterer and the roar contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -558,10 +558,17 @@ Use the `:type` option to specify the conversion target. Note that `:default` st
 
 (Please don't read this section!)
 
-If you need a special binding for a property you're free to create it using the `:binding` option.
+* If you need a special binding for a property you're free to create it using the `:binding` option.
 
     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.
+
+    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
 
@@ -569,3 +576,5 @@ Representable started as a heavily simplified fork of the ROXML gem. Big thanks
 
 * Copyright (c) 2011-2013 Nick Sutterer <apotonick@gmail.com>
 * ROXML is Copyright (c) 2004-2009 Ben Woosley, Zak Mandhro and Anders Engstrom.
+
+Representable is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/representable/binding.rb

@@ -16,13 +16,14 @@ module Representable
       raise "Binding#definition is no longer supported as all Definition methods are now delegated automatically."
     end
 
-    def initialize(definition, represented, user_options={})  # TODO: remove default arg.
+    def initialize(definition, represented, user_options={}, lambda_context=represented)  # TODO: remove default arg for user options. # DISCUSS: make lambda_context an options hash?
       super(definition)
-      @represented  = represented
-      @user_options = user_options
+      @represented    = represented
+      @user_options   = user_options
+      @lambda_context = lambda_context
     end
 
-    attr_reader :user_options, :represented # TODO: make private/remove.
+    attr_reader :user_options, :represented, :lambda_context # TODO: make private/remove.
 
     # Main entry point for rendering/parsing a property object.
     def serialize(value)
@@ -89,7 +90,7 @@ module Representable
     # Execute the block for +option_name+ on the represented object.
     def represented_exec_for(option_name, *args)
       return unless options[option_name]
-      represented.instance_exec(*args+[user_options], &options[option_name])
+      lambda_context.instance_exec(*args+[user_options], &options[option_name])
     end
 
 

data/lib/representable/decorator.rb

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

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.4.0"
+  VERSION = "1.4.1"
 end

data/test/representable_test.rb

@@ -674,6 +674,45 @@ class RepresentableTest < MiniTest::Spec
       end
     end
 
+    describe ":representer_exec" do
+      representer! do
+        property :title, :getter => lambda { |*| title_from_representer }, :representer_exec => true
+      end
+
+      it "executes lambdas in represented context" do
+        Class.new do
+          def title_from_representer
+            "Sounds Of Silence"
+          end
+        end.new.extend(representer).to_hash.must_equal({"title"=>"Sounds Of Silence"})
+      end
+
+      describe "with decorator" do
+
+        it "executes lambdas in representer context" do
+          rpr = representer
+          Class.new(Representable::Decorator) do
+            include rpr
+
+            def title_from_representer
+              "Sounds Of Silence"
+            end
+          end.new(Object.new).to_hash().must_equal({"title"=>"Sounds Of Silence"})
+        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
+
+            def title
+              "Sounds Of Silence"
+            end
+          end.new(OpenStruct.new(:title => "Secret")).to_hash.must_equal({"title"=>"Secret"})
+        end
+      end
+    end
+
     describe "decorator" do
       # TODO: Move to global place since it's used twice.
       class SongRepresentation < Representable::Decorator

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -167,6 +167,7 @@ files:
 - .travis.yml
 - CHANGES.textile
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - TODO
@@ -225,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Maps representation documents from and to Ruby objects. Includes XML and