jbuilder 2.11.3 → 2.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dacba51a263fc3bcbea4471ae1557dea10c014f68657a39ab812e55a167eba9
-  data.tar.gz: 544f954ce6f89f7775853b91bfc99f5f1634596389f5750028e13532b314a63c
+  metadata.gz: 071e52598986c430c4bc79a185a0229eceb11c3f38f12ee5a6bd6f9c16f7008c
+  data.tar.gz: 73e82bf90e7049fb735ba139521daf1e0291fbd8e704a1523f7aa4f97e395185
 SHA512:
-  metadata.gz: a71638ae38f5755b97a40db81c2121f92788b3e4242de6d4789032f0ff7bab4f62d2dd96b7cab19e8583ee448946bb2e66e8cf5f6ab65c7b514ff88c19af1407
-  data.tar.gz: cd3477c065ebdbacc5da5d383973e996499cce7872d8303691376739732735441b003981a767af1bdb8ccea6648685291ff20e81c662a95ad54c87205ba233f9
+  metadata.gz: fca112fc608e7fee45bc1b90ddb5430205d462955f458d1c5fff0d3d716a40ddd7cfc3383465f2eb727b82bfb3b1b226508df7ae77779c3655661324ee8d4963
+  data.tar.gz: 5a250b8e997d56eeeef8b3630cbdc98a6b88e78c06cd3524fb0f5518939ed10ff38bcb9dcc9c8470925f881c5b0690298af019ff16db4a162bee3207f5e6bfd6

data/.github/workflows/ruby.yml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 jobs:
   test:
-    name: Ruby test
+    name: Ruby ${{ matrix.ruby }} (${{ matrix.gemfile }})
     runs-on: ubuntu-20.04
     continue-on-error: ${{ matrix.experimental }}
     env:
@@ -14,82 +14,82 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [
-          2.2.10,
-          2.3.8,
-          2.4.10,
-          2.5.8,
-          2.6.6,
-          2.7.1,
-          3.0.0
-        ]
-        gemfile: [
-          "rails_5_0",
-          "rails_5_1",
-          "rails_5_2",
-          "rails_6_0",
-          "rails_6_1",
-          "rails_head"
-        ]
+        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.1
+          - ruby: 2.7
             gemfile: rails_5_0
-          - ruby: 3.0.0
+          - ruby: '3.0'
             gemfile: rails_5_0
           - ruby: head
             gemfile: rails_5_0
-          - ruby: 2.7.1
+          - ruby: 2.7
             gemfile: rails_5_1
-          - ruby: 3.0.0
+          - ruby: '3.0'
             gemfile: rails_5_1
           - ruby: head
             gemfile: rails_5_1
-          - ruby: 2.2.10
+          - ruby: 2.2
             gemfile: rails_5_2
-          - ruby: 2.7.1
+          - ruby: 2.7
             gemfile: rails_5_2
-          - ruby: 3.0.0
+          - ruby: '3.0'
             gemfile: rails_5_2
           - ruby: head
             gemfile: rails_5_2
-          - ruby: 2.2.10
+          - ruby: 2.2
             gemfile: rails_6_0
-          - ruby: 2.3.8
+          - ruby: 2.3
             gemfile: rails_6_0
-          - ruby: 2.4.10
+          - ruby: 2.4
             gemfile: rails_6_0
-          - ruby: 3.0.0
+          - ruby: '3.0'
             gemfile: rails_6_0
           - ruby: head
             gemfile: rails_6_0
-          - ruby: 2.2.10
+          - ruby: 2.2
             gemfile: rails_6_1
-          - ruby: 2.3.8
+          - ruby: 2.3
             gemfile: rails_6_1
-          - ruby: 2.4.10
+          - ruby: 2.4
             gemfile: rails_6_1
-          - ruby: 2.2.10
+          - ruby: 2.2
             gemfile: rails_head
-          - ruby: 2.3.8
+          - ruby: 2.3
             gemfile: rails_head
-          - ruby: 2.4.10
+          - ruby: 2.4
             gemfile: rails_head
-          - ruby: 2.5.8
+          - ruby: 2.5
             gemfile: rails_head
-          - ruby: 2.6.6
+          - ruby: 2.6
             gemfile: rails_head
-          - ruby: 2.7.1
+          - ruby: 2.7
             gemfile: rails_head
             experimental: false
-          - ruby: 3.0.0
+          - ruby: '3.0'
             gemfile: rails_head
             experimental: false
         include:
-          - ruby: 2.7.1
+          - ruby: 2.7
             gemfile: rails_head
             experimental: true
-          - ruby: 3.0.0
+          - ruby: '3.0'
             gemfile: rails_head
             experimental: true
           - ruby: head

data/README.md

@@ -110,12 +110,13 @@ json.array! @people, :id, :name
 
 To make a plain array without keys, construct and pass in a standard Ruby array.
 
-``` ruby
+```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.
 
@@ -284,13 +285,21 @@ end
 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

data/jbuilder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = 'jbuilder'
-  s.version  = '2.11.3'
+  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/controller.rb

@@ -30,7 +30,7 @@ class <%= controller_class_name %>Controller < ApplicationController
 
     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 }
@@ -43,7 +43,7 @@ class <%= controller_class_name %>Controller < ApplicationController
   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 }
@@ -55,6 +55,7 @@ class <%= controller_class_name %>Controller < ApplicationController
   # 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/jbuilder_template.rb

@@ -141,9 +141,7 @@ class JbuilderTemplate < Jbuilder
     options.reverse_merge! ::JbuilderTemplate.template_lookup_options
     as = options[:as]
 
-    if options.key?(:collection) && (options[:collection].nil? || options[:collection].empty?)
-      array!
-    elsif as && options.key?(:collection) && CollectionRenderer.supported?
+    if as && options.key?(:collection) && CollectionRenderer.supported?
       collection = options.delete(:collection) || []
       partial = options.delete(:partial)
       options[:locals].merge!(json: self)
@@ -156,9 +154,11 @@ class JbuilderTemplate < Jbuilder
         raise ::NotImplementedError, "The `:spacer_template' option is not supported in collection rendering."
       end
 
-      CollectionRenderer
+      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

data/test/jbuilder_template_test.rb

@@ -291,6 +291,22 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
       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)
 
@@ -318,6 +334,33 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
       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)

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,6 +59,25 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
     end
   end
 
+  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)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 2.11.3
+  version: 2.11.4
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-14 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Create JSON structures via a Builder-style DSL