actionview 4.2.11.1 → 7.0.2.4

data/lib/action_view/template/resolver.rb

@@ -1,366 +1,205 @@
+# 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
   class Resolver
-    # Keeps all information about view path and builds virtual path.
-    class Path
-      attr_reader :name, :prefix, :partial, :virtual
-      alias_method :partial?, :partial
-
-      def self.build(name, prefix, partial)
-        virtual = ""
-        virtual << "#{prefix}/" unless prefix.empty?
-        virtual << (partial ? "_#{name}" : name)
-        new name, prefix, partial, virtual
-      end
-
-      def initialize(name, prefix, partial, virtual)
-        @name    = name
-        @prefix  = prefix
-        @partial = partial
-        @virtual = virtual
-      end
-
-      def to_str
-        @virtual
-      end
-      alias :to_s :to_str
-    end
-
-    # Threadsafe template cache
-    class Cache #:nodoc:
-      class SmallCache < ThreadSafe::Cache
-        def initialize(options = {})
-          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)}
-
-      # 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)
-      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
-      end
-
-      def clear
-        @data.clear
-      end
-
-      private
-
-      def canonical_no_templates(templates)
-        templates.empty? ? NO_TEMPLATES : templates
-      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?
-        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 }
+    Path = ActionView::TemplatePath
+    deprecate_constant :Path
+
+    class PathParser # :nodoc:
+      ParsedPath = Struct.new(:path, :details)
+
+      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)
+        path = TemplatePath.build(match[:action], match[:prefix] || "", !!match[:partial])
+        details = TemplateDetails.new(
+          match[:locale]&.to_sym,
+          match[:handler]&.to_sym,
+          match[:format]&.to_sym,
+          match[:variant]&.to_sym
+        )
+        ParsedPath.new(path, details)
       end
     end
 
-    cattr_accessor :caching
-    self.caching = true
+    cattr_accessor :caching, default: true
 
     class << self
       alias :caching? :caching
     end
 
-    def initialize
-      @cache = Cache.new
-    end
-
     def clear_cache
-      @cache.clear
     end
 
     # Normalizes the arguments and passes it on to find_templates.
-    def find_all(name, prefix=nil, partial=false, details={}, key=nil, locals=[])
-      cached(key, [name, prefix, partial], details, locals) do
-        find_templates(name, prefix, partial, details, false)
-      end
+    def find_all(name, prefix = nil, partial = false, details = {}, key = nil, locals = [])
+      _find_all(name, prefix, partial, details, key, locals)
     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 all_template_paths # :nodoc:
+      # Not implemented by default
+      []
     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)
-    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:
-      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)
-        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))
-      end
+    def find_templates(name, prefix, partial, details, locals = [])
+      raise NotImplementedError, "Subclasses must implement a find_templates(name, prefix, partial, details, locals = []) method"
     end
   end
 
-  # An abstract class that implements a Resolver with path semantics.
-  class PathResolver < Resolver #:nodoc:
-    EXTENSIONS = { :locale => ".", :formats => ".", :variants => "+", :handlers => "." }
-    DEFAULT_PATTERN = ":prefix/:action{.:locale,}{.:formats,}{+:variants,}{.:handlers,}"
+  # A resolver that loads files from the filesystem.
+  class FileSystemResolver < Resolver
+    attr_reader :path
 
-    def initialize(pattern=nil)
-      @pattern = pattern || DEFAULT_PATTERN
+    def initialize(path)
+      raise ArgumentError, "path already is a Resolver class" if path.is_a?(Resolver)
+      @unbound_templates = Concurrent::Map.new
+      @path_parser = PathParser.new
+      @path = File.expand_path(path)
       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)
-
-      template_paths = find_template_paths query
-      template_paths = reject_files_external_to_app(template_paths) unless outside_app_allowed
-
-      template_paths.map { |template|
-        handler, format, variant = extract_handler_and_format_and_variant(template, formats)
-        contents = File.binread(template)
-
-        Template.new(contents, File.expand_path(template), handler,
-          :virtual_path => path.virtual,
-          :format       => format,
-          :variant      => variant,
-          :updated_at   => mtime(template)
-        )
-      }
+    def to_s
+      @path.to_s
     end
+    alias :to_path :to_s
 
-    def reject_files_external_to_app(files)
-      files.reject { |filename| !inside_path?(@path, filename) }
+    def eql?(resolver)
+      self.class.equal?(resolver.class) && to_path == resolver.to_path
     end
+    alias :== :eql?
 
-    if RUBY_VERSION >= '2.2.0'
-      def find_template_paths(query)
-        Dir[query].reject { |filename|
-          File.directory?(filename) ||
-            # deals with case-insensitive file systems.
-            !File.fnmatch(query, filename, File::FNM_EXTGLOB)
-        }
+    def all_template_paths # :nodoc:
+      paths = template_glob("**/*")
+      paths.map do |filename|
+        filename.from(@path.size + 1).remove(/\.[^\/]*\z/)
+      end.uniq.map do |filename|
+        TemplatePath.parse(filename)
       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)
-        }
-      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
-
-      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)
+    private
+      def _find_all(name, prefix, partial, details, key, locals)
+        requested_details = key || TemplateDetails::Requested.new(**details)
+        cache = key ? @unbound_templates : Concurrent::Map.new
+
+        unbound_templates =
+          cache.compute_if_absent(TemplatePath.virtual(name, prefix, partial)) do
+            path = TemplatePath.build(name, prefix, partial)
+            unbound_templates_from_path(path)
+          end
 
-      details.each do |ext, variants|
-        query.gsub!(/\:#{ext}/, "{#{variants.compact.uniq.join(',')}}")
+        filter_and_sort_by_details(unbound_templates, requested_details).map do |unbound_template|
+          unbound_template.bind_locals(locals)
+        end
       end
 
-      File.expand_path(query, @path)
-    end
-
-    def escape_entry(entry)
-      entry.gsub(/[*?{}\[\]]/, '\\\\\\&')
-    end
+      def source_for_template(template)
+        Template::Sources::File.new(template)
+      end
 
-    # Returns the file mtime from the filesystem.
-    def mtime(p)
-      File.mtime(p)
-    end
+      def build_unbound_template(template)
+        parsed = @path_parser.parse(template.from(@path.size + 1))
+        details = parsed.details
+        source = source_for_template(template)
 
-    # 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
+        UnboundTemplate.new(
+          source,
+          template,
+          details: details,
+          virtual_path: parsed.path.virtual,
+        )
       end
 
-      handler = Template.handler_for_extension(extension)
-      format, variant = pieces.last.split(EXTENSIONS[:variants], 2) if pieces.last
-      format  &&= Template::Types[format]
+      def unbound_templates_from_path(path)
+        if path.name.include?(".")
+          return []
+        end
 
-      [handler, format, variant]
-    end
-  end
+        # Instead of checking for every possible path, as our other globs would
+        # do, scan the directory for files with the right prefix.
+        paths = template_glob("#{escape_entry(path.to_s)}*")
 
-  # 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...)
-  #
-  class FileSystemResolver < PathResolver
-    def initialize(path, pattern=nil)
-      raise ArgumentError, "path already is a Resolver class" if path.is_a?(Resolver)
-      super(pattern)
-      @path = File.expand_path(path)
-    end
+        paths.map do |path|
+          build_unbound_template(path)
+        end.select do |template|
+          # Select for exact virtual path match, including case sensitivity
+          template.virtual_path == path.virtual
+        end
+      end
 
-    def to_s
-      @path.to_s
-    end
-    alias :to_path :to_s
+      def filter_and_sort_by_details(templates, requested_details)
+        filtered_templates = templates.select do |template|
+          template.details.matches?(requested_details)
+        end
 
-    def eql?(resolver)
-      self.class.equal?(resolver.class) && to_path == resolver.to_path
-    end
-    alias :== :eql?
-  end
+        if filtered_templates.count > 1
+          filtered_templates.sort_by! do |template|
+            template.details.sort_key_for(requested_details)
+          end
+        end
 
-  # An Optimized resolver for Rails' most common case.
-  class OptimizedFileSystemResolver < FileSystemResolver #:nodoc:
-    def build_query(path, details)
-      query = escape_entry(File.join(@path, path))
+        filtered_templates
+      end
 
-      exts = EXTENSIONS.map do |ext, prefix|
-        "{#{details[ext].compact.uniq.map { |e| "#{prefix}#{e}," }.join}}"
-      end.join
+      # Safe glob within @path
+      def template_glob(glob)
+        query = File.join(escape_entry(@path), glob)
+        path_with_slash = File.join(@path, "")
 
-      query + exts
-    end
-  end
+        Dir.glob(query).filter_map do |filename|
+          filename = File.expand_path(filename)
+          next if File.directory?(filename)
+          next unless filename.start_with?(path_with_slash)
 
-  # 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:
-    def self.instances
-      [new(""), new("/")]
-    end
+          filename
+        end
+      end
 
-    def decorate(*)
-      super.each { |t| t.virtual_path = nil }
-    end
+      def escape_entry(entry)
+        entry.gsub(/[*?{}\[\]]/, '\\\\\\&')
+      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 @@
-module ActionView #:nodoc:
+# frozen_string_literal: true
+
+module ActionView # :nodoc:
   # = Action View Text Template
-  class Template
-    class Text #:nodoc:
+  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

data/lib/action_view/template/types.rb

@@ -1,23 +1,17 @@
-require 'set'
-require 'active_support/core_ext/module/attribute_accessors'
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/attribute_accessors"
 
 module ActionView
-  class Template
-    class Types
+  class Template # :nodoc:
+    module Types
       class Type
-        cattr_accessor :types
-        self.types = Set.new
-
-        def self.register(*t)
-          types.merge(t.map { |type| type.to_s })
-        end
-
-        register :html, :text, :js, :css,  :xml, :json
+        SET = Struct.new(:symbols).new([ :html, :text, :js, :css, :xml, :json ])
 
         def self.[](type)
-          return type if type.is_a?(self)
-
-          if type.is_a?(Symbol) || types.member?(type.to_s)
+          if type.is_a?(self)
+            type
+          else
             new(type)
           end
         end
@@ -28,30 +22,38 @@ module ActionView
           @symbol = symbol.to_sym
         end
 
-        delegate :to_s, :to_sym, :to => :symbol
+        def to_s
+          @symbol.to_s
+        end
         alias to_str to_s
 
         def ref
-          to_sym || to_s
+          @symbol
         end
+        alias to_sym ref
 
         def ==(type)
-          return false if type.blank?
-          symbol.to_sym == type.to_sym
+          @symbol == type.to_sym unless type.blank?
         end
       end
 
-      cattr_accessor :type_klass
+      class << self
+        attr_accessor :type_klass
 
-      def self.delegate_to(klass)
-        self.type_klass = klass
-      end
+        def delegate_to(klass)
+          self.type_klass = klass
+        end
 
-      delegate_to Type
+        def [](type)
+          type_klass[type]
+        end
 
-      def self.[](type)
-        type_klass[type]
+        def symbols
+          type_klass::SET.symbols
+        end
       end
+
+      delegate_to Type
     end
   end
 end