actionpack 3.2.19 → 4.0.0

data/lib/action_view/helpers/text_helper.rb

@@ -1,5 +1,5 @@
-require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/filters'
+require 'active_support/core_ext/array/extract_options'
 
 module ActionView
   # = Action View Text Helpers
@@ -36,7 +36,6 @@ module ActionView
       # do not operate as expected in an eRuby code block. If you absolutely must
       # output text within a non-output code block (i.e., <% %>), you can use the concat method.
       #
-      # ==== Examples
       #   <%
       #       concat "hello"
       #       # is the equivalent of <%= "hello" %>
@@ -44,7 +43,7 @@ module ActionView
       #       if logged_in
       #         concat "Logged in!"
       #       else
-      #         concat link_to('login', :action => login)
+      #         concat link_to('login', action: :login)
       #       end
       #       # will either display "Logged in!" or a login link
       #   %>
@@ -62,128 +61,121 @@ module ActionView
       #
       # Pass a <tt>:separator</tt> to truncate +text+ at a natural break.
       #
-      # The result is not marked as HTML-safe, so will be subject to the default escaping when
-      # used in views, unless wrapped by <tt>raw()</tt>. Care should be taken if +text+ contains HTML tags
-      # or entities, because truncation may produce invalid HTML (such as unbalanced or incomplete tags).
+      # Pass a block if you want to show extra content when the text is truncated.
       #
-      # ==== Examples
+      # The result is marked as HTML-safe, but it is escaped by default, unless <tt>:escape</tt> is
+      # +false+. Care should be taken if +text+ contains HTML tags or entities, because truncation
+      # may produce invalid HTML (such as unbalanced or incomplete tags).
       #
       #   truncate("Once upon a time in a world far far away")
       #   # => "Once upon a time in a world..."
       #
-      #   truncate("Once upon a time in a world far far away", :length => 17)
+      #   truncate("Once upon a time in a world far far away", length: 17)
       #   # => "Once upon a ti..."
       #
-      #   truncate("Once upon a time in a world far far away", :length => 17, :separator => ' ')
+      #   truncate("Once upon a time in a world far far away", length: 17, separator: ' ')
       #   # => "Once upon a..."
       #
-      #   truncate("And they found that many people were sleeping better.", :length => 25, :omission => '... (continued)')
+      #   truncate("And they found that many people were sleeping better.", length: 25, omission: '... (continued)')
       #   # => "And they f... (continued)"
       #
       #   truncate("<p>Once upon a time in a world far far away</p>")
       #   # => "<p>Once upon a time in a wo..."
-      def truncate(text, options = {})
-        options.reverse_merge!(:length => 30)
-        text.truncate(options.delete(:length), options) if text
+      #
+      #   truncate("Once upon a time in a world far far away") { link_to "Continue", "#" }
+      #   # => "Once upon a time in a wo...<a href="#">Continue</a>"
+      def truncate(text, options = {}, &block)
+        if text
+          length  = options.fetch(:length, 30)
+
+          content = text.truncate(length, options)
+          content = options[:escape] == false ? content.html_safe : ERB::Util.html_escape(content)
+          content << capture(&block) if block_given? && text.length > length
+          content
+        end
       end
 
       # Highlights one or more +phrases+ everywhere in +text+ by inserting it into
       # a <tt>:highlighter</tt> string. The highlighter can be specialized by passing <tt>:highlighter</tt>
-      # as a single-quoted string with \1 where the phrase is to be inserted (defaults to
-      # '<strong class="highlight">\1</strong>')
+      # as a single-quoted string with <tt>\1</tt> where the phrase is to be inserted (defaults to
+      # '<mark>\1</mark>')
       #
-      # ==== Examples
       #   highlight('You searched for: rails', 'rails')
-      #   # => You searched for: <strong class="highlight">rails</strong>
+      #   # => You searched for: <mark>rails</mark>
       #
       #   highlight('You searched for: ruby, rails, dhh', 'actionpack')
       #   # => You searched for: ruby, rails, dhh
       #
-      #   highlight('You searched for: rails', ['for', 'rails'], :highlighter => '<em>\1</em>')
+      #   highlight('You searched for: rails', ['for', 'rails'], highlighter: '<em>\1</em>')
       #   # => You searched <em>for</em>: <em>rails</em>
       #
-      #   highlight('You searched for: rails', 'rails', :highlighter => '<a href="search?q=\1">\1</a>')
+      #   highlight('You searched for: rails', 'rails', highlighter: '<a href="search?q=\1">\1</a>')
       #   # => You searched for: <a href="search?q=rails">rails</a>
-      #
-      # You can still use <tt>highlight</tt> with the old API that accepts the
-      # +highlighter+ as its optional third parameter:
-      #   highlight('You searched for: rails', 'rails', '<a href="search?q=\1">\1</a>')     # => You searched for: <a href="search?q=rails">rails</a>
-      def highlight(text, phrases, *args)
-        options = args.extract_options!
-        unless args.empty?
-          ActiveSupport::Deprecation.warn "Calling highlight with a highlighter as an argument is deprecated. " \
-          "Please call with :highlighter => '#{args[0]}' instead.", caller
+      def highlight(text, phrases, options = {})
+        text = sanitize(text) if options.fetch(:sanitize, true)
 
-          options[:highlighter] = args[0] || '<strong class="highlight">\1</strong>'
-        end
-        options.reverse_merge!(:highlighter => '<strong class="highlight">\1</strong>')
-
-        text = sanitize(text) unless options[:sanitize] == false
         if text.blank? || phrases.blank?
           text
         else
+          highlighter = options.fetch(:highlighter, '<mark>\1</mark>')
           match = Array(phrases).map { |p| Regexp.escape(p) }.join('|')
-          text.gsub(/(#{match})(?![^<]*?>)/i, options[:highlighter])
+          text.gsub(/(#{match})(?![^<]*?>)/i, highlighter)
         end.html_safe
       end
 
       # Extracts an excerpt from +text+ that matches the first instance of +phrase+.
       # The <tt>:radius</tt> option expands the excerpt on each side of the first occurrence of +phrase+ by the number of characters
       # defined in <tt>:radius</tt> (which defaults to 100). If the excerpt radius overflows the beginning or end of the +text+,
-      # then the <tt>:omission</tt> option (which defaults to "...") will be prepended/appended accordingly. The resulting string
-      # will be stripped in any case. If the +phrase+ isn't found, nil is returned.
+      # then the <tt>:omission</tt> option (which defaults to "...") will be prepended/appended accordingly. Use the
+      # <tt>:separator</tt> option to choose the delimitation. The resulting string will be stripped in any case. If the +phrase+
+      # isn't found, nil is returned.
       #
-      # ==== Examples
-      #   excerpt('This is an example', 'an', :radius => 5)
+      #   excerpt('This is an example', 'an', radius: 5)
       #   # => ...s is an exam...
       #
-      #   excerpt('This is an example', 'is', :radius => 5)
+      #   excerpt('This is an example', 'is', radius: 5)
       #   # => This is a...
       #
       #   excerpt('This is an example', 'is')
       #   # => This is an example
       #
-      #   excerpt('This next thing is an example', 'ex', :radius => 2)
+      #   excerpt('This next thing is an example', 'ex', radius: 2)
       #   # => ...next...
       #
-      #   excerpt('This is also an example', 'an', :radius => 8, :omission => '<chop> ')
+      #   excerpt('This is also an example', 'an', radius: 8, omission: '<chop> ')
       #   # => <chop> is also an example
       #
-      # You can still use <tt>excerpt</tt> with the old API that accepts the
-      # +radius+ as its optional third and the +ellipsis+ as its
-      # optional forth parameter:
-      #   excerpt('This is an example', 'an', 5)                   # => ...s is an exam...
-      #   excerpt('This is also an example', 'an', 8, '<chop> ')   # => <chop> is also an example
-      def excerpt(text, phrase, *args)
+      #   excerpt('This is a very beautiful morning', 'very', separator: ' ', radius: 1)
+      #   # => ...a very beautiful...
+      def excerpt(text, phrase, options = {})
         return unless text && phrase
 
-        options = args.extract_options!
-        unless args.empty?
-          ActiveSupport::Deprecation.warn "Calling excerpt with radius and omission as arguments is deprecated. " \
-          "Please call with :radius => #{args[0]}#{", :omission => '#{args[1]}'" if args[1]} instead.", caller
+        separator = options.fetch(:separator, "")
+        phrase    = Regexp.escape(phrase)
+        regex     = /#{phrase}/i
 
-          options[:radius] = args[0] || 100
-          options[:omission] = args[1] || "..."
-        end
-        options.reverse_merge!(:radius => 100, :omission => "...")
+        return unless matches = text.match(regex)
+        phrase = matches[0]
 
-        phrase = Regexp.escape(phrase)
-        return unless found_pos = text.mb_chars =~ /(#{phrase})/i
+        text.split(separator).each do |value|
+          if value.match(regex)
+            regex = phrase = value
+            break
+          end
+        end
 
-        start_pos = [ found_pos - options[:radius], 0 ].max
-        end_pos   = [ [ found_pos + phrase.mb_chars.length + options[:radius] - 1, 0].max, text.mb_chars.length ].min
+        first_part, second_part = text.split(regex, 2)
 
-        prefix  = start_pos > 0 ? options[:omission] : ""
-        postfix = end_pos < text.mb_chars.length - 1 ? options[:omission] : ""
+        prefix, first_part   = cut_excerpt_part(:first, first_part, separator, options)
+        postfix, second_part = cut_excerpt_part(:second, second_part, separator, options)
 
-        prefix + text.mb_chars[start_pos..end_pos].strip + postfix
+        prefix + (first_part + separator + phrase + separator + second_part).strip + postfix
       end
 
       # Attempts to pluralize the +singular+ word unless +count+ is 1. If
       # +plural+ is supplied, it will use that when count is > 1, otherwise
-      # it will use the Inflector to determine the plural form
+      # it will use the Inflector to determine the plural form.
       #
-      # ==== Examples
       #   pluralize(1, 'person')
       #   # => 1 person
       #
@@ -196,42 +188,35 @@ module ActionView
       #   pluralize(0, 'person')
       #   # => 0 people
       def pluralize(count, singular, plural = nil)
-        "#{count || 0} " + ((count == 1 || count =~ /^1(\.0+)?$/) ? singular : (plural || singular.pluralize))
+        word = if (count == 1 || count =~ /^1(\.0+)?$/)
+          singular
+        else
+          plural || singular.pluralize
+        end
+
+        "#{count || 0} #{word}"
       end
 
       # Wraps the +text+ into lines no longer than +line_width+ width. This method
       # breaks on the first whitespace character that does not exceed +line_width+
       # (which is 80 by default).
       #
-      # ==== Examples
-      #
       #   word_wrap('Once upon a time')
       #   # => Once upon a time
       #
       #   word_wrap('Once upon a time, in a kingdom called Far Far Away, a king fell ill, and finding a successor to the throne turned out to be more trouble than anyone could have imagined...')
-      #   # => Once upon a time, in a kingdom called Far Far Away, a king fell ill, and finding\n a successor to the throne turned out to be more trouble than anyone could have\n imagined...
+      #   # => Once upon a time, in a kingdom called Far Far Away, a king fell ill, and finding\na successor to the throne turned out to be more trouble than anyone could have\nimagined...
       #
-      #   word_wrap('Once upon a time', :line_width => 8)
-      #   # => Once upon\na time
+      #   word_wrap('Once upon a time', line_width: 8)
+      #   # => Once\nupon a\ntime
       #
-      #   word_wrap('Once upon a time', :line_width => 1)
+      #   word_wrap('Once upon a time', line_width: 1)
       #   # => Once\nupon\na\ntime
-      #
-      # You can still use <tt>word_wrap</tt> with the old API that accepts the
-      # +line_width+ as its optional second parameter:
-      #   word_wrap('Once upon a time', 8)     # => Once upon\na time
-      def word_wrap(text, *args)
-        options = args.extract_options!
-        unless args.blank?
-          ActiveSupport::Deprecation.warn "Calling word_wrap with line_width as an argument is deprecated. " \
-          "Please call with :line_width => #{args[0]} instead.", caller
-
-          options[:line_width] = args[0] || 80
-        end
-        options.reverse_merge!(:line_width => 80)
+      def word_wrap(text, options = {})
+        line_width = options.fetch(:line_width, 80)
 
         text.split("\n").collect do |line|
-          line.length > options[:line_width] ? line.gsub(/(.{1,#{options[:line_width]}})(\s+|$)/, "\\1\n").strip : line
+          line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
         end * "\n"
       end
 
@@ -246,6 +231,7 @@ module ActionView
       #
       # ==== Options
       # * <tt>:sanitize</tt> - If +false+, does not sanitize +text+.
+      # * <tt>:wrapper_tag</tt> - String representing the wrapper tag, defaults to <tt>"p"</tt>
       #
       # ==== Examples
       #   my_text = "Here is some basic text...\n...with a line break."
@@ -253,27 +239,35 @@ module ActionView
       #   simple_format(my_text)
       #   # => "<p>Here is some basic text...\n<br />...with a line break.</p>"
       #
+      #   simple_format(my_text, {}, wrapper_tag: "div")
+      #   # => "<div>Here is some basic text...\n<br />...with a line break.</div>"
+      #
       #   more_text = "We want to put a paragraph...\n\n...right there."
       #
       #   simple_format(more_text)
       #   # => "<p>We want to put a paragraph...</p>\n\n<p>...right there.</p>"
       #
-      #   simple_format("Look ma! A class!", :class => 'description')
+      #   simple_format("Look ma! A class!", class: 'description')
       #   # => "<p class='description'>Look ma! A class!</p>"
       #
-      #   simple_format("<span>I'm allowed!</span> It's true.", {}, :sanitize => false)
-      #   # => "<p><span>I'm allowed!</span> It's true.</p>"
-      def simple_format(text, html_options={}, options={})
-        text = '' if text.nil?
-        text = text.dup
-        start_tag = tag('p', html_options, true)
-        text = sanitize(text) unless options[:sanitize] == false
-        text = text.to_str
-        text.gsub!(/\r\n?/, "\n")                    # \r\n and \r -> \n
-        text.gsub!(/\n\n+/, "</p>\n\n#{start_tag}")  # 2+ newline  -> paragraph
-        text.gsub!(/([^\n]\n)(?=[^\n])/, '\1<br />') # 1 newline   -> br
-        text.insert 0, start_tag
-        text.html_safe.safe_concat("</p>")
+      #   simple_format("<blink>Unblinkable.</blink>")
+      #   # => "<p>Unblinkable.</p>"
+      #
+      #   simple_format("<blink>Blinkable!</blink> It's true.", {}, sanitize: false)
+      #   # => "<p><blink>Blinkable!</span> It's true.</p>"
+      def simple_format(text, html_options = {}, options = {})
+        wrapper_tag = options.fetch(:wrapper_tag, :p)
+
+        text = sanitize(text) if options.fetch(:sanitize, true)
+        paragraphs = split_paragraphs(text)
+
+        if paragraphs.empty?
+          content_tag(wrapper_tag, nil, html_options)
+        else
+          paragraphs.map { |paragraph|
+            content_tag(wrapper_tag, paragraph, html_options, options[:sanitize])
+          }.join("\n\n").html_safe
+        end
       end
 
       # Creates a Cycle object whose _to_s_ method cycles through elements of an
@@ -285,7 +279,6 @@ module ActionView
       # and passing the name of the cycle. The current cycle string can be obtained
       # anytime using the current_cycle method.
       #
-      # ==== Examples
       #   # Alternate CSS classes for even and odd numbers...
       #   @items = [1,2,3,4]
       #   <table>
@@ -298,15 +291,15 @@ module ActionView
       #
       #
       #   # Cycle CSS classes for rows, and text colors for values within each row
-      #   @items = x = [{:first => 'Robert', :middle => 'Daniel', :last => 'James'},
-      #                {:first => 'Emily', :middle => 'Shannon', :maiden => 'Pike', :last => 'Hicks'},
-      #               {:first => 'June', :middle => 'Dae', :last => 'Jones'}]
+      #   @items = x = [{first: 'Robert', middle: 'Daniel', last: 'James'},
+      #                {first: 'Emily', middle: 'Shannon', maiden: 'Pike', last: 'Hicks'},
+      #               {first: 'June', middle: 'Dae', last: 'Jones'}]
       #   <% @items.each do |item| %>
-      #     <tr class="<%= cycle("odd", "even", :name => "row_class") -%>">
+      #     <tr class="<%= cycle("odd", "even", name: "row_class") -%>">
       #       <td>
       #         <% item.values.each do |value| %>
       #           <%# Create a named cycle "colors" %>
-      #           <span style="color:<%= cycle("red", "green", "blue", :name => "colors") -%>">
+      #           <span style="color:<%= cycle("red", "green", "blue", name: "colors") -%>">
       #             <%= value %>
       #           </span>
       #         <% end %>
@@ -315,12 +308,9 @@ module ActionView
       #    </tr>
       #  <% end %>
       def cycle(first_value, *values)
-        if (values.last.instance_of? Hash)
-          params = values.pop
-          name = params[:name]
-        else
-          name = "default"
-        end
+        options = values.extract_options!
+        name = options.fetch(:name, 'default')
+
         values.unshift(first_value)
 
         cycle = get_cycle(name)
@@ -334,7 +324,6 @@ module ActionView
       # for complex table highlighting or any other design need which requires
       # the current cycle string in more than one place.
       #
-      # ==== Example
       #   # Alternate background colors
       #   @items = [1,2,3,4]
       #   <% @items.each do |item| %>
@@ -350,14 +339,13 @@ module ActionView
       # Resets a cycle so that it starts from the first element the next time
       # it is called. Pass in +name+ to reset a named cycle.
       #
-      # ==== Example
       #   # Alternate CSS classes for even and odd numbers...
       #   @items = [[1,2,3,4], [5,6,3], [3,4,5,6,7,4]]
       #   <table>
       #   <% @items.each do |item| %>
       #     <tr class="<%= cycle("even", "odd") -%>">
       #         <% item.each do |value| %>
-      #           <span style="color:<%= cycle("#333", "#666", "#999", :name => "colors") -%>">
+      #           <span style="color:<%= cycle("#333", "#666", "#999", name: "colors") -%>">
       #             <%= value %>
       #           </span>
       #         <% end %>
@@ -421,6 +409,34 @@ module ActionView
           @_cycles = Hash.new unless defined?(@_cycles)
           @_cycles[name] = cycle_object
         end
+
+        def split_paragraphs(text)
+          return [] if text.blank?
+
+          text.to_str.gsub(/\r\n?/, "\n").split(/\n\n+/).map! do |t|
+            t.gsub!(/([^\n]\n)(?=[^\n])/, '\1<br />') || t
+          end
+        end
+
+        def cut_excerpt_part(part_position, part, separator, options)
+          return "", "" unless part
+
+          radius   = options.fetch(:radius, 100)
+          omission = options.fetch(:omission, "...")
+
+          part = part.split(separator)
+          part.delete("")
+          affix = part.size > radius ? omission : ""
+
+          part = if part_position == :first
+            drop_index = [part.length - radius, 0].max
+            part.drop(drop_index)
+          else
+            part.first(radius)
+          end
+
+          return affix, part.join(separator)
+        end
     end
   end
 end

data/lib/action_view/helpers/translation_helper.rb

@@ -1,14 +1,24 @@
 require 'action_view/helpers/tag_helper'
 require 'i18n/exceptions'
 
+module I18n
+  class ExceptionHandler
+    include Module.new {
+      def call(exception, locale, key, options)
+        exception.is_a?(MissingTranslation) && options[:rescue_format] == :html ? super.html_safe : super
+      end
+    }
+  end
+end
+
 module ActionView
   # = Action View Translation Helpers
   module Helpers
     module TranslationHelper
       # Delegates to <tt>I18n#translate</tt> but also performs three additional functions.
       #
-      # First, it will ensure that any thrown +MissingTranslation+ messages will be turned 
-      # into inline spans that:
+      # First, it'll pass the <tt>rescue_format: :html</tt> option to I18n so that any
+      # thrown +MissingTranslation+ messages will be turned into inline spans that
       #
       #   * have a "translation-missing" class set,
       #   * contain the missing key as a title attribute and
@@ -34,15 +44,8 @@ module ActionView
       # 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 = {})
-        # If the user has specified rescue_format then pass it all through, otherwise use
-        # raise and do the work ourselves
-        if options.key?(:raise) || options.key?(:rescue_format)
-          raise_error = options[:raise] || options[:rescue_format]
-        else
-          raise_error = false
-          options[:raise] = true
-        end
-
+        options.merge!(:rescue_format => :html) unless options.key?(:rescue_format)
+        options[:default] = wrap_translate_defaults(options[:default]) if options[:default]
         if html_safe_translation_key?(key)
           html_safe_options = options.dup
           options.except(*I18n::RESERVED_KEYS).each do |name, value|
@@ -56,15 +59,13 @@ module ActionView
         else
           I18n.translate(scope_key_by_partial(key), options)
         end
-      rescue I18n::MissingTranslationData => e
-        raise e if raise_error
-
-        keys = I18n.normalize_keys(e.locale, e.key, e.options[:scope])
-        content_tag('span', keys.last.to_s.titleize, :class => 'translation_missing', :title => "translation missing: #{keys.join('.')}")
       end
       alias :t :translate
 
       # Delegates to <tt>I18n.localize</tt> with no additional functionality.
+      #
+      # See http://rubydoc.info/github/svenfuchs/i18n/master/I18n/Backend/Base:localize
+      # for more information.
       def localize(*args)
         I18n.localize(*args)
       end
@@ -86,6 +87,21 @@ module ActionView
         def html_safe_translation_key?(key)
           key.to_s =~ /(\b|_|\.)html$/
         end
+
+        def wrap_translate_defaults(defaults)
+          new_defaults = []
+          defaults     = Array(defaults)
+          while key = defaults.shift
+            if key.is_a?(Symbol)
+              new_defaults << lambda { |_, options| translate key, options.merge(:default => defaults) }
+              break
+            else
+              new_defaults << key
+            end
+          end
+
+          new_defaults
+        end
     end
   end
 end