actionpack 3.0.0.beta3 → 3.0.0.beta4

data/lib/action_view/helpers/translation_helper.rb

@@ -3,17 +3,26 @@ require 'action_view/helpers/tag_helper'
 module ActionView
   module Helpers
     module TranslationHelper
-      # Delegates to I18n#translate but also performs two additional functions. First, it'll catch MissingTranslationData exceptions 
+      # Delegates to I18n#translate but also performs three additional functions. First, it'll catch MissingTranslationData exceptions
       # and turn them into inline spans that contains the missing key, such that you can see in a view what is missing where.
       #
       # Second, it'll scope the key by the current partial if the key starts with a period. So if you call translate(".foo") from the
       # people/index.html.erb template, you'll actually be calling I18n.translate("people.index.foo"). This makes it less repetitive
       # to translate many keys within the same partials and gives you a simple framework for scoping them consistently. If you don't
       # prepend the key with a period, nothing is converted.
+      #
+      # Third, it’ll mark the translation as safe HTML if the key has the suffix "_html" or the last element of the key is the word
+      # "html". For example, calling translate("footer_html") or translate("footer.html") will return a safe HTML string that won’t
+      # be escaped by other HTML helper methods. This naming convention helps to identify translations that include HTML tags so that
+      # you know what kind of output to expect when you call translate in a template.
+
       def translate(key, options = {})
-        options[:raise] = true
-        translation = I18n.translate(scope_key_by_partial(key), options)
-        (translation.respond_to?(:join) ? translation.join : translation).html_safe
+        translation = I18n.translate(scope_key_by_partial(key), options.merge!(:raise => true))
+        if html_safe_translation_key?(key) && translation.respond_to?(:html_safe)
+          translation.html_safe
+        else
+          translation
+        end
       rescue I18n::MissingTranslationData => e
         keys = I18n.normalize_keys(e.locale, e.key, e.options[:scope])
         content_tag('span', keys.join(', '), :class => 'translation_missing')
@@ -27,12 +36,10 @@ module ActionView
       alias :l :localize
 
       private
-
         def scope_key_by_partial(key)
-          strkey = key.respond_to?(:join) ? key.join : key.to_s
-          if strkey.first == "."
+          if key.to_s.first == "."
             if @_virtual_path
-              @_virtual_path.gsub(%r{/_?}, ".") + strkey
+              @_virtual_path.gsub(%r{/_?}, ".") + key.to_s
             else
               raise "Cannot use t(#{key.inspect}) shortcut because path is not available"
             end
@@ -40,6 +47,10 @@ module ActionView
             key
           end
         end
+
+        def html_safe_translation_key?(key)
+          key.to_s =~ /(\b|_|\.)html$/
+        end
     end
   end
 end

data/lib/action_view/helpers/url_helper.rb

@@ -504,7 +504,7 @@ module ActionView
           "document.write('#{content_tag("a", name || email_address_obfuscated.html_safe, html_options.merge({ "href" => "mailto:"+email_address+extras }))}');".each_byte do |c|
             string << sprintf("%%%x", c)
           end
-          "<script type=\"#{Mime::JS}\">eval(decodeURIComponent('#{string}'))</script>"
+          "<script type=\"#{Mime::JS}\">eval(decodeURIComponent('#{string}'))</script>".html_safe
         elsif encode == "hex"
           email_address_encoded = ''
           email_address_obfuscated.each_byte do |c|
@@ -596,10 +596,8 @@ module ActionView
           html_options = {} if html_options.nil?
           html_options = html_options.stringify_keys
 
-          if (options.is_a?(Hash) && options.key?('remote')) || (html_options.is_a?(Hash) && html_options.key?('remote'))
+          if (options.is_a?(Hash) && options.key?('remote') && options.delete('remote')) || (html_options.is_a?(Hash) && html_options.key?('remote') && html_options.delete('remote'))
             html_options['data-remote'] = 'true'
-            options.delete('remote') if options.is_a?(Hash)
-            html_options.delete('remote') if html_options.is_a?(Hash)
           end
 
           confirm = html_options.delete("confirm")

data/lib/action_view/locale/en.yml

@@ -102,37 +102,37 @@
       half_a_minute: "half a minute"
       less_than_x_seconds:
         one:   "less than 1 second"
-        other: "less than {{count}} seconds"
+        other: "less than %{count} seconds"
       x_seconds:
         one:   "1 second"
-        other: "{{count}} seconds"
+        other: "%{count} seconds"
       less_than_x_minutes:
         one:   "less than a minute"
-        other: "less than {{count}} minutes"
+        other: "less than %{count} minutes"
       x_minutes:
         one:   "1 minute"
-        other: "{{count}} minutes"
+        other: "%{count} minutes"
       about_x_hours:
         one:   "about 1 hour"
-        other: "about {{count}} hours"
+        other: "about %{count} hours"
       x_days:
         one:   "1 day"
-        other: "{{count}} days"
+        other: "%{count} days"
       about_x_months:
         one:   "about 1 month"
-        other: "about {{count}} months"
+        other: "about %{count} months"
       x_months:
         one:   "1 month"
-        other: "{{count}} months"
+        other: "%{count} months"
       about_x_years:
         one:   "about 1 year"
-        other: "about {{count}} years"
+        other: "about %{count} years"
       over_x_years:
         one:   "over 1 year"
-        other: "over {{count}} years"
+        other: "over %{count} years"
       almost_x_years:
         one:   "almost 1 year"
-        other: "almost {{count}} years"
+        other: "almost %{count} years"
     prompts:
       year:   "Year"
       month:  "Month"
@@ -148,7 +148,7 @@
 
     # Default translation keys for submit FormHelper
     submit:
-      create: 'Create {{model}}'
-      update: 'Update {{model}}'
-      submit: 'Save {{model}}'
+      create: 'Create %{model}'
+      update: 'Update %{model}'
+      submit: 'Save %{model}'
 

data/lib/action_view/lookup_context.rb

@@ -13,8 +13,13 @@ module ActionView
     mattr_accessor :registered_details
     self.registered_details = []
 
+    mattr_accessor :registered_detail_setters
+    self.registered_detail_setters = []
+
     def self.register_detail(name, options = {}, &block)
       self.registered_details << name
+      self.registered_detail_setters << [name, "#{name}="]
+
       Accessors.send :define_method, :"_#{name}_defaults", &block
       Accessors.module_eval <<-METHOD, __FILE__, __LINE__ + 1
         def #{name}
@@ -23,12 +28,7 @@ module ActionView
 
         def #{name}=(value)
           value = Array.wrap(value.presence || _#{name}_defaults)
-
-          if value != @details[:#{name}]
-            @details_key = nil
-            @details = @details.dup if @details.frozen?
-            @details[:#{name}] = value.freeze
-          end
+          _set_detail(:#{name}, value) if value != @details[:#{name}]
         end
       METHOD
     end
@@ -59,8 +59,11 @@ module ActionView
     def initialize(view_paths, details = {})
       @details, @details_key = { :handlers => default_handlers }, nil
       @frozen_formats, @skip_default_locale = false, false
+
       self.view_paths = view_paths
-      self.update_details(details, true)
+      self.registered_detail_setters.each do |key, setter|
+        send(setter, details[key])
+      end
     end
 
     module ViewPaths
@@ -116,11 +119,11 @@ module ActionView
       end
 
       def default_handlers #:nodoc:
-        @default_handlers ||= Template::Handlers.extensions
+        @@default_handlers ||= Template::Handlers.extensions
       end
 
       def handlers_regexp #:nodoc:
-        @handlers_regexp ||= /\.(?:#{default_handlers.join('|')})$/
+        @@handlers_regexp ||= /\.(?:#{default_handlers.join('|')})$/
       end
     end
 
@@ -141,10 +144,13 @@ module ActionView
       end
 
       # Overload formats= to reject [:"*/*"] values.
-      def formats=(value)
-        value = nil    if value == [:"*/*"]
-        value << :html if value == [:js]
-        super(value)
+      def formats=(values)
+        if values && values.size == 1
+          value = values.first
+          values = nil    if value == :"*/*"
+          values << :html if value == :js
+        end
+        super(values)
       end
 
       # Do not use the default locale on template lookup.
@@ -170,24 +176,48 @@ module ActionView
         super(@skip_default_locale ? I18n.locale : _locale_defaults)
       end
 
+      # A method which only uses the first format in the formats array for layout lookup.
+      # This method plays straight with instance variables for performance reasons.
+      def with_layout_format
+        if formats.size == 1
+          yield
+        else
+          old_formats = formats
+          _set_detail(:formats, formats[0,1])
+
+          begin
+            yield
+          ensure
+            _set_detail(:formats, old_formats)
+          end
+        end
+      end
+
       # Update the details keys by merging the given hash into the current
       # details hash. If a block is given, the details are modified just during
       # the execution of the block and reverted to the previous value after.
-      def update_details(new_details, force=false)
+      def update_details(new_details)
         old_details = @details.dup
 
-        registered_details.each do |key|
-          send(:"#{key}=", new_details[key]) if force || new_details.key?(key)
+        registered_detail_setters.each do |key, setter|
+          send(setter, new_details[key]) if new_details.key?(key)
         end
 
-        if block_given?
-          begin
-            yield
-          ensure
-            @details = old_details
-          end
+        begin
+          yield
+        ensure
+          @details_key = nil
+          @details = old_details
         end
       end
+
+    protected
+
+      def _set_detail(key, value)
+        @details_key = nil
+        @details = @details.dup if @details.frozen?
+        @details[key] = value.freeze
+      end
     end
 
     include Accessors

data/lib/action_view/paths.rb

@@ -31,6 +31,7 @@ module ActionView #:nodoc:
 
     def typecast!
       each_with_index do |path, i|
+        path = path.to_s if path.is_a?(Pathname)
         next unless path.is_a?(String)
         self[i] = FileSystemResolver.new(path)
       end

data/lib/action_view/render/layouts.rb

@@ -57,15 +57,11 @@ module ActionView
     # This is the method which actually finds the layout using details in the lookup
     # context object. If no layout is found, it checkes if at least a layout with
     # the given name exists across all details before raising the error.
-    #
-    # If self.formats contains several formats, just the first one is considered in
-    # the layout lookup.
     def find_layout(layout)
       begin
-        if formats.size == 1
-          _find_layout(layout)
-        else
-          update_details(:formats => self.formats.first){ _find_layout(layout) }
+        with_layout_format do
+          layout =~ /^\// ?
+            with_fallbacks { find_template(layout) } : find_template(layout)
         end
       rescue ActionView::MissingTemplate => e
         update_details(:formats => nil) do
@@ -74,11 +70,6 @@ module ActionView
       end
     end
 
-    def _find_layout(layout) #:nodoc:
-      layout =~ /^\// ?
-        with_fallbacks { find_template(layout) } : find_template(layout)
-    end
-
     # Contains the logic that actually renders the layout.
     def _render_layout(layout, locals, &block) #:nodoc:
       layout.render(self, locals){ |*name| _layout_for(*name, &block) }

data/lib/action_view/render/partials.rb

@@ -211,12 +211,12 @@ module ActionView
         identifier = ((@template = find_template) ? @template.identifier : @path)
 
         if @collection
-          ActiveSupport::Notifications.instrument("action_view.render_collection",
+          ActiveSupport::Notifications.instrument("render_collection.action_view",
             :identifier => identifier || "collection", :count => @collection.size) do
             render_collection
           end
         else
-          content = ActiveSupport::Notifications.instrument("action_view.render_partial",
+          content = ActiveSupport::Notifications.instrument("render_partial.action_view",
             :identifier => identifier) do
             render_partial
           end
@@ -241,15 +241,21 @@ module ActionView
       end
 
       def collection_with_template(template = @template)
-        segments, locals, as, template = [], @locals, @options[:as] || @template.variable_name, @template
+        segments, locals, template = [], @locals, @template
 
-        counter_name = template.counter_name
-        locals[counter_name] = -1
+        if @options[:as]
+          as = @options[:as]
+          counter = "#{as}_counter".to_sym
+        else
+          as = template.variable_name
+          counter = template.counter_name
+        end
+
+        locals[counter] = -1
 
         @collection.each do |object|
-          locals[counter_name] += 1
+          locals[counter] += 1
           locals[as] = object
-
           segments << template.render(@view, locals)
         end
 
@@ -257,13 +263,18 @@ module ActionView
       end
 
       def collection_without_template(collection_paths = @collection_paths)
-        segments, locals, as = [], @locals, @options[:as]
-        index, template = -1, nil
+        segments, locals = [], @locals
+        index, template  = -1, nil
+
+        if @options[:as]
+          as = @options[:as]
+          counter = "#{as}_counter"
+        end
 
         @collection.each_with_index do |object, i|
           template = find_template(collection_paths[i])
-          locals[template.counter_name] = (index += 1)
           locals[as || template.variable_name] = object
+          locals[counter || template.counter_name] = (index += 1)
 
           segments << template.render(@view, locals)
         end

data/lib/action_view/render/rendering.rb

@@ -52,7 +52,7 @@ module ActionView
       locals = options[:locals] || {}
       layout = find_layout(layout) if layout
 
-      ActiveSupport::Notifications.instrument("action_view.render_template",
+      ActiveSupport::Notifications.instrument("render_template.action_view",
         :identifier => template.identifier, :layout => layout.try(:virtual_path)) do
 
         content = template.render(self, locals) { |*name| _layout_for(*name) }

data/lib/action_view/template.rb

@@ -1,12 +1,92 @@
-# encoding: utf-8
-# This is so that templates compiled in this file are UTF-8
 require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/kernel/singleton_class'
 
 module ActionView
   class Template
     extend ActiveSupport::Autoload
 
+    # === Encodings in ActionView::Template
+    #
+    # ActionView::Template is one of a few sources of potential
+    # encoding issues in Rails. This is because the source for
+    # templates are usually read from disk, and Ruby (like most
+    # encoding-aware programming languages) assumes that the
+    # String retrieved through File IO is encoded in the
+    # <tt>default_external</tt> encoding. In Rails, the default
+    # <tt>default_external</tt> encoding is UTF-8.
+    #
+    # As a result, if a user saves their template as ISO-8859-1
+    # (for instance, using a non-Unicode-aware text editor),
+    # and uses characters outside of the ASCII range, their
+    # users will see diamonds with question marks in them in
+    # the browser.
+    #
+    # For the rest of this documentation, when we say "UTF-8",
+    # we mean "UTF-8 or whatever the default_internal encoding
+    # is set to". By default, it will be UTF-8.
+    #
+    # To mitigate this problem, we use a few strategies:
+    # 1. If the source is not valid UTF-8, we raise an exception
+    #    when the template is compiled to alert the user
+    #    to the problem.
+    # 2. The user can specify the encoding using Ruby-style
+    #    encoding comments in any template engine. If such
+    #    a comment is supplied, Rails will apply that encoding
+    #    to the resulting compiled source returned by the
+    #    template handler.
+    # 3. In all cases, we transcode the resulting String to
+    #    the UTF-8.
+    #
+    # This means that other parts of Rails can always assume
+    # that templates are encoded in UTF-8, even if the original
+    # source of the template was not UTF-8.
+    #
+    # From a user's perspective, the easiest thing to do is
+    # to save your templates as UTF-8. If you do this, you
+    # do not need to do anything else for things to "just work".
+    #
+    # === Instructions for template handlers
+    #
+    # The easiest thing for you to do is to simply ignore
+    # encodings. Rails will hand you the template source
+    # as the default_internal (generally UTF-8), raising
+    # an exception for the user before sending the template
+    # to you if it could not determine the original encoding.
+    #
+    # For the greatest simplicity, you can support only
+    # UTF-8 as the <tt>default_internal</tt>. This means
+    # that from the perspective of your handler, the
+    # entire pipeline is just UTF-8.
+    #
+    # === Advanced: Handlers with alternate metadata sources
+    #
+    # If you want to provide an alternate mechanism for
+    # specifying encodings (like ERB does via <%# encoding: ... %>),
+    # you may indicate that you will handle encodings yourself
+    # by implementing <tt>self.handles_encoding?</tt>
+    # on your handler.
+    #
+    # If you do, Rails will not try to encode the String
+    # into the default_internal, passing you the unaltered
+    # bytes tagged with the assumed encoding (from
+    # default_external).
+    #
+    # In this case, make sure you return a String from
+    # your handler encoded in the default_internal. Since
+    # you are handling out-of-band metadata, you are
+    # also responsible for alerting the user to any
+    # problems with converting the user's data to
+    # the default_internal.
+    #
+    # To do so, simply raise the raise WrongEncodingError
+    # as follows:
+    #
+    #     raise WrongEncodingError.new(
+    #       problematic_string,
+    #       expected_encoding
+    #     )
+
     eager_autoload do
       autoload :Error
       autoload :Handler
@@ -16,20 +96,22 @@ module ActionView
 
     extend Template::Handlers
 
-    attr_reader :source, :identifier, :handler, :virtual_path, :formats
+    attr_reader :source, :identifier, :handler, :virtual_path, :formats,
+                :original_encoding
 
-    Finalizer = proc do |method_name|
+    Finalizer = proc do |method_name, mod|
       proc do
-        ActionView::CompiledTemplates.module_eval do
+        mod.module_eval do
           remove_possible_method method_name
         end
       end
     end
 
     def initialize(source, identifier, handler, details)
-      @source     = source
-      @identifier = identifier
-      @handler    = handler
+      @source             = source
+      @identifier         = identifier
+      @handler            = handler
+      @original_encoding  = nil
 
       @virtual_path = details[:virtual_path]
       @method_names = {}
@@ -41,8 +123,14 @@ module ActionView
     def render(view, locals, &block)
       # Notice that 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.
-      ActiveSupport::Notifications.instrument("action_view.render_template!", :virtual_path => @virtual_path) do
-        method_name = compile(locals, view)
+      ActiveSupport::Notifications.instrument("!render_template.action_view", :virtual_path => @virtual_path) do
+        if view.is_a?(ActionView::CompiledTemplates)
+          mod = ActionView::CompiledTemplates
+        else
+          mod = view.singleton_class
+        end
+
+        method_name = compile(locals, view, mod)
         view.send(method_name, locals, &block)
       end
     rescue Exception => e
@@ -50,7 +138,7 @@ module ActionView
         e.sub_template_of(self)
         raise e
       else
-        raise Template::Error.new(self, view.assigns, e)
+        raise Template::Error.new(self, view.respond_to?(:assigns) ? view.assigns : {}, e)
       end
     end
 
@@ -75,37 +163,95 @@ module ActionView
     end
 
     private
-      def compile(locals, view)
+      # Among other things, 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 the same as Encoding.default_external.
+      #
+      # The user can also specify the encoding via a comment on the first
+      # line of the template (# encoding: NAME-OF-ENCODING). This will work
+      # with any template engine, as we process out the encoding comment
+      # before passing the source on to the template engine, leaving a
+      # blank line in its stead.
+      #
+      # If the template engine handles encodings, we send the encoded
+      # String to the engine without further processing. This allows
+      # the template engine to support additional mechanisms for
+      # specifying the encoding. For instance, ERB supports <%# encoding: %>
+      #
+      # Otherwise, after we figure out the correct encoding, we then
+      # encode the source into Encoding.default_internal. In general,
+      # this means that templates will be UTF-8 inside of Rails,
+      # regardless of the original source encoding.
+      def compile(locals, view, mod)
         method_name = build_method_name(locals)
         return method_name if view.respond_to?(method_name)
 
         locals_code = locals.keys.map! { |key| "#{key} = local_assigns[:#{key}];" }.join
 
-        code = @handler.call(self)
-        if code.sub!(/\A(#.*coding.*)\n/, '')
-          encoding_comment = $1
-        elsif defined?(Encoding) && Encoding.respond_to?(:default_external)
-          encoding_comment = "#coding:#{Encoding.default_external}"
+        if source.encoding_aware?
+          # Look for # encoding: *. If we find one, we'll encode the
+          # String in that encoding, otherwise, we'll use the
+          # default external encoding.
+          if source.sub!(/\A#{ENCODING_FLAG}/, '')
+            encoding = magic_encoding = $1
+          else
+            encoding = Encoding.default_external
+          end
+
+          # Tag the source with the default external encoding
+          # or the encoding specified in the file
+          source.force_encoding(encoding)
+
+          # If the user didn't specify an encoding, and the handler
+          # handles encodings, we simply pass the String as is to
+          # the handler (with the default_external tag)
+          if !magic_encoding && @handler.respond_to?(:handles_encoding?) && @handler.handles_encoding?
+            source
+          # Otherwise, if the String is valid in the encoding,
+          # encode immediately to default_internal. This means
+          # that if a handler doesn't handle encodings, it will
+          # always get Strings in the default_internal
+          elsif source.valid_encoding?
+            source.encode!
+          # Otherwise, since the String is invalid in the encoding
+          # specified, raise an exception
+          else
+            raise WrongEncodingError.new(source, encoding)
+          end
         end
 
+        code = @handler.call(self)
+
+        # Make sure that the resulting String to be evalled is in the
+        # encoding of the code
         source = <<-end_src
           def #{method_name}(local_assigns)
-            _old_virtual_path, @_virtual_path = @_virtual_path, #{@virtual_path.inspect};_old_output_buffer = output_buffer;#{locals_code};#{code}
+            _old_virtual_path, @_virtual_path = @_virtual_path, #{@virtual_path.inspect};_old_output_buffer = @output_buffer;#{locals_code};#{code}
           ensure
-            @_virtual_path, self.output_buffer = _old_virtual_path, _old_output_buffer
+            @_virtual_path, @output_buffer = _old_virtual_path, _old_output_buffer
           end
         end_src
 
-        if encoding_comment
-          source = "#{encoding_comment}\n#{source}"
-          line = -1
-        else
-          line = 0
+        if source.encoding_aware?
+          # Make sure the source is in the encoding of the returned code
+          source.force_encoding(code.encoding)
+
+          # In case we get back a String from a handler that is not in
+          # BINARY or the default_internal, encode it to the default_internal
+          source.encode!
+
+          # Now, validate that the source we got back from the template
+          # handler is valid in the default_internal. This is for handlers
+          # that handle encoding but screw up
+          unless source.valid_encoding?
+            raise WrongEncodingError.new(@source, Encoding.default_internal)
+          end
         end
 
         begin
-          ActionView::CompiledTemplates.module_eval(source, identifier, line)
-          ObjectSpace.define_finalizer(self, Finalizer[method_name])
+          mod.module_eval(source, identifier, 0)
+          ObjectSpace.define_finalizer(self, Finalizer[method_name, mod])
 
           method_name
         rescue Exception => e # errors from template code