jbuilder 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4178787c12de3a44e4d47e347b7eb81da4cbb75222f9726db40b22124998041e
-  data.tar.gz: 967cc31e472ad0e381e9c87f27e29be40aa2c71db6fb9f9131ef53b434bd3e5b
+  metadata.gz: 23152c62d2a748a3a3b190dba588de44dbb8577aff5ad930fa6aa7e29e935e50
+  data.tar.gz: 1a79f24f284ede18d9aea34702fe7bff5f70064c8dd6d8a372e8bd9ec4f5d266
 SHA512:
-  metadata.gz: ace71a1fc2424b0d9428d66f595f155367763d6d8d28a21e87838418259f8c2d3d370c3a96a7134b5aac729fb5007f053de5a6f0bebcc3d4a4c13f5e9deb0d92
-  data.tar.gz: 4b0b4992c64d2bbbfb83a343800555456a7c201d5f5fc19c5e919fd9ed9a1d448f7b902d841c99666c9794c70e15ad8b1cb94d5de4f61caca95901bbead3f046
+  metadata.gz: 0fb3a664bd96a0263ed6a155b385a634efcb26e157a1e8d7592da3f3baa1a4ed6d717bead553169d1fd6e540a35f1847925195e07ede281e6d845e6f649cd537
+  data.tar.gz: c9d1fd1cc89b68ffea4b5b6090ae2ed1de25e75442923a2dc9b16fda0bdfbdb7470d8ada71657d06ad8db1c64c41acacf1e1235891c794c146b3e16758978cff

data/.github/workflows/ruby.yml

@@ -15,64 +15,21 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - "2.7"
           - "3.0"
           - "3.1"
           - "3.2"
           - "3.3"
 
         gemfile:
-          - "rails_6_1"
           - "rails_7_0"
           - "rails_7_1"
           - "rails_head"
 
         exclude:
-          - ruby: 2.7
-            gemfile: rails_head
           - ruby: '3.0'
             gemfile: rails_head
 
         include:
-          - ruby: 2.2
-            gemfile: rails_5_0
-          - ruby: 2.2
-            gemfile: rails_5_1
-          - ruby: 2.3
-            gemfile: rails_5_0
-          - ruby: 2.3
-            gemfile: rails_5_1
-          - ruby: 2.3
-            gemfile: rails_5_2
-          - ruby: 2.4
-            gemfile: rails_5_0
-          - ruby: 2.4
-            gemfile: rails_5_1
-          - ruby: 2.4
-            gemfile: rails_5_2
-          - ruby: 2.5
-            gemfile: rails_5_0
-          - ruby: 2.5
-            gemfile: rails_5_1
-          - ruby: 2.5
-            gemfile: rails_5_2
-          - ruby: 2.5
-            gemfile: rails_6_0
-          - ruby: 2.5
-            gemfile: rails_6_1
-          - ruby: 2.6
-            gemfile: rails_5_0
-          - ruby: 2.6
-            gemfile: rails_5_1
-          - ruby: 2.6
-            gemfile: rails_5_2
-          - ruby: 2.6
-            gemfile: rails_6_0
-          - ruby: 2.6
-            gemfile: rails_6_1
-          - ruby: 2.7
-            gemfile: rails_6_0
-
           - ruby: '3.1'
             gemfile: rails_head
           - ruby: '3.2'

data/Appraisals

@@ -1,30 +1,3 @@
-if RUBY_VERSION < "2.7.0"
-  appraise "rails-5-0" do
-    gem "rails", "~> 5.0.0"
-    gem "loofah", "< 2.21.0"
-  end
-
-  appraise "rails-5-1" do
-    gem "rails", "~> 5.1.0"
-    gem "loofah", "< 2.21.0"
-  end
-
-  appraise "rails-5-2" do
-    gem "rails", "~> 5.2.0"
-    gem "loofah", "< 2.21.0"
-  end
-end
-
-if RUBY_VERSION >= "2.5.0"
-  appraise "rails-6-0" do
-    gem "rails", "~> 6.0.0"
-  end
-
-  appraise "rails-6-1" do
-    gem "rails", "~> 6.1.0"
-  end
-end
-
 if RUBY_VERSION >= "2.7.0"
   appraise "rails-7-0" do
     gem "rails", "~> 7.0.0"

data/CONTRIBUTING.md

@@ -33,13 +33,7 @@ git checkout -b my-feature-branch
 
 #### Bundle Install and Test
 
-Ensure that you can build the project and run tests.
-
-```
-bundle install
-appraisal install
-appraisal rake test
-```
+Ensure that you can build the project and run tests using `bin/test`.
 
 #### Write Tests
 

data/bin/release

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+VERSION=$1
+
+printf "class Jbuilder\n  VERSION = \"$VERSION\"\nend\n" > ./lib/jbuilder/version.rb
+bundle
+git add lib/jbuilder/version.rb
+git commit -m "Bump version for $VERSION"
+git push
+git tag v$VERSION
+git push --tags
+gem build jbuilder.gemspec
+gem push "jbuilder-$VERSION.gem" --host https://rubygems.org
+rm "jbuilder-$VERSION.gem"

data/bin/test

@@ -0,0 +1,6 @@
+#!/bin/env bash
+set -e
+
+bundle install
+appraisal install
+appraisal rake test

data/jbuilder.gemspec

@@ -1,6 +1,8 @@
+require_relative "lib/jbuilder/version"
+
 Gem::Specification.new do |s|
   s.name     = 'jbuilder'
-  s.version  = '2.12.0'
+  s.version  = Jbuilder::VERSION
   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

@@ -48,13 +48,19 @@ class <%= controller_class_name %>Controller < ApplicationController
   private
     # Use callbacks to share common setup or constraints between actions.
     def set_<%= singular_table_name %>
+      <%- if Rails::VERSION::MAJOR >= 8 -%>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params.expect(:id)") %>
+      <%- else -%>
       @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+      <%- end -%>
     end
 
     # Only allow a list of trusted parameters through.
     def <%= "#{singular_table_name}_params" %>
       <%- if attributes_names.empty? -%>
       params.fetch(<%= ":#{singular_table_name}" %>, {})
+      <%- elsif Rails::VERSION::MAJOR >= 8 -%>
+      params.expect(<%= singular_table_name %>: [ <%= permitted_params %> ])
       <%- else -%>
       params.require(<%= ":#{singular_table_name}" %>).permit(<%= permitted_params %>)
       <%- end -%>

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 <%= show_helper %>, notice: <%= %("#{human_name} was successfully created.") %> }
+        format.html { redirect_to <%= redirect_resource_name %>, 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 <%= show_helper %>, notice: <%= %("#{human_name} was successfully updated.") %> }
+        format.html { redirect_to <%= redirect_resource_name %>, notice: <%= %("#{human_name} was successfully updated.") %> }
         format.json { render :show, status: :ok, location: <%= "@#{singular_table_name}" %> }
       else
         format.html { render :edit, status: :unprocessable_entity }
@@ -57,7 +57,7 @@ class <%= controller_class_name %>Controller < ApplicationController
     @<%= orm_instance.destroy %>
 
     respond_to do |format|
-      format.html { redirect_to <%= index_helper %>_url, notice: <%= %("#{human_name} was successfully destroyed.") %> }
+      format.html { redirect_to <%= index_helper %>_path, status: :see_other, notice: <%= %("#{human_name} was successfully destroyed.") %> }
       format.json { head :no_content }
     end
   end
@@ -65,13 +65,19 @@ class <%= controller_class_name %>Controller < ApplicationController
   private
     # Use callbacks to share common setup or constraints between actions.
     def set_<%= singular_table_name %>
+      <%- if Rails::VERSION::MAJOR >= 8 -%>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params.expect(:id)") %>
+      <%- else -%>
       @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+      <%- end -%>
     end
 
     # Only allow a list of trusted parameters through.
     def <%= "#{singular_table_name}_params" %>
       <%- if attributes_names.empty? -%>
       params.fetch(<%= ":#{singular_table_name}" %>, {})
+      <%- elsif Rails::VERSION::MAJOR >= 8 -%>
+      params.expect(<%= singular_table_name %>: [ <%= permitted_params %> ])
       <%- else -%>
       params.require(<%= ":#{singular_table_name}" %>).permit(<%= permitted_params %>)
       <%- end -%>

data/lib/jbuilder/jbuilder_template.rb

@@ -155,21 +155,30 @@ 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?
+      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
     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?
+        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
+      else
+        array!
       end
     else
       _render_partial options

data/lib/jbuilder/version.rb

@@ -0,0 +1,3 @@
+class Jbuilder
+  VERSION = "2.13.0"
+end

data/lib/jbuilder.rb

@@ -3,12 +3,9 @@ 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'
-begin
-  require 'ostruct'
-rescue LoadError
-end
 
 class Jbuilder
   @@key_formatter = nil
@@ -31,7 +28,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?
@@ -354,7 +350,7 @@ class Jbuilder
   end
 
   def _is_collection?(object)
-    _object_respond_to?(object, :map, :count) && NON_ENUMERABLES.none?{ |klass| klass === object }
+    _object_respond_to?(object, :map, :count) && !(::Struct === object)
   end
 
   def _blank?(value=@attributes)

data/test/jbuilder_template_test.rb

@@ -98,10 +98,12 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
   end
 
   test "nil partial collection by name" do
+    Jbuilder::CollectionRenderer.expects(:new).never
     assert_equal [], render('json.partial! "post", collection: @posts, as: :post', posts: nil)
   end
 
   test "nil partial collection by options" do
+    Jbuilder::CollectionRenderer.expects(:new).never
     assert_equal [], render('json.partial! partial: "post", collection: @posts, as: :post', posts: nil)
   end
 
@@ -113,7 +115,13 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "Pavel", result[5]["author"]["first_name"]
   end
 
+  test "empty array of partials from empty collection" do
+    Jbuilder::CollectionRenderer.expects(:new).never
+    assert_equal [], render('json.array! @posts, partial: "post", as: :post', posts: [])
+  end
+
   test "empty array of partials from nil collection" do
+    Jbuilder::CollectionRenderer.expects(:new).never
     assert_equal [], render('json.array! @posts, partial: "post", as: :post', posts: nil)
   end
 
@@ -126,10 +134,17 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
   end
 
   test "empty array of partials under key from nil collection" do
+    Jbuilder::CollectionRenderer.expects(:new).never
     result = render('json.posts @posts, partial: "post", as: :post', posts: nil)
     assert_equal [], result["posts"]
   end
 
+  test "empty array of partials under key from an empy collection" do
+    Jbuilder::CollectionRenderer.expects(:new).never
+    result = render('json.posts @posts, partial: "post", as: :post', posts: [])
+    assert_equal [], result["posts"]
+  end
+
   test "object fragment caching" do
     render(<<-JBUILDER)
       json.cache! "cache-key" do
@@ -293,6 +308,7 @@ class JbuilderTemplateTest < ActiveSupport::TestCase
 
   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: [])
 
       # Do not use #assert_empty as it is important to ensure that the type of the JSON result is an array.

data/test/scaffold_api_controller_generator_test.rb

@@ -38,8 +38,17 @@ if Rails::VERSION::MAJOR > 4
           assert_match %r{@post\.destroy}, m
         end
 
+        assert_match %r{def set_post}, content
+        if Rails::VERSION::MAJOR >= 8
+          assert_match %r{params\.expect\(:id\)}, content
+        else
+          assert_match %r{params\[:id\]}, content
+        end
+
         assert_match %r{def post_params}, content
-        if Rails::VERSION::MAJOR >= 6
+        if Rails::VERSION::MAJOR >= 8
+          assert_match %r{params\.expect\(post: \[ :title, :body, images: \[\] \]\)}, content
+        elsif Rails::VERSION::MAJOR >= 6
           assert_match %r{params\.require\(:post\)\.permit\(:title, :body, images: \[\]\)}, content
         else
           assert_match %r{params\.require\(:post\)\.permit\(:title, :body, :images\)}, content
@@ -62,7 +71,11 @@ if Rails::VERSION::MAJOR > 4
         run_generator ["Message", "content:rich_text", "video:attachment", "photos:attachments"]
 
         assert_file 'app/controllers/messages_controller.rb' do |content|
-          assert_match %r{params\.require\(:message\)\.permit\(:content, :video, photos: \[\]\)}, content
+          if Rails::VERSION::MAJOR >= 8
+            assert_match %r{params\.expect\(message: \[ :content, :video, photos: \[\] \]\)}, content
+          else
+            assert_match %r{params\.require\(:message\)\.permit\(:content, :video, photos: \[\]\)}, content
+          end
         end
       end
     end

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_url\(@post\), notice: "Post was successfully created\." \}}, m
+        assert_match %r{format\.html \{ redirect_to @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_url\(@post\), notice: "Post was successfully updated\." \}}, m
+        assert_match %r{format\.html \{ redirect_to @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
@@ -46,12 +46,21 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
 
       assert_instance_method :destroy, content do |m|
         assert_match %r{@post\.destroy}, m
-        assert_match %r{format\.html \{ redirect_to posts_url, notice: "Post was successfully destroyed\." \}}, m
+        assert_match %r{format\.html \{ redirect_to posts_path, status: :see_other, notice: "Post was successfully destroyed\." \}}, m
         assert_match %r{format\.json \{ head :no_content \}}, m
       end
 
+      assert_match %r{def set_post}, content
+      if Rails::VERSION::MAJOR >= 8
+        assert_match %r{params\.expect\(:id\)}, content
+      else
+        assert_match %r{params\[:id\]}, content
+      end
+
       assert_match %r{def post_params}, content
-      if Rails::VERSION::MAJOR >= 6
+      if Rails::VERSION::MAJOR >= 8
+        assert_match %r{params\.expect\(post: \[ :title, :body, images: \[\] \]\)}, content
+      elsif Rails::VERSION::MAJOR >= 6
         assert_match %r{params\.require\(:post\)\.permit\(:title, :body, images: \[\]\)}, content
       else
         assert_match %r{params\.require\(:post\)\.permit\(:title, :body, :images\)}, content
@@ -64,15 +73,15 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
       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
+          assert_match %r{format\.html \{ redirect_to \[:admin, @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
+          assert_match %r{format\.html \{ redirect_to \[:admin, @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
+          assert_match %r{format\.html \{ redirect_to admin_posts_path, status: :see_other, notice: "Post was successfully destroyed\." \}}, m
         end
       end
     end
@@ -92,7 +101,11 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
       run_generator %w(Message content:rich_text video:attachment photos:attachments)
 
       assert_file 'app/controllers/messages_controller.rb' do |content|
-        assert_match %r{params\.require\(:message\)\.permit\(:content, :video, photos: \[\]\)}, content
+        if Rails::VERSION::MAJOR >= 8
+          assert_match %r{params\.expect\(message: \[ :content, :video, photos: \[\] \]\)}, content
+        else
+          assert_match %r{params\.require\(:message\)\.permit\(:content, :video, photos: \[\]\)}, content
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,11 +52,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- gemfiles/rails_5_0.gemfile
-- gemfiles/rails_5_1.gemfile
-- gemfiles/rails_5_2.gemfile
-- gemfiles/rails_6_0.gemfile
-- gemfiles/rails_6_1.gemfile
+- bin/release
+- bin/test
 - gemfiles/rails_7_0.gemfile
 - gemfiles/rails_7_1.gemfile
 - gemfiles/rails_head.gemfile
@@ -77,6 +74,7 @@ files:
 - lib/jbuilder/jbuilder_template.rb
 - lib/jbuilder/key_formatter.rb
 - lib/jbuilder/railtie.rb
+- lib/jbuilder/version.rb
 - test/jbuilder_dependency_tracker_test.rb
 - test/jbuilder_generator_test.rb
 - test/jbuilder_template_test.rb
@@ -89,9 +87,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/jbuilder/issues
-  changelog_uri: https://github.com/rails/jbuilder/releases/tag/v2.12.0
+  changelog_uri: https://github.com/rails/jbuilder/releases/tag/v2.13.0
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/jbuilder/tree/v2.12.0
+  source_code_uri: https://github.com/rails/jbuilder/tree/v2.13.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -108,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Create JSON structures via a Builder-style DSL

data/gemfiles/rails_5_0.gemfile

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

data/gemfiles/rails_5_1.gemfile

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

data/gemfiles/rails_5_2.gemfile

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

data/gemfiles/rails_6_0.gemfile

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

data/gemfiles/rails_6_1.gemfile

@@ -1,10 +0,0 @@
-# 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: "../"