jbuilder 2.11.0 → 2.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e18daf81b639ef039951269f0df24a2ffb0a4d6e93c05861eebef18c85a9039
-  data.tar.gz: db3ff93fbd28f3a67273b0afbae0962e5e2f49842901b3b2ade5bb3831b74d9b
+  metadata.gz: 071e52598986c430c4bc79a185a0229eceb11c3f38f12ee5a6bd6f9c16f7008c
+  data.tar.gz: 73e82bf90e7049fb735ba139521daf1e0291fbd8e704a1523f7aa4f97e395185
 SHA512:
-  metadata.gz: b74be66e7ba0559d14c7032bfff001e9c9a49c657edab95de06c289eb3600945dea14c3efd9595b0c7da524d31f21c407c8f2b4541da308be8921951f94103e3
-  data.tar.gz: 8ae3e52031fd58c5de35fae022c9224c116d13a93c85990f5385511a8a914ce488f41b69676f94b54d3442942f3a30f79e460fdc78d84633261d239654505547
+  metadata.gz: fca112fc608e7fee45bc1b90ddb5430205d462955f458d1c5fff0d3d716a40ddd7cfc3383465f2eb727b82bfb3b1b226508df7ae77779c3655661324ee8d4963
+  data.tar.gz: 5a250b8e997d56eeeef8b3630cbdc98a6b88e78c06cd3524fb0f5518939ed10ff38bcb9dcc9c8470925f881c5b0690298af019ff16db4a162bee3207f5e6bfd6

data/.github/workflows/ruby.yml

@@ -0,0 +1,108 @@
+name: Ruby test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }} (${{ matrix.gemfile }})
+    runs-on: ubuntu-20.04
+    continue-on-error: ${{ matrix.experimental }}
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: 
+          - "2.2"
+          - "2.3"
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+
+        gemfile:
+          - "rails_5_0"
+          - "rails_5_1"
+          - "rails_5_2"
+          - "rails_6_0"
+          - "rails_6_1"
+          - "rails_head"
+        
+        experimental: [false]
+        exclude:
+          - ruby: 2.7
+            gemfile: rails_5_0
+          - ruby: '3.0'
+            gemfile: rails_5_0
+          - ruby: head
+            gemfile: rails_5_0
+          - ruby: 2.7
+            gemfile: rails_5_1
+          - ruby: '3.0'
+            gemfile: rails_5_1
+          - ruby: head
+            gemfile: rails_5_1
+          - ruby: 2.2
+            gemfile: rails_5_2
+          - ruby: 2.7
+            gemfile: rails_5_2
+          - ruby: '3.0'
+            gemfile: rails_5_2
+          - ruby: head
+            gemfile: rails_5_2
+          - ruby: 2.2
+            gemfile: rails_6_0
+          - ruby: 2.3
+            gemfile: rails_6_0
+          - ruby: 2.4
+            gemfile: rails_6_0
+          - ruby: '3.0'
+            gemfile: rails_6_0
+          - ruby: head
+            gemfile: rails_6_0
+          - ruby: 2.2
+            gemfile: rails_6_1
+          - ruby: 2.3
+            gemfile: rails_6_1
+          - ruby: 2.4
+            gemfile: rails_6_1
+          - ruby: 2.2
+            gemfile: rails_head
+          - ruby: 2.3
+            gemfile: rails_head
+          - ruby: 2.4
+            gemfile: rails_head
+          - ruby: 2.5
+            gemfile: rails_head
+          - ruby: 2.6
+            gemfile: rails_head
+          - ruby: 2.7
+            gemfile: rails_head
+            experimental: false
+          - ruby: '3.0'
+            gemfile: rails_head
+            experimental: false
+        include:
+          - ruby: 2.7
+            gemfile: rails_head
+            experimental: true
+          - ruby: '3.0'
+            gemfile: rails_head
+            experimental: true
+          - ruby: head
+            gemfile: rails_head
+            experimental: true
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Ruby test
+        run: bundle exec rake

data/Appraisals

@@ -15,7 +15,11 @@ if RUBY_VERSION >= "2.5.0"
     gem "rails", "~> 6.0.0"
   end
 
+  appraise "rails-6-1" do
+    gem "rails", "~> 6.1.0"
+  end
+
   appraise "rails-head" do
-    gem "rails", github: "rails/rails"
+    gem "rails", github: "rails/rails", branch: "main"
   end
 end

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+2.11.2
+------
+
+* [Improve key formatting for nested hashes and disable by default](https://github.com/rails/jbuilder/pull/497)
+
+2.11.1
+------
+
+* Use symbols instead of strings for before_action filters [DHH]
+* Slim down comments in generated scaffold code [DHH]
+
 2.11.0
 ------
 

data/CONTRIBUTING.md

@@ -1,11 +1,11 @@
 Contributing to Jbuilder
 =====================
 
-[![Build Status](https://api.travis-ci.org/rails/jbuilder.svg?branch=master)][travis]
+[![Build Status](https://github.com/rails/jbuilder/workflows/Ruby%20test/badge.svg)][test]
 [![Gem Version](https://badge.fury.io/rb/jbuilder.svg)][gem]
 [![Code Climate](https://codeclimate.com/github/rails/jbuilder/badges/gpa.svg)][codeclimate]
 
-[travis]: https://travis-ci.org/rails/jbuilder
+[test]: https://github.com/rails/jbuilder/actions?query=branch%3Amaster
 [gem]: https://rubygems.org/gems/jbuilder
 [codeclimate]: https://codeclimate.com/github/rails/jbuilder
 
@@ -95,7 +95,7 @@ git push origin my-feature-branch -f
 
 #### Check on Your Pull Request
 
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+Go back to your pull request after a few minutes and see whether it passed muster with GitHub Actions. Everything should look green, otherwise fix issues and amend your commit as described above.
 
 #### Be Patient
 

data/README.md

@@ -108,6 +108,33 @@ json.array! @people, :id, :name
 # => [ { "id": 1, "name": "David" }, { "id": 2, "name": "Jamie" } ]
 ```
 
+To make a plain array without keys, construct and pass in a standard Ruby array.
+
+```ruby
+my_array = %w(David Jamie)
+
+json.people my_array
+
+# => "people": [ "David", "Jamie" ]
+```
+
+You don't always have or need a collection when building an array.
+
+```ruby
+json.people do
+  json.child! do
+    json.id 1
+    json.name 'David'
+  end
+  json.child! do
+    json.id 2
+    json.name 'Jamie'
+  end
+end
+
+# => { "people": [ { "id": 1, "name": "David" }, { "id": 2, "name": "Jamie" } ] }
+```
+
 Jbuilder objects can be directly nested inside each other.  Useful for composing objects.
 
 ``` ruby
@@ -137,7 +164,7 @@ company.to_builder.target!
 ```
 
 You can either use Jbuilder stand-alone or directly as an ActionView template
-language. When required in Rails, you can create views a la show.json.jbuilder
+language. When required in Rails, you can create views à la show.json.jbuilder
 (the json is already yielded):
 
 ``` ruby
@@ -171,19 +198,19 @@ It's also possible to render collections of partials:
 json.array! @posts, partial: 'posts/post', as: :post
 
 # or
-
 json.partial! 'posts/post', collection: @posts, as: :post
 
 # or
-
 json.partial! partial: 'posts/post', collection: @posts, as: :post
 
 # or
-
 json.comments @post.comments, partial: 'comments/comment', as: :comment
 ```
 
-The `as: :some_symbol` is used with partials. It will take care of mapping the passed in object to a variable for the partial. If the value is a collection (either implicitly or explicitly by using the `collection:` option, then each value of the collection is passed to the partial as the variable `some_symbol`. If the value is a singular object, then the object is passed to the partial as the variable `some_symbol`.
+The `as: :some_symbol` is used with partials. It will take care of mapping the passed in object to a variable for the
+partial. If the value is a collection either implicitly or explicitly by using the `collection:` option, then each
+value of the collection is passed to the partial as the variable `some_symbol`. If the value is a singular object,
+then the object is passed to the partial as the variable `some_symbol`.
 
 Be sure not to confuse the `as:` option to mean nesting of the partial. For example:
 
@@ -193,7 +220,7 @@ Be sure not to confuse the `as:` option to mean nesting of the partial. For exam
  json.partial! @comment, as: :comment
 ```
 
-is quite different than:
+is quite different from:
 
 ```ruby
  # comment attributes are nested under a "comment" property
@@ -236,6 +263,8 @@ json.bar "bar"
 # => { "bar": "bar" }
 ```
 
+## Caching
+
 Fragment caching is supported, it uses `Rails.cache` and works like caching in
 HTML templates:
 
@@ -253,9 +282,25 @@ json.cache_if! !admin?, ['v1', @person], expires_in: 10.minutes do
 end
 ```
 
-If you are rendering fragments for a collection of objects, have a look at
-`jbuilder_cache_multi` gem. It uses fetch_multi (>= Rails 4.1) to fetch
-multiple keys at once.
+Aside from that, the `:cached` options on collection rendering is available on Rails >= 6.0. This will cache the
+rendered results effectively using the multi fetch feature.
+
+```ruby
+json.array! @posts, partial: "posts/post", as: :post, cached: true
+
+# or:
+json.comments @post.comments, partial: "comments/comment", as: :comment, cached: true
+```
+
+If your collection cache depends on multiple sources (try to avoid this to keep things simple), you can name all these dependencies as part of a block that returns an array:
+
+```ruby
+json.array! @posts, partial: "posts/post", as: :post, cached: -> post { [post, current_user] }
+```
+
+This will include both records as part of the cache key and updating either of them will expire the cache.
+
+## Formatting Keys
 
 Keys can be auto formatted using `key_format!`, this can be used to convert
 keynames from the standard ruby_format to camelCase:
@@ -274,6 +319,25 @@ environment.rb for example):
 Jbuilder.key_format camelize: :lower
 ```
 
+By default, key format is not applied to keys of hashes that are
+passed to methods like `set!`, `array!` or `merge!`. You can opt into
+deeply transforming these as well:
+
+``` ruby
+json.key_format! camelize: :lower
+json.deep_format_keys!
+json.settings([{some_value: "abc"}])
+
+# => { "settings": [{ "someValue": "abc" }]}
+```
+
+You can set this globally with the class method `deep_format_keys` (from inside your
+environment.rb for example):
+
+``` ruby
+Jbuilder.deep_format_keys true
+```
+
 ## Contributing to Jbuilder
 
 Jbuilder is the work of many contributors. You're encouraged to submit pull requests, propose

data/Rakefile

@@ -2,7 +2,7 @@ require "bundler/setup"
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["CI"]
   require "appraisal/task"
   Appraisal::Task.new
   task default: :appraisal

data/gemfiles/rails_6_1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "mocha", :require => false
+gem "appraisal"
+gem "rails", "~> 6.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_head.gemfile

@@ -5,6 +5,6 @@ source "https://rubygems.org"
 gem "rake"
 gem "mocha", require: false
 gem "appraisal"
-gem "rails", github: "rails/rails"
+gem "rails", github: "rails/rails", branch: "main"
 
 gemspec path: "../"

data/jbuilder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = 'jbuilder'
-  s.version  = '2.11.0'
+  s.version  = '2.11.4'
   s.authors  = 'David Heinemeier Hansson'
   s.email    = 'david@basecamp.com'
   s.summary  = 'Create JSON structures via a Builder-style DSL'

data/lib/generators/rails/templates/api_controller.rb

@@ -4,7 +4,7 @@ require_dependency "<%= namespaced_path %>/application_controller"
 <% end -%>
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApplicationController
-  before_action :set_<%= singular_table_name %>, only: %w[ show update destroy ]
+  before_action :set_<%= singular_table_name %>, only: %i[ show update destroy ]
 
   # GET <%= route_url %>
   # GET <%= route_url %>.json

data/lib/generators/rails/templates/controller.rb

@@ -4,16 +4,14 @@ require_dependency "<%= namespaced_path %>/application_controller"
 <% end -%>
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApplicationController
-  before_action :set_<%= singular_table_name %>, only: %w[ show edit update destroy ]
+  before_action :set_<%= singular_table_name %>, only: %i[ show edit update destroy ]
 
-  # GET <%= route_url %>
-  # GET <%= route_url %>.json
+  # GET <%= route_url %> or <%= route_url %>.json
   def index
     @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
   end
 
-  # GET <%= route_url %>/1
-  # GET <%= route_url %>/1.json
+  # GET <%= route_url %>/1 or <%= route_url %>/1.json
   def show
   end
 
@@ -26,14 +24,13 @@ class <%= controller_class_name %>Controller < ApplicationController
   def edit
   end
 
-  # POST <%= route_url %>
-  # POST <%= route_url %>.json
+  # POST <%= route_url %> or <%= route_url %>.json
   def create
     @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
 
     respond_to do |format|
       if @<%= orm_instance.save %>
-        format.html { redirect_to @<%= singular_table_name %>, notice: <%= %("#{human_name} was successfully created.") %> }
+        format.html { redirect_to <%= show_helper %>, notice: <%= %("#{human_name} was successfully created.") %> }
         format.json { render :show, status: :created, location: <%= "@#{singular_table_name}" %> }
       else
         format.html { render :new, status: :unprocessable_entity }
@@ -42,12 +39,11 @@ class <%= controller_class_name %>Controller < ApplicationController
     end
   end
 
-  # PATCH/PUT <%= route_url %>/1
-  # PATCH/PUT <%= route_url %>/1.json
+  # PATCH/PUT <%= route_url %>/1 or <%= route_url %>/1.json
   def update
     respond_to do |format|
       if @<%= orm_instance.update("#{singular_table_name}_params") %>
-        format.html { redirect_to @<%= singular_table_name %>, notice: <%= %("#{human_name} was successfully updated.") %> }
+        format.html { redirect_to <%= show_helper %>, notice: <%= %("#{human_name} was successfully updated.") %> }
         format.json { render :show, status: :ok, location: <%= "@#{singular_table_name}" %> }
       else
         format.html { render :edit, status: :unprocessable_entity }
@@ -56,10 +52,10 @@ class <%= controller_class_name %>Controller < ApplicationController
     end
   end
 
-  # DELETE <%= route_url %>/1
-  # DELETE <%= route_url %>/1.json
+  # DELETE <%= route_url %>/1 or <%= route_url %>/1.json
   def destroy
     @<%= orm_instance.destroy %>
+
     respond_to do |format|
       format.html { redirect_to <%= index_helper %>_url, notice: <%= %("#{human_name} was successfully destroyed.") %> }
       format.json { head :no_content }

data/lib/jbuilder/collection_renderer.rb

@@ -0,0 +1,108 @@
+require 'delegate'
+require 'active_support/concern'
+
+begin
+  require 'action_view/renderer/collection_renderer'
+rescue LoadError
+  require 'action_view/renderer/partial_renderer'
+end
+
+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 ScopedIterator < ::SimpleDelegator # :nodoc:
+      include Enumerable
+
+      def initialize(obj, scope)
+        super(obj)
+        @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?
+
+        __getobj__.each_with_info do |object, info|
+          @scope.call { yield(object, info) }
+        end
+      end
+    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
+    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
+
+      def render_collection_with_partial(collection, partial, context, block)
+        render(context, @options.merge(collection: collection, partial: partial), block)
+      end
+
+      private
+        def collection_without_template(view)
+          @collection = ScopedIterator.new(@collection, @scope)
+
+          super(view)
+        end
+
+        def collection_with_template(view, template)
+          @collection = ScopedIterator.new(@collection, @scope)
+
+          super(view, template)
+        end
+    end
+  end
+end

data/lib/jbuilder/jbuilder_template.rb

@@ -1,4 +1,5 @@
 require 'jbuilder/jbuilder'
+require 'jbuilder/collection_renderer'
 require 'action_dispatch/http/mime_type'
 require 'active_support/cache'
 
@@ -15,6 +16,38 @@ class JbuilderTemplate < Jbuilder
     super(*args)
   end
 
+  # Generates JSON using the template specified with the `:partial` option. For example, the code below will render
+  # the file `views/comments/_comments.json.jbuilder`, and set a local variable comments with all this message's
+  # comments, which can be used inside the partial.
+  #
+  # Example:
+  #
+  #   json.partial! 'comments/comments', comments: @message.comments
+  #
+  # There are multiple ways to generate a collection of elements as JSON, as ilustrated below:
+  #
+  # Example:
+  #
+  #   json.array! @posts, partial: 'posts/post', as: :post
+  #
+  #   # or:
+  #   json.partial! 'posts/post', collection: @posts, as: :post
+  #
+  #   # or:
+  #   json.partial! partial: 'posts/post', collection: @posts, as: :post
+  #
+  #   # or:
+  #   json.comments @post.comments, partial: 'comments/comment', as: :comment
+  #
+  # Aside from that, the `:cached` options is available on Rails >= 6.0. This will cache the rendered results
+  # effectively using the multi fetch feature.
+  #
+  # Example:
+  #
+  #   json.array! @posts, partial: "posts/post", as: :post, cached: true
+  #
+  #   json.comments @post.comments, partial: "comments/comment", as: :comment, cached: true
+  #
   def partial!(*args)
     if args.one? && _is_active_model?(args.first)
       _render_active_model_partial args.first
@@ -104,11 +137,30 @@ class JbuilderTemplate < Jbuilder
   private
 
   def _render_partial_with_options(options)
-    options.reverse_merge! locals: options.except(:partial, :as, :collection)
+    options.reverse_merge! locals: options.except(:partial, :as, :collection, :cached)
     options.reverse_merge! ::JbuilderTemplate.template_lookup_options
     as = options[:as]
 
-    if as && options.key?(:collection)
+    if as && options.key?(:collection) && CollectionRenderer.supported?
+      collection = options.delete(:collection) || []
+      partial = options.delete(:partial)
+      options[:locals].merge!(json: self)
+
+      if options.has_key?(:layout)
+        raise ::NotImplementedError, "The `:layout' option is not supported in collection rendering."
+      end
+
+      if options.has_key?(:spacer_template)
+        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)
@@ -162,12 +214,7 @@ class JbuilderTemplate < Jbuilder
 
   def _fragment_name_with_digest(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)
-    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
       key
     end

data/lib/jbuilder.rb

@@ -9,12 +9,14 @@ require 'active_support/core_ext/hash/deep_merge'
 class Jbuilder
   @@key_formatter = nil
   @@ignore_nil    = false
+  @@deep_format_keys = false
 
   def initialize(options = {})
     @attributes = {}
 
     @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?
   end
@@ -131,6 +133,31 @@ class Jbuilder
     @@ignore_nil = value
   end
 
+  # Deeply apply key format to nested hashes and arrays passed to
+  # methods like set!, merge! or array!.
+  #
+  # Example:
+  #
+  #   json.key_format! camelize: :lower
+  #   json.settings({some_value: "abc"})
+  #
+  #   { "settings": { "some_value": "abc" }}
+  #
+  #   json.key_format! camelize: :lower
+  #   json.deep_format_keys!
+  #   json.settings({some_value: "abc"})
+  #
+  #   { "settings": { "someValue": "abc" }}
+  #
+  def deep_format_keys!(value = true)
+    @deep_format_keys = value
+  end
+
+  # Same as instance method deep_format_keys! except sets the default.
+  def self.deep_format_keys(value = true)
+    @@deep_format_keys = value
+  end
+
   # Turns the current element into an array and yields a builder to add a hash.
   #
   # Example:
@@ -190,10 +217,10 @@ class Jbuilder
     elsif attributes.any?
       _map_collection(collection) { |element| extract! element, *attributes }
     else
-      collection.to_a
+      _format_keys(collection.to_a)
     end
 
-    merge! array
+    @attributes = _merge_values(@attributes, array)
   end
 
   # Extracts the mentioned attributes or hash elements from the passed object and turns them into attributes of the JSON.
@@ -244,7 +271,7 @@ class Jbuilder
   # Merges hash, array, or Jbuilder instance into current builder.
   def merge!(object)
     hash_or_array = ::Jbuilder === object ? object.attributes! : object
-    @attributes = _merge_values(@attributes, hash_or_array)
+    @attributes = _merge_values(@attributes, _format_keys(hash_or_array))
   end
 
   # Encodes the current builder as JSON.
@@ -255,11 +282,11 @@ class Jbuilder
   private
 
   def _extract_hash_values(object, attributes)
-    attributes.each{ |key| _set_value key, object.fetch(key) }
+    attributes.each{ |key| _set_value key, _format_keys(object.fetch(key)) }
   end
 
   def _extract_method_values(object, attributes)
-    attributes.each{ |key| _set_value key, object.public_send(key) }
+    attributes.each{ |key| _set_value key, _format_keys(object.public_send(key)) }
   end
 
   def _merge_block(key)
@@ -273,11 +300,11 @@ class Jbuilder
     if _blank?(updates)
       current_value
     elsif _blank?(current_value) || updates.nil? || current_value.empty? && ::Array === updates
-      _format_keys(updates)
+      updates
     elsif ::Array === current_value && ::Array === updates
-      current_value + _format_keys(updates)
+      current_value + updates
     elsif ::Hash === current_value && ::Hash === updates
-      current_value.deep_merge(_format_keys(updates))
+      current_value.deep_merge(updates)
     else
       raise MergeError.build(current_value, updates)
     end
@@ -288,6 +315,8 @@ class Jbuilder
   end
 
   def _format_keys(hash_or_array)
+    return hash_or_array unless @deep_format_keys
+
     if ::Array === hash_or_array
       hash_or_array.map { |value| _format_keys(value) }
     elsif ::Hash === hash_or_array
@@ -312,12 +341,12 @@ class Jbuilder
   end
 
   def _scope
-    parent_attributes, parent_formatter = @attributes, @key_formatter
+    parent_attributes, parent_formatter, parent_deep_format_keys = @attributes, @key_formatter, @deep_format_keys
     @attributes = BLANK
     yield
     @attributes
   ensure
-    @attributes, @key_formatter = parent_attributes, parent_formatter
+    @attributes, @key_formatter, @deep_format_keys = parent_attributes, parent_formatter, parent_deep_format_keys
   end
 
   def _is_collection?(object)

data/test/jbuilder_dependency_tracker_test.rb

@@ -61,7 +61,7 @@ class JbuilderDependencyTrackerTest < ActiveSupport::TestCase
       assert_equal %w[comments/comment], dependencies
     end
 
-    test 'detects explicit depedency' do
+    test 'detects explicit dependency' do
       dependencies = track_dependencies <<-RUBY
         # Template Dependency: path/to/partial
         json.foo 'bar'

data/test/jbuilder_template_test.rb

@@ -159,7 +159,7 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
   end
 
   test "object fragment caching with expiry" do
-    travel_to "2018-05-12 11:29:00 -0400"
+    travel_to Time.iso8601("2018-05-12T11:29:00-04:00")
 
     render <<-JBUILDER
       json.cache! "cache-key", expires_in: 1.minute do
@@ -283,6 +283,101 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "David", result["firstName"]
   end
 
+  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: [])
+
+      # 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
+        alias length count # Rails 6.1 requires this.
+
+        def each(&block)
+          [].each(&block)
+        end
+      end
+
+      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
+
+    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"
+        }
+      }
+
+      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
+
+      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
+
+      assert_equal "The `:spacer_template' option is not supported in collection rendering.", error.message
+    end
+  end
+
   private
     def render(*args)
       JSON.load render_without_parsing(*args)
@@ -290,7 +385,7 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
 
     def render_without_parsing(source, assigns = {})
       view = build_view(fixtures: PARTIALS.merge("source.json.jbuilder" => source), assigns: assigns)
-      view.render(template: "source.json.jbuilder")
+      view.render(template: "source")
     end
 
     def build_view(options = {})
@@ -306,6 +401,9 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
       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

data/test/jbuilder_test.rb

@@ -312,7 +312,7 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal 'world', result['comments'].second['content']
   end
 
-  test 'nesting multiple chilren from a non-Enumerable that responds to #map with inline loop' do
+  test 'nesting multiple children from a non-Enumerable that responds to #map with inline loop' do
     comments = NonEnumerable.new([ Comment.new('hello', 1), Comment.new('world', 2) ])
 
     result = jbuild do |json|
@@ -566,6 +566,36 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal 'one', result['level1']
   end
 
+  test 'key_format! can be changed in child elements' do
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+
+      json.level_one do
+        json.key_format! :upcase
+        json.value 'two'
+      end
+    end
+
+    assert_equal ['levelOne'], result.keys
+    assert_equal ['VALUE'], result['levelOne'].keys
+  end
+
+  test 'key_format! can be changed in array!' do
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+
+      json.level_one do
+        json.array! [{value: 'two'}] do |object|
+          json.key_format! :upcase
+          json.value object[:value]
+        end
+      end
+    end
+
+    assert_equal ['levelOne'], result.keys
+    assert_equal ['VALUE'], result['levelOne'][0].keys
+  end
+
   test 'key_format! with no parameter' do
     result = jbuild do |json|
       json.key_format! :upcase
@@ -593,51 +623,121 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal ['oats and friends'], result.keys
   end
 
-  test 'key_format! with merge!' do
+  test 'key_format! is not applied deeply by default' do
+    names = { first_name: 'camel', last_name: 'case' }
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.set! :all_names, names
+    end
+
+    assert_equal %i[first_name last_name], result['allNames'].keys
+  end
+
+  test 'applying key_format! deeply can be enabled per scope' do
+    names = { first_name: 'camel', last_name: 'case' }
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.scope do
+        json.deep_format_keys!
+        json.set! :all_names, names
+      end
+      json.set! :all_names, names
+    end
+
+    assert_equal %w[firstName lastName], result['scope']['allNames'].keys
+    assert_equal %i[first_name last_name], result['allNames'].keys
+  end
+
+  test 'applying key_format! deeply can be disabled per scope' do
+    names = { first_name: 'camel', last_name: 'case' }
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.deep_format_keys!
+      json.set! :all_names, names
+      json.scope do
+        json.deep_format_keys! false
+        json.set! :all_names, names
+      end
+    end
+
+    assert_equal %w[firstName lastName], result['allNames'].keys
+    assert_equal %i[first_name last_name], result['scope']['allNames'].keys
+  end
+
+  test 'applying key_format! deeply can be enabled globally' do
+    names = { first_name: 'camel', last_name: 'case' }
+
+    Jbuilder.deep_format_keys true
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.set! :all_names, names
+    end
+
+    assert_equal %w[firstName lastName], result['allNames'].keys
+    Jbuilder.send(:class_variable_set, '@@deep_format_keys', false)
+  end
+
+  test 'deep key_format! with merge!' do
     hash = { camel_style: 'for JS' }
     result = jbuild do |json|
       json.key_format! camelize: :lower
+      json.deep_format_keys!
       json.merge! hash
     end
 
     assert_equal ['camelStyle'], result.keys
   end
 
-  test 'key_format! with merge! deep' do
+  test 'deep key_format! with merge! deep' do
     hash = { camel_style: { sub_attr: 'for JS' } }
     result = jbuild do |json|
       json.key_format! camelize: :lower
+      json.deep_format_keys!
       json.merge! hash
     end
 
     assert_equal ['subAttr'], result['camelStyle'].keys
   end
 
-  test 'key_format! with set! array of hashes' do
+  test 'deep key_format! with set! array of hashes' do
     names = [{ first_name: 'camel', last_name: 'case' }]
     result = jbuild do |json|
       json.key_format! camelize: :lower
+      json.deep_format_keys!
       json.set! :names, names
     end
 
     assert_equal %w[firstName lastName], result['names'][0].keys
   end
 
-  test 'key_format! with array! of hashes' do
+  test 'deep key_format! with set! extracting hash from object' do
+    comment = Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.deep_format_keys!
+      json.set! :comment, comment, :author
+    end
+
+    assert_equal %w[firstName lastName], result['comment']['author'].keys
+  end
+
+  test 'deep key_format! with array! of hashes' do
     names = [{ first_name: 'camel', last_name: 'case' }]
     result = jbuild do |json|
       json.key_format! camelize: :lower
+      json.deep_format_keys!
       json.array! names
     end
 
     assert_equal %w[firstName lastName], result[0].keys
   end
 
-  test 'key_format! with merge! array of hashes' do
+  test 'deep key_format! with merge! array of hashes' do
     names = [{ first_name: 'camel', last_name: 'case' }]
     new_names = [{ first_name: 'snake', last_name: 'case' }]
     result = jbuild do |json|
       json.key_format! camelize: :lower
+      json.deep_format_keys!
       json.array! names
       json.merge! new_names
     end
@@ -645,6 +745,39 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal %w[firstName lastName], result[1].keys
   end
 
+  test 'deep key_format! is applied to hash extracted from object' do
+    comment = Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.deep_format_keys!
+      json.extract! comment, :author
+    end
+
+    assert_equal %w[firstName lastName], result['author'].keys
+  end
+
+  test 'deep key_format! is applied to hash extracted from hash' do
+    comment = {author: { first_name: 'camel', last_name: 'case' }}
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.deep_format_keys!
+      json.extract! comment, :author
+    end
+
+    assert_equal %w[firstName lastName], result['author'].keys
+  end
+
+  test 'deep key_format! is applied to hash extracted directly from array' do
+    comments = [Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })]
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.deep_format_keys!
+      json.array! comments, :author
+    end
+
+    assert_equal %w[firstName lastName], result[0]['author'].keys
+  end
+
   test 'default key_format!' do
     Jbuilder.key_format camelize: :lower
     result = jbuild{ |json| json.camel_style 'for JS' }

data/test/scaffold_api_controller_generator_test.rb

@@ -47,7 +47,7 @@ if Rails::VERSION::MAJOR > 4
       end
     end
 
-    test 'dont use require and permit if there are no attributes' do
+    test "don't use require and permit if there are no attributes" do
       run_generator %w(Post --api)
 
       assert_file 'app/controllers/posts_controller.rb' do |content|

data/test/scaffold_controller_generator_test.rb

@@ -31,14 +31,14 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
       assert_instance_method :create, content do |m|
         assert_match %r{@post = Post\.new\(post_params\)}, m
         assert_match %r{@post\.save}, m
-        assert_match %r{format\.html \{ redirect_to @post, notice: "Post was successfully created\." \}}, m
+        assert_match %r{format\.html \{ redirect_to post_url\(@post\), notice: "Post was successfully created\." \}}, m
         assert_match %r{format\.json \{ render :show, status: :created, location: @post \}}, m
         assert_match %r{format\.html \{ render :new, status: :unprocessable_entity \}}, m
         assert_match %r{format\.json \{ render json: @post\.errors, status: :unprocessable_entity \}}, m
       end
 
       assert_instance_method :update, content do |m|
-        assert_match %r{format\.html \{ redirect_to @post, notice: "Post was successfully updated\." \}}, m
+        assert_match %r{format\.html \{ redirect_to post_url\(@post\), notice: "Post was successfully updated\." \}}, m
         assert_match %r{format\.json \{ render :show, status: :ok, location: @post \}}, m
         assert_match %r{format\.html \{ render :edit, status: :unprocessable_entity \}}, m
         assert_match %r{format\.json \{ render json: @post.errors, status: :unprocessable_entity \}}, m
@@ -59,7 +59,26 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
     end
   end
 
-  test 'dont use require and permit if there are no attributes' do
+  if Rails::VERSION::MAJOR >= 6
+    test 'controller with namespace' do
+      run_generator %w(Admin::Post --model-name=Post)
+      assert_file 'app/controllers/admin/posts_controller.rb' do |content|
+        assert_instance_method :create, content do |m|
+          assert_match %r{format\.html \{ redirect_to admin_post_url\(@post\), notice: "Post was successfully created\." \}}, m
+        end
+
+        assert_instance_method :update, content do |m|
+          assert_match %r{format\.html \{ redirect_to admin_post_url\(@post\), notice: "Post was successfully updated\." \}}, m
+        end
+
+        assert_instance_method :destroy, content do |m|
+          assert_match %r{format\.html \{ redirect_to admin_posts_url, notice: "Post was successfully destroyed\." \}}, m
+        end
+      end
+    end
+  end
+
+  test "don't use require and permit if there are no attributes" do
     run_generator %w(Post)
 
     assert_file 'app/controllers/posts_controller.rb' do |content|

data/test/test_helper.rb

@@ -21,7 +21,13 @@ class << Rails
   end
 end
 
-class Post < Struct.new(:id, :body, :author_name); end
+Jbuilder::CollectionRenderer.collection_cache = Rails.cache
+
+class Post < Struct.new(:id, :body, :author_name)
+  def cache_key
+    "post-#{id}"
+  end
+end
 
 class Racer < Struct.new(:id, :name)
   extend ActiveModel::Naming
@@ -29,6 +35,3 @@ class Racer < Struct.new(:id, :name)
 end
 
 ActionView::Template.register_template_handler :jbuilder, JbuilderHandler
-
-ActionView::Base.remove_possible_method :fragment_name_with_digest
-ActionView::Base.remove_possible_method :cache_fragment_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.11.4
 platform: ruby
 authors:
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,14 +24,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
-description: 
+description:
 email: david@basecamp.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -43,6 +43,7 @@ files:
 - gemfiles/rails_5_1.gemfile
 - gemfiles/rails_5_2.gemfile
 - gemfiles/rails_6_0.gemfile
+- gemfiles/rails_6_1.gemfile
 - gemfiles/rails_head.gemfile
 - jbuilder.gemspec
 - lib/generators/rails/jbuilder_generator.rb
@@ -54,6 +55,7 @@ files:
 - lib/generators/rails/templates/show.json.jbuilder
 - lib/jbuilder.rb
 - lib/jbuilder/blank.rb
+- lib/jbuilder/collection_renderer.rb
 - lib/jbuilder/dependency_tracker.rb
 - lib/jbuilder/errors.rb
 - lib/jbuilder/jbuilder.rb
@@ -71,7 +73,7 @@ homepage: https://github.com/rails/jbuilder
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,8 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Create JSON structures via a Builder-style DSL
 test_files:

data/.travis.yml

@@ -1,52 +0,0 @@
-language: ruby
-
-cache: bundler
-
-before_install:
-  - "gem install bundler -v '<2'"
-
-rvm:
-  - 2.2.10
-  - 2.3.8
-  - 2.4.10
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-  - ruby-head
-
-gemfile:
-  - gemfiles/rails_5_0.gemfile
-  - gemfiles/rails_5_1.gemfile
-  - gemfiles/rails_5_2.gemfile
-  - gemfiles/rails_6_0.gemfile
-  - gemfiles/rails_head.gemfile
-
-matrix:
-  exclude:
-    - rvm: 2.7.1
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 2.7.1
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: 2.2.10
-      gemfile: gemfiles/rails_5_2.gemfile
-    - rvm: 2.7.1
-      gemfile: gemfiles/rails_5_2.gemfile
-    - rvm: 2.2.10
-      gemfile: gemfiles/rails_6_0.gemfile
-    - rvm: 2.3.8
-      gemfile: gemfiles/rails_6_0.gemfile
-    - rvm: 2.4.10
-      gemfile: gemfiles/rails_6_0.gemfile
-    - rvm: 2.2.10
-      gemfile: gemfiles/rails_head.gemfile
-    - rvm: 2.3.8
-      gemfile: gemfiles/rails_head.gemfile
-    - rvm: 2.4.10
-      gemfile: gemfiles/rails_head.gemfile
-  allow_failures:
-    - rvm: ruby-head
-    - gemfile: gemfiles/rails_head.gemfile
-  fast_finish: true
-
-notifications:
-  email: false