jbuilder 1.5.3 → 2.11.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f96d267675b1f3a2c1b8362acec6cb5d6041594a
-  data.tar.gz: 16a89009d403703f5c2bab75b7db39e8a976043e
+SHA256:
+  metadata.gz: 9ce8fbeac8b34ee290535e98a284a1247e2de1b5272c4679c1b89a89ff8149db
+  data.tar.gz: cdaeb1302c4755ca43f037328698afe29fe658f2094c99e2c6f81f0000b9368c
 SHA512:
-  metadata.gz: 03e2efc5e9463f76a49560f1c61db48b02ad2d456399bc5aeed9a2cf47e8c919d59632c79141d696bf33ccd4cc1466fcb17dfab1d2f5f929924c6e386083ee9d
-  data.tar.gz: bcd576dd31be8b43e423612409ffae5051994bec4351f6fac4bd1ba0b1a5cf94ae091cb39570767c8949ea7a0d6f806ab13b2bbca5fbf7bc4bb6af91238717f0
+  metadata.gz: 6903b1aa13786fd5501d8e667eb7a913ebd469d24ce183a24cdf949a62788b1e598c2e0678c5ed5e369d4232c7720e284850f735c5be6f4691e4ecf42256d21a
+  data.tar.gz: 2a40e415a25a4d8680ac00ba81b9984188ef35440869a357db4fd7184d3f0b36d0ce10545a0d5253e6d12374b2f1d51f5a96f1ded1370ec7eddecaee469afc61

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/.gitignore

@@ -1,4 +1,7 @@
 tmp
+gemfiles/.bundle
+gemfiles/*.lock
 Gemfile.lock
-Gemfile.old.lock
 .ruby-version
+pkg
+*.gem

data/Appraisals

@@ -0,0 +1,25 @@
+appraise "rails-5-0" do
+  gem "rails", "~> 5.0.0"
+end
+
+appraise "rails-5-1" do
+  gem "rails", "~> 5.1.0"
+end
+
+appraise "rails-5-2" do
+  gem "rails", "~> 5.2.0"
+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
+
+  appraise "rails-head" do
+    gem "rails", github: "rails/rails", branch: "main"
+  end
+end

data/CONTRIBUTING.md

@@ -0,0 +1,106 @@
+Contributing to Jbuilder
+=====================
+
+[![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]
+
+[test]: https://github.com/rails/jbuilder/actions?query=branch%3Amaster
+[gem]: https://rubygems.org/gems/jbuilder
+[codeclimate]: https://codeclimate.com/github/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.
+
+```
+git clone https://github.com/contributor/jbuilder.git
+cd jbuilder
+git remote add upstream https://github.com/rails/jbuilder.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+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
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [test](test).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Make sure that `appraisal rake test` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Visit your forked repo and click the 'New pull request' button. Select your feature branch, fill out the form, and click the 'Create pull request' button. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+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 GitHub Actions. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+#### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang in there!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -1,8 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'rake'
-gem 'railties',   '~> 4.0.0'
-gem 'actionpack', '~> 4.0.0'
-gem 'mocha', require: false
+gem "rake"
+gem "mocha", require: false
+gem "appraisal"

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2013 David Heinemeier Hansson, 37signals
+Copyright (c) 2011-2018 David Heinemeier Hansson, 37signals
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,29 +1,31 @@
-Jbuilder [![Build Status](https://travis-ci.org/rails/jbuilder.png)](https://travis-ci.org/rails/jbuilder) [![Gem Version](https://badge.fury.io/rb/jbuilder.png)](https://rubygems.org/gems/jbuilder) [![Code Climate](https://codeclimate.com/github/rails/jbuilder.png)](https://codeclimate.com/github/rails/jbuilder)
-========
+# Jbuilder
 
-Jbuilder gives you a simple DSL for declaring JSON structures that beats massaging giant hash structures. This is particularly helpful when the generation process is fraught with conditionals and loops. Here's a simple example:
+Jbuilder gives you a simple DSL for declaring JSON structures that beats
+manipulating giant hash structures. This is particularly helpful when the
+generation process is fraught with conditionals and loops. Here's a simple
+example:
 
 ``` ruby
-Jbuilder.encode do |json|
-  json.content format_content(@message.content)
-  json.(@message, :created_at, :updated_at)
+# app/views/messages/show.json.jbuilder
 
-  json.author do
-    json.name @message.creator.name.familiar
-    json.email_address @message.creator.email_address_with_name
-    json.url url_for(@message.creator, format: :json)
-  end
+json.content format_content(@message.content)
+json.(@message, :created_at, :updated_at)
 
-  if current_user.admin?
-    json.visitors calculate_visitors(@message)
-  end
+json.author do
+  json.name @message.creator.name.familiar
+  json.email_address @message.creator.email_address_with_name
+  json.url url_for(@message.creator, format: :json)
+end
+
+if current_user.admin?
+  json.visitors calculate_visitors(@message)
+end
 
-  json.comments @message.comments, :content, :created_at
+json.comments @message.comments, :content, :created_at
 
-  json.attachments @message.attachments do |attachment|
-    json.filename attachment.filename
-    json.url url_for(attachment)
-  end
+json.attachments @message.attachments do |attachment|
+  json.filename attachment.filename
+  json.url url_for(attachment)
 end
 ```
 
@@ -62,30 +64,77 @@ json.set! :author do
   json.set! :name, 'David'
 end
 
-# => "author": { "name": "David" }
+# => {"author": { "name": "David" }}
+```
+
+
+To merge existing hash or array to current context:
+
+``` ruby
+hash = { author: { name: "David" } }
+json.post do
+  json.title "Merge HOWTO"
+  json.merge! hash
+end
+
+# => "post": { "title": "Merge HOWTO", "author": { "name": "David" } }
 ```
 
 Top level arrays can be handled directly.  Useful for index and other collection actions.
 
 ``` ruby
-# @people = People.all
-json.array! @people do |person|
-  json.name person.name
-  json.age calculate_age(person.birthday)
+# @comments = @post.comments
+
+json.array! @comments do |comment|
+  next if comment.marked_as_spam_by?(current_user)
+
+  json.body comment.body
+  json.author do
+    json.first_name comment.author.first_name
+    json.last_name comment.author.last_name
+  end
 end
 
-# => [ { "name": "David", "age": 32 }, { "name": "Jamie", "age": 31 } ]
+# => [ { "body": "great post...", "author": { "first_name": "Joe", "last_name": "Bloe" }} ]
 ```
 
 You can also extract attributes from array directly.
 
 ``` ruby
 # @people = People.all
+
 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
@@ -114,7 +163,9 @@ company.to_builder.target!
 # => {"name":"Doodle Corp","president":{"name":"John Stobs","age":58}}
 ```
 
-You can either use Jbuilder stand-alone or directly as an ActionView template language. When required in Rails, you can create views ala show.json.jbuilder (the json is already yielded):
+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
 # Any helpers available to views are available to the builder
@@ -132,7 +183,6 @@ if current_user.admin?
 end
 ```
 
-
 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
@@ -148,18 +198,48 @@ 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`.
+
+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
+```
+
+is quite different from:
+
+```ruby
+ # comment attributes are nested under a "comment" property
+json.comment do
+  json.partial! "/comments/comment.json.jbuilder", comment: @comment
+end
+```
+
+You can pass any objects into partial templates with or without `:locals` option.
+
+```ruby
+json.partial! 'sub_template', locals: { user: user }
+
 # or
 
-json.comments @post.comments, partial: 'comment/comment', as: :comment
+json.partial! 'sub_template', user: user
 ```
 
+
 You can explicitly make Jbuilder object return null if you want:
 
 ``` ruby
@@ -174,7 +254,19 @@ json.author do
 end
 ```
 
-Fragment caching is supported, it uses `Rails.cache` and works like caching in HTML templates:
+To prevent Jbuilder from including null values in the output, you can use the `ignore_nil!` method:
+
+```ruby
+json.ignore_nil!
+json.foo nil
+json.bar "bar"
+# => { "bar": "bar" }
+```
+
+## Caching
+
+Fragment caching is supported, it uses `Rails.cache` and works like caching in
+HTML templates:
 
 ```ruby
 json.cache! ['v1', @person], expires_in: 10.minutes do
@@ -182,7 +274,36 @@ json.cache! ['v1', @person], expires_in: 10.minutes do
 end
 ```
 
-Keys can be auto formatted using `key_format!`, this can be used to convert keynames from the standard ruby_format to CamelCase:
+You can also conditionally cache a block by using `cache_if!` like this:
+
+```ruby
+json.cache_if! !admin?, ['v1', @person], expires_in: 10.minutes do
+  json.extract! @person, :name, :age
+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
+keynames from the standard ruby_format to camelCase:
 
 ``` ruby
 json.key_format! camelize: :lower
@@ -191,17 +312,38 @@ json.first_name 'David'
 # => { "firstName": "David" }
 ```
 
-You can set this globally with the class method `key_format` (from inside your environment.rb for example):
+You can set this globally with the class method `key_format` (from inside your
+environment.rb for example):
 
 ``` ruby
 Jbuilder.key_format camelize: :lower
 ```
 
-Libraries similar to this in some form or another include:
+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
+features and discuss issues.
+
+See [CONTRIBUTING](CONTRIBUTING.md).
 
-* Active Model Serializers: https://github.com/rails-api/active_model_serializers
-* RABL: https://github.com/nesquena/rabl
-* JsonBuilder: https://github.com/nov/jsonbuilder
-* JSON Builder: https://github.com/dewski/json_builder
-* Jsonify: https://github.com/bsiggelkow/jsonify
-* RepresentationView: https://github.com/mdub/representative_view
+## License
+Jbuilder is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -1,14 +1,19 @@
-require 'bundler'
-require 'rake/testtask'
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-Bundler.require
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["CI"]
+  require "appraisal/task"
+  Appraisal::Task.new
+  task default: :appraisal
+else
+  Rake::TestTask.new do |test|
+    require "rails/version"
 
-Rake::TestTask.new do |test|
-  if /old$/ === ENV['BUNDLE_GEMFILE']
-    test.test_files = %w(test/jbuilder_template_test.rb test/jbuilder_test.rb)
-  else
-    test.test_files = FileList['test/*_test.rb']
+    test.libs << "test"
+
+    test.test_files = FileList["test/*_test.rb"]
   end
-end
 
-task :default => :test
+  task default: :test
+end

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

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

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

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

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: "../"