peppercorn 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 Changelog
 ===
 
-* 0.0.1 2011/10/25 Initial Release
-* 0.0.2 2011/10/28 Some refactoring and Added Nokogiri::XML::Node#appendable_node
+* 0.0.3 2011/11/04
+  * Renamed String#truncate to String#peppercorn_truncate so peppercorn will work with rails
+
+* 0.0.2 2011/10/28
+  * Some refactoring and Added Nokogiri::XML::Node#appendable_node
+
+* 0.0.1 2011/10/25
+  * Initial Release

data/README.md

@@ -1,3 +1,23 @@
+About Peppercorn
+================
+
+Peppercorn aims to be a simple and easy to use library for truncating HTML properly.  It works using the 
+fast Nokogiri ruby gem to parse a string of HTML into a document fragment.  Then steppes through that document's
+children until it has counted the desired number of words.
+
+Usage
+=====
+
+The simple case is a simple string: "Hello World"
+    "Hello World".truncate_html(1)  # => "Hello…"
+
+Of course if you don't like "…" on the end you could use something else:
+    "Hello World".truncate_html(1, :tail => " All")  # => "Hello All"
+
+
+
+{include:file:CHANGELOG.md}
+
 License
 =======
 

data/lib/peppercorn/string.rb

@@ -5,12 +5,12 @@ module Peppercorn
   module String
   
     # Truncate a string to "length" words
-    # @since 0.0.1
+    # @since 0.0.3
     # @param [Fixnum] length the number of word to truncate on
     # @param [Hash] opts hash of truncation options
     # @option opts [#to_s, nil] :tail ("…") the object to append to the truncated string
     # @return [String] the truncated string
-    def truncate(length=30, opts={})
+    def peppercorn_truncate(length=30, opts={})
       opts = Peppercorn::DEFAULT_TRUNCATION_OPTIONS.merge(opts)
       tokens = scan(/\W*\w+\W*/)
       string_tokens = tokens[0...length]
@@ -24,12 +24,18 @@ module Peppercorn
       end
       return opts[:return_hash] ? {:text => string, :overran => overran, :count => [length, tokens.size].min} : string
     end
+    
+    # Alias for #peppercorn_truncate
+    # @since 0.0.1
+    def truncate(length=30, opts={})
+      peppercorn_truncate(length, opts)
+    end
   
     # Strips all whitespaces from the end of the string
     # @since 0.0.1
     # @return [String] the stripped version of the string
     def strip_end
-      return sub(/(\s+)$/, '')
+      return rstrip
     end
   
     # Returns the string with all HTML tags removed

data/lib/peppercorn/version.rb

@@ -1,4 +1,4 @@
 module Peppercorn
   # The current peppercorn version
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/peppercorn/xml/node.rb

@@ -17,7 +17,7 @@ module Peppercorn
         overran = false
     
         if doc.text?
-          result = content.truncate(length, opts.merge(Peppercorn::TRUNCATE_CHILD_OPTS))
+          result = content.peppercorn_truncate(length, opts.merge(Peppercorn::TRUNCATE_CHILD_OPTS))
           target = result[:text]
           count = result[:count]
           overran = result[:overran]
@@ -38,7 +38,7 @@ module Peppercorn
         
         if opts[:strip]
           last_text_node = target.last_text_node
-          last_text_node.content = last_text_node.content.sub(/(\s+)$/, '') if last_text_node
+          last_text_node.content = last_text_node.content.strip_end if last_text_node
         end
         
         if !opts[:tail].to_s.empty? and overran

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peppercorn
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-28 00:00:00.000000000Z
+date: 2011-11-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70336758482100 !ruby/object:Gem::Requirement
+  requirement: &70250050848180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70336758482100
+  version_requirements: *70250050848180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70336758481140 !ruby/object:Gem::Requirement
+  requirement: &70250050847680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *70336758481140
+  version_requirements: *70250050847680
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70336758479500 !ruby/object:Gem::Requirement
+  requirement: &70250050847180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *70336758479500
+  version_requirements: *70250050847180
 - !ruby/object:Gem::Dependency
   name: guard-yard
-  requirement: &70336758478160 !ruby/object:Gem::Requirement
+  requirement: &70250050846720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70336758478160
+  version_requirements: *70250050846720
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70336758476840 !ruby/object:Gem::Requirement
+  requirement: &70250050846260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *70336758476840
+  version_requirements: *70250050846260
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70336758475660 !ruby/object:Gem::Requirement
+  requirement: &70250050845800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70336758475660
+  version_requirements: *70250050845800
 description: A simple gem to truncate HTML, with other features coming in the future.
 email:
 - wwest81@gmail.com