jbuilder 2.6.0 → 2.11.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d949cb2167336c8e5b026626493bb07843dab242
-  data.tar.gz: 1c0a6e23cb4441794732665e5fa2ef73a63eae0d
+SHA256:
+  metadata.gz: 9ce8fbeac8b34ee290535e98a284a1247e2de1b5272c4679c1b89a89ff8149db
+  data.tar.gz: cdaeb1302c4755ca43f037328698afe29fe658f2094c99e2c6f81f0000b9368c
 SHA512:
-  metadata.gz: bd78d3b8d0fa94ead3c7a77c7769593f2202ec46d18f3a2d3ba875f35a72040bd0e519bfd6e67b60fea465fbef8ffaf8966d964e02538eb8479c52011a5c24a1
-  data.tar.gz: dc257849862f9619da61c740ab9596026b1e2d9cdf0b3b8aa7eee7ab23eef1912fc00ec49eb6c6a3cd888161104929ff851ddbabb1358d655dc947003f6222cc
+  metadata.gz: 6903b1aa13786fd5501d8e667eb7a913ebd469d24ce183a24cdf949a62788b1e598c2e0678c5ed5e369d4232c7720e284850f735c5be6f4691e4ecf42256d21a
+  data.tar.gz: 2a40e415a25a4d8680ac00ba81b9984188ef35440869a357db4fd7184d3f0b36d0ce10545a0d5253e6d12374b2f1d51f5a96f1ded1370ec7eddecaee469afc61

data/.github/workflows/ruby.yml

@@ -0,0 +1,108 @@
+name: Ruby test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }} (${{ matrix.gemfile }})
+    runs-on: ubuntu-20.04
+    continue-on-error: ${{ matrix.experimental }}
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: 
+          - "2.2"
+          - "2.3"
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+
+        gemfile:
+          - "rails_5_0"
+          - "rails_5_1"
+          - "rails_5_2"
+          - "rails_6_0"
+          - "rails_6_1"
+          - "rails_head"
+        
+        experimental: [false]
+        exclude:
+          - ruby: 2.7
+            gemfile: rails_5_0
+          - ruby: '3.0'
+            gemfile: rails_5_0
+          - ruby: head
+            gemfile: rails_5_0
+          - ruby: 2.7
+            gemfile: rails_5_1
+          - ruby: '3.0'
+            gemfile: rails_5_1
+          - ruby: head
+            gemfile: rails_5_1
+          - ruby: 2.2
+            gemfile: rails_5_2
+          - ruby: 2.7
+            gemfile: rails_5_2
+          - ruby: '3.0'
+            gemfile: rails_5_2
+          - ruby: head
+            gemfile: rails_5_2
+          - ruby: 2.2
+            gemfile: rails_6_0
+          - ruby: 2.3
+            gemfile: rails_6_0
+          - ruby: 2.4
+            gemfile: rails_6_0
+          - ruby: '3.0'
+            gemfile: rails_6_0
+          - ruby: head
+            gemfile: rails_6_0
+          - ruby: 2.2
+            gemfile: rails_6_1
+          - ruby: 2.3
+            gemfile: rails_6_1
+          - ruby: 2.4
+            gemfile: rails_6_1
+          - ruby: 2.2
+            gemfile: rails_head
+          - ruby: 2.3
+            gemfile: rails_head
+          - ruby: 2.4
+            gemfile: rails_head
+          - ruby: 2.5
+            gemfile: rails_head
+          - ruby: 2.6
+            gemfile: rails_head
+          - ruby: 2.7
+            gemfile: rails_head
+            experimental: false
+          - ruby: '3.0'
+            gemfile: rails_head
+            experimental: false
+        include:
+          - ruby: 2.7
+            gemfile: rails_head
+            experimental: true
+          - ruby: '3.0'
+            gemfile: rails_head
+            experimental: true
+          - ruby: head
+            gemfile: rails_head
+            experimental: true
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Ruby test
+        run: bundle exec rake

data/.gitignore

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

data/Appraisals

@@ -1,44 +1,25 @@
-appraise "rails-3-0" do
-  gem "test-unit"
-  gem "railties",    "~> 3.0.0"
-  gem "actionpack",  "~> 3.0.0"
-  gem "activemodel", "~> 3.0.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"
+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"
+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
 
-appraise "rails-4-1" do
-  gem "railties",    "~> 4.1.0"
-  gem "actionpack",  "~> 4.1.0"
-  gem "activemodel", "~> 4.1.0"
-end
+if RUBY_VERSION >= "2.5.0"
+  appraise "rails-6-0" do
+    gem "rails", "~> 6.0.0"
+  end
 
-appraise "rails-4-2" do
-  gem "railties",    "~> 4.2.0"
-  gem "actionpack",  "~> 4.2.0"
-  gem "activemodel", "~> 4.2.0"
-end
+  appraise "rails-6-1" do
+    gem "rails", "~> 6.1.0"
+  end
 
-appraise "rails-5-0" do
-  gem "railties",    "~> 5.0.0"
-  gem "actionpack",  "~> 5.0.0"
-  gem "activemodel", "~> 5.0.0"
+  appraise "rails-head" do
+    gem "rails", github: "rails/rails", branch: "main"
+  end
 end

data/CONTRIBUTING.md

@@ -1,21 +1,19 @@
 Contributing to Jbuilder
 =====================
 
-[![Build Status](https://api.travis-ci.org/rails/jbuilder.svg?branch=master)][travis]
+[![Build Status](https://github.com/rails/jbuilder/workflows/Ruby%20test/badge.svg)][test]
 [![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
+[test]: https://github.com/rails/jbuilder/actions?query=branch%3Amaster
 [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
@@ -39,7 +37,8 @@ Ensure that you can build the project and run tests.
 
 ```
 bundle install
-bundle exec rake test
+appraisal install
+appraisal rake test
 ```
 
 #### Write Tests
@@ -52,7 +51,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
 
@@ -82,7 +81,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
 
@@ -96,11 +95,11 @@ git push origin my-feature-branch -f
 
 #### Check on Your Pull Request
 
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+Go back to your pull request after a few minutes and see whether it passed muster with GitHub Actions. Everything should look green, otherwise fix issues and amend your commit as described above.
 
 #### 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-2016 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,7 +1,7 @@
 # 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:
 
@@ -67,6 +67,19 @@ end
 # => {"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.
 
 ``` ruby
@@ -95,6 +108,33 @@ json.array! @people, :id, :name
 # => [ { "id": 1, "name": "David" }, { "id": 2, "name": "Jamie" } ]
 ```
 
+To make a plain array without keys, construct and pass in a standard Ruby array.
+
+```ruby
+my_array = %w(David Jamie)
+
+json.people my_array
+
+# => "people": [ "David", "Jamie" ]
+```
+
+You don't always have or need a collection when building an array.
+
+```ruby
+json.people do
+  json.child! do
+    json.id 1
+    json.name 'David'
+  end
+  json.child! do
+    json.id 2
+    json.name 'Jamie'
+  end
+end
+
+# => { "people": [ { "id": 1, "name": "David" }, { "id": 2, "name": "Jamie" } ] }
+```
+
 Jbuilder objects can be directly nested inside each other.  Useful for composing objects.
 
 ``` ruby
@@ -124,7 +164,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 à la show.json.jbuilder
 (the json is already yielded):
 
 ``` ruby
@@ -143,7 +183,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
@@ -159,18 +198,37 @@ It's also possible to render collections of partials:
 json.array! @posts, partial: 'posts/post', as: :post
 
 # or
-
 json.partial! 'posts/post', collection: @posts, as: :post
 
 # or
-
 json.partial! partial: 'posts/post', collection: @posts, as: :post
 
 # or
-
 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 from:
+
+```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
@@ -205,6 +263,8 @@ json.bar "bar"
 # => { "bar": "bar" }
 ```
 
+## Caching
+
 Fragment caching is supported, it uses `Rails.cache` and works like caching in
 HTML templates:
 
@@ -222,9 +282,25 @@ json.cache_if! !admin?, ['v1', @person], expires_in: 10.minutes do
 end
 ```
 
-If you are rendering fragments for a collection of objects, have a look at
-`jbuilder_cache_multi` gem. It uses fetch_multi (>= Rails 4.1) to fetch
-multiple keys at once.
+Aside from that, the `:cached` options on collection rendering is available on Rails >= 6.0. This will cache the
+rendered results effectively using the multi fetch feature.
+
+```ruby
+json.array! @posts, partial: "posts/post", as: :post, cached: true
+
+# or:
+json.comments @post.comments, partial: "comments/comment", as: :comment, cached: true
+```
+
+If your collection cache depends on multiple sources (try to avoid this to keep things simple), you can name all these dependencies as part of a block that returns an array:
+
+```ruby
+json.array! @posts, partial: "posts/post", as: :post, cached: -> post { [post, current_user] }
+```
+
+This will include both records as part of the cache key and updating either of them will expire the cache.
+
+## Formatting Keys
 
 Keys can be auto formatted using `key_format!`, this can be used to convert
 keynames from the standard ruby_format to camelCase:
@@ -243,20 +319,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/Rakefile

@@ -2,7 +2,7 @@ require "bundler/setup"
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["CI"]
   require "appraisal/task"
   Appraisal::Task.new
   task default: :appraisal
@@ -12,11 +12,7 @@ else
 
     test.libs << "test"
 
-    if Rails::VERSION::MAJOR == 3
-      test.test_files = %w[test/jbuilder_template_test.rb test/jbuilder_test.rb]
-    else
-      test.test_files = FileList["test/*_test.rb"]
-    end
+    test.test_files = FileList["test/*_test.rb"]
   end
 
   task default: :test

data/gemfiles/rails_5_0.gemfile

@@ -3,11 +3,8 @@
 source "https://rubygems.org"
 
 gem "rake"
-gem "mocha", :require => false
+gem "mocha", require: false
 gem "appraisal"
-gem "pry"
-gem "railties", ">= 5.0.0.beta2", "< 5.1"
-gem "actionpack", ">= 5.0.0.beta2", "< 5.1"
-gem "activemodel", ">= 5.0.0.beta2", "< 5.1"
+gem "rails", "~> 5.0.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5_1.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", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5_2.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", "~> 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_6_1.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.1.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", branch: "main"
+
+gemspec path: "../"

data/jbuilder.gemspec

@@ -1,17 +1,31 @@
 Gem::Specification.new do |s|
   s.name     = 'jbuilder'
-  s.version  = '2.6.0'
-  s.authors  = ['David Heinemeier Hansson', 'Pavel Pravosud']
-  s.email    = ['david@37signals.com', 'pavel@pravosud.com']
+  s.version  = '2.11.5'
+  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', '>= 3.0.0', '< 5.1'
-  s.add_dependency 'multi_json',    '~> 1.2'
+  s.add_dependency 'activesupport', '>= 5.0.0'
+  s.add_dependency 'actionview', '>= 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")
+
+  s.metadata = {
+    "bug_tracker_uri"       => "https://github.com/rails/jbuilder/issues",
+    "changelog_uri"         => "https://github.com/rails/jbuilder/releases/tag/v#{s.version}",
+    "mailing_list_uri"      => "https://discuss.rubyonrails.org/c/rubyonrails-talk",
+    "source_code_uri"       => "https://github.com/rails/jbuilder/tree/v#{s.version}",
+    "rubygems_mfa_required" => "true",
+  }
 end

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

@@ -6,7 +6,13 @@ module Rails
     class ScaffoldControllerGenerator
       source_paths << File.expand_path('../templates', __FILE__)
 
-      hook_for :jbuilder, default: true
+      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