lib/ztk/rake/docs.rb

Summary

Maintainability
A
0 mins
Test Coverage
require 'redcarpet'
require 'yard'
require 'yard/rake/yardoc_task'

GEM_NAME    = (ENV['GEM_NAME'] || File.basename(Dir.pwd))
VENDOR_PATH = File.expand_path(File.join(Dir.pwd, "vendor"))
DOC_PATH    = File.join(VENDOR_PATH, "docs")

namespace :docs do

  YARD::Rake::YardocTask.new(:generate) do |t|
    t.options = ['--markup-provider=redcarpet', '--markup=markdown', '--verbose', '-o', DOC_PATH]
  end

  namespace :ghpages do

    desc "Clone GitHub pages under vendor"
    task :clone do
      system(%(rm -rfv #{DOC_PATH}))

      if !File.exists?(DOC_PATH)
        remote = %x(git remote -v | grep 'origin').split[1].strip

        FileUtils.mkdir_p(VENDOR_PATH)
        Dir.chdir(VENDOR_PATH) do
          system(%(git clone --branch gh-pages #{remote} #{DOC_PATH}))
        end
      end
    end

    desc 'Clone, generate and publish YARD Documentation to GitHub pages'
    task :publish do
      Rake::Task["docs:ghpages:clone"].invoke
      Rake::Task["docs:generate"].invoke

      describe = %x(git describe).chomp
      stats    = %x(bundle exec yard stats).chomp

      commit_message = Array.new
      commit_message << "Generated YARD Documentation for #{GEM_NAME.upcase.inspect} #{describe}\n\n"
      commit_message << stats

      Dir.chdir(DOC_PATH) do
        FileUtils.touch('.nojekyll')
        system(%(git add -Av))
        system(%(git commit -S -m"#{commit_message.join}"))
        system(%(git push origin gh-pages))
      end
    end

  end

end