jbuilder 2.3.2 → 2.9.1

data/Rakefile

@@ -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_4_2.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", "~> 4.2.0"
-gem "actionpack", "~> 4.2.0"
-gem "activemodel", "~> 4.2.0"
+gem "rails", "~> 4.2.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5_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", "~> 5.0.0"
+
+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.rc1"
+
+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.3.2'
-  s.authors  = ['David Heinemeier Hansson', 'Pavel Pravosud']
-  s.email    = ['david@37signals.com', 'pavel@pravosud.com']
+  s.version  = '2.9.1'
+  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.add_dependency 'activesupport', '>= 3.0.0', '< 5'
-  s.add_dependency 'multi_json',    '~> 1.2'
+  s.add_dependency 'activesupport', '>= 4.2.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)
@@ -20,6 +22,7 @@ module Rails
           filename = filename_with_extensions(view)
           template filename, File.join('app/views', controller_file_path, filename)
         end
+        template filename_with_extensions('partial'), File.join('app/views', controller_file_path, filename_with_extensions("_#{singular_table_name}"))
       end
 
 
@@ -32,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

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

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

@@ -54,9 +54,9 @@ class <%= controller_class_name %>Controller < ApplicationController
     # Never trust parameters from the scary internet, only allow the white list through.
     def <%= "#{singular_table_name}_params" %>
       <%- if attributes_names.empty? -%>
-      params[<%= ":#{singular_table_name}" %>]
+      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

@@ -75,9 +75,9 @@ class <%= controller_class_name %>Controller < ApplicationController
     # Never trust parameters from the scary internet, only allow the white list through.
     def <%= "#{singular_table_name}_params" %>
       <%- if attributes_names.empty? -%>
-      params[<%= ":#{singular_table_name}" %>]
+      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,4 +1 @@
-json.array!(@<%= plural_table_name %>) do |<%= singular_table_name %>|
-  json.extract! <%= singular_table_name %>, <%= attributes_list %>
-  json.url <%= singular_table_name %>_url(<%= singular_table_name %>, format: :json)
-end
+json.array! @<%= plural_table_name %>, partial: "<%= plural_table_name %>/<%= singular_table_name %>", as: :<%= singular_table_name %>

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

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

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

@@ -1 +1 @@
-json.extract! @<%= singular_table_name %>, <%= attributes_list_with_timestamps %>
+json.partial! "<%= plural_table_name %>/<%= singular_table_name %>", <%= singular_table_name %>: @<%= singular_table_name %>

data/lib/jbuilder.rb

@@ -2,7 +2,7 @@ require 'jbuilder/jbuilder'
 require 'jbuilder/blank'
 require 'jbuilder/key_formatter'
 require 'jbuilder/errors'
-require 'multi_json'
+require 'json'
 require 'ostruct'
 
 class Jbuilder
@@ -247,7 +247,7 @@ class Jbuilder
 
   # Encodes the current builder as JSON.
   def target!
-    ::MultiJson.dump(@attributes)
+    @attributes.to_json
   end
 
   private
@@ -270,14 +270,14 @@ class Jbuilder
   def _merge_values(current_value, updates)
     if _blank?(updates)
       current_value
-    elsif _blank?(current_value) || updates.nil?
+    elsif _blank?(current_value) || updates.nil? || current_value.empty? && ::Array === updates
       updates
-    elsif ::Array === updates
-      ::Array === current_value ? current_value + updates : updates
-    elsif ::Hash === current_value
+    elsif ::Array === current_value && ::Array === updates
+      current_value + updates
+    elsif ::Hash === current_value && ::Hash === updates
       current_value.merge(updates)
     else
-      raise "Can't merge #{updates.inspect} with #{current_value.inspect}"
+      raise MergeError.build(current_value, updates)
     end
   end
 

data/lib/jbuilder/errors.rb

@@ -14,4 +14,11 @@ class Jbuilder
       new(message)
     end
   end
+
+  class MergeError < ::StandardError
+    def self.build(current_value, updates)
+      message = "Can't merge #{updates.inspect} into #{current_value.inspect}"
+      new(message)
+    end
+  end
 end

data/lib/jbuilder/jbuilder_template.rb

@@ -11,6 +11,7 @@ class JbuilderTemplate < Jbuilder
 
   def initialize(context, *args)
     @context = context
+    @cached_root = nil
     super(*args)
   end
 
@@ -32,7 +33,7 @@ class JbuilderTemplate < Jbuilder
   #   end
   def cache!(key=nil, options={})
     if @context.controller.perform_caching
-      value = ::Rails.cache.fetch(_cache_key(key, options), options) do
+      value = _cache_fragment_for(key, options) do
         _scope { yield self }
       end
 
@@ -42,6 +43,27 @@ class JbuilderTemplate < Jbuilder
     end
   end
 
+  # Caches the json structure at the root using a string rather than the hash structure. This is considerably
+  # faster, but the drawback is that it only works, as the name hints, at the root. So you cannot
+  # use this approach to cache deeper inside the hierarchy, like in partials or such. Continue to use #cache! there.
+  #
+  # Example:
+  #
+  #   json.cache_root! @person do
+  #     json.extract! @person, :name, :age
+  #   end
+  #
+  #   # json.extra 'This will not work either, the root must be exclusive'
+  def cache_root!(key=nil, options={})
+    if @context.controller.perform_caching
+      raise "cache_root! can't be used after JSON structures have been defined" if @attributes.present?
+
+      @cached_root = _cache_fragment_for([ :root, key ], options) { yield; target! }
+    else
+      yield
+    end
+  end
+
   # Conditionally caches the json depending in the condition given as first parameter. Has the same
   # signature as the `cache` helper method in `ActionView::Helpers::CacheHelper` and so can be used in
   # the same way.
@@ -55,6 +77,10 @@ class JbuilderTemplate < Jbuilder
     condition ? cache!(*args, &::Proc.new) : yield
   end
 
+  def target!
+    @cached_root || super
+  end
+
   def array!(collection = [], *args)
     options = args.first
 
@@ -78,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]
 
@@ -102,9 +128,35 @@ class JbuilderTemplate < Jbuilder
     @context.render options
   end
 
+  def _cache_fragment_for(key, options, &block)
+    key = _cache_key(key, options)
+    _read_fragment_cache(key, options) || _write_fragment_cache(key, options, &block)
+  end
+
+  def _read_fragment_cache(key, options = nil)
+    @context.controller.instrument_fragment_cache :read_fragment, key do
+      ::Rails.cache.read(key, options)
+    end
+  end
+
+  def _write_fragment_cache(key, options = nil)
+    @context.controller.instrument_fragment_cache :write_fragment, key do
+      yield.tap do |value|
+        ::Rails.cache.write(key, value, options)
+      end
+    end
+  end
+
   def _cache_key(key, options)
-    key = _fragment_name_with_digest(key, options)
-    key = url_for(key).split('://', 2).last if ::Hash === key
+    name_options = options.slice(:skip_digest, :virtual_path)
+    key = _fragment_name_with_digest(key, name_options)
+
+    if @context.respond_to?(:combined_fragment_cache_key)
+      key = @context.combined_fragment_cache_key(key)
+    else
+      key = url_for(key).split('://', 2).last if ::Hash === key
+    end
+
     ::ActiveSupport::Cache.expand_cache_key(key, :jbuilder)
   end
 
@@ -136,7 +188,7 @@ class JbuilderTemplate < Jbuilder
       _scope{ _render_partial_with_options options.merge(collection: object) }
     else
       locals = ::Hash[options[:as], object]
-      _scope{ _render_partial options.merge(locals: locals) }
+      _scope{ _render_partial_with_options options.merge(locals: locals) }
     end
 
     set! name, value
@@ -170,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/key_formatter.rb

@@ -11,8 +11,8 @@ class Jbuilder
       args.each do |name|
         @format[name] = []
       end
-      options.each do |name, paramaters|
-        @format[name] = paramaters
+      options.each do |name, parameters|
+        @format[name] = parameters
       end
     end
 

data/lib/jbuilder/railtie.rb

@@ -3,17 +3,24 @@ require 'jbuilder/jbuilder_template'
 
 class Jbuilder
   class Railtie < ::Rails::Railtie
-    initializer :jbuilder do |app|
+    initializer :jbuilder do
       ActiveSupport.on_load :action_view do
         ActionView::Template.register_template_handler :jbuilder, JbuilderHandler
         require 'jbuilder/dependency_tracker'
       end
 
-      if app.config.respond_to?(:api_only) && app.config.api_only
+      if Rails::VERSION::MAJOR >= 5
+        module ::ActionController
+          module ApiRendering
+            include ActionView::Rendering
+          end
+        end
+
         ActiveSupport.on_load :action_controller do
-          include ActionView::Rendering
-          include ActionController::Helpers
-          include ActionController::ImplicitRender
+          if self == ActionController::API
+            include ActionController::Helpers
+            include ActionController::ImplicitRender
+          end
         end
       end
     end

data/test/jbuilder_dependency_tracker_test.rb

@@ -53,7 +53,7 @@ class JbuilderDependencyTrackerTest < ActiveSupport::TestCase
       assert_equal %w[path/to/partial], dependencies
     end
 
-    test 'detects partial in indirect collecton calls' do
+    test 'detects partial in indirect collection calls' do
       dependencies = track_dependencies <<-RUBY
         json.comments @post.comments, partial: 'comments/comment', as: :comment
       RUBY

data/test/jbuilder_generator_test.rb

@@ -14,19 +14,33 @@ class JbuilderGeneratorTest < Rails::Generators::TestCase
     %w(index show).each do |view|
       assert_file "app/views/posts/#{view}.json.jbuilder"
     end
+    assert_file "app/views/posts/_post.json.jbuilder"
   end
 
   test 'index content' do
     run_generator
 
     assert_file 'app/views/posts/index.json.jbuilder' do |content|
-      assert_match /json\.array!\(@posts\) do \|post\|/, content
-      assert_match /json\.extract! post, :id, :title, :body/, content
-      assert_match /json\.url post_url\(post, format: :json\)/, 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 /json\.extract! @post, :id, :title, :body, :created_at, :updated_at/, content
+      assert_match %r{json\.partial! "posts/post", post: @post}, content
+    end
+
+    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