Move docs around (make consistent with other ianwhite releases)

Author: ianwhite

CHANGELOG

@@ -1,6 +1,4 @@
-http://plugins.ardes.com > truncate_html
-
-= truncate_html
+= {ianwhite}[http://github.com/ianwhite] / {truncate_html}[http://github.com/truncate_html]
 
 Ardes::TruncateHtml is just like the vanilla truncate rails helper, except it respects tags and html entities, and returns valid html.
 
@@ -24,7 +22,7 @@ or - in your environment.rb file (>= rails 2.1)
 
 * The SPECDOC lists the specifications
 * Coverage is 100% (C0)
-* CI: tested against all 2.x branches and stable tags
+* CI: tested against all 2.x branches
 
 RSpec is used for testing, so the tests are in <tt>spec/</tt> rather than
 <tt>test/</tt> Do rake --tasks for more details.

MIT-LICENSE

@@ -4,14 +4,15 @@ $LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base) and !$LOAD_PATH.includ
 
 require 'spec/rake/spectask'
 require 'spec/rake/verify_rcov'
-require 'rake/rdoctask'
+require 'hanna/rdoctask'
+require 'garlic/tasks'
 
-plugin_name = File.basename(File.dirname(__FILE__))
+plugin_name = "truncate_html"
 
 task :default => :spec
 
-task :cruise do
-  sh "garlic all"
+task :cruise => ['garlic:all', 'doc:push'] do
+  puts "The build is GOOD"
 end
 
 desc "Run the specs for #{plugin_name}"
@@ -20,53 +21,66 @@ Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_opts  = ["--colour"]
 end
 
-namespace :spec do
-  desc "Generate RCov report for #{plugin_name}"
-  Spec::Rake::SpecTask.new(:rcov) do |t|
-    t.spec_files  = FileList['spec/**/*_spec.rb']
-    t.rcov        = true
-    t.rcov_dir    = 'doc/coverage'
-    t.rcov_opts   = ['--text-report', '--exclude', "spec/,rcov.rb,#{File.expand_path(File.join(File.dirname(__FILE__),'../../..'))}"] 
-  end
-
-  namespace :rcov do
-    desc "Verify RCov threshold for #{plugin_name}"
-    RCov::VerifyTask.new(:verify => "spec:rcov") do |t|
-      t.threshold = 100.0
-      t.index_html = File.join(File.dirname(__FILE__), 'doc/coverage/index.html')
-    end
-  end
-  
-  desc "Generate specdoc for #{plugin_name}"
-  Spec::Rake::SpecTask.new(:doc) do |t|
-    t.spec_files  = FileList['spec/**/*_spec.rb']
-    t.spec_opts   = ["--format", "specdoc:SPECDOC"]
-   end
+desc "Generate RCov report for #{plugin_name}"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_files  = FileList['spec/**/*_spec.rb']
+  t.rcov        = true
+  t.rcov_dir    = 'doc/coverage'
+  t.rcov_opts   = ['--text-report', '--exclude', "spec/,rcov.rb,#{File.expand_path(File.join(File.dirname(__FILE__),'../../..'))}"] 
+end
 
-  namespace :doc do
-    desc "Generate html specdoc for #{plugin_name}"
-    Spec::Rake::SpecTask.new(:html => :rdoc) do |t|
-      t.spec_files    = FileList['spec/**/*_spec.rb']
-      t.spec_opts     = ["--format", "html:doc/rspec_report.html", "--diff"]
-    end
+namespace :rcov do
+  desc "Verify RCov threshold for #{plugin_name}"
+  RCov::VerifyTask.new(:verify => "spec:rcov") do |t|
+    t.threshold = 100.0
+    t.index_html = File.join(File.dirname(__FILE__), 'doc/coverage/index.html')
   end
 end
 
-task :rdoc => :doc
-task "SPECDOC" => "spec:doc"
+task :doc => 'doc:build'
 
-desc "Generate rdoc for #{plugin_name}"
-Rake::RDocTask.new(:doc) do |t|
-  t.rdoc_dir = 'doc'
-  t.main     = 'README'
-  t.title    = "#{plugin_name}"
-  t.template = ENV['RDOC_TEMPLATE']
-  t.options  = ['--line-numbers', '--inline-source', '--all']
-  t.rdoc_files.include('README', 'SPECDOC', 'MIT-LICENSE', 'CHANGELOG')
-  t.rdoc_files.include('lib/**/*.rb')
+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
+  
+  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
+  end
+  
+  def doc_changed_sha?(docpath1, docpath2)
+    `cat #{docpath1}/index.html | grep "<title>"` != `cat #{docpath2}/index.html | grep "<title>"`
+  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`
+  end
 end
-
-namespace :doc do 
-  desc "Generate all documentation (rdoc, specdoc, specdoc html and rcov) for #{plugin_name}"
-  task :all => ["spec:doc:html", "spec:doc", "spec:rcov", "doc"]
-end