jbuilder 2.2.16 → 2.6.4

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/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,37 +11,15 @@ class JbuilderTemplate < Jbuilder
 
   def initialize(context, *args)
     @context = context
+    @cached_root = nil
     super(*args)
   end
 
-  def partial!(name_or_options, locals = {})
-    case name_or_options
-    when ::Hash
-      # partial! partial: 'name', foo: 'bar'
-      options = name_or_options
-    else
-      # partial! 'name', locals: {foo: 'bar'}
-      if locals.one? && (locals.keys.first == :locals)
-        options = locals.merge(partial: name_or_options)
-      else
-        options = { partial: name_or_options, locals: locals }
-      end
-      # partial! 'name', foo: 'bar'
-      as = locals.delete(:as)
-      options[:as] = as if as.present?
-      options[:collection] = locals[:collection] if locals.key?(:collection)
-    end
-
-    _render_partial_with_options options
-  end
-
-  def array!(collection = [], *attributes)
-    options = attributes.extract_options!
-
-    if options.key?(:partial)
-      partial! options[:partial], options.merge(collection: collection)
+  def partial!(*args)
+    if args.one? && _is_active_model?(args.first)
+      _render_active_model_partial args.first
     else
-      super
+      _render_explicit_partial(*args)
     end
   end
 
@@ -55,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
 
@@ -65,7 +43,28 @@ class JbuilderTemplate < Jbuilder
     end
   end
 
-  # Conditionally catches the json depending in the condition given as first parameter. Has the same
+  # 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.
   #
@@ -78,7 +77,31 @@ class JbuilderTemplate < Jbuilder
     condition ? cache!(*args, &::Proc.new) : yield
   end
 
-  protected
+  def target!
+    @cached_root || super
+  end
+
+  def array!(collection = [], *args)
+    options = args.first
+
+    if args.one? && _partial_options?(options)
+      partial! options.merge(collection: collection)
+    else
+      super
+    end
+  end
+
+  def set!(name, object = BLANK, *args)
+    options = args.first
+
+    if args.one? && _partial_options?(options)
+      _set_inline_partial name, object, options
+    else
+      super
+    end
+  end
+
+  private
 
   def _render_partial_with_options(options)
     options.reverse_merge! locals: {}
@@ -105,14 +128,38 @@ 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?(:fragment_cache_key)
+      key = @context.fragment_cache_key(key)
+    else
+      key = url_for(key).split('://', 2).last if ::Hash === key
+    end
+
     ::ActiveSupport::Cache.expand_cache_key(key, :jbuilder)
   end
 
-  private
-
   def _fragment_name_with_digest(key, options)
     if @context.respond_to?(:cache_fragment_name)
       # Current compatibility, fragment_name_with_digest is private again and cache_fragment_name
@@ -126,16 +173,56 @@ class JbuilderTemplate < Jbuilder
     end
   end
 
-  def _mapable_arguments?(value, *args)
-    return true if super
-    options = args.last
-    ::Hash === options && options.key?(:as)
+  def _partial_options?(options)
+    ::Hash === options && options.key?(:as) && options.key?(:partial)
+  end
+
+  def _is_active_model?(object)
+    object.class.respond_to?(:model_name) && object.respond_to?(:to_partial_path)
+  end
+
+  def _set_inline_partial(name, object, options)
+    value = if object.nil?
+      []
+    elsif _is_collection?(object)
+      _scope{ _render_partial_with_options options.merge(collection: object) }
+    else
+      locals = ::Hash[options[:as], object]
+      _scope{ _render_partial options.merge(locals: locals) }
+    end
+
+    set! name, value
+  end
+
+  def _render_explicit_partial(name_or_options, locals = {})
+    case name_or_options
+    when ::Hash
+      # partial! partial: 'name', foo: 'bar'
+      options = name_or_options
+    else
+      # partial! 'name', locals: {foo: 'bar'}
+      if locals.one? && (locals.keys.first == :locals)
+        options = locals.merge(partial: name_or_options)
+      else
+        options = { partial: name_or_options, locals: locals }
+      end
+      # partial! 'name', foo: 'bar'
+      as = locals.delete(:as)
+      options[:as] = as if as.present?
+      options[:collection] = locals[:collection] if locals.key?(:collection)
+    end
+
+    _render_partial_with_options options
+  end
+
+  def _render_active_model_partial(object)
+    @context.render object, json: self
   end
 end
 
 class JbuilderHandler
   cattr_accessor :default_format
-  self.default_format = Mime::JSON
+  self.default_format = Mime[:json]
 
   def self.call(template)
     # this juggling is required to keep line numbers right in the error

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,15 +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
+          if self == ActionController::API
+            include ActionController::Helpers
+            include ActionController::ImplicitRender
+          end
         end
       end
     end

data/lib/jbuilder.rb

@@ -3,6 +3,7 @@ require 'jbuilder/blank'
 require 'jbuilder/key_formatter'
 require 'jbuilder/errors'
 require 'multi_json'
+require 'ostruct'
 
 class Jbuilder
   @@key_formatter = nil
@@ -23,6 +24,7 @@ class Jbuilder
   end
 
   BLANK = Blank.new
+  NON_ENUMERABLES = [ ::Struct, ::OpenStruct ].to_set
 
   def set!(key, value = BLANK, *args)
     result = if ::Kernel.block_given?
@@ -46,7 +48,7 @@ class Jbuilder
         # { "age": 32 }
         value
       end
-    elsif _mapable_arguments?(value, *args)
+    elsif _is_collection?(value)
       # json.comments @post.comments, :content, :created_at
       # { "comments": [ { "content": "hello", "created_at": "..." }, { "content": "world", "created_at": "..." } ] }
       _scope{ array! value, *args }
@@ -59,8 +61,13 @@ class Jbuilder
     _set_value key, result
   end
 
-  alias_method :method_missing, :set!
-  private :method_missing
+  def method_missing(*args)
+    if ::Kernel.block_given?
+      set!(*args, &::Proc.new)
+    else
+      set!(*args)
+    end
+  end
 
   # Specifies formatting to be applied to the key. Passing in a name of a function
   # will cause that function to be called on the key.  So :upcase will upper case
@@ -263,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
 
@@ -301,13 +308,17 @@ class Jbuilder
     @attributes, @key_formatter = parent_attributes, parent_formatter
   end
 
-  def _mapable_arguments?(value, *args)
-    value.respond_to?(:map)
+  def _is_collection?(object)
+    _object_respond_to?(object, :map, :count) && NON_ENUMERABLES.none?{ |klass| klass === object }
   end
 
   def _blank?(value=@attributes)
     BLANK == value
   end
+
+  def _object_respond_to?(object, *methods)
+    methods.all?{ |m| object.respond_to?(m) }
+  end
 end
 
 require 'jbuilder/railtie' if defined?(Rails)

data/test/jbuilder_generator_test.rb

@@ -14,19 +14,25 @@ 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{json\.url post_url\(post, format: :json\)}, content
+    end
+    
+
   end
 end