representable 1.3.2 → 1.3.3

data/.travis.yml

@@ -3,7 +3,4 @@ notifications:
 matrix:
   include:
     - rvm: 1.9.3
-      gemfile: gemfiles/Gemfile.mongoid-2.4
-    - rvm: 1.9.3
-      gemfile: Gemfile
-    
+

data/CHANGES.textile

@@ -1,3 +1,8 @@
+h2. 1.3.3
+
+* Added new options: `:binding`, `:setter` and `:getter`.
+* The `:if` option now eventually receives passed in user options.
+
 h2. 1.3.2
 
 * Some minor internal changes. Added `Config#inherit` to encasulate array push behavior. 

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 

data/README.md

@@ -172,6 +172,34 @@ For XML we just include the `Representable::XML` module.
           <composers>Sting</composers>
         </song>
 
+## Passing Options
+
+You're free to pass an options hash into the rendering or parsing.
+
+    song.to_json(:append => "SOLD OUT!")
+
+If you want to append the "SOLD OUT!" to the song's `title` when rendering, use the `:getter` option.
+
+    SongRepresenter
+      include Representable::JSON
+
+      property :title, :getter => lambda { |args| title + args[:append] }
+    end
+
+Note that the block is executed in the represented model context which allows using accessors and instance variables.
+
+
+The same works for parsing using the `:setter` method.
+
+    property :title, :setter => lambda { |val, args| self.title= val + args[:append] }
+
+Here, the block retrieves two arguments: the parsed value and your user options.
+
+You can also use the `:getter` option instead of writing a reader method. Even when you're not interested in user options you can still use this technique.
+
+    property :title, :getter => lambda { |*| @name }
+
+This hash will also be available in the `:if` block, documented [here](https://github.com/apotonick/representable/#conditions) and will be passed to nested objects.
 
 ## Using Helpers
 
@@ -417,7 +445,6 @@ I do not recommend this approach as it bloats your domain classes with represent
 
 Here's a quick overview about other available options for `#property` and its bro `#collection`.
 
-
 ### Read/Write Restrictions
 
 Using the `:readable` and `:writeable` options access to properties can be restricted.
@@ -448,6 +475,14 @@ You can also define conditions on properties using `:if`, making them being cons
   
 When rendering or parsing, the `track` property is considered only if track is valid. Note that the block is executed in instance context, giving you access to instance methods.
 
+As always, the block retrieves your options. Given this render call
+
+    song.to_json(minimum_track: 2)
+
+your `:if` may process the options.
+
+    property :track, if: lambda { |opts| track > opts[:minimum_track] }
+
 
 ### False and Nil Values
 
@@ -476,6 +511,15 @@ Use the `:type` option to specify the conversion target. Note that `:default` st
     end
 
 
+## Undocumented Features
+
+(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.
+
+    property :title, :binding => lambda { |*args| JSON::TitleBinding.new(*args) }
+
+
 ## Copyright
 
 Representable started as a heavily simplified fork of the ROXML gem. Big thanks to Ben Woosley for his inspiring work.

data/Rakefile

@@ -1,6 +1,4 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
+require 'bundler/setup'
 require 'rake/testtask'
 
 desc 'Test the representable gem.'
@@ -11,3 +9,9 @@ Rake::TestTask.new(:test) do |test|
   test.test_files = FileList['test/*_test.rb']
   test.verbose = true
 end
+
+Rake::TestTask.new(:test18) do |test|
+  test.libs << 'test'
+  test.test_files = FileList['test/*_test.rb'] - ['test/mongoid_test.rb', 'test/yaml_test.rb']
+  test.verbose = true
+end

data/TODO

@@ -14,4 +14,4 @@ document `XML::AttributeHash` etc
 
 * Song < OpenStruct in test_helper
 
-* have representable-options (:include, :exclude) and user-options 
+* have representable-options (:include, :exclude) and user-options

data/lib/representable.rb

@@ -81,13 +81,18 @@ private
   end
   
   def skip_conditional_property?(binding)
+    # TODO: move to Binding.
     return unless condition = binding.options[:if]
-    not instance_exec(&condition)
+
+    args = []
+    args << binding.user_options if condition.arity > 0 # TODO: remove arity check. users should know whether they pass options or not.
+
+    not instance_exec(*args, &condition)
   end
   
   # Retrieve value and write fragment to the doc.
   def compile_fragment(bin, doc)
-    value = send(bin.getter)
+    value = bin.get
     
     bin.write_fragment(doc, value)
   end
@@ -95,17 +100,17 @@ private
   # Parse value from doc and update the model property.
   def uncompile_fragment(bin, doc)
     bin.read_fragment(doc) do |value|
-      send(bin.setter, value)
+      bin.set(value)
     end
   end
-  
+
   def representable_attrs
     @representable_attrs ||= self.class.representable_attrs # DISCUSS: copy, or better not?
   end
   
   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) }
+    representable_attrs.map {|attr| format.build(attr, self, options) }
   end
   
   # Returns the wrapper for the representation. Mostly used in XML.

data/lib/representable/binding.rb

@@ -5,6 +5,12 @@ module Representable
   class Binding < SimpleDelegator
     class FragmentNotFound
     end
+
+    def self.build(definition, *args)
+      # DISCUSS: move #create_binding to this class?
+      return definition.create_binding(*args) if definition.binding
+      build_for(definition, *args)
+    end
     
     def definition  # TODO: remove in 1.4.
       raise "Binding#definition is no longer supported as all Definition methods are now delegated automatically."
@@ -15,6 +21,8 @@ module Representable
       @represented  = represented
       @user_options = user_options
     end
+
+    attr_reader :user_options, :represented # TODO: make private/remove.
     
     # Main entry point for rendering/parsing a property object.
     def serialize(value)
@@ -51,6 +59,16 @@ module Representable
     def read_fragment_for(doc)
       read(doc)
     end
+
+    def get
+      return represented.instance_exec(user_options, &options[:getter]) if options[:getter]
+      represented.send(getter)
+    end
+
+    def set(value)
+      value = represented.instance_exec(value, user_options, &options[:setter]) if options[:setter]
+      represented.send(setter, value)
+    end
     
     
     # Hooks into #serialize and #deserialize to extend typed properties

data/lib/representable/bindings/yaml_bindings.rb

@@ -57,4 +57,4 @@ module Representable
       end
     end
   end
-end
+end

data/lib/representable/definition.rb

@@ -63,5 +63,13 @@ module Representable
     def default
       options[:default]
     end
+
+    def binding
+      options[:binding]
+    end
+
+    def create_binding(*args)
+      binding.call(self, *args)
+    end
   end
 end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

data/representable.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "test_xml"
   s.add_development_dependency "minitest", ">= 2.8.1"
-  s.add_development_dependency "mocha"
+  s.add_development_dependency "mocha", ">= 0.13.0"
   s.add_development_dependency "mongoid"
   s.add_development_dependency "virtus", "~> 0.5.0"
 end

data/test/definition_test.rb

@@ -181,6 +181,23 @@ class DefinitionTest < MiniTest::Spec
 
   end
 
+  describe "#binding" do
+    it "returns true when :binding is set" do
+      assert Representable::Definition.new(:songs, :binding => Object).binding
+    end
+
+    it "returns false when :binding is not set" do
+      assert !Representable::Definition.new(:songs).binding
+    end
+  end
+
+  describe "#create_binding" do
+    it "executes the block (without special context)" do
+      definition = Representable::Definition.new(:title, :binding => lambda { |*args| @binding = Representable::Binding.new(*args) })
+      definition.create_binding(object=Object.new).must_equal @binding
+      @binding.instance_variable_get(:@represented).must_equal object
+    end
+  end
 
   describe ":collection => true" do
     before do
@@ -232,4 +249,14 @@ class DefinitionTest < MiniTest::Spec
       assert ! Representable::Definition.new(:songs).hash?
     end
   end
+
+  describe ":binding => Object" do
+    subject do
+      Representable::Definition.new(:songs, :binding => Object)
+    end
+
+    it "responds to #binding" do
+      assert_equal subject.binding, Object
+    end
+  end
 end

data/test/representable_test.rb

@@ -444,7 +444,6 @@ class RepresentableTest < MiniTest::Spec
       assert_equal nil, band.fame
     end
     
-    
     it "executes block in instance context" do
       @pop.class_eval { property :fame, :if => lambda { groupies } }
       band = @pop.new
@@ -452,6 +451,39 @@ class RepresentableTest < MiniTest::Spec
       band.update_properties_from({"fame"=>"oh yes"}, {}, Representable::Hash::PropertyBinding)
       assert_equal "oh yes", band.fame
     end
+
+    describe "propagating user options to the block" do
+      representer! do
+        property :name, :if => lambda { |opts| opts[:include_name] }
+      end
+      subject { OpenStruct.new(:name => "Outbound").extend(representer) }
+
+      it "works without specifying options" do
+        subject.to_hash.must_equal({})
+      end
+
+      it "passes user options to block" do
+        subject.to_hash(:include_name => true).must_equal({"name" => "Outbound"})
+      end
+    end
+  end
+
+  describe ":getter and :setter" do
+    representer! do
+      property :name, 
+        :getter => lambda { |args| "#{args[:welcome]} #{name}" }, 
+        :setter => lambda { |val, args| self.name = "#{args[:welcome]} #{val}" }
+    end
+
+    subject { OpenStruct.new(:name => "Mony Mony").extend(representer) }
+
+    it "uses :getter when rendering" do
+      subject.to_hash(:welcome => "Hi").must_equal({"name" => "Hi Mony Mony"})
+    end
+
+    it "uses :setter when parsing" do
+      subject.from_hash({"name" => "Eyes Without A Face"}, :welcome => "Hello").name.must_equal "Hello Eyes Without A Face"
+    end
   end
 
   describe ":extend and :class" do
@@ -567,6 +599,21 @@ class RepresentableTest < MiniTest::Spec
         end
       end
     end
+
+    describe ":binding" do
+      representer! do
+        class MyBinding < Representable::Binding
+          def write(doc, *args)
+            doc[:title] = @represented.title
+          end
+        end
+        property :title, :binding => lambda { |*args| MyBinding.new(*args) }
+      end
+
+      it "uses the specified binding instance" do
+        OpenStruct.new(:title => "Affliction").extend(representer).to_hash.must_equal({:title => "Affliction"})
+      end
+    end
     
   end
   

data/test/test_helper.rb

@@ -1,7 +1,3 @@
-require 'bundler'
-Bundler.setup
-
-gem 'minitest'
 require 'representable'
 require 'representable/json'
 require 'representable/xml'
@@ -9,7 +5,7 @@ require 'test/unit'
 require 'minitest/spec'
 require 'minitest/autorun'
 require 'test_xml/mini_test'
-require 'mocha'
+require 'mocha/setup'
 
 class Album
   attr_accessor :songs, :best_song

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2013-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -98,7 +98,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -154,7 +154,6 @@ files:
 - README.md
 - Rakefile
 - TODO
-- gemfiles/Gemfile.mongoid-2.4
 - lib/representable.rb
 - lib/representable/binding.rb
 - lib/representable/bindings/hash_bindings.rb

data/gemfiles/Gemfile.mongoid-2.4

@@ -1,6 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in roar-rails.gemspec
-gemspec :path => '../'
-
-gem 'mongoid', '~> 2.4.0'