actionview 5.1.4 → 6.1.1

data/lib/action_view/lookup_context.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require "concurrent/map"
-require "active_support/core_ext/module/remove_method"
 require "active_support/core_ext/module/attribute_accessors"
 require "action_view/template/resolver"
 
@@ -14,20 +15,18 @@ module ActionView
   class LookupContext #:nodoc:
     attr_accessor :prefixes, :rendered_format
 
-    mattr_accessor :fallbacks
-    @@fallbacks = FallbackFileSystemResolver.instances
+    mattr_accessor :fallbacks, default: FallbackFileSystemResolver.instances
 
-    mattr_accessor :registered_details
-    self.registered_details = []
+    mattr_accessor :registered_details, default: []
 
     def self.register_detail(name, &block)
       registered_details << name
       Accessors::DEFAULT_PROCS[name] = block
 
-      Accessors.send :define_method, :"default_#{name}", &block
+      Accessors.define_method(:"default_#{name}", &block)
       Accessors.module_eval <<-METHOD, __FILE__, __LINE__ + 1
         def #{name}
-          @details.fetch(:#{name}, [])
+          @details[:#{name}] || []
         end
 
         def #{name}=(value)
@@ -57,21 +56,39 @@ module ActionView
       alias :eql? :equal?
 
       @details_keys = Concurrent::Map.new
+      @digest_cache = Concurrent::Map.new
+      @view_context_mutex = Mutex.new
+
+      def self.digest_cache(details)
+        @digest_cache[details_cache_key(details)] ||= Concurrent::Map.new
+      end
 
-      def self.get(details)
+      def self.details_cache_key(details)
         if details[:formats]
           details = details.dup
           details[:formats] &= Template::Types.symbols
         end
-        @details_keys[details] ||= Concurrent::Map.new
+        @details_keys[details] ||= Object.new
       end
 
       def self.clear
+        ActionView::ViewPaths.all_view_paths.each do |path_set|
+          path_set.each(&:clear_cache)
+        end
+        ActionView::LookupContext.fallbacks.each(&:clear_cache)
+        @view_context_class = nil
         @details_keys.clear
+        @digest_cache.clear
       end
 
       def self.digest_caches
-        @details_keys.values
+        @digest_cache.values
+      end
+
+      def self.view_context_class(klass)
+        @view_context_mutex.synchronize do
+          @view_context_class ||= klass.with_empty_template_cache
+        end
       end
     end
 
@@ -82,7 +99,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:
-        @details_key ||= DetailsKey.get(@details) if @cache
+        @details_key ||= DetailsKey.details_cache_key(@details) if @cache
       end
 
       # Temporary skip passing the details_key forward.
@@ -94,9 +111,9 @@ module ActionView
       end
 
     private
-
       def _set_detail(key, value) # :doc:
-        @details = @details.dup if @details_key
+        @details = @details.dup if @digest_cache || @details_key
+        @digest_cache = nil
         @details_key = nil
         @details[key] = value
       end
@@ -106,21 +123,11 @@ module ActionView
     module ViewPaths
       attr_reader :view_paths, :html_fallback_for_js
 
-      # Whenever setting view paths, makes a copy so that we can manipulate them in
-      # instance objects as we wish.
-      def view_paths=(paths)
-        @view_paths = ActionView::PathSet.new(Array(paths))
-      end
-
       def find(name, prefixes = [], partial = false, keys = [], options = {})
         @view_paths.find(*args_for_lookup(name, prefixes, partial, keys, options))
       end
       alias :find_template :find
 
-      def find_file(name, prefixes = [], partial = false, keys = [], options = {})
-        @view_paths.find_file(*args_for_lookup(name, prefixes, partial, keys, options))
-      end
-
       def find_all(name, prefixes = [], partial = false, keys = [], options = {})
         @view_paths.find_all(*args_for_lookup(name, prefixes, partial, keys, options))
       end
@@ -138,18 +145,24 @@ module ActionView
       # Adds fallbacks to the view paths. Useful in cases when you are rendering
       # a :file.
       def with_fallbacks
-        added_resolvers = 0
-        self.class.fallbacks.each do |resolver|
-          next if view_paths.include?(resolver)
-          view_paths.push(resolver)
-          added_resolvers += 1
+        view_paths = build_view_paths((@view_paths.paths + self.class.fallbacks).uniq)
+
+        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
-        yield
-      ensure
-        added_resolvers.times { view_paths.pop }
       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)
@@ -163,7 +176,7 @@ module ActionView
         user_details = @details.merge(options)
 
         if @cache
-          details_key = DetailsKey.get(user_details)
+          details_key = DetailsKey.details_cache_key(user_details)
         else
           details_key = nil
         end
@@ -190,7 +203,7 @@ module ActionView
           end
 
           if @cache
-            [details, DetailsKey.get(details)]
+            [details, DetailsKey.details_cache_key(details)]
           else
             [details, nil]
           end
@@ -202,13 +215,13 @@ module ActionView
       # name instead of the prefix.
       def normalize_name(name, prefixes)
         prefixes = prefixes.presence
-        parts    = name.to_s.split("/".freeze)
+        parts    = name.to_s.split("/")
         parts.shift if parts.first.empty?
         name = parts.pop
 
         return name, prefixes || [""] if parts.empty?
 
-        parts    = parts.join("/".freeze)
+        parts    = parts.join("/")
         prefixes = prefixes ? prefixes.map { |p| "#{p}/#{parts}" } : [parts]
 
         return name, prefixes
@@ -221,16 +234,23 @@ module ActionView
 
     def initialize(view_paths, details = {}, prefixes = [])
       @details_key = nil
+      @digest_cache = nil
       @cache = true
       @prefixes = prefixes
-      @rendered_format = nil
 
       @details = initialize_details({}, details)
-      self.view_paths = view_paths
+      @view_paths = build_view_paths(view_paths)
     end
 
     def digest_cache
-      details_key
+      @digest_cache ||= DetailsKey.digest_cache(@details)
+    end
+
+    def with_prepended_formats(formats)
+      details = @details.dup
+      details[:formats] = formats
+
+      self.class.new(@view_paths, details, @prefixes)
     end
 
     def initialize_details(target, details)
@@ -245,7 +265,15 @@ module ActionView
     # add :html as fallback to :js.
     def formats=(values)
       if values
-        values.concat(default_formats) if values.delete "*/*".freeze
+        values = values.dup
+        values.concat(default_formats) if values.delete "*/*"
+        values.uniq!
+
+        invalid_values = (values - Template::Types.symbols)
+        unless invalid_values.empty?
+          raise ArgumentError, "Invalid formats: #{invalid_values.map(&:inspect).join(", ")}"
+        end
+
         if values == [:js]
           values << :html
           @html_fallback_for_js = true

data/lib/action_view/model_naming.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionView
   module ModelNaming #:nodoc:
     # Converts the given object to an ActiveModel compliant one.

data/lib/action_view/path_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionView #:nodoc:
   # = Action View PathSet
   #
@@ -46,12 +48,8 @@ module ActionView #:nodoc:
       find_all(*args).first || raise(MissingTemplate.new(self, *args))
     end
 
-    def find_file(path, prefixes = [], *args)
-      _find_all(path, prefixes, args, true).first || raise(MissingTemplate.new(self, path, prefixes, *args))
-    end
-
     def find_all(path, prefixes = [], *args)
-      _find_all path, prefixes, args, false
+      _find_all path, prefixes, args
     end
 
     def exists?(path, prefixes, *args)
@@ -68,16 +66,11 @@ module ActionView #:nodoc:
     end
 
     private
-
-      def _find_all(path, prefixes, args, outside_app)
+      def _find_all(path, prefixes, args)
         prefixes = [prefixes] if String === prefixes
         prefixes.each do |prefix|
           paths.each do |resolver|
-            if outside_app
-              templates = resolver.find_all_anywhere(path, prefix, *args)
-            else
-              templates = resolver.find_all(path, prefix, *args)
-            end
+            templates = resolver.find_all(path, prefix, *args)
             return templates unless templates.empty?
           end
         end

data/lib/action_view/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "action_view"
 require "rails"
 
@@ -7,37 +9,56 @@ module ActionView
     config.action_view = ActiveSupport::OrderedOptions.new
     config.action_view.embed_authenticity_token_in_remote_forms = nil
     config.action_view.debug_missing_translation = true
+    config.action_view.default_enforce_utf8 = nil
 
     config.eager_load_namespaces << ActionView
 
-    initializer "action_view.embed_authenticity_token_in_remote_forms" do |app|
-      ActiveSupport.on_load(:action_view) do
-        ActionView::Helpers::FormTagHelper.embed_authenticity_token_in_remote_forms =
-          app.config.action_view.delete(:embed_authenticity_token_in_remote_forms)
+    config.after_initialize do |app|
+      ActionView::Helpers::FormTagHelper.embed_authenticity_token_in_remote_forms =
+        app.config.action_view.delete(:embed_authenticity_token_in_remote_forms)
+    end
+
+    config.after_initialize do |app|
+      form_with_generates_remote_forms = app.config.action_view.delete(:form_with_generates_remote_forms)
+      ActionView::Helpers::FormHelper.form_with_generates_remote_forms = form_with_generates_remote_forms
+    end
+
+    config.after_initialize do |app|
+      form_with_generates_ids = app.config.action_view.delete(:form_with_generates_ids)
+      unless form_with_generates_ids.nil?
+        ActionView::Helpers::FormHelper.form_with_generates_ids = form_with_generates_ids
       end
     end
 
-    initializer "action_view.form_with_generates_remote_forms" do |app|
-      ActiveSupport.on_load(:action_view) do
-        form_with_generates_remote_forms = app.config.action_view.delete(:form_with_generates_remote_forms)
-        unless form_with_generates_remote_forms.nil?
-          ActionView::Helpers::FormHelper.form_with_generates_remote_forms = form_with_generates_remote_forms
-        end
+    config.after_initialize do |app|
+      default_enforce_utf8 = app.config.action_view.delete(:default_enforce_utf8)
+      unless default_enforce_utf8.nil?
+        ActionView::Helpers::FormTagHelper.default_enforce_utf8 = default_enforce_utf8
       end
     end
 
-    initializer "action_view.logger" do
-      ActiveSupport.on_load(:action_view) { self.logger ||= Rails.logger }
+    config.after_initialize do |app|
+      ActionView::Helpers::AssetTagHelper.preload_links_header = app.config.action_view.delete(:preload_links_header)
     end
 
-    initializer "action_view.set_configs" do |app|
+    config.after_initialize do |app|
       ActiveSupport.on_load(:action_view) do
         app.config.action_view.each do |k, v|
+          if k == :raise_on_missing_translations
+            ActiveSupport::Deprecation.warn \
+              "action_view.raise_on_missing_translations is deprecated and will be removed in Rails 6.2. " \
+              "Set i18n.raise_on_missing_translations instead. " \
+              "Note that this new setting also affects how missing translations are handled in controllers."
+          end
           send "#{k}=", v
         end
       end
     end
 
+    initializer "action_view.logger" do
+      ActiveSupport.on_load(:action_view) { self.logger ||= Rails.logger }
+    end
+
     initializer "action_view.caching" do |app|
       ActiveSupport.on_load(:action_view) do
         if app.config.action_view.cache_template_loading.nil?
@@ -46,14 +67,6 @@ module ActionView
       end
     end
 
-    initializer "action_view.per_request_digest_cache" do |app|
-      ActiveSupport.on_load(:action_view) do
-        unless ActionView::Resolver.caching?
-          app.executor.to_run ActionView::Digestor::PerExecutionDigestCacheExpiry
-        end
-      end
-    end
-
     initializer "action_view.setup_action_pack" do |app|
       ActiveSupport.on_load(:action_controller) do
         ActionView::RoutingUrlFor.include(ActionDispatch::Routing::UrlFor)
@@ -64,6 +77,18 @@ module ActionView
       PartialRenderer.collection_cache = app.config.action_controller.cache_store
     end
 
+    config.after_initialize do |app|
+      enable_caching = if app.config.action_view.cache_template_loading.nil?
+        app.config.cache_classes
+      else
+        app.config.action_view.cache_template_loading
+      end
+
+      unless enable_caching
+        app.executor.to_run ActionView::CacheExpiry::Executor.new(watcher: app.config.file_watcher)
+      end
+    end
+
     rake_tasks do |app|
       unless app.config.api_only
         load "action_view/tasks/cache_digests.rake"

data/lib/action_view/record_identifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/module"
 require "action_view/model_naming"
 
@@ -57,8 +59,8 @@ module ActionView
 
     include ModelNaming
 
-    JOIN = "_".freeze
-    NEW = "new".freeze
+    JOIN = "_"
+    NEW = "new"
 
     # The DOM class convention is to use the singular form of an object or class.
     #
@@ -93,7 +95,6 @@ module ActionView
     end
 
   private
-
     # Returns a string representation of the key attribute(s) that is suitable for use in an HTML DOM id.
     # This can be overwritten to customize the default generated string representation if desired.
     # If you need to read back a key from a dom_id in order to query for the underlying database record,

data/lib/action_view/renderer/abstract_renderer.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "concurrent/map"
+
 module ActionView
   # This class defines the interface for a renderer. Each class that
   # subclasses +AbstractRenderer+ is used by the base +Renderer+ class to
@@ -12,10 +16,10 @@ module ActionView
   #
   # Whenever the +render+ method is called on the base +Renderer+ class, a new
   # renderer object of the correct type is created, and the +render+ method on
-  # that new object is called in turn. This abstracts the setup and rendering
+  # that new object is called in turn. This abstracts the set up and rendering
   # into a separate classes for partials and templates.
   class AbstractRenderer #:nodoc:
-    delegate :find_template, :find_file, :template_exists?, :any_templates?, :with_fallbacks, :with_layout_format, :formats, to: :@lookup_context
+    delegate :template_exists?, :any_templates?, :formats, to: :@lookup_context
 
     def initialize(lookup_context)
       @lookup_context = lookup_context
@@ -25,22 +29,143 @@ module ActionView
       raise NotImplementedError
     end
 
-    private
+    module ObjectRendering # :nodoc:
+      PREFIXED_PARTIAL_NAMES = Concurrent::Map.new do |h, k|
+        h[k] = Concurrent::Map.new
+      end
 
-      def extract_details(options) # :doc:
-        @lookup_context.registered_details.each_with_object({}) do |key, details|
-          value = options[key]
+      def initialize(lookup_context, options)
+        super
+        @context_prefix = lookup_context.prefixes.first
+      end
+
+      private
+        def local_variable(path)
+          if as = @options[:as]
+            raise_invalid_option_as(as) unless /\A[a-z_]\w*\z/.match?(as.to_s)
+            as.to_sym
+          else
+            base = path.end_with?("/") ? "" : File.basename(path)
+            raise_invalid_identifier(path) unless base =~ /\A_?(.*?)(?:\.\w+)*\z/
+            $1.to_sym
+          end
+        end
+
+        IDENTIFIER_ERROR_MESSAGE = "The partial name (%s) is not a valid Ruby identifier; " \
+                                   "make sure your partial name starts with underscore."
+
+        OPTION_AS_ERROR_MESSAGE  = "The value (%s) of the option `as` is not a valid Ruby identifier; " \
+                                   "make sure it starts with lowercase letter, " \
+                                   "and is followed by any combination of letters, numbers and underscores."
+
+        def raise_invalid_identifier(path)
+          raise ArgumentError, IDENTIFIER_ERROR_MESSAGE % path
+        end
 
-          details[key] = Array(value) if value
+        def raise_invalid_option_as(as)
+          raise ArgumentError, OPTION_AS_ERROR_MESSAGE % as
         end
+
+        # Obtains the path to where the object's partial is located. If the object
+        # responds to +to_partial_path+, then +to_partial_path+ will be called and
+        # will provide the path. If the object does not respond to +to_partial_path+,
+        # then an +ArgumentError+ is raised.
+        #
+        # If +prefix_partial_path_with_controller_namespace+ is true, then this
+        # method will prefix the partial paths with a namespace.
+        def partial_path(object, view)
+          object = object.to_model if object.respond_to?(:to_model)
+
+          path = if object.respond_to?(:to_partial_path)
+            object.to_partial_path
+          else
+            raise ArgumentError.new("'#{object.inspect}' is not an ActiveModel-compatible object. It must implement :to_partial_path.")
+          end
+
+          if view.prefix_partial_path_with_controller_namespace
+            PREFIXED_PARTIAL_NAMES[@context_prefix][path] ||= merge_prefix_into_object_path(@context_prefix, path.dup)
+          else
+            path
+          end
+        end
+
+        def merge_prefix_into_object_path(prefix, object_path)
+          if prefix.include?(?/) && object_path.include?(?/)
+            prefixes = []
+            prefix_array = File.dirname(prefix).split("/")
+            object_path_array = object_path.split("/")[0..-3] # skip model dir & partial
+
+            prefix_array.each_with_index do |dir, index|
+              break if dir == object_path_array[index]
+              prefixes << dir
+            end
+
+            (prefixes << object_path).join("/")
+          else
+            object_path
+          end
+        end
+    end
+
+    class RenderedCollection # :nodoc:
+      def self.empty(format)
+        EmptyCollection.new format
       end
 
-      def instrument(name, **options) # :doc:
-        options[:identifier] ||= (@template && @template.identifier) || @path
+      attr_reader :rendered_templates
 
-        ActiveSupport::Notifications.instrument("render_#{name}.action_view", options) do |payload|
-          yield payload
+      def initialize(rendered_templates, spacer)
+        @rendered_templates = rendered_templates
+        @spacer = spacer
+      end
+
+      def body
+        @rendered_templates.map(&:body).join(@spacer.body).html_safe
+      end
+
+      def format
+        rendered_templates.first.format
+      end
+
+      class EmptyCollection
+        attr_reader :format
+
+        def initialize(format)
+          @format = format
         end
+
+        def body; nil; end
+      end
+    end
+
+    class RenderedTemplate # :nodoc:
+      attr_reader :body, :template
+
+      def initialize(body, template)
+        @body = body
+        @template = template
+      end
+
+      def format
+        template.format
+      end
+
+      EMPTY_SPACER = Struct.new(:body).new
+    end
+
+    private
+      NO_DETAILS = {}.freeze
+
+      def extract_details(options) # :doc:
+        details = nil
+        @lookup_context.registered_details.each do |key|
+          value = options[key]
+
+          if value
+            (details ||= {})[key] = Array(value)
+          end
+        end
+        details || NO_DETAILS
       end
 
       def prepend_formats(formats) # :doc:
@@ -49,5 +174,13 @@ module ActionView
 
         @lookup_context.formats = formats | @lookup_context.formats
       end
+
+      def build_rendered_template(content, template)
+        RenderedTemplate.new content, template
+      end
+
+      def build_rendered_collection(templates, spacer)
+        RenderedCollection.new templates, spacer
+      end
   end
 end