jbuilder 2.11.0 → 2.14.1

data/test/jbuilder_test.rb

@@ -312,7 +312,7 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal 'world', result['comments'].second['content']
   end
 
-  test 'nesting multiple chilren from a non-Enumerable that responds to #map with inline loop' do
+  test 'nesting multiple children from a non-Enumerable that responds to #map with inline loop' do
     comments = NonEnumerable.new([ Comment.new('hello', 1), Comment.new('world', 2) ])
 
     result = jbuild do |json|
@@ -566,6 +566,36 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal 'one', result['level1']
   end
 
+  test 'key_format! can be changed in child elements' do
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+
+      json.level_one do
+        json.key_format! :upcase
+        json.value 'two'
+      end
+    end
+
+    assert_equal ['levelOne'], result.keys
+    assert_equal ['VALUE'], result['levelOne'].keys
+  end
+
+  test 'key_format! can be changed in array!' do
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+
+      json.level_one do
+        json.array! [{value: 'two'}] do |object|
+          json.key_format! :upcase
+          json.value object[:value]
+        end
+      end
+    end
+
+    assert_equal ['levelOne'], result.keys
+    assert_equal ['VALUE'], result['levelOne'][0].keys
+  end
+
   test 'key_format! with no parameter' do
     result = jbuild do |json|
       json.key_format! :upcase
@@ -593,51 +623,121 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal ['oats and friends'], result.keys
   end
 
-  test 'key_format! with merge!' do
+  test 'key_format! is not applied deeply by default' do
+    names = { first_name: 'camel', last_name: 'case' }
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.set! :all_names, names
+    end
+
+    assert_equal %i[first_name last_name], result['allNames'].keys
+  end
+
+  test 'applying key_format! deeply can be enabled per scope' do
+    names = { first_name: 'camel', last_name: 'case' }
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.scope do
+        json.deep_format_keys!
+        json.set! :all_names, names
+      end
+      json.set! :all_names, names
+    end
+
+    assert_equal %w[firstName lastName], result['scope']['allNames'].keys
+    assert_equal %i[first_name last_name], result['allNames'].keys
+  end
+
+  test 'applying key_format! deeply can be disabled per scope' do
+    names = { first_name: 'camel', last_name: 'case' }
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.deep_format_keys!
+      json.set! :all_names, names
+      json.scope do
+        json.deep_format_keys! false
+        json.set! :all_names, names
+      end
+    end
+
+    assert_equal %w[firstName lastName], result['allNames'].keys
+    assert_equal %i[first_name last_name], result['scope']['allNames'].keys
+  end
+
+  test 'applying key_format! deeply can be enabled globally' do
+    names = { first_name: 'camel', last_name: 'case' }
+
+    Jbuilder.deep_format_keys true
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.set! :all_names, names
+    end
+
+    assert_equal %w[firstName lastName], result['allNames'].keys
+    Jbuilder.send(:class_variable_set, '@@deep_format_keys', false)
+  end
+
+  test 'deep key_format! with merge!' do
     hash = { camel_style: 'for JS' }
     result = jbuild do |json|
       json.key_format! camelize: :lower
+      json.deep_format_keys!
       json.merge! hash
     end
 
     assert_equal ['camelStyle'], result.keys
   end
 
-  test 'key_format! with merge! deep' do
+  test 'deep key_format! with merge! deep' do
     hash = { camel_style: { sub_attr: 'for JS' } }
     result = jbuild do |json|
       json.key_format! camelize: :lower
+      json.deep_format_keys!
       json.merge! hash
     end
 
     assert_equal ['subAttr'], result['camelStyle'].keys
   end
 
-  test 'key_format! with set! array of hashes' do
+  test 'deep key_format! with set! array of hashes' do
     names = [{ first_name: 'camel', last_name: 'case' }]
     result = jbuild do |json|
       json.key_format! camelize: :lower
+      json.deep_format_keys!
       json.set! :names, names
     end
 
     assert_equal %w[firstName lastName], result['names'][0].keys
   end
 
-  test 'key_format! with array! of hashes' do
+  test 'deep key_format! with set! extracting hash from object' do
+    comment = Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.deep_format_keys!
+      json.set! :comment, comment, :author
+    end
+
+    assert_equal %w[firstName lastName], result['comment']['author'].keys
+  end
+
+  test 'deep key_format! with array! of hashes' do
     names = [{ first_name: 'camel', last_name: 'case' }]
     result = jbuild do |json|
       json.key_format! camelize: :lower
+      json.deep_format_keys!
       json.array! names
     end
 
     assert_equal %w[firstName lastName], result[0].keys
   end
 
-  test 'key_format! with merge! array of hashes' do
+  test 'deep key_format! with merge! array of hashes' do
     names = [{ first_name: 'camel', last_name: 'case' }]
     new_names = [{ first_name: 'snake', last_name: 'case' }]
     result = jbuild do |json|
       json.key_format! camelize: :lower
+      json.deep_format_keys!
       json.array! names
       json.merge! new_names
     end
@@ -645,18 +745,51 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal %w[firstName lastName], result[1].keys
   end
 
+  test 'deep key_format! is applied to hash extracted from object' do
+    comment = Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.deep_format_keys!
+      json.extract! comment, :author
+    end
+
+    assert_equal %w[firstName lastName], result['author'].keys
+  end
+
+  test 'deep key_format! is applied to hash extracted from hash' do
+    comment = {author: { first_name: 'camel', last_name: 'case' }}
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.deep_format_keys!
+      json.extract! comment, :author
+    end
+
+    assert_equal %w[firstName lastName], result['author'].keys
+  end
+
+  test 'deep key_format! is applied to hash extracted directly from array' do
+    comments = [Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })]
+    result = jbuild do |json|
+      json.key_format! camelize: :lower
+      json.deep_format_keys!
+      json.array! comments, :author
+    end
+
+    assert_equal %w[firstName lastName], result[0]['author'].keys
+  end
+
   test 'default key_format!' do
     Jbuilder.key_format camelize: :lower
     result = jbuild{ |json| json.camel_style 'for JS' }
     assert_equal ['camelStyle'], result.keys
   end
 
-  test 'do not use default key formatter directly' do
+  test 'use default key formatter when configured' do
     Jbuilder.key_format
     jbuild{ |json| json.key 'value' }
     formatter = Jbuilder.send(:class_variable_get, '@@key_formatter')
     cache = formatter.instance_variable_get('@cache')
-    assert_empty cache
+    assert_includes cache, :key
   end
 
   test 'ignore_nil! without a parameter' do
@@ -797,12 +930,17 @@ class JbuilderTest < ActiveSupport::TestCase
     end
   end
 
-  if RUBY_VERSION >= "2.2.10"
-    test "respects JSON encoding customizations" do
-      # Active Support overrides Time#as_json for custom formatting.
-      # Ensure we call #to_json on the final attributes instead of JSON.dump.
-      result = JSON.load(Jbuilder.encode { |json| json.time Time.parse("2018-05-13 11:51:00.485 -0400") })
-      assert_equal "2018-05-13T11:51:00.485-04:00", result["time"]
+  test "respects JSON encoding customizations" do
+    # Active Support overrides Time#as_json for custom formatting.
+    # Ensure we call #to_json on the final attributes instead of JSON.dump.
+    result = JSON.load(Jbuilder.encode { |json| json.time Time.parse("2018-05-13 11:51:00.485 -0400") })
+    assert_equal "2018-05-13T11:51:00.485-04:00", result["time"]
+  end
+
+  test "encode forwards options to new" do
+    Jbuilder.encode(key_formatter: 1, ignore_nil: 2) do |json|
+      assert_equal 1, json.instance_eval{ @key_formatter }
+      assert_equal 2, json.instance_eval{ @ignore_nil }
     end
   end
 end

data/test/scaffold_api_controller_generator_test.rb

@@ -2,68 +2,73 @@ require 'test_helper'
 require 'rails/generators/test_case'
 require 'generators/rails/scaffold_controller_generator'
 
-if Rails::VERSION::MAJOR > 4
+class ScaffoldApiControllerGeneratorTest < Rails::Generators::TestCase
+  tests Rails::Generators::ScaffoldControllerGenerator
+  arguments %w(Post title body:text images:attachments --api --skip-routes)
+  destination File.expand_path('../tmp', __FILE__)
+  setup :prepare_destination
 
-  class ScaffoldApiControllerGeneratorTest < Rails::Generators::TestCase
-    tests Rails::Generators::ScaffoldControllerGenerator
-    arguments %w(Post title body:text images:attachments --api)
-    destination File.expand_path('../tmp', __FILE__)
-    setup :prepare_destination
+  test 'controller content' do
+    run_generator
 
-    test 'controller content' do
-      run_generator
+    assert_file 'app/controllers/posts_controller.rb' do |content|
+      assert_instance_method :index, content do |m|
+        assert_match %r{@posts = Post\.all}, m
+      end
 
-      assert_file 'app/controllers/posts_controller.rb' do |content|
-        assert_instance_method :index, content do |m|
-          assert_match %r{@posts = Post\.all}, m
-        end
+      assert_instance_method :show, content do |m|
+        assert m.blank?
+      end
 
-        assert_instance_method :show, content do |m|
-          assert m.blank?
-        end
+      assert_instance_method :create, content do |m|
+        assert_match %r{@post = Post\.new\(post_params\)}, m
+        assert_match %r{@post\.save}, m
+        assert_match %r{render :show, status: :created, location: @post}, m
+        assert_match %r{render json: @post\.errors, status: :unprocessable_entity}, m
+      end
 
-        assert_instance_method :create, content do |m|
-          assert_match %r{@post = Post\.new\(post_params\)}, m
-          assert_match %r{@post\.save}, m
-          assert_match %r{render :show, status: :created, location: @post}, m
-          assert_match %r{render json: @post\.errors, status: :unprocessable_entity}, m
-        end
+      assert_instance_method :update, content do |m|
+        assert_match %r{render :show, status: :ok, location: @post}, m
+        assert_match %r{render json: @post.errors, status: :unprocessable_entity}, m
+      end
 
-        assert_instance_method :update, content do |m|
-          assert_match %r{render :show, status: :ok, location: @post}, m
-          assert_match %r{render json: @post.errors, status: :unprocessable_entity}, m
-        end
+      assert_instance_method :destroy, content do |m|
+        assert_match %r{@post\.destroy}, m
+      end
 
-        assert_instance_method :destroy, content do |m|
-          assert_match %r{@post\.destroy}, m
-        end
+      assert_match %r{def set_post}, content
+      if Rails::VERSION::MAJOR >= 8
+        assert_match %r{params\.expect\(:id\)}, content
+      else
+        assert_match %r{params\[:id\]}, content
+      end
 
-        assert_match %r{def post_params}, content
-        if Rails::VERSION::MAJOR >= 6
-          assert_match %r{params\.require\(:post\)\.permit\(:title, :body, images: \[\]\)}, content
-        else
-          assert_match %r{params\.require\(:post\)\.permit\(:title, :body, :images\)}, content
-        end
+      assert_match %r{def post_params}, content
+      if Rails::VERSION::MAJOR >= 8
+        assert_match %r{params\.expect\(post: \[ :title, :body, images: \[\] \]\)}, content
+      else
+        assert_match %r{params\.require\(:post\)\.permit\(:title, :body, images: \[\]\)}, content
       end
     end
+  end
 
-    test 'dont use require and permit if there are no attributes' do
-      run_generator %w(Post --api)
+  test "don't use require and permit if there are no attributes" do
+    run_generator %w(Post --api --skip-routes)
 
-      assert_file 'app/controllers/posts_controller.rb' do |content|
-        assert_match %r{def post_params}, content
-        assert_match %r{params\.fetch\(:post, \{\}\)}, content
-      end
+    assert_file 'app/controllers/posts_controller.rb' do |content|
+      assert_match %r{def post_params}, content
+      assert_match %r{params\.fetch\(:post, \{\}\)}, content
     end
+  end
 
+  test 'handles virtual attributes' do
+    run_generator %w(Message content:rich_text video:attachment photos:attachments --skip-routes)
 
-    if Rails::VERSION::MAJOR >= 6
-      test 'handles virtual attributes' do
-        run_generator ["Message", "content:rich_text", "video:attachment", "photos:attachments"]
-
-        assert_file 'app/controllers/messages_controller.rb' do |content|
-          assert_match %r{params\.require\(:message\)\.permit\(:content, :video, photos: \[\]\)}, content
-        end
+    assert_file 'app/controllers/messages_controller.rb' do |content|
+      if Rails::VERSION::MAJOR >= 8
+        assert_match %r{params\.expect\(message: \[ :content, :video, photos: \[\] \]\)}, content
+      else
+        assert_match %r{params\.require\(:message\)\.permit\(:content, :video, photos: \[\]\)}, content
       end
     end
   end

data/test/scaffold_controller_generator_test.rb

@@ -4,7 +4,7 @@ require 'generators/rails/scaffold_controller_generator'
 
 class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
   tests Rails::Generators::ScaffoldControllerGenerator
-  arguments %w(Post title body:text images:attachments)
+  arguments %w(Post title body:text images:attachments --skip-routes)
   destination File.expand_path('../tmp', __FILE__)
   setup :prepare_destination
 
@@ -38,7 +38,7 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
       end
 
       assert_instance_method :update, content do |m|
-        assert_match %r{format\.html \{ redirect_to @post, notice: "Post was successfully updated\." \}}, m
+        assert_match %r{format\.html \{ redirect_to @post, notice: "Post was successfully updated\.", status: :see_other \}}, m
         assert_match %r{format\.json \{ render :show, status: :ok, location: @post \}}, m
         assert_match %r{format\.html \{ render :edit, status: :unprocessable_entity \}}, m
         assert_match %r{format\.json \{ render json: @post.errors, status: :unprocessable_entity \}}, m
@@ -46,21 +46,45 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
 
       assert_instance_method :destroy, content do |m|
         assert_match %r{@post\.destroy}, m
-        assert_match %r{format\.html \{ redirect_to posts_url, notice: "Post was successfully destroyed\." \}}, m
+        assert_match %r{format\.html \{ redirect_to posts_path, notice: "Post was successfully destroyed\.", status: :see_other \}}, m
         assert_match %r{format\.json \{ head :no_content \}}, m
       end
 
+      assert_match %r{def set_post}, content
+      if Rails::VERSION::MAJOR >= 8
+        assert_match %r{params\.expect\(:id\)}, content
+      else
+        assert_match %r{params\[:id\]}, content
+      end
+
       assert_match %r{def post_params}, content
-      if Rails::VERSION::MAJOR >= 6
-        assert_match %r{params\.require\(:post\)\.permit\(:title, :body, images: \[\]\)}, content
+      if Rails::VERSION::MAJOR >= 8
+        assert_match %r{params\.expect\(post: \[ :title, :body, images: \[\] \]\)}, content
       else
-        assert_match %r{params\.require\(:post\)\.permit\(:title, :body, :images\)}, content
+        assert_match %r{params\.require\(:post\)\.permit\(:title, :body, images: \[\]\)}, content
       end
     end
   end
 
-  test 'dont use require and permit if there are no attributes' do
-    run_generator %w(Post)
+  test 'controller with namespace' do
+    run_generator %w(Admin::Post --model-name=Post --skip-routes)
+    assert_file 'app/controllers/admin/posts_controller.rb' do |content|
+      assert_instance_method :create, content do |m|
+        assert_match %r{format\.html \{ redirect_to \[:admin, @post\], notice: "Post was successfully created\." \}}, m
+      end
+
+      assert_instance_method :update, content do |m|
+        assert_match %r{format\.html \{ redirect_to \[:admin, @post\], notice: "Post was successfully updated\.", status: :see_other \}}, m
+      end
+
+      assert_instance_method :destroy, content do |m|
+        assert_match %r{format\.html \{ redirect_to admin_posts_path, notice: "Post was successfully destroyed\.", status: :see_other \}}, m
+      end
+    end
+  end
+
+  test "don't use require and permit if there are no attributes" do
+    run_generator %w(Post --skip-routes)
 
     assert_file 'app/controllers/posts_controller.rb' do |content|
       assert_match %r{def post_params}, content
@@ -68,11 +92,13 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
     end
   end
 
-  if Rails::VERSION::MAJOR >= 6
-    test 'handles virtual attributes' do
-      run_generator %w(Message content:rich_text video:attachment photos:attachments)
+  test 'handles virtual attributes' do
+    run_generator %w(Message content:rich_text video:attachment photos:attachments --skip-routes)
 
-      assert_file 'app/controllers/messages_controller.rb' do |content|
+    assert_file 'app/controllers/messages_controller.rb' do |content|
+      if Rails::VERSION::MAJOR >= 8
+        assert_match %r{params\.expect\(message: \[ :content, :video, photos: \[\] \]\)}, content
+      else
         assert_match %r{params\.require\(:message\)\.permit\(:content, :video, photos: \[\]\)}, content
       end
     end

data/test/test_helper.rb

@@ -1,34 +1,47 @@
 require "bundler/setup"
 
-require "active_support"
+require "rails"
+
+require "jbuilder"
+
 require "active_support/core_ext/array/access"
 require "active_support/cache/memory_store"
 require "active_support/json"
 require "active_model"
-require "action_view"
-require "rails/version"
-
-require "jbuilder"
+require 'action_controller/railtie'
+require 'action_view/railtie'
 
 require "active_support/testing/autorun"
 require "mocha/minitest"
 
 ActiveSupport.test_order = :random
 
+ENV["RAILS_ENV"] ||= "test"
+
 class << Rails
-  def cache
+  redefine_method :cache do
     @cache ||= ActiveSupport::Cache::MemoryStore.new
   end
 end
 
-class Post < Struct.new(:id, :body, :author_name); end
+Jbuilder::CollectionRenderer.collection_cache = Rails.cache
+
+class Post < Struct.new(:id, :body, :author_name)
+  def cache_key
+    "post-#{id}"
+  end
+end
 
 class Racer < Struct.new(:id, :name)
   extend ActiveModel::Naming
   include ActiveModel::Conversion
 end
 
-ActionView::Template.register_template_handler :jbuilder, JbuilderHandler
+# Instantiate an Application in order to trigger the initializers
+Class.new(Rails::Application) do
+  config.secret_key_base = 'secret'
+  config.eager_load = false
+end.initialize!
 
-ActionView::Base.remove_possible_method :fragment_name_with_digest
-ActionView::Base.remove_possible_method :cache_fragment_name
+# Touch AV::Base in order to trigger :action_view on_load hook before running the tests
+ActionView::Base.inspect

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.14.1
 platform: ruby
 authors:
 - David Heinemeier Hansson
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,33 +15,48 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
-description: 
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
 email: david@basecamp.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - Appraisals
-- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
-- gemfiles/rails_5_0.gemfile
-- gemfiles/rails_5_1.gemfile
-- gemfiles/rails_5_2.gemfile
-- gemfiles/rails_6_0.gemfile
+- bin/release
+- bin/test
+- gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_1.gemfile
+- gemfiles/rails_7_2.gemfile
+- gemfiles/rails_8_0.gemfile
 - gemfiles/rails_head.gemfile
 - jbuilder.gemspec
 - lib/generators/rails/jbuilder_generator.rb
@@ -54,12 +68,14 @@ files:
 - lib/generators/rails/templates/show.json.jbuilder
 - lib/jbuilder.rb
 - lib/jbuilder/blank.rb
-- lib/jbuilder/dependency_tracker.rb
+- lib/jbuilder/collection_renderer.rb
 - lib/jbuilder/errors.rb
 - lib/jbuilder/jbuilder.rb
+- lib/jbuilder/jbuilder_dependency_tracker.rb
 - lib/jbuilder/jbuilder_template.rb
 - lib/jbuilder/key_formatter.rb
 - lib/jbuilder/railtie.rb
+- lib/jbuilder/version.rb
 - test/jbuilder_dependency_tracker_test.rb
 - test/jbuilder_generator_test.rb
 - test/jbuilder_template_test.rb
@@ -70,8 +86,12 @@ files:
 homepage: https://github.com/rails/jbuilder
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/rails/jbuilder/issues
+  changelog_uri: https://github.com/rails/jbuilder/releases/tag/v2.14.1
+  mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
+  source_code_uri: https://github.com/rails/jbuilder/tree/v2.14.1
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -79,15 +99,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Create JSON structures via a Builder-style DSL
 test_files: