truncateHTML 0.0.1 → 1.0.0

data/README.md

@@ -0,0 +1,38 @@
+truncateHTML
+==============
+`truncateHTML` truncates text like the Rails `truncate` helper but doesn't break HTML tags, entities, and optionally words.
+
+Installation
+------------
+
+The `truncateHTML` gem can be installed by running:
+
+    gem install truncateHTML
+
+Usage
+-----
+
+    require 'rubygems'
+    require 'truncateHTML'
+
+A string `html_string` can be truncated by running:
+
+    truncateHTML.truncate(`html_string`) 
+
+The following options can be passed to the `trucate` method:
+
+- `:max_length` The maximum length of the out put. Defaults to 40
+- `:ellipsis` The last few characters , in case the string is truncated. Defaults to `...`
+- `:words` Splicing words will be avoided if set to ttrue. Defaults to false.
+- `:link` A link will be appended to the truncated string if explicitely passed. Its by default nil.
+
+Author
+------
+
+B V Satyaram <[bvsatyaram.com](http://bvsatyaram.com)>
+
+- Initially authored By Henrik Nyh <[henrik.nyh.se](http://henrik.nyh.se)> 2008-01-30. Free to modify and redistribute with credit.
+- Modified by Dave Nolan <[textgoeshere.org.uk](http://textgoeshere.org.uk)> 2008-02-06. Ellipsis appended to text of last HTML node. Ellipsis inserted after final word break
+- Modified by Mark Dickson <mark@sitesteaders.com> 2008-12-18. Option to truncate to last full word. Option to include a 'more' link. Check for nil last child
+- Modified by Ken-ichi Ueda <[kueda.net](http://kueda.net)> 2009-09-02. Rails 2.3 compatability (chars -> mb_chars), via Henrik. Hpricot 0.8 compatability (avoid dup on Hpricot::Elem)
+- Modified by B V Satyaram <[bvsatyaram.com](http://bvsatyaram.com)> 2011-03-24. Rails version independent. Making this a gem. Removed mb_chars

data/lib/truncateHTML.rb

@@ -23,7 +23,7 @@ require "hpricot"
 require "truncateHTML/hpricot_truncator"
 
 module TruncateHTML
-  # Like the Rails _truncate_ helper but doesn't break HTML tags, entities, and optionally. words.
+  # Like the Rails _truncate_ helper but doesn't break HTML tags, entities, and optionally words.
   def self.truncate(text, options={})
     return if text.nil?
 
@@ -57,4 +57,4 @@ module TruncateHTML
 
     return status ? [return_string, return_status] : return_string
   end
-end
+end

data/lib/truncateHTML/version.rb

@@ -1,3 +1,3 @@
 module Truncatehtml
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: truncateHTML
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Satyaram B V
@@ -15,18 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-26 00:00:00 +05:30
+date: 2011-05-04 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -44,6 +41,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - lib/truncateHTML.rb
 - lib/truncateHTML/hpricot_truncator.rb
@@ -60,27 +58,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   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: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: truncateHTML
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Truncate HTML without breaking HTML tags, entities, and optionally words