jbuilder 2.8.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c134282537dc64d7253ed11314a8ee31402b4fe994626a955b57f308d8bc082
-  data.tar.gz: eebcdba24d5b41aaf87009296fbb63dd4628677b09955ed7c385e048ad3034a2
+  metadata.gz: a7289a23f21f82bfb3eeccd466ec985e8348a9977ed083be43eb8349551e840c
+  data.tar.gz: 20d2ba506a7a474d2a32030d91cef03d4345f2332a0753bca685ce6360b30995
 SHA512:
-  metadata.gz: 563cfe1ba9e191ed286ca80f77d7ea41737bb402cd257859ec5ffbf3ee77b7a7b041c3cb433d035f10a68a04df2e186140942a98b78b32d7b6d6e64a6514ff44
-  data.tar.gz: 8c7e23e0e0aa6abdc56f5a14d4b3ea4c7aa4abdc515d3d8fc8e10385c97733e4f5174a861ffc8fda3913623f90dbb878e7547eec917ebb5d9589d46d9d04c3ba
+  metadata.gz: fc04dfeb7c16b4547d0f7949b30ec481eb8517da3318550cf6c9f5e8bbc7bdc107c2d8bccc94e0e506741926d14f6798e783ece3640abb6edb323a39f7a691ae
+  data.tar.gz: 29a6793c2a3b4318b27b2a0614cc88c2a5e4ca646f39a29cb563d370524bc3c946b9ea8bff114b6a5ae9ea5b4e9d3546e30211f0ada15ad74ff028663933e5d7

data/.gitignore

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

data/.travis.yml

@@ -1,56 +1,47 @@
 language: ruby
 
-sudo: false
 cache: bundler
 
 before_install:
-  - gem update --system
-  - gem install bundler
+  - "gem update --system 2.7.9"
+  - "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.6
+  - 2.5.5
+  - 2.6.2
   - ruby-head
-  - jruby-19mode
-  - rbx
+  - rbx-3.107
 
 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:
+  exclude:
+    - 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
+    - rvm: rbx-3.107
     - rvm: ruby-head
+    - gemfile: gemfiles/rails_head.gemfile
   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
-      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
-      gemfile: gemfiles/rails_5_1.gemfile
 
 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,27 @@
 # Changelog
 
+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/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,21 +274,6 @@ 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 the work of many contributors. You're encouraged to submit pull requests, propose

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,15 @@
 Gem::Specification.new do |s|
   s.name     = 'jbuilder'
-  s.version  = '2.8.0'
+  s.version  = '2.10.0'
   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'
 
   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)

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

@@ -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

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

@@ -72,12 +72,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

data/lib/generators/rails/templates/index.json.jbuilder

@@ -1 +1 @@
-json.array! @<%= plural_table_name %>, partial: '<%= plural_table_name %>/<%= singular_table_name %>', as: :<%= singular_table_name %>
+json.array! @<%= plural_table_name %>, partial: "<%= plural_table_name %>/<%= singular_table_name %>", as: :<%= singular_table_name %>

data/lib/generators/rails/templates/partial.json.jbuilder

@@ -1,2 +1,2 @@
-json.extract! <%= singular_table_name %>, <%= attributes_list_with_timestamps %>
+json.extract! <%= singular_table_name %>, <%= full_attributes_list %>
 json.url <%= singular_table_name %>_url(<%= singular_table_name %>, format: :json)

data/lib/jbuilder/jbuilder_template.rb

@@ -73,8 +73,8 @@ class JbuilderTemplate < Jbuilder
   #   json.cache_if! !admin?, @person, expires_in: 10.minutes do
   #     json.extract! @person, :name, :age
   #   end
-  def cache_if!(condition, *args)
-    condition ? cache!(*args, &::Proc.new) : yield
+  def cache_if!(condition, *args, &block)
+    condition ? cache!(*args, &block) : yield
   end
 
   def target!
@@ -104,7 +104,7 @@ class JbuilderTemplate < Jbuilder
   private
 
   def _render_partial_with_options(options)
-    options.reverse_merge! locals: {}
+    options.reverse_merge! locals: options.except(:partial, :as, :collection)
     options.reverse_merge! ::JbuilderTemplate.template_lookup_options
     as = options[:as]
 
@@ -222,11 +222,12 @@ end
 
 class JbuilderHandler
   cattr_accessor :default_format
-  self.default_format = Mime[:json]
+  self.default_format = :json
 
-  def self.call(template)
+  def self.call(template, source = nil)
+    source ||= template.source
     # this juggling is required to keep line numbers right in the error
-    %{__already_defined = defined?(json); json||=JbuilderTemplate.new(self); #{template.source}
+    %{__already_defined = defined?(json); json||=JbuilderTemplate.new(self); #{source}
       json.target! unless (__already_defined && __already_defined != "method")}
   end
 end

data/lib/jbuilder.rb

@@ -2,8 +2,9 @@ require 'jbuilder/jbuilder'
 require 'jbuilder/blank'
 require 'jbuilder/key_formatter'
 require 'jbuilder/errors'
-require 'multi_json'
+require 'json'
 require 'ostruct'
+require 'active_support/core_ext/hash/deep_merge'
 
 class Jbuilder
   @@key_formatter = nil
@@ -26,12 +27,12 @@ class Jbuilder
   BLANK = Blank.new
   NON_ENUMERABLES = [ ::Struct, ::OpenStruct ].to_set
 
-  def set!(key, value = BLANK, *args)
+  def set!(key, value = BLANK, *args, &block)
     result = if ::Kernel.block_given?
       if !_blank?(value)
         # json.comments @post.comments { |comment| ... }
         # { "comments": [ { ... }, { ... } ] }
-        _scope{ array! value, &::Proc.new }
+        _scope{ array! value, &block }
       else
         # json.comments { ... }
         # { "comments": ... }
@@ -61,9 +62,9 @@ class Jbuilder
     _set_value key, result
   end
 
-  def method_missing(*args)
+  def method_missing(*args, &block)
     if ::Kernel.block_given?
-      set!(*args, &::Proc.new)
+      set!(*args, &block)
     else
       set!(*args)
     end
@@ -163,7 +164,7 @@ class Jbuilder
   #
   #   [ { "name": David", "age": 32 }, { "name": Jamie", "age": 31 } ]
   #
-  # If you are using Ruby 1.9+, you can use the call syntax instead of an explicit extract! call:
+  # You can use the call syntax instead of an explicit extract! call:
   #
   #   json.(@people) { |person| ... }
   #
@@ -181,11 +182,11 @@ class Jbuilder
   #   json.array! [1, 2, 3]
   #
   #   [1,2,3]
-  def array!(collection = [], *attributes)
+  def array!(collection = [], *attributes, &block)
     array = if collection.nil?
       []
     elsif ::Kernel.block_given?
-      _map_collection(collection, &::Proc.new)
+      _map_collection(collection, &block)
     elsif attributes.any?
       _map_collection(collection) { |element| extract! element, *attributes }
     else
@@ -220,9 +221,9 @@ class Jbuilder
     end
   end
 
-  def call(object, *attributes)
+  def call(object, *attributes, &block)
     if ::Kernel.block_given?
-      array! object, &::Proc.new
+      array! object, &block
     else
       extract! object, *attributes
     end
@@ -247,7 +248,7 @@ class Jbuilder
 
   # Encodes the current builder as JSON.
   def target!
-    ::MultiJson.dump(@attributes)
+    @attributes.to_json
   end
 
   private
@@ -275,7 +276,7 @@ class Jbuilder
     elsif ::Array === current_value && ::Array === updates
       current_value + updates
     elsif ::Hash === current_value && ::Hash === updates
-      current_value.merge(updates)
+      current_value.deep_merge(updates)
     else
       raise MergeError.build(current_value, updates)
     end

data/test/jbuilder_generator_test.rb

@@ -21,18 +21,26 @@ class JbuilderGeneratorTest < Rails::Generators::TestCase
     run_generator
 
     assert_file 'app/views/posts/index.json.jbuilder' do |content|
-      assert_match %r{json.array! @posts, partial: 'posts/post', as: :post}, content
+      assert_match %r{json\.array! @posts, partial: "posts/post", as: :post}, content
     end
 
     assert_file 'app/views/posts/show.json.jbuilder' do |content|
-      assert_match %r{json.partial! \"posts/post\", post: @post}, content
+      assert_match %r{json\.partial! "posts/post", post: @post}, content
     end
-    
-    assert_file 'app/views/posts/_post.json.jbuilder' do |content|            
+
+    assert_file 'app/views/posts/_post.json.jbuilder' do |content|
       assert_match %r{json\.extract! post, :id, :title, :body}, content
+      assert_match %r{:created_at, :updated_at}, content
       assert_match %r{json\.url post_url\(post, format: :json\)}, content
     end
-    
+  end
 
+  test 'timestamps are not generated in partial with --no-timestamps' do
+    run_generator %w(Post title body:text --no-timestamps)
+
+    assert_file 'app/views/posts/_post.json.jbuilder' do |content|
+      assert_match %r{json\.extract! post, :id, :title, :body$}, content
+      assert_no_match %r{:created_at, :updated_at}, content
+    end
   end
 end