tap-suite 0.2.0 → 0.3.0

data/History

@@ -1,3 +1,11 @@
+== 0.4.0 / 2009-12-05
+
+Updated versions to utilize Tap-0.19.0 and related libraries.
+
+== 0.3.0 / 2009-06-17
+
+Updated versions to utilize Tap-0.18.0 and related libraries.
+
 == 0.2.0 / 2009-05-25
 
 Updated versions to utilize Tap-0.17.0 and related libraries.

data/MIT-LICENSE

@@ -1,19 +1,21 @@
 Copyright (c) 2009, Regents of the University of Colorado.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this
-software and associated documentation files (the "Software"), to deal in the Software
-without restriction, including without limitation the rights to use, copy, modify, merge,
-publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
-to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2009, Simon Chiang.
 
-The above copyright notice and this permission notice shall be included in all copies or
-substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -8,41 +8,30 @@ workflows.
 == Description
 
 {Tap}[http://tap.rubyforge.org] is a configurable, distributable workflow
-framework. Several related modules apply Tap in particularly useful ways. The
-Tap-Suite is simply a collection of those gems, facilitating installation and
-update.
+framework. Tap-Suite is a collection of gems facilitating development with
+Tap.
 
 Currently these modules are included:
 
 * {Tap}[http://tap.rubyforge.org/rdoc]
 * {Rap}[http://tap.rubyforge.org/rap]
 * {Tap-Generators}[http://tap.rubyforge.org/tap-gen]
-* {Tap-Server}[http://tap.rubyforge.org/tap-server]
 * {Tap-Tasks}[http://tap.rubyforge.org/tap-tasks]
 * {Tap-Test}[http://tap.rubyforge.org/tap-test]
 
 Check out these links for documentation, development, and bug tracking.
 
 * Website[http://tap.rubyforge.org] 
-* Lighthouse[http://bahuvrihi.lighthouseapp.com/projects/9908-tap-task-application/tickets]
 * Github[http://github.com/bahuvrihi/tap/tree/master] 
 * {Google Group}[http://groups.google.com/group/ruby-on-tap]
 
 == Installation
 
-{Tap Suite}[http://tap.rubyforge.org/tap-suite] is available as a gem on RubyForge[http://rubyforge.org/projects/tap].  Use:
+Tap Suite is available as a gem on Gemcutter[http://gemcutter.org/gems/tap-suite].
 
   % gem install tap-suite
 
-Tap requires an updated version of RubyGems[http://docs.rubygems.org/] (>= 1.2.0).  To check the version and update RubyGems:
-
-  % gem --version
-  % gem --update system
-
 == Info 
 
-Copyright (c) 2009, Regents of the University of Colorado.
-Developer:: {Simon Chiang}[http://bahuvrihi.wordpress.com], {Biomolecular Structure Program}[http://biomol.uchsc.edu/], {Hansen Lab}[http://hsc-proteomics.uchsc.edu/hansenlab/] 
-Support:: CU Denver School of Medicine Deans Academic Enrichment Fund
+Developer:: {Simon Chiang}[http://bahuvrihi.wordpress.com]
 License:: {MIT-Style}[link:files/MIT-LICENSE.html]
-

data/lib/tap/suite/version.rb

@@ -0,0 +1,9 @@
+module Tap
+  module Suite
+    MAJOR = 0
+    MINOR = 3
+    TINY = 0
+  
+    VERSION="#{MAJOR}.#{MINOR}.#{TINY}" 
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tap-suite
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-25 00:00:00 -06:00
+date: 2009-12-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.17.0
+        version: 0.19.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: rap
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.13.0
+        version: 0.15.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: tap-gen
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.0
+        version: 0.3.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: tap-server
@@ -50,7 +50,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.0
+        version: 0.6.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: tap-tasks
@@ -60,7 +60,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.0
+        version: 0.5.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: tap-test
@@ -70,7 +70,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.0
+        version: 0.3.0
     version: 
 description: 
 email: simon.a.chiang@gmail.com
@@ -82,14 +82,15 @@ extra_rdoc_files:
 - README
 - MIT-LICENSE
 - History
-- doc/Tutorial
 files: 
+- lib/tap/suite/version.rb
 - README
 - MIT-LICENSE
 - History
-- doc/Tutorial
-has_rdoc: false
+has_rdoc: true
 homepage: http://tap.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -115,9 +116,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: tap
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A collection of modules to rapidly develop Tap workflows
 test_files: []
 

data/doc/Tutorial

@@ -1,344 +0,0 @@
-= Tap (Task Application)
-
-Tap is a framework for creating configurable, distributable workflows.
-Although scalable for complex workflows, at it simplest Tap works like a
-supercharged rake.  Using the rap executable, you can declare tasks using a
-syntax almost identical to rake, but with added support for configurations and
-documentation.
-
-Note: this tutorial spans several modules in the {Tap-Suite}[http://tap.rubyforge.org/tap-suite].
-Be sure to install the full suite beforehand.
-
-  % gem install tap-suite
-
-== Quickstart
-
-If you've used rake, Tap will be easy to pick up.  To get started, make a
-Rapfile with a simple task declaration:
-
-  [Rapfile]
-    
-  # ::desc your basic goodnight moon task
-  # Says goodnight with a configurable message.
-  Rap.task(:goodnight, :obj, :message => 'goodnight') do |task, args|
-    puts "#{task.message} #{args.obj}\n"
-  end
-  
-Now from the command line:
-
-  % rap goodnight moon
-  goodnight moon
-  
-  % rap goodnight world --message hello
-  hello world
-  
-  % rap goodnight --help
-  Goodnight -- your basic goodnight moon task
-  --------------------------------------------------------------------------------
-    Says goodnight with a configurable message.
-  --------------------------------------------------------------------------------
-  usage: rap goodnight OBJ
-
-  configurations:
-          --message MESSAGE
-
-  options:
-      -h, --help                       Print this help
-          --config FILE                Specifies a config file
-  
-The declaration syntax is obviously similar to rake; configurations are new
-but the task-block style is the same, as are inputs. Other rake constructs are
-available. Here is a similar goodnight task using dependencies, rake-style.
-
-  [Rapfile]
-  
-  # make the declarations available everywhere
-  include Rap::Declarations
-  
-  namespace :example do
-    task(:say, :message) do |task, args|
-      print(args.message || 'goodnight')
-    end
-    
-    desc "your basic goodnight moon task"
-    task({:goodnight => 'example:say'}, :obj) do |task, args|
-      puts " #{args.obj}\n"
-    end
-  end
-
-And now from the command line: 
-
-  % rap goodnight moon
-  goodnight moon
-  
-  % rap goodnight world -- say hello
-  hello world
-
-Unlike rake, rap inputs are written out individually and tasks are delimited
-by a double-dash. Aside from that, you can see rap is basically a supercharged
-rake. Furthermore, rap runs rake. Directly substitute rap for rake on the
-command line and your tasks should run as normal (see the Rap {Syntax
-Reference}[http://tap.rubyforge.org/rap/files/doc/Syntax%20Reference.html] for
-more details).
-
-However, supercharging rake isn't the point of Tap.  Declarations bridge the
-gap between rake and tap, but tap itself is a more general framework.  To get
-at other features like imperative workflows, testing, and distribution, we
-have to go beyond rap and take a look at what declarations do.
-
-Spoiler: declarations make subclasses of Tap::Task. 
-
-== Beyond Rap
-
-Going back to the first example, lets take a look at how a task declaration
-maps to a class definition:
-
-  [Rapfile]
-  
-  # ::desc your basic goodnight moon task
-  # Says goodnight with a configurable message.
-  Rap.task(:goodnight, :obj, :message => 'goodnight') do
-    puts "#{task.message} #{args.obj}\n"
-  end
-  
-Here is a corresponding class:
-
-  # Goodnight::manifest your basic goodnight moon task
-  # Says goodnight with a configurable message.
-  class Goodnight < Tap::Task
-    config :message, 'goodnight'
-
-    def process(obj)
-      "#{message} #{obj}"
-    end
-  end
-
-The name corresponds to the class, configurations (and dependencies, although
-they aren't show) are written out individually, and the block corresponds to
-process. There are a few differences, especially relating to process, but for
-the moment lets gloss over them and see how Goodnight works.
-
-  goodnight = Goodnight.new
-  goodnight.message                        # => 'goodnight'
-  goodnight.process('moon')                # => 'goodnight moon'
-  
-  hello = Goodnight.new(:message => 'hello')
-  hello.message                            # => 'hello'
-  hello.process('world')                   # => 'hello world'
-
-Totally straightforward. Goodnight stores the default configurations, each
-instance has accessors to the configurations, and the defaults may be
-overridden during initialization, or later. 
-
-Class definitions allow validation/transformation blocks to be specified for
-configurations. These blocks process inputs (ex the string inputs from the
-command line), literally defining the writer for a configuration accessor. A
-set of standard blocks are available through +c+, an alias for the
-{Configurable::Validation}[http://tap.rubyforge.org/configurable/classes/Configurable/Validation.html]
-module.
-
-  [lib/goodnight.rb]
-  
-  # Goodnight::manifest a fancy goodnight moon task
-  # Says goodnight with a configurable message.
-  class Goodnight < Tap::Task
-    config :message, 'goodnight'           # a goodnight message
-    config :reverse, false, &c.switch      # reverses the message
-    config :n, 1, &c.integer               # repeats message n times
-    
-    def process(*objects)
-      msg = "#{reverse == true ? message.reverse : message} " * n
-      msg + objects.join(', ')
-    end
-  end
-
-A few examples show a validation block in action:
-
-  goodnight = Goodnight.new
-  
-  goodnight.n = 10
-  goodnight.n                              # => 10
-  
-  goodnight.n = "100"
-  goodnight.n                              # => 100
-  
-  goodnight.n = "not an integer"           # !> ValidationError
-  
-Now from the command line:
-  
-  % rap goodnight moon --: dump
-  goodnight moon
-  
-  % rap goodnight moon mittens "little toy boat" --: dump
-  goodnight moon, mittens, little toy boat
-  
-  % rap goodnight world --message hello --reverse --n 3 --: dump
-  olleh olleh olleh world
-  
-  % rap goodnight --help
-  Goodnight -- a fancy goodnight moon task
-  --------------------------------------------------------------------------------
-    Says goodnight with a configurable message.
-  --------------------------------------------------------------------------------
-  usage: rap goodnight OBJECTS...
-
-  configurations:
-          --message MESSAGE            a goodnight message
-          --[no-]reverse               reverses the message
-          --n N                        repeats message n times
-
-  options:
-      -h, --help                       Print this help
-          --config FILE                Specifies a config file
-
-Take a quick look at the documentation. Class definitions map documentation
-and, in some cases, metadata to the command line; the configurations now have
-comments and reverse is a switch. Rich mapping like this allows tasks to act
-as an script interface, not unlike
-{OptionParser}[http://www.ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html]
-(check out the {Configurable}[http://tap.rubyforge.org/configurable/] gem and
-specifically
-{ConfigParser}[http://tap.rubyforge.org/configurable/classes/ConfigParser.html]
-for more details).
-
-This is a stand-alone goodnight script:
-
-  [goodnight]
-  
-  #!/usr/bin/env ruby
-  
-  require 'rubygems'
-  require 'tap'
-
-  # Goodnight::task a goodnight moon script
-  # Says goodnight with a configurable message.
-  class Goodnight < Tap::Task
-    config :message, 'goodnight'
-
-    def process(obj)
-      puts "#{message} #{obj}\n"
-    end
-  end
-
-  instance, args = Goodnight.parse!(ARGV)
-  instance.execute(*args)
-  
-Now, from the command line:
-
-  % ./goodnight moon
-  goodnight moon
-  
-  % ./goodnight --help
-  ...
-  
-Tasks may be subclassed, tested, and distributed as usual.  No magic, just
-convenience.
-
-== Tap
-
-Tap comes with two executables, rap and tap. The tap executable is more
-verbose than rap for running tasks, but it is more configurable, scalable, and
-logically pure. The full suite comes with a number of commands but we'll focus
-on generate to make, test, and package a task library. Begin by creating a tap
-directory structure and a task:
-
-  % tap generate root sample
-  % cd sample
-  % tap generate task goodnight
-
-Take a look at the task files and you find something like this:
-
-  [lib/goodnight.rb]
-  
-  # Goodnight::manifest <replace with manifest summary>
-  # <replace with command line description>
-
-  # Goodnight Documentation
-  class Goodnight < Tap::Task
-
-    # <config file documentation>
-    config :message, 'goodnight'           # a sample config
-  
-    def process(name)
-      log message, name
-      "#{message} #{name}"
-    end
-  end 
-
-  [test/goodnight_test.rb]
-  
-  require File.join(File.dirname(__FILE__), 'tap_test_helper.rb') 
-  require 'goodnight'
-
-  class GoodnightTest < Test::Unit::TestCase
-    acts_as_tap_test 
-
-    def test_goodnight
-      task = Goodnight.new :message => "goodnight"
-
-      # a simple test
-      assert_equal({:message  => 'goodnight'}, task.config)
-      assert_equal "goodnight moon", task.process("moon")
-
-      # a more complex test
-      task.enq("moon")
-      app.run
-
-      assert_equal ["goodnight moon"], app.results(task)
-      assert_audit_equal [[nil, "moon"], [task, "goodnight moon"]], app._results(task)[0]
-    end
-  end
-
-Run the test:
-
-  % rap test
-
-Run the task:
-
-  % rap goodnight moon
-    I[23:22:19]          goodnight moon
-
-Ok, lets share it.  Print the current gemspec manifest:
-
-  % rap print_manifest
-  true  README
-        Rakefile
-        lib/goodnight.rb
-        sample.gemspec
-  true  tap.yml
-        test/goodnight_test.rb
-  true  test/tap_test_helper.rb
-  true  test/tap_test_suite.rb
-  
-As you can see, this needs an update to include the task file.  Open up
-sample.gemspec and fix the manifest.
-
-  [sample.gemspec]
-  
-  Gem::Specification.new do |s|
-    s.name = "sample"
-    s.version = "0.0.1"
-    s.platform = Gem::Platform::RUBY
-    s.summary = "sample"
-    s.require_path = "lib"
-    s.add_dependency("tap")
-    s.files = %W{
-      lib/goodnight.rb
-      tap.yml
-    }
-  end
-
-Now package the gem and install it (gem may require sudo):
-
-  % rap gem
-  % gem install pkg/sample-0.0.1.gem
-  
-Now you can say goodnight anywhere, using 'tap run' or rap:
-
-  % cd ~/Desktop
-  % tap run -- goodnight moon
-  goodnight moon
-  % rap goodnight opus
-  goodnight opus
-
-And that is that.