jbuilder 2.10.0 → 2.14.1

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

@@ -1,19 +1,17 @@
 <% if namespaced? -%>
-require_dependency "<%= namespaced_file_path %>/application_controller"
+require_dependency "<%= namespaced_path %>/application_controller"
 
 <% end -%>
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApplicationController
-  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+  before_action :set_<%= singular_table_name %>, only: %i[ show edit update destroy ]
 
-  # GET <%= route_url %>
-  # GET <%= route_url %>.json
+  # GET <%= route_url %> or <%= route_url %>.json
   def index
     @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
   end
 
-  # GET <%= route_url %>/1
-  # GET <%= route_url %>/1.json
+  # GET <%= route_url %>/1 or <%= route_url %>/1.json
   def show
   end
 
@@ -26,42 +24,40 @@ class <%= controller_class_name %>Controller < ApplicationController
   def edit
   end
 
-  # POST <%= route_url %>
-  # POST <%= route_url %>.json
+  # POST <%= route_url %> or <%= route_url %>.json
   def create
     @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
 
     respond_to do |format|
       if @<%= orm_instance.save %>
-        format.html { redirect_to @<%= singular_table_name %>, notice: <%= "'#{human_name} was successfully created.'" %> }
+        format.html { redirect_to <%= redirect_resource_name %>, notice: <%= %("#{human_name} was successfully created.") %> }
         format.json { render :show, status: :created, location: <%= "@#{singular_table_name}" %> }
       else
-        format.html { render :new }
+        format.html { render :new, status: :unprocessable_entity }
         format.json { render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity }
       end
     end
   end
 
-  # PATCH/PUT <%= route_url %>/1
-  # PATCH/PUT <%= route_url %>/1.json
+  # PATCH/PUT <%= route_url %>/1 or <%= route_url %>/1.json
   def update
     respond_to do |format|
       if @<%= orm_instance.update("#{singular_table_name}_params") %>
-        format.html { redirect_to @<%= singular_table_name %>, notice: <%= "'#{human_name} was successfully updated.'" %> }
+        format.html { redirect_to <%= redirect_resource_name %>, notice: <%= %("#{human_name} was successfully updated.") %>, status: :see_other }
         format.json { render :show, status: :ok, location: <%= "@#{singular_table_name}" %> }
       else
-        format.html { render :edit }
+        format.html { render :edit, status: :unprocessable_entity }
         format.json { render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity }
       end
     end
   end
 
-  # DELETE <%= route_url %>/1
-  # DELETE <%= route_url %>/1.json
+  # DELETE <%= route_url %>/1 or <%= route_url %>/1.json
   def destroy
     @<%= orm_instance.destroy %>
+
     respond_to do |format|
-      format.html { redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %> }
+      format.html { redirect_to <%= index_helper %>_path, notice: <%= %("#{human_name} was successfully destroyed.") %>, status: :see_other }
       format.json { head :no_content }
     end
   end
@@ -69,13 +65,19 @@ class <%= controller_class_name %>Controller < ApplicationController
   private
     # Use callbacks to share common setup or constraints between actions.
     def set_<%= singular_table_name %>
+      <%- if Rails::VERSION::MAJOR >= 8 -%>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params.expect(:id)") %>
+      <%- else -%>
       @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+      <%- end -%>
     end
 
     # Only allow a list of trusted parameters through.
     def <%= "#{singular_table_name}_params" %>
       <%- if attributes_names.empty? -%>
       params.fetch(<%= ":#{singular_table_name}" %>, {})
+      <%- elsif Rails::VERSION::MAJOR >= 8 -%>
+      params.expect(<%= singular_table_name %>: [ <%= permitted_params %> ])
       <%- else -%>
       params.require(<%= ":#{singular_table_name}" %>).permit(<%= permitted_params %>)
       <%- end -%>

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

@@ -1 +1 @@
-json.array! @<%= plural_table_name %>, partial: "<%= plural_table_name %>/<%= singular_table_name %>", as: :<%= singular_table_name %>
+json.array! @<%= plural_table_name %>, partial: "<%= partial_path_name %>", as: :<%= singular_table_name %>

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

@@ -1,2 +1,16 @@
 json.extract! <%= singular_table_name %>, <%= full_attributes_list %>
 json.url <%= singular_table_name %>_url(<%= singular_table_name %>, format: :json)
+<%- virtual_attributes.each do |attribute| -%>
+<%- if attribute.type == :rich_text -%>
+json.<%= attribute.name %> <%= singular_table_name %>.<%= attribute.name %>.to_s
+<%- elsif attribute.type == :attachment -%>
+json.<%= attribute.name %> url_for(<%= singular_table_name %>.<%= attribute.name %>)
+<%- elsif attribute.type == :attachments -%>
+json.<%= attribute.name %> do
+  json.array!(<%= singular_table_name %>.<%= attribute.name %>) do |<%= attribute.singular_name %>|
+    json.id <%= attribute.singular_name %>.id
+    json.url url_for(<%= attribute.singular_name %>)
+  end
+end
+<%- end -%>
+<%- end -%>

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

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

data/lib/jbuilder/blank.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Jbuilder
   class Blank
     def ==(other)

data/lib/jbuilder/collection_renderer.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require 'action_view'
+require 'action_view/renderer/collection_renderer'
+
+class Jbuilder
+  class CollectionRenderer < ::ActionView::CollectionRenderer # :nodoc:
+    class ScopedIterator < ::SimpleDelegator # :nodoc:
+      include Enumerable
+
+      def initialize(obj, scope)
+        super(obj)
+        @scope = scope
+      end
+
+      def each_with_info
+        return enum_for(:each_with_info) unless block_given?
+
+        __getobj__.each_with_info do |object, info|
+          @scope.call { yield(object, info) }
+        end
+      end
+    end
+
+    private_constant :ScopedIterator
+
+    def initialize(lookup_context, options, &scope)
+      super(lookup_context, options)
+      @scope = scope
+    end
+
+    private
+
+      def build_rendered_template(content, template, layout = nil)
+        super(content || json.attributes!, template)
+      end
+
+      def build_rendered_collection(templates, _spacer)
+        json.merge!(templates.map(&:body))
+      end
+
+      def json
+        @options[:locals].fetch(:json)
+      end
+
+      def collection_with_template(view, template, layout, collection)
+        super(view, template, layout, ScopedIterator.new(collection, @scope))
+      end
+  end
+
+  class EnumerableCompat < ::SimpleDelegator
+    # Rails 6.1 requires this.
+    def size(*args, &block)
+      __getobj__.count(*args, &block)
+    end
+  end
+end

data/lib/jbuilder/errors.rb

@@ -1,4 +1,6 @@
-require 'jbuilder/jbuilder'
+# frozen_string_literal: true
+
+require 'jbuilder/version'
 
 class Jbuilder
   class NullError < ::NoMethodError

data/lib/jbuilder/jbuilder.rb

@@ -1,7 +1,3 @@
-Jbuilder = Class.new(begin
-  require 'active_support/proxy_object'
-  ActiveSupport::ProxyObject
-rescue LoadError
-  require 'active_support/basic_object'
-  ActiveSupport::BasicObject
-end)
+# frozen_string_literal: true
+
+require 'jbuilder/version'

data/lib/jbuilder/jbuilder_dependency_tracker.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+class Jbuilder::DependencyTracker
+  EXPLICIT_DEPENDENCY = /# Template Dependency: (\S+)/
+
+  # Matches:
+  #   json.partial! "messages/message"
+  #   json.partial!('messages/message')
+  #
+  DIRECT_RENDERS = /
+        \w+\.partial!     # json.partial!
+        \(?\s*            # optional parenthesis
+        (['"])([^'"]+)\1  # quoted value
+      /x
+
+  # Matches:
+  #   json.partial! partial: "comments/comment"
+  #   json.comments @post.comments, partial: "comments/comment", as: :comment
+  #   json.array! @posts, partial: "posts/post", as: :post
+  #   = render partial: "account"
+  #
+  INDIRECT_RENDERS = /
+        (?::partial\s*=>|partial:)  # partial: or :partial =>
+        \s*                         # optional whitespace
+        (['"])([^'"]+)\1            # quoted value
+      /x
+
+  def self.call(name, template, view_paths = nil)
+    new(name, template, view_paths).dependencies
+  end
+
+  def initialize(name, template, view_paths = nil)
+    @name, @template, @view_paths = name, template, view_paths
+  end
+
+  def dependencies
+    direct_dependencies + indirect_dependencies + explicit_dependencies
+  end
+
+  private
+
+  attr_reader :name, :template
+
+  def direct_dependencies
+    source.scan(DIRECT_RENDERS).map(&:second)
+  end
+
+  def indirect_dependencies
+    source.scan(INDIRECT_RENDERS).map(&:second)
+  end
+
+  def explicit_dependencies
+    dependencies = source.scan(EXPLICIT_DEPENDENCY).flatten.uniq
+
+    wildcards, explicits = dependencies.partition { |dependency| dependency.end_with?("/*") }
+
+    (explicits + resolve_directories(wildcards)).uniq
+  end
+
+  def resolve_directories(wildcard_dependencies)
+    return [] unless @view_paths
+    return [] if wildcard_dependencies.empty?
+
+    # Remove trailing "/*"
+    prefixes = wildcard_dependencies.map { |query| query[0..-3] }
+
+    @view_paths.flat_map(&:all_template_paths).uniq.filter_map { |path|
+      path.to_s if prefixes.include?(path.prefix)
+    }.sort
+  end
+
+  def source
+    template.source
+  end
+end

data/lib/jbuilder/jbuilder_template.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'jbuilder/jbuilder'
+require 'jbuilder/collection_renderer'
 require 'action_dispatch/http/mime_type'
 require 'active_support/cache'
 
@@ -9,17 +12,52 @@ class JbuilderTemplate < Jbuilder
 
   self.template_lookup_options = { handlers: [:jbuilder] }
 
-  def initialize(context, *args)
+  def initialize(context, options = nil)
     @context = context
     @cached_root = nil
-    super(*args)
+
+    options.nil? ? super() : super(**options)
   end
 
+  # Generates JSON using the template specified with the `:partial` option. For example, the code below will render
+  # the file `views/comments/_comments.json.jbuilder`, and set a local variable comments with all this message's
+  # comments, which can be used inside the partial.
+  #
+  # Example:
+  #
+  #   json.partial! 'comments/comments', comments: @message.comments
+  #
+  # There are multiple ways to generate a collection of elements as JSON, as ilustrated below:
+  #
+  # Example:
+  #
+  #   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
+  #
+  # Aside from that, the `:cached` options is available on Rails >= 6.0. This will cache the rendered results
+  # effectively using the multi fetch feature.
+  #
+  # Example:
+  #
+  #   json.array! @posts, partial: "posts/post", as: :post, cached: true
+  #
+  #   json.comments @post.comments, partial: "comments/comment", as: :comment, cached: true
+  #
   def partial!(*args)
     if args.one? && _is_active_model?(args.first)
       _render_active_model_partial args.first
     else
-      _render_explicit_partial(*args)
+      options = args.extract_options!.dup
+      options[:partial] = args.first if args.present?
+      _render_partial_with_options options
     end
   end
 
@@ -56,7 +94,7 @@ class JbuilderTemplate < Jbuilder
   #   # 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?
+      ::Kernel.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
@@ -85,7 +123,9 @@ class JbuilderTemplate < Jbuilder
     options = args.first
 
     if args.one? && _partial_options?(options)
-      partial! options.merge(collection: collection)
+      options = options.dup
+      options[:collection] = collection
+      _render_partial_with_options options
     else
       super
     end
@@ -95,7 +135,7 @@ class JbuilderTemplate < Jbuilder
     options = args.first
 
     if args.one? && _partial_options?(options)
-      _set_inline_partial name, object, options
+      _set_inline_partial name, object, options.dup
     else
       super
     end
@@ -103,20 +143,35 @@ class JbuilderTemplate < Jbuilder
 
   private
 
+  alias_method :method_missing, :set!
+
   def _render_partial_with_options(options)
-    options.reverse_merge! locals: options.except(:partial, :as, :collection)
-    options.reverse_merge! ::JbuilderTemplate.template_lookup_options
+    options[:locals] ||= options.except(:partial, :as, :collection, :cached)
+    options[:handlers] ||= ::JbuilderTemplate.template_lookup_options[:handlers]
     as = options[:as]
 
     if as && options.key?(:collection)
-      as = as.to_sym
-      collection = options.delete(:collection)
-      locals = options.delete(:locals)
-      array! collection do |member|
-        member_locals = locals.clone
-        member_locals.merge! collection: collection
-        member_locals.merge! as => member
-        _render_partial options.merge(locals: member_locals)
+      collection = options.delete(:collection) || []
+      partial = options.delete(:partial)
+      options[:locals][:json] = self
+      collection = EnumerableCompat.new(collection) if collection.respond_to?(:count) && !collection.respond_to?(:size)
+
+      if options.has_key?(:layout)
+        ::Kernel.raise ::NotImplementedError, "The `:layout' option is not supported in collection rendering."
+      end
+
+      if options.has_key?(:spacer_template)
+        ::Kernel.raise ::NotImplementedError, "The `:spacer_template' option is not supported in collection rendering."
+      end
+
+      if collection.present?
+        results = CollectionRenderer
+          .new(@context.lookup_context, options) { |&block| _scope(&block) }
+          .render_collection_with_partial(collection, partial, @context, nil)
+
+        array! if results.respond_to?(:body) && results.body.nil?
+      else
+        array!
       end
     else
       _render_partial options
@@ -124,7 +179,7 @@ class JbuilderTemplate < Jbuilder
   end
 
   def _render_partial(options)
-    options[:locals].merge! json: self
+    options[:locals][:json] = self
     @context.render options
   end
 
@@ -162,12 +217,7 @@ class JbuilderTemplate < Jbuilder
 
   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
-      # should be used instead.
-      @context.cache_fragment_name(key, options)
-    elsif @context.respond_to?(:fragment_name_with_digest)
-      # Backwards compatibility for period of time when fragment_name_with_digest was made public.
-      @context.fragment_name_with_digest(key)
+      @context.cache_fragment_name(key, **options)
     else
       key
     end
@@ -185,34 +235,18 @@ class JbuilderTemplate < Jbuilder
     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_with_options 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
+      _scope do
+        options[:collection] = object
+        _render_partial_with_options options
+      end
     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 }
+      _scope do
+        options[:locals] = { options[:as] => object }
+        _render_partial_with_options options
       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
+    _set_value name, value
   end
 
   def _render_active_model_partial(object)
@@ -227,7 +261,7 @@ class JbuilderHandler
   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); #{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

@@ -1,32 +1,30 @@
+# frozen_string_literal: true
+
 require 'jbuilder/jbuilder'
-require 'active_support/core_ext/array'
 
 class Jbuilder
   class KeyFormatter
-    def initialize(*args)
-      @format = {}
-      @cache = {}
-
-      options = args.extract_options!
-      args.each do |name|
-        @format[name] = []
-      end
-      options.each do |name, parameters|
-        @format[name] = parameters
-      end
-    end
-
-    def initialize_copy(original)
+    def initialize(*formats, **formats_with_options)
+      @mutex = Mutex.new
+      @formats = formats
+      @formats_with_options = formats_with_options
       @cache = {}
     end
 
     def format(key)
-      @cache[key] ||= @format.inject(key.to_s) do |result, args|
-        func, args = args
-        if ::Proc === func
-          func.call result, *args
-        else
-          result.send func, *args
+      @mutex.synchronize do
+        @cache[key] ||= begin
+          value = key.is_a?(Symbol) ? key.name : key.to_s
+
+          @formats.each do |func|
+            value = func.is_a?(Proc) ? func.call(value) : value.send(func)
+          end
+
+          @formats_with_options.each do |func, params|
+            value = func.is_a?(Proc) ? func.call(value, *params) : value.send(func, *params)
+          end
+
+          value
         end
       end
     end

data/lib/jbuilder/railtie.rb

@@ -1,4 +1,6 @@
-require 'rails/railtie'
+# frozen_string_literal: true
+
+require 'rails'
 require 'jbuilder/jbuilder_template'
 
 class Jbuilder
@@ -6,31 +8,27 @@ class Jbuilder
     initializer :jbuilder do
       ActiveSupport.on_load :action_view do
         ActionView::Template.register_template_handler :jbuilder, JbuilderHandler
-        require 'jbuilder/dependency_tracker'
+        require 'jbuilder/jbuilder_dependency_tracker'
       end
 
-      if Rails::VERSION::MAJOR >= 5
-        module ::ActionController
-          module ApiRendering
-            include ActionView::Rendering
-          end
+      module ::ActionController
+        module ApiRendering
+          include ActionView::Rendering
         end
+      end
 
-        ActiveSupport.on_load :action_controller do
-          if self == ActionController::API
-            include ActionController::Helpers
-            include ActionController::ImplicitRender
-          end
-        end
+      ActiveSupport.on_load :action_controller_api do
+        include ActionController::Helpers
+        include ActionController::ImplicitRender
+        helper_method :combined_fragment_cache_key
+        helper_method :view_cache_dependencies
       end
     end
 
-    if Rails::VERSION::MAJOR >= 4
-      generators do |app|
-        Rails::Generators.configure! app.config.generators
-        Rails::Generators.hidden_namespaces.uniq!
-        require 'generators/rails/scaffold_controller_generator'
-      end
+    generators do |app|
+      Rails::Generators.configure! app.config.generators
+      Rails::Generators.hidden_namespaces.uniq!
+      require 'generators/rails/scaffold_controller_generator'
     end
   end
 end

data/lib/jbuilder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Jbuilder < BasicObject
+  VERSION = "2.14.1"
+end