rabl-rails 0.3.0 → 0.3.1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 0.3.2 (unreleased)
+
+## 0.3.1
+  * Add `merge` keywork
+  * Format can be passed as a string or a symbol
+  * Avoid to unexpectedly change cached templates (johnbintz)
+  * Add full template stack support to `glue` (fnordfish)
+  * Allow format to be a symbol (lloydmeta)
+
 ## 0.3.0
   * Travis integration
   * Add test for keywords used as variable names

data/Gemfile

@@ -6,6 +6,9 @@ gem 'plist'
 
 platforms :ruby do
   gem 'oj'
+end
+
+platforms :mri do
   gem 'libxml-ruby'
 end
 

data/README.md

@@ -165,7 +165,8 @@ attributes title: :foo, to_s: :bar
 
 ### Child nodes
 
-You can include nested information from data associated with the parent model. You can also alias these associations.
+You can include informations from data associated with the parent model or arbitrary data. These informations can be grouped under a node or directly merged into current node.
+
 For example if you have a `Post` model that belongs to a `User`
 
 ```ruby
@@ -183,9 +184,19 @@ child(:@users) do
 end
 ```
 
+If you want to merge directly into current node, you can use the `glue` keywork
+
+```ruby
+attribute :title
+glue(:user) do
+  attributes :name => :author_name
+end
+# => { "post" : { "title" : "Foo", "author_name" : "John D." } }
+```
+
 ### Custom nodes
 
-You can create custom node in your response, based on the result of the given block
+You can create custom node in your response, based on the result of the given block.
 
 ```ruby
 object :@user
@@ -193,7 +204,7 @@ node(:full_name) { |u| u.first_name + " " + u.last_name }
 # => { "user" : { "full_name" : "John Doe" } }
 ```
 
-You can add the node only if a condition is true
+You can add condition on your custom nodes (if the condition is evaluated to false, the node will not be included).
 
 ```ruby
 node(:email, if: -> { |u| u.valid_email? }) do |u|
@@ -207,6 +218,14 @@ Nodes are evaluated at the rendering time, so you can use any instance variables
 node(:url) { |post| post_url(post) }
 ```
 
+If you want to include directly the result into the current node, use the `merge` keyword (result returned from the block should be a hash)
+
+```ruby
+object :@user
+merge { |u| { name: u.first_name + " " + u.last_name } }
+# => { "user" : { "name" : "John Doe" } }
+```
+
 Custom nodes are really usefull to create flexible representations of your resources.
 
 ### Extends & Partials

data/lib/rabl-rails/compiler.rb

@@ -5,7 +5,7 @@ module RablRails
   #
   class Compiler
     def initialize
-      @i = 0
+      @i = -1
     end
 
     #
@@ -80,9 +80,7 @@ module RablRails
     #
     def glue(data)
       return unless block_given?
-      name = :"_glue#{@i}"
-      @i += 1
-      @template[name] = sub_compile(data) { yield }
+      @template[sequence('glue')] = sub_compile(data) { yield }
     end
 
     #
@@ -93,7 +91,8 @@ module RablRails
     #   node(:name) { |user| user.first_name + user.last_name }
     #   node(:role, if: ->(u) { !u.admin? }) { |u| u.role }
     #
-    def node(name, options = {}, &block)
+    def node(name = nil, options = {}, &block)
+      name ||= sequence('merge')
       condition = options[:if]
 
       if condition
@@ -108,6 +107,17 @@ module RablRails
     end
     alias_method :code, :node
 
+    #
+    # Merge arbitrary data into json output. Given block should
+    # return a hash.
+    # Example:
+    #   merge { |item| partial("specific/#{item.to_s}", object: item) }
+    #
+    def merge(&block)
+      return unless block_given?
+      node(sequence('merge'), &block)
+    end
+
     #
     # Extends an existing rabl template
     # Example:
@@ -127,13 +137,19 @@ module RablRails
     #
     def condition(proc)
       return unless block_given?
-      name = :"_if#{@i}"
-      @i += 1
-      @template[name] = Condition.new(proc, sub_compile(nil) { yield })
+      @template[sequence('if')] = Condition.new(proc, sub_compile(nil) { yield })
     end
 
     protected
 
+    #
+    # Return unique symbol starting with given name
+    #
+    def sequence(name)
+      @i += 1
+      :"_#{name}#{@i}"
+    end
+
     #
     # Extract data root_name and root name
     # Example:

data/lib/rabl-rails/library.rb

@@ -14,21 +14,23 @@ module RablRails
 
       compiled_template = compile_template_from_source(source, path)
 
-      format = context.params[:format] || 'json'
-      Renderers.const_get(format.upcase!).new(context, locals).render(compiled_template)
+      format = context.params[:format] ? context.params[:format].to_s : 'json'
+      format.upcase!
+      Renderers.const_get(format).new(context, locals).render(compiled_template)
     end
 
     def compile_template_from_source(source, path = nil)
       if path && RablRails.cache_templates?
         @cached_templates[path] ||= Compiler.new.compile_source(source)
+        @cached_templates[path].dup
       else
         Compiler.new.compile_source(source)
       end
     end
 
     def compile_template_from_path(path)
-      template = @cached_templates[path]
-      return template if template
+      return @cached_templates[path].dup if @cached_templates.has_key?(path)
+      
       t = @lookup_context.find_template(path, [], false)
       compile_template_from_source(t.source, path)
     end

data/lib/rabl-rails/renderer.rb

@@ -15,7 +15,7 @@ module RablRails
 
       def initialize(view_path, format)
         @view_path = view_path || RablRails::Renderer.view_path
-        @format = format
+        @format = format.to_s.downcase
       end
 
       #

data/lib/rabl-rails/renderers/base.rb

@@ -54,7 +54,15 @@ module RablRails
           when Symbol
             data.send(value) # attributes
           when Proc
-            instance_exec data, &value # node
+            result = instance_exec data, &value
+
+            if key.to_s.start_with?('_') # merge
+              raise PartialError, '`merge` block should return a hash' unless result.is_a?(Hash) 
+              output.merge!(result)
+              next output
+            else # node
+               result
+            end
           when Array # node with condition
             next output if !instance_exec data, &(value.first)
             instance_exec data, &(value.last)
@@ -70,9 +78,7 @@ module RablRails
             end
 
             if key.to_s.start_with?('_') # glue
-              current_value.each_pair { |k, v|
-                output[k] = object.send(v)
-              }
+              output.merge!(render_resource(object, current_value))
               next output
             else # child
               object.respond_to?(:each) ? render_collection(object, current_value) : render_resource(object, current_value)

data/lib/rabl-rails/template.rb

@@ -7,5 +7,10 @@ module RablRails
     def initialize
       @source = {}
     end
+
+    def initialize_dup(other)
+      super
+      self.source = other.source.dup
+    end
   end
 end

data/lib/rabl-rails/version.rb

@@ -1,3 +1,3 @@
 module RablRails
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/test/cache_templates_test.rb

@@ -18,10 +18,11 @@ class CacheTemplatesTest < ActiveSupport::TestCase
 
   test "cached templates should not be modifiable in place" do
     ActionController::Base.stub(:perform_caching).and_return(true)
-    @library.compile_template_from_source('', 'some/path')
-    t = @library.compile_template_from_source("attribute :id", 'some/path')
+    t = @library.compile_template_from_source('', 'some/path')
 
-    assert_equal({}, t.source)
+    t.merge!(:_data => :foo)
+
+    assert_equal({}, @library.compile_template_from_path('some/path').source)
   end
 
   test "don't cache templates cache_templates is enabled but perform_caching is not active" do

data/test/compiler_test.rb

@@ -112,7 +112,7 @@ class CompilerTest < ActiveSupport::TestCase
     RablRails::Library.instance.stub(:compile_template_from_path).with('users/base').and_return(mock_template)
 
     t = @compiler.compile_source(%{child(:user, :partial => 'users/base') })
-    assert_equal( {:user => { :_data => :user, :id => :id } }, t.source)
+    assert_equal({:user => { :_data => :user, :id => :id } }, t.source)
   end
 
   test "glue is compiled as a child but with anonymous name" do
@@ -132,6 +132,18 @@ class CompilerTest < ActiveSupport::TestCase
     }, t.source)
   end
 
+  test "glue accepts all dsl in its body" do
+    t = @compiler.compile_source(%{
+      glue :@user do node(:foo) { |u| u.name } end
+    })
+
+    assert_not_nil(t.source[:_glue0])
+    s = t.source[:_glue0]
+
+    assert_equal(:@user, s[:_data])
+    assert_instance_of(Proc, s[:foo])
+  end
+
   test "extends use other template source as itself" do
     template = mock('template', :source => { :id => :id })
     RablRails::Library.reset_instance
@@ -153,6 +165,16 @@ class CompilerTest < ActiveSupport::TestCase
     assert_equal 2, t.source[:foo].size
   end
 
+  test "node can take no arguments and behave like a merge" do
+    t = @compiler.compile_source(%{ node do |m| m.foo end })
+    assert_instance_of Proc, t.source[:_merge0]
+  end
+
+  test "merge compile like a node but with a reserved keyword as name" do
+    t = @compiler.compile_source(%{ merge do |m| m.foo end })
+    assert_instance_of Proc, t.source[:_merge0]
+  end
+
   test "conditionnal block compile nicely" do
     t = @compiler.compile_source(%{ condition(->(u) {}) do attributes :secret end })
     assert_instance_of RablRails::Condition, t.source[:_if0]

data/test/render_test.rb

@@ -60,4 +60,17 @@ class RenderTest < ActiveSupport::TestCase
     assert_equal %q({"user":{"extended_name":"Marty"}}), RablRails.render(@user, 'extend', view_path: @tmp_path)
   end
 
+  test "format can be passed as symbol or a string" do
+    File.open(@tmp_path + "show.json.rabl", "w") do |f|
+      f.puts %q{
+        object :@user
+        attributes :id, :name
+      }
+    end
+
+    assert_equal %q({"user":{"id":1,"name":"Marty"}}), RablRails.render(@user, 'show', view_path: @tmp_path, format: :json)
+    assert_equal %q({"user":{"id":1,"name":"Marty"}}), RablRails.render(@user, 'show', view_path: @tmp_path, format: 'json')
+    assert_equal %q({"user":{"id":1,"name":"Marty"}}), RablRails.render(@user, 'show', view_path: @tmp_path, format: 'JSON')
+  end
+
 end

data/test/renderers/json_renderer_test.rb

@@ -61,6 +61,11 @@ class TestJsonRenderer < ActiveSupport::TestCase
     assert_equal %q({"name":"foobar"}), render_json_output
   end
 
+  test "render glued node" do
+    @template.source = { :_glue0 => { :_data => :@data, :foo => lambda { |u| u.name } } }
+    assert_equal(%q({"foo":"foobar"}), render_json_output)
+  end
+
   test "render collection with attributes" do
     @data = [User.new(1, 'foo', 'male'), User.new(2, 'bar', 'female')]
     @context.assigns['data'] = @data
@@ -152,4 +157,14 @@ class TestJsonRenderer < ActiveSupport::TestCase
     @template.source = { :id => :id, :name => :name }
     assert_equal %q({"id":1,"name":"foobar"}), render_json_output
   end
+
+  test "merge should raise is return from given block is not a hash" do
+    @template.source = { :_merge0 => ->(c) { 'foo' } }
+    assert_raises(RablRails::Renderers::PartialError) { render_json_output }
+  end
+
+  test "result from merge is merge inside current response" do
+    @template.source = { :_merge0 => ->(c) { { :custom => c.name } } }
+    assert_equal %q({"custom":"foobar"}), render_json_output
+  end
 end

data/test/test_helper.rb

@@ -26,7 +26,7 @@ require 'plist'
 
 if RUBY_ENGINE == 'jruby'
   require 'nokogiri'
-else
+elsif RUBY_ENGINE == 'ruby'
   require 'libxml'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-14 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Fast Rails 3+ templating system with JSON and XML support