History.txt License.txt Todo.txt @@ -4,7 +4,7 @@ $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' plugin_name = 'resources_controller' @@ -16,65 +16,73 @@ 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', "config/,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 => :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" +# load up the tasks for testing rspec generators against RC +require File.join(File.dirname(__FILE__), 'spec/generate_rake_task') -desc "Generate rdoc for #{plugin_name}" -Rake::RDocTask.new(:doc) do |t| - t.rdoc_dir = 'doc' - t.main = 'README.rdoc' - t.title = "#{plugin_name}" - t.template = ENV['RDOC_TEMPLATE'] - t.options = ['--line-numbers', '--inline-source', '--all'] - t.rdoc_files.include('README.rdoc', 'SPECDOC', 'MIT-LICENSE', 'CHANGELOG') - t.rdoc_files.include('lib/**/*.rb') -end +task :rdoc => 'doc:build' +task :doc => 'doc:build' -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"] +namespace :doc do + + current_sha = `git log HEAD -1 --pretty=format:"%H"`[0..6] + + Rake::RDocTask.new(:build) do |d| + d.rdoc_dir = 'doc' + d.main = 'README.rdoc' + d.title = "#{plugin_name} API Docs (#{current_sha})" + d.rdoc_files.include('README.rdoc', 'History.txt', 'License.txt', 'Todo.txt', 'lib/**/*.rb') + end + + task :push => 'doc:build' do + 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 -# load up the tasks for testing rspec generators against RC -require File.join(File.dirname(__FILE__), 'spec/generate_rake_task') - task :cruise do - # run the garlic task, capture the output, if succesful make the docs and copy them to ardes sh "garlic clean && garlic all" - `garlic run > .garlic/report.txt` - `scp -i ~/.ssh/ardes .garlic/report.txt ardes@ardes.com:~/subdomains/plugins/httpdocs/doc/#{plugin_name}_garlic_report.txt` - `cd .garlic/*/vendor/plugins/#{plugin_name}; rake doc:all; scp -i ~/.ssh/ardes -r doc ardes@ardes.com:~/subdomains/plugins/httpdocs/doc/#{plugin_name}` + Rake::Task['doc:push'].invoke puts "The build is GOOD" end \ No newline at end of file Rakefile CHANGELOG MIT-LICENSE TODO 0f8aaf3397e2072c3b3e48ffd963ace859cb468f Ian White ian.w.white@gmail.com http://github.com/ianwhite/resources_controller/commit/cca4373481fb2bf6098729f74723a915dce582a3 cca4373481fb2bf6098729f74723a915dce582a3 2009-02-13T06:26:03-08:00 2009-02-13T06:26:03-08:00 Simplify Rakefile and push docs to gh-pages on succesful build 3aed6a0ce3a53daab291cd3c1ad4f44101f92e30 Ian White ian.w.white@gmail.com