ramaze 2011.07.25 → 2011.10.23

data/lib/ramaze/helper/csrf.rb

@@ -17,29 +17,29 @@ module Ramaze
     # However, there's no need to panic as it's very easy to setup a basic anti
     # CSRF system.
     #
-    # == Usage
+    # ## Usage
     #
     # In order to enable CSRF protection we need to do two things. Load the
     # helper and create a before_all block in a controller. Take a look at the
     # following code:
     #
-    #  class BaseController < Ramaze::Controller
-    #    before_all do
-    #      puts "Hello, before_all!"
-    #    end
-    #  end
+    #     class BaseController < Ramaze::Controller
+    #       before_all do
+    #         puts "Hello, before_all!"
+    #       end
+    #     end
     #
     # This would output "Hello, before_all!" to the console upon each request.
     # Not very useful but it does show what the before_all block can do. On to
     # actual CSRF related code!
     #
-    #  class BaseController < Ramaze::Controller
-    #    before_all do
-    #      csrf_protection :save do
-    #        # ....
-    #      end
-    #    end
-    #  end
+    #     class BaseController < Ramaze::Controller
+    #       before_all do
+    #         csrf_protection :save do
+    #           # ....
+    #         end
+    #       end
+    #     end
     #
     # This example introduces an extra block that validates the current
     # request. Whenever a user requests a controller that either extends
@@ -47,13 +47,13 @@ module Ramaze
     # current request data contains a CSRF token. Of course an if/end isn't
     # very useful if it doesn't do anything, let's add some code.
     #
-    #  class BaseController < Ramaze::Controller
-    #    before_all do
-    #      csrf_protection :save do
-    #        puts "Hello, unsafe data!"
-    #      end
-    #    end
-    #  end
+    #     class BaseController < Ramaze::Controller
+    #       before_all do
+    #         csrf_protection :save do
+    #           puts "Hello, unsafe data!"
+    #         end
+    #       end
+    #     end
     #
     # The code above checks if the current method is "save" (or any other of
     # the provided methods) and checks if an CSRF token is supplied if the
@@ -67,18 +67,17 @@ module Ramaze
     # If you're a lazy person you can copy-paste the example below and adapt it
     # to your needs.
     #
-    #  class BaseController < Ramaze::Controller
-    #    before_all do
-    #      csrf_protection :save do
-    #        respond("The supplied CSRF token is invalid.", 401)
-    #      end
-    #    end
-    #  end
+    #     class BaseController < Ramaze::Controller
+    #       before_all do
+    #         csrf_protection :save do
+    #           respond("The supplied CSRF token is invalid.", 401)
+    #         end
+    #       end
+    #     end
     #
     # @author Yorick Peterse
     #
     module CSRF
-
       ##
       # Method that can be used to protect the specified methods against CSRF
       # exploits. Each protected method will require the token to be stored in
@@ -86,10 +85,10 @@ module Ramaze
       # against the current token in the session.
       #
       # @author Yorick Peterse
-      # @param  [Strings/Symbol] *methods Methods that will be protected/unprotected.
+      # @param  [Strings/Symbol] *methods Methods that will be
+      #  protected/unprotected.
       # @param  [Block] Block that will be executed if the token is invalid.
       # @example
-      #
       #  # Protect "create" and "save" against CSRF exploits
       #  before_all do
       #    csrf_protection :create, :save do
@@ -97,7 +96,7 @@ module Ramaze
       #    end
       #  end
       #
-      def csrf_protection *methods, &block
+      def csrf_protection(*methods, &block)
         # Only protect the specified methods
         if methods.include?(action.name) or methods.include?(action.name.to_sym)
           # THINK: For now the field name is hard-coded to "csrf_token". While
@@ -120,9 +119,8 @@ module Ramaze
       #
       # @author Yorick Peterse
       # @param  [Hash] Additional arguments that can be set such as the TTL.
-      # @return [Void]
       #
-      def generate_csrf_token args = {}
+      def generate_csrf_token(args = {})
         # Default TTL is 15 minutes
         ttl = args[:ttl] || (15 * 60)
 
@@ -154,7 +152,6 @@ module Ramaze
       # @author Yorick Peterse
       # @return [String] The current CSRF token.
       # @example
-      #
       #  form(@data, :method => :post) do |f|
       #    f.input_hidden :csrf_token, get_csrf_token()
       #  end
@@ -180,9 +177,8 @@ module Ramaze
       #
       # @author Yorick Peterse
       # @param  [String] input_token The CSRF token to validate.
-      # @return [Bool]
+      # @return [TrueClass|FalseClass]
       # @example
-      #
       #  before_all do
       #    if validate_csrf_token(request.params['csrf_token']) != true
       #      respond("Invalid CSRF token", 401)
@@ -205,6 +201,6 @@ module Ramaze
           _csrf[:ip] == request.env['REMOTE_ADDR'] &&
           _csrf[:agent] == request.env['HTTP_USER_AGENT']
       end
-    end
-  end
-end
+    end # CSRF
+  end # Helper
+end # Ramaze

data/lib/ramaze/helper/disqus.rb

@@ -3,7 +3,7 @@ require 'disqus/view_helpers'
 
 module Ramaze
   module Helper
-
+    ##
     # Provides shortcuts via Disqus::ViewHelpers.
     #
     # Make sure that you set your disqus credentials when using this helper:
@@ -19,8 +19,9 @@ module Ramaze
     #   disqus_recent_comments
     #   disqus_thread
     #   disqus_top_commenters
+    #
     module Disqus
       include ::Disqus::ViewHelpers
-    end
-  end
-end
+    end # Disqus
+  end # Helper
+end # Ramaze

data/lib/ramaze/helper/email.rb

@@ -6,35 +6,37 @@ module Ramaze
     # The Email helper can be used as a simple way of sending Emails from your
     # application. In order to use this helper you first need to load it:
     #
-    #  class Comments < Ramaze::Controller
-    #    helper :email
-    #  end
+    #     class Comments < Ramaze::Controller
+    #       helper :email
+    #     end
     #
     # Sending an Email can be done by calling the method send_email():
     #
-    #  send_email('info@yorickpeterse.com', 'Hello, world!', 'Hello, this is an Email')
+    #     send_email(
+    #       'user@domain.tld',
+    #       'Hello, world!',
+    #       'Hello, this is an Email'
+    #     )
     #
-    # Ramaze will log any errors in case the Email could not be sent so you don't have to
-    # worry about this.
+    # Ramaze will log any errors in case the Email could not be sent so you
+    # don't have to worry about this.
     #
-    # == Options
+    # ## Options
     #
-    # This module can be configured using Innate::Optioned. Say you want to change the
-    # SMTP host you simply need to do the following:
+    # This module can be configured using Innate::Optioned. Say you want to
+    # change the SMTP host you simply need to do the following:
     #
-    #  Ramaze::Helper::Email.options.host = 'mail.google.com'
+    #     Ramaze::Helper::Email.options.host = 'mail.google.com'
     #
-    # Various other options are available, for a full list of these options run the
-    # following in an IRB session:
+    # Various other options are available, for a full list of these options run
+    # the following in an IRB session:
     #
-    #  puts Ramaze::Helper::Email.options
+    #     puts Ramaze::Helper::Email.options
     #
-    # By default this helper uses \r\n for newlines, this can be changed as following:
+    # By default this helper uses ``\r\n`` for newlines, this can be changed as
+    # following:
     #
-    #  Ramaze::Helper::Email.options.newline = "\n"
-    #
-    # It's important that this setting matches the settings of your SMTP server as
-    # otherwise you (usually) won't be able to send any Emails.
+    #     Ramaze::Helper::Email.options.newline = "\n"
     #
     # @author Yorick Peterse
     # @author Michael Fellinger
@@ -59,12 +61,12 @@ module Ramaze
           "<" + Time.now.to_i.to_s + "@" + Ramaze::Helper::Email.options.helo_domain + ">"
         }
       end
-      
+
       ##
       # Sends an Email over SMTP.
       #
       # @example
-      #  send_email('info@yorickpeterse.com', 'Hello, world!', 'Hello, this is an Email')
+      #  send_email('user@domain.tld', 'Hello, world!', 'Hello, this is an Email')
       #
       # @author Yorick Peterse
       # @author Michael Fellinger
@@ -79,7 +81,7 @@ module Ramaze
         id      = Email.options.generator.call
 
         # Generate the body of the Email
-        email   = [
+        email = [
           "From: #{sender}", "To: <#{recipient}>", "Date: #{Time.now.rfc2822}",
           "Subject: #{subject}", "Message-Id: #{id}", '', message
         ].join(Email.options.newline)
@@ -93,11 +95,20 @@ module Ramaze
 
         begin
           Net::SMTP.start(*email_options) do |smtp|
-            smtp.send_message(email, Email.options.sender, [recipient, *Email.options.bcc])
-            Ramaze::Log.info("Email sent to #{recipient} with subject \"#{subject}\"")
+            smtp.send_message(
+              email,
+              Email.options.sender,
+              [recipient, *Email.options.bcc]
+            )
+
+            Ramaze::Log.info(
+              "Email sent to #{recipient} with subject \"#{subject}\""
+            )
           end
         rescue => e
-          Ramaze::Log.error("Failed to send an Email to #{recipient}: #{e.inspect}")
+          Ramaze::Log.error(
+            "Failed to send an Email to #{recipient}: #{e.inspect}"
+          )
         end
       end
     end # Email

data/lib/ramaze/helper/erector.rb

@@ -8,7 +8,7 @@ module Ramaze
     ##
     # Allows you to use some shortcuts for Erector in your Controller.
     #
-    # use this inside your controller to directly build Erector 
+    # use this inside your controller to directly build Erector
     # Refer to the Erector-documentation and testsuite for more examples.
     #
     # @example
@@ -26,19 +26,18 @@ module Ramaze
         # Method that generates a XHTML 1.0 Strict doctype.
         #
         # @example
-        #
         #   strict_html do
         #     head do
         #       title "Ramaze Rocks!"
         #     end
         #     body
         #       div do
-        #         
+        #
         #       end
         #     end
         #   end
         #
-        # @param [Hash] args Hash containing extra options such as the xml:lang 
+        # @param [Hash] args Hash containing extra options such as the xml:lang
         #  and xmlns attribute.
         # @param [Block] block Block that contains the inner data of the <html>
         #  element.
@@ -53,7 +52,6 @@ module Ramaze
         # Generate a Javascript tag.
         #
         # @example
-        # 
         #   js 'javascript/jquery.js'
         #
         # @param [String] src The full or relative path to the Javascript file.
@@ -66,13 +64,12 @@ module Ramaze
         # Generate a pair of conditional tags for a specific browser.
         #
         # @example
-        #
         #   ie_if 'IE' do
         #     ......
         #   end
         #
         # @param [String] expr The if expression, such as 'IE' or 'lte IE7'.
-        # @param [block] block Block that contains the data that needs to be 
+        # @param [block] block Block that contains the data that needs to be
         #  loaded for the specified browser.
         #
         def ie_if(expr, &block)
@@ -94,19 +91,18 @@ module Ramaze
         # Generate a stylesheet tag.
         #
         # @example
-        #
         #   css 'css/reset.css', :media => 'print'
         #
-        # @param [String] href The path (either absolute or relative) to the CSS 
+        # @param [String] href The path (either absolute or relative) to the CSS
         #  file.
-        # @param [Hash] args A hash containing additional arguments to add to 
+        # @param [Hash] args A hash containing additional arguments to add to
         #  the CSS tag.
         #
         def css(href, args = {})
           attrs = {
-            :rel => "stylesheet", 
-            :href => href, 
-            :type => "text/css" 
+            :rel => "stylesheet",
+            :href => href,
+            :type => "text/css"
           }.merge(args)
 
           link attrs

data/lib/ramaze/helper/flash.rb

@@ -9,16 +9,14 @@ module Ramaze
   # Flash is a way to keep a temporary pairs of keys and values for the duration
   # of two requests, the current and following.
   #
-  # Very vague Example:
+  # Time for an example. On the first request, for example on registering:
   #
-  # On the first request, for example on registering:
-  #
-  #   flash[:error] = "You should reconsider your username, it's taken already"
-  #   redirect r(:register)
+  #     flash[:error] = "You should reconsider your username, it's taken already"
+  #     redirect r(:register)
   #
   # This is the request from the redirect:
   #
-  #   do_stuff if flash[:error]
+  #     do_stuff if flash[:error]
   #
   # On the request after this, flash[:error] is gone.
 
@@ -59,6 +57,6 @@ module Ramaze
           end
         }.flatten.join("\n")
       end
-    end
-  end
-end
+    end # Flash
+  end # Helper
+end # Ramaze

data/lib/ramaze/helper/formatting.rb

@@ -2,191 +2,206 @@
 # All files in this distribution are subject to the terms of the Ruby license.
 
 module Ramaze
-  module Helper::Formatting
-    module_function
-
-    FORMATTING_NUMBER_COUNTER = { 0 => 'no', 2 => 'two', 3 => 'three',
-      4 => 'four', 5 => 'five', 6 => 'six', 7 => 'seven', 8 => 'eight',
-      9 => 'nine', 10 => 'ten' }
-
-    # Answers with a representation of given +count+ with correct grammar.
-    # If no +items+ argument is given, and the +count+ argument is not 1, then
-    # we first check whether the +item+ argument responds to #pluralize (for
-    # example if you are using Sequel). If this doesn't work we append 's' to
-    # the +item+ argument.
-    #
-    # @example usage
-    #   number_counter(0, 'comment') # => 'no comments'
-    #   number_counter(1, 'comment') # => 'one comment'
-    #   number_counter(2, 'comment') # => '2 comments'
-
-    def number_counter(count, item, items = nil)
-      count, item = count.to_i, item.to_s
-
-      if count == 1
-        "one #{item}"
-      else
-        items ||= item.respond_to?(:pluralize) ? item.pluralize : "#{item}s"
-        prefix = FORMATTING_NUMBER_COUNTER[count] || count
-        "#{prefix} #{items}"
-      end
-    end
-
-    # Format a floating number nicely for display.
-    #
-    # Usage:
-    #   number_format(123.123)           # => '123.123'
-    #   number_format(123456.12345)      # => '123,456.12345'
-    #   number_format(123456.12345, '.') # => '123.456,12345'
-
-    def number_format(n, delimiter = ',')
-      delim_l, delim_r = delimiter == ',' ? %w[, .] : %w[. ,]
-      h, r = n.to_s.split('.')
-      [h.reverse.scan(/\d{1,3}/).join(delim_l).reverse, r].compact.join(delim_r)
-    end
-
-    # Answer with the ordinal version of a number.
-    #
-    # Usage:
-    #   ordinal(1)   # => "1st"
-    #   ordinal(2)   # => "2nd"
-    #   ordinal(3)   # => "3rd"
-    #   ordinal(13)  # => "13th"
-    #   ordinal(33)  # => "33rd"
-    #   ordinal(100) # => "100th"
-    #   ordinal(133) # => "133rd"
-
-    def ordinal(number)
-      number = number.to_i
-
-      case number % 100
-      when 11..13; "#{number}th"
-      else
-        case number % 10
-        when 1; "#{number}st"
-        when 2; "#{number}nd"
-        when 3; "#{number}rd"
-        else    "#{number}th"
+  module Helper
+    module Formatting
+      module_function
+
+      FORMATTING_NUMBER_COUNTER = {
+        0  => 'no',
+        2  => 'two',
+        3  => 'three',
+        4  => 'four',
+        5  => 'five',
+        6  => 'six',
+        7  => 'seven',
+        8  => 'eight',
+        9  => 'nine',
+        10 => 'ten'
+      }
+
+      # Answers with a representation of given +count+ with correct grammar.  If
+      # no +items+ argument is given, and the +count+ argument is not 1, then we
+      # first check whether the +item+ argument responds to ``#pluralize`` (for
+      # example if you are using Sequel). If this doesn't work we append 's'
+      # to the +item+ argument.
+      #
+      # @example usage
+      #  number_counter(0, 'comment') # => 'no comments'
+      #  number_counter(1, 'comment') # => 'one comment'
+      #  number_counter(2, 'comment') # => '2 comments'
+      #
+      def number_counter(count, item, items = nil)
+        count, item = count.to_i, item.to_s
+
+        if count == 1
+          "one #{item}"
+        else
+          items ||= item.respond_to?(:pluralize) ? item.pluralize : "#{item}s"
+          prefix = FORMATTING_NUMBER_COUNTER[count] || count
+          "#{prefix} #{items}"
         end
       end
-    end
-
-    # stolen and adapted from rails
-    def time_diff(from_time, to_time = Time.now, include_seconds = false)
-      distance_in_minutes = (((to_time - from_time).abs)/60).round
-      distance_in_seconds = ((to_time - from_time).abs).round if include_seconds
-
-      case distance_in_minutes
-        when 0..1
-          return (distance_in_minutes == 0) ? 'less than a minute' : '1 minute' unless include_seconds
-          case distance_in_seconds
-            when 0..4   then 'less than 5 seconds'
-            when 5..9   then 'less than 10 seconds'
-            when 10..19 then 'less than 20 seconds'
-            when 20..39 then 'half a minute'
-            when 40..59 then 'less than a minute'
-            else             '1 minute'
-          end
 
-        when 2..44           then "#{distance_in_minutes} minutes"
-        when 45..89          then 'about 1 hour'
-        when 90..1439        then "about #{(distance_in_minutes.to_f / 60.0).round} hours"
-        when 1440..2879      then '1 day'
-        when 2880..43199     then "#{(distance_in_minutes / 1440).round} days"
-        when 43200..86399    then 'about 1 month'
-        when 86400..525959   then "#{(distance_in_minutes / 43200).round} months"
-        when 525960..1051919 then 'about 1 year'
-        else                      "over #{(distance_in_minutes / 525960).round} years"
+      # Format a floating number nicely for display.
+      #
+      # @example
+      #  number_format(123.123)           # => '123.123'
+      #  number_format(123456.12345)      # => '123,456.12345'
+      #  number_format(123456.12345, '.') # => '123.456,12345'
+      #
+      def number_format(n, delimiter = ',')
+        delim_l, delim_r = delimiter == ',' ? %w[, .] : %w[. ,]
+        h, r = n.to_s.split('.')
+        [h.reverse.scan(/\d{1,3}/).join(delim_l).reverse, r].compact.join(delim_r)
       end
-    end
-
-    # Copied from actionpack, and revised by insane-dreamer to fix a bug (original fails on some URLs)
-    AUTO_LINK_RE = %r{
-      (                          # leading text
-        <\w+.*?>|                # leading HTML tag, or
-        [^=!:'"/]|               # leading punctuation, or
-        ^                        # beginning of line
-      )
-      (
-        (?:https?://)|           # protocol spec, or
-        (?:www\.)                # www.*
-      )
-      (
-        [-\w]+                   # subdomain or domain
-        (?:\.[-\w]+)*            # remaining subdomains or domain
-        (?::\d+)?                # port
-        (?:/(?:[~\w\+@%=\(\)-]|(?:[,.;:'][^\s<$]))*)* # path
-        (?:\?[\w\+@%&=.;:-]+)?   # query string
-        (?:\#[\w\-]*)?           # trailing anchor
-      )
-      ([[:punct:]]|<|$|)         # trailing text
-    }x unless defined? AUTO_LINK_RE
-
-    # Turns all urls into clickable links.  If a block is given, each url
-    # is yielded and the result is used as the link text.
-    def auto_link(text, opts = {})
-      html_options = ' ' + opts.map{|k,v| "#{k}='#{v}'"}.join(' ') if opts.any?
-      text.gsub(AUTO_LINK_RE) do
-        all, a, b, c, d = $&, $1, $2, $3, $4
-        if a =~ /<a\s/i # don't replace URL's that are already linked
-          all
+
+      # Answer with the ordinal version of a number.
+      #
+      # @example
+      #  ordinal(1)   # => "1st"
+      #  ordinal(2)   # => "2nd"
+      #  ordinal(3)   # => "3rd"
+      #  ordinal(13)  # => "13th"
+      #  ordinal(33)  # => "33rd"
+      #  ordinal(100) # => "100th"
+      #  ordinal(133) # => "133rd"
+      #
+      def ordinal(number)
+        number = number.to_i
+
+        case number % 100
+        when 11..13; "#{number}th"
         else
-          text = b + c
-          text = yield(text) if block_given?
-          %(#{a}<a href="#{b=="www."?"http://www.":b}#{c}"#{html_options}>#{text}</a>#{d})
+          case number % 10
+          when 1; "#{number}st"
+          when 2; "#{number}nd"
+          when 3; "#{number}rd"
+          else    "#{number}th"
+          end
+        end
+      end
+
+      # stolen and adapted from rails
+      def time_diff(from_time, to_time = Time.now, include_seconds = false)
+        distance_in_minutes = (((to_time - from_time).abs)/60).round
+        distance_in_seconds = ((to_time - from_time).abs).round if include_seconds
+
+        case distance_in_minutes
+          when 0..1
+            return (distance_in_minutes == 0) ? 'less than a minute' : '1 minute' unless include_seconds
+            case distance_in_seconds
+              when 0..4   then 'less than 5 seconds'
+              when 5..9   then 'less than 10 seconds'
+              when 10..19 then 'less than 20 seconds'
+              when 20..39 then 'half a minute'
+              when 40..59 then 'less than a minute'
+              else             '1 minute'
+            end
+
+          when 2..44           then "#{distance_in_minutes} minutes"
+          when 45..89          then 'about 1 hour'
+          when 90..1439        then "about #{(distance_in_minutes.to_f / 60.0).round} hours"
+          when 1440..2879      then '1 day'
+          when 2880..43199     then "#{(distance_in_minutes / 1440).round} days"
+          when 43200..86399    then 'about 1 month'
+          when 86400..525959   then "#{(distance_in_minutes / 43200).round} months"
+          when 525960..1051919 then 'about 1 year'
+          else                      "over #{(distance_in_minutes / 525960).round} years"
+        end
+      end
+
+      # Copied from actionpack, and revised by insane-dreamer to fix a bug
+      # (original fails on some URLs)
+      AUTO_LINK_RE = %r{
+        (                          # leading text
+          <\w+.*?>|                # leading HTML tag, or
+          [^=!:'"/]|               # leading punctuation, or
+          ^                        # beginning of line
+        )
+        (
+          (?:https?://)|           # protocol spec, or
+          (?:www\.)                # www.*
+        )
+        (
+          [-\w]+                   # subdomain or domain
+          (?:\.[-\w]+)*            # remaining subdomains or domain
+          (?::\d+)?                # port
+          (?:/(?:[~\w\+@%=\(\)-]|(?:[,.;:'][^\s<$]))*)* # path
+          (?:\?[\w\+@%&=.;:-]+)?   # query string
+          (?:\#[\w\-]*)?           # trailing anchor
+        )
+        ([[:punct:]]|<|$|)         # trailing text
+      }x unless defined? AUTO_LINK_RE
+
+      # Turns all urls into clickable links.  If a block is given, each url
+      # is yielded and the result is used as the link text.
+      def auto_link(text, opts = {})
+        html_options = ' ' + opts.map{|k,v| "#{k}='#{v}'"}.join(' ') if opts.any?
+        text.gsub(AUTO_LINK_RE) do
+          all, a, b, c, d = $&, $1, $2, $3, $4
+          if a =~ /<a\s/i # don't replace URL's that are already linked
+            all
+          else
+            text = b + c
+            text = yield(text) if block_given?
+            %(#{a}<a href="#{b=="www."?"http://www.":b}#{c}"#{html_options}>#{text}</a>#{d})
+          end
         end
       end
-    end
-    alias autolink auto_link
-
-    # takes a string and optional argument for outputting compliance HTML
-    # instead of XHTML.
-    # e.g nl2br "a\nb\n\c" #=> 'a<br />b<br />c'
-
-    def nl2br(string, xhtml = true)
-      br = xhtml ? '<br />' : '<br>'
-      string.gsub(/\n/, br)
-    end
-
-    # Maybe port to ruby < 1.8.7 ?
-    def obfuscate_email(email, text = nil)
-      obfuscated = []
-      email.to_s.each_byte{|c| obfuscated << "&#%03d" % c }
-      joined = obfuscated.join
-
-      %(<a href="mailto:#{joined}">#{text || joined}</a>)
-    end
-
-    # Returns Hash with tags as keys and their weight as value.
-    #
-    # Example:
-    #     tags = %w[ruby ruby code ramaze]
-    #     tagcloud(tags)
-    #     # => {"code"=>0.75, "ramaze"=>0.75, "ruby"=>1.0}
-    #
-    # The weight can be influenced by adjusting the +min+ and +max+ parameters,
-    # please make sure that +max+ is larger than +min+ to get meaningful output.
-    #
-    # This is not thought as immediate output to your template but rather to
-    # help either implementing your own algorithm or using the result as input
-    # for your tagcloud.
-    #
-    # Example:
-    #     - tagcloud(tags).each do |tag, weight|
-    #       - style = "font-size: %0.2fem" % weight
-    #       %a{:style => style, :href => Rs(tag)}= h(tag)
-
-    def tagcloud(tags, min = 0.5, max = 1.5)
-      result = {}
-      total = tags.size.to_f
-      diff = max - min
-
-      tags.uniq.each do |tag|
-        count = tags.respond_to?(:count) ? tags.count(tag) : tags.select{|t| t==tag }.size
-        result[tag] = ((count / total) * diff) + min
+      alias autolink auto_link
+
+      # takes a string and optional argument for outputting compliance HTML
+      # instead of XHTML.
+      #
+      # @example
+      #  nl2br "a\nb\n\c" #=> 'a<br />b<br />c'
+      #
+      def nl2br(string, xhtml = true)
+        br = xhtml ? '<br />' : '<br>'
+        string.gsub(/\n/, br)
       end
 
-      result
-    end
-  end
-end
+      def obfuscate_email(email, text = nil)
+        obfuscated = []
+        email.to_s.each_byte{|c| obfuscated << "&#%03d" % c }
+        joined = obfuscated.join
+
+        %(<a href="mailto:#{joined}">#{text || joined}</a>)
+      end
+
+      # Returns Hash with tags as keys and their weight as value.
+      #
+      # Example:
+      #     tags = %w[ruby ruby code ramaze]
+      #     tagcloud(tags)
+      #     # => {"code"=>0.75, "ramaze"=>0.75, "ruby"=>1.0}
+      #
+      # The weight can be influenced by adjusting the +min+ and +max+
+      # parameters, please make sure that +max+ is larger than +min+ to get
+      # meaningful output.
+      #
+      # This is not thought as immediate output to your template but rather to
+      # help either implementing your own algorithm or using the result as input
+      # for your tagcloud.
+      #
+      # @example
+      #  tagcloud(tags).each do |tag, weight|
+      #    style = "font-size: %0.2fem" % weight
+      #    %a{:style => style, :href => Rs(tag)}= h(tag)
+      #  end
+      #
+      def tagcloud(tags, min = 0.5, max = 1.5)
+        result = {}
+        total = tags.size.to_f
+        diff = max - min
+
+        tags.uniq.each do |tag|
+          count = tags.respond_to?(:count) ? tags.count(tag) : tags.select{|t| t==tag }.size
+          result[tag] = ((count / total) * diff) + min
+        end
+
+        result
+      end
+    end # Formatting
+  end # Helper
+end # Ramaze