@@ -17,3 +17,27 @@ Rap.task :reinstall, :name do |task, args| Install.instance.execute(args.name) end + +# ::desc generate rdoc +Rap.task :rdoc, :redoc => false do |task, args| + FileUtils.rm_r("rdoc") if File.directory?("rdoc") + + %w{tap rap tap-gen tap-suite tap-tasks tap-test}.each do |dir| + Dir.chdir(dir) do + if task.redoc && File.directory?("rdoc") + FileUtils.rm_r("rdoc") + end + + Rap.sh('rake rdoc') + end + + dest = if dir == "tap" + "rdoc" + else + "rdoc/#{dir}" + end + + FileUtils.mkdir_p(dest) + FileUtils.cp_r("#{dir}/rdoc/.", dest) + end +end \ No newline at end of file Rapfile @@ -1 +1 @@ -Subproject commit 1d5a2aefba7ac8c691395bbc9595a8ff0d9b8d77 +Subproject commit 5679b8819b2b4ca5b88c5a5fbe9e2ad9ed8f67b0 configurable @@ -1 +1 @@ -Subproject commit 798a11e73782f2771eb7336f40f7eb8840ce8535 +Subproject commit 01f40bc9a074d9ba489bf6158211175cbb7c5b86 lazydoc @@ -15,7 +15,8 @@ Gem::Specification.new do |s| s.extra_rdoc_files = %W{ README MIT-LICENSE - History} + History + doc/Tutorial} s.files = %W{} end \ No newline at end of file tap-suite/tap-suite.gemspec @@ -1,4 +1,54 @@ +require 'rake' require 'rake/testtask' +require 'rake/rdoctask' +require 'rake/gempackagetask' + +$:.unshift File.expand_path("#{File.dirname(__FILE__)}/lib") +require 'tap/constants' + +# +# Gem specification +# + +def gemspec + require 'rubygems/specification' + + data = File.read('tap-test.gemspec') + spec = nil + Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join + spec +end + +Rake::GemPackageTask.new(gemspec) do |pkg| + pkg.need_tar = true +end + +desc 'Prints the gemspec manifest.' +task :print_manifest do + # collect files from the gemspec, labeling + # with true or false corresponding to the + # file existing or not + files = gemspec.files.inject({}) do |files, file| + files[File.expand_path(file)] = [File.exists?(file), file] + files + end + + # gather non-rdoc/pkg files for the project + # and add to the files list if they are not + # included already (marking by the absence + # of a label) + Dir.glob("**/*").each do |file| + next if file =~ /^(rdoc|pkg|test|specs|images)/ || File.directory?(file) + + path = File.expand_path(file) + files[path] = ["", file] unless files.has_key?(path) + end + + # sort and output the results + files.values.sort_by {|exists, file| file }.each do |entry| + puts "%-5s %s" % entry + end +end # # Test tasks @@ -22,3 +72,25 @@ Rake::TestTask.new(:test) do |t| t.warning = true end +# +# Documentation tasks +# + +desc 'Generate documentation.' +Rake::RDocTask.new(:rdoc) do |rdoc| + spec = gemspec + + rdoc.rdoc_dir = 'rdoc' + rdoc.options.concat(spec.rdoc_options) + rdoc.rdoc_files.include( spec.extra_rdoc_files ) + + files = spec.files.select {|file| file =~ /^lib.*\.rb$/} + rdoc.rdoc_files.include( files ) + + begin + require 'cdoc' + rdoc.template = 'cdoc/cdoc_html_template' + rdoc.options << '--fmt' << 'cdoc' + rescue(LoadError) + end +end \ No newline at end of file tap-test/Rakefile @@ -1,9 +1,9 @@ -== 0.17.0 +== 0.17.0 / 2009-05-03 Significant reorganization and update to Tap internals. The workflow syntax for joins has changed in incompatible ways, and several key methods have been renamed (notably -Root#filepath). Obviously not 100% backwards compatible but +Root#filepath). Obviously not backwards compatible but most tasks will work without alteration. Upgrade Notes: @@ -27,10 +27,11 @@ Changes: * added file flag to load * added unloading to Constant * switched const_name, name on Constant -* added constant_glob to Root * refactored on_complete_block to join * reworked App to use aggregators that respond_to? call * reworked Join so that it may be dumped as YAML +* reworked Schema syntax +* removed rounds from Schema syntax and Queue * many other small changes == 0.12.4 / 2009-03-23 tap/History @@ -13,7 +13,7 @@ and reuse results. Task libraries are readily shared as gems. Check out these links for tutorials, development, and bug tracking. -* {Tutorial}[link:files/doc/Tutorial.html], {Class}[link:files/doc/Class%20Reference.html], {Command}[link:files/doc/Command%20Reference.html], and {Syntax}[link:files/doc/Syntax%20Reference.html] References +* {Tutorial}[link:tap-suite/files/doc/Tutorial.html], {Class}[link:files/doc/Class%20Reference.html], {Command}[link:files/doc/Command%20Reference.html], and {Syntax}[link:files/doc/Syntax%20Reference.html] References * Website[http://tap.rubyforge.org] * Lighthouse[http://bahuvrihi.lighthouseapp.com/projects/9908-tap-task-application/tickets] * Github[http://github.com/bahuvrihi/tap/tree/master] @@ -81,13 +81,6 @@ Tap comes with generators. To get started: % tap generate task goodnight % tap run -- goodnight moon -=== Bugs/Known Issues - -- Some inconsequential tests on JRuby fail due to bugs in JRuby itself. -- Joins, Parser, and Schema require additional documentation and may be - reworked in a future release. The workflow syntax should remain the same. -- Audit.dump only works for certain cases. Merges frequently cause trouble. - == Installation Tap is available as a gem on RubyForge[http://rubyforge.org/projects/tap]. Use: tap/README @@ -408,11 +408,11 @@ module Tap # TerminateErrors are raised to kill executing tasks when terminate is # called on an running App. They are handled by the run rescue code. - class TerminateError < RuntimeError + class TerminateError < RuntimeError # :nodoc: end # Raised when Dependencies#resolve detects a circular dependency. - class DependencyError < StandardError + class DependencyError < StandardError # :nodoc: def initialize(trace) super "circular dependency: [#{trace.join(', ')}]" end tap/lib/tap/app.rb @@ -573,7 +573,7 @@ module Tap end # Raised when there is a configuration error from Env.load_config. - class ConfigError < StandardError + class ConfigError < StandardError # :nodoc: attr_reader :original_error, :env_path def initialize(original_error, env_path) tap/lib/tap/env.rb @@ -3,10 +3,7 @@ require 'tap/joins/switch' require 'tap/joins/sync' module Tap - class App - - # A module of standard Join classes supported by Tap. - module Joins - end + # A module of standard Join classes supported by Tap. + module Joins end end \ No newline at end of file tap/lib/tap/joins.rb @@ -37,7 +37,7 @@ module Tap end # Raised by a Switch join to indicate when a switch index is out of bounds. - class SwitchError < RuntimeError + class SwitchError < RuntimeError # :nodoc: end end end tap/lib/tap/joins/switch.rb @@ -88,7 +88,7 @@ module Tap # Raised by a Sync join to indicate when an input returns twice before # the group is ready to execute. - class SynchronizeError < RuntimeError + class SynchronizeError < RuntimeError # :nodoc: end end end tap/lib/tap/joins/sync.rb @@ -44,6 +44,7 @@ Gem::Specification.new do |s| lib/tap/env/minimap.rb lib/tap/env/string_ext.rb lib/tap/exe.rb + lib/tap/exe/opts.rb lib/tap/join.rb lib/tap/joins.rb lib/tap/joins/switch.rb @@ -53,7 +54,6 @@ Gem::Specification.new do |s| lib/tap/root/utils.rb lib/tap/root/versions.rb lib/tap/schema.rb - lib/tap/schema/node.rb lib/tap/schema/parser.rb lib/tap/support/intern.rb lib/tap/support/templater.rb tap/tap.gemspec f62fd070ae1de04bee371db1ebddf45cf9cfd5da Simon Chiang simon.a.chiang@gmail.com http://github.com/bahuvrihi/tap/commit/6879ccd8469913bcefab824d1738f6123d8d18f0 6879ccd8469913bcefab824d1738f6123d8d18f0 2009-05-04T09:22:34-07:00 2009-05-04T09:22:34-07:00 began work updating documentation 22ec491b61d1979527de676fdfbc74ca50676a55 Simon Chiang simon.a.chiang@gmail.com