html_truncator 0.1.0

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bruno Michel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+HTML Truncator
+==============
+
+Wants to truncate an HTML string properly? This gem is for you.
+It's powered by [Nokogiri](http://nokogiri.org/)!
+
+
+How to use it
+-------------
+
+It's very simple. Install it with rubygems:
+
+    gem install html_truncator
+
+Or, if you use bundler, add it to your `Gemfile`:
+
+    gem "html_truncator", :version => "~>0.1"
+
+Then you can use it in your code:
+
+    require "html_truncator"
+	HTML_Truncator.truncate("<p>Lorem ipsum dolor sit amet.</p>", 3)
+	# => "<p>Lorem ipsum dolor...</p>"
+
+The HTML_Truncator class has only one method, `truncate`, with 3 arguments:
+
+* the HTML-formatted string to truncate
+* the number of words to keep (real words, tags and attributes aren't count)
+* the ellipsis (optional, '...' by default).
+
+
+Examples
+--------
+
+A simple example:
+
+	HTML_Truncator.truncate("<p>Lorem ipsum dolor sit amet.</p>", 3)
+	# => "<p>Lorem ipsum dolor...</p>"
+
+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>"
+
+You can customize the ellipsis:
+
+    HTML_Truncator.truncate("<p>Lorem ipsum dolor sit amet.</p>", 3, " (truncated)")
+     => "<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>"
+
+
+Alternatives
+------------
+
+Rails has a `truncate` helper, but as the doc says:
+
+> Care should be taken if text contains HTML tags or entities,
+  because truncation may produce invalid HTML (such as unbalanced or incomplete tags).
+
+I know there are some Ruby code to truncate HTML, like:
+
+* https://github.com/hgimenez/truncate_html
+* https://gist.github.com/101410
+* http://henrik.nyh.se/2008/01/rails-truncate-html-helper
+* http://blog.madebydna.com/all/code/2010/06/04/ruby-helper-to-cleanly-truncate-html.html
+
+But I'm not pleased with these solutions: they are either based on regexp for
+parsing the content (too fragile), they don't put the ellipsis where expected,
+they cut words and sometimes leave empty DOM nodes. So I made my own gem ;-)
+
+
+Issues or Suggestions
+---------------------
+
+Found an issue or have a suggestion? Please report it on
+[Github's issue tracker](http://github.com/nono/HTML-Truncator/issues).
+
+If you wants to make a pull request, please check the specs before:
+
+    rspec spec
+
+
+Copyright (c) 2011 Bruno Michel <bmichel@menfin.info>, released under the MIT license

data/lib/html_truncator.rb

@@ -0,0 +1,50 @@
+require "nokogiri"
+
+
+class HTML_Truncator
+  def self.truncate(text, max_words, ellipsis="...")
+    doc = Nokogiri::HTML::DocumentFragment.parse(text)
+    doc.truncate(max_words, ellipsis)
+  end
+end
+
+
+class Nokogiri::HTML::DocumentFragment
+  def truncate(max_words, ellipsis)
+    inner_truncate(max_words, ellipsis).first
+  end
+end
+
+class Nokogiri::XML::Node
+  def truncate(max_words, ellipsis)
+    inner, remaining = inner_truncate(max_words, ellipsis)
+    children.remove
+    add_child Nokogiri::HTML::DocumentFragment.parse(inner)
+    [to_xml, max_words - remaining]
+  end
+
+  def inner_truncate(max_words, ellipsis)
+    inner, remaining = "", max_words
+    self.children.each do |node|
+      txt, nb = node.truncate(remaining, ellipsis)
+      remaining -= nb
+      inner += txt
+      break if remaining < 0
+    end
+    [inner, remaining]
+  end
+
+  def nb_words
+    inner_text.split.length
+  end
+end
+
+class Nokogiri::XML::Text
+  def truncate(max_words, ellipsis)
+    words    = content.split
+    nb_words = words.length
+    return [to_xhtml, nb_words] if nb_words <= max_words
+    return [ellipsis, 1] if max_words == 0
+    [words.slice(0, max_words).join(' ') + ellipsis, nb_words]
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: html_truncator
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bruno Michel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        version: "2.4"
+  type: :development
+  version_requirements: *id002
+description: Wants to truncate an HTML string properly? This gem is for you.
+email: bmichel@menfin.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Gemfile
+- lib/html_truncator.rb
+has_rdoc: true
+homepage: http://github.com/nono/HTML-Truncator
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wants to truncate an HTML string properly? This gem is for you.
+test_files: []
+