peppercorn 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc
+doc/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in peppercorn.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'yard' do
+  watch(%r{app/.+\.rb})
+  watch(%r{lib/.+\.rb})
+  watch(%r{ext/.+\.(c|cpp|rb)})
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+

data/Procfile

@@ -0,0 +1,2 @@
+guard:    guard
+yard:     yard server -p 3001

data/README

@@ -0,0 +1,9 @@
+== License
+
+Copyright (c) 2011 Wade West
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/peppercorn/string.rb

@@ -0,0 +1,57 @@
+require 'nokogiri'
+
+module Peppercorn
+  # Peppercorn extension to the String class
+  module String
+  
+    # Truncate a string to "length" words
+    # @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
+    # @return [String] the truncated string
+    def truncate(length=30, opts={})
+      opts = Peppercorn::DEFAULT_TRUNCATION_OPTIONS.merge(opts)
+      tokens = scan(/\W*\w+\W*/)
+      string_tokens = tokens[0...length]
+      string = string_tokens.join
+      overran = length <= tokens.size
+      string = string.strip_end if opts[:strip]
+      string << opts[:tail].to_s if overran
+      if opts[:return_node]
+        string = Nokogiri::HTML::DocumentFragment.parse(string)
+        string = string.child if string.children.size == 1
+      end
+      return opts[:return_hash] ? {:text => string, :overran => overran, :count => [length, tokens.size].min} : string
+    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+)$/, '')
+    end
+  
+    # Returns the string with all HTML tags removed
+    # @since 0.0.1
+    # @return [String] the string stripped of all HTML
+    def strip_html
+      return Nokogiri::HTML::DocumentFragment.parse(self).inner_text
+    end
+  
+    # Truncate a string of html to "length" words
+    # @since 0.0.1
+    # @param (see #truncate)
+    # @return [String] the truncated html
+    # @option opts [String, Nokogiri::XML::Node, nil] :tail ("&#8230;") 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
+    end
+  end
+end
+
+# Include Peppercorn::String in String
+class String
+  include Peppercorn::String
+end

data/lib/peppercorn/version.rb

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

data/lib/peppercorn/xml/node.rb

@@ -0,0 +1,82 @@
+require 'nokogiri'
+
+module Peppercorn
+  
+  module XML
+    
+    # Extensions to Nokogiri::XML::Node
+    module Node
+  
+      # (see Peppercorn::String#truncate_html)
+      def truncate(length, opts={})
+        opts = Peppercorn::DEFAULT_TRUNCATION_OPTIONS.merge(opts)
+    
+        doc = self
+        target = nil
+        count = 0
+        overran = false
+    
+        if doc.text?
+          result = content.truncate(length, opts.merge(Peppercorn::TRUNCATE_CHILD_OPTS))
+          target = result[:text]
+          count = result[:count]
+          overran = result[:overran]
+        else
+          target = doc.clone
+          target.children.remove
+          doc.children.each do |child|
+            result = child.truncate(length-count, opts.merge(Peppercorn::TRUNCATE_CHILD_OPTS))
+            count += result[:count]
+            overran = result[:overran]
+            target << result[:text]
+            break if overran
+          end
+        end
+        
+        return nil if target.nil?
+        
+        
+        if opts[:strip]
+          last_text_node = target.last_text_node
+          last_text_node.content = last_text_node.content.sub(/(\s+)$/, '') if last_text_node
+        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])
+        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 child node that is a text node
+      # @return [Nokogiri::XML::Node] the last text node
+      # @since 0.0.1
+      def last_text_node
+        return self if text? and !content.empty?
+
+        children.reverse.each do |child|
+          ltn = child.last_text_node
+          return ltn unless ltn.nil?
+        end
+
+        return nil
+      end
+    
+    end
+  end
+end
+
+# Include Peppercorn::XML::Node in Nokogiri::XML::Node (http://nokogiri.org)
+class Nokogiri::XML::Node
+  include Peppercorn::XML::Node
+end

data/lib/peppercorn/xml.rb

@@ -0,0 +1,5 @@
+module Peppercorn
+  # Extensions to Nokogiri::XML
+  module XML
+  end
+end

data/lib/peppercorn.rb

@@ -0,0 +1,31 @@
+require "peppercorn/version"
+
+# The peppercorn gem is a library for helping out with HTML, XML, and Strings.
+#
+# Peppercorn added some methods to the String and Nokogiri::XML::Node classes to do its work.
+module Peppercorn
+  
+  # Default options for truncating strings and html
+  #   * WARNING: The undocumented options could change or be removed with any release without notice *
+  DEFAULT_TRUNCATION_OPTIONS = {
+    # Documented options
+    :tail => "…",
+    # Undocumented options
+    :strip => true,
+    :return_hash => false,
+    :return_node => false
+  }
+
+  
+  # Options to override when recursively truncating a child node
+  TRUNCATE_CHILD_OPTS = {
+	  :tail => nil,
+	  :return_hash => true,
+	  :return_node => true,
+	  :strip => false
+	}
+
+end
+
+require "peppercorn/string"
+require "peppercorn/xml/node"

data/peppercorn.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "peppercorn/version"
+
+Gem::Specification.new do |s|
+  s.name        = "peppercorn"
+  s.version     = Peppercorn::VERSION
+  s.authors     = ["Wade West"]
+  s.email       = ["wwest81@gmail.com"]
+  s.homepage    = ""
+  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.}
+
+  s.rubyforge_project = "peppercorn"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "yard", "~> 0.7"
+  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_runtime_dependency "rest-client"
+  # s.add_dependency "htmlentities"
+  s.add_dependency "nokogiri"
+end

data/spec/peppercorn/string_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe String do
+  
+  before do
+    @string = "Hello World, I make HTML truncation easy."
+  end
+  
+  it "should properly truncate a string" do
+    @string.truncate(5).should eql "Hello World, I make HTML…"
+  end
+  
+  it "should not truncate a string shorter than length" do
+    @string.truncate(30).should eql @string
+  end
+  
+  it "should properly truncate some simple HTML" do
+    "<em>#{@string}</em>".truncate_html(5).should eql "<em>Hello World, I make HTML</em>&#8230;"
+  end
+  
+end

data/spec/peppercorn/xml/node_spec.rb

@@ -0,0 +1,18 @@
+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>"
+    @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>"
+  end
+
+  it "should not truncate some HTML that is shorter than length" do
+    @html.truncate(30).should eql @html.to_s
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'peppercorn'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: peppercorn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Wade West
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70354207037860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70354207037860
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70354207035900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70354207035900
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70354207034020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: *70354207034020
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: &70354207032280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354207032280
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70354207031480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70354207031480
+description: A simple gem to truncate HTML, with other features coming in the future.
+email:
+- wwest81@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- Procfile
+- README
+- Rakefile
+- lib/peppercorn.rb
+- lib/peppercorn/string.rb
+- lib/peppercorn/version.rb
+- lib/peppercorn/xml.rb
+- lib/peppercorn/xml/node.rb
+- peppercorn.gemspec
+- spec/peppercorn/string_spec.rb
+- spec/peppercorn/xml/node_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: peppercorn
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple gem to truncate HTML, with other features coming in the future.
+test_files:
+- spec/peppercorn/string_spec.rb
+- spec/peppercorn/xml/node_spec.rb
+- spec/spec_helper.rb
+has_rdoc: