peppercorn 0.0.1 → 0.0.2

data/.yardopts

@@ -0,0 +1 @@
+- README.md CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+Changelog
+===
+
+* 0.0.1 2011/10/25 Initial Release
+* 0.0.2 2011/10/28 Some refactoring and Added Nokogiri::XML::Node#appendable_node

data/Guardfile

@@ -5,6 +5,7 @@ guard 'yard' do
   watch(%r{app/.+\.rb})
   watch(%r{lib/.+\.rb})
   watch(%r{ext/.+\.(c|cpp|rb)})
+  watch(%r{.*\.md}) { "doc" }
 end
 
 guard 'rspec', :version => 2 do

data/{README → README.md}

@@ -1,4 +1,5 @@
-== License
+License
+=======
 
 Copyright (c) 2011 Wade West
 

data/lib/peppercorn/string.rb

@@ -8,7 +8,7 @@ module Peppercorn
     # @since 0.0.1
     # @param [Fixnum] length the number of word to truncate on
     # @param [Hash] opts hash of truncation options
-    # @option opts [String, nil] :tail ("…") the string to append to the truncated string
+    # @option opts [#to_s, nil] :tail ("…") the object to append to the truncated string
     # @return [String] the truncated string
     def truncate(length=30, opts={})
       opts = Peppercorn::DEFAULT_TRUNCATION_OPTIONS.merge(opts)
@@ -45,8 +45,7 @@ module Peppercorn
     # @return [String] the truncated html
     # @option opts [String, Nokogiri::XML::Node, nil] :tail ("…") string or xml node to append to the truncated string
     def truncate_html(length=30, opts={})
-      string = Nokogiri::HTML::DocumentFragment.parse(self).truncate(length, opts)
-      return string
+      Nokogiri::HTML::DocumentFragment.parse(self).truncate(length, opts)
     end
   end
 end

data/lib/peppercorn/version.rb

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

data/lib/peppercorn/xml/node.rb

@@ -42,21 +42,27 @@ module Peppercorn
         end
         
         if !opts[:tail].to_s.empty? and overran
-          append_to = target.children.last
-          loop do
-            if append_to.text? or append_to.description.inline? # We want to append to the last block-level element
-              append_to = append_to.parent
-              break;
-            end
-            append_to = append_to.children.last
-          end
-          append_to << Nokogiri::HTML::DocumentFragment.parse(opts[:tail])
+          target.appendable_node << Nokogiri::HTML::DocumentFragment.parse(opts[:tail])
         end
         
         target = target.inner_html unless opts[:return_node]
         return opts[:return_hash] ? {:text => target, :count => [count, length].min, :overran => overran} : target
     
       end
+      
+      # Returns the last appendable child node (the last block-level element)
+      # return [Nokogiri::XML::Node]
+      # since 0.0.2
+      def appendable_node
+        current = children.last
+        loop do
+          if current.text? or current.description.inline?
+            return current.parent
+          end
+          current = current.children.last
+        end
+        return current
+      end
   
       # Returns the last child node that is a text node
       # @return [Nokogiri::XML::Node] the last text node

data/peppercorn.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Peppercorn::VERSION
   s.authors     = ["Wade West"]
   s.email       = ["wwest81@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/wadewest/peppercorn"
   s.summary     = %q{A simple gem to truncate HTML, with other features coming in the future.}
   s.description = %q{A simple gem to truncate HTML, with other features coming in the future.}
 
@@ -23,7 +23,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec", "~> 2.7"
   s.add_development_dependency "guard-rspec", "~> 0.5"
   s.add_development_dependency "guard-yard", "~> 1.0"
+  s.add_development_dependency "rdiscount", "~> 1.6"
   # s.add_runtime_dependency "rest-client"
   # s.add_dependency "htmlentities"
-  s.add_dependency "nokogiri"
+  s.add_dependency "nokogiri", "~> 1.5"
 end

data/spec/peppercorn/string_spec.rb

@@ -6,6 +6,16 @@ describe String do
     @string = "Hello World, I make HTML truncation easy."
   end
   
+  it "should be able to strip whitespaces from the end of the string" do
+    "    \t\t\t#{@string}\t   \r\n".strip_end.should eql "    \t\t\t#{@string}"
+  end
+  
+  it "should be able to strip HTML tags from the string" do
+    string = "The quick brown fox jumps over the lazy dog."
+    html = "<p class=\"example\">The <em>quick</em> brown <i>fox jumps</i> over the lazy dog.</p>"
+    html.strip_html.should eql string
+  end
+  
   it "should properly truncate a string" do
     @string.truncate(5).should eql "Hello World, I make HTML&#8230;"
   end
@@ -18,4 +28,19 @@ describe String do
     "<em>#{@string}</em>".truncate_html(5).should eql "<em>Hello World, I make HTML</em>&#8230;"
   end
   
+  it "should truncate HTML just like plain text when the HTML contains no tags" do 
+    html = @string
+    html.truncate_html(3).should eql @string.truncate(3)
+  end
+  
+  it "should allow a link in the tail" do
+    opts = {:tail => "...<a href=\"some_page.html\">Read More</a>"}
+    @string.truncate(3, opts).should eql "Hello World, I#{opts[:tail]}"
+  end
+  
+  it "should be able to use a Nokogiri::XML::Node as the tail" do
+    opts = {:tail => Nokogiri::HTML::DocumentFragment.parse("...<a href=\"some_page.html\">Read More</a>")}
+    @string.truncate(3, opts).should eql "Hello World, I#{opts[:tail].to_s}"
+  end
+  
 end

data/spec/peppercorn/xml/node_spec.rb

@@ -3,16 +3,20 @@ require 'spec_helper'
 describe String do
   
   before do
-    @string = "<p><em class='strong'>Hello World</em>, I <i>can</i> make HTML truncation easy.</p>"
+    @string = "<p class=\"appendable\"><em class=\"strong\">Hello World</em>, I <i>can</i> make HTML truncation <i>easy.</i></p>"
     @html = Nokogiri::HTML::DocumentFragment.parse @string
   end
 
   it "should properly truncate some simple HTML" do
-    @html.truncate(6).should eql "<p><em class=\"strong\">Hello World</em>, I <i>can</i> make HTML&#8230;</p>"
+    @html.truncate(6).should eql "<p class=\"appendable\"><em class=\"strong\">Hello World</em>, I <i>can</i> make HTML&#8230;</p>"
   end
 
   it "should not truncate some HTML that is shorter than length" do
-    @html.truncate(30).should eql @html.to_s
+    @html.truncate(30).should eql @string
+  end
+  
+  it "should return the last appendable node" do
+    @html.appendable_node.attribute('class').to_s.should eql "appendable"
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peppercorn
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-26 00:00:00.000000000Z
+date: 2011-10-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70354207037860 !ruby/object:Gem::Requirement
+  requirement: &70336758482100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70354207037860
+  version_requirements: *70336758482100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70354207035900 !ruby/object:Gem::Requirement
+  requirement: &70336758481140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *70354207035900
+  version_requirements: *70336758481140
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70354207034020 !ruby/object:Gem::Requirement
+  requirement: &70336758479500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *70354207034020
+  version_requirements: *70336758479500
 - !ruby/object:Gem::Dependency
   name: guard-yard
-  requirement: &70354207032280 !ruby/object:Gem::Requirement
+  requirement: &70336758478160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,18 +54,29 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70354207032280
+  version_requirements: *70336758478160
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &70336758476840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70336758476840
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70354207031480 !ruby/object:Gem::Requirement
+  requirement: &70336758475660 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70354207031480
+  version_requirements: *70336758475660
 description: A simple gem to truncate HTML, with other features coming in the future.
 email:
 - wwest81@gmail.com
@@ -74,10 +85,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - Procfile
-- README
+- README.md
 - Rakefile
 - lib/peppercorn.rb
 - lib/peppercorn/string.rb
@@ -88,7 +101,7 @@ files:
 - spec/peppercorn/string_spec.rb
 - spec/peppercorn/xml/node_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/wadewest/peppercorn
 licenses: []
 post_install_message: 
 rdoc_options: []