representable 1.1.5 → 1.1.6

data/CHANGES.textile

@@ -1,3 +1,7 @@
+h2. 1.1.6
+
+* Added @:if@ option to @property@.
+
 h2. 1.1.5
 
 * Definitions are now properly cloned when @Config@ is cloned.

data/README.rdoc

@@ -231,7 +231,7 @@ If your accessor name doesn't match the attribute name in the document, use the
   peter.to_json #=> {"i_am_called":"Peter","surename":"Pan"}
 
 
-=== Filtering
+=== Filtering and Conditions
 
 Representable allows you to skip and include properties when rendering or parsing.
 
@@ -240,6 +240,13 @@ Representable allows you to skip and include properties when rendering or parsin
 
 It gives you convenient +:exclude+ and +:include+ options.
 
+You can also define conditions on properties on the class layer.
+
+  module HeroRepresenter
+    property :friends, :if => lambda { forename == "Peter" }
+  end
+  
+  When rendering or parsing, the +friends+ property is considered only if the condition block evals to true. Note that the block is executed in instance context, giving you access to instance methods.
 
 == DCI
 

data/lib/representable.rb

@@ -67,11 +67,23 @@ private
   
   # 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 :except'ed
+    
+    skip_conditional_property?(binding)
+  end
+  
+  def skip_excluded_property?(binding, options)
     return unless props = options[:except] || options[:include]
-    res = props.include?(binding.definition.name.to_sym)
+    props = options[:except] || options[:include]
+    res   = props.include?(binding.definition.name.to_sym)
     options[:include] ? !res : res
   end
   
+  def skip_conditional_property?(binding)
+    return unless condition = binding.definition.options[:if]
+    not instance_exec(&condition)
+  end
+  
   # Retrieve value and write fragment to the doc.
   def compile_fragment(bin, doc)
     value = send(bin.definition.getter) || bin.definition.default # DISCUSS: eventually move back to Ref.

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.1.5"
+  VERSION = "1.1.6"
 end

data/test/representable_test.rb

@@ -154,15 +154,6 @@ class RepresentableTest < MiniTest::Spec
         assert_equal "friends", band.representable_attrs.last.from
       end
     end
-    
-    describe ":accessor" do
-      it "doesn't add methods when false" do
-        klass = Class.new(Band) { property :friends, :accessors => false }
-        band = klass.new
-        assert ! band.respond_to?(:friends)
-        assert ! band.respond_to?("friends=")
-      end
-    end
   end
   
   describe "#collection" do
@@ -253,6 +244,48 @@ class RepresentableTest < MiniTest::Spec
     it "always returns self" do
       assert_equal @band, @band.update_properties_from({"name"=>"Nofx"}, {}, Representable::JSON)
     end
+    
+    describe ":if" do
+      before do
+        @pop = Class.new(PopBand) { attr_accessor :fame }
+      end
+      
+      it "respects property when condition true" do
+        @pop.class_eval { property :fame, :if => lambda { true } }
+        band = @pop.new
+        band.update_properties_from({"fame"=>"oh yes"}, {}, Representable::JSON)
+        assert_equal "oh yes", band.fame
+      end
+      
+      it "ignores property when condition false" do
+        @pop.class_eval { property :fame, :if => lambda { false } }
+        band = @pop.new
+        band.update_properties_from({"fame"=>"oh yes"}, {}, Representable::JSON)
+        assert_equal nil, band.fame
+      end
+      
+      it "ignores property when :except'ed even when condition is true" do
+        @pop.class_eval { property :fame, :if => lambda { true } }
+        band = @pop.new
+        band.update_properties_from({"fame"=>"oh yes"}, {:except => [:fame]}, Representable::JSON)
+        assert_equal nil, band.fame
+      end
+      
+      
+      it "executes block in instance context" do
+        @pop.class_eval { property :fame, :if => lambda { groupies } }
+        band = @pop.new
+        band.groupies = true
+        band.update_properties_from({"fame"=>"oh yes"}, {}, Representable::JSON)
+        assert_equal "oh yes", band.fame
+      end
+      
+    end
+    
+    it "what" do
+      
+    end
+    
   end
   
   describe "#create_representation_with" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-03 00:00:00.000000000 Z
+date: 2012-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &72230170 !ruby/object:Gem::Requirement
+  requirement: &80957240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *72230170
+  version_requirements: *80957240
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &72229010 !ruby/object:Gem::Requirement
+  requirement: &80956630 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *72229010
+  version_requirements: *80956630
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &72228350 !ruby/object:Gem::Requirement
+  requirement: &80956310 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72228350
+  version_requirements: *80956310
 - !ruby/object:Gem::Dependency
   name: test_xml
-  requirement: &72227790 !ruby/object:Gem::Requirement
+  requirement: &80956090 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72227790
+  version_requirements: *80956090
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &72227360 !ruby/object:Gem::Requirement
+  requirement: &80955690 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 2.8.1
   type: :development
   prerelease: false
-  version_requirements: *72227360
+  version_requirements: *80955690
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &72226980 !ruby/object:Gem::Requirement
+  requirement: &80955390 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72226980
+  version_requirements: *80955390
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &72226580 !ruby/object:Gem::Requirement
+  requirement: &80955040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72226580
+  version_requirements: *80955040
 description: Maps representation documents from and to Ruby objects. Includes XML
   and JSON support, plain properties, collections and compositions.
 email: