Rulebook

#!/usr/bin/env ruby

# global ignore
ignore 'pages', 'doc', 'site', 'log'

##
# Default
#
ruleset :default => [:index, :manifest, :demo]

##
# Release
#
# TODO: How to force all tests to be run?
#
ruleset :release => [:index, :demo, :manifest, :doc]

#
# QED Demos
#
ruleset :demo do
  desc "run demos"

  rule 'demo/**/*.md'        => :demo
  rule 'lib/**/*.rb'         => :demo_all
  rule 'demo/test_helper.rb' => :demo_all

  def demo(*files)
    #files = ["demo/**/*.md"] if files.empty?
    shell "bundle exec qed " + files.join(" ")
  end

  def demo_all
    demo "demo/**/*.md"
  end
end

#
# Unit Testing
#
ruleset :test do
  desc "run unit tests"

  rule 'test/case_*.rb'         => :test
  rule 'test/helper.rb'         => :test_all
  rule /^lib\/(.*?)\.rb$/       => :test_match
  rule /^lib\/ergo\/(.*?)\.rb$/ => :test_match

  def test(*paths)
    shell "ruby-test #{gem_opt} -Ilib:test #{paths.flatten.join(' ')}"
  end

  def test_all
    test(*Dir['test/**/case_*.rb'])
  end

  def test_match(m)
    test("test/case_#{m[1]}")
  end

  def gem_opt
    defined?(::Gem) ? "-rubygems" : ""
  end
end

#
# Update .index file
#
ruleset :index do
  desc "update index file"

  rule 'INDEX.yml' do 
    shell "index -u INDEX.yml"
  end
end

#
# Update Manifest - this uses the `mast` commandline tool.
#
ruleset :manifest do
  desc "update manifest"

  rule :manifest_outofdate? => :update_manifest

  def manifest_outofdate?
    ! system "mast --quiet --verify"
  end

  def update_manifest
    shell "mast -u"
  end
end

#
# Shomen documentation. (NOT USED PRESENTLY)
#
ruleset :doc do
  desc "generate shomen documentation"

  rule :shomen_docs_needed? => :update_shomen_docs

  def shomen_docs_needed?
    files = `mast -b --no-head`.split("\n")
    doc_file = "web/doc/#{project.name}-#{project.version}.json"
    ! FileUtils.uptodate?(doc_file, files)
  end

  def update_shomen_docs
    shell "shomen-yard > web/doc/#{project.name}-#{project.version}.json"
  end
end

# Access to project metadata, if needed.
def project
  @project ||= (
    require 'yaml'
    index = YAML.load_file('.index')
    Struct.new('Project', *index.keys).new(*index.values)
  )
end