actionview 6.0.0 → 6.1.0

data/lib/action_view/template/error.rb

@@ -81,19 +81,19 @@ module ActionView
         end
       end
 
-      def source_extract(indentation = 0, output = :console)
-        return unless num = line_number
+      def source_extract(indentation = 0)
+        return [] unless num = line_number
         num = num.to_i
 
-        source_code = @template.source.split("\n")
+        source_code = @template.encode!.split("\n")
 
         start_on_line = [ num - SOURCE_CODE_RADIUS - 1, 0 ].max
         end_on_line   = [ num + SOURCE_CODE_RADIUS - 1, source_code.length].min
 
         indent = end_on_line.to_s.size + indentation
-        return unless source_code = source_code[start_on_line..end_on_line]
+        return [] unless source_code = source_code[start_on_line..end_on_line]
 
-        formatted_code_for(source_code, start_on_line, indent, output)
+        formatted_code_for(source_code, start_on_line, indent)
       end
 
       def sub_template_of(template_path)
@@ -114,7 +114,6 @@ module ActionView
       end
 
       private
-
         def source_location
           if line_number
             "on line ##{line_number} of "
@@ -123,15 +122,11 @@ module ActionView
           end + file_name
         end
 
-        def formatted_code_for(source_code, line_counter, indent, output)
-          start_value = (output == :html) ? {} : []
-          source_code.inject(start_value) do |result, line|
+        def formatted_code_for(source_code, line_counter, indent)
+          indent_template = "%#{indent}s: %s"
+          source_code.map do |line|
             line_counter += 1
-            if output == :html
-              result.update(line_counter.to_s => "%#{indent}s %s\n" % ["", line])
-            else
-              result << "%#{indent}s: %s" % [line_counter, line]
-            end
+            indent_template % [line_counter, line]
           end
         end
     end

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

@@ -13,9 +13,11 @@ module ActionView
 
             # Dup properties so that we don't modify argument
             properties = Hash[properties]
-            properties[:preamble]   = ""
-            properties[:postamble]  = "@output_buffer.to_s"
-            properties[:bufvar]     = "@output_buffer"
+
+            properties[:bufvar]     ||= "@output_buffer"
+            properties[:preamble]   ||= ""
+            properties[:postamble]  ||= "#{properties[:bufvar]}.to_s"
+
             properties[:escapefunc] = ""
 
             super
@@ -37,7 +39,7 @@ module ActionView
             if text == "\n"
               @newline_pending += 1
             else
-              src << "@output_buffer.safe_append='"
+              src << bufvar << ".safe_append='"
               src << "\n" * @newline_pending if @newline_pending > 0
               src << text.gsub(/['\\]/, '\\\\\&')
               src << "'.freeze;"
@@ -52,9 +54,9 @@ module ActionView
             flush_newline_if_pending(src)
 
             if (indicator == "==") || @escape
-              src << "@output_buffer.safe_expr_append="
+              src << bufvar << ".safe_expr_append="
             else
-              src << "@output_buffer.append="
+              src << bufvar << ".append="
             end
 
             if BLOCK_EXPR.match?(code)
@@ -76,7 +78,7 @@ module ActionView
 
           def flush_newline_if_pending(src)
             if @newline_pending > 0
-              src << "@output_buffer.safe_append='#{"\n" * @newline_pending}'.freeze;"
+              src << bufvar << ".safe_append='#{"\n" * @newline_pending}'.freeze;"
               @newline_pending = 0
             end
           end

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

@@ -16,16 +16,6 @@ module ActionView
         # Do not escape templates of these mime types.
         class_attribute :escape_ignore_list, default: ["text/plain"]
 
-        [self, singleton_class].each do |base|
-          base.alias_method :escape_whitelist, :escape_ignore_list
-          base.alias_method :escape_whitelist=, :escape_ignore_list=
-
-          base.deprecate(
-            escape_whitelist: "use #escape_ignore_list instead",
-            :escape_whitelist= => "use #escape_ignore_list= instead"
-          )
-        end
-
         ENCODING_TAG = Regexp.new("\\A(<%#{ENCODING_FLAG}-?%>)[ \\t]*")
 
         def self.call(template, source)
@@ -45,7 +35,7 @@ module ActionView
           # wrong, we can still find an encoding tag
           # (<%# encoding %>) inside the String using a regular
           # expression
-          template_source = source.dup.force_encoding(Encoding::ASCII_8BIT)
+          template_source = source.b
 
           erb = template_source.gsub(ENCODING_TAG, "")
           encoding = $2
@@ -55,15 +45,20 @@ module ActionView
           # Always make sure we return a String in the default_internal
           erb.encode!
 
-          self.class.erb_implementation.new(
-            erb,
+          options = {
             escape: (self.class.escape_ignore_list.include? template.type),
             trim: (self.class.erb_trim_mode == "-")
-          ).src
+          }
+
+          if ActionView::Base.annotate_rendered_view_with_filenames && template.format == :html
+            options[:preamble] = "@output_buffer.safe_append='<!-- BEGIN #{template.short_identifier} -->';"
+            options[:postamble] = "@output_buffer.safe_append='<!-- END #{template.short_identifier} -->';@output_buffer.to_s"
+          end
+
+          self.class.erb_implementation.new(erb, options).src
         end
 
       private
-
         def valid_encoding(string, encoding)
           # If a magic encoding comment was found, tag the
           # String with this encoding. This is for a case

data/lib/action_view/template/handlers.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support/deprecation"
-
 module ActionView #:nodoc:
   # = Action View Template Handlers
   class Template #:nodoc:
@@ -26,35 +24,11 @@ module ActionView #:nodoc:
         @@template_extensions ||= @@template_handlers.keys
       end
 
-      class LegacyHandlerWrapper < SimpleDelegator # :nodoc:
-        def call(view, source)
-          __getobj__.call(ActionView::Template::LegacyTemplate.new(view, source))
-        end
-      end
-
       # Register an object that knows how to handle template files with the given
       # extensions. This can be used to implement new template types.
       # The handler must respond to +:call+, which will be passed the template
       # and should return the rendered template as a String.
       def register_template_handler(*extensions, handler)
-        params = if handler.is_a?(Proc)
-          handler.parameters
-        else
-          handler.method(:call).parameters
-        end
-
-        unless params.find_all { |type, _| type == :req || type == :opt }.length >= 2
-          ActiveSupport::Deprecation.warn <<~eowarn
-          Single arity template handlers are deprecated. Template handlers must
-          now accept two parameters, the view object and the source for the view object.
-          Change:
-            >> #{handler}.call(#{params.map(&:last).join(", ")})
-          To:
-            >> #{handler}.call(#{params.map(&:last).join(", ")}, source)
-          eowarn
-          handler = LegacyHandlerWrapper.new(handler)
-        end
-
         raise(ArgumentError, "Extension is required") if extensions.empty?
         extensions.each do |extension|
           @@template_handlers[extension.to_sym] = handler

data/lib/action_view/template/html.rb

@@ -1,19 +1,12 @@
 # frozen_string_literal: true
 
-require "active_support/deprecation"
-
 module ActionView #:nodoc:
   # = Action View HTML Template
   class Template #:nodoc:
     class HTML #:nodoc:
       attr_reader :type
 
-      def initialize(string, type = nil)
-        unless type
-          ActiveSupport::Deprecation.warn "ActionView::Template::HTML#initialize requires a type parameter"
-          type = :html
-        end
-
+      def initialize(string, type)
         @string = string.to_s
         @type   = type
       end
@@ -35,9 +28,6 @@ module ActionView #:nodoc:
       def format
         @type
       end
-
-      def formats; Array(format); end
-      deprecate :formats
     end
   end
 end

data/lib/action_view/template/raw_file.rb

@@ -20,9 +20,6 @@ module ActionView #:nodoc:
       def render(*args)
         ::File.read(@filename)
       end
-
-      def formats; Array(format); end
-      deprecate :formats
     end
   end
 end

data/lib/action_view/template/renderable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ActionView
+  # = Action View Renderable Template for objects that respond to #render_in
+  class Template
+    class Renderable # :nodoc:
+      def initialize(renderable)
+        @renderable = renderable
+      end
+
+      def identifier
+        @renderable.class.name
+      end
+
+      def render(context, *args)
+        @renderable.render_in(context)
+      end
+
+      def format
+        @renderable.format
+      end
+    end
+  end
+end

data/lib/action_view/template/resolver.rb

@@ -35,6 +35,41 @@ module ActionView
       alias :to_s :to_str
     end
 
+    class PathParser # :nodoc:
+      def build_path_regex
+        handlers = Template::Handlers.extensions.map { |x| Regexp.escape(x) }.join("|")
+        formats = Template::Types.symbols.map { |x| Regexp.escape(x) }.join("|")
+        locales = "[a-z]{2}(?:-[A-Z]{2})?"
+        variants = "[^.]*"
+
+        %r{
+          \A
+          (?:(?<prefix>.*)/)?
+          (?<partial>_)?
+          (?<action>.*?)
+          (?:\.(?<locale>#{locales}))??
+          (?:\.(?<format>#{formats}))??
+          (?:\+(?<variant>#{variants}))??
+          (?:\.(?<handler>#{handlers}))?
+          \z
+        }x
+      end
+
+      def parse(path)
+        @regex ||= build_path_regex
+        match = @regex.match(path)
+        {
+          prefix: match[:prefix] || "",
+          action: match[:action],
+          partial: !!match[:partial],
+          locale: match[:locale]&.to_sym,
+          handler: match[:handler]&.to_sym,
+          format: match[:format]&.to_sym,
+          variant: match[:variant]
+        }
+      end
+    end
+
     # Threadsafe template cache
     class Cache #:nodoc:
       class SmallCache < Concurrent::Map
@@ -43,13 +78,13 @@ module ActionView
         end
       end
 
-      # preallocate all the default blocks for performance/memory consumption reasons
+      # Preallocate all the default blocks for performance/memory consumption reasons
       PARTIAL_BLOCK = lambda { |cache, partial| cache[partial] = SmallCache.new }
       PREFIX_BLOCK  = lambda { |cache, prefix|  cache[prefix]  = SmallCache.new(&PARTIAL_BLOCK) }
       NAME_BLOCK    = lambda { |cache, name|    cache[name]    = SmallCache.new(&PREFIX_BLOCK) }
       KEY_BLOCK     = lambda { |cache, key|     cache[key]     = SmallCache.new(&NAME_BLOCK) }
 
-      # usually a majority of template look ups return nothing, use this canonical preallocated array to save memory
+      # Usually a majority of template look ups return nothing, use this canonical preallocated array to save memory
       NO_TEMPLATES = [].freeze
 
       def initialize
@@ -58,7 +93,7 @@ module ActionView
       end
 
       def inspect
-        "#<#{self.class.name}:0x#{(object_id << 1).to_s(16)} keys=#{@data.size} queries=#{@query_cache.size}>"
+        "#{to_s[0..-2]} keys=#{@data.size} queries=#{@query_cache.size}>"
       end
 
       # Cache the templates returned by the block
@@ -75,7 +110,7 @@ module ActionView
         @query_cache.clear
       end
 
-      # Get the cache size.  Do not call this
+      # Get the cache size. Do not call this
       # method. This method is not guaranteed to be here ever.
       def size # :nodoc:
         size = 0
@@ -93,7 +128,6 @@ module ActionView
       end
 
       private
-
         def canonical_no_templates(templates)
           templates.empty? ? NO_TEMPLATES : templates
         end
@@ -122,15 +156,11 @@ module ActionView
       end
     end
 
-    alias :find_all_anywhere :find_all
-    deprecate :find_all_anywhere
-
     def find_all_with_query(query) # :nodoc:
       @cache.cache_query(query) { find_template_paths(File.join(@path, query)) }
     end
 
   private
-
     def _find_all(name, prefix, partial, details, key, locals)
       find_templates(name, prefix, partial, details, locals)
     end
@@ -166,24 +196,20 @@ module ActionView
     EXTENSIONS = { locale: ".", formats: ".", variants: "+", handlers: "." }
     DEFAULT_PATTERN = ":prefix/:action{.:locale,}{.:formats,}{+:variants,}{.:handlers,}"
 
-    def initialize(pattern = nil)
-      if pattern
-        ActiveSupport::Deprecation.warn "Specifying a custom path for #{self.class} is deprecated. Implement a custom Resolver subclass instead."
-        @pattern = pattern
-      else
-        @pattern = DEFAULT_PATTERN
-      end
+    def initialize
+      @pattern = DEFAULT_PATTERN
       @unbound_templates = Concurrent::Map.new
-      super()
+      @path_parser = PathParser.new
+      super
     end
 
     def clear_cache
       @unbound_templates.clear
-      super()
+      @path_parser = PathParser.new
+      super
     end
 
     private
-
       def _find_all(name, prefix, partial, details, key, locals)
         path = Path.build(name, prefix, partial)
         query(path, details, details[:formats], locals, cache: !!key)
@@ -207,9 +233,13 @@ module ActionView
         end
       end
 
+      def source_for_template(template)
+        Template::Sources::File.new(template)
+      end
+
       def build_unbound_template(template, virtual_path)
         handler, format, variant = extract_handler_and_format_and_variant(template)
-        source = Template::Sources::File.new(template)
+        source = source_for_template(template)
 
         UnboundTemplate.new(
           source,
@@ -226,6 +256,10 @@ module ActionView
       end
 
       def find_template_paths_from_details(path, details)
+        if path.name.include?(".")
+          ActiveSupport::Deprecation.warn("Rendering actions with '.' in the name is deprecated: #{path}")
+        end
+
         query = build_query(path, details)
         find_template_paths(query)
       end
@@ -252,7 +286,7 @@ module ActionView
         query.gsub!(/:prefix(\/)?/, prefix)
 
         partial = escape_entry(path.partial? ? "_#{path.name}" : path.name)
-        query.gsub!(/:action/, partial)
+        query.gsub!(":action", partial)
 
         details.each do |ext, candidates|
           if ext == :variants && candidates == :any
@@ -273,22 +307,11 @@ module ActionView
       # from the path, or the handler, we should return the array of formats given
       # to the resolver.
       def extract_handler_and_format_and_variant(path)
-        pieces = File.basename(path).split(".")
-        pieces.shift
-
-        extension = pieces.pop
-
-        handler = Template.handler_for_extension(extension)
-        format, variant = pieces.last.split(EXTENSIONS[:variants], 2) if pieces.last
-        format = if format
-          Template::Types[format]&.ref
-        else
-          if handler.respond_to?(:default_format) # default_format can return nil
-            handler.default_format
-          else
-            nil
-          end
-        end
+        details = @path_parser.parse(path)
+
+        handler = Template.handler_for_extension(details[:handler])
+        format = details[:format] || handler.try(:default_format)
+        variant = details[:variant]
 
         # Template::Types[format] and handler.default_format can return nil
         [handler, format, variant]
@@ -299,9 +322,9 @@ module ActionView
   class FileSystemResolver < PathResolver
     attr_reader :path
 
-    def initialize(path, pattern = nil)
+    def initialize(path)
       raise ArgumentError, "path already is a Resolver class" if path.is_a?(Resolver)
-      super(pattern)
+      super()
       @path = File.expand_path(path)
     end
 
@@ -323,15 +346,27 @@ module ActionView
     end
 
     private
-
-      def find_template_paths_from_details(path, details)
+      def find_candidate_template_paths(path)
         # Instead of checking for every possible path, as our other globs would
         # do, scan the directory for files with the right prefix.
         query = "#{escape_entry(File.join(@path, path))}*"
 
+        Dir[query].reject do |filename|
+          File.directory?(filename)
+        end
+      end
+
+      def find_template_paths_from_details(path, details)
+        if path.name.include?(".")
+          # Fall back to the unoptimized resolver, which will warn
+          return super
+        end
+
+        candidates = find_candidate_template_paths(path)
+
         regex = build_regex(path, details)
 
-        Dir[query].uniq.reject do |filename|
+        candidates.uniq.reject do |filename|
           # This regex match does double duty of finding only files which match
           # details (instead of just matching the prefix) and also filtering for
           # case-insensitive file systems.
@@ -343,7 +378,7 @@ module ActionView
           # We can use the matches found by the regex and sort by their index in
           # details.
           match = filename.match(regex)
-          EXTENSIONS.keys.reverse.map do |ext|
+          EXTENSIONS.keys.map do |ext|
             if ext == :variants && details[ext] == :any
               match[ext].nil? ? 0 : 1
             elsif match[ext].nil?
@@ -358,13 +393,16 @@ module ActionView
       end
 
       def build_regex(path, details)
-        query = escape_entry(File.join(@path, path))
+        query = Regexp.escape(File.join(@path, path))
         exts = EXTENSIONS.map do |ext, prefix|
           match =
             if ext == :variants && details[ext] == :any
               ".*?"
             else
-              details[ext].compact.uniq.map { |e| Regexp.escape(e) }.join("|")
+              arr = details[ext].compact
+              arr.uniq!
+              arr.map! { |e| Regexp.escape(e) }
+              arr.join("|")
             end
           prefix = Regexp.escape(prefix)
           "(#{prefix}(?<#{ext}>#{match}))?"

data/lib/action_view/template/text.rb

@@ -27,9 +27,6 @@ module ActionView #:nodoc:
       def format
         :text
       end
-
-      def formats; Array(format); end
-      deprecate :formats
     end
   end
 end

data/lib/action_view/template.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/object/try"
-require "active_support/core_ext/kernel/singleton_class"
-require "active_support/deprecation"
 require "thread"
 require "delegate"
 
@@ -11,14 +8,6 @@ module ActionView
   class Template
     extend ActiveSupport::Autoload
 
-    def self.finalize_compiled_template_methods
-      ActiveSupport::Deprecation.warn "ActionView::Template.finalize_compiled_template_methods is deprecated and has no effect"
-    end
-
-    def self.finalize_compiled_template_methods=(_)
-      ActiveSupport::Deprecation.warn "ActionView::Template.finalize_compiled_template_methods= is deprecated and has no effect"
-    end
-
     # === Encodings in ActionView::Template
     #
     # ActionView::Template is one of a few sources of potential
@@ -114,6 +103,7 @@ module ActionView
     eager_autoload do
       autoload :Error
       autoload :RawFile
+      autoload :Renderable
       autoload :Handlers
       autoload :HTML
       autoload :Inline
@@ -124,15 +114,10 @@ module ActionView
 
     extend Template::Handlers
 
-    attr_reader :identifier, :handler, :original_encoding, :updated_at
+    attr_reader :identifier, :handler
     attr_reader :variable, :format, :variant, :locals, :virtual_path
 
-    def initialize(source, identifier, handler, format: nil, variant: nil, locals: nil, virtual_path: nil, updated_at: nil)
-      unless locals
-        ActiveSupport::Deprecation.warn "ActionView::Template#initialize requires a locals parameter"
-        locals = []
-      end
-
+    def initialize(source, identifier, handler, locals:, format: nil, variant: nil, virtual_path: nil)
       @source            = source
       @identifier        = identifier
       @handler           = handler
@@ -141,32 +126,16 @@ module ActionView
       @virtual_path      = virtual_path
 
       @variable = if @virtual_path
-        base = @virtual_path[-1] == "/" ? "" : ::File.basename(@virtual_path)
+        base = @virtual_path.end_with?("/") ? "" : ::File.basename(@virtual_path)
         base =~ /\A_?(.*?)(?:\.\w+)*\z/
         $1.to_sym
       end
 
-      if updated_at
-        ActiveSupport::Deprecation.warn "ActionView::Template#updated_at is deprecated"
-        @updated_at        = updated_at
-      else
-        @updated_at        = Time.now
-      end
       @format            = format
       @variant           = variant
       @compile_mutex     = Mutex.new
     end
 
-    deprecate :original_encoding
-    deprecate :updated_at
-    deprecate def virtual_path=(_); end
-    deprecate def locals=(_); end
-    deprecate def formats=(_); end
-    deprecate def formats; Array(format); end
-    deprecate def variants=(_); end
-    deprecate def variants; [variant]; end
-    deprecate def refresh(_); self; end
-
     # Returns whether the underlying handler supports streaming. If so,
     # a streaming buffer *may* be passed when it starts rendering.
     def supports_streaming?
@@ -179,10 +148,10 @@ module ActionView
     # This method is instrumented as "!render_template.action_view". Notice that
     # we use a bang in this instrumentation because you don't want to
     # consume this in production. This is only slow if it's being listened to.
-    def render(view, locals, buffer = ActionView::OutputBuffer.new, &block)
+    def render(view, locals, buffer = ActionView::OutputBuffer.new, add_to_stack: true, &block)
       instrument_render_template do
         compile!(view)
-        view._run(method_name, self, locals, buffer, &block)
+        view._run(method_name, self, locals, buffer, add_to_stack: add_to_stack, &block)
       end
     rescue => e
       handle_render_error(view, e)
@@ -193,7 +162,7 @@ module ActionView
     end
 
     def short_identifier
-      @short_identifier ||= defined?(Rails.root) ? identifier.sub("#{Rails.root}/", "") : identifier
+      @short_identifier ||= defined?(Rails.root) ? identifier.delete_prefix("#{Rails.root}/") : identifier
     end
 
     def inspect
@@ -255,16 +224,15 @@ module ActionView
     # to ensure that references to the template object can be marshalled as well. This means forgoing
     # the marshalling of the compiler mutex and instantiating that again on unmarshalling.
     def marshal_dump # :nodoc:
-      [ @source, @identifier, @handler, @compiled, @locals, @virtual_path, @updated_at, @format, @variant ]
+      [ @source, @identifier, @handler, @compiled, @locals, @virtual_path, @format, @variant ]
     end
 
     def marshal_load(array) # :nodoc:
-      @source, @identifier, @handler, @compiled, @locals, @virtual_path, @updated_at, @format, @variant = *array
+      @source, @identifier, @handler, @compiled, @locals, @virtual_path, @format, @variant = *array
       @compile_mutex = Mutex.new
     end
 
     private
-
       # Compile a template. This method ensures a template is compiled
       # just once and removes the source after it is compiled.
       def compile!(view)
@@ -289,15 +257,6 @@ module ActionView
         end
       end
 
-      class LegacyTemplate < DelegateClass(Template) # :nodoc:
-        attr_reader :source
-
-        def initialize(template, source)
-          super(template)
-          @source = source
-        end
-      end
-
       # Among other things, this method is responsible for properly setting
       # the encoding of the compiled template.
       #