truncate_html 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/README.markdown

@@ -29,14 +29,13 @@ Installation
 #### As a gem
 Add this to your <code>config/environment.rb</code>:
 
-    config.gem 'hgimenez-truncate_html',
-      :source => 'http://gems.github.com',
-      :lib    => 'truncate_html'
+    config.gem 'truncate_html',
+      :source => 'http://gemcutter.org'
 
 Then either
-<code>sudo gem install hgimenez-truncate_html</code>
-or
 <code>sudo rake gems:install</code>
+or
+<code>sudo gem install truncate_html</code>
 
 #### As a plugin:
 <code>script/plugin install git://github.com/hgimenez/truncate_html.git</code>

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/truncate_html/html_truncator.rb

@@ -8,6 +8,7 @@ module TruncateHtml
     end
 
     def truncate(options = {})
+      return '' if @original_html.nil?
       options[:length] ||= 100
       options[:omission] ||= '...'
       @chars_remaining = options[:length]
@@ -36,9 +37,6 @@ module TruncateHtml
       result.join('')
     end
 
-
-    private #############################
-
     def html_tokens
       @original_html.scan(/<\/?[^>]+>|[\w\|`~!@#\$%^&*\(\)\-_\+=\[\]{}:;'",\.\/?]+|\s+/).map do
         |t| t.gsub(

data/spec/helpers/truncate_html_helper_spec.rb

@@ -4,18 +4,25 @@ include TruncateHtmlHelper
 
 describe TruncateHtmlHelper do
 
-  it 'should be included in ActionView::Base' do
+  it 'is included in ActionView::Base' do
     ActionView::Base.included_modules.should include(TruncateHtmlHelper)
   end
 
   describe '#truncate_html' do
 
+    context 'the input html is nil' do
+      it 'returns an empty string' do
+        truncate_html(nil).should be_empty
+        truncate_html(nil).should be_kind_of String
+      end
+    end
+
     context 'truncating in the middle of a link' do
       before(:each) do
         @html = '<div><ul><li>Look at <a href="foo">this</a> link </li></ul></div>'
       end
 
-      it 'should truncate, and close the <a>, and close any remaining open tags' do
+      it 'truncates, and closes the <a>, and closes any remaining open tags' do
         truncate_html(@html, :length => 10).should == '<div><ul><li>Look at <a href="foo">this...</a></li></ul></div>'
       end
     end
@@ -25,7 +32,7 @@ describe TruncateHtmlHelper do
         before(:each) do
           @html = "<p>Look at <strong>this</strong>#{char} More words here</p>"
         end
-        it 'should place the punctuation after the tag without any whitespace' do
+        it 'places the punctuation after the tag without any whitespace' do
           truncate_html(@html, :length => 16).should == "<p>Look at <strong>this</strong>#{char} More...</p>"
         end
       end
@@ -35,7 +42,7 @@ describe TruncateHtmlHelper do
       before(:each) do
         @html = '<p>Look at <a href="awesomeful.net">this</a> link for randomness</p>'
       end
-      it 'should leave a whitespace between the closing tag and the following word character' do
+      it 'leaves a whitespace between the closing tag and the following word character' do
         truncate_html(@html, :length => 17).should == '<p>Look at <a href="awesomeful.net">this</a> link...</p>'
       end
     end
@@ -51,7 +58,7 @@ describe TruncateHtmlHelper do
         END_HTML
       end
 
-      it 'should recognize the multiline html properly' do
+      it 'recognizes the multiline html properly' do
         truncate_html(@html, :length => 8).should == ' <div id="foo" class="bar"> This is...</div>'
       end
     end
@@ -64,7 +71,7 @@ describe TruncateHtmlHelper do
             @html = "<div>Some before. <#{unpaired_tag}>and some after</div>"
             @html_caps = "<div>Some before. <#{unpaired_tag.capitalize}>and some after</div>"
           end
-          it "should not close the #{unpaired_tag} tag" do
+          it "does not close the #{unpaired_tag} tag" do
             truncate_html(@html, :length => 15).should == "<div>Some before. <#{unpaired_tag}>and...</div>"
             truncate_html(@html_caps, :length => 15).should == "<div>Some before. <#{unpaired_tag.capitalize}>and...</div>"
           end
@@ -75,7 +82,7 @@ describe TruncateHtmlHelper do
             @html = "<div>Some before. <#{unpaired_tag} />and some after</div>"
             @html_caps = "<div>Some before. <#{unpaired_tag.capitalize} />and some after</div>"
           end
-          it "should not close the #{unpaired_tag} tag" do
+          it "does not close the #{unpaired_tag} tag" do
             truncate_html(@html, :length => 15).should == "<div>Some before. <#{unpaired_tag} />and...</div>"
             truncate_html(@html_caps, :length => 15).should == "<div>Some before. <#{unpaired_tag.capitalize} />and...</div>"
           end

data/spec/truncate_html/html_truncator_spec.rb

@@ -2,69 +2,68 @@ require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe TruncateHtml::HtmlTruncator do
 
+  def truncator(html = nil)
+    @truncator ||= TruncateHtml::HtmlTruncator.new(html)
+  end
+
   describe '#html_tokens' do
     before(:each) do
       @html = '<h1>Hi there</h1> <p>This is sweet!</p>'
-      @truncator = TruncateHtml::HtmlTruncator.new @html
     end
 
-    it 'should return each token in the string as an array element' do
-      @truncator.send(:html_tokens).should == ['<h1>', 'Hi', ' ', 'there', '</h1>', ' ', '<p>', 'This', ' ', 'is', ' ', 'sweet!', '</p>']
+    it 'returns each token in the string as an array element' do
+      truncator(@html).html_tokens.should == ['<h1>', 'Hi', ' ', 'there', '</h1>', ' ', '<p>', 'This', ' ', 'is', ' ', 'sweet!', '</p>']
     end
   end
 
   describe '#html_tag?' do
 
-    before(:each) do
-      @truncator = TruncateHtml::HtmlTruncator.new 'foo'
-    end
-
-    it 'should be false when the string parameter is not an html tag' do
-      @truncator.send(:html_tag?, 'no tags').should be_false
+    it 'returns false when the string parameter is not an html tag' do
+      truncator.html_tag?('no tags').should be_false
     end
 
-    it 'should be true when the string parameter is an html tag' do
-      @truncator.send(:html_tag?, '<img src="foo">').should be_true
-      @truncator.send(:html_tag?, '</img>').should be_true
+    it 'returns true when the string parameter is an html tag' do
+      truncator.html_tag?('<img src="foo">').should be_true
+      truncator.html_tag?('</img>').should be_true
     end
 
   end
 
   describe '#open_tag?' do
 
-    before(:each) do
-      @truncator = TruncateHtml::HtmlTruncator.new 'foo'
+    it 'returns true if the tag is an open tag' do
+      truncator.open_tag?('<a>').should be_true
     end
 
-    it 'should be true if the tag is an open tag' do
-      @truncator.send(:open_tag?, '<a>').should be_true
+    it 'returns true if the tag is an open tag, and has whitespace and html properties with either single or double quotes' do
+      truncator.open_tag?(' <a href="http://awesomeful.net">').should be_true
+      truncator.open_tag?(" <a href='http://awesomeful.net' >").should be_true
     end
 
-    it 'should be true if the tag is an open tag, and has whitespace and html properties with either single or double quotes' do
-      @truncator.send(:open_tag?, ' <a href="http://awesomeful.net">').should be_true
-      @truncator.send(:open_tag?, " <a href='http://awesomeful.net' >").should be_true
+    it 'returns false if the tag is a close tag' do
+      truncator.open_tag?('</a>').should be_false
     end
 
-    it 'should be false if the tag is a close tag' do
-      @truncator.send(:open_tag?, '</a>').should be_false
-    end
-
-    it 'should be false if the string is not an html tag' do
-      @truncator.send(:open_tag?, 'foo bar').should be_false
+    it 'returns false if the string is not an html tag' do
+      truncator.open_tag?('foo bar').should be_false
     end
   end
 
   describe '#matching_close_tag' do
 
-    before(:each) do
-      @truncator = TruncateHtml::HtmlTruncator.new 'foo'
+    it 'closes a tag given an open tag' do
+      truncator.matching_close_tag('<a>').should == '</a>'
+      truncator.matching_close_tag(' <div>').should == '</div>'
+      truncator.matching_close_tag('<h1>').should == '</h1>'
+      truncator.matching_close_tag('<a href="foo">').should == '</a>'
     end
+  end
+
+  describe 'nil string' do
 
-    it 'should close a tag given an open tag' do
-      @truncator.send(:matching_close_tag, '<a>').should == '</a>'
-      @truncator.send(:matching_close_tag, ' <div>').should == '</div>'
-      @truncator.send(:matching_close_tag, '<h1>').should == '</h1>'
-      @truncator.send(:matching_close_tag, '<a href="foo">').should == '</a>'
+    it 'returns an empty string' do
+      truncator(nil).truncate.should be_empty
+      truncator(nil).truncate.should be_kind_of String
     end
   end
 

data/truncate_html.gemspec

@@ -2,18 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{truncate_html}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["hgimenez"]
-  s.date = %q{2009-08-25}
+  s.date = %q{2009-09-25}
   s.description = %q{Truncates html so you don't have to}
   s.email = %q{harold.gimenez@gmail.com}
   s.extra_rdoc_files = [
     "README.markdown"
   ]
   s.files = [
-    "README.markdown",
+    ".gitignore",
+     "README.markdown",
      "Rakefile",
      "VERSION",
      "init.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: truncate_html
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - hgimenez
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-25 00:00:00 -04:00
+date: 2009-09-25 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -22,6 +22,7 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 files: 
+- .gitignore
 - README.markdown
 - Rakefile
 - VERSION