butter 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in butter.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/butter.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/butter/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "butter"
+  s.version     = Butter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = "Jonathan Martin"
+  s.email       = "me@nybblr.com"
+  s.homepage    = "http://rubygems.org/gems/butter"
+  s.summary     = "Ever need to shorten some HTML formatted content? Maybe you're trying to show snippets from last week's blog post, or get tired of really long comments on your blog. This gem gives you access to a simple truncation method that uses Nokogiri to truncate in an HTML friendly manner."
+  s.description = "Easy HTML string truncation, done with proper markup in mind."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "butter"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_dependency "htmlentities"
+  s.add_dependency "nokogiri"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/lib/butter.rb

@@ -0,0 +1,132 @@
+require 'htmlentities'
+require 'nokogiri'
+
+module Butter
+	# == Info ===========================================================
+	# This gem was developed by Jonathan Martin for use on his personal blog, nybblr.com; the original source was coded by Eleo from https://gist.github.com/101410. My intent was to take his excellent implementation and clean it up a bit for Rails usage with more options and extension as a string method. Thanks Eleo!
+	
+	# == Usage ==========================================================
+	# "<p>An HTML <i>string</i></p>".truncate_html 2, :tail => "..."
+	# 	=> "<p>An HTML...</p>"
+	# 
+	# "<p>An HTML <i>string</i></p>".truncate_html 2, :tail => " &rarr;"
+	# 	=> "<p>An HTML &rarr;</p>"
+	# 
+	# "<p>An HTML <i>string</i></p>".truncate_html 2, :strip_html => true
+	# 	=> "An HTML..."
+
+	def truncate_html(num_words = 30, opts = {})
+		opts = { :word_cut => true, :tail => "&hellip;", :strip_html => false }.merge(opts)
+		tail = HTMLEntities.new.decode opts[:tail]
+	
+		doc = Nokogiri::HTML(self)
+	
+		current = doc.children.first
+		count = 0
+	
+		while true
+			# we found a text node
+			if current.is_a?(Nokogiri::XML::Text)
+				count += current.text.split.length
+				# we reached our limit, let's get outta here!
+				break if count > num_words
+				previous = current
+			end
+	
+			if current.children.length > 0
+				# this node has children, can't be a text node,
+				# lets descend and look for text nodes
+				current = current.children.first
+			elsif !current.next.nil?
+				#this has no children, but has a sibling, let's check it out
+				current = current.next
+			else 
+				# we are the last child, we need to ascend until we are
+				# either done or find a sibling to continue on to
+				n = current
+				while !n.is_a?(Nokogiri::HTML::Document) and n.parent.next.nil?
+					n = n.parent
+				end
+	
+				# we've reached the top and found no more text nodes, break
+				if n.is_a?(Nokogiri::HTML::Document)
+					break;
+				else
+					current = n.parent.next
+				end
+			end
+		end
+	
+		if count >= num_words
+			unless count == num_words
+		 		new_content = current.text.split
+		 		
+				 # If we're here, the last text node we counted eclipsed the number of words
+				 # that we want, so we need to cut down on words.	 The easiest way to think about
+				 # this is that without this node we'd have fewer words than the limit, so all
+				 # the previous words plus a limited number of words from this node are needed.
+				 # We simply need to figure out how many words are needed and grab that many.
+				 # Then we need to -subtract- an index, because the first word would be index zero.
+				 
+				 # For example, given:
+				 # <p>Testing this HTML truncater.</p><p>To see if its working.</p>
+				 # Let's say I want 6 words.	The correct returned string would be:
+				 # <p>Testing this HTML truncater.</p><p>To see...</p>
+				 # All the words in both paragraphs = 9
+				 # The last paragraph is the one that breaks the limit.	 How many words would we
+				 # have without it? 4.	But we want up to 6, so we might as well get that many.
+				 # 6 - 4 = 2, so we get 2 words from this node, but words #1-2 are indices #0-1, so
+				 # we subtract 1.	 If this gives us -1, we want nothing from this node. So go back to
+				 # the previous node instead.
+				 index = num_words-(count-new_content.length)-1
+				 if index >= 0
+					 new_content = new_content[0..index]
+		 			 current.content = new_content.join(' ') + tail
+				 else
+					 current = previous
+					 current.content = current.content + tail
+				end
+			end
+	
+			# remove everything else
+			while !current.is_a?(Nokogiri::HTML::Document)
+				while !current.next.nil?
+					current.next.remove
+				end
+				current = current.parent
+			end
+		end
+	
+		# now we grab the html and not the text.
+		# we do first because nokogiri adds html and body tags
+		# which we don't want
+		
+		# Strip out the unwanted <p> tag that gets added, if it is present. This is mostly for the sake of markup, since extra <p> tags can throw off styling. In the future, this will need to see if the original code was already wrapped in a plain <p> tag.
+		
+		root = doc.root.children.first
+		only_child = root.children.first
+		
+		if root.children.size == 1 and only_child.name == "p" and only_child.attributes.empty?
+			truncated = only_child
+		else
+			truncated = root
+		end
+		
+		if opts[:strip_html] == true
+			truncated = truncated.inner_text
+		else
+			truncated = truncated.inner_html
+		end
+		
+		if html_safe?
+			truncated.html_safe
+		else
+			truncated
+		end
+	end
+end
+
+# Add method to String class
+class String
+	include Butter
+end

data/lib/butter/version.rb

@@ -0,0 +1,3 @@
+module Butter
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: butter
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jonathan Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: htmlentities
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Easy HTML string truncation, done with proper markup in mind.
+email: me@nybblr.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- butter.gemspec
+- lib/butter.rb
+- lib/butter/version.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/butter
+licenses: []
+
+post_install_message: 
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: butter
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ever need to shorten some HTML formatted content? Maybe you're trying to show snippets from last week's blog post, or get tired of really long comments on your blog. This gem gives you access to a simple truncation method that uses Nokogiri to truncate in an HTML friendly manner.
+test_files: []
+