jbuilder 2.13.0 → 2.15.1

data/lib/jbuilder.rb

@@ -1,75 +1,44 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'jbuilder/jbuilder'
 require 'jbuilder/blank'
 require 'jbuilder/key_formatter'
 require 'jbuilder/errors'
-require 'jbuilder/version'
 require 'json'
 require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/object/blank'
 
 class Jbuilder
   @@key_formatter = nil
   @@ignore_nil    = false
   @@deep_format_keys = false
 
-  def initialize(options = {})
+  def initialize(
+    key_formatter: @@key_formatter,
+    ignore_nil: @@ignore_nil,
+    deep_format_keys: @@deep_format_keys,
+    &block
+  )
     @attributes = {}
+    @key_formatter = key_formatter
+    @ignore_nil = ignore_nil
+    @deep_format_keys = deep_format_keys
 
-    @key_formatter = options.fetch(:key_formatter){ @@key_formatter ? @@key_formatter.clone : nil}
-    @ignore_nil = options.fetch(:ignore_nil, @@ignore_nil)
-    @deep_format_keys = options.fetch(:deep_format_keys, @@deep_format_keys)
-
-    yield self if ::Kernel.block_given?
+    yield self if block
   end
 
   # Yields a builder and automatically turns the result into a JSON string
-  def self.encode(*args, &block)
-    new(*args, &block).target!
+  def self.encode(...)
+    new(...).target!
   end
 
-  BLANK = Blank.new
+  BLANK = Blank.new.freeze
+  EMPTY_ARRAY = [].freeze
+  private_constant :BLANK, :EMPTY_ARRAY
 
   def set!(key, value = BLANK, *args, &block)
-    result = if ::Kernel.block_given?
-      if !_blank?(value)
-        # json.comments @post.comments { |comment| ... }
-        # { "comments": [ { ... }, { ... } ] }
-        _scope{ array! value, &block }
-      else
-        # json.comments { ... }
-        # { "comments": ... }
-        _merge_block(key){ yield self }
-      end
-    elsif args.empty?
-      if ::Jbuilder === value
-        # json.age 32
-        # json.person another_jbuilder
-        # { "age": 32, "person": { ...  }
-        _format_keys(value.attributes!)
-      else
-        # json.age 32
-        # { "age": 32 }
-        _format_keys(value)
-      end
-    elsif _is_collection?(value)
-      # json.comments @post.comments, :content, :created_at
-      # { "comments": [ { "content": "hello", "created_at": "..." }, { "content": "world", "created_at": "..." } ] }
-      _scope{ array! value, *args }
-    else
-      # json.author @post.creator, :name, :email_address
-      # { "author": { "name": "David", "email_address": "david@loudthinking.com" } }
-      _merge_block(key){ extract! value, *args }
-    end
-
-    _set_value key, result
-  end
-
-  def method_missing(*args, &block)
-    if ::Kernel.block_given?
-      set!(*args, &block)
-    else
-      set!(*args)
-    end
+    _set(key, value, args, &block)
   end
 
   # Specifies formatting to be applied to the key. Passing in a name of a function
@@ -100,13 +69,13 @@ class Jbuilder
   #
   #   { "_first_name": "David" }
   #
-  def key_format!(*args)
-    @key_formatter = KeyFormatter.new(*args)
+  def key_format!(...)
+    @key_formatter = KeyFormatter.new(...)
   end
 
   # Same as the instance method key_format! except sets the default.
-  def self.key_format(*args)
-    @@key_formatter = KeyFormatter.new(*args)
+  def self.key_format(...)
+    @@key_formatter = KeyFormatter.new(...)
   end
 
   # If you want to skip adding nil values to your JSON hash. This is useful
@@ -209,18 +178,8 @@ class Jbuilder
   #   json.array! [1, 2, 3]
   #
   #   [1,2,3]
-  def array!(collection = [], *attributes, &block)
-    array = if collection.nil?
-      []
-    elsif ::Kernel.block_given?
-      _map_collection(collection, &block)
-    elsif attributes.any?
-      _map_collection(collection) { |element| extract! element, *attributes }
-    else
-      _format_keys(collection.to_a)
-    end
-
-    @attributes = _merge_values(@attributes, array)
+  def array!(collection = EMPTY_ARRAY, *attributes, &block)
+    _array collection, attributes, &block
   end
 
   # Extracts the mentioned attributes or hash elements from the passed object and turns them into attributes of the JSON.
@@ -241,18 +200,14 @@ class Jbuilder
   #
   #   json.(@person, :name, :age)
   def extract!(object, *attributes)
-    if ::Hash === object
-      _extract_hash_values(object, attributes)
-    else
-      _extract_method_values(object, attributes)
-    end
+    _extract object, attributes
   end
 
   def call(object, *attributes, &block)
-    if ::Kernel.block_given?
-      array! object, &block
+    if block
+      _array object, &block
     else
-      extract! object, *attributes
+      _extract object, attributes
     end
   end
 
@@ -279,8 +234,68 @@ class Jbuilder
     @attributes.to_json
   end
 
+  alias_method :method_missing, :set!
+  private :method_missing
+
   private
 
+  def _set(key, value = BLANK, attributes = nil, &block)
+    result = if block
+      if _blank?(value)
+        # json.comments { ... }
+        # { "comments": ... }
+        _merge_block key, &block
+      else
+        # json.comments @post.comments { |comment| ... }
+        # { "comments": [ { ... }, { ... } ] }
+        _scope { _array value, &block }
+      end
+    elsif attributes.empty?
+      if ::Jbuilder === value
+        # json.age 32
+        # json.person another_jbuilder
+        # { "age": 32, "person": { ...  }
+        _format_keys(value.attributes!)
+      else
+        # json.age 32
+        # { "age": 32 }
+        _format_keys(value)
+      end
+    elsif _is_collection?(value)
+      # json.comments @post.comments, :content, :created_at
+      # { "comments": [ { "content": "hello", "created_at": "..." }, { "content": "world", "created_at": "..." } ] }
+      _scope { _array value, attributes }
+    else
+      # json.author @post.creator, :name, :email_address
+      # { "author": { "name": "David", "email_address": "david@loudthinking.com" } }
+      _merge_block(key) { _extract value, attributes }
+    end
+
+    _set_value key, result
+  end
+
+  def _array(collection = EMPTY_ARRAY, attributes = nil, &block)
+    array = if collection.nil?
+      EMPTY_ARRAY
+    elsif block
+      _map_collection(collection, &block)
+    elsif attributes.present?
+      _map_collection(collection) { |element| _extract element, attributes }
+    else
+      _format_keys(collection.to_a)
+    end
+
+    @attributes = _merge_values(@attributes, array)
+  end
+
+  def _extract(object, attributes)
+    if ::Hash === object
+      _extract_hash_values(object, attributes)
+    else
+      _extract_method_values(object, attributes)
+    end
+  end
+
   def _extract_hash_values(object, attributes)
     attributes.each{ |key| _set_value key, _format_keys(object.fetch(key)) }
   end
@@ -311,7 +326,13 @@ class Jbuilder
   end
 
   def _key(key)
-    @key_formatter ? @key_formatter.format(key) : key.to_s
+    if @key_formatter
+      @key_formatter.format(key)
+    elsif key.is_a?(::Symbol)
+      key.name
+    else
+      key.to_s
+    end
   end
 
   def _format_keys(hash_or_array)
@@ -335,9 +356,11 @@ class Jbuilder
   end
 
   def _map_collection(collection)
-    collection.map do |element|
+    collection = collection.map do |element|
       _scope{ yield element }
-    end - [BLANK]
+    end
+    collection.delete(BLANK)
+    collection
   end
 
   def _scope
@@ -350,16 +373,12 @@ class Jbuilder
   end
 
   def _is_collection?(object)
-    _object_respond_to?(object, :map, :count) && !(::Struct === object)
+    object.respond_to?(:map) && object.respond_to?(:count) && !(::Struct === object)
   end
 
   def _blank?(value=@attributes)
     BLANK == value
   end
-
-  def _object_respond_to?(object, *methods)
-    methods.all?{ |m| object.respond_to?(m) }
-  end
 end
 
 require 'jbuilder/railtie' if defined?(Rails)

data/test/jbuilder_generator_test.rb

@@ -56,15 +56,13 @@ class JbuilderGeneratorTest < Rails::Generators::TestCase
     end
   end
 
-  if Rails::VERSION::MAJOR >= 6
-    test 'handles virtual attributes' do
-      run_generator %w(Message content:rich_text video:attachment photos:attachments)
+  test 'handles virtual attributes' do
+    run_generator %w(Message content:rich_text video:attachment photos:attachments)
 
-      assert_file 'app/views/messages/_message.json.jbuilder' do |content|
-        assert_match %r{json\.content message\.content\.to_s}, content
-        assert_match %r{json\.video url_for\(message\.video\)}, content
-        assert_match %r{json\.photos do\n  json\.array!\(message\.photos\) do \|photo\|\n    json\.id photo\.id\n    json\.url url_for\(photo\)\n  end\nend}, content
-      end
+    assert_file 'app/views/messages/_message.json.jbuilder' do |content|
+      assert_match %r{json\.content message\.content\.to_s}, content
+      assert_match %r{json\.video url_for\(message\.video\)}, content
+      assert_match %r{json\.photos do\n  json\.array!\(message\.photos\) do \|photo\|\n    json\.id photo\.id\n    json\.url url_for\(photo\)\n  end\nend}, content
     end
   end
 end

data/test/jbuilder_template_test.rb

@@ -4,6 +4,7 @@ require "action_view/testing/resolvers"
 class JbuilderTemplateTest < ActiveSupport::TestCase
   POST_PARTIAL = <<-JBUILDER
     json.extract! post, :id, :body
+    json.title post.title if local_assigns.fetch(:include_title, false)
     json.author do
       first_name, last_name = post.author_name.split(nil, 2)
       json.first_name first_name
@@ -17,6 +18,7 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
 
   RACER_PARTIAL = <<-JBUILDER
     json.extract! racer, :id, :name
+    json.highlighted local_assigns.fetch(:highlighted, false)
   JBUILDER
 
   PARTIALS = {
@@ -30,7 +32,7 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
   }
 
   AUTHORS = [ "David Heinemeier Hansson", "Pavel Pravosud" ].cycle
-  POSTS   = (1..10).collect { |i| Post.new(i, "Post ##{i}", AUTHORS.next) }
+  POSTS   = (1..10).collect { |i| Post.new(i, "Title #{i}", "Post ##{i}", AUTHORS.next) }
 
   setup { Rails.cache.clear }
 
@@ -39,6 +41,11 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "hello", result["content"]
   end
 
+  test "method_missing can be used as a key" do
+    result = render('json.method_missing "hello"')
+    assert_equal({ "method_missing" => "hello" }, result)
+  end
+
   test "partial by name with top-level locals" do
     result = render('json.partial! "partial", content: "hello"')
     assert_equal "hello", result["content"]
@@ -49,6 +56,17 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "hello", result["content"]
   end
 
+  test "partial by name with hash value omission (punning) as last statement [3.1+]" do
+    major, minor, _ = RUBY_VERSION.split(".").map(&:to_i)
+    return unless (major == 3 && minor >= 1) || major > 3
+
+    result = render(<<-JBUILDER)
+      content = "hello"
+      json.partial! "partial", content:
+    JBUILDER
+    assert_equal "hello", result["content"]
+  end
+
   test "partial by options containing nested locals" do
     result = render('json.partial! partial: "partial", locals: { content: "hello" }')
     assert_equal "hello", result["content"]
@@ -65,6 +83,13 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "Chris Harris", result["name"]
   end
 
+  test "partial for Active Model preserves extra locals" do
+    result = render('json.partial! @racer, highlighted: true', racer: Racer.new(123, "Chris Harris"))
+    assert_equal 123, result["id"]
+    assert_equal "Chris Harris", result["name"]
+    assert_equal true, result["highlighted"]
+  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
@@ -125,6 +150,18 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal [], render('json.array! @posts, partial: "post", as: :post', posts: nil)
   end
 
+  test "single partial under key" do
+    result = render('json.post @post, partial: "post", as: :post', post: POSTS.first)
+    assert_equal "Post #1", result["post"]["body"]
+    assert_equal "Heinemeier Hansson", result["post"]["author"]["last_name"]
+    assert_equal "David", result["post"]["author"]["first_name"]
+  end
+
+  test 'single partial under key with local' do
+    result = render('json.post @post, partial: "post", as: :post, include_title: true', post: POSTS.first)
+    assert_equal "Title 1", result["post"]["title"]
+  end
+
   test "array of partials under key" do
     result = render('json.posts @posts, partial: "post", as: :post', posts: POSTS)
     assert_equal 10, result["posts"].count
@@ -133,13 +170,19 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "Pavel", result["posts"][5]["author"]["first_name"]
   end
 
+  test "array of partials under key with local" do
+    result = render('json.posts @posts, partial: "post", as: :post, include_title: true', posts: POSTS)
+    assert_equal "Title 1", result["posts"][0]["title"]
+    assert_equal "Title 2", result["posts"][1]["title"]
+  end
+
   test "empty array of partials under key from nil collection" do
     Jbuilder::CollectionRenderer.expects(:new).never
     result = render('json.posts @posts, partial: "post", as: :post', posts: nil)
     assert_equal [], result["posts"]
   end
 
-  test "empty array of partials under key from an empy collection" do
+  test "empty array of partials under key from an empty collection" do
     Jbuilder::CollectionRenderer.expects(:new).never
     result = render('json.posts @posts, partial: "post", as: :post', posts: [])
     assert_equal [], result["posts"]
@@ -306,99 +349,97 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "David", result["firstName"]
   end
 
-  if JbuilderTemplate::CollectionRenderer.supported?
-    test "returns an empty array for an empty collection" do
-      Jbuilder::CollectionRenderer.expects(:new).never
-      result = render('json.array! @posts, partial: "post", as: :post, cached: true', posts: [])
+  test "returns an empty array for an empty collection" do
+    Jbuilder::CollectionRenderer.expects(:new).never
+    result = render('json.array! @posts, partial: "post", as: :post, cached: true', posts: [])
 
-      # 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
+    # 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 "works with an enumerable object" do
-      enumerable_class = Class.new do
-        include Enumerable
+  test "works with an enumerable object" do
+    enumerable_class = Class.new do
+      include Enumerable
 
-        def each(&block)
-          [].each(&block)
-        end
+      def each(&block)
+        [].each(&block)
       end
+    end
 
-      result = render('json.array! @posts, partial: "post", as: :post, cached: true', posts: enumerable_class.new)
+    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
+    # 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"
-        }
+  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")
+    assert_equal expected, Rails.cache.read("post-1")
 
-      result = render('json.array! @posts, partial: "post", as: :post, cached: true', posts: POSTS)
+    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
+    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 "supports the cached: ->() {} option" do
-      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"]
-
-      expected = {
-        "id" => 1,
-        "body" => "Post #1",
-        "author" => {
-          "first_name" => "David",
-          "last_name" => "Heinemeier Hansson"
-        }
-      }
+  test "supports the cached: ->() {} option" do
+    result = render('json.array! @posts, partial: "post", as: :post, cached: ->(post) { [post, "foo"] }', posts: POSTS)
 
-      assert_equal expected, Rails.cache.read("post-1/foo")
+    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"]
 
-      result = render('json.array! @posts, partial: "post", as: :post, cached: ->(post) { [post, "foo"] }', posts: POSTS)
+    expected = {
+      "id" => 1,
+      "body" => "Post #1",
+      "author" => {
+        "first_name" => "David",
+        "last_name" => "Heinemeier Hansson"
+      }
+    }
 
-      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 expected, Rails.cache.read("post-1/foo")
 
-    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
+    result = render('json.array! @posts, partial: "post", as: :post, cached: ->(post) { [post, "foo"] }', posts: POSTS)
 
-      assert_equal "The `:layout' option is not supported in collection rendering.", error.message
+    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
 
-    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
+    assert_equal "The `:layout' option is not supported in collection rendering.", error.message
+  end
 
-      assert_equal "The `:spacer_template' option is not supported in collection rendering.", error.message
+  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
+
+    assert_equal "The `:spacer_template' option is not supported in collection rendering.", error.message
   end
 
   private
@@ -416,12 +457,7 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
       lookup_context = ActionView::LookupContext.new([ resolver ], {}, [""])
       controller = ActionView::TestCase::TestController.new
 
-      # 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
+      view = ActionView::Base.with_empty_template_cache.new(lookup_context, options.fetch(:assigns, {}), controller)
 
       def view.view_cache_dependencies; []; end
       def view.combined_fragment_cache_key(key) [ key ] end

data/test/jbuilder_test.rb

@@ -61,6 +61,14 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal 'hello', result['content']
   end
 
+  test 'method_missing key' do
+    result = jbuild do |json|
+      json.method_missing 'hello'
+    end
+
+    assert_equal 'hello', result['method_missing']
+  end
+
   test 'single key with false value' do
     result = jbuild do |json|
       json.content false
@@ -784,12 +792,12 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal ['camelStyle'], result.keys
   end
 
-  test 'do not use default key formatter directly' do
+  test 'use default key formatter when configured' do
     Jbuilder.key_format
     jbuild{ |json| json.key 'value' }
     formatter = Jbuilder.send(:class_variable_get, '@@key_formatter')
     cache = formatter.instance_variable_get('@cache')
-    assert_empty cache
+    assert_includes cache, :key
   end
 
   test 'ignore_nil! without a parameter' do
@@ -930,12 +938,17 @@ class JbuilderTest < ActiveSupport::TestCase
     end
   end
 
-  if RUBY_VERSION >= "2.2.10"
-    test "respects JSON encoding customizations" do
-      # Active Support overrides Time#as_json for custom formatting.
-      # Ensure we call #to_json on the final attributes instead of JSON.dump.
-      result = JSON.load(Jbuilder.encode { |json| json.time Time.parse("2018-05-13 11:51:00.485 -0400") })
-      assert_equal "2018-05-13T11:51:00.485-04:00", result["time"]
+  test "respects JSON encoding customizations" do
+    # Active Support overrides Time#as_json for custom formatting.
+    # Ensure we call #to_json on the final attributes instead of JSON.dump.
+    result = JSON.load(Jbuilder.encode { |json| json.time Time.parse("2018-05-13 11:51:00.485 -0400") })
+    assert_equal "2018-05-13T11:51:00.485-04:00", result["time"]
+  end
+
+  test "encode forwards options to new" do
+    Jbuilder.encode(key_formatter: 1, ignore_nil: 2) do |json|
+      assert_equal 1, json.instance_eval{ @key_formatter }
+      assert_equal 2, json.instance_eval{ @ignore_nil }
     end
   end
 end