actionview 7.1.5.2 → 8.1.2.1

data/lib/action_view/structured_event_subscriber.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "active_support/structured_event_subscriber"
+
+module ActionView
+  class StructuredEventSubscriber < ActiveSupport::StructuredEventSubscriber # :nodoc:
+    VIEWS_PATTERN = /^app\/views\//
+
+    def initialize
+      @root = nil
+      super
+    end
+
+    def render_template(event)
+      emit_debug_event("action_view.render_template",
+        identifier: from_rails_root(event.payload[:identifier]),
+        layout: from_rails_root(event.payload[:layout]),
+        duration_ms: event.duration.round(2),
+        gc_ms: event.gc_time.round(2),
+      )
+    end
+    debug_only :render_template
+
+    def render_partial(event)
+      emit_debug_event("action_view.render_partial",
+        identifier: from_rails_root(event.payload[:identifier]),
+        layout: from_rails_root(event.payload[:layout]),
+        duration_ms: event.duration.round(2),
+        gc_ms: event.gc_time.round(2),
+        cache_hit: event.payload[:cache_hit],
+      )
+    end
+    debug_only :render_partial
+
+    def render_layout(event)
+      emit_event("action_view.render_layout",
+        identifier: from_rails_root(event.payload[:identifier]),
+        duration_ms: event.duration.round(2),
+        gc_ms: event.gc_time.round(2),
+      )
+    end
+    debug_only :render_layout
+
+    def render_collection(event)
+      emit_debug_event("action_view.render_collection",
+        identifier: from_rails_root(event.payload[:identifier] || "templates"),
+        layout: from_rails_root(event.payload[:layout]),
+        duration_ms: event.duration.round(2),
+        gc_ms: event.gc_time.round(2),
+        cache_hits: event.payload[:cache_hits],
+        count: event.payload[:count],
+      )
+    end
+    debug_only :render_collection
+
+    module Utils # :nodoc:
+      private
+        def from_rails_root(string)
+          return unless string
+
+          string = string.sub("#{rails_root}/", "")
+          string.sub!(VIEWS_PATTERN, "")
+          string
+        end
+
+        def rails_root # :doc:
+          @root ||= Rails.try(:root)
+        end
+    end
+
+    include Utils
+
+    class Start # :nodoc:
+      include Utils
+
+      def start(name, id, payload)
+        ActiveSupport.event_reporter.debug("action_view.render_start",
+          is_layout: name == "render_layout.action_view",
+          identifier: from_rails_root(payload[:identifier]),
+          layout: from_rails_root(payload[:layout]),
+        )
+      end
+
+      def finish(name, id, payload)
+      end
+    end
+
+    def self.attach_to(*)
+      ActiveSupport::Notifications.subscribe("render_template.action_view", Start.new)
+      ActiveSupport::Notifications.subscribe("render_layout.action_view", Start.new)
+
+      super
+    end
+  end
+end
+
+ActionView::StructuredEventSubscriber.attach_to :action_view

data/lib/action_view/template/error.rb

@@ -27,6 +27,17 @@ module ActionView
     end
   end
 
+  class StrictLocalsError < ArgumentError # :nodoc:
+    def initialize(argument_error, template)
+      message = argument_error.message.
+                  gsub("unknown keyword:", "unknown local:").
+                  gsub("missing keyword:", "missing local:").
+                  gsub("no keywords accepted", "no locals accepted").
+                  concat(" for #{template.short_identifier}")
+      super(message)
+    end
+  end
+
   class MissingTemplate < ActionViewError # :nodoc:
     attr_reader :path, :paths, :prefixes, :partial
 
@@ -249,9 +260,13 @@ module ActionView
     end
 
     def message
-      <<~MESSAGE
-        Encountered a syntax error while rendering template: check #{@offending_code_string}
-      MESSAGE
+      if template.is_a?(Template::Inline)
+        <<~MESSAGE
+          Encountered a syntax error while rendering template: check #{@offending_code_string}
+        MESSAGE
+      else
+        "Encountered a syntax error while rendering template located at: #{template.short_identifier}"
+      end
     end
 
     def annotated_source_code

data/lib/action_view/template/handlers/erb/erubi.rb

@@ -18,7 +18,7 @@ module ActionView
             properties[:preamble]   ||= ""
             properties[:postamble]  ||= "#{properties[:bufvar]}"
 
-            # Tell Eruby that whether template will be compiled with `frozen_string_literal: true`
+            # Tell Erubi whether the template will be compiled with `frozen_string_literal: true`
             properties[:freeze_template_literals] = !Template.frozen_string_literal
 
             properties[:escapefunc] = ""

data/lib/action_view/template/handlers/erb.rb

@@ -40,18 +40,22 @@ module ActionView
 
         # Translate an error location returned by ErrorHighlight to the correct
         # source location inside the template.
-        def translate_location(spot, backtrace_location, source)
-          # Tokenize the source line
-          tokens = ::ERB::Util.tokenize(source.lines[backtrace_location.lineno - 1])
-          new_first_column = find_offset(spot[:snippet], tokens, spot[:first_column])
-          lineno_delta = spot[:first_lineno] - backtrace_location.lineno
+        def translate_location(spot, _backtrace_location, source)
+          compiled = spot[:script_lines]
+          highlight = compiled[spot[:first_lineno] - 1]&.byteslice((spot[:first_column] - 1)...spot[:last_column])
+          return nil if highlight.blank?
+
+          source_lines = source.lines
+          lineno_delta = find_lineno_offset(compiled, source_lines, highlight, spot[:first_lineno])
+
+          tokens = ::ERB::Util.tokenize(source_lines[spot[:first_lineno] - lineno_delta - 1])
+          column_delta = find_offset(spot[:snippet], tokens, spot[:first_column])
+
           spot[:first_lineno] -= lineno_delta
           spot[:last_lineno] -= lineno_delta
-
-          column_delta = spot[:first_column] - new_first_column
           spot[:first_column] -= column_delta
           spot[:last_column] -= column_delta
-          spot[:script_lines] = source.lines
+          spot[:script_lines] = source_lines
 
           spot
         rescue NotImplementedError, LocationParsingError
@@ -82,7 +86,7 @@ module ActionView
           }
 
           if ActionView::Base.annotate_rendered_view_with_filenames && template.format == :html
-            options[:preamble] = "@output_buffer.safe_append='<!-- BEGIN #{template.short_identifier} -->';"
+            options[:preamble] = "@output_buffer.safe_append='<!-- BEGIN #{template.short_identifier}\n-->';"
             options[:postamble] = "@output_buffer.safe_append='<!-- END #{template.short_identifier} -->';@output_buffer"
           end
 
@@ -105,51 +109,80 @@ module ActionView
           raise WrongEncodingError.new(string, string.encoding)
         end
 
+        # Return the offset between the error lineno and the source lineno.
+        # Searches in reverse from the backtrace lineno so we have a better
+        # chance of finding the correct line
+        #
+        # The compiled template is likely to be longer than the source.
+        # Use the difference between the compiled and source sizes to
+        # determine the earliest line that could contain the highlight.
+        def find_lineno_offset(compiled, source_lines, highlight, error_lineno)
+          first_index = error_lineno - 1 - compiled.size + source_lines.size
+          first_index = 0 if first_index < 0
+
+          last_index = error_lineno - 1
+          last_index = source_lines.size - 1 if last_index >= source_lines.size
+
+          last_index.downto(first_index) do |line_index|
+            next unless source_lines[line_index].include?(highlight)
+            return error_lineno - 1 - line_index
+          end
+
+          raise LocationParsingError, "Couldn't find code snippet"
+        end
+
+        # Find which token in the source template spans the byte range that
+        # contains the error_column, then return the offset compared to the
+        # original source template.
+        #
+        # Iterate consecutive pairs of CODE or TEXT tokens, requiring
+        # a match of the first token before matching either token.
+        #
+        # For example, if we want to find tokens A, B, C, we do the following:
+        # 1. Find a match for A: test error_column or advance scanner.
+        # 2. Find a match for B or A:
+        #   a. If B: start over with next token set (B, C).
+        #   b. If A: test error_column or advance scanner.
+        #   c. Otherwise: Advance 1 byte
+        #
+        # Prioritize matching the next token over the current token once
+        # a match for the current token has been found. This is to prevent
+        # the current token from looping past the next token if they both
+        # match (i.e. if the current token is a single space character).
         def find_offset(compiled, source_tokens, error_column)
           compiled = StringScanner.new(compiled)
+          offset_source_tokens(source_tokens).each_cons(2) do |(name, str, offset), (_, next_str, _)|
+            matched_str = false
 
-          passed_tokens = []
+            until compiled.eos?
+              if matched_str && next_str && compiled.match?(next_str)
+                break
+              elsif compiled.match?(str)
+                matched_str = true
 
-          while tok = source_tokens.shift
-            tok_name, str = *tok
-            case tok_name
-            when :TEXT
-              loop do
-                break if compiled.match?(str)
-                compiled.getch
-              end
-              raise LocationParsingError unless compiled.scan(str)
-            when :CODE
-              if compiled.pos > error_column
-                raise LocationParsingError, "We went too far"
-              end
+                if name == :CODE && compiled.pos <= error_column && compiled.pos + str.bytesize >= error_column
+                  return compiled.pos - offset
+                end
 
-              if compiled.pos + str.bytesize >= error_column
-                offset = error_column - compiled.pos
-                return passed_tokens.map(&:last).join.bytesize + offset
+                compiled.pos += str.bytesize
               else
-                unless compiled.scan(str)
-                  raise LocationParsingError, "Couldn't find code snippet"
-                end
-              end
-            when :OPEN
-              next_tok = source_tokens.first.last
-              loop do
-                break if compiled.match?(next_tok)
-                compiled.getch
+                compiled.pos += 1
               end
-            when :CLOSE
-              next_tok = source_tokens.first.last
-              loop do
-                break if compiled.match?(next_tok)
-                compiled.getch
-              end
-            else
-              raise LocationParsingError, "Not implemented: #{tok.first}"
             end
+          end
+
+          raise LocationParsingError, "Couldn't find code snippet"
+        end
 
-            passed_tokens << tok
+        def offset_source_tokens(source_tokens)
+          source_offset = 0
+          with_offset = source_tokens.filter_map do |name, str|
+            result = [:CODE, str, source_offset] if name == :CODE || name == :PLAIN
+            result = [:TEXT, str, source_offset] if name == :TEXT
+            source_offset += str.bytesize
+            result
           end
+          with_offset << [:EOS, nil, source_offset]
         end
       end
     end

data/lib/action_view/template/raw_file.rb

@@ -20,6 +20,10 @@ module ActionView # :nodoc:
       def render(*args)
         ::File.read(@filename)
       end
+
+      def supports_streaming?
+        false
+      end
     end
   end
 end

data/lib/action_view/template/renderable.rb

@@ -14,10 +14,16 @@ module ActionView
 
       def render(context, *args)
         @renderable.render_in(context)
+      rescue NoMethodError
+        if !@renderable.respond_to?(:render_in)
+          raise ArgumentError, "'#{@renderable.inspect}' is not a renderable object. It must implement #render_in."
+        else
+          raise
+        end
       end
 
       def format
-        @renderable.format
+        @renderable.try(:format)
       end
     end
   end

data/lib/action_view/template/resolver.rb

@@ -4,14 +4,11 @@ require "pathname"
 require "active_support/core_ext/class"
 require "active_support/core_ext/module/attribute_accessors"
 require "action_view/template"
-require "thread"
 require "concurrent/map"
 
 module ActionView
   # = Action View Resolver
   class Resolver
-    include ActiveSupport::Deprecation::DeprecatedConstantAccessor
-
     class PathParser # :nodoc:
       ParsedPath = Struct.new(:path, :details)
 

data/lib/action_view/template.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "thread"
 require "delegate"
 
 module ActionView
@@ -8,7 +7,7 @@ module ActionView
   class Template
     extend ActiveSupport::Autoload
 
-    STRICT_LOCALS_REGEX = /\#\s+locals:\s+\((.*)\)/
+    STRICT_LOCALS_REGEX = /\#\s+locals:\s+\((.*?)\)(?=\s*-?%>|\s*$)/m
 
     # === Encodings in ActionView::Template
     #
@@ -148,6 +147,20 @@ module ActionView
     #     <p><%= alert %></p>
     #   <% end %>
     #
+    # By default, templates will accept any <tt>locals</tt> as keyword arguments
+    # and make them available to <tt>local_assigns</tt>. To restrict what
+    # <tt>local_assigns</tt> a template will accept, add a <tt>locals:</tt> magic comment:
+    #
+    #   <%# locals: (headline:, alerts: []) %>
+    #
+    #   <h1><%= headline %></h1>
+    #
+    #   <% alerts.each do |alert| %>
+    #     <p><%= alert %></p>
+    #   <% end %>
+    #
+    # Read more about strict locals in {Action View Overview}[https://guides.rubyonrails.org/action_view_overview.html#strict-locals]
+    # in the guides.
 
     eager_autoload do
       autoload :Error
@@ -216,11 +229,21 @@ module ActionView
     end
 
     def spot(location) # :nodoc:
-      ast = RubyVM::AbstractSyntaxTree.parse(compiled_source, keep_script_lines: true)
       node_id = RubyVM::AbstractSyntaxTree.node_id_for_backtrace_location(location)
-      node = find_node_by_id(ast, node_id)
+      found =
+        if RubyVM::InstructionSequence.compile("").to_a[4][:parser] == :prism
+          require "prism"
 
-      ErrorHighlight.spot(node)
+          if Prism::VERSION >= "1.0.0"
+            result = Prism.parse(compiled_source).value
+            result.breadth_first_search { |node| node.node_id == node_id }
+          end
+        else
+          node = RubyVM::AbstractSyntaxTree.parse(compiled_source, keep_script_lines: true)
+          find_node_by_id(node, node_id)
+        end
+
+      ErrorHighlight.spot(found) if found
     end
 
     # Translate an error location returned by ErrorHighlight to the correct
@@ -333,7 +356,7 @@ module ActionView
 
     # This method is responsible for marking a template as having strict locals
     # which means the template can only accept the locals defined in a magic
-    # comment. For example, if your template acceps the locals +title+ and
+    # comment. For example, if your template accepts the locals +title+ and
     # +comment_count+, add the following to your template file:
     #
     #   <%# locals: (title: "Default title", comment_count: 0) %>
@@ -343,7 +366,7 @@ module ActionView
     def strict_locals!
       if @strict_locals == NONE
         self.source.sub!(STRICT_LOCALS_REGEX, "")
-        @strict_locals = $1
+        @strict_locals = $1&.rstrip
 
         return if @strict_locals.nil? # Magic comment not found
 
@@ -425,9 +448,9 @@ module ActionView
         method_arguments =
           if set_strict_locals
             if set_strict_locals.include?("&")
-              "output_buffer, #{set_strict_locals}"
+              "local_assigns, output_buffer, #{set_strict_locals}"
             else
-              "output_buffer, #{set_strict_locals}, &_"
+              "local_assigns, output_buffer, #{set_strict_locals}, &_"
             end
           else
             "local_assigns, output_buffer, &_"
@@ -486,11 +509,12 @@ module ActionView
 
         return unless strict_locals?
 
-        parameters = mod.instance_method(method_name).parameters - [[:req, :output_buffer]]
+        parameters = mod.instance_method(method_name).parameters
+        parameters -= [[:req, :local_assigns], [:req, :output_buffer]]
+
         # Check compiled method parameters to ensure that only kwargs
         # were provided as strict locals, preventing `locals: (foo, *foo)` etc
         # and allowing `locals: (foo:)`.
-
         non_kwarg_parameters = parameters.select do |parameter|
           ![:keyreq, :key, :keyrest, :nokey].include?(parameter[0])
         end
@@ -531,12 +555,15 @@ module ActionView
         end
       end
 
+      RUBY_RESERVED_KEYWORDS = ::ActiveSupport::Delegation::RUBY_RESERVED_KEYWORDS
+      private_constant :RUBY_RESERVED_KEYWORDS
+
       def locals_code
         return "" if strict_locals?
 
         # Only locals with valid variable names get set directly. Others will
         # still be available in local_assigns.
-        locals = @locals - Module::RUBY_RESERVED_KEYWORDS
+        locals = @locals - RUBY_RESERVED_KEYWORDS
 
         locals = locals.grep(/\A(?![A-Z0-9])(?:[[:alnum:]_]|[^\0-\177])+\z/)
 

data/lib/action_view/test_case.rb

@@ -60,7 +60,56 @@ module ActionView
       include ActiveSupport::Testing::ConstantLookup
 
       delegate :lookup_context, to: :controller
-      attr_accessor :controller, :request, :output_buffer, :rendered
+      attr_accessor :controller, :request, :output_buffer
+
+      # Returns the content rendered by the last +render+ call.
+      #
+      # The returned object behaves like a string but also exposes a number of methods
+      # that allows you to parse the content string in formats registered using
+      # <tt>.register_parser</tt>.
+      #
+      # By default includes the following parsers:
+      #
+      # +.html+
+      #
+      # Parse the <tt>rendered</tt> content String into HTML. By default, this means
+      # a <tt>Nokogiri::XML::Node</tt>.
+      #
+      #   test "renders HTML" do
+      #     article = Article.create!(title: "Hello, world")
+      #
+      #     render partial: "articles/article", locals: { article: article }
+      #
+      #     assert_pattern { rendered.html.at("main h1") => { content: "Hello, world" } }
+      #   end
+      #
+      # To parse the rendered content into a <tt>Capybara::Simple::Node</tt>,
+      # re-register an <tt>:html</tt> parser with a call to
+      # <tt>Capybara.string</tt>:
+      #
+      #   register_parser :html, -> rendered { Capybara.string(rendered) }
+      #
+      #   test "renders HTML" do
+      #     article = Article.create!(title: "Hello, world")
+      #
+      #     render partial: article
+      #
+      #     rendered.html.assert_css "h1", text: "Hello, world"
+      #   end
+      #
+      # +.json+
+      #
+      # Parse the <tt>rendered</tt> content String into JSON. By default, this means
+      # a <tt>ActiveSupport::HashWithIndifferentAccess</tt>.
+      #
+      #   test "renders JSON" do
+      #     article = Article.create!(title: "Hello, world")
+      #
+      #     render formats: :json, partial: "articles/article", locals: { article: article }
+      #
+      #     assert_pattern { rendered.json => { title: "Hello, world" } }
+      #   end
+      attr_accessor :rendered
 
       module ClassMethods
         def inherited(descendant) # :nodoc:
@@ -171,10 +220,9 @@ module ActionView
           # Almost a duplicate from ActionController::Helpers
           methods.flatten.each do |method|
             _helpers_for_modification.module_eval <<~end_eval, __FILE__, __LINE__ + 1
-              def #{method}(*args, &block)                    # def current_user(*args, &block)
-                _test_case.send(:'#{method}', *args, &block)  #   _test_case.send(:'current_user', *args, &block)
-              end                                             # end
-              ruby2_keywords(:'#{method}')
+              def #{method}(...)                    # def current_user(...)
+                _test_case.send(:'#{method}', ...)  #   _test_case.send(:'current_user', ...)
+              end                                   # end
             end_eval
           end
         end
@@ -202,7 +250,7 @@ module ActionView
 
         setup :setup_with_controller
 
-        register_parser :html, -> rendered { Rails::Dom::Testing.html_document.parse(rendered).root }
+        register_parser :html, -> rendered { Rails::Dom::Testing.html_document_fragment.parse(rendered) }
         register_parser :json, -> rendered { JSON.parse(rendered, object_class: ActiveSupport::HashWithIndifferentAccess) }
 
         ActiveSupport.run_load_hooks(:action_view_test_case, self)
@@ -244,57 +292,6 @@ module ActionView
         @_rendered_views ||= RenderedViewsCollection.new
       end
 
-      ##
-      # :method: rendered
-      #
-      # Returns the content rendered by the last +render+ call.
-      #
-      # The returned object behaves like a string but also exposes a number of methods
-      # that allows you to parse the content string in formats registered using
-      # <tt>.register_parser</tt>.
-      #
-      # By default includes the following parsers:
-      #
-      # +.html+
-      #
-      # Parse the <tt>rendered</tt> content String into HTML. By default, this means
-      # a <tt>Nokogiri::XML::Node</tt>.
-      #
-      #   test "renders HTML" do
-      #     article = Article.create!(title: "Hello, world")
-      #
-      #     render partial: "articles/article", locals: { article: article }
-      #
-      #     assert_pattern { rendered.html.at("main h1") => { content: "Hello, world" } }
-      #   end
-      #
-      # To parse the rendered content into a <tt>Capybara::Simple::Node</tt>,
-      # re-register an <tt>:html</tt> parser with a call to
-      # <tt>Capybara.string</tt>:
-      #
-      #   register_parser :html, -> rendered { Capybara.string(rendered) }
-      #
-      #   test "renders HTML" do
-      #     article = Article.create!(title: "Hello, world")
-      #
-      #     render partial: article
-      #
-      #     rendered.html.assert_css "h1", text: "Hello, world"
-      #   end
-      #
-      # +.json+
-      #
-      # Parse the <tt>rendered</tt> content String into JSON. By default, this means
-      # a <tt>ActiveSupport::HashWithIndifferentAccess</tt>.
-      #
-      #   test "renders JSON" do
-      #     article = Article.create!(title: "Hello, world")
-      #
-      #     render formats: :json, partial: "articles/article", locals: { article: article }
-      #
-      #     assert_pattern { rendered.json => { title: "Hello, world" } }
-      #   end
-
       def _routes
         @controller._routes if @controller.respond_to?(:_routes)
       end
@@ -302,7 +299,6 @@ module ActionView
       class RenderedViewContent < String # :nodoc:
       end
 
-      # Need to experiment if this priority is the best one: rendered => output_buffer
       class RenderedViewsCollection
         def initialize
           @rendered_views ||= Hash.new { |hash, key| hash[key] = [] }
@@ -416,7 +412,7 @@ module ActionView
         end]
       end
 
-      def method_missing(selector, *args)
+      def method_missing(selector, ...)
         begin
           routes = @controller.respond_to?(:_routes) && @controller._routes
         rescue
@@ -426,16 +422,15 @@ module ActionView
         if routes &&
            (routes.named_routes.route_defined?(selector) ||
              routes.mounted_helpers.method_defined?(selector))
-          @controller.__send__(selector, *args)
+          @controller.__send__(selector, ...)
         else
           super
         end
       end
-      ruby2_keywords(:method_missing)
 
       def respond_to_missing?(name, include_private = false)
         begin
-          routes = defined?(@controller) && @controller.respond_to?(:_routes) && @controller._routes
+          routes = @controller.respond_to?(:_routes) && @controller._routes
         rescue
           # Don't call routes, if there is an error on _routes call
         end

data/lib/action_view.rb

@@ -81,6 +81,7 @@ module ActionView
       autoload :MissingTemplate
       autoload :ActionViewError
       autoload :EncodingError
+      autoload :StrictLocalsError
       autoload :TemplateError
       autoload :SyntaxErrorInTemplate
       autoload :WrongEncodingError
@@ -90,6 +91,9 @@ module ActionView
   autoload :CacheExpiry
   autoload :TestCase
 
+  singleton_class.attr_accessor :render_tracker
+  self.render_tracker = :regex
+
   def self.eager_load!
     super
     ActionView::Helpers.eager_load!