jbuilder 2.13.0 → 2.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23152c62d2a748a3a3b190dba588de44dbb8577aff5ad930fa6aa7e29e935e50
-  data.tar.gz: 1a79f24f284ede18d9aea34702fe7bff5f70064c8dd6d8a372e8bd9ec4f5d266
+  metadata.gz: c3f0a36b10c8ab54a2378daf5acb8f59126b9fe97dcebddac33bd2a4bd63b846
+  data.tar.gz: 0062fc739c0c288fb9f1864db1189b05bd0d0c6943481dc56bf00eb9a33f2662
 SHA512:
-  metadata.gz: 0fb3a664bd96a0263ed6a155b385a634efcb26e157a1e8d7592da3f3baa1a4ed6d717bead553169d1fd6e540a35f1847925195e07ede281e6d845e6f649cd537
-  data.tar.gz: c9d1fd1cc89b68ffea4b5b6090ae2ed1de25e75442923a2dc9b16fda0bdfbdb7470d8ada71657d06ad8db1c64c41acacf1e1235891c794c146b3e16758978cff
+  metadata.gz: 77d5b7b40bf5445c727b4e3fa4ddce979bd6d04c9a21336b1a486d6884d1f8cede1b0473944053ae5f1e2fc593cf1464e9e7c78b82fc230ef12381e25be53360
+  data.tar.gz: 4dd011c5f03e7e7f44cf456241078a218c420c9f80951480c2102a39fbcfb2ecc2ea2fd0a170025151e79c8db83517261c9cb53cd085b65faa8a7d6bbae3a922

data/.devcontainer/devcontainer-lock.json

@@ -0,0 +1,9 @@
+{
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {
+      "version": "1.1.0",
+      "resolved": "ghcr.io/devcontainers/features/github-cli@sha256:d22f50b70ed75339b4eed1ba9ecde3a1791f90e88d37936517e3bace0bbad671",
+      "integrity": "sha256:d22f50b70ed75339b4eed1ba9ecde3a1791f90e88d37936517e3bace0bbad671"
+    }
+  }
+}

data/.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "jbuilder",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "ghcr.io/rails/devcontainer/images/ruby:4.0.4",
+	"features": {
+		"ghcr.io/devcontainers/features/github-cli:1": {}
+	}
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.github/workflows/ruby.yml

@@ -5,7 +5,7 @@ on: [push, pull_request]
 jobs:
   test:
     name: Ruby ${{ matrix.ruby }} (${{ matrix.gemfile }})
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.gemfile == 'rails_head' }}
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
@@ -19,26 +19,43 @@ jobs:
           - "3.1"
           - "3.2"
           - "3.3"
+          - "3.4"
+          - "4.0"
 
         gemfile:
           - "rails_7_0"
           - "rails_7_1"
+          - "rails_7_2"
+          - "rails_8_0"
+          - "rails_8_1"
           - "rails_head"
 
         exclude:
+          - ruby: '3.0'
+            gemfile: rails_7_2
+          - ruby: '3.0'
+            gemfile: rails_8_0
+          - ruby: '3.0'
+            gemfile: rails_8_1
           - ruby: '3.0'
             gemfile: rails_head
-
-        include:
+          - ruby: '3.1'
+            gemfile: rails_7_2
+          - ruby: '3.1'
+            gemfile: rails_8_0
+          - ruby: '3.1'
+            gemfile: rails_8_1
           - ruby: '3.1'
             gemfile: rails_head
           - ruby: '3.2'
             gemfile: rails_head
-          - ruby: head
-            gemfile: rails_head
+          - ruby: '3.4'
+            gemfile: rails_7_0
+          - ruby: '4.0'
+            gemfile: rails_7_0
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - uses: ruby/setup-ruby@v1
         with:

data/Appraisals

@@ -1,13 +1,26 @@
-if RUBY_VERSION >= "2.7.0"
-  appraise "rails-7-0" do
-    gem "rails", "~> 7.0.0"
-  end
-
-  appraise "rails-7-1" do
-    gem "rails", "~> 7.1.0"
-  end
-
-  appraise "rails-head" do
-    gem "rails", github: "rails/rails", branch: "main"
-  end
+# frozen_string_literal: true
+
+appraise "rails-7-0" do
+  gem "rails", "~> 7.0.0"
+  gem "concurrent-ruby", "< 1.3.5" # to avoid problem described in https://github.com/rails/rails/pull/54264
+end
+
+appraise "rails-7-1" do
+  gem "rails", "~> 7.1.0"
+end
+
+appraise "rails-7-2" do
+  gem "rails", "~> 7.2.0"
+end
+
+appraise "rails-8-0" do
+  gem "rails", "~> 8.0.0"
+end
+
+appraise "rails-8-1" do
+  gem "rails", "~> 8.1.0"
+end
+
+appraise "rails-head" do
+  gem "rails", github: "rails/rails", branch: "main"
 end

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -5,7 +5,7 @@ manipulating giant hash structures. This is particularly helpful when the
 generation process is fraught with conditionals and loops. Here's a simple
 example:
 
-``` ruby
+```ruby
 # app/views/messages/show.json.jbuilder
 
 json.content format_content(@message.content)
@@ -31,7 +31,7 @@ end
 
 This will build the following structure:
 
-``` javascript
+```javascript
 {
   "content": "<p>This is <i>serious</i> monkey business</p>",
   "created_at": "2011-10-29T20:45:28-05:00",
@@ -57,9 +57,11 @@ This will build the following structure:
 }
 ```
 
+## Dynamically Defined Attributes
+
 To define attribute and structure names dynamically, use the `set!` method:
 
-``` ruby
+```ruby
 json.set! :author do
   json.set! :name, 'David'
 end
@@ -67,10 +69,11 @@ end
 # => {"author": { "name": "David" }}
 ```
 
+## Merging Existing Hash or Array
 
 To merge existing hash or array to current context:
 
-``` ruby
+```ruby
 hash = { author: { name: "David" } }
 json.post do
   json.title "Merge HOWTO"
@@ -80,9 +83,11 @@ end
 # => "post": { "title": "Merge HOWTO", "author": { "name": "David" } }
 ```
 
-Top level arrays can be handled directly.  Useful for index and other collection actions.
+## Top Level Arrays
+
+Top level arrays can be handled directly. Useful for index and other collection actions.
 
-``` ruby
+```ruby
 # @comments = @post.comments
 
 json.array! @comments do |comment|
@@ -95,12 +100,14 @@ json.array! @comments do |comment|
   end
 end
 
-# => [ { "body": "great post...", "author": { "first_name": "Joe", "last_name": "Bloe" }} ]
+# => [ { "body": "great post...", "author": { "first_name": "Joe", "last_name": "Blow" }} ]
 ```
 
+## Array Attributes
+
 You can also extract attributes from array directly.
 
-``` ruby
+```ruby
 # @people = People.all
 
 json.array! @people, :id, :name
@@ -108,6 +115,8 @@ json.array! @people, :id, :name
 # => [ { "id": 1, "name": "David" }, { "id": 2, "name": "Jamie" } ]
 ```
 
+## Plain Arrays
+
 To make a plain array without keys, construct and pass in a standard Ruby array.
 
 ```ruby
@@ -118,6 +127,8 @@ json.people my_array
 # => "people": [ "David", "Jamie" ]
 ```
 
+## Child Objects
+
 You don't always have or need a collection when building an array.
 
 ```ruby
@@ -135,9 +146,11 @@ end
 # => { "people": [ { "id": 1, "name": "David" }, { "id": 2, "name": "Jamie" } ] }
 ```
 
-Jbuilder objects can be directly nested inside each other.  Useful for composing objects.
+## Nested Jbuilder Objects
+
+Jbuilder objects can be directly nested inside each other. Useful for composing objects.
 
-``` ruby
+```ruby
 class Person
   # ... Class Definition ... #
   def to_builder
@@ -163,11 +176,13 @@ company.to_builder.target!
 # => {"name":"Doodle Corp","president":{"name":"John Stobs","age":58}}
 ```
 
+## Rails Integration
+
 You can either use Jbuilder stand-alone or directly as an ActionView template
 language. When required in Rails, you can create views à la show.json.jbuilder
 (the json is already yielded):
 
-``` ruby
+```ruby
 # Any helpers available to views are available to the builder
 json.content format_content(@message.content)
 json.(@message, :created_at, :updated_at)
@@ -183,6 +198,8 @@ if current_user.admin?
 end
 ```
 
+## Partials
+
 You can use partials as well. The following will render the file
 `views/comments/_comments.json.jbuilder`, and set a local variable
 `comments` with all this message's comments, which you can use inside
@@ -192,6 +209,13 @@ the partial.
 json.partial! 'comments/comments', comments: @message.comments
 ```
 
+You can also render an object to a partial inline under a key.
+
+```ruby
+json.post @post, partial: 'posts/post', as: :post
+# => { "post": { "title": "Hello World!", "author": { "name": "David" } } }
+```
+
 It's also possible to render collections of partials:
 
 ```ruby
@@ -202,9 +226,24 @@ json.partial! 'posts/post', collection: @posts, as: :post
 
 # or
 json.partial! partial: 'posts/post', collection: @posts, as: :post
+```
 
-# or
+You can also render to a collection of partials inline under a key.
+
+```ruby
 json.comments @post.comments, partial: 'comments/comment', as: :comment
+# => { "comments": [{ "content": "Hello everyone!" }, { "content": "To you my good sir!" }] }
+```
+
+You can also provide other locals to the partial you're rendering to.
+
+```ruby
+# Provide the `include_body` local to the partial when rendering a single object
+json.post @post, partial: 'posts/post', as: :post, include_body: true
+
+# Provide a local to the partial when rendering a collection.
+# Each item in the collection will render with `include_author: true`.
+json.comments @post.comments, partial: 'comments/comment', as: :comment, include_author: true
 ```
 
 The `as: :some_symbol` is used with partials. It will take care of mapping the passed in object to a variable for the
@@ -215,15 +254,15 @@ 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:
 
 ```ruby
- # Use the default `views/comments/_comment.json.jbuilder`, putting @comment as the comment local variable.
- # Note, `comment` attributes are "inlined".
- json.partial! @comment, as: :comment
+# Use the default `views/comments/_comment.json.jbuilder`, putting @comment as the comment local variable.
+# Note, `comment` attributes are "inlined".
+json.partial! @comment, as: :comment
 ```
 
 is quite different from:
 
 ```ruby
- # comment attributes are nested under a "comment" property
+# comment attributes are nested under a "comment" property
 json.comment do
   json.partial! "/comments/comment.json.jbuilder", comment: @comment
 end
@@ -239,10 +278,11 @@ json.partial! 'sub_template', locals: { user: user }
 json.partial! 'sub_template', user: user
 ```
 
+## Null Values
 
 You can explicitly make Jbuilder object return null if you want:
 
-``` ruby
+```ruby
 json.extract! @post, :id, :title, :content, :published_at
 json.author do
   if @post.anonymous?
@@ -303,9 +343,9 @@ This will include both records as part of the cache key and updating either of t
 ## Formatting Keys
 
 Keys can be auto formatted using `key_format!`, this can be used to convert
-keynames from the standard ruby_format to camelCase:
+key names from the standard ruby_format to camelCase:
 
-``` ruby
+```ruby
 json.key_format! camelize: :lower
 json.first_name 'David'
 
@@ -315,7 +355,7 @@ json.first_name 'David'
 You can set this globally with the class method `key_format` (from inside your
 environment.rb for example):
 
-``` ruby
+```ruby
 Jbuilder.key_format camelize: :lower
 ```
 
@@ -323,7 +363,7 @@ 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
+```ruby
 json.key_format! camelize: :lower
 json.deep_format_keys!
 json.settings([{some_value: "abc"}])
@@ -334,7 +374,7 @@ json.settings([{some_value: "abc"}])
 You can set this globally with the class method `deep_format_keys` (from inside your
 environment.rb for example):
 
-``` ruby
+```ruby
 Jbuilder.deep_format_keys true
 ```
 
@@ -350,4 +390,5 @@ features and discuss issues.
 See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## License
+
 Jbuilder is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/setup"
 require "bundler/gem_tasks"
 require "rake/testtask"

data/bin/test

@@ -1,4 +1,4 @@
-#!/bin/env bash
+#!/usr/bin/env bash
 set -e
 
 bundle install

data/gemfiles/rails_7_0.gemfile

@@ -6,5 +6,6 @@ gem "rake"
 gem "mocha", require: false
 gem "appraisal"
 gem "rails", "~> 7.0.0"
+gem "concurrent-ruby", "< 1.3.5"
 
 gemspec path: "../"

data/gemfiles/rails_7_2.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", "~> 7.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_8_0.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", "~> 8.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_8_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", "~> 8.1.0"
+
+gemspec path: "../"

data/jbuilder.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/jbuilder/version"
 
 Gem::Specification.new do |s|
@@ -9,10 +11,10 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/rails/jbuilder'
   s.license  = 'MIT'
 
-  s.required_ruby_version = '>= 2.2.2'
+  s.required_ruby_version = '>= 3.0.0'
 
-  s.add_dependency 'activesupport', '>= 5.0.0'
-  s.add_dependency 'actionview', '>= 5.0.0'
+  s.add_dependency 'activesupport', '>= 7.0.0'
+  s.add_dependency 'actionview', '>= 7.0.0'
 
   if RUBY_ENGINE == 'rbx'
     s.add_development_dependency('racc')

data/lib/generators/rails/jbuilder_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators/named_base'
 require 'rails/generators/resource_helpers'
 

data/lib/generators/rails/scaffold_controller_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
 
@@ -13,6 +15,10 @@ module Rails
         def permitted_params
           attributes_names.map { |name| ":#{name}" }.join(', ')
         end unless private_method_defined? :permitted_params
+
+        def status_unprocessable_content
+          ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(422) rescue :unprocessable_content
+        end
     end
   end
 end

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

@@ -25,7 +25,7 @@ class <%= controller_class_name %>Controller < ApplicationController
     if @<%= orm_instance.save %>
       render :show, status: :created, location: <%= "@#{singular_table_name}" %>
     else
-      render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
+      render json: <%= "@#{orm_instance.errors}" %>, status: :<%= status_unprocessable_content.to_s %>
     end
   end
 
@@ -35,7 +35,7 @@ class <%= controller_class_name %>Controller < ApplicationController
     if @<%= orm_instance.update("#{singular_table_name}_params") %>
       render :show, status: :ok, location: <%= "@#{singular_table_name}" %>
     else
-      render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
+      render json: <%= "@#{orm_instance.errors}" %>, status: :<%= status_unprocessable_content.to_s %>
     end
   end
 

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

@@ -33,8 +33,8 @@ class <%= controller_class_name %>Controller < ApplicationController
         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 }
-        format.json { render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity }
+        format.html { render :new, status: :<%= status_unprocessable_content.to_s %> }
+        format.json { render json: <%= "@#{orm_instance.errors}" %>, status: :<%= status_unprocessable_content.to_s %> }
       end
     end
   end
@@ -43,11 +43,11 @@ class <%= controller_class_name %>Controller < ApplicationController
   def update
     respond_to do |format|
       if @<%= orm_instance.update("#{singular_table_name}_params") %>
-        format.html { redirect_to <%= redirect_resource_name %>, notice: <%= %("#{human_name} was successfully updated.") %> }
+        format.html { redirect_to <%= redirect_resource_name %>, notice: <%= %("#{human_name} was successfully updated.") %>, status: :see_other }
         format.json { render :show, status: :ok, location: <%= "@#{singular_table_name}" %> }
       else
-        format.html { render :edit, status: :unprocessable_entity }
-        format.json { render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity }
+        format.html { render :edit, status: :<%= status_unprocessable_content.to_s %> }
+        format.json { render json: <%= "@#{orm_instance.errors}" %>, status: :<%= status_unprocessable_content.to_s %> }
       end
     end
   end
@@ -57,7 +57,7 @@ class <%= controller_class_name %>Controller < ApplicationController
     @<%= orm_instance.destroy %>
 
     respond_to do |format|
-      format.html { redirect_to <%= index_helper %>_path, status: :see_other, notice: <%= %("#{human_name} was successfully destroyed.") %> }
+      format.html { redirect_to <%= index_helper %>_path, notice: <%= %("#{human_name} was successfully destroyed.") %>, status: :see_other }
       format.json { head :no_content }
     end
   end

data/lib/jbuilder/blank.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Jbuilder
   class Blank
     def ==(other)