require 'open3' task :default => [ 'test:spec' ] task :spec do Rake::Task['test:spec'].invoke end task :yard do Rake::Task['docs:gen'].invoke end task :history do Rake::Task['history:gen'].invoke end task :travis do Rake::Task['yard'].invoke Rake::Task['spec'].invoke end namespace :test do desc 'Run specs and check for deprecation warnings' task :spec do original_dir = Dir.pwd Dir.chdir( File.expand_path(File.dirname(__FILE__)) ) exit_status = 1 output = '' Open3.popen3("bundle exec rspec") {|stdin, stdout, stderr, wait_thr| while line = stdout.gets puts line end output = stdout if not wait_thr.value.success? fail "Failed to 'bundle exec rspec' (exit status: #{wait_thr.value})" end exit_status = wait_thr.value } if exit_status != /0/ #check for deprecation warnings if output =~ /Deprecation Warnings/ fail "DEPRECATION WARNINGS in spec generation, please fix!" end end Dir.chdir( original_dir ) end end ########################################################### # # History Tasks # ########################################################### namespace :history do desc 'Generate HISTORY.md' task :gen do original_dir = Dir.pwd Dir.chdir( File.expand_path(File.dirname(__FILE__)) ) output = `bundle exec ruby history.rb .` puts output if output !~ /success/ raise "History generation failed" end Dir.chdir( original_dir ) end end ########################################################### # # Documentation Tasks # ########################################################### DOCS_DAEMON = "yard server --reload --daemon --server thin" FOREGROUND_SERVER = 'bundle exec yard server --reload --verbose --server thin lib/beaker' def running?( cmdline ) ps = `ps -ef` found = ps.lines.grep( /#{Regexp.quote( cmdline )}/ ) if found.length > 1 raise StandardError, "Found multiple YARD Servers. Don't know what to do." end yes = found.empty? ? false : true return yes, found.first end def pid_from( output ) output.squeeze(' ').strip.split(' ')[1] end desc 'Start the documentation server in the foreground' task :docs => 'docs:clear' do original_dir = Dir.pwd Dir.chdir( File.expand_path(File.dirname(__FILE__)) ) sh FOREGROUND_SERVER Dir.chdir( original_dir ) end namespace :docs do desc 'Clear the generated documentation cache' task :clear do original_dir = Dir.pwd Dir.chdir( File.expand_path(File.dirname(__FILE__)) ) sh 'rm -rf docs' Dir.chdir( original_dir ) end desc 'Generate static documentation' task :gen => 'docs:clear' do original_dir = Dir.pwd Dir.chdir( File.expand_path(File.dirname(__FILE__)) ) output = `bundle exec yard doc` puts output if output =~ /\[warn\]|\[error\]/ fail "Errors/Warnings during yard documentation generation" end Dir.chdir( original_dir ) end desc 'Run the documentation server in the background, alias `bg`' task :background => 'docs:clear' do yes, output = running?( DOCS_DAEMON ) if yes puts "Not starting a new YARD Server..." puts "Found one running with pid #{pid_from( output )}." else original_dir = Dir.pwd Dir.chdir( File.expand_path(File.dirname(__FILE__)) ) sh "bundle exec #{DOCS_DAEMON}" Dir.chdir( original_dir ) end end task(:bg) { Rake::Task['docs:background'].invoke } desc 'Check the status of the documentation server' task :status do yes, output = running?( DOCS_DAEMON ) if yes pid = pid_from( output ) puts "Found a YARD Server running with pid #{pid}" else puts "Could not find a running YARD Server." end end desc "Stop a running YARD Server" task :stop do yes, output = running?( DOCS_DAEMON ) if yes pid = pid_from( output ) puts "Found a YARD Server running with pid #{pid}" `kill #{pid}` puts "Stopping..." yes, output = running?( DOCS_DAEMON ) if yes `kill -9 #{pid}` yes, output = running?( DOCS_DAEMON ) if yes puts "Could not Stop Server!" else puts "Server stopped." end else puts "Server stopped." end else puts "Could not find a running YARD Server" end end end