actionview 6.0.0.beta3 → 6.0.0.rc1

data/lib/action_view/renderer/streaming_template_renderer.rb

@@ -34,7 +34,7 @@ module ActionView
           return unless logger
 
           message = +"\n#{exception.class} (#{exception.message}):\n"
-          message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
+          message << exception.annotated_source_code.to_s if exception.respond_to?(:annotated_source_code)
           message << "  " << exception.backtrace.join("\n  ")
           logger.fatal("#{message}\n\n")
         end

data/lib/action_view/renderer/template_renderer.rb

@@ -26,7 +26,12 @@ module ActionView
         elsif options.key?(:html)
           Template::HTML.new(options[:html], formats.first)
         elsif options.key?(:file)
-          @lookup_context.with_fallbacks.find_file(options[:file], nil, false, keys, @details)
+          if File.exist?(options[:file])
+            Template::RawFile.new(options[:file])
+          else
+            ActiveSupport::Deprecation.warn "render file: should be given the absolute path to a file"
+            @lookup_context.with_fallbacks.find_template(options[:file], nil, false, keys, @details)
+          end
         elsif options.key?(:inline)
           handler = Template.handler_for_extension(options[:type] || "erb")
           format = if handler.respond_to?(:default_format)
@@ -49,14 +54,14 @@ module ActionView
       # Renders the given template. A string representing the layout can be
       # supplied as well.
       def render_template(view, template, layout_name, locals)
-        render_with_layout(view, layout_name, template, locals) do |layout|
+        render_with_layout(view, template, layout_name, locals) do |layout|
           instrument(:template, identifier: template.identifier, layout: layout.try(:virtual_path)) do
             template.render(view, locals) { |*name| view._layout_for(*name) }
           end
         end
       end
 
-      def render_with_layout(view, path, template, locals)
+      def render_with_layout(view, template, path, locals)
         layout  = path && find_layout(path, locals.keys, [formats.first])
         content = yield(layout)
 
@@ -84,6 +89,7 @@ module ActionView
         when String
           begin
             if layout.start_with?("/")
+              ActiveSupport::Deprecation.warn "Rendering layouts from an absolute path is deprecated."
               @lookup_context.with_fallbacks.find_template(layout, nil, false, [], details)
             else
               @lookup_context.find_template(layout, nil, false, [], details)

data/lib/action_view/rendering.rb

@@ -118,7 +118,8 @@ module ActionView
           renderer.render_to_object(context, options)
         end
 
-        @rendered_format = Template::Types[rendered_template.format]
+        rendered_format = rendered_template.format || lookup_context.formats.first
+        @rendered_format = Template::Types[rendered_format]
 
         rendered_template.body
       end
@@ -126,7 +127,7 @@ module ActionView
       # Assign the rendered format to look up context.
       def _process_format(format)
         super
-        lookup_context.formats = [format.to_sym]
+        lookup_context.formats = [format.to_sym] if format.to_sym
       end
 
       # Normalize args by converting render "foo" to render :action => "foo" and

data/lib/action_view/template.rb

@@ -113,51 +113,59 @@ module ActionView
 
     eager_autoload do
       autoload :Error
+      autoload :RawFile
       autoload :Handlers
       autoload :HTML
       autoload :Inline
+      autoload :Sources
       autoload :Text
       autoload :Types
     end
 
     extend Template::Handlers
 
-    attr_accessor :locals, :variants, :virtual_path
+    attr_reader :identifier, :handler, :original_encoding, :updated_at
+    attr_reader :variable, :format, :variant, :locals, :virtual_path
 
-    attr_reader :source, :identifier, :handler, :original_encoding, :updated_at
-    attr_reader :variable, :format
-
-    def initialize(source, identifier, handler, format: nil, **details)
-      unless format
-        ActiveSupport::Deprecation.warn "ActionView::Template#initialize requires a format parameter"
-        format = :html
+    def initialize(source, identifier, handler, format: nil, variant: nil, locals: nil, virtual_path: nil, updated_at: nil)
+      unless locals
+        ActiveSupport::Deprecation.warn "ActionView::Template#initialize requires a locals parameter"
+        locals = []
       end
 
       @source            = source
       @identifier        = identifier
       @handler           = handler
       @compiled          = false
-      @original_encoding = nil
-      @locals            = details[:locals] || []
-      @virtual_path      = details[:virtual_path]
+      @locals            = locals
+      @virtual_path      = virtual_path
 
       @variable = if @virtual_path
-        base = @virtual_path[-1] == "/" ? "" : File.basename(@virtual_path)
+        base = @virtual_path[-1] == "/" ? "" : ::File.basename(@virtual_path)
         base =~ /\A_?(.*?)(?:\.\w+)*\z/
         $1.to_sym
       end
 
-      @updated_at        = details[:updated_at] || Time.now
+      if updated_at
+        ActiveSupport::Deprecation.warn "ActionView::Template#updated_at is deprecated"
+        @updated_at        = updated_at
+      else
+        @updated_at        = Time.now
+      end
       @format            = format
-      @variants          = [details[:variant]]
+      @variant           = variant
       @compile_mutex     = Mutex.new
     end
 
-    def formats=(_)
-    end
-    deprecate :formats=
-
+    deprecate :original_encoding
+    deprecate :updated_at
+    deprecate def virtual_path=(_); end
+    deprecate def locals=(_); end
+    deprecate def formats=(_); end
     deprecate def formats; Array(format); end
+    deprecate def variants=(_); end
+    deprecate def variants; [variant]; end
+    deprecate def refresh(_); self; end
 
     # Returns whether the underlying handler supports streaming. If so,
     # a streaming buffer *may* be passed when it starts rendering.
@@ -174,7 +182,7 @@ module ActionView
     def render(view, locals, buffer = ActionView::OutputBuffer.new, &block)
       instrument_render_template do
         compile!(view)
-        view.run(method_name, self, locals, buffer, &block)
+        view._run(method_name, self, locals, buffer, &block)
       end
     rescue => e
       handle_render_error(view, e)
@@ -184,25 +192,6 @@ module ActionView
       @type ||= Types[format]
     end
 
-    # Receives a view object and return a template similar to self by using @virtual_path.
-    #
-    # This method is useful if you have a template object but it does not contain its source
-    # anymore since it was already compiled. In such cases, all you need to do is to call
-    # refresh passing in the view object.
-    #
-    # Notice this method raises an error if the template to be refreshed does not have a
-    # virtual path set (true just for inline templates).
-    def refresh(view)
-      raise "A template needs to have a virtual path in order to be refreshed" unless @virtual_path
-      lookup  = view.lookup_context
-      pieces  = @virtual_path.split("/")
-      name    = pieces.pop
-      partial = !!name.sub!(/^_/, "")
-      lookup.disable_cache do
-        lookup.find_template(name, [ pieces.join("/") ], partial, @locals)
-      end
-    end
-
     def short_identifier
       @short_identifier ||= defined?(Rails.root) ? identifier.sub("#{Rails.root}/", "") : identifier
     end
@@ -211,6 +200,10 @@ module ActionView
       "#<#{self.class.name} #{short_identifier} locals=#{@locals.inspect}>"
     end
 
+    def source
+      @source.to_s
+    end
+
     # This method is responsible for properly setting the encoding of the
     # source. Until this point, we assume that the source is BINARY data.
     # If no additional information is supplied, we assume the encoding is
@@ -262,11 +255,11 @@ module ActionView
     # to ensure that references to the template object can be marshalled as well. This means forgoing
     # the marshalling of the compiler mutex and instantiating that again on unmarshalling.
     def marshal_dump # :nodoc:
-      [ @source, @identifier, @handler, @compiled, @original_encoding, @locals, @virtual_path, @updated_at, @format, @variants ]
+      [ @source, @identifier, @handler, @compiled, @locals, @virtual_path, @updated_at, @format, @variant ]
     end
 
     def marshal_load(array) # :nodoc:
-      @source, @identifier, @handler, @compiled, @original_encoding, @locals, @virtual_path, @updated_at, @format, @variants = *array
+      @source, @identifier, @handler, @compiled, @locals, @virtual_path, @updated_at, @format, @variant = *array
       @compile_mutex = Mutex.new
     end
 
@@ -292,9 +285,6 @@ module ActionView
             compile(mod)
           end
 
-          # Just discard the source if we have a virtual path. This
-          # means we can get the template back.
-          @source = nil if @virtual_path
           @compiled = true
         end
       end
@@ -326,6 +316,7 @@ module ActionView
 
         # Make sure that the resulting String to be eval'd is in the
         # encoding of the code
+        original_source = source
         source = +<<-end_src
           def #{method_name}(local_assigns, output_buffer)
             @virtual_path = #{@virtual_path.inspect};#{locals_code};#{code}
@@ -346,7 +337,14 @@ module ActionView
           raise WrongEncodingError.new(source, Encoding.default_internal)
         end
 
-        mod.module_eval(source, identifier, 0)
+        begin
+          mod.module_eval(source, identifier, 0)
+        rescue SyntaxError
+          # Account for when code in the template is not syntactically valid; e.g. if we're using
+          # ERB and the user writes <%= foo( %>, attempting to call a helper `foo` and interpolate
+          # the result into the template, but missing an end parenthesis.
+          raise SyntaxErrorInTemplate.new(self, original_source)
+        end
       end
 
       def handle_render_error(view, e)
@@ -354,12 +352,7 @@ module ActionView
           e.sub_template_of(self)
           raise e
         else
-          template = self
-          unless template.source
-            template = refresh(view)
-            template.encode!
-          end
-          raise Template::Error.new(template)
+          raise Template::Error.new(self)
         end
       end
 

data/lib/action_view/template/error.rb

@@ -109,7 +109,7 @@ module ActionView
           end
       end
 
-      def annoted_source_code
+      def annotated_source_code
         source_extract(4)
       end
 
@@ -138,4 +138,24 @@ module ActionView
   end
 
   TemplateError = Template::Error
+
+  class SyntaxErrorInTemplate < TemplateError #:nodoc
+    def initialize(template, offending_code_string)
+      @offending_code_string = offending_code_string
+      super(template)
+    end
+
+    def message
+      <<~MESSAGE
+        Encountered a syntax error while rendering template: check #{@offending_code_string}
+      MESSAGE
+    end
+
+    def annotated_source_code
+      @offending_code_string.split("\n").map.with_index(1) { |line, index|
+        indentation = " " * 4
+        "#{index}:#{indentation}#{line}"
+      }
+    end
+  end
 end

data/lib/action_view/template/handlers.rb

@@ -45,12 +45,12 @@ module ActionView #:nodoc:
 
         unless params.find_all { |type, _| type == :req || type == :opt }.length >= 2
           ActiveSupport::Deprecation.warn <<~eowarn
-          Single arity template handlers are deprecated.  Template handlers must
+          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(", ")})
+            >> #{handler}.call(#{params.map(&:last).join(", ")})
           To:
-            >> #{handler.class}#call(#{params.map(&:last).join(", ")}, source)
+            >> #{handler}.call(#{params.map(&:last).join(", ")}, source)
           eowarn
           handler = LegacyHandlerWrapper.new(handler)
         end

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

@@ -25,9 +25,9 @@ module ActionView
             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)
+              class_eval("define_method(:_template) { |local_assigns, output_buffer| #{src} }", defined?(@filename) ? @filename : "(erubi)", 0)
             }.empty
-            view.run(:_template, nil, {}, ActionView::OutputBuffer.new)
+            view._run(:_template, nil, {}, ActionView::OutputBuffer.new)
           end
 
         private

data/lib/action_view/template/raw_file.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ActionView #:nodoc:
+  # = Action View RawFile Template
+  class Template #:nodoc:
+    class RawFile #:nodoc:
+      attr_accessor :type, :format
+
+      def initialize(filename)
+        @filename = filename.to_s
+        extname = ::File.extname(filename).delete(".")
+        @type = Template::Types[extname] || Template::Types[:text]
+        @format = @type.symbol
+      end
+
+      def identifier
+        @filename
+      end
+
+      def render(*args)
+        ::File.read(@filename)
+      end
+
+      def formats; Array(format); end
+      deprecate :formats
+    end
+  end
+end

data/lib/action_view/template/resolver.rb

@@ -63,26 +63,11 @@ module ActionView
 
       # 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:
-        if Resolver.caching?
-          @query_cache[query] ||= canonical_no_templates(yield)
-        else
-          yield
-        end
+        @query_cache[query] ||= canonical_no_templates(yield)
       end
 
       def clear
@@ -112,19 +97,6 @@ module ActionView
         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 }
-        end
     end
 
     cattr_accessor :caching, default: true
@@ -143,35 +115,33 @@ module ActionView
 
     # 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)
-      end
-    end
+      locals = locals.map(&:to_s).sort!.freeze
 
-    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)
+        _find_all(name, prefix, partial, details, key, locals)
       end
     end
 
+    alias :find_all_anywhere :find_all
+    deprecate :find_all_anywhere
+
     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 = false)
-      raise NotImplementedError, "Subclasses must implement a find_templates(name, prefix, partial, details, outside_app_allowed = false) 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
@@ -180,24 +150,13 @@ module ActionView
     # resolver is fresher before returning it.
     def cached(key, path_info, details, locals)
       name, prefix, partial = path_info
-      locals = locals.map(&: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)
-      cached = nil
-      templates.each do |t|
-        t.locals         = locals
-        t.variants       = details[:variants] || []      if t.variants.empty?
-        t.virtual_path ||= (cached ||= build_path(*path_info))
+        yield
       end
     end
   end
@@ -208,33 +167,60 @@ module ActionView
     DEFAULT_PATTERN = ":prefix/:action{.:locale,}{.:formats,}{+:variants,}{.:handlers,}"
 
     def initialize(pattern = nil)
-      @pattern = pattern || DEFAULT_PATTERN
+      if pattern
+        ActiveSupport::Deprecation.warn "Specifying a custom path for #{self.class} is deprecated. Implement a custom Resolver subclass instead."
+        @pattern = pattern
+      else
+        @pattern = DEFAULT_PATTERN
+      end
+      @unbound_templates = Concurrent::Map.new
+      super()
+    end
+
+    def clear_cache
+      @unbound_templates.clear
       super()
     end
 
     private
 
-      def find_templates(name, prefix, partial, details, outside_app_allowed = false)
+      def _find_all(name, prefix, partial, details, key, locals)
         path = Path.build(name, prefix, partial)
-        query(path, details, details[:formats], outside_app_allowed)
+        query(path, details, details[:formats], locals, cache: !!key)
       end
 
-      def query(path, details, formats, 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) unless outside_app_allowed
+        template_paths = reject_files_external_to_app(template_paths)
 
         template_paths.map do |template|
-          handler, format, variant = extract_handler_and_format_and_variant(template, formats.first)
-
-          FileTemplate.new(File.expand_path(template), handler,
-            virtual_path: path.virtual,
-            format: format,
-            variant: variant,
-            updated_at: mtime(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
 
+      def build_unbound_template(template, virtual_path)
+        handler, format, variant = extract_handler_and_format_and_variant(template)
+        source = Template::Sources::File.new(template)
+
+        UnboundTemplate.new(
+          source,
+          template,
+          handler,
+          virtual_path: virtual_path,
+          format: format,
+          variant: variant,
+        )
+      end
+
       def reject_files_external_to_app(files)
         files.reject { |filename| !inside_path?(@path, filename) }
       end
@@ -283,15 +269,10 @@ module ActionView
         entry.gsub(/[*?{}\[\]]/, '\\\\\\&')
       end
 
-      # Returns the file mtime from the filesystem.
-      def mtime(p)
-        File.mtime(p)
-      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, query_format)
+      def extract_handler_and_format_and_variant(path)
         pieces = File.basename(path).split(".")
         pieces.shift
 
@@ -305,54 +286,19 @@ module ActionView
           if handler.respond_to?(:default_format) # default_format can return nil
             handler.default_format
           else
-            query_format
+            nil
           end
         end
 
         # Template::Types[format] and handler.default_format can return nil
-        [handler, format || query_format, variant]
+        [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 <tt>users/new</tt> it will produce query glob: <tt>users/new{.{en},}{.{html,js},}{.{erb,haml},}</tt>
-  #
-  #   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. <tt>users/new.html</tt> will be loaded from <tt>users/html/new.erb</tt> or <tt>users/new.html.erb</tt>,
-  # <tt>users/new.js</tt> from <tt>users/js/new.erb</tt> or <tt>users/new.js.erb</tt>, 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/:action{.:locale,}{.: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
+    attr_reader :path
+
     def initialize(path, pattern = nil)
       raise ArgumentError, "path already is a Resolver class" if path.is_a?(Resolver)
       super(pattern)
@@ -372,6 +318,10 @@ module ActionView
 
   # An Optimized resolver for Rails' most common case.
   class OptimizedFileSystemResolver < FileSystemResolver #:nodoc:
+    def initialize(path)
+      super(path)
+    end
+
     private
 
       def find_template_paths_from_details(path, details)
@@ -427,12 +377,18 @@ module ActionView
   # 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