jbuilder 2.10.0 → 2.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7289a23f21f82bfb3eeccd466ec985e8348a9977ed083be43eb8349551e840c
-  data.tar.gz: 20d2ba506a7a474d2a32030d91cef03d4345f2332a0753bca685ce6360b30995
+  metadata.gz: 7980c25163c5711962622d39c236ac262bfd7917160eb5012c6e36a06c797984
+  data.tar.gz: 7b6881e873c5e3d6be33cf5e7a122de51c99a33ec61fa34b30baa5c5fa1c2c63
 SHA512:
-  metadata.gz: fc04dfeb7c16b4547d0f7949b30ec481eb8517da3318550cf6c9f5e8bbc7bdc107c2d8bccc94e0e506741926d14f6798e783ece3640abb6edb323a39f7a691ae
-  data.tar.gz: 29a6793c2a3b4318b27b2a0614cc88c2a5e4ca646f39a29cb563d370524bc3c946b9ea8bff114b6a5ae9ea5b4e9d3546e30211f0ada15ad74ff028663933e5d7
+  metadata.gz: 6c8477608caf773c5ef0123798df81cdcd8003081fa5dccd79f72a356f58b31c05a06bb1df16725150e01477f611332973e8e870db5239f6077501e9d560daed
+  data.tar.gz: 108438d96749fabc48b4432eaa5c9b6dcf47df1f0adcdf0ff3de68bb602f49e3bb0bfe542cd13e041501bcddb80f8a3fd7ff7ffed9882235ff6f6d4c0d1aa464

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:3.4.5",
+	"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

@@ -0,0 +1,56 @@
+name: Ruby test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }} (${{ matrix.gemfile }})
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.gemfile == 'rails_head' }}
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
+          - "3.4"
+
+        gemfile:
+          - "rails_7_0"
+          - "rails_7_1"
+          - "rails_7_2"
+          - "rails_8_0"
+          - "rails_head"
+
+        exclude:
+          - ruby: '3.0'
+            gemfile: rails_7_2
+          - ruby: '3.0'
+            gemfile: rails_8_0
+          - ruby: '3.0'
+            gemfile: rails_head
+          - ruby: '3.1'
+            gemfile: rails_7_2
+          - ruby: '3.1'
+            gemfile: rails_8_0
+          - ruby: '3.1'
+            gemfile: rails_head
+          - ruby: '3.4'
+            gemfile: rails_7_0
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Ruby test
+        run: bundle exec rake

data/.gitignore

@@ -1,4 +1,6 @@
 tmp
+/log
+gemfiles/.bundle
 gemfiles/*.lock
 Gemfile.lock
 .ruby-version

data/Appraisals

@@ -1,21 +1,22 @@
-appraise "rails-5-0" do
-  gem "rails", "~> 5.0.0"
+# 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-5-1" do
-  gem "rails", "~> 5.1.0"
+appraise "rails-7-1" do
+  gem "rails", "~> 7.1.0"
 end
 
-appraise "rails-5-2" do
-  gem "rails", "~> 5.2.0"
+appraise "rails-7-2" do
+  gem "rails", "~> 7.2.0"
 end
 
-if RUBY_VERSION >= "2.5.0"
-  appraise "rails-6-0" do
-    gem "rails", "~> 6.0.0"
-  end
+appraise "rails-8-0" do
+  gem "rails", "~> 8.0.0"
+end
 
-  appraise "rails-head" do
-    gem "rails", github: "rails/rails"
-  end
+appraise "rails-head" do
+  gem "rails", github: "rails/rails", branch: "main"
 end

data/CONTRIBUTING.md

@@ -1,21 +1,19 @@
 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]
-[![Dependencies Status](https://gemnasium.com/rails/jbuilder.svg)][gemnasium]
 
-[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
-[gemnasium]: https://gemnasium.com/rails/jbuilder
 
 Jbuilder is work of [many contributors](https://github.com/rails/jbuilder/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/rails/jbuilder/pulls), [propose features and discuss issues](https://github.com/rails/jbuilder/issues).
 
 #### Fork the Project
 
-Fork the [project on Github](https://github.com/rails/jbuilder) and check out your copy.
+Fork the [project on GitHub](https://github.com/rails/jbuilder) and check out your copy.
 
 ```
 git clone https://github.com/contributor/jbuilder.git
@@ -35,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
 
@@ -97,7 +89,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/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
 
-``` ruby
+Top level arrays can be handled directly. Useful for index and other collection actions.
+
+```ruby
 # @comments = @post.comments
 
 json.array! @comments do |comment|
@@ -98,9 +103,11 @@ end
 # => [ { "body": "great post...", "author": { "first_name": "Joe", "last_name": "Bloe" }} ]
 ```
 
+## Array Attributes
+
 You can also extract attributes from array directly.
 
-``` ruby
+```ruby
 # @people = People.all
 
 json.array! @people, :id, :name
@@ -108,9 +115,42 @@ json.array! @people, :id, :name
 # => [ { "id": 1, "name": "David" }, { "id": 2, "name": "Jamie" } ]
 ```
 
-Jbuilder objects can be directly nested inside each other.  Useful for composing objects.
+## Plain Arrays
+
+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" ]
+```
+
+## Child Objects
 
-``` ruby
+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" } ] }
+```
+
+## Nested Jbuilder Objects
+
+Jbuilder objects can be directly nested inside each other. Useful for composing objects.
+
+```ruby
 class Person
   # ... Class Definition ... #
   def to_builder
@@ -136,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 a la show.json.jbuilder
+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)
@@ -156,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
@@ -171,32 +215,32 @@ 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:
 
 ```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 than:
+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
@@ -212,10 +256,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?
@@ -236,6 +281,8 @@ json.bar "bar"
 # => { "bar": "bar" }
 ```
 
+## Caching
+
 Fragment caching is supported, it uses `Rails.cache` and works like caching in
 HTML templates:
 
@@ -253,14 +300,30 @@ 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:
 
-``` ruby
+```ruby
 json.key_format! camelize: :lower
 json.first_name 'David'
 
@@ -270,10 +333,33 @@ 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
 ```
 
+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
+```
+
+## Testing JBuilder Response body with RSpec
+
+To test the response body of your controller spec, enable `render_views` in your RSpec context. This [configuration](https://rspec.info/features/6-0/rspec-rails/controller-specs/render-views) renders the views in a controller test.
+
 ## Contributing to Jbuilder
 
 Jbuilder is the work of many contributors. You're encouraged to submit pull requests, propose
@@ -282,4 +368,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,8 +1,10 @@
+# frozen_string_literal: true
+
 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/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 @@
+#!/usr/bin/env bash
+set -e
+
+bundle install
+appraisal install
+appraisal rake test

data/gemfiles/{rails_5_1.gemfile → rails_7_0.gemfile}

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

data/gemfiles/{rails_5_2.gemfile → rails_7_1.gemfile}

@@ -5,6 +5,6 @@ source "https://rubygems.org"
 gem "rake"
 gem "mocha", require: false
 gem "appraisal"
-gem "rails", "~> 5.2.0"
+gem "rails", "~> 7.1.0"
 
 gemspec path: "../"

data/gemfiles/{rails_6_0.gemfile → rails_7_2.gemfile}

@@ -5,6 +5,6 @@ source "https://rubygems.org"
 gem "rake"
 gem "mocha", require: false
 gem "appraisal"
-gem "rails", "~> 6.0.0"
+gem "rails", "~> 7.2.0"
 
 gemspec path: "../"

data/gemfiles/{rails_5_0.gemfile → rails_8_0.gemfile}

@@ -5,6 +5,6 @@ source "https://rubygems.org"
 gem "rake"
 gem "mocha", require: false
 gem "appraisal"
-gem "rails", "~> 5.0.0"
+gem "rails", "~> 8.0.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,16 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/jbuilder/version"
+
 Gem::Specification.new do |s|
   s.name     = 'jbuilder'
-  s.version  = '2.10.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'
   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 'activesupport', '>= 7.0.0'
+  s.add_dependency 'actionview', '>= 7.0.0'
+
+  if RUBY_ENGINE == 'rbx'
+    s.add_development_dependency('racc')
+    s.add_development_dependency('json')
+    s.add_development_dependency('rubysl')
+  end
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")
+
+  s.metadata = {
+    "bug_tracker_uri"       => "https://github.com/rails/jbuilder/issues",
+    "changelog_uri"         => "https://github.com/rails/jbuilder/releases/tag/v#{s.version}",
+    "mailing_list_uri"      => "https://discuss.rubyonrails.org/c/rubyonrails-talk",
+    "source_code_uri"       => "https://github.com/rails/jbuilder/tree/v#{s.version}",
+    "rubygems_mfa_required" => "true",
+  }
 end

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'
 
@@ -50,6 +52,14 @@ module Rails
 
           attributes.map { |a| ":#{a}"} * ', '
         end
+
+        def virtual_attributes
+          attributes.select {|name| name.respond_to?(:virtual?) && name.virtual? }
+        end
+
+        def partial_path_name
+          [controller_file_path, singular_table_name].join("/")
+        end
     end
   end
 end

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'
 

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

@@ -1,10 +1,10 @@
 <% if namespaced? -%>
-require_dependency "<%= namespaced_file_path %>/application_controller"
+require_dependency "<%= namespaced_path %>/application_controller"
 
 <% end -%>
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApplicationController
-  before_action :set_<%= singular_table_name %>, only: [:show, :update, :destroy]
+  before_action :set_<%= singular_table_name %>, only: %i[ show update destroy ]
 
   # GET <%= route_url %>
   # GET <%= route_url %>.json
@@ -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 -%>