tap 0.12.1 → 0.12.2

data/History

@@ -1,3 +1,11 @@
+== 0.12.2 / 2009-02-23
+
+* Added --no-yaml option to Dump and Load
+* Added --aggregate option to Join
+* Updated Dump behavior to merge inputs before process
+* Reworked App so that it is not a Root
+* Added the ability to load workflows via 'tap run'
+
 == 0.12.1 / 2009-02-18
 
 Maintenance release with updates to Dump and Load tasks.

data/README

@@ -91,6 +91,7 @@ Tap comes with generators. To get started:
 - 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
 

data/cmd/console.rb

@@ -1,4 +1,4 @@
-# tap console {options}
+# tap console [options]
 #
 # Opens up an IRB session with Tap initialized to the configurations 
 # in tap.yml. Access the Tap::App.instance through 'app', and

data/cmd/manifest.rb

@@ -1,4 +1,4 @@
-# tap manifest
+# tap manifest [options]
 #
 # Prints information about the current tap environment.
 #

data/cmd/run.rb

@@ -1,4 +1,4 @@
-# tap run {options} -- {task options} task INPUTS...
+# tap run FILEPATHS... [options] -- [SCHEMA]
 #
 # examples:
 #   tap run --help                     Prints this help
@@ -8,6 +8,16 @@
 env = Tap::Env.instance
 app = Tap::App.instance
 
+#
+# divide argv
+#
+
+run_argv = []
+break_regexp = Tap::Support::Parser::BREAK
+while !ARGV.empty? && ARGV[0] !~ break_regexp
+  run_argv << ARGV.shift
+end
+
 #
 # handle options
 #
@@ -38,19 +48,31 @@ ConfigParser.new do |opts|
     exit
   end
   
-end.parse!(ARGV)
+end.parse!(run_argv, app.config)
 
 #
 # build and run the argv
 #
 
-env.set_signals
-env.build(ARGV)
+run_argv.each do |path|
+  unless File.exists?(path)
+    puts "No such file or directory - #{path}"
+    puts "(did you mean 'tap run -- #{path}'?)"
+    exit
+  end
+  
+  schema = Tap::Support::Schema.load_file(path)
+  env.build(schema, app)
+end
+
+schema = Tap::Support::Schema.parse(ARGV)
 ARGV.clear
+env.build(schema, app)
 
 if app.queue.empty?
   puts "no task specified"
   exit
 end
 
+env.set_signals
 app.run

data/doc/Class Reference

@@ -248,8 +248,7 @@ inputs.
 
 http://tap.rubyforge.org/images/App.png
 
-Instances of Tap::App coordinate the execution of tasks.  Apps are basically a
-subclass of Root with an ExecutableQueue.
+Instances of Tap::App coordinate the execution of tasks.
 
 Task initialization requires an App, which is by default Tap::App.instance.  
 Tasks use their app for logging, dependency-resolution, checks, and to enque 
@@ -370,5 +369,4 @@ http://tap.rubyforge.org/images/Run-Env.png
 
 Tap::Exe adds several configurations (ex before/after) which only get loaded
 for the present directory, and methods for building and executing workflows
-from command line inputs.  Tap::Exe is a singleton, and is special because it
-wraps Tap::App.instance.
+from command line inputs.

data/lib/tap/app.rb

@@ -1,6 +1,5 @@
 require 'logger'
 
-require 'tap/root'
 require 'tap/support/aggregator'
 require 'tap/support/dependencies'
 require 'tap/support/executable_queue'
@@ -123,7 +122,7 @@ module Tap
   #   app.run
   #   array                          # => [1, 2, 3]
   #
-  class App < Root
+  class App < Monitor
     class << self
       # Sets the current app instance
       attr_writer :instance
@@ -134,7 +133,9 @@ module Tap
         @instance ||= App.new
       end
     end
-
+    
+    include Configurable
+    
     # The application logger
     attr_reader :logger
     
@@ -157,6 +158,7 @@ module Tap
     # will be collected by self).
     attr_reader :on_complete_block
     
+    config :audit, true, &c.switch                # Signal auditing
     config :debug, false, &c.flag                 # Flag debugging
     config :force, false, &c.flag                 # Force execution at checkpoints
     config :quiet, false, &c.flag                 # Suppress logging
@@ -179,13 +181,11 @@ module Tap
       def state_str(state)
         constants.inject(nil) {|str, s| const_get(s) == state ? s.to_s : str}
       end
-    end  
-    
-    include MonitorMixin
+    end
     
     # Creates a new App with the given configuration.  
     def initialize(config={}, logger=DEFAULT_LOGGER, &block)
-      super()
+      super() # monitor
       
       @state = State::READY
       @queue = Support::ExecutableQueue.new
@@ -193,7 +193,7 @@ module Tap
       @dependencies = Support::Dependencies.new
       @on_complete_block = block
       
-      reconfigure(config)
+      initialize_config(config)
       self.logger = logger
     end
     

data/lib/tap/env.rb

@@ -1,4 +1,5 @@
 require 'tap/support/constant_manifest'
+autoload(:YAML, 'yaml')
 
 module Tap
   module Support

data/lib/tap/exe.rb

@@ -5,9 +5,8 @@ require 'tap/support/schema'
 module Tap
   class Exe < Env
     class << self
-      def instantiate(path=Dir.pwd)
-        app = App.instance.reconfigure(:root => path)
-        exe = super(app)
+      def instantiate(path_or_root=Dir.pwd)
+        exe = super
         
         # add all gems if no gems are specified (Note this is VERY SLOW ~ 1/3 the overhead for tap)
         exe.gems = :all if !File.exists?(Tap::Env::DEFAULT_CONFIG_FILE)
@@ -39,17 +38,9 @@ module Tap
       end
     end
     
-    # The Root directory structure for self.
-    nest(:root, Tap::App) do |config|
-      case config
-      when App then config
-      when String then App.new(:root => config)
-      else App.new(config)
-      end
-    end
-    
     config :before, nil
     config :after, nil
+    
     # Specify files to require when self is activated.
     config :requires, [], &c.array_or_nil
     
@@ -63,15 +54,6 @@ module Tap
     # The global config file path
     GLOBAL_CONFIG_FILE = File.join(GLOBAL_HOME, "tap.yml")
     
-    def initialize(app=App.instance)
-      super(app)
-    end
-    
-    # Alias for root (Exe should have a Tap::App as root)
-    def app
-      root
-    end
-    
     def activate
       if super      
       
@@ -117,9 +99,8 @@ module Tap
         end
       end
     end
-
-    def build(argv=ARGV, app=app)
-      schema = argv.kind_of?(Support::Schema) ? argv : Support::Schema.parse(argv)
+    
+    def build(schema, app=Tap::App.instance)
       schema.build(app) do |args|
         task = args.shift
         const = tasks.search(task) 

data/lib/tap/file_task.rb

@@ -90,13 +90,12 @@ module Tap
     
     # Constructs a filepath using the dir, name, and the specified paths.
     #
-    #   t = FileTask.new 
-    #   t.app[:data, true] = "/data" 
-    #   t.name                              # => "tap/file_task"
-    #   t.filepath(:data, "result.txt")     # => "/data/tap/file_task/result.txt"
+    #   t = FileTask.new
+    #   t.name                                # => "tap/file_task"
+    #   t.filepath('data', "result.txt")      # => File.expand_path("data/tap/file_task/result.txt")
     #
-    def filepath(dir, *paths) 
-      app.filepath(dir, name, *paths)
+    def filepath(dir, *paths)
+      File.expand_path(File.join(dir, name, *paths))
     end
     
     # Makes a backup filepath relative to backup_dir by using name, the

data/lib/tap/generator/base.rb

@@ -69,6 +69,7 @@ module Tap
       lazy_attr :args, :manifest
       lazy_register :manifest, Arguments
       
+      config :destination_root, Dir.pwd       # The destination root directory
       config :pretend, false, &c.flag         # Run but rollback any changes.
       config :force, false, &c.flag           # Overwrite files that already exist.
       config :skip, false, &c.flag            # Skip files that already exist.
@@ -115,6 +116,11 @@ module Tap
         actions.collect {|action| yield(action) }
       end
       
+      # Constructs a path relative to destination_root.
+      def path(*paths)
+        File.expand_path(File.join(*paths), destination_root)
+      end
+      
       # Peforms a directory action (ex generate or destroy).  Must be
       # overridden by one of the action mixins (ex Generate or Destroy).
       def directory(target, options={})

data/lib/tap/generator/generators/command/command_generator.rb

@@ -10,12 +10,12 @@ module Tap::Generator::Generators
   class CommandGenerator < Tap::Generator::Base
     
     def manifest(m, command_name)
-      m.directory app['cmd']
+      m.directory path('cmd')
       
       template_files do |source, target|
-        m.template app.filepath('cmd', "#{command_name}.rb"), source, :command_name => command_name
+        m.template path('cmd', "#{command_name}.rb"), source, :command_name => command_name
       end
     end
     
   end
-end
+end

data/lib/tap/generator/generators/config/config_generator.rb

@@ -33,7 +33,7 @@ module Tap::Generator::Generators
         
         # setup formatting
         leader = default == nil ? '# ' : ''
-        config = {key => default}.to_yaml[5..-1]
+        config = YAML.dump({key => default})[5..-1]
         "#{lines.join("\n")}#{leader}#{config.strip}\n\n"
       end
     end
@@ -48,7 +48,7 @@ module Tap::Generator::Generators
       
         # setup formatting
         leader = default == nil ? '# ' : ''
-        config = {key => default}.to_yaml[5..-1]
+        config = YAML.dump({key => default})[5..-1]
         "#{leader}#{config.strip}\n"
       end
     end
@@ -72,14 +72,14 @@ module Tap::Generator::Generators
       # setup
       tasc = lookup(name)
       config_name ||= tasc.default_name
-      config_file = app.filepath('config', config_name)
+      config_file = path('config', config_name)
       config_file += ".yml" if File.extname(config_file).empty?
       
       # generate the dumps
       dumps = Configurable::Utils.dump_file(tasc.configurations, config_file, nest, true, &format_block)
       
       # now put the dumps to the manifest
-      m.directory(app['config'])
+      m.directory(path('config'))
       
       dumps.each do |path, content|
         next if content.empty? && !blanks

data/lib/tap/generator/generators/generator/generator_generator.rb

@@ -9,26 +9,26 @@ module Tap::Generator::Generators
     
     def manifest(m, const_name)
       const = Tap::Support::Constant.new(const_name.camelize)
-      dir = app.filepath('lib', const.path)
+      dir = path('lib', const.path)
       
       # make the directory
       m.directory dir
       
       # make the generator
-      m.template app.filepath(dir, "#{const.basename}_generator.rb"), "task.erb", :const => const
+      m.template path(dir, "#{const.basename}_generator.rb"), "task.erb", :const => const
       
       # make the templates directory
-      m.directory app.filepath(dir, 'templates')
+      m.directory path(dir, 'templates')
       
       # make a template file
       # (note it's easier to do this as a file since erb is
       # added, and would have to be escaped in a template)
-      m.file app.filepath(dir, 'templates', 'template_file.erb') do |file|
+      m.file path(dir, 'templates', 'template_file.erb') do |file|
         file << "# A sample template file.\nkey: <%= key %>\n"
       end
       
       if test
-        test_path = app.filepath('test', "#{const.path}_generator_test.rb")
+        test_path = path('test', "#{const.path}_generator_test.rb")
         m.directory File.dirname(test_path)
         m.template test_path, "test.erb", :const => const
       end

data/lib/tap/generator/generators/root/root_generator.rb

@@ -62,7 +62,7 @@ module Tap::Generator::Generators
           
           # setup formatting
           leader = key == 'root' || default == nil ? '# ' : ''
-          config = {key => default}.to_yaml[5..-1]
+          config = YAML.dump({key => default})[5..-1]
           "#{lines.join("\n")}#{leader}#{config.strip}\n\n"
         end
       end if config_file

data/lib/tap/generator/generators/task/task_generator.rb

@@ -10,12 +10,12 @@ module Tap::Generator::Generators
     def manifest(m, const_name)
       const = Tap::Support::Constant.new(const_name.camelize)
       
-      task_path = app.filepath('lib', "#{const.path}.rb")
+      task_path = path('lib', "#{const.path}.rb")
       m.directory File.dirname(task_path)
       m.template task_path, "task.erb", :const => const
       
       if test
-        test_path = app.filepath('test', "#{const.path}_test.rb")
+        test_path = path('test', "#{const.path}_test.rb")
         m.directory File.dirname(test_path)
         m.template test_path, "test.erb", :const => const
       end

data/lib/tap/generator/preview.rb

@@ -10,7 +10,7 @@ module Tap
     #
     #   class Sample < Tap::Generator::Base
     #     def manifest(m)
-    #       dir = app.filepath(:root, 'dir')
+    #       dir = path('dir')
     #
     #       m.directory dir
     #       m.file(File.join(dir, 'file.txt')) {|io| io << "content"}
@@ -27,14 +27,7 @@ module Tap
     #
     #   assert_equal "content", s.preview['dir/file.txt']
     #
-    # Note that relative filepaths are determined from app.root for the
-    # instance; in tests like the one above, it may be prudent to reset
-    # the Tap::App.instance like so:
-    #
-    #   def setup
-    #     Tap::App.instance = Tap::App.new
-    #   end
-    #
+    # Note that relative filepaths are relative to destination_root.
     module Preview
       
       # A hash of (relative_path, content) pairs representing
@@ -45,10 +38,10 @@ module Tap
         base.instance_variable_set(:@preview, {})
       end
       
-      # Returns the path of path, relative to app.root.  If path
-      # is app.root, '.' will be returned.
+      # Returns the path of path, relative to destination_root.  If path
+      # is destination_root, '.' will be returned.
       def relative_path(path)
-        path = app.relative_filepath(:root, path) || path
+        path = Root.relative_filepath(destination_root, path, destination_root) || path
         path.empty? ? "." : path
       end
       

data/lib/tap/support/executable.rb

@@ -143,7 +143,7 @@ module Tap
           end
         end
          
-        audit = Audit.new(self, send(method_name, *inputs), previous)
+        audit = Audit.new(self, send(method_name, *inputs), app.audit ? previous : nil)
         if complete_block = on_complete_block || app.on_complete_block
           complete_block.call(audit)
         else 

data/lib/tap/support/executable_queue.rb

@@ -36,6 +36,19 @@ module Tap
         synchronize { size == 0 }
       end
       
+      def has?(entry)
+        synchronize do
+          entry_id = entry.object_id
+          
+          @rounds.each do |round|
+            round.each do |enqued_entry|
+              return true if entry_id == enqued_entry.object_id
+            end
+          end
+          false
+        end
+      end
+      
       # Enqueues the method and inputs. Raises an error if the  
       # method is not an Executable.
       def enq(method, inputs)
@@ -68,7 +81,7 @@ module Tap
             check_method(method)
           end
           
-          @rounds << round.dup
+          @rounds << round
         end
       end
       

data/lib/tap/support/join.rb

@@ -23,6 +23,10 @@ module Tap
       # than executed immediately.
       config :stack, false, :short => 'k', &c.boolean
       
+      # Aggregates results and enques them to the target
+      # in a trailing round.
+      config :aggregate, false, :short => 'a', &c.boolean
+      
       # Initializes a new join with the specified configuration.
       def initialize(config={})
         initialize_config(config)
@@ -69,12 +73,43 @@ module Tap
       #   stack        the executable is enqued   the executable is executed
       #
       def enq(executable, *_results)
-        unpack(_results) do |_result|
-          if stack 
-            executable.enq(*_result)
-          else
-            executable._execute(*_result)
+        case
+        when aggregate
+          
+          case
+          when iterate, splat, stack
+            raise "iterate, splat, or stack and aggregate"
+          else collect(executable, _results)
+          end
+          
+        else
+          unpack(_results) do |_result|
+            case
+            when stack
+              executable.enq(*_result)            
+            else
+              executable._execute(*_result)
+            end
+          end
+        end
+      end
+      
+      # returns the aggregator for self
+      def aggregator # :nodoc:
+        @aggregator ||= {}
+      end
+      
+      # helper method to aggregate audited results
+      def collect(executable, inputs) # :nodoc:
+        queue = executable.app.queue
+        entry = aggregator[executable]
+        
+        queue.synchronize do
+          unless queue.has?(entry)
+            entry = aggregator[executable] = [executable, []]
+            queue.concat [entry]
           end
+          entry[1].concat(inputs)
         end
       end
       

data/lib/tap/task.rb

@@ -209,10 +209,6 @@ module Tap
         argv = opts.parse!(argv, {}, false)
         
         # load configurations
-        if config_path == nil && name != nil
-          config_path = app.filepath('config', "#{name}.yml")
-        end
-        
         config = load_config(config_path)
         
         # build and reconfigure the instance

data/lib/tap/tasks/dump.rb

@@ -11,6 +11,9 @@ module Tap
     #
     #   % tap run -- [task] --: dump FILEPATH
     #
+    # Results may be printed directly, without conversion to YAML by using the
+    # --no-yaml option.
+    #
     # :startdoc::manifest-
     #
     # Dumps are organized so that arguments passed on the command line are
@@ -33,9 +36,13 @@ module Tap
         end
       end
       
+      lazy_attr :args, :setup
+      lazy_register :setup, Lazydoc::Arguments
+      
       config :date_format, '%Y-%m-%d %H:%M:%S'   # the date format
       config :audit, true, &c.switch             # include the audit trails
       config :date, true, &c.switch              # include a date
+      config :yaml, true, &c.switch              # dump as yaml (vs string)
       
       # The dump target, by default $stdout.  Target may be a filepath,
       # in which case dumps append the file.
@@ -69,8 +76,8 @@ module Tap
         end
         
         # this is the overridden part
-        send(method_name, *previous)
-        audit = Support::Audit.new(self, inputs, previous)
+        audit = Support::Audit.new(self, inputs, app.audit ? previous : nil)
+        send(method_name, audit)
         
         if complete_block = on_complete_block || app.on_complete_block
           complete_block.call(audit)
@@ -83,19 +90,21 @@ module Tap
       
       # Prints the _audit to the target.  The return value of process is
       # not recorded in the audit trail.
-      def process(*_audits)
+      def process(_audit)
         open_io do |io|
           if date
             io.puts "# date: #{Time.now.strftime(date_format)}"
           end
           
-          _audits.each do |_audit|
-            if audit
-              io.puts "# audit:"
-              io.puts "# #{_audit.dump.gsub("\n", "\n# ")}"
-            end
+          if audit
+            io.puts "# audit:"
+            io.puts "# #{_audit.dump.gsub("\n", "\n# ")}"
+          end
           
+          if yaml
             YAML::dump(_audit.value, io)
+          else
+            io << _audit.value.to_s
           end
         end
       end

data/lib/tap/tasks/load.rb

@@ -3,22 +3,28 @@ module Tap
     # :startdoc::manifest the default load task
     #
     # Loads YAML-formatted data and makes the result available for other tasks.
+    # Use the --no-yaml configuration to read the data without loading as YAML.
+    #
     # Load is typically used as a gateway task to other tasks.
     #
     #   % tap run -- load FILEPATH --: [task]
     #
     class Load < Tap::Task
       
+      config :yaml, true, &c.switch              # load as yaml (vs string)
+      
       # Loads the input as YAML.  Input may be an IO, StringIO, or a filepath.
       # The loaded object is returned directly.
       def process(input)
-        case input
+        str = case input
         when StringIO, IO
-          YAML.load(input.read)
+          input.read
         else
           log :load, input
-          YAML.load_file(input)
+          File.read(input)
         end
+        
+        yaml ? YAML.load(str) : str
       end
     end 
   end

data/lib/tap/test/tap_test.rb

@@ -73,7 +73,7 @@ module Tap
       
       # The configurations used to initialize self.app
       def app_config
-        method_root.config.to_hash.merge(:quiet => true, :debug => true)
+        {:quiet => true, :debug => true}
       end
       
       # Reconfigures app with the input configurations for the 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tap
 version: !ruby/object:Gem::Version 
-  version: 0.12.1
+  version: 0.12.2
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-18 00:00:00 -07:00
+date: 2009-02-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency