jbuilder 1.5.3 → 2.11.5

data/test/jbuilder_template_test.rb

@@ -1,254 +1,410 @@
-require 'test/unit'
-require 'mocha/setup'
-require 'action_view'
-require 'action_view/testing/resolvers'
-require 'active_support/cache'
-require 'jbuilder/jbuilder_template'
+require "test_helper"
+require "action_view/testing/resolvers"
+
+class JbuilderTemplateTest < ActiveSupport::TestCase
+  POST_PARTIAL = <<-JBUILDER
+    json.extract! post, :id, :body
+    json.author do
+      first_name, last_name = post.author_name.split(nil, 2)
+      json.first_name first_name
+      json.last_name last_name
+    end
+  JBUILDER
+
+  COLLECTION_PARTIAL = <<-JBUILDER
+    json.extract! collection, :id, :name
+  JBUILDER
+
+  RACER_PARTIAL = <<-JBUILDER
+    json.extract! racer, :id, :name
+  JBUILDER
+
+  PARTIALS = {
+    "_partial.json.jbuilder"      => "json.content content",
+    "_post.json.jbuilder"         => POST_PARTIAL,
+    "racers/_racer.json.jbuilder" => RACER_PARTIAL,
+    "_collection.json.jbuilder"   => COLLECTION_PARTIAL,
+
+    # Ensure we find only Jbuilder partials from within Jbuilder templates.
+    "_post.html.erb" => "Hello world!"
+  }
+
+  AUTHORS = [ "David Heinemeier Hansson", "Pavel Pravosud" ].cycle
+  POSTS   = (1..10).collect { |i| Post.new(i, "Post ##{i}", AUTHORS.next) }
 
+  setup { Rails.cache.clear }
 
-BLOG_POST_PARTIAL = <<-JBUILDER
-  json.extract! blog_post, :id, :body
-  json.author do
-    name = blog_post.author_name.split(nil, 2)
-    json.first_name name[0]
-    json.last_name  name[1]
+  test "basic template" do
+    result = render('json.content "hello"')
+    assert_equal "hello", result["content"]
   end
-JBUILDER
 
-BlogPost = Struct.new(:id, :body, :author_name)
-blog_authors = [ 'David Heinemeier Hansson', 'Pavel Pravosud' ].cycle
-BLOG_POST_COLLECTION = 10.times.map{ |i| BlogPost.new(i+1, "post body #{i+1}", blog_authors.next) }
+  test "partial by name with top-level locals" do
+    result = render('json.partial! "partial", content: "hello"')
+    assert_equal "hello", result["content"]
+  end
 
-module Rails
-  def self.cache
-    @cache ||= ActiveSupport::Cache::MemoryStore.new
+  test "partial by name with nested locals" do
+    result = render('json.partial! "partial", locals: { content: "hello" }')
+    assert_equal "hello", result["content"]
   end
-end
 
-class JbuilderTemplateTest < ActionView::TestCase
-  setup do
-    @context = self
-    Rails.cache.clear
+  test "partial by options containing nested locals" do
+    result = render('json.partial! partial: "partial", locals: { content: "hello" }')
+    assert_equal "hello", result["content"]
   end
 
-  def partials
-    {
-      '_partial.json.jbuilder'  => 'json.content "hello"',
-      '_blog_post.json.jbuilder' => BLOG_POST_PARTIAL
-    }
+  test "partial by options containing top-level locals" do
+    result = render('json.partial! partial: "partial", content: "hello"')
+    assert_equal "hello", result["content"]
   end
 
-  def render_jbuilder(source)
-    @rendered = []
-    lookup_context.view_paths = [ActionView::FixtureResolver.new(partials.merge('test.json.jbuilder' => source))]
-    ActionView::Template.new(source, 'test', JbuilderHandler, :virtual_path => 'test').render(self, {}).strip
+  test "partial for Active Model" do
+    result = render('json.partial! @racer', racer: Racer.new(123, "Chris Harris"))
+    assert_equal 123, result["id"]
+    assert_equal "Chris Harris", result["name"]
   end
 
-  def undef_context_methods(*names)
-    self.class_eval do
-      names.each do |name|
-        undef_method name.to_sym if self.method_defined?(name.to_sym)
-      end
-    end
+  test "partial collection by name with symbol local" do
+    result = render('json.partial! "post", collection: @posts, as: :post', posts: POSTS)
+    assert_equal 10, result.count
+    assert_equal "Post #5", result[4]["body"]
+    assert_equal "Heinemeier Hansson", result[2]["author"]["last_name"]
+    assert_equal "Pavel", result[5]["author"]["first_name"]
   end
 
-  def assert_collection_rendered(json, context = nil)
-    result = MultiJson.load(json)
-    result = result.fetch(context) if context
+  test "partial collection by name with string local" do
+    result = render('json.partial! "post", collection: @posts, as: "post"', posts: POSTS)
+    assert_equal 10, result.count
+    assert_equal "Post #5", result[4]["body"]
+    assert_equal "Heinemeier Hansson", result[2]["author"]["last_name"]
+    assert_equal "Pavel", result[5]["author"]["first_name"]
+  end
 
-    assert_equal 10, result.length
-    assert_equal Array, result.class
-    assert_equal 'post body 5',        result[4]['body']
-    assert_equal 'Heinemeier Hansson', result[2]['author']['last_name']
-    assert_equal 'Pavel',              result[5]['author']['first_name']
+  test "partial collection by options" do
+    result = render('json.partial! partial: "post", collection: @posts, as: :post', posts: POSTS)
+    assert_equal 10, result.count
+    assert_equal "Post #5", result[4]["body"]
+    assert_equal "Heinemeier Hansson", result[2]["author"]["last_name"]
+    assert_equal "Pavel", result[5]["author"]["first_name"]
   end
 
-  test 'rendering' do
-    json = render_jbuilder <<-JBUILDER
-      json.content 'hello'
-    JBUILDER
+  test "nil partial collection by name" do
+    assert_equal [], render('json.partial! "post", collection: @posts, as: :post', posts: nil)
+  end
 
-    assert_equal 'hello', MultiJson.load(json)['content']
+  test "nil partial collection by options" do
+    assert_equal [], render('json.partial! partial: "post", collection: @posts, as: :post', posts: nil)
   end
 
-  test 'key_format! with parameter' do
-    json = render_jbuilder <<-JBUILDER
-      json.key_format! :camelize => [:lower]
-      json.camel_style 'for JS'
-    JBUILDER
+  test "array of partials" do
+    result = render('json.array! @posts, partial: "post", as: :post', posts: POSTS)
+    assert_equal 10, result.count
+    assert_equal "Post #5", result[4]["body"]
+    assert_equal "Heinemeier Hansson", result[2]["author"]["last_name"]
+    assert_equal "Pavel", result[5]["author"]["first_name"]
+  end
 
-    assert_equal ['camelStyle'], MultiJson.load(json).keys
+  test "empty array of partials from nil collection" do
+    assert_equal [], render('json.array! @posts, partial: "post", as: :post', posts: nil)
   end
 
-  test 'key_format! propagates to child elements' do
-    json = render_jbuilder <<-JBUILDER
-      json.key_format! :upcase
-      json.level1 'one'
-      json.level2 do
-        json.value 'two'
-      end
-    JBUILDER
+  test "array of partials under key" do
+    result = render('json.posts @posts, partial: "post", as: :post', posts: POSTS)
+    assert_equal 10, result["posts"].count
+    assert_equal "Post #5", result["posts"][4]["body"]
+    assert_equal "Heinemeier Hansson", result["posts"][2]["author"]["last_name"]
+    assert_equal "Pavel", result["posts"][5]["author"]["first_name"]
+  end
 
-    result = MultiJson.load(json)
-    assert_equal 'one', result['LEVEL1']
-    assert_equal 'two', result['LEVEL2']['VALUE']
+  test "empty array of partials under key from nil collection" do
+    result = render('json.posts @posts, partial: "post", as: :post', posts: nil)
+    assert_equal [], result["posts"]
   end
 
-  test 'partial! renders partial' do
-    json = render_jbuilder <<-JBUILDER
-      json.partial! 'partial'
+  test "object fragment caching" do
+    render(<<-JBUILDER)
+      json.cache! "cache-key" do
+        json.name "Hit"
+      end
     JBUILDER
 
-    assert_equal 'hello', MultiJson.load(json)['content']
+    hit = render('json.cache! "cache-key" do; end')
+    assert_equal "Hit", hit["name"]
   end
 
-  test 'partial! renders collections' do
-    json = render_jbuilder <<-JBUILDER
-      json.partial! 'blog_post', :collection => BLOG_POST_COLLECTION, :as => :blog_post
+  test "conditional object fragment caching" do
+    render(<<-JBUILDER)
+      json.cache_if! true, "cache-key" do
+        json.a "Hit"
+      end
+
+      json.cache_if! false, "cache-key" do
+        json.b "Hit"
+      end
     JBUILDER
 
-    assert_collection_rendered json
-  end
+    result = render(<<-JBUILDER)
+      json.cache_if! true, "cache-key" do
+        json.a "Miss"
+      end
 
-  test 'partial! renders as empty array for nil-collection' do
-    json = render_jbuilder <<-JBUILDER
-      json.partial! 'blog_post', :collection => nil, :as => :blog_post
+      json.cache_if! false, "cache-key" do
+        json.b "Miss"
+      end
     JBUILDER
 
-    assert_equal '[]', json
+    assert_equal "Hit", result["a"]
+    assert_equal "Miss", result["b"]
   end
 
-  test 'partial! renders collection (alt. syntax)' do
-    json = render_jbuilder <<-JBUILDER
-      json.partial! :partial => 'blog_post', :collection => BLOG_POST_COLLECTION, :as => :blog_post
+  test "object fragment caching with expiry" do
+    travel_to Time.iso8601("2018-05-12T11:29:00-04:00")
+
+    render <<-JBUILDER
+      json.cache! "cache-key", expires_in: 1.minute do
+        json.name "Hit"
+      end
     JBUILDER
 
-    assert_collection_rendered json
-  end
+    travel 30.seconds
 
-  test 'partial! renders as empty array for nil-collection (alt. syntax)' do
-    json = render_jbuilder <<-JBUILDER
-      json.partial! :partial => 'blog_post', :collection => nil, :as => :blog_post
+    result = render(<<-JBUILDER)
+      json.cache! "cache-key", expires_in: 1.minute do
+        json.name "Miss"
+      end
     JBUILDER
 
-    assert_equal '[]', json
-  end
+    assert_equal "Hit", result["name"]
 
-  test 'render array of partials' do
-    json = render_jbuilder <<-JBUILDER
-      json.array! BLOG_POST_COLLECTION, :partial => 'blog_post', :as => :blog_post
+    travel 31.seconds
+
+    result = render(<<-JBUILDER)
+      json.cache! "cache-key", expires_in: 1.minute do
+        json.name "Miss"
+      end
     JBUILDER
 
-    assert_collection_rendered json
+    assert_equal "Miss", result["name"]
   end
 
-  test 'render array of partials as empty array with nil-collection' do
-    json = render_jbuilder <<-JBUILDER
-      json.array! nil, :partial => 'blog_post', :as => :blog_post
+  test "object root caching" do
+    render <<-JBUILDER
+      json.cache_root! "cache-key" do
+        json.name "Hit"
+      end
     JBUILDER
 
-    assert_equal '[]', json
-  end
+    assert_equal JSON.dump(name: "Hit"), Rails.cache.read("jbuilder/root/cache-key")
 
-  test 'render array if partials as a value' do
-    json = render_jbuilder <<-JBUILDER
-      json.posts BLOG_POST_COLLECTION, :partial => 'blog_post', :as => :blog_post
+    result = render(<<-JBUILDER)
+      json.cache_root! "cache-key" do
+        json.name "Miss"
+      end
     JBUILDER
 
-    assert_collection_rendered json, 'posts'
+    assert_equal "Hit", result["name"]
   end
 
-  test 'render as empty array if partials as a nil value' do
-    json = render_jbuilder <<-JBUILDER
-      json.posts nil, :partial => 'blog_post', :as => :blog_post
+  test "array fragment caching" do
+    render <<-JBUILDER
+      json.cache! "cache-key" do
+        json.array! %w[ a b c ]
+      end
     JBUILDER
 
-    assert_equal '{"posts":[]}', json
+    assert_equal %w[ a b c ], render('json.cache! "cache-key" do; end')
   end
 
-  test 'fragment caching a JSON object' do
-    undef_context_methods :fragment_name_with_digest, :cache_fragment_name
-
-    render_jbuilder <<-JBUILDER
-      json.cache! 'cachekey' do
-        json.name 'Cache'
+  test "array root caching" do
+    render <<-JBUILDER
+      json.cache_root! "cache-key" do
+        json.array! %w[ a b c ]
       end
     JBUILDER
 
-    json = render_jbuilder <<-JBUILDER
-      json.cache! 'cachekey' do
-        json.name 'Miss'
+    assert_equal JSON.dump(%w[ a b c ]), Rails.cache.read("jbuilder/root/cache-key")
+
+    assert_equal %w[ a b c ], render(<<-JBUILDER)
+      json.cache_root! "cache-key" do
+        json.array! %w[ d e f ]
       end
     JBUILDER
+  end
 
-    parsed = MultiJson.load(json)
-    assert_equal 'Cache', parsed['name']
+  test "failing to cache root after JSON structures have been defined" do
+    assert_raises ActionView::Template::Error, "cache_root! can't be used after JSON structures have been defined" do
+      render <<-JBUILDER
+        json.name "Kaboom"
+        json.cache_root! "cache-key" do
+          json.name "Miss"
+        end
+      JBUILDER
+    end
   end
 
-  test 'fragment caching deserializes an array' do
-    undef_context_methods :fragment_name_with_digest, :cache_fragment_name
+  test "empty fragment caching" do
+    render 'json.cache! "nothing" do; end'
 
-    render_jbuilder <<-JBUILDER
-      json.cache! 'cachekey' do
-        json.array! %w(a b c)
+    result = nil
+
+    assert_nothing_raised do
+      result = render(<<-JBUILDER)
+        json.foo "bar"
+        json.cache! "nothing" do; end
+      JBUILDER
+    end
+
+    assert_equal "bar", result["foo"]
+  end
+
+  test "cache instrumentation" do
+    payloads = {}
+
+    ActiveSupport::Notifications.subscribe("read_fragment.action_controller") { |*args| payloads[:read] = args.last }
+    ActiveSupport::Notifications.subscribe("write_fragment.action_controller") { |*args| payloads[:write] = args.last }
+
+    render <<-JBUILDER
+      json.cache! "cache-key" do
+        json.name "Cache"
       end
     JBUILDER
 
-    json = render_jbuilder <<-JBUILDER
-      json.cache! 'cachekey' do
-        json.array! %w(1 2 3)
-      end
+    assert_equal "jbuilder/cache-key", payloads[:read][:key]
+    assert_equal "jbuilder/cache-key", payloads[:write][:key]
+  end
+
+  test "camelized keys" do
+    result = render(<<-JBUILDER)
+      json.key_format! camelize: [:lower]
+      json.first_name "David"
     JBUILDER
 
-    parsed = MultiJson.load(json)
-    assert_equal %w(a b c), parsed
+    assert_equal "David", result["firstName"]
   end
 
-  test 'fragment caching works with previous version of cache digests' do
-    undef_context_methods :cache_fragment_name
+  if JbuilderTemplate::CollectionRenderer.supported?
+    test "returns an empty array for an empty collection" do
+      result = render('json.array! @posts, partial: "post", as: :post, cached: true', posts: [])
 
-    @context.expects :fragment_name_with_digest
+      # Do not use #assert_empty as it is important to ensure that the type of the JSON result is an array.
+      assert_equal [], result
+    end
 
-    render_jbuilder <<-JBUILDER
-      json.cache! 'cachekey' do
-        json.name 'Cache'
+    test "works with an enumerable object" do
+      enumerable_class = Class.new do
+        include Enumerable
+        alias length count # Rails 6.1 requires this.
+
+        def each(&block)
+          [].each(&block)
+        end
       end
-    JBUILDER
-  end
 
-  test 'fragment caching works with current cache digests' do
-    undef_context_methods :fragment_name_with_digest
+      result = render('json.array! @posts, partial: "post", as: :post, cached: true', posts: enumerable_class.new)
+
+      # Do not use #assert_empty as it is important to ensure that the type of the JSON result is an array.
+      assert_equal [], result
+    end
+
+    test "supports the cached: true option" do
+      result = render('json.array! @posts, partial: "post", as: :post, cached: true', posts: POSTS)
+
+      assert_equal 10, result.count
+      assert_equal "Post #5", result[4]["body"]
+      assert_equal "Heinemeier Hansson", result[2]["author"]["last_name"]
+      assert_equal "Pavel", result[5]["author"]["first_name"]
+
+      expected = {
+        "id" => 1,
+        "body" => "Post #1",
+        "author" => {
+          "first_name" => "David",
+          "last_name" => "Heinemeier Hansson"
+        }
+      }
+
+      assert_equal expected, Rails.cache.read("post-1")
+
+      result = render('json.array! @posts, partial: "post", as: :post, cached: true', posts: POSTS)
+
+      assert_equal 10, result.count
+      assert_equal "Post #5", result[4]["body"]
+      assert_equal "Heinemeier Hansson", result[2]["author"]["last_name"]
+      assert_equal "Pavel", result[5]["author"]["first_name"]
+    end
 
-    @context.expects :cache_fragment_name
+    test "supports the cached: ->() {} option" do
+      result = render('json.array! @posts, partial: "post", as: :post, cached: ->(post) { [post, "foo"] }', posts: POSTS)
 
-    render_jbuilder <<-JBUILDER
-      json.cache! 'cachekey' do
-        json.name 'Cache'
+      assert_equal 10, result.count
+      assert_equal "Post #5", result[4]["body"]
+      assert_equal "Heinemeier Hansson", result[2]["author"]["last_name"]
+      assert_equal "Pavel", result[5]["author"]["first_name"]
+
+      expected = {
+        "id" => 1,
+        "body" => "Post #1",
+        "author" => {
+          "first_name" => "David",
+          "last_name" => "Heinemeier Hansson"
+        }
+      }
+
+      assert_equal expected, Rails.cache.read("post-1/foo")
+
+      result = render('json.array! @posts, partial: "post", as: :post, cached: ->(post) { [post, "foo"] }', posts: POSTS)
+
+      assert_equal 10, result.count
+      assert_equal "Post #5", result[4]["body"]
+      assert_equal "Heinemeier Hansson", result[2]["author"]["last_name"]
+      assert_equal "Pavel", result[5]["author"]["first_name"]
+    end
+
+    test "raises an error on a render call with the :layout option" do
+      error = assert_raises NotImplementedError do
+        render('json.array! @posts, partial: "post", as: :post, layout: "layout"', posts: POSTS)
       end
-    JBUILDER
-  end
 
-  test 'does not perform caching when controller.perform_caching is false' do
-    controller.perform_caching = false
-    render_jbuilder <<-JBUILDER
-      json.cache! 'cachekey' do
-        json.name 'Cache'
+      assert_equal "The `:layout' option is not supported in collection rendering.", error.message
+    end
+
+    test "raises an error on a render call with the :spacer_template option" do
+      error = assert_raises NotImplementedError do
+        render('json.array! @posts, partial: "post", as: :post, spacer_template: "template"', posts: POSTS)
       end
-    JBUILDER
 
-    assert_equal Rails.cache.inspect[/entries=(\d+)/, 1], '0'
+      assert_equal "The `:spacer_template' option is not supported in collection rendering.", error.message
+    end
   end
 
-  test 'fragment caching falls back on ActiveSupport::Cache.expand_cache_key' do
-    undef_context_methods :fragment_name_with_digest, :cache_fragment_name
+  private
+    def render(*args)
+      JSON.load render_without_parsing(*args)
+    end
+
+    def render_without_parsing(source, assigns = {})
+      view = build_view(fixtures: PARTIALS.merge("source.json.jbuilder" => source), assigns: assigns)
+      view.render(template: "source")
+    end
 
-    ActiveSupport::Cache.expects :expand_cache_key
+    def build_view(options = {})
+      resolver = ActionView::FixtureResolver.new(options.fetch(:fixtures))
+      lookup_context = ActionView::LookupContext.new([ resolver ], {}, [""])
+      controller = ActionView::TestCase::TestController.new
 
-    render_jbuilder <<-JBUILDER
-      json.cache! 'cachekey' do
-        json.name 'Cache'
+      # TODO: Use with_empty_template_cache unconditionally after dropping support for Rails <6.0.
+      view = if ActionView::Base.respond_to?(:with_empty_template_cache)
+        ActionView::Base.with_empty_template_cache.new(lookup_context, options.fetch(:assigns, {}), controller)
+      else
+        ActionView::Base.new(lookup_context, options.fetch(:assigns, {}), controller)
       end
-    JBUILDER
-  end
 
-end
+      def view.view_cache_dependencies; []; end
+      def view.combined_fragment_cache_key(key) [ key ] end
+      def view.cache_fragment_name(key, *) key end
+      def view.fragment_name_with_digest(key) key end
+
+      view
+    end
+end