actionpack 3.2.19 → 4.0.0

data/lib/action_view/template/error.rb

@@ -1,4 +1,3 @@
-require "active_support/core_ext/array/wrap"
 require "active_support/core_ext/enumerable"
 
 module ActionView
@@ -9,13 +8,16 @@ module ActionView
   class EncodingError < StandardError #:nodoc:
   end
 
+  class MissingRequestError < StandardError #:nodoc:
+  end
+
   class WrongEncodingError < EncodingError #:nodoc:
     def initialize(string, encoding)
       @string, @encoding = string, encoding
     end
 
     def message
-      @string.force_encoding("BINARY")
+      @string.force_encoding(Encoding::ASCII_8BIT)
       "Your template was not saved as valid #{@encoding}. Please " \
       "either specify #{@encoding} as the encoding for your template " \
       "in your text editor, or mark the template with its " \
@@ -30,7 +32,7 @@ module ActionView
 
     def initialize(paths, path, prefixes, partial, details, *)
       @path = path
-      prefixes = Array.wrap(prefixes)
+      prefixes = Array(prefixes)
       template_type = if partial
         "partial"
       elsif path =~ /layouts/i
@@ -56,9 +58,9 @@ module ActionView
 
       attr_reader :original_exception, :backtrace
 
-      def initialize(template, assigns, original_exception)
+      def initialize(template, original_exception)
         super(original_exception.message)
-        @template, @assigns, @original_exception = template, assigns.dup, original_exception
+        @template, @original_exception = template, original_exception
         @sub_templates = nil
         @backtrace = original_exception.backtrace
       end
@@ -76,7 +78,7 @@ module ActionView
         end
       end
 
-      def source_extract(indentation = 0)
+      def source_extract(indentation = 0, output = :console)
         return unless num = line_number
         num = num.to_i
 
@@ -85,14 +87,10 @@ module ActionView
         start_on_line = [ num - SOURCE_CODE_RADIUS - 1, 0 ].max
         end_on_line   = [ num + SOURCE_CODE_RADIUS - 1, source_code.length].min
 
-        indent = ' ' * indentation
-        line_counter = start_on_line
+        indent = end_on_line.to_s.size + indentation
         return unless source_code = source_code[start_on_line..end_on_line]
 
-        source_code.sum do |line|
-          line_counter += 1
-          "#{indent}#{line_counter}: #{line}\n"
-        end
+        formatted_code_for(source_code, start_on_line, indent, output)
       end
 
       def sub_template_of(template_path)
@@ -121,6 +119,18 @@ module ActionView
             'in '
           end + file_name
         end
+
+        def formatted_code_for(source_code, line_counter, indent, output)
+          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]
+            end
+          end
+        end
     end
   end
 

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

@@ -3,7 +3,7 @@ module ActionView
     class Builder
       # Default format used by Builder.
       class_attribute :default_format
-      self.default_format = Mime::XML
+      self.default_format = :xml
 
       def call(template)
         require_engine

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

@@ -1,5 +1,4 @@
 require 'action_dispatch/http/mime_type'
-require 'active_support/core_ext/class/attribute'
 require 'erubis'
 
 module ActionView
@@ -7,12 +6,23 @@ module ActionView
     module Handlers
       class Erubis < ::Erubis::Eruby
         def add_preamble(src)
+          @newline_pending = 0
           src << "@output_buffer = output_buffer || ActionView::OutputBuffer.new;"
         end
 
         def add_text(src, text)
           return if text.empty?
-          src << "@output_buffer.safe_concat('" << escape_text(text) << "');"
+
+          if text == "\n"
+            @newline_pending += 1
+          else
+            src << "@output_buffer.safe_append='"
+            src << "\n" * @newline_pending if @newline_pending > 0
+            src << escape_text(text)
+            src << "';"
+
+            @newline_pending = 0
+          end
         end
 
         # Erubis toggles <%= and <%== behavior when escaping is enabled.
@@ -29,24 +39,39 @@ module ActionView
         BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/
 
         def add_expr_literal(src, code)
+          flush_newline_if_pending(src)
           if code =~ BLOCK_EXPR
             src << '@output_buffer.append= ' << code
           else
-            src << '@output_buffer.append= (' << code << ');'
+            src << '@output_buffer.append=(' << code << ');'
           end
         end
 
         def add_expr_escaped(src, code)
+          flush_newline_if_pending(src)
           if code =~ BLOCK_EXPR
             src << "@output_buffer.safe_append= " << code
           else
-            src << "@output_buffer.safe_concat((" << code << ").to_s);"
+            src << "@output_buffer.safe_append=(" << code << ");"
           end
         end
 
+        def add_stmt(src, code)
+          flush_newline_if_pending(src)
+          super
+        end
+
         def add_postamble(src)
+          flush_newline_if_pending(src)
           src << '@output_buffer.to_s'
         end
+
+        def flush_newline_if_pending(src)
+          if @newline_pending > 0
+            src << "@output_buffer.safe_append='#{"\n" * @newline_pending}';"
+            @newline_pending = 0
+          end
+        end
       end
 
       class ERB
@@ -78,27 +103,23 @@ module ActionView
         end
 
         def call(template)
-          if template.source.encoding_aware?
-            # First, convert to BINARY, so in case the encoding is
-            # wrong, we can still find an encoding tag
-            # (<%# encoding %>) inside the String using a regular
-            # expression
-            template_source = template.source.dup.force_encoding("BINARY")
+          # First, convert to BINARY, so in case the encoding is
+          # wrong, we can still find an encoding tag
+          # (<%# encoding %>) inside the String using a regular
+          # expression
+          template_source = template.source.dup.force_encoding(Encoding::ASCII_8BIT)
 
-            erb = template_source.gsub(ENCODING_TAG, '')
-            encoding = $2
+          erb = template_source.gsub(ENCODING_TAG, '')
+          encoding = $2
 
-            erb.force_encoding valid_encoding(template.source.dup, encoding)
+          erb.force_encoding valid_encoding(template.source.dup, encoding)
 
-            # Always make sure we return a String in the default_internal
-            erb.encode!
-          else
-            erb = template.source.dup
-          end
+          # Always make sure we return a String in the default_internal
+          erb.encode!
 
           self.class.erb_implementation.new(
             erb,
-            :escape => (self.class.escape_whitelist.include? template.mime_type),
+            :escape => (self.class.escape_whitelist.include? template.type),
             :trim => (self.class.erb_trim_mode == "-")
           ).src
         end

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

@@ -0,0 +1,11 @@
+module ActionView
+  module Template::Handlers
+    class Raw
+      def call(template)
+        escaped = template.source.gsub(':', '\:')
+
+        '%q:' + escaped + ':;'
+      end
+    end
+  end
+end

data/lib/action_view/template/handlers.rb

@@ -4,10 +4,13 @@ module ActionView #:nodoc:
     module Handlers #:nodoc:
       autoload :ERB, 'action_view/template/handlers/erb'
       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_template_handler :builder, Builder.new
+        base.register_template_handler :raw, Raw.new
+        base.register_template_handler :ruby, :source.to_proc
       end
 
       @@template_handlers = {}
@@ -17,15 +20,15 @@ module ActionView #:nodoc:
         @@template_extensions ||= @@template_handlers.keys
       end
 
-      # Register a class that knows how to handle template files with the given
-      # extension. This can be used to implement new template types.
-      # The constructor for the class must take the ActiveView::Base instance
-      # as a parameter, and the class must implement a +render+ method that
-      # takes the contents of the template to render as well as the Hash of
-      # local assigns available to the template. The +render+ method ought to
-      # return the rendered template as a string.
-      def register_template_handler(extension, klass)
-        @@template_handlers[extension.to_sym] = klass
+      # Register an object that knows how to handle template files with the given
+      # extensions. This can be used to implement new template types.
+      # The handler must respond to `:call`, which will be passed the template
+      # and should return the rendered template as a String.
+      def register_template_handler(*extensions, handler)
+        raise(ArgumentError, "Extension is required") if extensions.empty?
+        extensions.each do |extension|
+          @@template_handlers[extension.to_sym] = handler
+        end
         @@template_extensions = nil
       end
 

data/lib/action_view/template/resolver.rb

@@ -1,13 +1,15 @@
 require "pathname"
 require "active_support/core_ext/class"
-require "active_support/core_ext/io"
+require "active_support/core_ext/class/attribute_accessors"
 require "action_view/template"
+require "thread"
+require "thread_safe"
 
 module ActionView
   # = Action View Resolver
   class Resolver
     # Keeps all information about view path and builds virtual path.
-    class Path < String
+    class Path
       attr_reader :name, :prefix, :partial, :virtual
       alias_method :partial?, :partial
 
@@ -19,8 +21,76 @@ module ActionView
       end
 
       def initialize(name, prefix, partial, virtual)
-        @name, @prefix, @partial = name, prefix, partial
-        super(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 }
       end
     end
 
@@ -32,15 +102,14 @@ module ActionView
     end
 
     def initialize
-      @cached = Hash.new { |h1,k1| h1[k1] = Hash.new { |h2,k2|
-        h2[k2] = Hash.new { |h3,k3| h3[k3] = Hash.new { |h4,k4| h4[k4] = {} } } } }
+      @cache = Cache.new
     end
 
     def clear_cache
-      @cached.clear
+      @cache.clear
     end
 
-    # Normalizes the arguments and passes it on to find_template.
+    # 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)
@@ -49,7 +118,7 @@ module ActionView
 
   private
 
-    delegate :caching?, :to => "self.class"
+    delegate :caching?, to: :class
 
     # This is what child classes implement. No defaults are needed
     # because Resolver guarantees that the arguments are present and
@@ -65,27 +134,18 @@ module ActionView
 
     # 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 check if the resolver is fresher
-    # before returning it.
+    # 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 && caching?
-        @cached[key][name][prefix][partial][locals] ||= decorate(yield, path_info, details, locals)
-      else
-        fresh = decorate(yield, path_info, details, locals)
-        return fresh unless key
-
-        scope = @cached[key][name][prefix][partial]
-        cache = scope[locals]
-        mtime = cache && cache.map(&:updated_at).max
-
-        if !mtime || fresh.empty?  || fresh.any? { |t| t.updated_at > mtime }
-          scope[locals] = fresh
-        else
-          cache
+      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
 
@@ -120,7 +180,13 @@ module ActionView
     def query(path, details, formats)
       query = build_query(path, details)
 
-      template_paths = find_template_paths query
+      # deals with case-insensitive file systems.
+      sanitizer = Hash.new { |h,dir| h[dir] = Dir["#{dir}/*"] }
+
+      template_paths = Dir[query].reject { |filename|
+        File.directory?(filename) ||
+          !sanitizer[File.dirname(filename)].include?(filename)
+      }
 
       template_paths.map { |template|
         handler, format = extract_handler_and_format(template, formats)
@@ -133,26 +199,6 @@ module ActionView
       }
     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)
-        }
-      end
-    end
-
     # Helper for building query glob string based on resolver's pattern.
     def build_query(path, details)
       query = @pattern.dup
@@ -185,13 +231,21 @@ module ActionView
     def extract_handler_and_format(path, default_formats)
       pieces = File.basename(path).split(".")
       pieces.shift
-      handler = Template.handler_for_extension(pieces.pop)
-      format  = pieces.last && Mime[pieces.last]
+
+      extension = pieces.pop
+      unless extension
+        message = "The file #{path} did not specify a template handler. The default is currently ERB, " \
+                  "but will change to RAW in the future."
+        ActiveSupport::Deprecation.warn message
+      end
+
+      handler = Template.handler_for_extension(extension)
+      format  = pieces.last && Template::Types[pieces.last]
       [handler, format]
     end
   end
 
-  # A resolver that loads files from the filesystem. It allows to set your own
+  # 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
@@ -201,13 +255,13 @@ module ActionView
   #
   #   FileSystemResolver.new("/path/to/views", ":prefix/:action{.:locale,}{.:formats,}{.:handlers,}")
   #
-  # This one allows you to keep files with different formats in seperated subdirectories,
+  # 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,}{.:handlers,}")
   #
-  # If you don't specify pattern then the default will be used.
+  # 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:
@@ -219,10 +273,10 @@ module ActionView
   #
   # ==== Pattern format and variables
   #
-  # Pattern have to be a valid glob string, and it allows you to use the
+  # Pattern has to be a valid glob string, and it allows you to use the
   # following variables:
   #
-  # * <tt>:prefix</tt> - usualy the controller path
+  # * <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...)

data/lib/action_view/template/text.rb

@@ -1,13 +1,13 @@
 module ActionView #:nodoc:
   # = Action View Text Template
   class Template
-    class Text < String #:nodoc:
-      attr_accessor :mime_type
+    class Text #:nodoc:
+      attr_accessor :type
 
-      def initialize(string, mime_type = nil)
-        super(string.to_s)
-        @mime_type   = Mime[mime_type] || mime_type if mime_type
-        @mime_type ||= Mime::TEXT
+      def initialize(string, type = nil)
+        @string = string.to_s
+        @type   = Types[type] || type if type
+        @type ||= Types[:text]
       end
 
       def identifier
@@ -18,12 +18,16 @@ module ActionView #:nodoc:
         'text template'
       end
 
+      def to_str
+        @string
+      end
+
       def render(*args)
-        to_s
+        to_str
       end
 
       def formats
-        [@mime_type.respond_to?(:ref) ? @mime_type.ref : @mime_type.to_s]
+        [@type.to_sym]
       end
     end
   end

data/lib/action_view/template/types.rb

@@ -0,0 +1,57 @@
+require 'set'
+require 'active_support/core_ext/class/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
+
+        def self.[](type)
+          return type if type.is_a?(self)
+
+          if type.is_a?(Symbol) || types.member?(type.to_s)
+            new(type)
+          end
+        end
+
+        attr_reader :symbol
+
+        def initialize(symbol)
+          @symbol = symbol.to_sym
+        end
+
+        delegate :to_s, :to_sym, :to => :symbol
+        alias to_str to_s
+
+        def ref
+          to_sym || to_s
+        end
+
+        def ==(type)
+          return false if type.blank?
+          symbol.to_sym == type.to_sym
+        end
+      end
+
+      cattr_accessor :type_klass
+
+      def self.delegate_to(klass)
+        self.type_klass = klass
+      end
+
+      delegate_to Type
+
+      def self.[](type)
+        type_klass[type]
+      end
+    end
+  end
+end