jbuilder_cache_multi 0.0.3 → 0.1.0

data/gemfiles/rails_4.1.0_jbuilder_2.0.0.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "mocha", :require => false
+gem "appraisal"
+gem "test-unit"
+gem "railties", "~> 4.1.0"
+gem "actionpack", "~> 4.1.0"
+gem "jbuilder", "~> 2.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.0_jbuilder_2.0.0.gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: ..
+  specs:
+    jbuilder_cache_multi (0.0.3)
+      jbuilder (>= 1.5.0, < 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.13)
+      actionview (= 4.1.13)
+      activesupport (= 4.1.13)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.13)
+      activesupport (= 4.1.13)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activesupport (4.1.13)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.2)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    jbuilder (2.0.8)
+      activesupport (>= 3.0.0, < 5)
+      multi_json (~> 1.2)
+    json (1.8.3)
+    metaclass (0.0.4)
+    minitest (5.8.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.11.2)
+    power_assert (0.2.2)
+    rack (1.5.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    railties (4.1.13)
+      actionpack (= 4.1.13)
+      activesupport (= 4.1.13)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    test-unit (3.0.8)
+      power_assert
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 4.1.0)
+  appraisal
+  jbuilder (~> 2.0.0)
+  jbuilder_cache_multi!
+  mocha
+  railties (~> 4.1.0)
+  rake
+  test-unit
+
+BUNDLED WITH
+   1.14.6

data/gemfiles/rails_5.0.0_jbuilder_1.5.0.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "mocha", :require => false
+gem "appraisal"
+gem "test-unit"
+gem "railties", "~> 5.0.0"
+gem "actionpack", "~> 5.0.0"
+gem "jbuilder", "~> 1.5.0"
+
+gemspec :path => "../"

data/gemfiles/rails_5.0.0_jbuilder_1.5.0.gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: ..
+  specs:
+    jbuilder_cache_multi (0.0.3)
+      jbuilder (>= 1.5.0, < 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    erubis (2.7.0)
+    i18n (0.8.1)
+    jbuilder (1.5.3)
+      activesupport (>= 3.0.0)
+      multi_json (>= 1.2.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    mocha (1.2.1)
+      metaclass (~> 0.0.1)
+    multi_json (1.12.1)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    power_assert (1.0.2)
+    rack (2.0.2)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    test-unit (3.2.3)
+      power_assert
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 5.0.0)
+  appraisal
+  jbuilder (~> 1.5.0)
+  jbuilder_cache_multi!
+  mocha
+  railties (~> 5.0.0)
+  rake
+  test-unit
+
+BUNDLED WITH
+   1.14.6

data/gemfiles/rails_5.0.0_jbuilder_2.0.0.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "mocha", :require => false
+gem "appraisal"
+gem "test-unit"
+gem "railties", "~> 5.0.0"
+gem "actionpack", "~> 5.0.0"
+gem "jbuilder", "~> 2.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_5.0.0_jbuilder_2.0.0.gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: ..
+  specs:
+    jbuilder_cache_multi (0.0.3)
+      jbuilder (>= 1.5.0, < 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    erubis (2.7.0)
+    i18n (0.8.1)
+    jbuilder (2.0.5)
+      activesupport (>= 3.0.0)
+      multi_json (>= 1.2.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    mocha (1.2.1)
+      metaclass (~> 0.0.1)
+    multi_json (1.12.1)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    power_assert (1.0.2)
+    rack (2.0.2)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    test-unit (3.2.3)
+      power_assert
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 5.0.0)
+  appraisal
+  jbuilder (~> 2.0.0)
+  jbuilder_cache_multi!
+  mocha
+  railties (~> 5.0.0)
+  rake
+  test-unit
+
+BUNDLED WITH
+   1.14.6

data/lib/jbuilder_cache_multi/jbuilder_ext.rb

@@ -7,55 +7,78 @@ JbuilderTemplate.class_eval do
   # json.cache_collection! @people, expires_in: 10.minutes do |person|
   #   json.partial! 'person', :person => person
   # end
-  def cache_collection!(collection, options = {}, &block)    
-    if @context.controller.perform_caching
-      keys_to_collection_map = _keys_to_collection_map(collection, options)  
+  def cache_collection!(collection, options = {}, &block)
+    if @context.controller.perform_caching && !collection.empty?
+      keys_to_collection_map = _keys_to_collection_map(collection, options)
 
       if ::Rails.cache.respond_to?(:fetch_multi)
         results = ::Rails.cache.fetch_multi(*keys_to_collection_map.keys, options) do |key|
           _scope { yield keys_to_collection_map[key] }
-        end        
+        end
       else
         results = keys_to_collection_map.map do |key, item|
           ::Rails.cache.fetch(key, options) { _scope { yield item } }
         end
       end
-      
+
       _process_collection_results(results)
     else
       array! collection, options, &block
     end
   end
-  
-  
-  
+
+  # Conditionally caches a collection of objects depending in the condition given as first parameter.
+  #
+  # Example:
+  #
+  # json.cache_collection_if! do_cache?, @people, expires_in: 10.minutes do |person|
+  #   json.partial! 'person', :person => person
+  # end
+  def cache_collection_if!(condition, collection, options = {}, &block)
+    condition ?
+        cache_collection!(collection, options, &block) :
+        array!(collection, options, &block)
+  end
+
   protected
-  
+
   ## Implementing our own version of _cache_key because jbuilder's is protected
   def _cache_key_fetch_multi(key, options)
+    key = _fragment_name_with_digest_fetch_multi(key, options)
+    key = url_for(key).split('://', 2).last if ::Hash === key
+    ::ActiveSupport::Cache.expand_cache_key(key, :jbuilder)
+  end
+
+  def _fragment_name_with_digest_fetch_multi(key, options)
     if @context.respond_to?(:cache_fragment_name)
       # Current compatibility, fragment_name_with_digest is private again and cache_fragment_name
       # should be used instead.
-      @context.cache_fragment_name(key, options)
+      @context.cache_fragment_name(key, options.slice(:skip_digest, :virtual_path))
     elsif @context.respond_to?(:fragment_name_with_digest)
       # Backwards compatibility for period of time when fragment_name_with_digest was made public.
       @context.fragment_name_with_digest(key)
     else
-      ::ActiveSupport::Cache.expand_cache_key(key.is_a?(::Hash) ? url_for(key).split('://').last : key, :jbuilder)
+      key
     end
   end
-  
+
   def _keys_to_collection_map(collection, options)
     key = options.delete(:key)
 
     collection.inject({}) do |result, item|
-      key = key.respond_to?(:call) ? key.call(item) : key
-      cache_key = key ? [key, item] : item
+      cache_key =
+          if key.respond_to?(:call)
+            key.call(item)
+          elsif key
+            [key, item]
+          else
+            item
+          end
       result[_cache_key_fetch_multi(cache_key, options)] = item
       result
     end
   end
-  
+
   def _process_collection_results(results)
     _results = results.class == Hash ? results.values : results
     #support pre 2.0 versions of jbuilder where merge! is still private
@@ -67,5 +90,5 @@ JbuilderTemplate.class_eval do
       _results
     end
   end
-  
-end
+
+end

data/lib/jbuilder_cache_multi/version.rb

@@ -1,3 +1,3 @@
 module JbuilderCacheMulti
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/test/jbuilder_template_test.rb

@@ -17,7 +17,7 @@ BLOG_POST_PARTIAL = <<-JBUILDER
   end
 JBUILDER
 
-CACHE_KEY_PROC = Proc.new { |blog_post| true }
+CACHE_KEY_PROC = Proc.new { |blog_post| blog_post.id }
 
 BlogPost = Struct.new(:id, :body, :author_name)
 blog_authors = [ 'David Heinemeier Hansson', 'Pavel Pravosud' ].cycle
@@ -42,6 +42,14 @@ class JbuilderTemplateTest < ActionView::TestCase
     }
   end
 
+  # Stub out a couple of methods that'll get called from cache_fragment_name
+  def view_cache_dependencies
+    []
+  end
+  def formats
+    [:json]
+  end
+
   def render_jbuilder(source)
     @rendered = []
     lookup_context.view_paths = [ActionView::FixtureResolver.new(partials.merge('test.json.jbuilder' => source))]
@@ -79,9 +87,18 @@ class JbuilderTemplateTest < ActionView::TestCase
     assert_collection_rendered json
   end
 
+  test 'allows additional options' do
+    json = render_jbuilder <<-JBUILDER
+      json.cache_collection! BLOG_POST_COLLECTION, expires_in: 1.hour do |blog_post|
+        json.partial! 'blog_post', :blog_post => blog_post
+      end
+    JBUILDER
+
+    assert_collection_rendered json
+  end
+
   test 'renders cached array with a key specified as a proc' do
     undef_context_methods :fragment_name_with_digest, :cache_fragment_name
-    CACHE_KEY_PROC.expects(:call)
 
     json = render_jbuilder <<-JBUILDER
       json.cache_collection! BLOG_POST_COLLECTION, key: CACHE_KEY_PROC do |blog_post|
@@ -91,7 +108,7 @@ class JbuilderTemplateTest < ActionView::TestCase
 
     assert_collection_rendered json
   end
-  
+
   test 'reverts to cache! if cache does not support fetch_multi' do
     undef_context_methods :fragment_name_with_digest, :cache_fragment_name
     ActiveSupport::Cache::Store.send(:undef_method, :fetch_multi) if ActiveSupport::Cache::Store.method_defined?(:fetch_multi)
@@ -104,7 +121,7 @@ class JbuilderTemplateTest < ActionView::TestCase
     
     assert_collection_rendered json
   end
-  
+
   test 'reverts to array! when controller.perform_caching is false' do
     controller.perform_caching = false
     
@@ -117,4 +134,40 @@ class JbuilderTemplateTest < ActionView::TestCase
     assert_collection_rendered json
   end
 
+  test 'reverts to array! when collection is empty' do
+    json = render_jbuilder <<-JBUILDER
+      json.cache_collection! [] do |blog_post|
+        json.partial! 'blog_post', :blog_post => blog_post
+      end
+    JBUILDER
+    
+    assert_equal '[]', json
+  end
+
+  test 'conditionally fragment caching a JSON object' do
+    undef_context_methods :fragment_name_with_digest, :cache_fragment_name
+
+    render_jbuilder <<-JBUILDER
+      json.cache_collection_if! true, BLOG_POST_COLLECTION, key: 'cachekey' do |blog_post|
+        json.partial! 'blog_post', :blog_post => blog_post
+      end
+    JBUILDER
+
+    json = render_jbuilder <<-JBUILDER
+      json.cache_collection_if! true, BLOG_POST_COLLECTION, key: 'cachekey' do |blog_post|
+        json.test 'Miss'
+      end
+    JBUILDER
+
+    assert_collection_rendered json
+
+    json = render_jbuilder <<-JBUILDER
+      json.cache_collection_if! false, BLOG_POST_COLLECTION, key: 'cachekey' do |blog_post|
+        json.test 'Miss'
+      end
+    JBUILDER
+
+    result = MultiJson.load(json)
+    assert_equal 'Miss',        result[4]['test']
+  end
 end