jbuilder 2.13.0 → 2.14.0

data/lib/jbuilder/jbuilder_template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jbuilder/jbuilder'
 require 'jbuilder/collection_renderer'
 require 'action_dispatch/http/mime_type'
@@ -10,10 +12,11 @@ class JbuilderTemplate < Jbuilder
 
   self.template_lookup_options = { handlers: [:jbuilder] }
 
-  def initialize(context, *args)
+  def initialize(context, options = nil)
     @context = context
     @cached_root = nil
-    super(*args)
+
+    options.nil? ? super() : super(**options)
   end
 
   # Generates JSON using the template specified with the `:partial` option. For example, the code below will render
@@ -52,7 +55,9 @@ class JbuilderTemplate < Jbuilder
     if args.one? && _is_active_model?(args.first)
       _render_active_model_partial args.first
     else
-      _render_explicit_partial(*args)
+      options = args.extract_options!.dup
+      options[:partial] = args.first if args.present?
+      _render_partial_with_options options
     end
   end
 
@@ -118,7 +123,9 @@ class JbuilderTemplate < Jbuilder
     options = args.first
 
     if args.one? && _partial_options?(options)
-      partial! options.merge(collection: collection)
+      options = options.dup
+      options[:collection] = collection
+      _render_partial_with_options options
     else
       super
     end
@@ -128,7 +135,7 @@ class JbuilderTemplate < Jbuilder
     options = args.first
 
     if args.one? && _partial_options?(options)
-      _set_inline_partial name, object, options
+      _set_inline_partial name, object, options.dup
     else
       super
     end
@@ -136,15 +143,17 @@ class JbuilderTemplate < Jbuilder
 
   private
 
+  alias_method :method_missing, :set!
+
   def _render_partial_with_options(options)
-    options.reverse_merge! locals: options.except(:partial, :as, :collection, :cached)
-    options.reverse_merge! ::JbuilderTemplate.template_lookup_options
+    options[:locals] ||= options.except(:partial, :as, :collection, :cached)
+    options[:handlers] ||= ::JbuilderTemplate.template_lookup_options[:handlers]
     as = options[:as]
 
-    if as && options.key?(:collection) && CollectionRenderer.supported?
+    if as && options.key?(:collection)
       collection = options.delete(:collection) || []
       partial = options.delete(:partial)
-      options[:locals].merge!(json: self)
+      options[:locals][:json] = self
       collection = EnumerableCompat.new(collection) if collection.respond_to?(:count) && !collection.respond_to?(:size)
 
       if options.has_key?(:layout)
@@ -159,24 +168,8 @@ class JbuilderTemplate < Jbuilder
         results = CollectionRenderer
           .new(@context.lookup_context, options) { |&block| _scope(&block) }
           .render_collection_with_partial(collection, partial, @context, nil)
-  
-        array! if results.respond_to?(:body) && results.body.nil?
-      else
-        array!
-      end
-    elsif as && options.key?(:collection) && !CollectionRenderer.supported?
-      # For Rails <= 5.2:
-      as = as.to_sym
-      collection = options.delete(:collection)
 
-      if collection.present?
-        locals = options.delete(:locals)
-        array! collection do |member|
-          member_locals = locals.clone
-          member_locals.merge! collection: collection
-          member_locals.merge! as => member
-          _render_partial options.merge(locals: member_locals)
-        end
+        array! if results.respond_to?(:body) && results.body.nil?
       else
         array!
       end
@@ -186,7 +179,7 @@ class JbuilderTemplate < Jbuilder
   end
 
   def _render_partial(options)
-    options[:locals].merge! json: self
+    options[:locals][:json] = self
     @context.render options
   end
 
@@ -242,34 +235,18 @@ class JbuilderTemplate < Jbuilder
     value = if object.nil?
       []
     elsif _is_collection?(object)
-      _scope{ _render_partial_with_options options.merge(collection: object) }
-    else
-      locals = ::Hash[options[:as], object]
-      _scope{ _render_partial_with_options options.merge(locals: locals) }
-    end
-
-    set! name, value
-  end
-
-  def _render_explicit_partial(name_or_options, locals = {})
-    case name_or_options
-    when ::Hash
-      # partial! partial: 'name', foo: 'bar'
-      options = name_or_options
+      _scope do
+        options[:collection] = object
+        _render_partial_with_options options
+      end
     else
-      # partial! 'name', locals: {foo: 'bar'}
-      if locals.one? && (locals.keys.first == :locals)
-        options = locals.merge(partial: name_or_options)
-      else
-        options = { partial: name_or_options, locals: locals }
+      _scope do
+        options[:locals] = { options[:as] => object }
+        _render_partial_with_options options
       end
-      # partial! 'name', foo: 'bar'
-      as = locals.delete(:as)
-      options[:as] = as if as.present?
-      options[:collection] = locals[:collection] if locals.key?(:collection)
     end
 
-    _render_partial_with_options options
+    _set_value name, value
   end
 
   def _render_active_model_partial(object)
@@ -284,7 +261,7 @@ class JbuilderHandler
   def self.call(template, source = nil)
     source ||= template.source
     # this juggling is required to keep line numbers right in the error
-    %{__already_defined = defined?(json); json||=JbuilderTemplate.new(self); #{source}
+    %{__already_defined = defined?(json); json||=JbuilderTemplate.new(self); #{source};
       json.target! unless (__already_defined && __already_defined != "method")}
   end
 end

data/lib/jbuilder/key_formatter.rb

@@ -1,32 +1,30 @@
+# frozen_string_literal: true
+
 require 'jbuilder/jbuilder'
-require 'active_support/core_ext/array'
 
 class Jbuilder
   class KeyFormatter
-    def initialize(*args)
-      @format = {}
-      @cache = {}
-
-      options = args.extract_options!
-      args.each do |name|
-        @format[name] = []
-      end
-      options.each do |name, parameters|
-        @format[name] = parameters
-      end
-    end
-
-    def initialize_copy(original)
+    def initialize(*formats, **formats_with_options)
+      @mutex = Mutex.new
+      @formats = formats
+      @formats_with_options = formats_with_options
       @cache = {}
     end
 
     def format(key)
-      @cache[key] ||= @format.inject(key.to_s) do |result, args|
-        func, args = args
-        if ::Proc === func
-          func.call result, *args
-        else
-          result.send func, *args
+      @mutex.synchronize do
+        @cache[key] ||= begin
+          value = key.is_a?(Symbol) ? key.name : key.to_s
+
+          @formats.each do |func|
+            value = func.is_a?(Proc) ? func.call(value) : value.send(func)
+          end
+
+          @formats_with_options.each do |func, params|
+            value = func.is_a?(Proc) ? func.call(value, *params) : value.send(func, *params)
+          end
+
+          value
         end
       end
     end

data/lib/jbuilder/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'jbuilder/jbuilder_template'
 
@@ -9,28 +11,24 @@ class Jbuilder
         require 'jbuilder/jbuilder_dependency_tracker'
       end
 
-      if Rails::VERSION::MAJOR >= 5
-        module ::ActionController
-          module ApiRendering
-            include ActionView::Rendering
-          end
+      module ::ActionController
+        module ApiRendering
+          include ActionView::Rendering
         end
+      end
 
-        ActiveSupport.on_load :action_controller do
-          if name == 'ActionController::API'
-            include ActionController::Helpers
-            include ActionController::ImplicitRender
-          end
-        end
+      ActiveSupport.on_load :action_controller_api do
+        include ActionController::Helpers
+        include ActionController::ImplicitRender
+        helper_method :combined_fragment_cache_key
+        helper_method :view_cache_dependencies
       end
     end
 
-    if Rails::VERSION::MAJOR >= 4
-      generators do |app|
-        Rails::Generators.configure! app.config.generators
-        Rails::Generators.hidden_namespaces.uniq!
-        require 'generators/rails/scaffold_controller_generator'
-      end
+    generators do |app|
+      Rails::Generators.configure! app.config.generators
+      Rails::Generators.hidden_namespaces.uniq!
+      require 'generators/rails/scaffold_controller_generator'
     end
   end
 end

data/lib/jbuilder/version.rb

@@ -1,3 +1,5 @@
-class Jbuilder
-  VERSION = "2.13.0"
+# frozen_string_literal: true
+
+class Jbuilder < BasicObject
+  VERSION = "2.14.0"
 end

data/lib/jbuilder.rb

@@ -1,9 +1,10 @@
+# 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'
 
@@ -12,14 +13,18 @@ class Jbuilder
   @@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
@@ -58,20 +63,12 @@ class Jbuilder
     else
       # json.author @post.creator, :name, :email_address
       # { "author": { "name": "David", "email_address": "david@loudthinking.com" } }
-      _merge_block(key){ extract! value, *args }
+      _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
-  end
-
   # Specifies formatting to be applied to the key. Passing in a name of a function
   # will cause that function to be called on the key.  So :upcase will upper case
   # the key.  You can also pass in lambdas for more complex transformations.
@@ -100,13 +97,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
@@ -215,7 +212,7 @@ class Jbuilder
     elsif ::Kernel.block_given?
       _map_collection(collection, &block)
     elsif attributes.any?
-      _map_collection(collection) { |element| extract! element, *attributes }
+      _map_collection(collection) { |element| _extract element, attributes }
     else
       _format_keys(collection.to_a)
     end
@@ -241,18 +238,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
     else
-      extract! object, *attributes
+      _extract object, attributes
     end
   end
 
@@ -281,6 +274,16 @@ class Jbuilder
 
   private
 
+  alias_method :method_missing, :set!
+
+  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 +314,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)
@@ -350,16 +359,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

@@ -49,6 +49,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"]
@@ -306,99 +317,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)
 
-    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 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 +425,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