jbuilder 2.3.2 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3fd6ceffeb8702bf3239431ba2d2938500937d57
-  data.tar.gz: 35822ade1066472dd5d4bd241b40d677fa6e1234
+SHA256:
+  metadata.gz: 79b2c794b6341ee3d94c4c2d1ed8236e97357dac75dc9e49618a6a885ab35601
+  data.tar.gz: 4bb8128da8ec6305ae36c3fa866cf19cd1eb08037128b2c3716002525e97014b
 SHA512:
-  metadata.gz: 331609bd2b08cca7f6dc8e23ca3bfc5c1ac2bf740ae0874375024c4624caebdc84643c0cbad5b839555ce0057dc4753a6c01e28031b63c05c1452e9b3b1c0785
-  data.tar.gz: 043a81f2ae16fa51913bb21e8e0ded28b981ecde782338a47a6974c8ae0509d828e87cd83734831fb37fb9dca81c1ea90218ec31b933ca634e9031d03a1e7878
+  metadata.gz: c931310549e6384945735110e6c3a2ce36e566d12d691f33d8a5e68f1dca055eeda1ebe606fb093ec85b4c2481c05ebb7dc639f9209a8e4d324f59dd7b4c8693
+  data.tar.gz: 277b4c68a0fe426e308f6c5fbc59c8b7453d61291aaf3968e4500532f86e902bbc8ac34970ccd2496935c361584773616a4ff71745b7adbabc752b09ba0da9de

data/.gitignore

@@ -3,3 +3,4 @@ gemfiles/*.lock
 Gemfile.lock
 .ruby-version
 pkg
+*.gem

data/.travis.yml

@@ -1,43 +1,67 @@
 language: ruby
 
-sudo: false
 cache: bundler
 
+before_install:
+  - "gem update --system 2.7.9"
+  - "gem install bundler -v '<2'"
+
 rvm:
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.2
+  - 2.2.10
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.2
   - ruby-head
-  - jruby-19mode
-  - rbx
+  - rbx-3.107
 
 gemfile:
-  - gemfiles/rails_3_0.gemfile
-  - gemfiles/rails_3_1.gemfile
-  - gemfiles/rails_3_2.gemfile
-  - gemfiles/rails_4_0.gemfile
-  - gemfiles/rails_4_1.gemfile
   - gemfiles/rails_4_2.gemfile
-  - gemfiles/rails_edge.gemfile
+  - gemfiles/rails_5_0.gemfile
+  - gemfiles/rails_5_1.gemfile
+  - gemfiles/rails_5_2.gemfile
+  - gemfiles/rails_6_0.gemfile
+  - gemfiles/rails_head.gemfile
 
 matrix:
-  allow_failures:
-    - rvm: jruby-19mode
-    - rvm: rbx
-    - rvm: ruby-head
-  fast_finish: true
-  exclude:
+  include:
     - rvm: 1.9
-      gemfile: gemfiles/rails_edge.gemfile
+      gemfile: gemfiles/rails_4_2.gemfile
     - rvm: 2.0
-      gemfile: gemfiles/rails_edge.gemfile
+      gemfile: gemfiles/rails_4_2.gemfile
     - rvm: 2.1
-      gemfile: gemfiles/rails_edge.gemfile
+      gemfile: gemfiles/rails_4_2.gemfile
+    - rvm: 2.3
+      gemfile: gemfiles/rails_4_2.gemfile
     - rvm: jruby-19mode
-      gemfile: gemfiles/rails_edge.gemfile
-    - rvm: rbx
-      gemfile: gemfiles/rails_edge.gemfile
+      gemfile: gemfiles/rails_4_2.gemfile
+    - rvm: rbx-3.107
+      gemfile: gemfiles/rails_4_2.gemfile
+  exclude:
+    - rvm: 2.4.6
+      gemfile: gemfiles/rails_4_2.gemfile
+    - rvm: 2.5.5
+      gemfile: gemfiles/rails_4_2.gemfile
+    - rvm: 2.6.2
+      gemfile: gemfiles/rails_4_2.gemfile
+    - rvm: 2.2.10
+      gemfile: gemfiles/rails_6_0.gemfile
+    - rvm: 2.3.8
+      gemfile: gemfiles/rails_6_0.gemfile
+    - rvm: 2.4.6
+      gemfile: gemfiles/rails_6_0.gemfile
+    - rvm: 2.2.10
+      gemfile: gemfiles/rails_head.gemfile
+    - rvm: 2.3.8
+      gemfile: gemfiles/rails_head.gemfile
+    - rvm: 2.4.6
+      gemfile: gemfiles/rails_head.gemfile
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-3.107
+    - rvm: ruby-head
+    - gemfile: gemfiles/rails_head.gemfile
+  fast_finish: true
 
 notifications:
   email: false

data/Appraisals

@@ -1,44 +1,27 @@
-appraise "rails-3-0" do
-  gem "test-unit"
-  gem "railties",    "~> 3.0.0"
-  gem "actionpack",  "~> 3.0.0"
-  gem "activemodel", "~> 3.0.0"
+appraise "rails-4-2" do
+  gem "rails", "~> 4.2.0"
 end
 
-appraise "rails-3-1" do
-  gem "test-unit"
-  gem "railties",    "~> 3.1.0"
-  gem "actionpack",  "~> 3.1.0"
-  gem "activemodel", "~> 3.1.0"
-end
+if RUBY_VERSION >= "2.2.2"
+  appraise "rails-5-0" do
+    gem "rails", "~> 5.0.0"
+  end
 
-appraise "rails-3-2" do
-  gem "test-unit"
-  gem "railties",    "~> 3.2.0"
-  gem "actionpack",  "~> 3.2.0"
-  gem "activemodel", "~> 3.2.0"
-end
+  appraise "rails-5-1" do
+    gem "rails", "~> 5.1.0"
+  end
 
-appraise "rails-4-0" do
-  gem "railties",    "~> 4.0.0"
-  gem "actionpack",  "~> 4.0.0"
-  gem "activemodel", "~> 4.0.0"
+  appraise "rails-5-2" do
+    gem "rails", "~> 5.2.0"
+  end
 end
 
-appraise "rails-4-1" do
-  gem "railties",    "~> 4.1.0"
-  gem "actionpack",  "~> 4.1.0"
-  gem "activemodel", "~> 4.1.0"
-end
-
-appraise "rails-4-2" do
-  gem "railties",    "~> 4.2.0"
-  gem "actionpack",  "~> 4.2.0"
-  gem "activemodel", "~> 4.2.0"
-end
+if RUBY_VERSION >= "2.5.0"
+  appraise "rails-6-0" do
+    gem "rails", "~> 6.0.0.rc1"
+  end
 
-appraise "rails-edge" do
-  gem "rails",  ">= 5.0.0.alpha", github: "rails/rails"
-  gem "arel",   ">= 7.0.0.alpha", github: "rails/arel"
-  gem "rack",   ">= 2.0.0.alpha", github: "rack/rack"
+  appraise "rails-head" do
+    gem "rails", github: "rails/rails"
+  end
 end

data/CHANGELOG.md

@@ -1,5 +1,74 @@
 # Changelog
 
+2.9.1
+-----
+
+* [Respect JSON encoding customizations](https://github.com/rails/jbuilder/commit/e2e8623b08078ad6a2323ce8ecaf642b7afe1166)
+
+2.9.0
+-----
+
+* [Fix passing object with partial without locals](https://github.com/rails/jbuilder/pull/435)
+* [Fix deprecation warning in Rails 6.0](https://github.com/rails/jbuilder/pull/453)
+* [Use quotes consistently in generated templates](https://github.com/rails/jbuilder/pull/455)
+* [Allow omitting timestamps from generated partials](https://github.com/rails/jbuilder/pull/448)
+* [Respect changing scaffold generator](https://github.com/rails/jbuilder/pull/458)
+* [Use a symbolic default format for Rails 6.0 forward compatibility](https://github.com/rails/jbuilder/commit/3895a7243f3db292b0bf15513fc05494e6e50576)
+* [Drop MultiJSON in favor of Ruby standard library JSON](https://github.com/rails/jbuilder/commit/b952ae096eb1828b0fcfde06e6ba62311494ec49)
+
+2.8.0
+-----
+
+* [Replace deprecated fragment_cache_key for Rails 5.2 support](https://github.com/rails/jbuilder/pull/430)
+
+2.7.0
+-----
+
+* [Requires Rails 4+](https://github.com/rails/jbuilder/commit/5207ff394533177fffdd768bfaa6413a0cd16dc8)
+* [Fix implicitly rendering a JSON partial with the same name as an
+   HTML partial](https://github.com/rails/jbuilder/pull/400)
+
+2.6.4
+-----
+
+* Drop the pessimistic upper-bound restriction on Active Support and MultiJSON to prevent future gemfile resolution deadlocks *DHH*
+
+2.6.3
+-----
+
+* Support Rails 5.1
+
+2.6.2
+-----
+
+* Fix thor warnings
+
+2.6.1
+-----
+
+* [Optimize root caches with cache_root!](https://github.com/rails/jbuilder/pull/370)
+
+2.6.0
+-----
+
+* [Rails 5 cache! with expire support](https://github.com/rails/jbuilder/commit/d61e3354563863731bc1f358f495b1dbb7ae9d32)
+* [Generated view DRYed by using model partial](https://github.com/rails/jbuilder/commit/83256f4d7e9211c9dc47972feaed7fd31e4f7cac)
+
+2.5.0
+-----
+
+* [Rails 5 compatibility](https://github.com/rails/jbuilder/commit/64c510ec69d9e63b73ffd5942e802d21a7d14701)
+
+2.4.1
+-----
+
+* [Fix controller generators to be Rails 5 compatible](https://github.com/rails/jbuilder/commit/2dc6203c5c4a98701d5b64c2a5200835a48bb533)
+
+2.4.0
+-----
+
+* [Rails 5 compatibility](https://github.com/rails/jbuilder/commit/4aa2cfcc19a4634d65a28ffc75f0ac0cb8304115)
+
 2.3.2
 -----
 
@@ -32,12 +101,12 @@
 2.2.13
 ------
 
-* Several peformance optimizations: [#260](https://github.com/rails/jbuilder/pull/260) & [#261](https://github.com/rails/jbuilder/pull/261)
+* Several performance optimizations: [#260](https://github.com/rails/jbuilder/pull/260) & [#261](https://github.com/rails/jbuilder/pull/261)
 
 2.2.12
 ------
 
-* [Replace explici block calls with yield for performance](https://github.com/rails/jbuilder/commit/3184f941276ad03a071cf977133d1a32302afa47)
+* [Replace explicit block calls with yield for performance](https://github.com/rails/jbuilder/commit/3184f941276ad03a071cf977133d1a32302afa47)
 
 2.2.11
 ------
@@ -181,7 +250,7 @@
 -----
 * [Add quick collection attribute extraction](https://github.com/rails/jbuilder/commit/c2b966cf653ea4264fbb008b8cc6ce5359ebe40a)
 * [Block has priority over attributes extraction](https://github.com/rails/jbuilder/commit/77c24766362c02769d81dac000b1879a9e4d4a00)
-* [Meaningfull error messages when adding properties to null](https://github.com/rails/jbuilder/commit/e26764602e34b3772e57e730763d512e59489e3b)
+* [Meaningful error messages when adding properties to null](https://github.com/rails/jbuilder/commit/e26764602e34b3772e57e730763d512e59489e3b)
 * [Do not enforce template format, enforce handlers instead](https://github.com/rails/jbuilder/commit/72576755224b15da45e50cbea877679800ab1398)
 
 1.3.0

data/CONTRIBUTING.md

@@ -1,10 +1,15 @@
 Contributing to Jbuilder
 =====================
 
-[![Build Status](https://travis-ci.org/rails/jbuilder.svg?branch=master)]()
-[![Gem Version](http://img.shields.io/gem/v/jbuilder.svg)]()
-[![Code Climate](http://img.shields.io/codeclimate/github/rails/jbuilder.svg)]()
-[![Dependencies Status](http://img.shields.io/gemnasium/rails/jbuilder.svg)]()
+[![Build Status](https://api.travis-ci.org/rails/jbuilder.svg?branch=master)][travis]
+[![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
+[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).
 
@@ -34,7 +39,8 @@ Ensure that you can build the project and run tests.
 
 ```
 bundle install
-bundle exec rake test
+appraisal install
+appraisal rake test
 ```
 
 #### Write Tests
@@ -47,7 +53,7 @@ We definitely appreciate pull requests that highlight or reproduce a problem, ev
 
 Implement your feature or bug fix.
 
-Make sure that `bundle exec rake test` completes without errors.
+Make sure that `appraisal rake test` completes without errors.
 
 #### Write Documentation
 
@@ -77,7 +83,7 @@ git push origin my-feature-branch
 
 #### Make a Pull Request
 
-Go to https://github.com/contributor/jbuilder and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+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
 
@@ -95,7 +101,7 @@ Go back to your pull request after a few minutes and see whether it passed muste
 
 #### 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 on there!
+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
 

data/Gemfile

@@ -5,4 +5,3 @@ gemspec
 gem "rake"
 gem "mocha", require: false
 gem "appraisal"
-gem "pry"

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2015 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

data/README.md

@@ -1,12 +1,12 @@
 # Jbuilder
 
 Jbuilder gives you a simple DSL for declaring JSON structures that beats
-massaging giant hash structures. This is particularly helpful when the
+manipulating giant hash structures. This is particularly helpful when the
 generation process is fraught with conditionals and loops. Here's a simple
 example:
 
 ``` ruby
-# app/views/message/show.json.jbuilder
+# app/views/messages/show.json.jbuilder
 
 json.content format_content(@message.content)
 json.(@message, :created_at, :updated_at)
@@ -64,7 +64,20 @@ 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.
@@ -124,7 +137,7 @@ company.to_builder.target!
 ```
 
 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
+language. When required in Rails, you can create views a la show.json.jbuilder
 (the json is already yielded):
 
 ``` ruby
@@ -143,7 +156,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
@@ -168,7 +180,26 @@ json.partial! partial: 'posts/post', collection: @posts, as: :post
 
 # or
 
-json.comments @post.comments, partial: 'comment/comment', as: :comment
+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 than:
+
+```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.
@@ -196,6 +227,15 @@ json.author do
 end
 ```
 
+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" }
+```
+
 Fragment caching is supported, it uses `Rails.cache` and works like caching in
 HTML templates:
 
@@ -234,24 +274,9 @@ environment.rb for example):
 Jbuilder.key_format camelize: :lower
 ```
 
-Faster JSON backends
---------------------
-
-Jbuilder uses MultiJson, which by default will use the JSON gem. That gem is
-currently tangled with ActiveSupport's all-Ruby `#to_json` implementation,
-which is slow (fixed in Rails >= 4.1). For faster Jbuilder rendering, you can
-specify something like the Yajl JSON generator instead. You'll need to include
-the `yajl-ruby` gem in your Gemfile and then set the following configuration
-for MultiJson:
-
-``` ruby
-require 'multi_json'
-MultiJson.use :yajl
- ```
-
 ## Contributing to Jbuilder
 
-Jbuilder is work of many contributors. You're encouraged to submit pull requests, propose
+Jbuilder is the work of many contributors. You're encouraged to submit pull requests, propose
 features and discuss issues.
 
 See [CONTRIBUTING](CONTRIBUTING.md).