actionview 6.1.7.2 → 7.1.3

data/lib/action_view/helpers.rb

@@ -1,34 +1,35 @@
 # frozen_string_literal: true
 
 require "active_support/benchmarkable"
+require "action_view/helpers/capture_helper"
+require "action_view/helpers/output_safety_helper"
+require "action_view/helpers/tag_helper"
+require "action_view/helpers/url_helper"
+require "action_view/helpers/sanitize_helper"
+require "action_view/helpers/text_helper"
+require "action_view/helpers/active_model_helper"
+require "action_view/helpers/asset_tag_helper"
+require "action_view/helpers/asset_url_helper"
+require "action_view/helpers/atom_feed_helper"
+require "action_view/helpers/cache_helper"
+require "action_view/helpers/content_exfiltration_prevention_helper"
+require "action_view/helpers/controller_helper"
+require "action_view/helpers/csp_helper"
+require "action_view/helpers/csrf_helper"
+require "action_view/helpers/date_helper"
+require "action_view/helpers/debug_helper"
+require "action_view/helpers/form_tag_helper"
+require "action_view/helpers/form_helper"
+require "action_view/helpers/form_options_helper"
+require "action_view/helpers/javascript_helper"
+require "action_view/helpers/number_helper"
+require "action_view/helpers/rendering_helper"
+require "action_view/helpers/translation_helper"
 
-module ActionView #:nodoc:
-  module Helpers #:nodoc:
+module ActionView # :nodoc:
+  module Helpers # :nodoc:
     extend ActiveSupport::Autoload
 
-    autoload :ActiveModelHelper
-    autoload :AssetTagHelper
-    autoload :AssetUrlHelper
-    autoload :AtomFeedHelper
-    autoload :CacheHelper
-    autoload :CaptureHelper
-    autoload :ControllerHelper
-    autoload :CspHelper
-    autoload :CsrfHelper
-    autoload :DateHelper
-    autoload :DebugHelper
-    autoload :FormHelper
-    autoload :FormOptionsHelper
-    autoload :FormTagHelper
-    autoload :JavaScriptHelper, "action_view/helpers/javascript_helper"
-    autoload :NumberHelper
-    autoload :OutputSafetyHelper
-    autoload :RenderingHelper
-    autoload :SanitizeHelper
-    autoload :TagHelper
-    autoload :TextHelper
-    autoload :TranslationHelper
-    autoload :UrlHelper
     autoload :Tags
 
     def self.eager_load!
@@ -45,6 +46,7 @@ module ActionView #:nodoc:
     include AtomFeedHelper
     include CacheHelper
     include CaptureHelper
+    include ContentExfiltrationPreventionHelper
     include ControllerHelper
     include CspHelper
     include CsrfHelper

data/lib/action_view/layouts.rb

@@ -4,12 +4,14 @@ require "action_view/rendering"
 require "active_support/core_ext/module/redefine_method"
 
 module ActionView
+  # = Action View \Layouts
+  #
   # Layouts reverse the common pattern of including shared headers and footers in many templates to isolate changes in
   # repeated setups. The inclusion pattern has pages that look like this:
   #
-  #   <%= render "shared/header" %>
+  #   <%= render "application/header" %>
   #   Hello World
-  #   <%= render "shared/footer" %>
+  #   <%= render "application/footer" %>
   #
   # This approach is a decent way of keeping common structures isolated from the changing content, but it's verbose
   # and if you ever want to change the structure of these two includes, you'll have to change all the templates.
@@ -150,7 +152,7 @@ module ActionView
   # The template will be looked always in <tt>app/views/layouts/</tt> folder. But you can point
   # <tt>layouts</tt> folder direct also. <tt>layout "layouts/demo"</tt> is the same as <tt>layout "demo"</tt>.
   #
-  # Setting the layout to +nil+ forces it to be looked up in the filesystem and fallbacks to the parent behavior if none exists.
+  # Setting the layout to +nil+ forces it to be looked up in the filesystem and falls back to the parent behavior if none exists.
   # Setting it to +nil+ is useful to re-enable template lookup overriding a previous configuration set in the parent:
   #
   #     class ApplicationController < ActionController::Base
@@ -162,7 +164,7 @@ module ActionView
   #     end
   #
   #     class CommentsController < ApplicationController
-  #       # Will search for "comments" layout and fallback "application" layout
+  #       # Will search for "comments" layout and fall back to "application" layout
   #       layout nil
   #     end
   #
@@ -183,7 +185,7 @@ module ActionView
   # be rendered directly, without wrapping a layout around the rendered view.
   #
   # Both the <tt>:only</tt> and <tt>:except</tt> condition can accept an arbitrary number of method references, so
-  # #<tt>except: [ :rss, :text_only ]</tt> is valid, as is <tt>except: :rss</tt>.
+  # <tt>except: [ :rss, :text_only ]</tt> is valid, as is <tt>except: :rss</tt>.
   #
   # == Using a different layout in the action render call
   #
@@ -210,9 +212,9 @@ module ActionView
       class_attribute :_layout_conditions, instance_accessor: false, default: {}
 
       _write_layout_method
-    end
 
-    delegate :_layout_conditions, to: :class
+      delegate :_layout_conditions, to: :class
+    end
 
     module ClassMethods
       def inherited(klass) # :nodoc:
@@ -255,14 +257,17 @@ module ActionView
       # true::   raise an ArgumentError
       # nil::    Force default layout behavior with inheritance
       #
-      # Return value of +Proc+ and +Symbol+ arguments should be +String+, +false+, +true+ or +nil+
+      # Return value of +Proc+ and +Symbol+ arguments should be +String+, +false+, +true+, or +nil+
       # with the same meaning as described above.
+      #
       # ==== Parameters
+      #
       # * <tt>layout</tt> - The layout to use.
       #
       # ==== Options (conditions)
-      # * :only   - A list of actions to apply this layout to.
-      # * :except - Apply this layout to all actions but this one.
+      #
+      # * +:only+   - A list of actions to apply this layout to.
+      # * +:except+ - Apply this layout to all actions but this one.
       def layout(layout, conditions = {})
         include LayoutConditions unless conditions.empty?
 

data/lib/action_view/log_subscriber.rb

@@ -5,7 +5,7 @@ require "active_support/log_subscriber"
 module ActionView
   # = Action View Log Subscriber
   #
-  # Provides functionality so that Rails can output logs from Action View.
+  # Provides functionality so that \Rails can output logs from Action View.
   class LogSubscriber < ActiveSupport::LogSubscriber
     VIEWS_PATTERN = /^app\/views\//
 
@@ -21,6 +21,7 @@ module ActionView
         message << " (Duration: #{event.duration.round(1)}ms | Allocations: #{event.allocations})"
       end
     end
+    subscribe_log_level :render_template, :debug
 
     def render_partial(event)
       debug do
@@ -31,6 +32,7 @@ module ActionView
         message
       end
     end
+    subscribe_log_level :render_partial, :debug
 
     def render_layout(event)
       info do
@@ -38,6 +40,7 @@ module ActionView
         message << " (Duration: #{event.duration.round(1)}ms | Allocations: #{event.allocations})"
       end
     end
+    subscribe_log_level :render_layout, :info
 
     def render_collection(event)
       identifier = event.payload[:identifier] || "templates"
@@ -49,29 +52,60 @@ module ActionView
         message
       end
     end
+    subscribe_log_level :render_collection, :debug
 
-    def start(name, id, payload)
-      log_rendering_start(payload, name)
+    module Utils # :nodoc:
+      def logger
+        ActionView::Base.logger
+      end
 
-      super
-    end
+    private
+      def from_rails_root(string)
+        string = string.sub(rails_root, "")
+        string.sub!(VIEWS_PATTERN, "")
+        string
+      end
 
-    def logger
-      ActionView::Base.logger
+      def rails_root # :doc:
+        @root ||= "#{Rails.root}/"
+      end
     end
 
-  private
-    EMPTY = ""
-    def from_rails_root(string) # :doc:
-      string = string.sub(rails_root, EMPTY)
-      string.sub!(VIEWS_PATTERN, EMPTY)
-      string
+    include Utils
+
+    class Start # :nodoc:
+      include Utils
+
+      def start(name, id, payload)
+        return unless logger
+        logger.debug do
+          qualifier =
+            if name == "render_template.action_view"
+              ""
+            elsif name == "render_layout.action_view"
+              "layout "
+            end
+
+          return unless qualifier
+
+          message = +"  Rendering #{qualifier}#{from_rails_root(payload[:identifier])}"
+          message << " within #{from_rails_root(payload[:layout])}" if payload[:layout]
+          message
+        end
+      end
+
+      def finish(name, id, payload)
+      end
     end
 
-    def rails_root # :doc:
-      @root ||= "#{Rails.root}/"
+    def self.attach_to(*)
+      ActiveSupport::Notifications.subscribe("render_template.action_view", ActionView::LogSubscriber::Start.new)
+      ActiveSupport::Notifications.subscribe("render_layout.action_view", ActionView::LogSubscriber::Start.new)
+
+      super
     end
 
+  private
     def render_count(payload) # :doc:
       if payload[:cache_hits]
         "[#{payload[:cache_hits]} / #{payload[:count]} cache hits]"
@@ -88,23 +122,6 @@ module ActionView
         "[cache miss]"
       end
     end
-
-    def log_rendering_start(payload, name)
-      debug do
-        qualifier =
-          if name == "render_template.action_view"
-            ""
-          elsif name == "render_layout.action_view"
-            "layout "
-          end
-
-        return unless qualifier
-
-        message = +"  Rendering #{qualifier}#{from_rails_root(payload[:identifier])}"
-        message << " within #{from_rails_root(payload[:layout])}" if payload[:layout]
-        message
-      end
-    end
   end
 end
 

data/lib/action_view/lookup_context.rb

@@ -12,12 +12,11 @@ module ActionView
   # <tt>LookupContext</tt> is also responsible for generating a key, given to
   # view paths, used in the resolver cache lookup. Since this key is generated
   # only once during the request, it speeds up all cache accesses.
-  class LookupContext #:nodoc:
-    attr_accessor :prefixes, :rendered_format
+  class LookupContext # :nodoc:
+    attr_accessor :prefixes
 
-    mattr_accessor :fallbacks, default: FallbackFileSystemResolver.instances
-
-    mattr_accessor :registered_details, default: []
+    singleton_class.attr_accessor :registered_details
+    self.registered_details = []
 
     def self.register_detail(name, &block)
       registered_details << name
@@ -37,7 +36,7 @@ module ActionView
     end
 
     # Holds accessors for the registered details.
-    module Accessors #:nodoc:
+    module Accessors # :nodoc:
       DEFAULT_PROCS = {}
     end
 
@@ -52,7 +51,7 @@ module ActionView
     register_detail(:variants) { [] }
     register_detail(:handlers) { Template::Handlers.extensions }
 
-    class DetailsKey #:nodoc:
+    class DetailsKey # :nodoc:
       alias :eql? :equal?
 
       @details_keys = Concurrent::Map.new
@@ -64,18 +63,21 @@ module ActionView
       end
 
       def self.details_cache_key(details)
-        if details[:formats]
-          details = details.dup
-          details[:formats] &= Template::Types.symbols
+        @details_keys.fetch(details) do
+          if formats = details[:formats]
+            unless Template::Types.valid_symbols?(formats)
+              details = details.dup
+              details[:formats] &= Template::Types.symbols
+            end
+          end
+          @details_keys[details] ||= TemplateDetails::Requested.new(**details)
         end
-        @details_keys[details] ||= Object.new
       end
 
       def self.clear
-        ActionView::ViewPaths.all_view_paths.each do |path_set|
-          path_set.each(&:clear_cache)
+        ActionView::PathRegistry.all_resolvers.each do |resolver|
+          resolver.clear_cache
         end
-        ActionView::LookupContext.fallbacks.each(&:clear_cache)
         @view_context_class = nil
         @details_keys.clear
         @digest_cache.clear
@@ -85,9 +87,9 @@ module ActionView
         @digest_cache.values
       end
 
-      def self.view_context_class(klass)
+      def self.view_context_class
         @view_context_mutex.synchronize do
-          @view_context_class ||= klass.with_empty_template_cache
+          @view_context_class ||= ActionView::Base.with_empty_template_cache
         end
       end
     end
@@ -98,7 +100,7 @@ module ActionView
 
       # Calculate the details key. Remove the handlers from calculation to improve performance
       # since the user cannot modify it explicitly.
-      def details_key #:nodoc:
+      def details_key # :nodoc:
         @details_key ||= DetailsKey.details_cache_key(@details) if @cache
       end
 
@@ -124,50 +126,49 @@ module ActionView
       attr_reader :view_paths, :html_fallback_for_js
 
       def find(name, prefixes = [], partial = false, keys = [], options = {})
-        @view_paths.find(*args_for_lookup(name, prefixes, partial, keys, options))
+        name, prefixes = normalize_name(name, prefixes)
+        details, details_key = detail_args_for(options)
+        @view_paths.find(name, prefixes, partial, details, details_key, keys)
       end
       alias :find_template :find
 
       def find_all(name, prefixes = [], partial = false, keys = [], options = {})
-        @view_paths.find_all(*args_for_lookup(name, prefixes, partial, keys, options))
+        name, prefixes = normalize_name(name, prefixes)
+        details, details_key = detail_args_for(options)
+        @view_paths.find_all(name, prefixes, partial, details, details_key, keys)
       end
 
       def exists?(name, prefixes = [], partial = false, keys = [], **options)
-        @view_paths.exists?(*args_for_lookup(name, prefixes, partial, keys, options))
+        name, prefixes = normalize_name(name, prefixes)
+        details, details_key = detail_args_for(options)
+        @view_paths.exists?(name, prefixes, partial, details, details_key, keys)
       end
       alias :template_exists? :exists?
 
       def any?(name, prefixes = [], partial = false)
-        @view_paths.exists?(*args_for_any(name, prefixes, partial))
+        name, prefixes = normalize_name(name, prefixes)
+        details, details_key = detail_args_for_any
+        @view_paths.exists?(name, prefixes, partial, details, details_key, [])
       end
       alias :any_templates? :any?
 
-      # Adds fallbacks to the view paths. Useful in cases when you are rendering
-      # a :file.
-      def with_fallbacks
-        view_paths = build_view_paths((@view_paths.paths + self.class.fallbacks).uniq)
+      def append_view_paths(paths)
+        @view_paths = build_view_paths(@view_paths.to_a + paths)
+      end
 
-        if block_given?
-          raise ArgumentError, <<~eowarn.squish
-          Calling `with_fallbacks` with a block is not supported. Call methods on
-          the lookup context returned by `with_fallbacks` instead.
-          eowarn
-        else
-          ActionView::LookupContext.new(view_paths, @details, @prefixes)
-        end
+      def prepend_view_paths(paths)
+        @view_paths = build_view_paths(paths + @view_paths.to_a)
       end
 
     private
       # Whenever setting view paths, makes a copy so that we can manipulate them in
       # instance objects as we wish.
       def build_view_paths(paths)
-        ActionView::PathSet.new(Array(paths))
-      end
-
-      def args_for_lookup(name, prefixes, partial, keys, details_options)
-        name, prefixes = normalize_name(name, prefixes)
-        details, details_key = detail_args_for(details_options)
-        [name, prefixes, partial || false, details, details_key, keys]
+        if ActionView::PathSet === paths
+          paths
+        else
+          ActionView::PathSet.new(Array(paths))
+        end
       end
 
       # Compute details hash and key according to user options (e.g. passed from #render).
@@ -184,17 +185,11 @@ module ActionView
         [user_details, details_key]
       end
 
-      def args_for_any(name, prefixes, partial)
-        name, prefixes = normalize_name(name, prefixes)
-        details, details_key = detail_args_for_any
-        [name, prefixes, partial || false, details, details_key]
-      end
-
       def detail_args_for_any
         @detail_args_for_any ||= begin
           details = {}
 
-          registered_details.each do |k|
+          LookupContext.registered_details.each do |k|
             if k == :variants
               details[k] = :any
             else
@@ -210,19 +205,21 @@ module ActionView
         end
       end
 
-      # Support legacy foo.erb names even though we now ignore .erb
-      # as well as incorrectly putting part of the path in the template
-      # name instead of the prefix.
+      # Fix when prefix is specified as part of the template name
       def normalize_name(name, prefixes)
-        prefixes = prefixes.presence
-        parts    = name.to_s.split("/")
-        parts.shift if parts.first.empty?
-        name = parts.pop
+        name = name.to_s
+        idx = name.rindex("/")
+        return name, prefixes.presence || [""] unless idx
 
-        return name, prefixes || [""] if parts.empty?
+        path_prefix = name[0, idx]
+        path_prefix = path_prefix.from(1) if path_prefix.start_with?("/")
+        name = name.from(idx + 1)
 
-        parts    = parts.join("/")
-        prefixes = prefixes ? prefixes.map { |p| "#{p}/#{parts}" } : [parts]
+        if !prefixes || prefixes.empty?
+          prefixes = [path_prefix]
+        else
+          prefixes = prefixes.map { |p| "#{p}/#{path_prefix}" }
+        end
 
         return name, prefixes
       end
@@ -254,7 +251,7 @@ module ActionView
     end
 
     def initialize_details(target, details)
-      registered_details.each do |k|
+      LookupContext.registered_details.each do |k|
         target[k] = details[k] || Accessors::DEFAULT_PROCS[k].call
       end
       target
@@ -269,12 +266,12 @@ module ActionView
         values.concat(default_formats) if values.delete "*/*"
         values.uniq!
 
-        invalid_values = (values - Template::Types.symbols)
-        unless invalid_values.empty?
+        unless Template::Types.valid_symbols?(values)
+          invalid_values = values - Template::Types.symbols
           raise ArgumentError, "Invalid formats: #{invalid_values.map(&:inspect).join(", ")}"
         end
 
-        if values == [:js]
+        if (values.length == 1) && (values[0] == :js)
           values << :html
           @html_fallback_for_js = true
         end

data/lib/action_view/model_naming.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module ActionView
-  module ModelNaming #:nodoc:
-    # Converts the given object to an ActiveModel compliant one.
+  module ModelNaming # :nodoc:
+    # Converts the given object to an Active Model compliant one.
     def convert_to_model(object)
       object.respond_to?(:to_model) ? object.to_model : object
     end

data/lib/action_view/path_registry.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module ActionView # :nodoc:
+  module PathRegistry # :nodoc:
+    @view_paths_by_class = {}
+    @file_system_resolvers = {}
+    @file_system_resolver_mutex = Mutex.new
+    @file_system_resolver_hooks = []
+
+    class << self
+      attr_reader :file_system_resolver_hooks
+    end
+
+    def self.get_view_paths(klass)
+      @view_paths_by_class[klass] || get_view_paths(klass.superclass)
+    end
+
+    def self.set_view_paths(klass, paths)
+      @view_paths_by_class[klass] = paths
+    end
+
+    def self.cast_file_system_resolvers(paths)
+      paths = Array(paths)
+
+      @file_system_resolver_mutex.synchronize do
+        built_resolver = false
+        paths = paths.map do |path|
+          case path
+          when String, Pathname
+            path = File.expand_path(path)
+            @file_system_resolvers[path] ||=
+              begin
+                built_resolver = true
+                FileSystemResolver.new(path)
+              end
+          else
+            path
+          end
+        end
+
+        file_system_resolver_hooks.each(&:call) if built_resolver
+      end
+
+      paths
+    end
+
+    def self.all_resolvers
+      resolvers = [all_file_system_resolvers]
+      resolvers.concat @view_paths_by_class.values.map(&:to_a)
+      resolvers.flatten.uniq
+    end
+
+    def self.all_file_system_resolvers
+      @file_system_resolvers.values
+    end
+  end
+end