jbuilder 2.8.0 → 2.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c134282537dc64d7253ed11314a8ee31402b4fe994626a955b57f308d8bc082
-  data.tar.gz: eebcdba24d5b41aaf87009296fbb63dd4628677b09955ed7c385e048ad3034a2
+  metadata.gz: '039b14d174dd7bfb3a5e00d5a315aee89f1efd46a570244191ab985bb44fc328'
+  data.tar.gz: 4eda58d10150903687b7940b858fa02c6f0a2cbca8858cd2ae9866c5be5a4b62
 SHA512:
-  metadata.gz: 563cfe1ba9e191ed286ca80f77d7ea41737bb402cd257859ec5ffbf3ee77b7a7b041c3cb433d035f10a68a04df2e186140942a98b78b32d7b6d6e64a6514ff44
-  data.tar.gz: 8c7e23e0e0aa6abdc56f5a14d4b3ea4c7aa4abdc515d3d8fc8e10385c97733e4f5174a861ffc8fda3913623f90dbb878e7547eec917ebb5d9589d46d9d04c3ba
+  metadata.gz: 1d20f2794455635cbb3272bd4b6e8f91781e2c55aa40c7228d5347b4b6ad049cd3cc22ebc9ef708b8bbe4a05811774de07770b175035342123458a4637b9240f
+  data.tar.gz: 383aca1c7489eda135339e4538fa8a9dec80900c7c8bab786729a7c323d63f3a75657889ee6dad6bf91b769ced3eb507e41ef7daa15faa8bb3c5d0261c0c0394

data/.gitignore

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

data/.travis.yml

@@ -1,56 +1,52 @@
 language: ruby
 
-sudo: false
 cache: bundler
 
 before_install:
-  - gem update --system
-  - gem install bundler
+  - "gem install bundler -v '<2'"
 
 rvm:
-  - 1.9
-  - 2.0
-  - 2.1
   - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.3.8
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
   - ruby-head
-  - jruby-19mode
-  - rbx
 
 gemfile:
-  - gemfiles/rails_4_2.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:
-    - rvm: 1.9
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 1.9
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: 2.0
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 2.0
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: 2.1
+    - rvm: 2.7.1
       gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 2.1
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: jruby-19mode
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: jruby-19mode
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: rbx
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: rbx
+    - rvm: 2.7.1
       gemfile: gemfiles/rails_5_1.gemfile
+    - rvm: 2.2.10
+      gemfile: gemfiles/rails_5_2.gemfile
+    - rvm: 2.7.1
+      gemfile: gemfiles/rails_5_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.10
+      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.10
+      gemfile: gemfiles/rails_head.gemfile
+  allow_failures:
+    - rvm: ruby-head
+    - gemfile: gemfiles/rails_head.gemfile
+  fast_finish: true
 
 notifications:
   email: false

data/Appraisals

@@ -1,13 +1,21 @@
-appraise "rails-4-2" do
-  gem "rails",    "~> 4.2.0"
+appraise "rails-5-0" do
+  gem "rails", "~> 5.0.0"
 end
 
-if RUBY_VERSION >= "2.2.2"
-  appraise "rails-5-0" do
-    gem "rails",    ">= 5.0.0", "< 5.1"
+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-5-1" do
-    gem "rails",    ">= 5.1.0", "< 5.2"
+  appraise "rails-head" do
+    gem "rails", github: "rails/rails"
   end
 end

data/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Changelog
 
+2.11.2
+------
+
+* [Improve key formatting for nested hashes and disable by default](https://github.com/rails/jbuilder/pull/497)
+
+2.11.1
+------
+
+* Use symbols instead of strings for before_action filters [DHH]
+* Slim down comments in generated scaffold code [DHH]
+
+2.11.0
+------
+
+* [Allow jbuilder instance to be passed to #merge!](https://github.com/rails/jbuilder/pull/485)
+* [Fix for key_format! when using nested hashes](https://github.com/rails/jbuilder/pull/486)
+* [Include rich_text, attachment, and attachments fields in json partial](https://github.com/rails/jbuilder/pull/459)
+
+2.10.2
+------
+
+* Update scaffold generator to use double quotes, 422 form error responds, and modern string-of-arrays syntax [DHH]
+
+2.10.1
+------
+
+* Fix keyword arguments warning on Ruby 2.7
+
+2.10.0
+------
+
+* Requires Rails 5+ and Ruby 2.2+
+* Nested hashes are deep-merged
+
+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
 -----
 

data/CONTRIBUTING.md

@@ -4,18 +4,16 @@ Contributing to Jbuilder
 [![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).
 
 #### 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

data/Gemfile

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

data/README.md

@@ -156,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
@@ -184,6 +183,25 @@ json.partial! partial: 'posts/post', collection: @posts, as: :post
 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.
 
 ```ruby
@@ -256,20 +274,24 @@ environment.rb for example):
 Jbuilder.key_format camelize: :lower
 ```
 
-Faster JSON backends
---------------------
+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:
 
-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
+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
-require 'multi_json'
-MultiJson.use :yajl
- ```
+Jbuilder.deep_format_keys true
+```
 
 ## Contributing to Jbuilder
 

data/gemfiles/rails_5_0.gemfile

@@ -5,7 +5,6 @@ source "https://rubygems.org"
 gem "rake"
 gem "mocha", require: false
 gem "appraisal"
-gem "pry"
-gem "rails", ">= 5.0.0", "< 5.1"
+gem "rails", "~> 5.0.0"
 
 gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

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

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

@@ -5,7 +5,6 @@ source "https://rubygems.org"
 gem "rake"
 gem "mocha", require: false
 gem "appraisal"
-gem "pry"
-gem "rails", "~> 4.2.0"
+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_head.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", github: "rails/rails"
+
+gemspec path: "../"

data/jbuilder.gemspec

@@ -1,16 +1,21 @@
 Gem::Specification.new do |s|
   s.name     = 'jbuilder'
-  s.version  = '2.8.0'
+  s.version  = '2.11.2'
   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 = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.2.2'
 
-  s.add_dependency 'activesupport', '>= 4.2.0'
-  s.add_dependency 'multi_json',    '>= 1.2'
+  s.add_dependency 'activesupport', '>= 5.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")

data/lib/generators/rails/jbuilder_generator.rb

@@ -10,6 +10,8 @@ module Rails
 
       argument :attributes, type: :array, default: [], banner: 'field:type field:type'
 
+      class_option :timestamps, type: :boolean, default: true
+
       def create_root_folder
         path = File.join('app/views', controller_file_path)
         empty_directory path unless File.directory?(path)
@@ -33,8 +35,12 @@ module Rails
           [name, :json, :jbuilder] * '.'
         end
 
-        def attributes_list_with_timestamps
-          attributes_list(attributes_names + %w(created_at updated_at))
+        def full_attributes_list
+          if options[:timestamps]
+            attributes_list(attributes_names + %w(created_at updated_at))
+          else
+            attributes_list(attributes_names)
+          end
         end
 
         def attributes_list(attributes = attributes_names)
@@ -44,6 +50,10 @@ module Rails
 
           attributes.map { |a| ":#{a}"} * ', '
         end
+
+        def virtual_attributes
+          attributes.select {|name| name.respond_to?(:virtual?) && name.virtual? }
+        end
     end
   end
 end

data/lib/generators/rails/scaffold_controller_generator.rb

@@ -7,6 +7,12 @@ module Rails
       source_paths << File.expand_path('../templates', __FILE__)
 
       hook_for :jbuilder, type: :boolean, default: true
+
+      private
+
+        def permitted_params
+          attributes_names.map { |name| ":#{name}" }.join(', ')
+        end unless private_method_defined? :permitted_params
     end
   end
 end

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
@@ -51,12 +51,12 @@ class <%= controller_class_name %>Controller < ApplicationController
       @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
     end
 
-    # Never trust parameters from the scary internet, only allow the white list through.
+    # Only allow a list of trusted parameters through.
     def <%= "#{singular_table_name}_params" %>
       <%- if attributes_names.empty? -%>
       params.fetch(<%= ":#{singular_table_name}" %>, {})
       <%- else -%>
-      params.require(<%= ":#{singular_table_name}" %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      params.require(<%= ":#{singular_table_name}" %>).permit(<%= permitted_params %>)
       <%- end -%>
     end
 end