actionview 4.2.11 → 5.0.7

data/lib/action_view/tasks/{dependencies.rake → cache_digests.rake}

@@ -2,13 +2,13 @@ namespace :cache_digests do
   desc 'Lookup nested dependencies for TEMPLATE (like messages/show or comments/_comment.html)'
   task :nested_dependencies => :environment do
     abort 'You must provide TEMPLATE for the task to run' unless ENV['TEMPLATE'].present?
-    puts JSON.pretty_generate ActionView::Digestor.new(name: CacheDigests.template_name, finder: CacheDigests.finder).nested_dependencies
+    puts JSON.pretty_generate ActionView::Digestor.tree(CacheDigests.template_name, CacheDigests.finder).children.map(&:to_dep_map)
   end
 
   desc 'Lookup first-level dependencies for TEMPLATE (like messages/show or comments/_comment.html)'
   task :dependencies => :environment do
     abort 'You must provide TEMPLATE for the task to run' unless ENV['TEMPLATE'].present?
-    puts JSON.pretty_generate ActionView::Digestor.new(name: CacheDigests.template_name, finder: CacheDigests.finder).dependencies
+    puts JSON.pretty_generate ActionView::Digestor.tree(CacheDigests.template_name, CacheDigests.finder).children.map(&:name)
   end
 
   class CacheDigests

data/lib/action_view/template.rb

@@ -1,6 +1,7 @@
-require 'active_support/core_ext/object/try'
-require 'active_support/core_ext/kernel/singleton_class'
-require 'thread'
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/kernel/singleton_class"
+require "active_support/core_ext/module/delegation"
+require "thread"
 
 module ActionView
   # = Action View Template
@@ -87,6 +88,19 @@ module ActionView
     #       expected_encoding
     #     )
 
+    ##
+    # :method: local_assigns
+    #
+    # Returns a hash with the defined local variables.
+    #
+    # Given this sub template rendering:
+    #
+    #   <%= render "shared/header", { headline: "Welcome", person: person } %>
+    #
+    # You can use +local_assigns+ in the sub templates to access the local variables:
+    #
+    #   local_assigns[:headline] # => "Welcome"
+
     eager_autoload do
       autoload :Error
       autoload :Handlers
@@ -103,7 +117,7 @@ module ActionView
 
     # This finalizer is needed (and exactly with a proc inside another proc)
     # otherwise templates leak in development.
-    Finalizer = proc do |method_name, mod|
+    Finalizer = proc do |method_name, mod| # :nodoc:
       proc do
         mod.module_eval do
           remove_possible_method method_name
@@ -127,7 +141,7 @@ module ActionView
       @compile_mutex     = Mutex.new
     end
 
-    # Returns if the underlying handler supports streaming. If so,
+    # Returns whether the underlying handler supports streaming. If so,
     # a streaming buffer *may* be passed when it start rendering.
     def supports_streaming?
       handler.respond_to?(:supports_streaming?) && handler.supports_streaming?
@@ -140,7 +154,7 @@ module ActionView
     # we use a bang in this instrumentation because you don't want to
     # consume this in production. This is only slow if it's being listened to.
     def render(view, locals, buffer=nil, &block)
-      instrument("!render_template") do
+      instrument("!render_template".freeze) do
         compile!(view)
         view.send(method_name, locals, buffer, &block)
       end
@@ -172,7 +186,7 @@ module ActionView
     end
 
     def inspect
-      @inspect ||= defined?(Rails.root) ? identifier.sub("#{Rails.root}/", '') : identifier
+      @inspect ||= defined?(Rails.root) ? identifier.sub("#{Rails.root}/", ''.freeze) : identifier
     end
 
     # This method is responsible for properly setting the encoding of the
@@ -307,30 +321,40 @@ module ActionView
             template = refresh(view)
             template.encode!
           end
-          raise Template::Error.new(template, e)
+          raise Template::Error.new(template)
         end
       end
 
       def locals_code #:nodoc:
+        # Only locals with valid variable names get set directly. Others will
+        # still be available in local_assigns.
+        locals = @locals - Module::RUBY_RESERVED_KEYWORDS
+        locals = locals.grep(/\A@?(?![A-Z0-9])(?:[[:alnum:]_]|[^\0-\177])+\z/)
+
         # Double assign to suppress the dreaded 'assigned but unused variable' warning
-        @locals.each_with_object('') { |key, code| code << "#{key} = #{key} = local_assigns[:#{key}];" }
+        locals.each_with_object("") { |key, code| code << "#{key} = #{key} = local_assigns[:#{key}];" }
       end
 
       def method_name #:nodoc:
         @method_name ||= begin
           m = "_#{identifier_method_name}__#{@identifier.hash}_#{__id__}"
-          m.tr!('-', '_')
+          m.tr!('-'.freeze, '_'.freeze)
           m
         end
       end
 
       def identifier_method_name #:nodoc:
-        inspect.tr('^a-z_', '_')
+        inspect.tr('^a-z_'.freeze, '_'.freeze)
       end
 
       def instrument(action, &block)
         payload = { virtual_path: @virtual_path, identifier: @identifier }
-        ActiveSupport::Notifications.instrument("#{action}.action_view", payload, &block)
+        case action
+        when "!render_template".freeze
+          ActiveSupport::Notifications.instrument("!render_template.action_view".freeze, payload, &block)
+        else
+          ActiveSupport::Notifications.instrument("#{action}.action_view".freeze, payload, &block)
+        end
       end
   end
 end

data/lib/action_view/template/error.rb

@@ -59,13 +59,24 @@ module ActionView
     class Error < ActionViewError #:nodoc:
       SOURCE_CODE_RADIUS = 3
 
-      attr_reader :original_exception
+      # Override to prevent #cause resetting during re-raise.
+      attr_reader :cause
 
-      def initialize(template, original_exception)
-        super(original_exception.message)
-        @template, @original_exception = template, original_exception
-        @sub_templates = nil
-        set_backtrace(original_exception.backtrace)
+      def initialize(template, original_exception = nil)
+        if original_exception
+          ActiveSupport::Deprecation.warn("Passing #original_exception is deprecated and has no effect. " \
+                                          "Exceptions will automatically capture the original exception.", caller)
+        end
+
+        super($!.message)
+        set_backtrace($!.backtrace)
+        @cause = $!
+        @template, @sub_templates = template, nil
+      end
+
+      def original_exception
+        ActiveSupport::Deprecation.warn("#original_exception is deprecated. Use #cause instead.", caller)
+        cause
       end
 
       def file_name
@@ -75,7 +86,7 @@ module ActionView
       def sub_template_message
         if @sub_templates
           "Trace of template inclusion: " +
-          @sub_templates.collect { |template| template.inspect }.join(", ")
+          @sub_templates.collect(&:inspect).join(", ")
         else
           ""
         end
@@ -124,13 +135,13 @@ module ActionView
         end
 
         def formatted_code_for(source_code, line_counter, indent, output)
-          start_value = (output == :html) ? {} : ""
+          start_value = (output == :html) ? {} : []
           source_code.inject(start_value) do |result, line|
             line_counter += 1
             if output == :html
               result.update(line_counter.to_s => "%#{indent}s %s\n" % ["", line])
             else
-              result << "%#{indent}s: %s\n" % [line_counter, line]
+              result << "%#{indent}s: %s" % [line_counter, line]
             end
           end
         end

data/lib/action_view/template/handlers.rb

@@ -2,14 +2,16 @@ module ActionView #:nodoc:
   # = Action View Template Handlers
   class Template
     module Handlers #:nodoc:
+      autoload :Raw, 'action_view/template/handlers/raw'
       autoload :ERB, 'action_view/template/handlers/erb'
+      autoload :Html, 'action_view/template/handlers/html'
       autoload :Builder, 'action_view/template/handlers/builder'
-      autoload :Raw, 'action_view/template/handlers/raw'
 
       def self.extended(base)
-        base.register_default_template_handler :erb, ERB.new
+        base.register_default_template_handler :raw, Raw.new
+        base.register_template_handler :erb, ERB.new
+        base.register_template_handler :html, Html.new
         base.register_template_handler :builder, Builder.new
-        base.register_template_handler :raw, Raw.new
         base.register_template_handler :ruby, :source.to_proc
       end
 
@@ -42,7 +44,7 @@ module ActionView #:nodoc:
       end
 
       def template_handler_extensions
-        @@template_handlers.keys.map {|key| key.to_s }.sort
+        @@template_handlers.keys.map(&:to_s).sort
       end
 
       def registered_template_handler(extension)

data/lib/action_view/template/handlers/html.rb

@@ -0,0 +1,9 @@
+module ActionView
+  module Template::Handlers
+    class Html < Raw
+      def call(template)
+        "ActionView::OutputBuffer.new #{super}"
+      end
+    end
+  end
+end

data/lib/action_view/template/handlers/raw.rb

@@ -2,9 +2,7 @@ module ActionView
   module Template::Handlers
     class Raw
       def call(template)
-        escaped = template.source.gsub(/:/, '\:')
-
-        '%q:' + escaped + ':;'
+        "#{template.source.inspect}.html_safe;"
       end
     end
   end

data/lib/action_view/template/resolver.rb

@@ -1,10 +1,9 @@
 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
@@ -36,7 +35,7 @@ module ActionView
 
     # Threadsafe template cache
     class Cache #:nodoc:
-      class SmallCache < ThreadSafe::Cache
+      class SmallCache < Concurrent::Map
         def initialize(options = {})
           super(options.merge(:initial_capacity => 2))
         end
@@ -53,6 +52,11 @@ module ActionView
 
       def initialize
         @data = SmallCache.new(&KEY_BLOCK)
+        @query_cache = SmallCache.new
+      end
+
+      def inspect
+        "#<#{self.class.name}:0x#{(object_id << 1).to_s(16)} keys=#{@data.size} queries=#{@query_cache.size}>"
       end
 
       # Cache the templates returned by the block
@@ -71,8 +75,17 @@ module ActionView
         end
       end
 
+      def cache_query(query) # :nodoc:
+        if Resolver.caching?
+          @query_cache[query] ||= canonical_no_templates(yield)
+        else
+          yield
+        end
+      end
+
       def clear
         @data.clear
+        @query_cache.clear
       end
 
       private
@@ -113,7 +126,7 @@ 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, false)
+        find_templates(name, prefix, partial, details)
       end
     end
 
@@ -123,6 +136,10 @@ module ActionView
       end
     end
 
+    def find_all_with_query(query) # :nodoc:
+      @cache.cache_query(query) { find_template_paths(File.join(@path, query)) }
+    end
+
   private
 
     delegate :caching?, to: :class
@@ -130,8 +147,8 @@ module ActionView
     # 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"
+    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.
@@ -145,7 +162,7 @@ module ActionView
     # 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!
+      locals = locals.map(&:to_s).sort!
 
       if key
         @cache.cache(key, name, prefix, partial, locals) do
@@ -188,10 +205,10 @@ module ActionView
     def query(path, details, formats, outside_app_allowed)
       query = build_query(path, details)
 
-      template_paths = find_template_paths query
+      template_paths = find_template_paths(query)
       template_paths = reject_files_external_to_app(template_paths) unless outside_app_allowed
 
-      template_paths.map { |template|
+      template_paths.map do |template|
         handler, format, variant = extract_handler_and_format_and_variant(template, formats)
         contents = File.binread(template)
 
@@ -201,30 +218,18 @@ module ActionView
           :variant      => variant,
           :updated_at   => mtime(template)
         )
-      }
+      end
     end
 
     def reject_files_external_to_app(files)
       files.reject { |filename| !inside_path?(@path, filename) }
     end
 
-    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)
-        }
-      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 find_template_paths(query)
+      Dir[query].uniq.reject do |filename|
+        File.directory?(filename) ||
+          # deals with case-insensitive file systems.
+          !File.fnmatch(query, filename, File::FNM_EXTGLOB)
       end
     end
 
@@ -238,21 +243,25 @@ module ActionView
     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)
+      query.gsub!(/:action/, partial)
 
-      details.each do |ext, variants|
-        query.gsub!(/\:#{ext}/, "{#{variants.compact.uniq.join(',')}}")
+      details.each do |ext, candidates|
+        if ext == :variants && candidates == :any
+          query.gsub!(/:#{ext}/, "*")
+        else
+          query.gsub!(/:#{ext}/, "{#{candidates.compact.uniq.join(',')}}")
+        end
       end
 
       File.expand_path(query, @path)
     end
 
     def escape_entry(entry)
-      entry.gsub(/[*?{}\[\]]/, '\\\\\\&')
+      entry.gsub(/[*?{}\[\]]/, '\\\\\\&'.freeze)
     end
 
     # Returns the file mtime from the filesystem.
@@ -264,16 +273,10 @@ module ActionView
     # 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 = File.basename(path).split('.'.freeze)
       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
-      end
 
       handler = Template.handler_for_extension(extension)
       format, variant = pieces.last.split(EXTENSIONS[:variants], 2) if pieces.last
@@ -306,7 +309,7 @@ module ActionView
   #
   #   ActionController::Base.view_paths = FileSystemResolver.new(
   #     Rails.root.join("app/views"),
-  #     ":prefix{/:locale}/:action{.:formats,}{+:variants,}{.:handlers,}"
+  #     ":prefix/:action{.:locale,}{.:formats,}{+:variants,}{.:handlers,}",
   #   )
   #
   # ==== Pattern format and variables
@@ -345,7 +348,11 @@ module ActionView
       query = escape_entry(File.join(@path, path))
 
       exts = EXTENSIONS.map do |ext, prefix|
-        "{#{details[ext].compact.uniq.map { |e| "#{prefix}#{e}," }.join}}"
+        if ext == :variants && details[ext] == :any
+          "{#{prefix}*,}"
+        else
+          "{#{details[ext].compact.uniq.map { |e| "#{prefix}#{e}," }.join}}"
+        end
       end.join
 
       query + exts

data/lib/action_view/template/types.rb

@@ -1,23 +1,15 @@
-require 'set'
 require 'active_support/core_ext/module/attribute_accessors'
 
 module ActionView
   class Template
     class 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,16 +20,18 @@ 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
 
@@ -52,6 +46,10 @@ module ActionView
       def self.[](type)
         type_klass[type]
       end
+
+      def self.symbols
+        type_klass::SET.symbols
+      end
     end
   end
 end