rabl-rails 0.3.2 → 0.3.3

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## 0.3.3
+  * Add response caching
+
 ## 0.3.2
   * Using child with a nil value will be correctly formatted as nil
   * Allow controller's assigns to have symbol keys

data/README.md

@@ -1,4 +1,4 @@
-# RABL for Rails #
+# RABL for Rails [![Build Status](https://travis-ci.org/ccocchi/rabl-rails.png?branch=master)](https://travis-ci.org/ccocchi/rabl-rails)
 
 RABL (Ruby API Builder Language) is a ruby templating system for rendering resources in different format (JSON, XML, BSON, ...). You can find documentation [here](http://github.com/nesquena/rabl).
 
@@ -94,7 +94,7 @@ RablRails.configure do |config|
   # config.json_engine = :oj
   # config.xml_engine = 'LibXML'
   # config.use_custom_responder = false
-	# config.default_responder_template = 'show'
+  # config.default_responder_template = 'show'
   # config.enable_jsonp_callbacks = false
 end
 ```
@@ -285,7 +285,10 @@ You can find more informations about how to use this method in the [wiki](http:/
 
 ### Other features
 
-You can find more informations about other features (caching, custom_responder, ...) in the [WIKI](https://github.com/ccocchi/rabl-rails/wiki)
+* [Caching](https://github.com/ccocchi/rabl-rails/wiki/Caching)
+* [Custom responder](https://github.com/ccocchi/rabl-rails/wiki/Using-custom-responder)
+
+And more in the [WIKI](https://github.com/ccocchi/rabl-rails/wiki)
 
 ## Performance
 

data/lib/rabl-rails/compiler.rb

@@ -65,11 +65,12 @@ module RablRails
     def child(name_or_data, options = {})
       data, name = extract_data_and_name(name_or_data)
       name = options[:root] if options.has_key? :root
-      if options[:partial]
+
+      @template[name] = if options[:partial]
         template = Library.instance.compile_template_from_path(options[:partial])
-        @template[name] = template.merge!(:_data => data)
+        template.merge!(:_data => data)
       elsif block_given?
-        @template[name] = sub_compile(data) { yield }
+        sub_compile(data) { yield }
       end
     end
 
@@ -140,6 +141,10 @@ module RablRails
       @template[sequence('if')] = Condition.new(proc, sub_compile(nil) { yield })
     end
 
+    def cache(&block)
+      @template.cache_key = block_given? ? block : nil
+    end
+
     protected
 
     #

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

@@ -27,10 +27,13 @@ module RablRails
           end
         end
         collection_or_resource ||= @_resource
-        output_hash = collection_or_resource.respond_to?(:each) ? render_collection(collection_or_resource, template.source) :
-          render_resource(collection_or_resource, template.source)
-        _options[:root_name] = template.root_name
-        format_output(output_hash)
+
+        render_with_cache(template.cache_key, collection_or_resource) do
+          output_hash = collection_or_resource.respond_to?(:each) ? render_collection(collection_or_resource, template.source)
+                                                                  : render_resource(collection_or_resource, template.source)
+          _options[:root_name] = template.root_name
+          format_output(output_hash)
+        end
       end
 
       #
@@ -43,6 +46,16 @@ module RablRails
 
       protected
 
+      def render_with_cache(key, collection_or_resource, &block)
+        if !key.is_a?(FalseClass) && ActionController::Base.perform_caching
+          Rails.cache.fetch(resolve_cache_key(key, collection_or_resource)) do
+            yield
+          end
+        else
+          yield
+        end
+      end
+
       #
       # Render a single resource as a hash, according to the compiled
       # template source passed.
@@ -68,14 +81,7 @@ module RablRails
             instance_exec data, &(value.last)
           when Hash
             current_value = value.dup
-            data_symbol = current_value.delete(:_data)
-            object = if data_symbol == nil
-              data
-            else
-              data_symbol.to_s.start_with?('@') ? instance_variable_get(data_symbol)
-                                                : data.respond_to?(data_symbol) ? data.send(data_symbol)
-                                                                                : send(data_symbol)
-            end
+            object = object_from_data(data, current_value.delete(:_data))
 
             if key.to_s.start_with?('_') # glue
               output.merge!(render_resource(object, current_value))
@@ -133,6 +139,23 @@ module RablRails
         @_context.respond_to?(name) ? @_context.send(name, *args, &block) : super
       end
 
+      def resolve_cache_key(key, data)
+        return data.cache_key unless key
+        key.is_a?(Proc) ? instance_exec(data, &key) : key
+      end
+
+      private
+
+      def object_from_data(data, symbol)
+        return data if symbol == nil
+
+        if symbol.to_s.start_with?('@')
+          instance_variable_get(symbol)
+        else
+          data.respond_to?(symbol) ? data.send(symbol) : send(symbol)
+        end
+      end
+
       #
       # Copy assigns from controller's context into this
       # renderer context to include instances variables when

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

@@ -7,6 +7,10 @@ module RablRails
 
         RablRails.enable_jsonp_callbacks && params.has_key?(:callback) ? "#{params[:callback]}(#{json})" : json
       end
+
+      def resolve_cache_key(key, data)
+        "#{super}.json"
+      end
     end
   end
 end

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

@@ -6,6 +6,10 @@ module RablRails
         hash = { _options[:root_name] => hash } if _options[:root_name] && RablRails.include_plist_root
         RablRails.plist_engine.dump(hash)
       end
+
+      def resolve_cache_key(key, data)
+        "#{super}.plist"
+      end
     end
   end
 end

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

@@ -9,6 +9,10 @@ module RablRails
       	xml_options = { root: _options[:root_name] }.merge!(DEFAULT_OPTIONS)
 				hash.to_xml(xml_options)
       end
+
+      def resolve_cache_key(key, data)
+        "#{super}.xml"
+      end
     end
   end
 end

data/lib/rabl-rails/template.rb

@@ -1,11 +1,12 @@
 module RablRails
   class CompiledTemplate
-    attr_accessor :source, :data, :root_name
+    attr_accessor :source, :data, :root_name, :cache_key
 
     delegate :[], :[]=, :merge!, :to => :source
 
     def initialize
       @source = {}
+      @cache_key = false
     end
 
     def initialize_dup(other)

data/lib/rabl-rails/version.rb

@@ -1,3 +1,3 @@
 module RablRails
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/test/base_renderer_test.rb

@@ -15,7 +15,11 @@ class TestBaseRenderer < ActiveSupport::TestCase
     @context.assigns['data'] = @data
 
     @template = RablRails::CompiledTemplate.new
+    @template.source = {}
     @template.data = :@data
+
+    @cache = mock
+    Rails.stub(:cache).and_return(@cache)
   end
 
   def render_hash
@@ -29,7 +33,35 @@ class TestBaseRenderer < ActiveSupport::TestCase
 
   test "properly handle assigns with symbol keys" do
     @context.assigns[:foo] = 'bar'
-    @template.source = {}
     assert_nothing_raised { render_hash }
   end
+
+  test "cache should be applied if no cache key is given" do
+    @cache.should_not_receive(:fetch)
+    render_hash
+  end
+
+  test "cache should not be used if disabled in Rails configuration" do
+    ActionController::Base.stub(:perform_caching).and_return(false)
+    @cache.should_not_receive(:fetch)
+    @template.cache_key = 'something'
+    render_hash
+  end
+
+  test "cache shoud use #cache_key as default" do
+    ActionController::Base.stub(:perform_caching).and_return(true)
+    @data.stub(:cache_key).and_return('data_cache_key')
+    @cache.should_receive(:fetch).with('data_cache_key').and_return({ some: 'hash' })
+    @template.cache_key = nil
+
+    assert_equal({ some: 'hash' }, render_hash)
+  end
+
+  test "cache should use the proc if given" do
+    ActionController::Base.stub(:perform_caching).and_return(true)
+    @template.cache_key = ->(u) { 'proc_cache_key' }
+    @cache.should_receive(:fetch).with('proc_cache_key').and_return({ some: 'hash' })
+
+    assert_equal({ some: 'hash' }, render_hash)
+  end
 end

data/test/compiler_test.rb

@@ -58,6 +58,21 @@ class CompilerTest < ActiveSupport::TestCase
     assert_equal false, t.root_name
   end
 
+  test "template should not have a cache key if cache is not enable" do
+    t = @compiler.compile_source('')
+    assert_equal false, t.cache_key
+  end
+
+  test "cache can take no argument" do
+    t = @compiler.compile_source(%{ cache })
+    assert_nil t.cache_key
+  end
+
+  test "cache can take a block" do
+    t = @compiler.compile_source(%( cache { 'foo' }))
+    assert_instance_of Proc, t.cache_key
+  end
+
   # Compilation
 
   test "simple attributes are compiled to hash" do
@@ -152,6 +167,23 @@ class CompilerTest < ActiveSupport::TestCase
     assert_equal({ :id => :id }, t.source)
   end
 
+  test "extends should not overwrite nodes previously defined" do
+    skip('Bug reported by @abrisse')
+
+    template = mock('file_template', :source => %(condition(-> { true }) { 'foo' }))
+    lookup_context = mock
+    lookup_context.stub(:find_template).with('users/xtnd', [], false).and_return(template)
+    RablRails::Library.reset_instance
+    RablRails::Library.instance.instance_variable_set(:@lookup_context, lookup_context)
+
+    t = @compiler.compile_source(%{
+      condition(-> { false }) { 'bar' }
+      extends('users/xtnd')
+    })
+
+    assert_equal 2, t.source.keys.size
+  end
+
   test "node are compiled without evaluating the block" do
     t = @compiler.compile_source(%{ node(:foo) { bar } })
     assert_not_nil t.source[:foo]

data/test/renderers/json_renderer_test.rb

@@ -174,4 +174,16 @@ class TestJsonRenderer < ActiveSupport::TestCase
     @template.source = { :name => :name }
     assert_equal %q[some_callback({"name":"foobar"})], render_json_output
   end
+
+  test "cache key should be different from Base to avoid name collisions" do
+    ActionController::Base.stub(:perform_caching).and_return(true)
+    @data.stub(:cache_key).and_return('data_cache_key')
+    @template.cache_key = nil
+
+    @cache = mock
+    @cache.should_receive(:fetch).with('data_cache_key.json').and_return(%("some":"json"))
+    Rails.stub(:cache).and_return(@cache)
+
+    assert_equal %("some":"json"), render_json_output
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2013-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport