tap 0.9.1 → 0.10.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tap
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,20 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-26 00:00:00 -06:00
+date: 2008-08-08 00:00:00 -06:00
 default_executable: tap
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.0.1
-    version: 
+dependencies: []
+
 description: 
-email: simon.chiang@uchsc.edu
+email: simon.a.chiang@gmail.com
 executables: 
 - tap
 extensions: []
@@ -31,218 +23,95 @@ extra_rdoc_files:
 - README
 - MIT-LICENSE
 - History
-- Tutorial
-- Basic Overview
-- Command Reference
+- doc/Tutorial
+- doc/Class Reference
+- doc/Command Reference
 files: 
 - README
 - MIT-LICENSE
 - History
-- Tutorial
-- Basic Overview
-- Command Reference
-- Rakefile
+- cmd/console.rb
+- cmd/destroy.rb
+- cmd/generate.rb
+- cmd/run.rb
+- doc/Tutorial
+- doc/Class Reference
+- doc/Command Reference
 - bin/tap
 - lib/tap/app.rb
 - lib/tap/constants.rb
-- lib/tap/dump.rb
 - lib/tap/env.rb
 - lib/tap/file_task.rb
+- lib/tap/generator/base.rb
+- lib/tap/generator/destroy.rb
+- lib/tap/generator/generate.rb
 - lib/tap/generator/generators/command/command_generator.rb
 - lib/tap/generator/generators/command/templates/command.erb
-- lib/tap/generator/generators/command/USAGE
 - lib/tap/generator/generators/config/config_generator.rb
-- lib/tap/generator/generators/config/templates/config.erb
-- lib/tap/generator/generators/config/USAGE
+- lib/tap/generator/generators/config/templates/doc.erb
+- lib/tap/generator/generators/config/templates/nodoc.erb
 - lib/tap/generator/generators/file_task/file_task_generator.rb
 - lib/tap/generator/generators/file_task/templates/file.txt
-- lib/tap/generator/generators/file_task/templates/file.yml
+- lib/tap/generator/generators/file_task/templates/result.yml
 - lib/tap/generator/generators/file_task/templates/task.erb
 - lib/tap/generator/generators/file_task/templates/test.erb
-- lib/tap/generator/generators/file_task/USAGE
-- lib/tap/generator/generators/generator/generator_generator.rb
-- lib/tap/generator/generators/generator/templates/generator.erb
-- lib/tap/generator/generators/generator/templates/usage.erb
-- lib/tap/generator/generators/generator/USAGE
 - lib/tap/generator/generators/root/root_generator.rb
 - lib/tap/generator/generators/root/templates/Rakefile
-- lib/tap/generator/generators/root/templates/ReadMe.txt
-- lib/tap/generator/generators/root/templates/tap.yml
+- lib/tap/generator/generators/root/templates/tapfile
+- lib/tap/generator/generators/root/templates/gemspec
 - lib/tap/generator/generators/root/templates/test/tap_test_helper.rb
 - lib/tap/generator/generators/root/templates/test/tap_test_suite.rb
-- lib/tap/generator/generators/root/USAGE
+- lib/tap/generator/generators/root/templates/test/tapfile_test.rb
 - lib/tap/generator/generators/task/task_generator.rb
 - lib/tap/generator/generators/task/templates/task.erb
 - lib/tap/generator/generators/task/templates/test.erb
-- lib/tap/generator/generators/task/USAGE
-- lib/tap/generator/generators/workflow/templates/task.erb
-- lib/tap/generator/generators/workflow/templates/test.erb
-- lib/tap/generator/generators/workflow/USAGE
-- lib/tap/generator/generators/workflow/workflow_generator.rb
-- lib/tap/generator/options.rb
-- lib/tap/generator/usage.rb
-- lib/tap/generator.rb
+- lib/tap/generator/manifest.rb
 - lib/tap/patches/rake/rake_test_loader.rb
 - lib/tap/patches/rake/testtask.rb
 - lib/tap/patches/ruby19/backtrace_filter.rb
 - lib/tap/patches/ruby19/parsedate.rb
 - lib/tap/root.rb
-- lib/tap/cmd/console.rb
-- lib/tap/cmd/destroy.rb
-- lib/tap/cmd/generate.rb
-- lib/tap/cmd/run.rb
 - lib/tap/support/aggregator.rb
+- lib/tap/support/assignments.rb
 - lib/tap/support/audit.rb
 - lib/tap/support/batchable.rb
-- lib/tap/support/batchable_methods.rb
+- lib/tap/support/batchable_class.rb
 - lib/tap/support/class_configuration.rb
 - lib/tap/support/command_line.rb
-- lib/tap/support/command_line_methods.rb
+- lib/tap/support/comment.rb
 - lib/tap/support/configurable.rb
-- lib/tap/support/configurable_methods.rb
+- lib/tap/support/configurable_class.rb
+- lib/tap/support/configuration.rb
+- lib/tap/support/constant.rb
+- lib/tap/support/constant_utils.rb
+- lib/tap/support/declarations.rb
 - lib/tap/support/executable.rb
 - lib/tap/support/executable_queue.rb
-- lib/tap/support/logger.rb
-- lib/tap/support/rake.rb
+- lib/tap/support/framework.rb
+- lib/tap/support/framework_class.rb
+- lib/tap/support/instance_configuration.rb
+- lib/tap/support/lazydoc.rb
+- lib/tap/support/manifest.rb
 - lib/tap/support/run_error.rb
 - lib/tap/support/shell_utils.rb
-- lib/tap/support/tdoc/config_attr.rb
+- lib/tap/support/tdoc.rb
 - lib/tap/support/tdoc/tdoc_html_generator.rb
 - lib/tap/support/tdoc/tdoc_html_template.rb
-- lib/tap/support/tdoc.rb
+- lib/tap/support/summary.rb
+- lib/tap/support/templater.rb
 - lib/tap/support/validation.rb
 - lib/tap/support/versions.rb
 - lib/tap/task.rb
+- lib/tap/tasks/dump.rb
+- lib/tap/tasks/rake.rb
 - lib/tap/test/env_vars.rb
 - lib/tap/test/file_methods.rb
+- lib/tap/test/script_methods.rb
 - lib/tap/test/subset_methods.rb
 - lib/tap/test/tap_methods.rb
 - lib/tap/test.rb
 - lib/tap/workflow.rb
 - lib/tap.rb
-- test/app/config/another/task.yml
-- test/app/config/batch.yml
-- test/app/config/empty.yml
-- test/app/config/erb.yml
-- test/app/config/some/task.yml
-- test/app/config/template.yml
-- test/app/config/version-0.1.yml
-- test/app/config/version.yml
-- test/app/lib/app_test_task.rb
-- test/app_test.rb
-- test/env/test_configure/recurse_a.yml
-- test/env/test_configure/recurse_b.yml
-- test/env/test_configure/tap.yml
-- test/env/test_load_env_config/dir/tap.yml
-- test/env/test_load_env_config/recurse_a.yml
-- test/env/test_load_env_config/recurse_b.yml
-- test/env/test_load_env_config/tap.yml
-- test/env_test.rb
-- test/file_task/config/batch.yml
-- test/file_task/config/configured.yml
-- test/file_task/old_file_one.txt
-- test/file_task/old_file_two.txt
-- test/file_task_test.rb
-- test/root/alt_lib/alt_module.rb
-- test/root/glob/one.txt
-- test/root/glob/two.txt
-- test/root/lib/absolute_alt_filepath.rb
-- test/root/lib/alternative_filepath.rb
-- test/root/lib/another_module.rb
-- test/root/lib/nested/some_module.rb
-- test/root/lib/no_module_included.rb
-- test/root/lib/some/module.rb
-- test/root/lib/some_class.rb
-- test/root/lib/some_module.rb
-- test/root/load_path/load_path_module.rb
-- test/root/load_path/skip_module.rb
-- test/root/mtime/older.txt
-- test/root/unload/full_path.rb
-- test/root/unload/loaded_by_nested.rb
-- test/root/unload/nested/nested_load.rb
-- test/root/unload/nested/nested_with_ext.rb
-- test/root/unload/nested/relative_path.rb
-- test/root/unload/older.rb
-- test/root/unload/unload_base.rb
-- test/root/versions/another.yml
-- test/root/versions/file-0.1.2.yml
-- test/root/versions/file-0.1.yml
-- test/root/versions/file.yml
-- test/root/file.txt
-- test/root_test.rb
-- test/support/aggregator_test.rb
-- test/support/audit_test.rb
-- test/support/batchable_test.rb
-- test/support/class_configuration_test.rb
-- test/support/command_line_test.rb
-- test/support/configurable/config/configured.yml
-- test/support/configurable_test.rb
-- test/support/executable_queue_test.rb
-- test/support/executable_test.rb
-- test/support/logger_test.rb
-- test/support/rake_test.rb
-- test/support/shell_utils_test.rb
-- test/support/tdoc_test.rb
-- test/support/validation_test.rb
-- test/support/versions_test.rb
-- test/tap_test_helper.rb
-- test/tap_test_suite.rb
-- test/task/config/batch.yml
-- test/task/config/batched.yml
-- test/task/config/configured.yml
-- test/task/config/example.yml
-- test/task_base_test.rb
-- test/task_syntax_test.rb
-- test/task_test.rb
-- test/test/env_vars_test.rb
-- test/test/file_methods/test_assert_files/expected/one.txt
-- test/test/file_methods/test_assert_files/expected/two.txt
-- test/test/file_methods/test_assert_files/input/one.txt
-- test/test/file_methods/test_assert_files/input/two.txt
-- test/test/file_methods/test_assert_files_can_have_no_expected_files_if_specified/input/one.txt
-- test/test/file_methods/test_assert_files_can_have_no_expected_files_if_specified/input/two.txt
-- test/test/file_methods/test_assert_files_fails_for_different_content/expected/one.txt
-- test/test/file_methods/test_assert_files_fails_for_different_content/expected/two.txt
-- test/test/file_methods/test_assert_files_fails_for_different_content/input/one.txt
-- test/test/file_methods/test_assert_files_fails_for_different_content/input/two.txt
-- test/test/file_methods/test_assert_files_fails_for_missing_expected_file/expected/one.txt
-- test/test/file_methods/test_assert_files_fails_for_missing_expected_file/input/one.txt
-- test/test/file_methods/test_assert_files_fails_for_missing_expected_file/input/two.txt
-- test/test/file_methods/test_assert_files_fails_for_missing_output_file/expected/one.txt
-- test/test/file_methods/test_assert_files_fails_for_missing_output_file/expected/two.txt
-- test/test/file_methods/test_assert_files_fails_for_missing_output_file/input/one.txt
-- test/test/file_methods/test_assert_files_fails_for_missing_output_file/input/two.txt
-- test/test/file_methods/test_assert_files_fails_for_no_expected_files/input/one.txt
-- test/test/file_methods/test_assert_files_fails_for_no_expected_files/input/two.txt
-- test/test/file_methods/test_method_glob/expected/file.yml
-- test/test/file_methods/test_method_glob/expected/file_1.txt
-- test/test/file_methods/test_method_glob/expected/file_2.txt
-- test/test/file_methods_doc/test_sub/expected/one.txt
-- test/test/file_methods_doc/test_sub/expected/two.txt
-- test/test/file_methods_doc/test_sub/input/one.txt
-- test/test/file_methods_doc/test_sub/input/two.txt
-- test/test/file_methods_doc_test.rb
-- test/test/file_methods_test.rb
-- test/test/subset_methods_test.rb
-- test/test/tap_methods/test_assert_files/expected/task/name/a.txt
-- test/test/tap_methods/test_assert_files/expected/task/name/b.txt
-- test/test/tap_methods/test_assert_files/input/a.txt
-- test/test/tap_methods/test_assert_files/input/b.txt
-- test/test/tap_methods_test.rb
-- test/workflow_test.rb
-- vendor/rails_generator/base.rb
-- vendor/rails_generator/commands.rb
-- vendor/rails_generator/generated_attribute.rb
-- vendor/rails_generator/lookup.rb
-- vendor/rails_generator/manifest.rb
-- vendor/rails_generator/options.rb
-- vendor/rails_generator/scripts/destroy.rb
-- vendor/rails_generator/scripts/generate.rb
-- vendor/rails_generator/scripts/update.rb
-- vendor/rails_generator/scripts.rb
-- vendor/rails_generator/simple_logger.rb
-- vendor/rails_generator/spec.rb
-- vendor/rails_generator.rb
 has_rdoc: true
 homepage: http://tap.rubyforge.org
 post_install_message: 
@@ -268,9 +137,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: tap
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: A framework for configurable, distributable, and easy-to-use tasks and workflow applications.
-test_files: 
-- test/tap_test_suite.rb
+summary: A framework for creating configurable, distributable tasks and workflows.
+test_files: []
+

data/Basic Overview

@@ -1,151 +0,0 @@
-= The Tap Application (Tap::App)
-
-Instances of Tap::App coordinate the execution of tasks.  Normally a script will only need and use a single instance (often Tap::App.instance), but there is no reason why multiple instances could not be used.  Apps basically consist of reference to a root directory, and task queue.  
-
-=== Root Directory (Tap::Root)
-
-The root directory establishes the base of a standard directory structure that facilitates configuration, dependency loading, and file handling.  Apps 'live' in the directory structure, but are not confined to it.  Code associated with the root directory allows you to alias directories, basically meaning that the conceptual standard directories can be put anywhere in the file system.  
-
-The basic structure looks like this:
-
-  /path/to/root_dir
-  |- config
-  |   `- sample
-  |       `- task.yml             # a default config file for Sample::Task
-  |- lib
-  |   `- sample
-  |       `- task.rb              # a class file like above
-  |- tap.yml                      # a configuration file for Tap::App
-
-All these files/directories are optional (and there are others that could be added), but for illustration say you instantiated an App to the directory above:
-
-  require 'tap'
-  
-  app = Tap::App.new :root => '/path/to/root_dir'
-  app.root                                      # => '/path/to/root_dir'
-  app['config']                                 # => '/path/to/root_dir/config'
-  app.filepath('config', 'sample/task.yml')     # => '/path/to/root_dir/config/sample/task.yml'
-  
-Then if you wanted to alias the config directory somewhere else:
-
-  # set a new directory relative to root
-  app['config'] = 'alt'
-  app['config']                                 # => '/path/to/root_dir/alt'
-  app.filepath('config', 'sample/task.yml')     # => '/path/to/root_dir/alt/sample/task.yml'
-  
-  # set an absolute path to anywhere
-  app['config', true] = '/path/somewhere/else'
-  app['config']                                 # => '/path/somewhere/else'
-  app.filepath('config', 'sample/task.yml')     # => '/path/somewhere/else/sample/task.yml'
-  
-While very simple, this ability to reference files using directory aliases is useful, powerful, and forms the basis of the Tap execution environment.  All directory aliases and environment configurations can be defined in the 'tap.yml' file.
-
-=== Task Queue
-
-Apps coordinate the execution of tasks through a queue.  Although referred to here as a 'task queue', the queue is actually just a stack of methods to run and the inputs to the methods.  Any methods from any object can be enqued; tasks do not need to be involved.  
-
-During a run the enqued methods are run sequentially.  When multithreading, multiple methods can be run at once, but normally methods are run one at a time on the same thread.  
-
-= Tasks (Tap::Task)
-
-Tasks can be defined within a script using a syntax similar to Rake:
-
-  t = Tap::Task.new do |task|
-    # .. do something ...
-  end
-  t.execute
-  
-Unlike a Rake task, Tap tasks can be made to take inputs:
-
-  t = Tap::Task.new do |task, one, two|
-    # .. do something with the inputs ...
-  end
-  t.execute(1,2)
-  
-Tasks are designed for subclassing.  A task class is structured like this (with annotation):
-  
-  module Sample
-    # == Description
-    # This documentation is available in RDoc, as well as from the command line.
-    # === Usage
-    #  % tap run sample/task
-    #
-    # By default, usage info comes up as well...
-    #
-    class Task < Tap::Task
-
-      # Configurations are defined like this.  Tap makes
-      # the config documentation available in Rdoc and
-      # in the command line.
-      #
-      # The default 'config' creates accessors, as can 
-      # be seen in the process method.
-      
-      # Full documentation for the configuration
-      # can be written here.
-      config :key, "input"                            # command line documentation
-      
-      # Configurations can be transformed or 
-      # validated by an optional block.
-      config :transformation, "string" do |value|     # this config is modified to "STRING"
-        value.upcase
-      end
-      config :standard_validation, {}, &c.check(Hash) # non-hash values raise an error
-    
-      # Process receives each input from the command line
-      # and is analogous to the block in the samples above.
-      # Any number of inputs are allowed, including an 
-      # arbitrary number of inputs (using *) and no inputs.
-      def process(input)
-      
-        # log is available to record information
-        result = "#{input} was processed with #{key}"
-        log self.name, result
-
-        result
-      end
-    end
-  end
-
-Once instantiated, tasks can be enqued to an App or joined into a workflow.  
-      
-All task instances may have a name, which serves as a relative filepath to a configuration file and other associated files.  When the application instantiates a task by the name 'sample/task' it sets the instance configs from 'config/sample/task.yml'.  Nil can be used to specify no config file. 
-
-Names need not be unique.  Multiple task instances, even from different classes, may be named the same and thus get their configurations from the same file.  A map of task names to task classes can be set up in an app, allowing easy lookup and task instantiation through the app.task method:
-
-  app = Tap:App.instance
-
-  # set up a mapping between a name and a task class
-  app.map["alt"] = Sample::Task 
-
-  t1 = app.task("sample/task")     # Sample::Task configured from 'config/sample/task.yml'
-  t2 = app.task("alt")             # Sample::Task configured from 'config/alt.yml'
-  
-  # the idea is the same if you manually make a task... 
-
-  t3 = Tap::Task.new("alt")        # Tap::Task configured from 'config/alt.yml'
-  
-  t1.class     # => Sample::Task
-  t2.class     # => Sample::Task
-  t3.class     # => Tap::Task
-
-= Workflows (Tap::Workflow)
-
-Once instantiated, tasks can be joined into workflows.  The workflow model used by Tap is very simple; workflows are implemented using the App queue, whereby each tasks enques the next task (or tasks) in the workflow when the task completes.  
-
-Each task can be assigned an on_complete block to do so.  Arbitrary workflow logic can be used to join tasks in this way, but by default Tap supports sequencing, forking, and merging.  If a task has no on_complete block, App collects the unhandled results in app.aggregator so they can be handled somewhere else.
-
-Workflows are not Tasks, but work exactly like Tasks.  Workflows can be configured, enqued, used in or joined to other workflows, and subclassed.
-
-= Auditing (Tap::Support::Audit)
-
-Tap tracks inputs as they are modified by various tasks.  At the end of a run, the individual results can be tracked back to it's original value, through the tasks that modified it.  This auditing can be very useful when workflows diverge (as they often do), adding or subtracting steps depending on the input.
-
-Auditing is largely invisible except in on_complete blocks.  On complete blocks receive the audited results so that this information can be used, as needed, to make decisions.  
-
-  t = Task.new
-  t.on_complete do |_result|      # _result is an Audit instance
-    _result._current              # the current value
-    _result._original             # the original value
-  end
-