html_truncator 0.1.1 → 0.1.2

data/README.md

@@ -28,6 +28,9 @@ The HTML_Truncator class has only one method, `truncate`, with 3 arguments:
 * the number of words to keep (real words, tags and attributes aren't count)
 * the ellipsis (optional, '...' by default).
 
+And an attribute, `ellipsable_tags`, which lists the tags that can contain the ellipsis
+(by default: p ol ul li div header article nav section footer aside dd dt dl).
+
 
 Examples
 --------
@@ -40,17 +43,28 @@ A simple example:
 If the text is too short to be truncated, it won't be modified:
 
     HTML_Truncator.truncate("<p>Lorem ipsum dolor sit amet.</p>", 5)
-     => "<p>Lorem ipsum dolor sit amet.</p>"
+    # => "<p>Lorem ipsum dolor sit amet.</p>"
 
 You can customize the ellipsis:
 
     HTML_Truncator.truncate("<p>Lorem ipsum dolor sit amet.</p>", 3, " (truncated)")
-     => "<p>Lorem ipsum dolor (truncated)</p>"
+    # => "<p>Lorem ipsum dolor (truncated)</p>"
 
 And even have HTML in the ellipsis:
 
     HTML_Truncator.truncate("<p>Lorem ipsum dolor sit amet.</p>", 3, '<a href="/more-to-read">...</a>')
-     => "<p>Lorem ipsum dolor<a href="/more-to-read">...</a></p>"
+    # => "<p>Lorem ipsum dolor<a href="/more-to-read">...</a></p>"
+
+The ellipsis is put at the right place, inside `<p>`, but not `<i>`:
+
+    HTML_Truncator.truncate("<p><i>Lorem ipsum dolor sit amet.</i></p>", 3)
+    # => "<p><i>Lorem ipsum dolor</i>...</p>"
+
+You can indicate that a tag can contain the ellipsis but adding it to the ellipsable_tags:
+
+    HTML_Truncator.ellipsable_tags << "blockquote"
+    HTML_Truncator.truncate("<blockquote>Lorem ipsum dolor sit amet.</blockquote>", 3)
+    # => "<blockquote>Lorem ipsum dolor...</blockquote>"
 
 
 Alternatives
@@ -84,4 +98,9 @@ If you wants to make a pull request, please check the specs before:
     rspec spec
 
 
+Credits
+-------
+
+Thanks to François de Metz for his awesome help!
+
 Copyright (c) 2011 Bruno Michel <bmichel@menfin.info>, released under the MIT license

data/lib/html_truncator.rb

@@ -1,4 +1,5 @@
 require "nokogiri"
+require "set"
 
 
 class HTML_Truncator
@@ -6,6 +7,11 @@ class HTML_Truncator
     doc = Nokogiri::HTML::DocumentFragment.parse(text)
     doc.truncate(max_words, ellipsis).first
   end
+
+  class <<self
+    attr_accessor :ellipsable_tags
+  end
+  self.ellipsable_tags = Set.new(%w(p ol ul li div header article nav section footer aside dd dt dl))
 end
 
 
@@ -29,21 +35,19 @@ class Nokogiri::XML::Node
     self.children.each do |node|
       txt, nb, ellipsis = node.truncate(remaining, ellipsis)
       remaining -= nb
-      if remaining < 0
-        inner += txt
-        if ellipsable?
-          inner += ellipsis
-          ellipsis = ""
-        end
-        break
-      end
       inner += txt
+      next if remaining >= 0
+      if ellipsable?
+        inner += ellipsis
+        ellipsis = ""
+      end
+      break
     end
     [inner, remaining, ellipsis]
   end
 
   def ellipsable?
-    %w(p ol ul li div header article nav section footer aside dd dt dl).include? name
+    HTML_Truncator.ellipsable_tags.include? name
   end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Bruno Michel
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 +01:00
+date: 2011-01-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency