Initial

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@4 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

1 files changed, 111 insertions, 0 deletions

diff --git a/actionpack/lib/action_view/helpers/text_helper.rb b/actionpack/lib/action_view/helpers/text_helper.rb
new file mode 100644
index 0000000000..7e05e468b8
--- /dev/null
+++ b/actionpack/lib/action_view/helpers/text_helper.rb
@@ -0,0 +1,111 @@
+module ActionView
+  module Helpers #:nodoc:
+    # Provides a set of methods for working with text strings that can help unburden the level of inline Ruby code in the
+    # templates. In the example below we iterate over a collection of posts provided to the template and prints each title 
+    # after making sure it doesn't run longer than 20 characters:
+    #   <% for post in @posts %>
+    #     Title: <%= truncate(post.title, 20) %>
+    #   <% end %>
+    module TextHelper
+      # The regular puts and print are outlawed in eRuby. It's recommended to use the <%= "hello" %> form instead of print "hello".
+      # If you absolutely must use a method-based output, you can use concat. It's use like this <% concat "hello", binding %>. Notice that
+      # it doesn't have an equal sign in front. Using <%= concat "hello" %> would result in a double hello.
+      def concat(string, binding)
+        eval("_erbout", binding).concat(string)
+      end
+
+      # Truncates +text+ to the length of +length+ and replaces the last three characters with the +truncate_string+
+      # if the +text+ is longer than +length+.
+      def truncate(text, length = 30, truncate_string = "...")
+        if text.nil? then return end
+        if text.length > length then text[0..(length - 3)] + truncate_string else text end
+      end
+
+      # Highlights the +phrase+ where it is found in the +text+ by surrounding it like
+      # <strong class="highlight">I'm a highlight phrase</strong>. The highlighter can be specialized by
+      # passing +highlighter+ as single-quoted string with \1 where the phrase is supposed to be inserted.
+      # N.B.: The +phrase+ is sanitized to include only letters, digits, and spaces before use.
+      def highlight(text, phrase, highlighter = '<strong class="highlight">\1</strong>')
+        if text.nil? || phrase.nil? then return end
+        text.gsub(/(#{escape_regexp(phrase)})/i, highlighter) unless text.nil?
+      end
+      
+      # Extracts an excerpt from the +text+ surrounding the +phrase+ with a number of characters on each side determined
+      # by +radius+. If the phrase isn't found, nil is returned. Ex: 
+      #   excerpt("hello my world", "my", 3) => "...lo my wo..."
+      def excerpt(text, phrase, radius = 100, excerpt_string = "...")
+        if text.nil? || phrase.nil? then return end
+        phrase = escape_regexp(phrase)
+        
+        if found_pos = text =~ /(#{phrase})/i
+          start_pos = [ found_pos - radius, 0 ].max
+          end_pos   = [ found_pos + phrase.length + radius, text.length ].min
+
+          prefix  = start_pos > 0 ? excerpt_string : ""
+          postfix = end_pos < text.length ? excerpt_string : ""
+
+          prefix + text[start_pos..end_pos].strip + postfix
+        else
+          nil
+        end
+      end
+
+      # Attempts to pluralize the +singular+ word unless +count+ is 1. See source for pluralization rules.
+      def pluralize(count, singular, plural = nil)
+         "#{count} " + if count == 1
+          singular
+        elsif plural
+          plural
+        elsif Object.const_defined?("Inflector")
+          Inflector.pluralize(singular)
+        else 
+          singular + "s"
+        end
+      end
+
+      begin
+        require "redcloth"
+
+        # Returns the text with all the Textile codes turned into HTML-tags. 
+        # <i>This method is only available if RedCloth can be required</i>.
+        def textilize(text)
+          RedCloth.new(text).to_html
+        end
+
+        # Returns the text with all the Textile codes turned into HTML-tags, but without the regular bounding <p> tag. 
+        # <i>This method is only available if RedCloth can be required</i>.
+        def textilize_without_paragraph(text)
+          textiled = textilize(text)
+          if textiled[0..2] == "<p>" then textiled = textiled[3..-1] end
+          if textiled[-4..-1] == "</p>" then textiled = textiled[0..-5] end
+          return textiled
+        end
+      rescue LoadError
+        # We can't really help what's not there
+      end
+
+      begin
+        require "bluecloth"
+
+        # Returns the text with all the Markdown codes turned into HTML-tags. 
+        # <i>This method is only available if BlueCloth can be required</i>.
+        def markdown(text)
+          BlueCloth.new(text).to_html
+        end
+      rescue LoadError
+        # We can't really help what's not there
+      end
+
+      # Turns all links into words, like "<a href="something">else</a>" to "else".
+      def strip_links(text)
+        text.gsub(/<a.*>(.*)<\/a>/m, '\1')
+      end
+      
+      private
+        # Returns a version of the text that's safe to use in a regular expression without triggering engine features.
+        def escape_regexp(text)
+          text.gsub(/([\\|?+*\/\)\(])/) { |m| "\\#{$1}" }
+        end
+    end
+  end
+end
\ No newline at end of file