jbuilder 2.12.0 → 2.14.0

data/lib/jbuilder/collection_renderer.rb

@@ -1,37 +1,11 @@
+# frozen_string_literal: true
+
 require 'delegate'
-require 'active_support/concern'
 require 'action_view'
-
-begin
-  require 'action_view/renderer/collection_renderer'
-rescue LoadError
-  require 'action_view/renderer/partial_renderer'
-end
+require 'action_view/renderer/collection_renderer'
 
 class Jbuilder
-  module CollectionRenderable # :nodoc:
-    extend ActiveSupport::Concern
-
-    class_methods do
-      def supported?
-        superclass.private_method_defined?(:build_rendered_template) && self.superclass.private_method_defined?(:build_rendered_collection)
-      end
-    end
-
-    private
-
-    def build_rendered_template(content, template, layout = nil)
-      super(content || json.attributes!, template)
-    end
-
-    def build_rendered_collection(templates, _spacer)
-      json.merge!(templates.map(&:body))
-    end
-
-    def json
-      @options[:locals].fetch(:json)
-    end
-
+  class CollectionRenderer < ::ActionView::CollectionRenderer # :nodoc:
     class ScopedIterator < ::SimpleDelegator # :nodoc:
       include Enumerable
 
@@ -40,16 +14,6 @@ class Jbuilder
         @scope = scope
       end
 
-      # Rails 6.0 support:
-      def each
-        return enum_for(:each) unless block_given?
-
-        __getobj__.each do |object|
-          @scope.call { yield(object) }
-        end
-      end
-
-      # Rails 6.1 support:
       def each_with_info
         return enum_for(:each_with_info) unless block_given?
 
@@ -60,51 +24,29 @@ class Jbuilder
     end
 
     private_constant :ScopedIterator
-  end
-
-  if defined?(::ActionView::CollectionRenderer)
-    # Rails 6.1 support:
-    class CollectionRenderer < ::ActionView::CollectionRenderer # :nodoc:
-      include CollectionRenderable
 
-      def initialize(lookup_context, options, &scope)
-        super(lookup_context, options)
-        @scope = scope
-      end
-
-      private
-        def collection_with_template(view, template, layout, collection)
-          super(view, template, layout, ScopedIterator.new(collection, @scope))
-        end
+    def initialize(lookup_context, options, &scope)
+      super(lookup_context, options)
+      @scope = scope
     end
-  else
-    # Rails 6.0 support:
-    class CollectionRenderer < ::ActionView::PartialRenderer # :nodoc:
-      include CollectionRenderable
 
-      def initialize(lookup_context, options, &scope)
-        super(lookup_context)
-        @options = options
-        @scope = scope
-      end
+    private
 
-      def render_collection_with_partial(collection, partial, context, block)
-        render(context, @options.merge(collection: collection, partial: partial), block)
+      def build_rendered_template(content, template, layout = nil)
+        super(content || json.attributes!, template)
       end
 
-      private
-        def collection_without_template(view)
-          @collection = ScopedIterator.new(@collection, @scope)
-
-          super(view)
-        end
+      def build_rendered_collection(templates, _spacer)
+        json.merge!(templates.map(&:body))
+      end
 
-        def collection_with_template(view, template)
-          @collection = ScopedIterator.new(@collection, @scope)
+      def json
+        @options[:locals].fetch(:json)
+      end
 
-          super(view, template)
-        end
-    end
+      def collection_with_template(view, template, layout, collection)
+        super(view, template, layout, ScopedIterator.new(collection, @scope))
+      end
   end
 
   class EnumerableCompat < ::SimpleDelegator

data/lib/jbuilder/errors.rb

@@ -1,4 +1,6 @@
-require 'jbuilder/jbuilder'
+# frozen_string_literal: true
+
+require 'jbuilder/version'
 
 class Jbuilder
   class NullError < ::NoMethodError

data/lib/jbuilder/jbuilder.rb

@@ -1 +1,3 @@
-Jbuilder = Class.new(BasicObject)
+# frozen_string_literal: true
+
+require 'jbuilder/version'

data/lib/jbuilder/jbuilder_dependency_tracker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Jbuilder::DependencyTracker
   EXPLICIT_DEPENDENCY = /# Template Dependency: (\S+)/
 

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)
@@ -155,21 +164,14 @@ class JbuilderTemplate < Jbuilder
         ::Kernel.raise ::NotImplementedError, "The `:spacer_template' option is not supported in collection rendering."
       end
 
-      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?
-    elsif as && options.key?(:collection) && !CollectionRenderer.supported?
-      # For Rails <= 5.2:
-      as = as.to_sym
-      collection = options.delete(:collection)
-      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)
+      if collection.present?
+        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
     else
       _render_partial options
@@ -177,7 +179,7 @@ class JbuilderTemplate < Jbuilder
   end
 
   def _render_partial(options)
-    options[:locals].merge! json: self
+    options[:locals][:json] = self
     @context.render options
   end
 
@@ -233,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)
@@ -275,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

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

data/lib/jbuilder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'jbuilder/jbuilder'
 require 'jbuilder/blank'
@@ -5,24 +7,24 @@ require 'jbuilder/key_formatter'
 require 'jbuilder/errors'
 require 'json'
 require 'active_support/core_ext/hash/deep_merge'
-begin
-  require 'ostruct'
-rescue LoadError
-end
 
 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
@@ -31,7 +33,6 @@ class Jbuilder
   end
 
   BLANK = Blank.new
-  NON_ENUMERABLES = defined?(::OpenStruct) ? [::Struct, ::OpenStruct].to_set : [::Struct].to_set
 
   def set!(key, value = BLANK, *args, &block)
     result = if ::Kernel.block_given?
@@ -62,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.
@@ -104,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
@@ -219,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
@@ -245,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
 
@@ -285,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
@@ -315,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)
@@ -354,16 +359,12 @@ class Jbuilder
   end
 
   def _is_collection?(object)
-    _object_respond_to?(object, :map, :count) && NON_ENUMERABLES.none?{ |klass| klass === 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