actionview 4.2.11.1 → 6.1.5

data/lib/action_view/template/resolver.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require "pathname"
 require "active_support/core_ext/class"
 require "active_support/core_ext/module/attribute_accessors"
-require 'active_support/core_ext/string/filters'
 require "action_view/template"
 require "thread"
-require "thread_safe"
+require "concurrent/map"
 
 module ActionView
   # = Action View Resolver
@@ -15,7 +16,7 @@ module ActionView
       alias_method :partial?, :partial
 
       def self.build(name, prefix, partial)
-        virtual = ""
+        virtual = +""
         virtual << "#{prefix}/" unless prefix.empty?
         virtual << (partial ? "_#{name}" : name)
         new name, prefix, partial, virtual
@@ -34,69 +35,105 @@ 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 < ThreadSafe::Cache
+      class SmallCache < Concurrent::Map
         def initialize(options = {})
-          super(options.merge(:initial_capacity => 2))
+          super(options.merge(initial_capacity: 2))
         end
       end
 
-      # 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)}
+      # 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
         @data = SmallCache.new(&KEY_BLOCK)
+        @query_cache = SmallCache.new
+      end
+
+      def inspect
+        "#{to_s[0..-2]} keys=#{@data.size} queries=#{@query_cache.size}>"
       end
 
       # Cache the templates returned by the block
       def cache(key, name, prefix, partial, locals)
-        if Resolver.caching?
-          @data[key][name][prefix][partial][locals] ||= canonical_no_templates(yield)
-        else
-          fresh_templates  = yield
-          cached_templates = @data[key][name][prefix][partial][locals]
-
-          if templates_have_changed?(cached_templates, fresh_templates)
-            @data[key][name][prefix][partial][locals] = canonical_no_templates(fresh_templates)
-          else
-            cached_templates || NO_TEMPLATES
-          end
-        end
+        @data[key][name][prefix][partial][locals] ||= canonical_no_templates(yield)
+      end
+
+      def cache_query(query) # :nodoc:
+        @query_cache[query] ||= canonical_no_templates(yield)
       end
 
       def clear
         @data.clear
+        @query_cache.clear
       end
 
-      private
+      # Get the cache size. Do not call this
+      # method. This method is not guaranteed to be here ever.
+      def size # :nodoc:
+        size = 0
+        @data.each_value do |v1|
+          v1.each_value do |v2|
+            v2.each_value do |v3|
+              v3.each_value do |v4|
+                size += v4.size
+              end
+            end
+          end
+        end
 
-      def canonical_no_templates(templates)
-        templates.empty? ? NO_TEMPLATES : templates
+        size + @query_cache.size
       end
 
-      def templates_have_changed?(cached_templates, fresh_templates)
-        # if either the old or new template list is empty, we don't need to (and can't)
-        # compare modification times, and instead just check whether the lists are different
-        if cached_templates.blank? || fresh_templates.blank?
-          return fresh_templates.blank? != cached_templates.blank?
+      private
+        def canonical_no_templates(templates)
+          templates.empty? ? NO_TEMPLATES : templates
         end
-
-        cached_templates_max_updated_at = cached_templates.map(&:updated_at).max
-
-        # if a template has changed, it will be now be newer than all the cached templates
-        fresh_templates.any? { |t| t.updated_at > cached_templates_max_updated_at }
-      end
     end
 
-    cattr_accessor :caching
-    self.caching = true
+    cattr_accessor :caching, default: true
 
     class << self
       alias :caching? :caching
@@ -111,220 +148,183 @@ module ActionView
     end
 
     # Normalizes the arguments and passes it on to find_templates.
-    def find_all(name, prefix=nil, partial=false, details={}, key=nil, locals=[])
+    def find_all(name, prefix = nil, partial = false, details = {}, key = nil, locals = [])
+      locals = locals.map(&:to_s).sort!.freeze
+
       cached(key, [name, prefix, partial], details, locals) do
-        find_templates(name, prefix, partial, details, false)
+        _find_all(name, prefix, partial, details, key, locals)
       end
     end
 
-    def find_all_anywhere(name, prefix, partial=false, details={}, key=nil, locals=[])
-      cached(key, [name, prefix, partial], details, locals) do
-        find_templates(name, prefix, partial, details, true)
-      end
+    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
 
     delegate :caching?, to: :class
 
     # This is what child classes implement. No defaults are needed
     # because Resolver guarantees that the arguments are present and
     # normalized.
-    def find_templates(name, prefix, partial, details, outside_app_allowed)
-      raise NotImplementedError, "Subclasses must implement a find_templates(name, prefix, partial, details, outside_app_allowed) method"
-    end
-
-    # Helpers that builds a path. Useful for building virtual paths.
-    def build_path(name, prefix, partial)
-      Path.build(name, prefix, partial)
+    def find_templates(name, prefix, partial, details, locals = [])
+      raise NotImplementedError, "Subclasses must implement a find_templates(name, prefix, partial, details, locals = []) method"
     end
 
     # Handles templates caching. If a key is given and caching is on
     # always check the cache before hitting the resolver. Otherwise,
     # it always hits the resolver but if the key is present, check if the
     # resolver is fresher before returning it.
-    def cached(key, path_info, details, locals) #:nodoc:
+    def cached(key, path_info, details, locals)
       name, prefix, partial = path_info
-      locals = locals.map { |x| x.to_s }.sort!
 
       if key
         @cache.cache(key, name, prefix, partial, locals) do
-          decorate(yield, path_info, details, locals)
+          yield
         end
       else
-        decorate(yield, path_info, details, locals)
-      end
-    end
-
-    # Ensures all the resolver information is set in the template.
-    def decorate(templates, path_info, details, locals) #:nodoc:
-      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))
+        yield
       end
     end
   end
 
   # An abstract class that implements a Resolver with path semantics.
   class PathResolver < Resolver #:nodoc:
-    EXTENSIONS = { :locale => ".", :formats => ".", :variants => "+", :handlers => "." }
+    EXTENSIONS = { locale: ".", formats: ".", variants: "+", handlers: "." }
     DEFAULT_PATTERN = ":prefix/:action{.:locale,}{.:formats,}{+:variants,}{.:handlers,}"
 
-    def initialize(pattern=nil)
-      @pattern = pattern || DEFAULT_PATTERN
-      super()
+    def initialize
+      @pattern = DEFAULT_PATTERN
+      @unbound_templates = Concurrent::Map.new
+      @path_parser = PathParser.new
+      super
     end
 
-    private
-
-    def find_templates(name, prefix, partial, details, outside_app_allowed = false)
-      path = Path.build(name, prefix, partial)
-      query(path, details, details[:formats], outside_app_allowed)
+    def clear_cache
+      @unbound_templates.clear
+      @path_parser = PathParser.new
+      super
     end
 
-    def query(path, details, formats, outside_app_allowed)
-      query = build_query(path, details)
+    private
+      def _find_all(name, prefix, partial, details, key, locals)
+        path = Path.build(name, prefix, partial)
+        query(path, details, details[:formats], locals, cache: !!key)
+      end
 
-      template_paths = find_template_paths query
-      template_paths = reject_files_external_to_app(template_paths) unless outside_app_allowed
+      def query(path, details, formats, locals, cache:)
+        template_paths = find_template_paths_from_details(path, details)
+        template_paths = reject_files_external_to_app(template_paths)
+
+        template_paths.map do |template|
+          unbound_template =
+            if cache
+              @unbound_templates.compute_if_absent([template, path.virtual]) do
+                build_unbound_template(template, path.virtual)
+              end
+            else
+              build_unbound_template(template, path.virtual)
+            end
+
+          unbound_template.bind_locals(locals)
+        end
+      end
 
-      template_paths.map { |template|
-        handler, format, variant = extract_handler_and_format_and_variant(template, formats)
-        contents = File.binread(template)
+      def source_for_template(template)
+        Template::Sources::File.new(template)
+      end
 
-        Template.new(contents, File.expand_path(template), handler,
-          :virtual_path => path.virtual,
-          :format       => format,
-          :variant      => variant,
-          :updated_at   => mtime(template)
+      def build_unbound_template(template, virtual_path)
+        handler, format, variant = extract_handler_and_format_and_variant(template)
+        source = source_for_template(template)
+
+        UnboundTemplate.new(
+          source,
+          template,
+          handler,
+          virtual_path: virtual_path,
+          format: format,
+          variant: variant,
         )
-      }
-    end
+      end
 
-    def reject_files_external_to_app(files)
-      files.reject { |filename| !inside_path?(@path, filename) }
-    end
+      def reject_files_external_to_app(files)
+        files.reject { |filename| !inside_path?(@path, filename) }
+      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
 
-    if RUBY_VERSION >= '2.2.0'
       def find_template_paths(query)
-        Dir[query].reject { |filename|
+        Dir[query].uniq.reject do |filename|
           File.directory?(filename) ||
             # deals with case-insensitive file systems.
             !File.fnmatch(query, filename, File::FNM_EXTGLOB)
-        }
+        end
       end
-    else
-      def find_template_paths(query)
-        # deals with case-insensitive file systems.
-        sanitizer = Hash.new { |h,dir| h[dir] = Dir["#{dir}/*"] }
 
-        Dir[query].reject { |filename|
-          File.directory?(filename) ||
-            !sanitizer[File.dirname(filename)].include?(filename)
-        }
+      def inside_path?(path, filename)
+        filename = File.expand_path(filename)
+        path = File.join(path, "")
+        filename.start_with?(path)
       end
-    end
 
-    def inside_path?(path, filename)
-      filename = File.expand_path(filename)
-      path = File.join(path, '')
-      filename.start_with?(path)
-    end
+      # Helper for building query glob string based on resolver's pattern.
+      def build_query(path, details)
+        query = @pattern.dup
 
-    # Helper for building query glob string based on resolver's pattern.
-    def build_query(path, details)
-      query = @pattern.dup
+        prefix = path.prefix.empty? ? "" : "#{escape_entry(path.prefix)}\\1"
+        query.gsub!(/:prefix(\/)?/, prefix)
 
-      prefix = path.prefix.empty? ? "" : "#{escape_entry(path.prefix)}\\1"
-      query.gsub!(/\:prefix(\/)?/, prefix)
+        partial = escape_entry(path.partial? ? "_#{path.name}" : path.name)
+        query.gsub!(":action", partial)
 
-      partial = escape_entry(path.partial? ? "_#{path.name}" : path.name)
-      query.gsub!(/\:action/, partial)
+        details.each do |ext, candidates|
+          if ext == :variants && candidates == :any
+            query.gsub!(/:#{ext}/, "*")
+          else
+            query.gsub!(/:#{ext}/, "{#{candidates.compact.uniq.join(',')}}")
+          end
+        end
 
-      details.each do |ext, variants|
-        query.gsub!(/\:#{ext}/, "{#{variants.compact.uniq.join(',')}}")
+        File.expand_path(query, @path)
       end
 
-      File.expand_path(query, @path)
-    end
+      def escape_entry(entry)
+        entry.gsub(/[*?{}\[\]]/, '\\\\\\&')
+      end
 
-    def escape_entry(entry)
-      entry.gsub(/[*?{}\[\]]/, '\\\\\\&')
-    end
+      # 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)
+        details = @path_parser.parse(path)
 
-    # Returns the file mtime from the filesystem.
-    def mtime(p)
-      File.mtime(p)
-    end
+        handler = Template.handler_for_extension(details[:handler])
+        format = details[:format] || handler.try(:default_format)
+        variant = details[:variant]
 
-    # 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, default_formats)
-      pieces = File.basename(path).split(".")
-      pieces.shift
-
-      extension = pieces.pop
-      unless extension
-        ActiveSupport::Deprecation.warn(<<-MSG.squish)
-          The file #{path} did not specify a template handler. The default is
-          currently ERB, but will change to RAW in the future.
-        MSG
+        # Template::Types[format] and handler.default_format can return nil
+        [handler, format, variant]
       end
-
-      handler = Template.handler_for_extension(extension)
-      format, variant = pieces.last.split(EXTENSIONS[:variants], 2) if pieces.last
-      format  &&= Template::Types[format]
-
-      [handler, format, variant]
-    end
   end
 
-  # A resolver that loads files from the filesystem. It allows setting your own
-  # resolving pattern. Such pattern can be a glob string supported by some variables.
-  #
-  # ==== Examples
-  #
-  # Default pattern, loads views the same way as previous versions of rails, eg. when you're
-  # looking for `users/new` it will produce query glob: `users/new{.{en},}{.{html,js},}{.{erb,haml},}`
-  #
-  #   FileSystemResolver.new("/path/to/views", ":prefix/:action{.:locale,}{.:formats,}{+:variants,}{.:handlers,}")
-  #
-  # This one allows you to keep files with different formats in separate subdirectories,
-  # eg. `users/new.html` will be loaded from `users/html/new.erb` or `users/new.html.erb`,
-  # `users/new.js` from `users/js/new.erb` or `users/new.js.erb`, etc.
-  #
-  #   FileSystemResolver.new("/path/to/views", ":prefix/{:formats/,}:action{.:locale,}{.:formats,}{+:variants,}{.:handlers,}")
-  #
-  # If you don't specify a pattern then the default will be used.
-  #
-  # In order to use any of the customized resolvers above in a Rails application, you just need
-  # to configure ActionController::Base.view_paths in an initializer, for example:
-  #
-  #   ActionController::Base.view_paths = FileSystemResolver.new(
-  #     Rails.root.join("app/views"),
-  #     ":prefix{/:locale}/:action{.:formats,}{+:variants,}{.:handlers,}"
-  #   )
-  #
-  # ==== Pattern format and variables
-  #
-  # Pattern has to be a valid glob string, and it allows you to use the
-  # following variables:
-  #
-  # * <tt>:prefix</tt> - usually the controller path
-  # * <tt>:action</tt> - name of the action
-  # * <tt>:locale</tt> - possible locale versions
-  # * <tt>:formats</tt> - possible request formats (for example html, json, xml...)
-  # * <tt>:variants</tt> - possible request variants (for example phone, tablet...)
-  # * <tt>:handlers</tt> - possible handlers (for example erb, haml, builder...)
-  #
+  # A resolver that loads files from the filesystem.
   class FileSystemResolver < PathResolver
-    def initialize(path, pattern=nil)
+    attr_reader :path
+
+    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
 
@@ -341,26 +341,92 @@ 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))
+    def initialize(path)
+      super(path)
+    end
 
-      exts = EXTENSIONS.map do |ext, prefix|
-        "{#{details[ext].compact.uniq.map { |e| "#{prefix}#{e}," }.join}}"
-      end.join
+    private
+      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))}*"
 
-      query + exts
-    end
+        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)
+
+        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.
+          !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.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
+
+      def build_regex(path, details)
+        query = Regexp.escape(File.join(@path, path))
+        exts = EXTENSIONS.map do |ext, prefix|
+          match =
+            if ext == :variants && details[ext] == :any
+              ".*?"
+            else
+              arr = details[ext].compact
+              arr.uniq!
+              arr.map! { |e| Regexp.escape(e) }
+              arr.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
   # a virtual path since it is invalid for such resolvers.
   class FallbackFileSystemResolver < FileSystemResolver #:nodoc:
+    private_class_method :new
+
     def self.instances
       [new(""), new("/")]
     end
 
-    def decorate(*)
-      super.each { |t| t.virtual_path = nil }
+    def build_unbound_template(template, _)
+      super(template, nil)
+    end
+
+    def reject_files_external_to_app(files)
+      files
     end
   end
 end

data/lib/action_view/template/sources/file.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActionView
+  class Template
+    module Sources
+      class File
+        def initialize(filename)
+          @filename = filename
+        end
+
+        def to_s
+          ::File.binread @filename
+        end
+      end
+    end
+  end
+end

data/lib/action_view/template/sources.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActionView
+  class Template
+    module Sources
+      extend ActiveSupport::Autoload
+
+      eager_autoload do
+        autoload :File
+      end
+    end
+  end
+end

data/lib/action_view/template/text.rb

@@ -1,22 +1,20 @@
+# frozen_string_literal: true
+
 module ActionView #:nodoc:
   # = Action View Text Template
-  class Template
+  class Template #:nodoc:
     class Text #:nodoc:
       attr_accessor :type
 
-      def initialize(string, type = nil)
+      def initialize(string)
         @string = string.to_s
-        @type   = Types[type] || type if type
-        @type ||= Types[:text]
       end
 
       def identifier
-        'text template'
+        "text template"
       end
 
-      def inspect
-        'text template'
-      end
+      alias_method :inspect, :identifier
 
       def to_str
         @string
@@ -26,8 +24,8 @@ module ActionView #:nodoc:
         to_str
       end
 
-      def formats
-        [@type.respond_to?(:ref) ? @type.ref : @type.to_s]
+      def format
+        :text
       end
     end
   end