tap 0.19.0 → 1.3.0

data/History

@@ -1,11 +1,76 @@
+== 1.3.0 / 2010-04-02
+
+* various improvements to declarations
+* moved env methods from ShellTest to Utils
+
+== 1.0.0 - 1.2.4 / 2010-03 - 2010-04
+
+Continued rework of Tap internals. Implementation of new Env setup scheme
+based largely on signals. Updated the Declarations DSL with significantly more
+flexibility. Numerous cleanups to the API. Simplification and standardization
+of the tap syntax for defining command-line workflows.
+
+These releases were created for internal use and debugged in fairly rapid
+succession. The transition from 0.* to 1.* marks significant changes that,
+aside from the basic API, are not backwards-compatible. Going forward Tap
+should be much more stable, and the various APIs should be stable.
+
+The tasks among the various modules in the tap suite may still be reorganizd
+and the Declarations DSL is still under development.
+
+Also, about this time numerous tags were deleted to cleanup the repo.  Rap
+was removed entirely as a separate gem, as was the tap-suite.  These are
+the old tag names and their corresponding shas:
+
+  all: 5f609e24147587692303d3654f1386958f476f59
+  rap-0.12.0: 2a988dbbacac45b6b8bf0fc7c74e7d3639e64f56
+  rap-0.12.1: a1e0f3605f6937326b258038812fba775c7616bd
+  rap-0.12.2: 03dc3dfc3b365901847ef70dbf1b92d297642b00
+  rap-0.12.3: 6ce756f1f4783787f54d0f8332899972a9b4b863
+  rap-0.13.0: 6db8026cd7dabb1ff407470a9c793796b4ea6126
+  rap-0.13.1: c512db583aad0453ab5e23d54fe5ef4b3c28992c
+  rap-0.15.0: 981bae18210008c5cabc108592d3bc6a44f49530
+  tap-0.10.0: f0c4ae53e5136364f0f6c4c3b2b587daa4eaeefe
+  tap-0.10.1: 6ec15db9a9043e3eca285227b77e6e562bb2ff35
+  tap-0.11.0: 359383266c572bc8e124a751dc3097fec806e16b
+  tap-0.11.1: 5079dcb5ef33c0d5f6def81f4767925be0e8b8c5
+  tap-0.12.0: f8c97e2efbbe9e8699d20b63d29e975cd91a8c57
+  tap-0.12.1: f6ac7f29834804eafd654200096696821f698290
+  tap-0.12.2: ad7fc99d028c6c682c2eb1e7c069bea520641bdb
+  tap-0.12.3: 5cba176fcc5e8e098ed1d9165139bd9a99e097c9
+  tap-0.12.4: 9148452b903f64c1fa170048fa9fa2dfc299414f
+  tap-0.17.0: e23074c52ac656e42904b58d829e82150d76c66a
+  tap-0.17.1: 6139af4e890d55f956d6a61de31396a623b03fec
+  tap-gen-0.1.0: 25f69b6fc788c2aa302bb5623c76e7325e3391fc
+  tap-gen-0.1.1: 8f5614336350942615add73b3fe79075b54a93c1
+  tap-gen-0.1.2: 621ce1fdb7ab0d966a32a34637e39fa5221247f1
+  tap-gen-0.1.3: 60e44d4cf6ac837e28d8b4138e1e4779656341d9
+  tap-gen-0.3.0: 0b12752589ff6cf7bb081d06347fa5d74c7b6eb4
+  tap-server-0.1.0: f08a40b83e370d37adf54ab322f153c2392de9ce
+  tap-server-0.1.1: dada4c9ca83191e9990eaaf7215c049cc7dc88a9
+  tap-server-0.2.0: 45b0d1fb7381ba824b5234079441e8f252a9d28d
+  tap-server-0.3.0: 861fd836b7d19422c7bbb4e3b65981f409130b3d
+  tap-server-0.4.0: 4f2b8c6e146bdca781f30f35d608815544f96e3e
+  tap-server-0.6.0: bfce08a4a73aeffe3b873f9d2bd1b36db4489598
+  tap-suite-0.1.0: 8ab253ee8f72f79a5f7b9b7928831affbcfacda9
+  tap-suite-0.2.0: 76afbec380f6faf7fbec386f2f40c1cbd074b6d9
+  tap-suite-0.3.0: bbfe80400f6d5e988dea9ad1fa3b25851f5aa8e7
+  tap-tasks-0.1.0: fb4d357010a321ab31bf689d3794889f36487059
+  tap-tasks-0.2.0: c0a561780b49de3eaa2a4ef7c69070a47d0b902b
+  tap-tasks-0.5.0: 357d793a78808a26438b4b66c4f6c471a23d05f8
+  tap-test-0.1.0: b533809da134fda0f9fd685c766fe8f26da7f0f3
+  tap-test-0.3.0: 140580cf49bc58cd1e64b5eb9ef7cc8066fa9410
+
+We'll see if I can't keep this under control a little better.
+
 == 0.19.0 / 2009-12-05
 
 Significant rework of Tap internals.
 
 * extracted task/join/middleware code to make Api base class
-* some changes to semantics of Minimap; entry_to_minikey is
-  now entry_to_path.  Likewise entries now specify their own
-  path using entry.path rather than entry.minikey
+* some changes to semantics of Minimap; entry_to_minikey is now entry_to_path.
+  Likewise entries now specify their own path using entry.path rather than
+  entry.minikey
 * added Signals implemented with the Dsl pattern
 
 == 0.18.1
@@ -21,21 +86,19 @@ Significant rework of Tap internals.
   
 == 0.18.0 / 2009-06-17
 
-Several updates to simplify Tap.  Most significantly,
-dependencies have been removed because their general
-utility is quite doubtful, and it it easy to implement
-in situations that require them (ex rap).
+Several updates to simplify Tap. Most significantly, dependencies have been
+removed because their general utility is quite doubtful, and it it easy to
+implement in situations that require them (ex rap).
 
-* bug fix in console (app now refers to Tap::App.instance)
+* bug fix in console (app now refers to Tap::App.current)
 * bug fix in load for recurrently loading from a file
 * fixed a mistake in run help
-* made load only load once by default, stream loading must
-  be enabled in subclasses
+* made load only load once by default, stream loading must be enabled in
+  subclasses
 * dump now returns the input, not the io
 * removed dependencies from tap
 * removed intern method on Task (now use app.task)
-* removed Support module (ie refactored Templater to
-  Tap::Templater)
+* removed Support module (ie refactored Templater to Tap::Templater)
 * removed Task.help method
 * added Middleware baseclass
 * Task.parse now yields opts to block for modifications
@@ -52,27 +115,23 @@ in situations that require them (ex rap).
 
 == 0.17.0 / 2009-05-25
 
-Significant reorganization and update to Tap internals.
-The workflow syntax for joins has changed in incompatible
-ways, and several key methods have been renamed.  
-Obviously not backwards compatible but most tasks will
-work without alteration.
+Significant reorganization and update to Tap internals. The workflow syntax
+for joins has changed in incompatible ways, and several key methods have been
+renamed. Obviously not backwards compatible but most tasks will work without
+alteration.
 
 Upgrade Notes:
 
-* Tasks now are identified by "::task" rather than "::manifest"
-  The manifest identifier still works for now but will be
-  removed by 1.0.
-* Root#filepath and Root#relative_filepath have been renamed
-  Root#path and Root#relative_path
-* Audits have been removed
-* Generators, FileTask, and test modules have been removed
-  to separate modules (tap-gen, tap-tasks, tap-test). Install
-  tap-suite to get them all back.
-* switched const_name, name on Constant
-* refactored on_complete_block to join
-* callbacks in Task have been removed
-* schema syntax no longer supports rounds, globals
+* Tasks now are identified by "::task" rather than "::manifest" The manifest
+  identifier still works for now but will be removed by 1.0. 
+* Root#filepath and Root#relative_filepath have been renamed Root#path and
+  Root#relative_path 
+* Audits have been removed 
+* Generators, FileTask, and test modules have been removed to separate modules
+  (tap-gen, tap-tasks, tap-test). Install tap-suite to get them all back. 
+* switched const_name, name on Constant * refactored on_complete_block to join
+* callbacks in Task have been removed * schema syntax no longer supports
+  rounds, globals
 
 Changes:
 
@@ -88,11 +147,10 @@ Changes:
 
 * fixed bug in App#inspect
 * documentation updates
-* changed the default load/dump configs to load and
-  dump data without serialization
+* changed the default load/dump configs to load and dump data without
+  serialization
 * made stdin the default input to load
-* updated run syntax to allow arguments to be passed
-  to saved workflows
+* updated run syntax to allow arguments to be passed to saved workflows
 * updates to RootGenerator
 
 == 0.12.3 / 2009-03-05
@@ -155,8 +213,7 @@ Upgrade note:
 
 == 0.11.0 / 2008-10-20
 
-Significant update to Tap with many internal reworks.
-Major changes include:
+Significant update to Tap with many internal reworks. Major changes include:
 
 * Addition of Parser/Schema
 * Addition of rap and task declarations
@@ -167,8 +224,7 @@ Major changes include:
 
 == 0.10.1 / 2008-08-21
 
-Update of Tap with a few improvements to manifests
-and a new manifest command.
+Update of Tap with a few improvements to manifests and a new manifest command.
 
 * Fixed some bugs and extended manifests
 * Bug fixes in generators
@@ -176,16 +232,15 @@ and a new manifest command.
 
 == 0.10.0 / 2008-08-08
 
-Major revision.  Reworked configurations and the execution
-environment.  Added Lazydoc documentation.  Backwards incompatible.
-Development is now on GitHub. 
+Major revision. Reworked configurations and the execution environment. Added
+Lazydoc documentation. Backwards incompatible. Development is now on GitHub.
 
 == 0.9.1 / 2008-04-26 revision 253
 
-Relatively minor update, but with one important refactoring that
-removes the Tap::Script module.  This breaks backward compatibility
-but only should affect people who have made their own commands.
-Simply sub Tap::Support::CommandLine for Tap::Script to fix.
+Relatively minor update, but with one important refactoring that removes the
+Tap::Script module. This breaks backward compatibility but only should affect
+people who have made their own commands. Simply sub Tap::Support::CommandLine
+for Tap::Script to fix.
 
 * Added constants methods (ex try_constantize) to String
 * Added gem discovery when no tap.yml file is present

data/MIT-LICENSE

@@ -1,6 +1,6 @@
 Copyright (c) 2006-2009, Regents of the University of Colorado.
 
-Copyright (c) 2009, Simon Chiang.
+Copyright (c) 2009-2010, Simon Chiang.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README

@@ -10,12 +10,11 @@ Tap allows the construction of workflows that may be defined, configured, and
 run from the command line. The tasks and joins composing a workflow are easy
 to test, subclass, and distribute as gems.
 
-Tap is the core of the
-{Tap-Suite}[http://tap.rubyforge.org/tap-suite/index.html] 
-which provides a standard library of 
+Tap provides a standard library of
 {tasks}[http://tap.rubyforge.org/tap-tasks/index.html],
-{generators}[http://tap.rubyforge.org/tap-gen/index.html], and 
-{test utilities}[http://tap.rubyforge.org/tap-test/index.html].
+{generators}[http://tap.rubyforge.org/tap-gen/index.html], and {test
+modules}[http://tap.rubyforge.org/tap-test/index.html] to expedite
+development.
 
 * Website[http://tap.rubyforge.org]
 * Github[http://github.com/bahuvrihi/tap/tree/master]
@@ -26,8 +25,9 @@ which provides a standard library of
 Tasks are defined as subclasses of Tap::Task.
 
   [lib/goodnight.rb]
+  require 'tap/task'
   
-  # Goodnight::task your basic goodnight moon task
+  # ::task your basic goodnight moon task
   # Says goodnight with a configurable message.
   class Goodnight < Tap::Task
     config :message, 'goodnight'           # a goodnight message
@@ -37,74 +37,118 @@ Tasks are defined as subclasses of Tap::Task.
     end
   end
 
-Tap automatically discovers tasks.
-
-  % tap run -T
-    sample:
-      goodnight   # your basic goodnight moon task
-    tap:
-      dump        # the default dump task
-      load        # the default load task
-      
-And generates command line documentation.
-
-  % tap run -- goodnight --help
+Tap discovers tasks.
+
+  % tap list
+  task:
+    dump                 # dump data
+    goodnight            # your basic goodnight moon task
+    list                 # list resources
+    load                 # load data
+    prompt               # open a prompt
+    signal               # signal via a task
+  join:
+    gate                 # collects results
+    join                 # unsyncrhonized multi-way join
+    sync                 # synchronized multi-way join
+  middleware:
+    debugger             # default debugger
+
+Generates command-line documentation.
+
+  % tap goodnight --help
   Goodnight -- your basic goodnight moon task
   --------------------------------------------------------------------------------
     Says goodnight with a configurable message.
   --------------------------------------------------------------------------------
-  usage: tap run -- goodnight NAME
+  usage: tap goodnight NAME
 
   configurations:
           --message MESSAGE            a goodnight message
 
   options:
           --help                       Print this help
-          --enque                      Manually enques self
           --config FILE                Specifies a config file
 
-Tasks are immediately available for use in workflows, and may be configured as
-if they were individual executables. This workflow joins the goodnight task to
-a dump task, which prints the message to stdout.
+And provides a robust
+{syntax}[http://tap.rubyforge.org/rdoc/files/doc/Workflow%20Syntax.html] for
+building both simple and complex workflows. This joins a goodnight task to a
+dump task in order to print the goodnight message.
 
-  % tap run -- goodnight moon --: dump
+  % tap goodnight moon -: dump
   goodnight moon
 
-  % tap run -- goodnight world --message hello --: dump
+  % tap goodnight world --message hello -: dump
   hello world
 
-=== Workflow Syntax
-
-Workflows are specified on the command line using argument vectors separated
-by option breaks (ie '--'). The argument vectors define the tasks while
-modifications to the breaks specify joins.
-
-A simple sequence.
-
-  % tap run -- load 'goodnight moon' --: dump
-  goodnight moon
-
-A more formal way of specifying a sequence.
+Workflows support the use of middleware to wrap the execution of each task,
+most commonly for logging and/or debugging.
 
-  % tap run -- load 'goodnight moon' -- dump --[0][1]
+  % tap goodnight moon -: dump --/use debugger
+    21:06:53       0 << ["moon"] (Goodnight)
+    21:06:53       0 >> "goodnight moon" (Goodnight)
+    21:06:53       1 << "goodnight moon" (Tap::Tasks::Dump)
   goodnight moon
+    21:06:53       1 >> "goodnight moon" (Tap::Tasks::Dump)
 
-A fork.
-
-  % tap run -- load 'goodnight moon' -- dump -- dump --[0][1,2]
-  goodnight moon
-  goodnight moon
+Tap provides a set of {test
+modules}[http://tap.rubyforge.org/tap-test/index.html] to simplify testing of
+workflows both off and on the command-line (this documentation is tested, for
+example):
 
-A merge (note that dump receives the inputs in serial).
+  require 'tap/test/unit'
+  
+  class ShellTestTest < Test::Unit::TestCase
+    acts_as_shell_test
+    
+    def test_goodnight_moon
+      sh_test %q{
+      % tap load 'goodnight moon' -: dump
+      goodnight moon
+      }
+    end
+  end
 
-  % tap run -- load goodnight -- load moon -- dump --[0,1][2]
-  goodnight
-  moon
+Tasks can be packaged into gems like any other code. Tap automatically finds
+tasks in gems containing a tap.yml file so that distribution feels normal and
+unobtrusive.
 
-A synchronized merge (the printout is <tt>['goodnight', 'moon'].to_s</tt>).
+  % tap load/yaml
+  unresolvable constant: "load/yaml"
+  
+  % gem install tap-tasks
+  ...
+  
+  % tap load/yaml "[1, 2, 3]" -: dump/yaml
+  --- 
+  - 1
+  - 2
+  - 3
+
+For local tasks that don't need to be distributed, Tap provides declarations
+a-la {Rake}[http://rake.rubyforge.org/]. By default any tasks in a tapfile are
+available for use.
+
+  [tapfile]
+  desc "concat file contents"
+  task :cat do |config, *files|
+    files.collect {|file| File.read(file) }.join
+  end
+  
+  desc "grep lines"
+  task :grep, :e => '.' do |config, str|
+    str.split("\n").grep(/#{config.e}/)
+  end
+  
+  % tap cat tapfile -:a grep -e task -:i dump
+  task :cat do |config, *files|
+  task :grep, :e => '.' do |config, str|
 
-  % tap run -- load goodnight -- load moon -- dump --[0,1][2].sync
-  goodnightmoon
+See the documentation for a greater explanation of the {workflow
+syntax}[http://tap.rubyforge.org/rdoc/files/doc/Workflow%20Syntax.html],
+several common
+{patterns}[http://tap.rubyforge.org/rdoc/files/doc/Examples.html], and the
+underlying {APIs}[http://tap.rubyforge.org/rdoc/files/doc/API.html].
 
 == Installation
 
@@ -115,4 +159,4 @@ Tap is available as a gem on Gemcutter[http://gemcutter.org/gems/tap].
 == Info 
 
 Developer:: {Simon Chiang}[http://bahuvrihi.wordpress.com]
-License:: {MIT-Style}[link:files/MIT-LICENSE.html]
+License:: {MIT-Style}[http://tap.rubyforge.org/rdoc/files/MIT-LICENSE.html]

data/bin/tap

@@ -1,62 +1,16 @@
 #!/usr/bin/env ruby
-# usage: tap <command> {options} [args]
 #
-# Launches a tap command.
+# Runs tapexe, first setting the default ENV variables expected
+# by tap when installed by RubyGems.  Splitting the work into
+# two files like this is a pattern allowing tapexe to be run
+# without RubyGems or the default ENV (ie 'ruby tapexe').
 #
-# examples:
-#   tap generate root .                  # generates a root dir
-#   tap run taskname --option input      # runs the 'taskname' task
-#
-# help:
-#   tap --help                           # prints this help
-#   tap command --help                   # prints help for 'command'
-#
-
-require "#{File.dirname(__FILE__)}/../lib/tap.rb"
-
-#
-# setup the application
-#
-
-begin
-  app = Tap::App.setup
-rescue(Tap::Env::ConfigError)
-  # catch errors and exit gracefully
-  # (errors usu from gem loading errors)
-  puts $!.message
-  exit(1)
-end
-
-#
-# launch the command
-#
-
-commands = app.env.manifest do |env|
-  env.root.glob(:cmd, "**/*.rb")
-end
-
-case command = ARGV.shift.to_s  
-when '', '--help'
-  template = %Q{<% unless minimap.empty? || count <= 1 %>
-<%= env_key %>:
-<% end %>
-<% minimap.each do |key, path| %>
-  <%= key.ljust(width) %>
-<% end %>}
 
-  puts Lazydoc.usage(__FILE__)
-  puts
-  puts "available commands:"
-  puts commands.summarize(template)
-  puts
-  puts "version #{Tap::VERSION} -- #{Tap::WEBSITE}"
-else
-  if path = commands.seek(command)
-    load path
-  else
-    puts "Unknown command: '#{command}'"
-    puts "Type 'tap --help' for usage information."
-  end
-end
+ENV['TAP_GEMS']  ||= '.'
+ENV['TAP_PATH']  ||= '.'
+ENV['TAPENV']    ||= 'tapenv'
+ENV['TAPRC']     ||= '~/.taprc:taprc'
+ENV['TAPFILE']   ||= 'tapfile'
+ENV['TAP_CACHE'] ||= '~/.tap'
 
-exit(0)
+load File.expand_path('../tapexe', __FILE__)