jbuilder 2.6.1 → 2.11.5

data/test/jbuilder_test.rb

@@ -49,7 +49,7 @@ end
 
 
 class JbuilderTest < ActiveSupport::TestCase
-  setup do
+  teardown do
     Jbuilder.send :class_variable_set, '@@key_formatter', nil
   end
 
@@ -75,7 +75,7 @@ class JbuilderTest < ActiveSupport::TestCase
     end
 
     assert result.has_key?('content')
-    assert_equal nil, result['content']
+    assert_nil result['content']
   end
 
   test 'multiple keys' do
@@ -99,7 +99,7 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal 32, result['age']
   end
 
-  test 'extracting from object using call style for 1.9' do
+  test 'extracting from object using call style' do
     person = Struct.new(:name, :age).new('David', 32)
 
     result = jbuild do |json|
@@ -159,6 +159,25 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal 32, result['author']['age']
   end
 
+  test 'nested blocks are additive' do
+    result = jbuild do |json|
+      json.author do
+        json.name do
+          json.first 'David'
+        end
+      end
+
+      json.author do
+        json.name do
+          json.last 'Heinemeier Hansson'
+        end
+      end
+    end
+
+    assert_equal 'David', result['author']['name']['first']
+    assert_equal 'Heinemeier Hansson', result['author']['name']['last']
+  end
+
   test 'support merge! method' do
     result = jbuild do |json|
       json.merge! 'foo' => 'bar'
@@ -177,6 +196,18 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal 'Pavel', result['author']['name']
   end
 
+  test 'support merge! method with Jbuilder instance' do
+    obj = jbuild do |json|
+      json.foo 'bar'
+    end
+
+    result = jbuild do |json|
+      json.merge! obj
+    end
+
+    assert_equal 'bar', result['foo']
+  end
+
   test 'blocks are additive via extract syntax' do
     person = Person.new('Pavel', 27)
 
@@ -281,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|
@@ -535,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
@@ -562,6 +623,161 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal ['oats and friends'], result.keys
   end
 
+  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 '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 '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 '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 '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
+
+    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' }
@@ -686,4 +902,40 @@ class JbuilderTest < ActiveSupport::TestCase
       end
     end
   end
+
+  test "throws MergeError when trying to merge array with non-empty hash" do
+    assert_raise Jbuilder::MergeError do
+      jbuild do |json|
+        json.name "Daniel"
+        json.merge! []
+      end
+    end
+  end
+
+  test "throws MergeError when trying to merge hash with array" do
+    assert_raise Jbuilder::MergeError do
+      jbuild do |json|
+        json.array!
+        json.merge!({})
+      end
+    end
+  end
+
+  test "throws MergeError when trying to merge invalid objects" do
+    assert_raise Jbuilder::MergeError do
+      jbuild do |json|
+        json.name "Daniel"
+        json.merge! "Nope"
+      end
+    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"]
+    end
+  end
 end

data/test/scaffold_api_controller_generator_test.rb

@@ -6,7 +6,7 @@ if Rails::VERSION::MAJOR > 4
 
   class ScaffoldApiControllerGeneratorTest < Rails::Generators::TestCase
     tests Rails::Generators::ScaffoldControllerGenerator
-    arguments %w(Post title body:text --api)
+    arguments %w(Post title body:text images:attachments --api)
     destination File.expand_path('../tmp', __FILE__)
     setup :prepare_destination
 
@@ -39,11 +39,15 @@ if Rails::VERSION::MAJOR > 4
         end
 
         assert_match %r{def post_params}, content
-        assert_match %r{params\.require\(:post\)\.permit\(:title, :body\)}, 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
       end
     end
 
-    test 'dont use require and permit if there are no attributes' do
+    test "don't use require and permit if there are no attributes" do
       run_generator %w(Post --api)
 
       assert_file 'app/controllers/posts_controller.rb' do |content|
@@ -51,5 +55,16 @@ if Rails::VERSION::MAJOR > 4
         assert_match %r{params\.fetch\(:post, \{\}\)}, content
       end
     end
+
+
+    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
+      end
+    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)
+  arguments %w(Post title body:text images:attachments)
   destination File.expand_path('../tmp', __FILE__)
   setup :prepare_destination
 
@@ -31,31 +31,54 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
       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{format\.html \{ redirect_to @post, notice: 'Post was successfully created\.' \}}, m
+        assert_match %r{format\.html \{ redirect_to post_url\(@post\), notice: "Post was successfully created\." \}}, m
         assert_match %r{format\.json \{ render :show, status: :created, location: @post \}}, m
-        assert_match %r{format\.html \{ render :new \}}, m
+        assert_match %r{format\.html \{ render :new, status: :unprocessable_entity \}}, m
         assert_match %r{format\.json \{ render json: @post\.errors, status: :unprocessable_entity \}}, m
       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_url\(@post\), notice: "Post was successfully updated\." \}}, m
         assert_match %r{format\.json \{ render :show, status: :ok, location: @post \}}, m
-        assert_match %r{format\.html \{ render :edit \}}, 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
       end
 
       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_url, notice: "Post was successfully destroyed\." \}}, m
         assert_match %r{format\.json \{ head :no_content \}}, m
       end
 
       assert_match %r{def post_params}, content
-      assert_match %r{params\.require\(:post\)\.permit\(:title, :body\)}, 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
+    end
+  end
+
+  if Rails::VERSION::MAJOR >= 6
+    test 'controller with namespace' do
+      run_generator %w(Admin::Post --model-name=Post)
+      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_url\(@post\), notice: "Post was successfully created\." \}}, m
+        end
+
+        assert_instance_method :update, content do |m|
+          assert_match %r{format\.html \{ redirect_to admin_post_url\(@post\), notice: "Post was successfully updated\." \}}, m
+        end
+
+        assert_instance_method :destroy, content do |m|
+          assert_match %r{format\.html \{ redirect_to admin_posts_url, notice: "Post was successfully destroyed\." \}}, m
+        end
+      end
     end
   end
 
-  test 'dont use require and permit if there are no attributes' do
+  test "don't use require and permit if there are no attributes" do
     run_generator %w(Post)
 
     assert_file 'app/controllers/posts_controller.rb' do |content|
@@ -63,4 +86,14 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
       assert_match %r{params\.fetch\(:post, \{\}\)}, content
     end
   end
+
+  if Rails::VERSION::MAJOR >= 6
+    test 'handles virtual attributes' do
+      run_generator %w(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
+    end
+  end
 end

data/test/test_helper.rb

@@ -1,14 +1,36 @@
 require "bundler/setup"
-require "active_support"
-require "rails/version"
 
-if Rails::VERSION::STRING > "4.0"
-  require "active_support/testing/autorun"
-else
-  require "test/unit"
+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 "active_support/testing/autorun"
+require "mocha/minitest"
+
+ActiveSupport.test_order = :random
+
+class << Rails
+  def cache
+    @cache ||= ActiveSupport::Cache::MemoryStore.new
+  end
 end
 
+Jbuilder::CollectionRenderer.collection_cache = Rails.cache
+
+class Post < Struct.new(:id, :body, :author_name)
+  def cache_key
+    "post-#{id}"
+  end
+end
 
-if ActiveSupport.respond_to?(:test_order=)
-  ActiveSupport.test_order = :random
+class Racer < Struct.new(:id, :name)
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
 end
+
+ActionView::Template.register_template_handler :jbuilder, JbuilderHandler

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.11.5
 platform: ruby
 authors:
 - David Heinemeier Hansson
-- Pavel Pravosud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,58 +16,48 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 5.0.0
 description: 
-email:
-- david@37signals.com
-- pavel@pravosud.com
+email: david@basecamp.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - Appraisals
-- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
-- 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_5_0.gemfile
+- gemfiles/rails_5_1.gemfile
+- gemfiles/rails_5_2.gemfile
+- gemfiles/rails_6_0.gemfile
+- gemfiles/rails_6_1.gemfile
+- gemfiles/rails_head.gemfile
 - jbuilder.gemspec
 - lib/generators/rails/jbuilder_generator.rb
 - lib/generators/rails/scaffold_controller_generator.rb
@@ -79,6 +68,7 @@ files:
 - lib/generators/rails/templates/show.json.jbuilder
 - lib/jbuilder.rb
 - lib/jbuilder/blank.rb
+- lib/jbuilder/collection_renderer.rb
 - lib/jbuilder/dependency_tracker.rb
 - lib/jbuilder/errors.rb
 - lib/jbuilder/jbuilder.rb
@@ -95,7 +85,12 @@ files:
 homepage: https://github.com/rails/jbuilder
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/rails/jbuilder/issues
+  changelog_uri: https://github.com/rails/jbuilder/releases/tag/v2.11.5
+  mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
+  source_code_uri: https://github.com/rails/jbuilder/tree/v2.11.5
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -104,15 +99,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Create JSON structures via a Builder-style DSL

data/.travis.yml

@@ -1,44 +0,0 @@
-language: ruby
-
-sudo: false
-cache: bundler
-
-rvm:
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.2.5
-  - 2.3.1
-  - ruby-head
-  - jruby-19mode
-  - rbx
-
-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_5_0.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: 2.0
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 2.1
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: jruby-19mode
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: rbx
-      gemfile: gemfiles/rails_5_0.gemfile
-
-notifications:
-  email: false