padrino-helpers 0.9.28 → 0.9.29

data/README.rdoc

@@ -196,12 +196,13 @@ passing javascript information from a js template to a javascript function.
 There is also an alias for escape_html called <tt>h</tt> for even easier usage within templates.
 
 Format helpers also includes a number of useful text manipulation functions such as <tt>simple_format</tt>,
-<tt>pluralize</tt>, <tt>word_wrap</tt>, and <tt>truncate</tt>.
+<tt>pluralize</tt>, <tt>word_wrap</tt>, <tt>truncate</tt> and <tt>truncate_words</tt>.
 
   simple_format("hello\nworld") # => "<p>hello<br/>world</p>"
   pluralize(2, 'person') => '2 people'
   word_wrap('Once upon a time', :line_width => 8) => "Once upon\na time"
   truncate("Once upon a time in a world far far away", :length => 8) => "Once upon..."
+  truncate_words("Once upon a time in a world far far away", :length => 4) => "Once upon a time..."
 
 These helpers can be invoked from any route or view within your application.
 

data/lib/padrino-helpers/format_helpers.rb

@@ -75,6 +75,22 @@ module Padrino
           (chars.length > options[:length] ? chars[0...len] + options[:omission] : text).to_s
         end
       end
+      
+      ##
+      # Truncates words of a given text after a given :length if number of words in text is more than :length (defaults to 30).
+      # The last words will be replaced with the :omission (defaults to "…") for a total number of words not exceeding :length.
+      #
+      # ==== Examples
+      #
+      #   truncate_words("Once upon a time in a world far far away", :length => 8) => "Once upon a time in a world far..."
+      #
+      def truncate_words(text, options={})
+        options.reverse_merge!(:length => 30, :omission => "...")
+        if text
+          words = text.split()
+          words[0..(options[:length]-1)].join(' ') + (words.length > options[:length] ? options[:omission] : '')
+        end
+      end
 
       ##
       # Wraps the text into lines no longer than line_width width.

data/test/test_format_helpers.rb

@@ -109,20 +109,35 @@ class TestFormatHelpers < Test::Unit::TestCase
     end
   end
 
+  context 'for #truncate_words method' do
+    should "support default truncation" do
+      actual_text = truncate_words("Long before books were made, people told stories. They told them to one another and to the children as they sat before the fire. Many of these stories were about interesting people, but most of them were about the ways of fairies and giants.")
+      assert_equal "Long before books were made, people told stories. They told them to one another and to the children as they sat before the fire. Many of these stories were about...", actual_text
+    end
+    should "support specifying length" do
+      actual_text = truncate_words("Once upon a time in a world far far away", :length => 8)
+      assert_equal "Once upon a time in a world far...", actual_text
+    end
+    should "support specifying omission text" do
+      actual_text = truncate_words("And they found that many people were sleeping better.", :length => 4, :omission => "(clipped)")
+      assert_equal "And they found that(clipped)", actual_text
+    end
+  end
+
   context 'for #h and #h! method' do
     should "escape the simple html" do
-      assert_equal '&lt;h1&gt;hello&lt;/h1&gt;', h('<h1>hello</h1>')
-      assert_equal '&lt;h1&gt;hello&lt;/h1&gt;', escape_html('<h1>hello</h1>')
+      assert_equal '&lt;h1&gt;hello&lt;&#x2F;h1&gt;', h('<h1>hello</h1>')
+      assert_equal '&lt;h1&gt;hello&lt;&#x2F;h1&gt;', escape_html('<h1>hello</h1>')
     end
     should "escape all brackets, quotes and ampersands" do
-      assert_equal '&lt;h1&gt;&lt;&gt;&quot;&amp;demo&amp;&quot;&lt;&gt;&lt;/h1&gt;', h('<h1><>"&demo&"<></h1>')
+      assert_equal '&lt;h1&gt;&lt;&gt;&quot;&amp;demo&amp;&quot;&lt;&gt;&lt;&#x2F;h1&gt;', h('<h1><>"&demo&"<></h1>')
     end
     should "return default text if text is empty" do
       assert_equal 'default', h!("", "default")
       assert_equal '&nbsp;', h!("")
     end
     should "return text escaped if not empty" do
-      assert_equal '&lt;h1&gt;hello&lt;/h1&gt;', h!('<h1>hello</h1>')
+      assert_equal '&lt;h1&gt;hello&lt;&#x2F;h1&gt;', h!('<h1>hello</h1>')
     end
   end
 

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: padrino-helpers
 version: !ruby/object:Gem::Version 
-  hash: 3
   prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 28
-  version: 0.9.28
+  version: 0.9.29
 platform: ruby
 authors: 
 - Padrino Team
@@ -18,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-11 00:00:00 Z
+date: 2011-05-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: padrino-core
@@ -28,12 +23,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 9
-        - 28
-        version: 0.9.28
+        version: 0.9.29
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -44,11 +34,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 4
-        - 1
         version: 0.4.1
   type: :runtime
   version_requirements: *id002
@@ -169,20 +154,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []