← Back to branch summary

~michaelforrest/use-case-mapper/trunk

« back to all changes in this revision

Viewing changes to vendor/rails/actionpack/lib/action_view/helpers/text_helper.rb

  • Committer: Richard Lee (Canonical)
  • Date: 2010-10-15 15:17:58 UTC
  • mfrom: (190.1.3 use-case-mapper)
  • Revision ID: richard.lee@canonical.com-20101015151758-wcvmfxrexsongf9d
Merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
vendor/rails/actionpack/lib/action_view/helpers/text_helper.rb
1
 
require 'action_view/helpers/tag_helper'
2
 
 
3
 
module ActionView
4
 
  module Helpers #:nodoc:
5
 
    # The TextHelper module provides a set of methods for filtering, formatting
6
 
    # and transforming strings, which can reduce the amount of inline Ruby code in
7
 
    # your views. These helper methods extend ActionView making them callable
8
 
    # within your template files.
9
 
    module TextHelper
10
 
      # The preferred method of outputting text in your views is to use the
11
 
      # <%= "text" %> eRuby syntax. The regular _puts_ and _print_ methods
12
 
      # do not operate as expected in an eRuby code block. If you absolutely must
13
 
      # output text within a non-output code block (i.e., <% %>), you can use the concat method.
14
 
      #
15
 
      # ==== Examples
16
 
      #   <%
17
 
      #       concat "hello"
18
 
      #       # is the equivalent of <%= "hello" %>
19
 
      #
20
 
      #       if (logged_in == true):
21
 
      #         concat "Logged in!"
22
 
      #       else
23
 
      #         concat link_to('login', :action => login)
24
 
      #       end
25
 
      #       # will either display "Logged in!" or a login link
26
 
      #   %>
27
 
      def concat(string, unused_binding = nil)
28
 
        if unused_binding
29
 
          ActiveSupport::Deprecation.warn("The binding argument of #concat is no longer needed.  Please remove it from your views and helpers.", caller)
30
 
        end
31
 
 
32
 
        output_buffer << string
33
 
      end
34
 
 
35
 
      # Truncates a given +text+ after a given <tt>:length</tt> if +text+ is longer than <tt>:length</tt>
36
 
      # (defaults to 30). The last characters will be replaced with the <tt>:omission</tt> (defaults to "...")
37
 
      # for a total length not exceeding <tt>:length</tt>.
38
 
      #
39
 
      # ==== Examples
40
 
      #
41
 
      #   truncate("Once upon a time in a world far far away")
42
 
      #   # => Once upon a time in a world...
43
 
      #
44
 
      #   truncate("Once upon a time in a world far far away", :length => 14)
45
 
      #   # => Once upon a...
46
 
      #
47
 
      #   truncate("And they found that many people were sleeping better.", :length => 25, "(clipped)")
48
 
      #   # => And they found t(clipped)
49
 
      #
50
 
      #   truncate("And they found that many people were sleeping better.", :omission => "... (continued)", :length => 25)
51
 
      #   # => And they f... (continued)
52
 
      #
53
 
      # You can still use <tt>truncate</tt> with the old API that accepts the
54
 
      # +length+ as its optional second and the +ellipsis+ as its
55
 
      # optional third parameter:
56
 
      #   truncate("Once upon a time in a world far far away", 14)
57
 
      #   # => Once upon a...
58
 
      #
59
 
      #   truncate("And they found that many people were sleeping better.", 25, "... (continued)")
60
 
      #   # => And they f... (continued)
61
 
      def truncate(text, *args)
62
 
        options = args.extract_options!
63
 
        unless args.empty?
64
 
          ActiveSupport::Deprecation.warn('truncate takes an option hash instead of separate ' +
65
 
            'length and omission arguments', caller)
66
 
 
67
 
          options[:length] = args[0] || 30
68
 
          options[:omission] = args[1] || "..."
69
 
        end
70
 
        options.reverse_merge!(:length => 30, :omission => "...")
71
 
 
72
 
        if text
73
 
          l = options[:length] - options[:omission].mb_chars.length
74
 
          chars = text.mb_chars
75
 
          (chars.length > options[:length] ? chars[0...l] + options[:omission] : text).to_s
76
 
        end
77
 
      end
78
 
 
79
 
      # Highlights one or more +phrases+ everywhere in +text+ by inserting it into
80
 
      # a <tt>:highlighter</tt> string. The highlighter can be specialized by passing <tt>:highlighter</tt>
81
 
      # as a single-quoted string with \1 where the phrase is to be inserted (defaults to
82
 
      # '<strong class="highlight">\1</strong>')
83
 
      #
84
 
      # ==== Examples
85
 
      #   highlight('You searched for: rails', 'rails')
86
 
      #   # => You searched for: <strong class="highlight">rails</strong>
87
 
      #
88
 
      #   highlight('You searched for: ruby, rails, dhh', 'actionpack')
89
 
      #   # => You searched for: ruby, rails, dhh
90
 
      #
91
 
      #   highlight('You searched for: rails', ['for', 'rails'], :highlighter => '<em>\1</em>')
92
 
      #   # => You searched <em>for</em>: <em>rails</em>
93
 
      #
94
 
      #   highlight('You searched for: rails', 'rails', :highlighter => '<a href="search?q=\1">\1</a>')
95
 
      #   # => You searched for: <a href="search?q=rails">rails</a>
96
 
      #
97
 
      # You can still use <tt>highlight</tt> with the old API that accepts the
98
 
      # +highlighter+ as its optional third parameter:
99
 
      #   highlight('You searched for: rails', 'rails', '<a href="search?q=\1">\1</a>')     # => You searched for: <a href="search?q=rails">rails</a>
100
 
      def highlight(text, phrases, *args)
101
 
        options = args.extract_options!
102
 
        unless args.empty?
103
 
          options[:highlighter] = args[0] || '<strong class="highlight">\1</strong>'
104
 
        end
105
 
        options.reverse_merge!(:highlighter => '<strong class="highlight">\1</strong>')
106
 
 
107
 
        if text.blank? || phrases.blank?
108
 
          text
109
 
        else
110
 
          match = Array(phrases).map { |p| Regexp.escape(p) }.join('|')
111
 
          text.gsub(/(#{match})(?!(?:[^<]*?)(?:["'])[^<>]*>)/i, options[:highlighter])
112
 
        end
113
 
      end
114
 
 
115
 
      # Extracts an excerpt from +text+ that matches the first instance of +phrase+.
116
 
      # The <tt>:radius</tt> option expands the excerpt on each side of the first occurrence of +phrase+ by the number of characters
117
 
      # defined in <tt>:radius</tt> (which defaults to 100). If the excerpt radius overflows the beginning or end of the +text+,
118
 
      # then the <tt>:omission</tt> option (which defaults to "...") will be prepended/appended accordingly. The resulting string
119
 
      # will be stripped in any case. If the +phrase+ isn't found, nil is returned.
120
 
      #
121
 
      # ==== Examples
122
 
      #   excerpt('This is an example', 'an', :radius => 5)
123
 
      #   # => ...s is an exam...
124
 
      #
125
 
      #   excerpt('This is an example', 'is', :radius => 5)
126
 
      #   # => This is a...
127
 
      #
128
 
      #   excerpt('This is an example', 'is')
129
 
      #   # => This is an example
130
 
      #
131
 
      #   excerpt('This next thing is an example', 'ex', :radius => 2)
132
 
      #   # => ...next...
133
 
      #
134
 
      #   excerpt('This is also an example', 'an', :radius => 8, :omission => '<chop> ')
135
 
      #   # => <chop> is also an example
136
 
      #
137
 
      # You can still use <tt>excerpt</tt> with the old API that accepts the
138
 
      # +radius+ as its optional third and the +ellipsis+ as its
139
 
      # optional forth parameter:
140
 
      #   excerpt('This is an example', 'an', 5)                   # => ...s is an exam...
141
 
      #   excerpt('This is also an example', 'an', 8, '<chop> ')   # => <chop> is also an example
142
 
      def excerpt(text, phrase, *args)
143
 
        options = args.extract_options!
144
 
        unless args.empty?
145
 
          options[:radius] = args[0] || 100
146
 
          options[:omission] = args[1] || "..."
147
 
        end
148
 
        options.reverse_merge!(:radius => 100, :omission => "...")
149
 
 
150
 
        if text && phrase
151
 
          phrase = Regexp.escape(phrase)
152
 
 
153
 
          if found_pos = text.mb_chars =~ /(#{phrase})/i
154
 
            start_pos = [ found_pos - options[:radius], 0 ].max
155
 
            end_pos   = [ [ found_pos + phrase.mb_chars.length + options[:radius] - 1, 0].max, text.mb_chars.length ].min
156
 
 
157
 
            prefix  = start_pos > 0 ? options[:omission] : ""
158
 
            postfix = end_pos < text.mb_chars.length - 1 ? options[:omission] : ""
159
 
 
160
 
            prefix + text.mb_chars[start_pos..end_pos].strip + postfix
161
 
          else
162
 
            nil
163
 
          end
164
 
        end
165
 
      end
166
 
 
167
 
      # Attempts to pluralize the +singular+ word unless +count+ is 1. If
168
 
      # +plural+ is supplied, it will use that when count is > 1, otherwise
169
 
      # it will use the Inflector to determine the plural form
170
 
      #
171
 
      # ==== Examples
172
 
      #   pluralize(1, 'person')
173
 
      #   # => 1 person
174
 
      #
175
 
      #   pluralize(2, 'person')
176
 
      #   # => 2 people
177
 
      #
178
 
      #   pluralize(3, 'person', 'users')
179
 
      #   # => 3 users
180
 
      #
181
 
      #   pluralize(0, 'person')
182
 
      #   # => 0 people
183
 
      def pluralize(count, singular, plural = nil)
184
 
        "#{count || 0} " + ((count == 1 || count == '1') ? singular : (plural || singular.pluralize))
185
 
      end
186
 
 
187
 
      # Wraps the +text+ into lines no longer than +line_width+ width. This method
188
 
      # breaks on the first whitespace character that does not exceed +line_width+
189
 
      # (which is 80 by default).
190
 
      #
191
 
      # ==== Examples
192
 
      #
193
 
      #   word_wrap('Once upon a time')
194
 
      #   # => Once upon a time
195
 
      #
196
 
      #   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...')
197
 
      #   # => 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...
198
 
      #
199
 
      #   word_wrap('Once upon a time', :line_width => 8)
200
 
      #   # => Once upon\na time
201
 
      #
202
 
      #   word_wrap('Once upon a time', :line_width => 1)
203
 
      #   # => Once\nupon\na\ntime
204
 
      #
205
 
      # You can still use <tt>word_wrap</tt> with the old API that accepts the
206
 
      # +line_width+ as its optional second parameter:
207
 
      #   word_wrap('Once upon a time', 8)     # => Once upon\na time
208
 
      def word_wrap(text, *args)
209
 
        options = args.extract_options!
210
 
        unless args.blank?
211
 
          options[:line_width] = args[0] || 80
212
 
        end
213
 
        options.reverse_merge!(:line_width => 80)
214
 
 
215
 
        text.split("\n").collect do |line|
216
 
          line.length > options[:line_width] ? line.gsub(/(.{1,#{options[:line_width]}})(\s+|$)/, "\\1\n").strip : line
217
 
        end * "\n"
218
 
      end
219
 
 
220
 
      # Returns the text with all the Textile[http://www.textism.com/tools/textile] codes turned into HTML tags.
221
 
      #
222
 
      # You can learn more about Textile's syntax at its website[http://www.textism.com/tools/textile].
223
 
      # <i>This method is only available if RedCloth[http://whytheluckystiff.net/ruby/redcloth/]
224
 
      # is available</i>.
225
 
      #
226
 
      # ==== Examples
227
 
      #   textilize("*This is Textile!*  Rejoice!")
228
 
      #   # => "<p><strong>This is Textile!</strong>  Rejoice!</p>"
229
 
      #
230
 
      #   textilize("I _love_ ROR(Ruby on Rails)!")
231
 
      #   # => "<p>I <em>love</em> <acronym title="Ruby on Rails">ROR</acronym>!</p>"
232
 
      #
233
 
      #   textilize("h2. Textile makes markup -easy- simple!")
234
 
      #   # => "<h2>Textile makes markup <del>easy</del> simple!</h2>"
235
 
      #
236
 
      #   textilize("Visit the Rails website "here":http://www.rubyonrails.org/.)
237
 
      #   # => "<p>Visit the Rails website <a href="http://www.rubyonrails.org/">here</a>.</p>"
238
 
      #
239
 
      #   textilize("This is worded <strong>strongly</strong>")
240
 
      #   # => "<p>This is worded <strong>strongly</strong></p>"
241
 
      #
242
 
      #   textilize("This is worded <strong>strongly</strong>", :filter_html)
243
 
      #   # => "<p>This is worded &lt;strong&gt;strongly&lt;/strong&gt;</p>"
244
 
      #
245
 
      def textilize(text, *options)
246
 
        options ||= [:hard_breaks]
247
 
 
248
 
        if text.blank?
249
 
          ""
250
 
        else
251
 
          textilized = RedCloth.new(text, options)
252
 
          textilized.to_html
253
 
        end
254
 
      end
255
 
 
256
 
      # Returns the text with all the Textile codes turned into HTML tags,
257
 
      # but without the bounding <p> tag that RedCloth adds.
258
 
      #
259
 
      # You can learn more about Textile's syntax at its website[http://www.textism.com/tools/textile].
260
 
      # <i>This method is requires RedCloth[http://whytheluckystiff.net/ruby/redcloth/]
261
 
      # to be available</i>.
262
 
      #
263
 
      # ==== Examples
264
 
      #   textilize_without_paragraph("*This is Textile!*  Rejoice!")
265
 
      #   # => "<strong>This is Textile!</strong>  Rejoice!"
266
 
      #
267
 
      #   textilize_without_paragraph("I _love_ ROR(Ruby on Rails)!")
268
 
      #   # => "I <em>love</em> <acronym title="Ruby on Rails">ROR</acronym>!"
269
 
      #
270
 
      #   textilize_without_paragraph("h2. Textile makes markup -easy- simple!")
271
 
      #   # => "<h2>Textile makes markup <del>easy</del> simple!</h2>"
272
 
      #
273
 
      #   textilize_without_paragraph("Visit the Rails website "here":http://www.rubyonrails.org/.)
274
 
      #   # => "Visit the Rails website <a href="http://www.rubyonrails.org/">here</a>."
275
 
      def textilize_without_paragraph(text)
276
 
        textiled = textilize(text)
277
 
        if textiled[0..2] == "<p>" then textiled = textiled[3..-1] end
278
 
        if textiled[-4..-1] == "</p>" then textiled = textiled[0..-5] end
279
 
        return textiled
280
 
      end
281
 
 
282
 
      # Returns the text with all the Markdown codes turned into HTML tags.
283
 
      # <i>This method requires BlueCloth[http://www.deveiate.org/projects/BlueCloth] or another
284
 
      # Markdown library to be installed.</i>.
285
 
      #
286
 
      # ==== Examples
287
 
      #   markdown("We are using __Markdown__ now!")
288
 
      #   # => "<p>We are using <strong>Markdown</strong> now!</p>"
289
 
      #
290
 
      #   markdown("We like to _write_ `code`, not just _read_ it!")
291
 
      #   # => "<p>We like to <em>write</em> <code>code</code>, not just <em>read</em> it!</p>"
292
 
      #
293
 
      #   markdown("The [Markdown website](http://daringfireball.net/projects/markdown/) has more information.")
294
 
      #   # => "<p>The <a href="http://daringfireball.net/projects/markdown/">Markdown website</a>
295
 
      #   #     has more information.</p>"
296
 
      #
297
 
      #   markdown('![The ROR logo](http://rubyonrails.com/images/rails.png "Ruby on Rails")')
298
 
      #   # => '<p><img src="http://rubyonrails.com/images/rails.png" alt="The ROR logo" title="Ruby on Rails" /></p>'
299
 
      def markdown(text)
300
 
        text.blank? ? "" : Markdown.new(text).to_html
301
 
      end
302
 
 
303
 
      # Returns +text+ transformed into HTML using simple formatting rules.
304
 
      # Two or more consecutive newlines(<tt>\n\n</tt>) are considered as a
305
 
      # paragraph and wrapped in <tt><p></tt> tags. One newline (<tt>\n</tt>) is
306
 
      # considered as a linebreak and a <tt><br /></tt> tag is appended. This
307
 
      # method does not remove the newlines from the +text+.
308
 
      #
309
 
      # You can pass any HTML attributes into <tt>html_options</tt>.  These
310
 
      # will be added to all created paragraphs.
311
 
      # ==== Examples
312
 
      #   my_text = "Here is some basic text...\n...with a line break."
313
 
      #
314
 
      #   simple_format(my_text)
315
 
      #   # => "<p>Here is some basic text...\n<br />...with a line break.</p>"
316
 
      #
317
 
      #   more_text = "We want to put a paragraph...\n\n...right there."
318
 
      #
319
 
      #   simple_format(more_text)
320
 
      #   # => "<p>We want to put a paragraph...</p>\n\n<p>...right there.</p>"
321
 
      #
322
 
      #   simple_format("Look ma! A class!", :class => 'description')
323
 
      #   # => "<p class='description'>Look ma! A class!</p>"
324
 
      def simple_format(text, html_options={})
325
 
        start_tag = tag('p', html_options, true)
326
 
        text = text.to_s.dup
327
 
        text.gsub!(/\r\n?/, "\n")                    # \r\n and \r -> \n
328
 
        text.gsub!(/\n\n+/, "</p>\n\n#{start_tag}")  # 2+ newline  -> paragraph
329
 
        text.gsub!(/([^\n]\n)(?=[^\n])/, '\1<br />') # 1 newline   -> br
330
 
        text.insert 0, start_tag
331
 
        text << "</p>"
332
 
      end
333
 
 
334
 
      # Turns all URLs and e-mail addresses into clickable links. The <tt>:link</tt> option
335
 
      # will limit what should be linked. You can add HTML attributes to the links using
336
 
      # <tt>:href_options</tt>. Possible values for <tt>:link</tt> are <tt>:all</tt> (default),
337
 
      # <tt>:email_addresses</tt>, and <tt>:urls</tt>. If a block is given, each URL and
338
 
      # e-mail address is yielded and the result is used as the link text.
339
 
      #
340
 
      # ==== Examples
341
 
      #   auto_link("Go to http://www.rubyonrails.org and say hello to david@loudthinking.com")
342
 
      #   # => "Go to <a href=\"http://www.rubyonrails.org\">http://www.rubyonrails.org</a> and
343
 
      #   #     say hello to <a href=\"mailto:david@loudthinking.com\">david@loudthinking.com</a>"
344
 
      #
345
 
      #   auto_link("Visit http://www.loudthinking.com/ or e-mail david@loudthinking.com", :link => :urls)
346
 
      #   # => "Visit <a href=\"http://www.loudthinking.com/\">http://www.loudthinking.com/</a>
347
 
      #   #     or e-mail david@loudthinking.com"
348
 
      #
349
 
      #   auto_link("Visit http://www.loudthinking.com/ or e-mail david@loudthinking.com", :link => :email_addresses)
350
 
      #   # => "Visit http://www.loudthinking.com/ or e-mail <a href=\"mailto:david@loudthinking.com\">david@loudthinking.com</a>"
351
 
      #
352
 
      #   post_body = "Welcome to my new blog at http://www.myblog.com/.  Please e-mail me at me@email.com."
353
 
      #   auto_link(post_body, :href_options => { :target => '_blank' }) do |text|
354
 
      #     truncate(text, 15)
355
 
      #   end
356
 
      #   # => "Welcome to my new blog at <a href=\"http://www.myblog.com/\" target=\"_blank\">http://www.m...</a>.
357
 
      #         Please e-mail me at <a href=\"mailto:me@email.com\">me@email.com</a>."
358
 
      #
359
 
      #
360
 
      # You can still use <tt>auto_link</tt> with the old API that accepts the
361
 
      # +link+ as its optional second parameter and the +html_options+ hash
362
 
      # as its optional third parameter:
363
 
      #   post_body = "Welcome to my new blog at http://www.myblog.com/. Please e-mail me at me@email.com."
364
 
      #   auto_link(post_body, :urls)     # => Once upon\na time
365
 
      #   # => "Welcome to my new blog at <a href=\"http://www.myblog.com/\">http://www.myblog.com</a>.
366
 
      #         Please e-mail me at me@email.com."
367
 
      #
368
 
      #   auto_link(post_body, :all, :target => "_blank")     # => Once upon\na time
369
 
      #   # => "Welcome to my new blog at <a href=\"http://www.myblog.com/\" target=\"_blank\">http://www.myblog.com</a>.
370
 
      #         Please e-mail me at <a href=\"mailto:me@email.com\">me@email.com</a>."
371
 
      def auto_link(text, *args, &block)#link = :all, href_options = {}, &block)
372
 
        return '' if text.blank?
373
 
 
374
 
        options = args.size == 2 ? {} : args.extract_options! # this is necessary because the old auto_link API has a Hash as its last parameter
375
 
        unless args.empty?
376
 
          options[:link] = args[0] || :all
377
 
          options[:html] = args[1] || {}
378
 
        end
379
 
        options.reverse_merge!(:link => :all, :html => {})
380
 
 
381
 
        case options[:link].to_sym
382
 
          when :all                         then auto_link_email_addresses(auto_link_urls(text, options[:html], &block), options[:html], &block)
383
 
          when :email_addresses             then auto_link_email_addresses(text, options[:html], &block)
384
 
          when :urls                        then auto_link_urls(text, options[:html], &block)
385
 
        end
386
 
      end
387
 
 
388
 
      # Creates a Cycle object whose _to_s_ method cycles through elements of an
389
 
      # array every time it is called. This can be used for example, to alternate
390
 
      # classes for table rows.  You can use named cycles to allow nesting in loops.
391
 
      # Passing a Hash as the last parameter with a <tt>:name</tt> key will create a
392
 
      # named cycle. The default name for a cycle without a +:name+ key is
393
 
      # <tt>"default"</tt>. You can manually reset a cycle by calling reset_cycle
394
 
      # and passing the name of the cycle. The current cycle string can be obtained
395
 
      # anytime using the current_cycle method.
396
 
      #
397
 
      # ==== Examples
398
 
      #   # Alternate CSS classes for even and odd numbers...
399
 
      #   @items = [1,2,3,4]
400
 
      #   <table>
401
 
      #   <% @items.each do |item| %>
402
 
      #     <tr class="<%= cycle("even", "odd") -%>">
403
 
      #       <td>item</td>
404
 
      #     </tr>
405
 
      #   <% end %>
406
 
      #   </table>
407
 
      #
408
 
      #
409
 
      #   # Cycle CSS classes for rows, and text colors for values within each row
410
 
      #   @items = x = [{:first => 'Robert', :middle => 'Daniel', :last => 'James'},
411
 
      #                {:first => 'Emily', :middle => 'Shannon', :maiden => 'Pike', :last => 'Hicks'},
412
 
      #               {:first => 'June', :middle => 'Dae', :last => 'Jones'}]
413
 
      #   <% @items.each do |item| %>
414
 
      #     <tr class="<%= cycle("even", "odd", :name => "row_class") -%>">
415
 
      #       <td>
416
 
      #         <% item.values.each do |value| %>
417
 
      #           <%# Create a named cycle "colors" %>
418
 
      #           <span style="color:<%= cycle("red", "green", "blue", :name => "colors") -%>">
419
 
      #             <%= value %>
420
 
      #           </span>
421
 
      #         <% end %>
422
 
      #         <% reset_cycle("colors") %>
423
 
      #       </td>
424
 
      #    </tr>
425
 
      #  <% end %>
426
 
      def cycle(first_value, *values)
427
 
        if (values.last.instance_of? Hash)
428
 
          params = values.pop
429
 
          name = params[:name]
430
 
        else
431
 
          name = "default"
432
 
        end
433
 
        values.unshift(first_value)
434
 
 
435
 
        cycle = get_cycle(name)
436
 
        if (cycle.nil? || cycle.values != values)
437
 
          cycle = set_cycle(name, Cycle.new(*values))
438
 
        end
439
 
        return cycle.to_s
440
 
      end
441
 
 
442
 
      # Returns the current cycle string after a cycle has been started. Useful
443
 
      # for complex table highlighing or any other design need which requires
444
 
      # the current cycle string in more than one place.
445
 
      #
446
 
      # ==== Example
447
 
      #   # Alternate background colors
448
 
      #   @items = [1,2,3,4]
449
 
      #   <% @items.each do |item| %>
450
 
      #     <div style="background-color:<%= cycle("red","white","blue") %>">
451
 
      #       <span style="background-color:<%= current_cycle %>"><%= item %></span>
452
 
      #     </div>
453
 
      #   <% end %>
454
 
      def current_cycle(name = "default")
455
 
        cycle = get_cycle(name)
456
 
        cycle.current_value unless cycle.nil?
457
 
      end
458
 
 
459
 
      # Resets a cycle so that it starts from the first element the next time
460
 
      # it is called. Pass in +name+ to reset a named cycle.
461
 
      #
462
 
      # ==== Example
463
 
      #   # Alternate CSS classes for even and odd numbers...
464
 
      #   @items = [[1,2,3,4], [5,6,3], [3,4,5,6,7,4]]
465
 
      #   <table>
466
 
      #   <% @items.each do |item| %>
467
 
      #     <tr class="<%= cycle("even", "odd") -%>">
468
 
      #         <% item.each do |value| %>
469
 
      #           <span style="color:<%= cycle("#333", "#666", "#999", :name => "colors") -%>">
470
 
      #             <%= value %>
471
 
      #           </span>
472
 
      #         <% end %>
473
 
      #
474
 
      #         <% reset_cycle("colors") %>
475
 
      #     </tr>
476
 
      #   <% end %>
477
 
      #   </table>
478
 
      def reset_cycle(name = "default")
479
 
        cycle = get_cycle(name)
480
 
        cycle.reset unless cycle.nil?
481
 
      end
482
 
 
483
 
      class Cycle #:nodoc:
484
 
        attr_reader :values
485
 
 
486
 
        def initialize(first_value, *values)
487
 
          @values = values.unshift(first_value)
488
 
          reset
489
 
        end
490
 
 
491
 
        def reset
492
 
          @index = 0
493
 
        end
494
 
 
495
 
        def current_value
496
 
          @values[previous_index].to_s
497
 
        end
498
 
 
499
 
        def to_s
500
 
          value = @values[@index].to_s
501
 
          @index = next_index
502
 
          return value
503
 
        end
504
 
 
505
 
        private
506
 
 
507
 
        def next_index
508
 
          step_index(1)
509
 
        end
510
 
 
511
 
        def previous_index
512
 
          step_index(-1)
513
 
        end
514
 
 
515
 
        def step_index(n)
516
 
          (@index + n) % @values.size
517
 
        end
518
 
      end
519
 
 
520
 
      private
521
 
        # The cycle helpers need to store the cycles in a place that is
522
 
        # guaranteed to be reset every time a page is rendered, so it
523
 
        # uses an instance variable of ActionView::Base.
524
 
        def get_cycle(name)
525
 
          @_cycles = Hash.new unless defined?(@_cycles)
526
 
          return @_cycles[name]
527
 
        end
528
 
 
529
 
        def set_cycle(name, cycle_object)
530
 
          @_cycles = Hash.new unless defined?(@_cycles)
531
 
          @_cycles[name] = cycle_object
532
 
        end
533
 
 
534
 
        AUTO_LINK_RE = %r{
535
 
            ( https?:// | www\. )
536
 
            [^\s<]+
537
 
          }x unless const_defined?(:AUTO_LINK_RE)
538
 
 
539
 
        BRACKETS = { ']' => '[', ')' => '(', '}' => '{' }
540
 
 
541
 
        # Turns all urls into clickable links.  If a block is given, each url
542
 
        # is yielded and the result is used as the link text.
543
 
        def auto_link_urls(text, html_options = {})
544
 
          link_attributes = html_options.stringify_keys
545
 
          text.gsub(AUTO_LINK_RE) do
546
 
            href = $&
547
 
            punctuation = ''
548
 
            left, right = $`, $'
549
 
            # detect already linked URLs and URLs in the middle of a tag
550
 
            if left =~ /<[^>]+$/ && right =~ /^[^>]*>/
551
 
              # do not change string; URL is alreay linked
552
 
              href
553
 
            else
554
 
              # don't include trailing punctuation character as part of the URL
555
 
              if href.sub!(/[^\w\/-]$/, '') and punctuation = $& and opening = BRACKETS[punctuation]
556
 
                if href.scan(opening).size > href.scan(punctuation).size
557
 
                  href << punctuation
558
 
                  punctuation = ''
559
 
                end
560
 
              end
561
 
 
562
 
              link_text = block_given?? yield(href) : href
563
 
              href = 'http://' + href unless href.index('http') == 0
564
 
 
565
 
              content_tag(:a, h(link_text), link_attributes.merge('href' => href)) + punctuation
566
 
            end
567
 
          end
568
 
        end
569
 
 
570
 
        # Turns all email addresses into clickable links.  If a block is given,
571
 
        # each email is yielded and the result is used as the link text.
572
 
        def auto_link_email_addresses(text, html_options = {})
573
 
          body = text.dup
574
 
          text.gsub(/([\w\.!#\$%\-+.]+@[A-Za-z0-9\-]+(\.[A-Za-z0-9\-]+)+)/) do
575
 
            text = $1
576
 
 
577
 
            if body.match(/<a\b[^>]*>(.*)(#{Regexp.escape(text)})(.*)<\/a>/)
578
 
              text
579
 
            else
580
 
              display_text = (block_given?) ? yield(text) : text
581
 
              mail_to text, display_text, html_options
582
 
            end
583
 
          end
584
 
        end
585
 
    end
586
 
  end
587
 
end