actionview 5.2.8.1 → 6.0.0.beta2

data/lib/action_view/rendering.rb

@@ -26,6 +26,13 @@ module ActionView
     extend ActiveSupport::Concern
     include ActionView::ViewPaths
 
+    attr_reader :rendered_format
+
+    def initialize
+      @rendered_format = nil
+      super
+    end
+
     # Overwrite process to setup I18n proxy.
     def process(*) #:nodoc:
       old_config, I18n.config = I18n.config, I18nProxy.new(I18n.config, lookup_context)
@@ -35,47 +42,59 @@ module ActionView
     end
 
     module ClassMethods
-      def view_context_class
-        @view_context_class ||= begin
-          supports_path = supports_path?
-          routes  = respond_to?(:_routes)  && _routes
-          helpers = respond_to?(:_helpers) && _helpers
-
-          Class.new(ActionView::Base) do
-            if routes
-              include routes.url_helpers(supports_path)
-              include routes.mounted_helpers
-            end
-
-            if helpers
-              include helpers
-            end
+      def _routes
+      end
+
+      def _helpers
+      end
+
+      def build_view_context_class(klass, supports_path, routes, helpers)
+        Class.new(klass) do
+          if routes
+            include routes.url_helpers(supports_path)
+            include routes.mounted_helpers
+          end
+
+          if helpers
+            include helpers
           end
         end
       end
-    end
 
-    attr_internal_writer :view_context_class
+      def view_context_class
+        klass = ActionView::LookupContext::DetailsKey.view_context_class(ActionView::Base)
+
+        @view_context_class ||= build_view_context_class(klass, supports_path?, _routes, _helpers)
+
+        if klass.changed?(@view_context_class)
+          @view_context_class = build_view_context_class(klass, supports_path?, _routes, _helpers)
+        end
+
+        @view_context_class
+      end
+    end
 
     def view_context_class
-      @_view_context_class ||= self.class.view_context_class
+      self.class.view_context_class
     end
 
     # An instance of a view class. The default view class is ActionView::Base.
     #
     # The view class must have the following methods:
-    # View.new[lookup_context, assigns, controller]
-    #   Create a new ActionView instance for a controller and we can also pass the arguments.
-    # View#render(option)
-    #   Returns String with the rendered template
+    #
+    # * <tt>View.new(lookup_context, assigns, controller)</tt> — Create a new
+    #   ActionView instance for a controller and we can also pass the arguments.
+    #
+    # * <tt>View#render(option)</tt> — Returns String with the rendered template.
     #
     # Override this method in a module to change the default behavior.
     def view_context
-      view_context_class.new(view_renderer, view_assigns, self)
+      view_context_class.new(lookup_context, view_assigns, self)
     end
 
     # Returns an object that is able to render templates.
     def view_renderer # :nodoc:
+      # Lifespan: Per controller
       @_view_renderer ||= ActionView::Renderer.new(lookup_context)
     end
 
@@ -84,10 +103,6 @@ module ActionView
       _render_template(options)
     end
 
-    def rendered_format
-      Template::Types[lookup_context.rendered_format]
-    end
-
     private
 
       # Find and render a template based on the options given.
@@ -97,17 +112,21 @@ module ActionView
         context = view_context
 
         context.assign assigns if assigns
-        lookup_context.rendered_format = nil if options[:formats]
         lookup_context.variants = variant if variant
 
-        view_renderer.render(context, options)
+        rendered_template = context.in_rendering_context(options) do |renderer|
+          renderer.render_to_object(context, options)
+        end
+
+        @rendered_format = Template::Types[rendered_template.format]
+
+        rendered_template.body
       end
 
       # Assign the rendered format to look up context.
       def _process_format(format)
         super
         lookup_context.formats = [format.to_sym]
-        lookup_context.rendered_format = lookup_context.formats.first
       end
 
       # Normalize args by converting render "foo" to render :action => "foo" and

data/lib/action_view/routing_url_for.rb

@@ -84,25 +84,24 @@ module ActionView
         super(only_path: _generate_paths_by_default)
       when Hash
         options = options.symbolize_keys
-        unless options.key?(:only_path)
-          options[:only_path] = only_path?(options[:host])
-        end
+        ensure_only_path_option(options)
 
         super(options)
       when ActionController::Parameters
-        unless options.key?(:only_path)
-          options[:only_path] = only_path?(options[:host])
-        end
+        ensure_only_path_option(options)
 
         super(options)
       when :back
         _back_url
       when Array
         components = options.dup
-        if _generate_paths_by_default
-          polymorphic_path(components, components.extract_options!)
+        options = components.extract_options!
+        ensure_only_path_option(options)
+
+        if options[:only_path]
+          polymorphic_path(components, options)
         else
-          polymorphic_url(components, components.extract_options!)
+          polymorphic_url(components, options)
         end
       else
         method = _generate_paths_by_default ? :path : :url
@@ -138,8 +137,10 @@ module ActionView
         true
       end
 
-      def only_path?(host)
-        _generate_paths_by_default unless host
+      def ensure_only_path_option(options)
+        unless options.key?(:only_path)
+          options[:only_path] = _generate_paths_by_default unless options[:host]
+        end
       end
   end
 end

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

@@ -5,11 +5,11 @@ module ActionView
     class Builder
       class_attribute :default_format, default: :xml
 
-      def call(template)
+      def call(template, source)
         require_engine
         "xml = ::Builder::XmlMarkup.new(:indent => 2);" \
           "self.output_buffer = xml.target!;" +
-          template.source +
+          source +
           ";xml.target!;"
       end
 

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

@@ -13,7 +13,7 @@ module ActionView
 
             # Dup properties so that we don't modify argument
             properties = Hash[properties]
-            properties[:preamble]   = "@output_buffer = output_buffer || ActionView::OutputBuffer.new;"
+            properties[:preamble]   = ""
             properties[:postamble]  = "@output_buffer.to_s"
             properties[:bufvar]     = "@output_buffer"
             properties[:escapefunc] = ""
@@ -22,8 +22,12 @@ module ActionView
           end
 
           def evaluate(action_view_erb_handler_context)
-            pr = eval("proc { #{@src} }", binding, @filename || "(erubi)")
-            action_view_erb_handler_context.instance_eval(&pr)
+            src = @src
+            view = Class.new(ActionView::Base) {
+              include action_view_erb_handler_context._routes.url_helpers
+              class_eval("define_method(:_template) { |local_assigns, output_buffer| #{src} }", @filename || "(erubi)", 0)
+            }.empty
+            view.run(:_template, nil, {}, ActionView::OutputBuffer.new)
           end
 
         private

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

@@ -14,12 +14,22 @@ module ActionView
         class_attribute :erb_implementation, default: Erubi
 
         # Do not escape templates of these mime types.
-        class_attribute :escape_whitelist, default: ["text/plain"]
+        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)
-          new.call(template)
+        def self.call(template, source)
+          new.call(template, source)
         end
 
         def supports_streaming?
@@ -30,24 +40,24 @@ module ActionView
           true
         end
 
-        def call(template)
+        def call(template, source)
           # First, convert to BINARY, so in case the encoding is
           # wrong, we can still find an encoding tag
           # (<%# encoding %>) inside the String using a regular
           # expression
-          template_source = template.source.dup.force_encoding(Encoding::ASCII_8BIT)
+          template_source = source.dup.force_encoding(Encoding::ASCII_8BIT)
 
           erb = template_source.gsub(ENCODING_TAG, "")
           encoding = $2
 
-          erb.force_encoding valid_encoding(template.source.dup, encoding)
+          erb.force_encoding valid_encoding(source.dup, encoding)
 
           # Always make sure we return a String in the default_internal
           erb.encode!
 
           self.class.erb_implementation.new(
             erb,
-            escape: (self.class.escape_whitelist.include? template.type),
+            escape: (self.class.escape_ignore_list.include? template.type),
             trim: (self.class.erb_trim_mode == "-")
           ).src
         end

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

@@ -3,7 +3,7 @@
 module ActionView
   module Template::Handlers
     class Html < Raw
-      def call(template)
+      def call(template, source)
         "ActionView::OutputBuffer.new #{super}"
       end
     end

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

@@ -3,8 +3,8 @@
 module ActionView
   module Template::Handlers
     class Raw
-      def call(template)
-        "#{template.source.inspect}.html_safe;"
+      def call(template, source)
+        "#{source.inspect}.html_safe;"
       end
     end
   end

data/lib/action_view/template/handlers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/deprecation"
+
 module ActionView #:nodoc:
   # = Action View Template Handlers
   class Template #:nodoc:
@@ -14,7 +16,7 @@ module ActionView #:nodoc:
         base.register_template_handler :erb, ERB.new
         base.register_template_handler :html, Html.new
         base.register_template_handler :builder, Builder.new
-        base.register_template_handler :ruby, :source.to_proc
+        base.register_template_handler :ruby, lambda { |_, source| source }
       end
 
       @@template_handlers = {}
@@ -24,11 +26,35 @@ 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.class}#call(#{params.map(&:last).join(", ")})
+          To:
+            >> #{handler.class}#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,15 +1,21 @@
 # frozen_string_literal: true
 
+require "active_support/deprecation"
+
 module ActionView #:nodoc:
   # = Action View HTML Template
   class Template #:nodoc:
     class HTML #:nodoc:
-      attr_accessor :type
+      attr_reader :type
 
       def initialize(string, type = nil)
+        unless type
+          ActiveSupport::Deprecation.warn "ActionView::Template::HTML#initialize requires a type parameter"
+          type = :html
+        end
+
         @string = string.to_s
-        @type   = Types[type] || type if type
-        @type ||= Types[:html]
+        @type   = type
       end
 
       def identifier
@@ -26,9 +32,12 @@ module ActionView #:nodoc:
         to_str
       end
 
-      def formats
-        [@type.respond_to?(:ref) ? @type.ref : @type.to_s]
+      def format
+        @type
       end
+
+      def formats; Array(format); end
+      deprecate :formats
     end
   end
 end

data/lib/action_view/template/inline.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActionView #:nodoc:
+  class Template #:nodoc:
+    class Inline < Template #:nodoc:
+      # This finalizer is needed (and exactly with a proc inside another proc)
+      # otherwise templates leak in development.
+      Finalizer = proc do |method_name, mod| # :nodoc:
+        proc do
+          mod.module_eval do
+            remove_possible_method method_name
+          end
+        end
+      end
+
+      def compile(mod)
+        super
+        ObjectSpace.define_finalizer(self, Finalizer[method_name, mod])
+      end
+    end
+  end
+end

data/lib/action_view/template/resolver.rb

@@ -16,7 +16,7 @@ module ActionView
       alias_method :partial?, :partial
 
       def self.build(name, prefix, partial)
-        virtual = "".dup
+        virtual = +""
         virtual << "#{prefix}/" unless prefix.empty?
         virtual << (partial ? "_#{name}" : name)
         new name, prefix, partial, virtual
@@ -196,7 +196,6 @@ module ActionView
       cached = nil
       templates.each do |t|
         t.locals         = locals
-        t.formats        = details[:formats]  || [:html] if t.formats.empty?
         t.variants       = details[:variants] || []      if t.variants.empty?
         t.virtual_path ||= (cached ||= build_path(*path_info))
       end
@@ -221,16 +220,13 @@ module ActionView
       end
 
       def query(path, details, formats, outside_app_allowed)
-        query = build_query(path, details)
-
-        template_paths = find_template_paths(query)
+        template_paths = find_template_paths_from_details(path, details)
         template_paths = reject_files_external_to_app(template_paths) unless outside_app_allowed
 
         template_paths.map do |template|
-          handler, format, variant = extract_handler_and_format_and_variant(template)
-          contents = File.binread(template)
+          handler, format, variant = extract_handler_and_format_and_variant(template, formats.first)
 
-          Template.new(contents, File.expand_path(template), handler,
+          FileTemplate.new(File.expand_path(template), handler,
             virtual_path: path.virtual,
             format: format,
             variant: variant,
@@ -243,6 +239,11 @@ module ActionView
         files.reject { |filename| !inside_path?(@path, filename) }
       end
 
+      def find_template_paths_from_details(path, details)
+        query = build_query(path, details)
+        find_template_paths(query)
+      end
+
       def find_template_paths(query)
         Dir[query].uniq.reject do |filename|
           File.directory?(filename) ||
@@ -279,7 +280,7 @@ module ActionView
       end
 
       def escape_entry(entry)
-        entry.gsub(/[*?{}\[\]]/, '\\\\\\&'.freeze)
+        entry.gsub(/[*?{}\[\]]/, '\\\\\\&')
       end
 
       # Returns the file mtime from the filesystem.
@@ -290,17 +291,26 @@ module ActionView
       # Extract handler, formats and variant from path. If a format cannot be found neither
       # 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(".".freeze)
+      def extract_handler_and_format_and_variant(path, query_format)
+        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 &&= Template::Types[format]
+        format = if format
+          Template::Types[format]&.ref
+        else
+          if handler.respond_to?(:default_format) # default_format can return nil
+            handler.default_format
+          else
+            query_format
+          end
+        end
 
-        [handler, format, variant]
+        # Template::Types[format] and handler.default_format can return nil
+        [handler, format || query_format, variant]
       end
   end
 
@@ -362,19 +372,56 @@ module ActionView
 
   # An Optimized resolver for Rails' most common case.
   class OptimizedFileSystemResolver < FileSystemResolver #:nodoc:
-    def build_query(path, details)
-      query = escape_entry(File.join(@path, path))
+    private
 
-      exts = EXTENSIONS.map do |ext, prefix|
-        if ext == :variants && details[ext] == :any
-          "{#{prefix}*,}"
-        else
-          "{#{details[ext].compact.uniq.map { |e| "#{prefix}#{e}," }.join}}"
+      def find_template_paths_from_details(path, details)
+        # 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))}*"
+
+        regex = build_regex(path, details)
+
+        Dir[query].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.
+          !regex.match?(filename) ||
+            File.directory?(filename)
+        end.sort_by do |filename|
+          # Because we scanned the directory, instead of checking for files
+          # one-by-one, they will be returned in an arbitrary order.
+          # 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|
+            if ext == :variants && details[ext] == :any
+              match[ext].nil? ? 0 : 1
+            elsif match[ext].nil?
+              # No match should be last
+              details[ext].length
+            else
+              found = match[ext].to_sym
+              details[ext].index(found)
+            end
+          end
         end
-      end.join
+      end
 
-      query + exts
-    end
+      def build_regex(path, details)
+        query = escape_entry(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("|")
+            end
+          prefix = Regexp.escape(prefix)
+          "(#{prefix}(?<#{ext}>#{match}))?"
+        end.join
+
+        %r{\A#{query}#{exts}\z}
+      end
   end
 
   # The same as FileSystemResolver but does not allow templates to store

data/lib/action_view/template/text.rb

@@ -8,7 +8,6 @@ module ActionView #:nodoc:
 
       def initialize(string)
         @string = string.to_s
-        @type = Types[:text]
       end
 
       def identifier
@@ -25,9 +24,12 @@ module ActionView #:nodoc:
         to_str
       end
 
-      def formats
-        [@type.ref]
+      def format
+        :text
       end
+
+      def formats; Array(format); end
+      deprecate :formats
     end
   end
 end