rabl 0.9.0 → 0.9.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWZjOGQ4ZGRlYmFiMDBhNmZjODdjZDcyZTM3ZjBjNWQ3ODBjYjAzYQ==
+    ZjAzMDNhYTIyNjk1OTg1YjE5N2NiNzNhYThmMGIyMTQzY2Y2MTk1NA==
   data.tar.gz: !binary |-
-    MjM1ZjE1YWJjZGQzYTk5YmU1N2UxYTU2YTM0ODRmNDU0NDcxMzgxMA==
+    NzI2ZGQ3MDQ0ZjY0NDk5NTFjZmRhZmJkYjEzMjNiYjMzMWM1N2MzNw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MjhiYTM0M2E1ZGE4OWM5ZDA5OTg4OTg4MzdkNDk3NjZkMmU2NDgwY2E2YWMy
-    NWQ3NjE2MzA4OTc1NTVhY2JkMTQwNTAxNmI1MzA3ZWQzMDVmMTczNjBjYWZl
-    MjUyM2Q1NWJjMGNhYmFhM2FiMzIyOWM3YjJlNWVjMjcyOGQzNDk=
+    OWViYTRkNWFjZTQ1MWU2NWRlMTUwNTlkNzQ5NzBkNjQyZGJlZjQ3OGU5Yjcy
+    NzhkNWE5YTM0MmYzMTEzZDE0OWIxN2E0YzYzOTUwNzg4OTQ5MDNmYjhmMDI3
+    YWUxMjNmZTIyZjE2NGRmMzE4N2VhYmYxYmI0YmJiMWM1MGMzYmQ=
   data.tar.gz: !binary |-
-    MjI5ZGFiOGE1OTBkOGUyNmMzMTllMDM2MDhmMWVjZmVjOTMzOTg4ZWFhMzE5
-    ZjU0ZDgxNjYwNDU3NWI3NjliYTYwZmNiMTAzMDhhNGZmZmM5OGYyNDg1NDg5
-    ZTA3MmZlYTdkNDI1NWNhODhhN2E5Yjk2ZjUzOGNkYTQ5MjYyZTI=
+    OTRiYTVjMTkxZTVkOWNmMGI4MjgyYTA2MTcwNzcxOGZlMzdkYjAwZGNjZGI3
+    NDEyYjRlMTM0MGI0YWI0ZjhhMWM4ZDhjYjI0ZGIxNjlhZmQxNDlkZDljYjgz
+    NzcwOGM0OThiZDI4ODFjZTc5ZDkwM2FjZWVjNTU2MDU4NDdjNmQ=

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.9.1 (November 17 2013)
+
+* NEW #507 Resolve conditionals for extends (Thanks @micahcraig)
+* NEW #453 Support for symbol conditionals (Thanks @leoc)
+
 ## 0.9.0 (October 14 2013)
 
 * FIX #497 Renderer should support partial caching and a digestor bug fixed (Thanks @siong1987)

data/README.md

@@ -364,15 +364,6 @@ node :full_name do |u|
 end
 ```
 
-or a custom node that exists only if a condition is true:
-
-```ruby
-# m is the object being rendered, also supports :unless
-node(:foo, :if => lambda { |m| m.has_foo? }) do |m|
-  m.foo
-end
-```
-
 or don't pass a name and have the node block merged into the response:
 
 ```ruby
@@ -460,6 +451,45 @@ node(:comments) { |post| post.comments } unless locals[:hide_comments]
 
 This can be useful as an advanced tool when extending or rendering partials.
 
+### Conditions ###
+
+You can provide conditions to all kinds of nodes, attributes, extends, etc. which includes a given element only if the specified condition is true.
+
+```ruby
+collection @posts
+# m is the object being rendered, also supports :unless
+node(:coolness, :if => lambda { |m| m.coolness > 5 }) do |m|
+  m.coolness
+end
+```
+
+Because attributes take conditional options as well, we could simplify the example with:
+
+```ruby
+collection @posts
+# m is the object being rendered, also supports :unless
+attribute(:coolness, :if => lambda { |m| m.coolness > 5 })
+```
+
+The value for the `:if` and `:unless` options may be a simple `Boolean`, `Proc` or a `Symbol`. If it is a `Symbol` and the specific `@object` responds to its, the method will be called. Thus the example above can be rewritten as:
+
+```ruby
+class Post
+  def cool?
+    coolness > 5
+  end
+end
+```
+
+and then:
+
+```ruby
+collection @posts
+attribute :coolness, if: :cool?
+```
+
+Using conditions allows for easy control over when certain elements render.
+
 ### Template Scope ###
 
 In RABL, you have access to everything you need to build an API response. Each RABL template has full access to the controllers
@@ -667,5 +697,5 @@ Thanks again for all of these great projects.
 
 ## Copyright ##
 
-Copyright © 2011-2012 Nathan Esquenazi. See [MIT-LICENSE](https://github.com/nesquena/rabl/blob/master/MIT-LICENSE) for details.
+Copyright © 2011-2013 Nathan Esquenazi. See [MIT-LICENSE](https://github.com/nesquena/rabl/blob/master/MIT-LICENSE) for details.
 

data/lib/rabl/builder.rb

@@ -120,18 +120,35 @@ module Rabl
     # Extends an existing rabl template with additional attributes in the block
     # extends("users/show") { attribute :full_name }
     def extends(file, options={}, &block)
+      return unless resolve_condition(options)
       options = @options.slice(:child_root).merge(:object => @_object).merge(options)
       result = self.partial(file, options, &block)
       @_result.merge!(result) if result.is_a?(Hash)
     end
 
+    def call_condition_proc(condition, object, &blk)
+      blk = lambda { |v| v } unless block_given?
+      if condition.respond_to?(:call)
+        blk.call(condition.call(object))
+      elsif condition.is_a?(Symbol) && object.respond_to?(condition)
+        blk.call(object.send(condition))
+      else
+        false
+      end
+    end
+
     # resolve_condition(:if => true) => true
     # resolve_condition(:if => lambda { |m| false }) => false
     # resolve_condition(:unless => lambda { |m| true }) => true
     def resolve_condition(options)
       return true if options[:if].nil? && options[:unless].nil?
-      result = options[:if] == true || (options[:if].respond_to?(:call) && options[:if].call(@_object)) if options.has_key?(:if)
-      result = options[:unless] == false || (options[:unless].respond_to?(:call) && !options[:unless].call(@_object)) if options.has_key?(:unless)
+      result = nil
+      if options.has_key?(:if)
+        result = options[:if] == true || call_condition_proc(options[:if], @_object)
+      end
+      if options.has_key?(:unless)
+        result = options[:unless] == false || call_condition_proc(options[:unless], @_object, &:!)
+      end
       result
     end
 

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/test/builder_test.rb

@@ -180,4 +180,40 @@ context "Rabl::Builder" do
       b.build(false)
     end.equivalent_to({:user => 'xyz'})
   end
+
+  context "#resolve_conditionals" do
+    class ArbObj
+      def cool?
+        false
+      end
+
+      def smooth?
+        true
+      end
+    end
+
+    asserts "that it can use symbols on if condition and return false if method returns false" do
+      scope = Rabl::Builder.new
+      scope.instance_variable_set(:@_object, ArbObj.new)
+      scope.send(:resolve_condition, { :if => :cool? })
+    end.equals(false)
+
+    asserts "that it can use symbols on if condition and return true if method returns true" do
+      scope = Rabl::Builder.new
+      scope.instance_variable_set(:@_object, ArbObj.new)
+      scope.send :resolve_condition, { :if => :smooth? }
+    end.equals(true)
+
+    asserts "that it can use symbols as unless condition and return true if method returns false" do
+      scope = Rabl::Builder.new
+      scope.instance_variable_set(:@_object, ArbObj.new)
+      scope.send :resolve_condition, { :unless => :cool? }
+    end.equals(true)
+
+    asserts "that it can use symbols as unmless condition and return false if method returns true" do
+      scope = Rabl::Builder.new
+      scope.instance_variable_set(:@_object, ArbObj.new)
+      scope.send :resolve_condition, { :unless => :smooth? }
+    end.equals(false)
+  end
 end

data/test/engine_test.rb

@@ -680,6 +680,42 @@ context "Rabl::Engine" do
       end.equals JSON.parse("{\"name\":\"leo\"}")
     end
 
+    context "#extends" do
+      helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
+      setup do
+        Rabl.configure do |config|
+          config.view_paths = tmp_path
+        end
+        File.open(tmp_path + "test.json.rabl", "w") do |f|
+          f.puts %q{
+            attributes :age
+          }
+        end
+      end
+
+      asserts "that it extends the template with attributes from the file" do
+        template = rabl %{
+          object @user
+          attribute :name
+          extends 'test'
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :age => 12)
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"name\":\"leo\",\"age\":12}")
+
+      asserts "that it can be passed conditionals" do
+        template = rabl %{
+          object @user
+          attribute :name
+          extends('test', {:if => lambda { |i| false }})
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :age => 12)
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"name\":\"leo\"}")
+    end
+
     teardown do
       Rabl.reset_configuration!
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Nathan Esquenazi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2013-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport