Changing to use all rake for build

Author: ianwhite

.gitignore

@@ -1,2 +1,2 @@
-doc/*
+doc
 .garlic

History.txt

@@ -0,0 +1,3 @@
+* Make API compatible with rails 2.2
+
+* Initial release

License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2009 Ian White - [email protected]
+
+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.

README.rdoc

@@ -1,6 +1,6 @@
-= {ianwhite}[http://github.com/ianwhite] / {truncate_html}[http://github.com/truncate_html]
+= {ianwhite}[http://github.com/ianwhite] / {truncate_html}[http://github.com/ianwhite/truncate_html]
 
-Ardes::TruncateHtml is just like the vanilla truncate rails helper, except it respects tags and html entities, and returns valid html.
+TruncateHtml is just like the vanilla truncate rails helper, except it respects tags and html entities, and returns valid html.
 
 Rexml and HtmlEntities are used for the parsing.  If the input is invalid html, then hpricot is used to fix it up (but is not used when the input is fine).
 

Rakefile

@@ -4,17 +4,11 @@ $LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base) and !$LOAD_PATH.includ
 
 require 'spec/rake/spectask'
 require 'spec/rake/verify_rcov'
-require 'hanna/rdoctask'
-require 'garlic/tasks'
 
 plugin_name = "truncate_html"
 
 task :default => :spec
 
-task :cruise => ['garlic:all', 'doc:push'] do
-  puts "The build is GOOD"
-end
-
 desc "Run the specs for #{plugin_name}"
 Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
@@ -37,50 +31,47 @@ namespace :rcov do
   end
 end
 
-task :doc => 'doc:build'
-
-namespace :doc do
-  def sha
-    `git log -1 --pretty=format:"%h"`
-  end
-  
-  Rake::RDocTask.new(:build) do |d|
-    d.rdoc_dir = 'doc'
-    d.main     = 'README.rdoc'
-    d.title    = "#{plugin_name} API Docs (#{sha})"
-    d.rdoc_files.include('README.rdoc', 'History.txt', 'License.txt', 'Todo.txt', 'lib/**/*.rb')
-  end
+# the following tasks are for CI and doc building, so if dependencies don't
+# exist just load these tasks
+begin
+  require 'hanna/rdoctask'
+  require 'garlic/tasks'
+  require 'grancher/task'
 
-  task :push => 'doc:build' do
-#    if sha != `cat`
-#      
-#    mv 'doc', 'newdoc'
-#    on_gh_pages do
-#      if doc_changed_sha?('newdoc', 'doc')
-#        puts "doc has changed, pushing to gh-pages"
-#        `rm -rf doc && mv newdoc doc`
-#        `git add doc`
-#        `git commit -a -m "Update API docs"`
-#        `git push`
-#      else
-#        puts "doc is unchanged"
-#        rm_rf 'newdoc'
-#      end
-#    end
+  task :cruise => ['garlic:all', 'doc:publish_new'] do
+    puts "The build is GOOD"
   end
+
+  task :doc => 'doc:build'
+
+  namespace :doc do
+    def repo_sha
+      `git log -1 --pretty=format:"%h"`
+    end
 
-  def doc_changed_sha?(docpath1, docpath2)
-    `cat #{docpath1}/index.html | grep "<title>"` != `cat #{docpath2}/index.html | grep "<title>"`
-  end
+    def doc_sha
+      File.read('doc/index.html').match(/<title>.*?\((\w{7})\)<\/title>/m)[1] rescue nil
+    end
+    
+    task :publish_new do
+      Rake::Task.invoke('doc:publish') if doc_sha != repo_sha
+    end
+    
+    Rake::RDocTask.new(:build) do |d|
+      d.rdoc_dir = 'doc'
+      d.main     = 'README.rdoc'
+      d.title    = "#{plugin_name} API Docs (#{repo_sha})"
+      d.rdoc_files.include('README.rdoc', 'History.txt', 'License.txt', 'Todo.txt', 'lib/**/*.rb')
+    end
 
-  def on_gh_pages(&block)
-    `git branch -m gh-pages orig-gh-pages > /dev/null 2>&1`
-    `git checkout -b gh-pages origin/gh-pages`
-    `git pull`
-    yield
-  ensure
-    `git checkout master`
-    `git branch -D gh-pages`
-    `git branch -m orig-gh-pages gh-pages > /dev/null 2>&1`
+    Grancher::Task.new(:publish) => ['doc:build'] do |g|
+      if doc_sha != repo_sha
+        g.keep 'index.html'
+        g.directory 'doc', 'doc'
+        g.branch = 'gh-pages'
+        g.push_to = 'origin'
+      end
+    end
   end
-end
+rescue LoadError
+end

Todo.txt

@@ -17,7 +17,7 @@
 
       run do
         cd "vendor/plugins/truncate_html" do
-          sh "rake spec:rcov:verify"
+          sh "rake rcov:verify"
         end
       end
     end

garlic.rb

@@ -1,4 +1,3 @@
-# init
-require 'ardes/truncate_html_helper'
+require 'truncate_html_helper'
 
-ActionView::Base.send :include, Ardes::TruncateHtmlHelper
+ActionView::Base.send :include, TruncateHtmlHelper

init.rb

@@ -0,0 +1,58 @@
+require "rexml/parsers/pullparser"
+require 'rubygems'
+require "htmlentities"
+require "hpricot"
+
+module TruncateHtmlHelper
+  # you may set this to either 'html4', or 'xhtml1'
+  mattr_accessor :flavor
+  self.flavor = 'html4'
+  
+  # Truncates html respecting tags and html entities.
+  #
+  # The API is the same as ActionView::Helpers::TextHelper#truncate.  It uses Rexml for the parsing, and HtmlEntities for entity awareness.  If Rexml raises a ParseException, then Hpricot is used to fixup the tags, and we try again
+  #
+  # Examples:
+  #  truncate_html '<p>Hello <strong>World</strong></p>', :length => 7 # => '<p>Hello <strong>W&hellip;</strong></p>'
+  #  truncate_html '<p>Hello &amp; Goodbye</p>', :length => 7          # => '<p>Hello &amp;&hellip;</p>'
+  def truncate_html(input, *args)
+    # support both 2.2 & earlier APIs
+    options = args.extract_options!
+    length = options[:length] || args[0] || 30
+    omission = options[:omission] || args[1] || '&hellip;'
+    
+    begin
+      parser = REXML::Parsers::PullParser.new(input)
+      encoder = HTMLEntities.new(TruncateHtmlHelper.flavor)
+      tags, output, chars_remaining = [], '', length
+    
+      while parser.has_next? && chars_remaining > 0
+        element = parser.pull
+        case element.event_type
+        when :start_element
+          output << rexml_element_to_tag(element)
+          tags.push element[0]
+        when :end_element
+          output << "</#{tags.pop}>"
+        when :text
+          text = encoder.decode(element[0])
+          output << encoder.encode(text.first(chars_remaining))
+          chars_remaining -= text.length
+          output << omission if chars_remaining < 0
+        end
+      end
+    
+      tags.reverse.each {|tag| output << "</#{tag}>" }
+      output
+  
+    rescue REXML::ParseException
+      input = Hpricot(input, :fixup_tags => true).to_html
+      retry
+    end
+  end
+  
+private
+  def rexml_element_to_tag(element)
+    "<#{element[0]}#{element[1].inject(""){|m,(k,v)| m << %{ #{k}="#{v}"}} unless element[1].empty?}>"
+  end
+end