tap-tasks 0.5.0 → 0.7.0

data/History

@@ -1,3 +1,7 @@
+== 0.7.0 / 2010-05-02
+
+Updates for Tap-1.3.0
+
 == 0.5.0 / 2009-12-05
 
 Updates for Tap-0.19.0

data/MIT-LICENSE

@@ -1,6 +1,6 @@
 Copyright (c) 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

@@ -7,9 +7,7 @@ A set of standard Tap tasks.
 == Description
 
 A standard library of utility tasks, for example tasks to dump/load results as
-{YAML}[http://www.yaml.org/]. {Tap-Tasks}[http://tap.rubyforge.org/tap-tasks]
-is a part of the {Tap-Suite}[http://tap.rubyforge.org/tap-suite]. Check out
-these links for documentation, development, and bug tracking.
+{YAML}[http://www.yaml.org/] or CSV.
 
 * Website[http://tap.rubyforge.org] 
 * Github[http://github.com/bahuvrihi/tap/tree/master] 
@@ -19,7 +17,7 @@ these links for documentation, development, and bug tracking.
 
 Usage is the same as for any tasks.
 
-  % tap run -- load/yaml "{key: value}" --: inspect
+  % tap load/yaml "{key: value}" -: inspect
   {"key" => "value"}
 
 == Installation

data/lib/tap/tasks/console.rb

@@ -0,0 +1,43 @@
+require 'tap/task'
+require 'tap/declarations'
+require 'irb'
+
+# http://www.ruby-forum.com/topic/182335
+class IRB::Irb
+  alias initialize_orig initialize
+  def initialize(workspace = nil, *args)
+    default = IRB.conf[:DEFAULT_OBJECT]
+    workspace ||= IRB::WorkSpace.new(default) if default
+    initialize_orig(workspace, *args)
+  end
+end
+
+module Tap
+  module Tasks
+    # :startdoc::task start an irb session
+    #
+    # Console allows interaction with tap via IRB.  Starts an IRB sssion with
+    # the same context as a tapfile (a Tap::Declarations::Context).  Only one
+    # console can be running at time.
+    # 
+    class Console < Tap::Task
+      # Handles a bug in IRB that causes exit to throw :IRB_EXIT
+      # and consequentially make a warning message, even on a
+      # clean exit. This module resets exit to the original
+      # aliased method.
+      module CleanExit # :nodoc:
+        def exit(ret = 0)
+          __exit__(ret)
+        end
+      end
+      
+      def process
+        raise "console already running" if IRB.conf[:DEFAULT_OBJECT]
+        IRB.conf[:DEFAULT_OBJECT] = Declarations::Context.new(app, "console")
+        IRB.start
+        IRB.conf[:DEFAULT_OBJECT] = nil
+        IRB.CurrentContext.extend CleanExit
+      end
+    end 
+  end
+end

data/lib/tap/tasks/dump/csv.rb

@@ -11,18 +11,28 @@ module Tap
       # into a single line of csv, ie multiple dumps build the csv results.
       # Non-array objects are converted to arrays using to_ary.
       #
-      #   % tap run -- load/yaml ["a", "b", "c"] --: dump/csv
+      #   % tap load/yaml '["a", "b", "c"]' -: dump/csv
       #   a,b,c
       #
       class Csv < Dump
         
         config :col_sep, ",", :short => :c, &c.string    # The column separator (",")
-        config :row_sep, "\n", :short => :r, &c.string   # The row separator ("\n")
+        config :row_sep, $/, :short => :r, &c.string     # The row separator ("\n")
         
-        # Dumps the data to io as CSV.  Data is converted to an array using
-        # to_ary.
         def dump(data, io)
-          io << CSV.generate_line(data.to_ary, col_sep) + row_sep
+          io << generate_line(data.to_ary)
+        end
+        
+        private
+        
+        if RUBY_VERSION >= '1.9'
+          def generate_line(data)
+            CSV.generate_line(data, :col_sep => col_sep, :row_sep => row_sep)
+          end
+        else
+          def generate_line(data)
+            CSV.generate_line(data, col_sep) + row_sep
+          end
         end
       end
     end

data/lib/tap/tasks/dump/inspect.rb

@@ -10,15 +10,12 @@ module Tap
       # method can be specified for inspection using the inspect_method
       # config.
       #
-      #   % tap run -- load/yaml "{key: value}" --: inspect
+      #   % tap load/yaml "{key: value}" -: inspect
       #   {"key"=>"value"}
       #
-      #   % tap run -- load string --: inspect -m length
-      #   6
-      #
       class Inspect < Dump
         
-        config :inspect_method, 'inspect', :short => :m    # The inspection method
+        config :inspect_method, 'inspect', :long => :method, :short => :m    # The inspection method
         
         # Dumps the object to io using obj.inspect
         def dump(obj, io)

data/lib/tap/tasks/dump/yaml.rb

@@ -8,7 +8,7 @@ module Tap
       #
       # Dumps workflow results to a file or IO as YAML.
       #
-      #   % tap run -- load/yaml "{key: value}" --: dump/yaml
+      #   % tap load/yaml "{key: value}" -: dump/yaml
       #   --- 
       #   key: value
       #

data/lib/tap/tasks/error.rb

@@ -0,0 +1,16 @@
+require 'tap/task'
+
+module Tap
+  module Tasks
+    # :startdoc::task raises an error
+    #
+    # Error raises a Runtime error when called.  The input specifies the
+    # error message.
+    #
+    class Error < Tap::Task 
+      def process(msg=nil)
+        raise msg
+      end
+    end 
+  end
+end

data/lib/tap/tasks/glob.rb

@@ -7,7 +7,7 @@ module Tap
     # Globs the input patterns for matching patterns.  Matching files are
     # returned as an array.
     #
-    #   % tap run -- glob * --: dump/yaml
+    #   % tap glob * -: dump/yaml
     #
     # A variety of filters are available as configurations.
     #
@@ -20,7 +20,7 @@ module Tap
     #
     # To glob within the task and not the command line, quote the glob.
     #
-    #   % tap run -- glob '*' --: dump/yaml
+    #   % tap glob '*' -: dump/yaml
     #
     class Glob < Tap::Task
       

data/lib/tap/tasks/insert.rb

@@ -0,0 +1,89 @@
+require 'tap/task'
+
+module Tap
+  module Tasks
+    # :startdoc::task insert into an array
+    #
+    # Insert supports a common workflow pattern of inserting variable
+    # arguments into an otherwise static array.
+    #
+    #   % tap load moon -: insert goodnight %0 -: inspect
+    #   ["goodnight", "moon"]
+    #
+    # The percent serves as a placeholder identifying the index of the
+    # argument that will be inserted.  Unlike most tasks, command-line
+    # arguments provided to insert define the insertion template rather than
+    # inputs (ie they cannot be enqued or executed with -- or -!) so typically
+    # inserts are used with joins or signals.
+    #
+    #   % tap insert goodnight %0 -: inspect -/enq 0 moon
+    #   ["goodnight", "moon"]
+    #
+    # Arguments can be used more than once, as indicated.  The default value
+    # will be used if the argument value at the given index is nil.
+    #
+    #   % tap load a -: insert %0 %0 %1 -: inspect
+    #   ["a", "a", nil]
+    #
+    class Insert < Tap::Task 
+      class << self
+        def parse(argv=ARGV, app=Tap::App.current)
+          super(argv, app, &nil)
+        end
+        
+        def parse!(argv=ARGV, app=Tap::App.current)
+          super(argv, app, &nil)
+        end
+        
+        def build(spec={}, app=Tap::App.current)
+          new(spec['template'], spec['config'], app)
+        end
+        
+        def convert_to_spec(parser, args)
+          template = args.dup
+          args.clear
+          
+          {
+            'config' => parser.nested_config,
+            'template'  => template
+          }
+        end
+      end
+      
+      config :placeholder, '%', :short => :p, &c.string  # argument placeholder
+      config :default, nil                               # default insert value
+      
+      attr_reader :template
+      
+      def initialize(template, config={}, app=Tap::App.current)
+        super(config, app)
+        @template = template
+        @map = {}
+        
+        plength = placeholder.length
+        template.each_with_index do |arg, index|
+          if arg.index(placeholder) == 0
+            @map[index] = arg[plength, arg.length - plength].to_i
+          end
+        end
+      end
+      
+      def process(*args)
+        result = template.dup
+        
+        @map.each_pair do |insert_idx, arg_idx|
+          value = args[arg_idx]
+          result[insert_idx] = value.nil? ? default : value
+        end
+        
+        result
+      end
+      
+      def to_spec
+        spec = super
+        spec['template'] = template
+        spec
+      end
+    end 
+  end
+end

data/lib/tap/tasks/load/csv.rb

@@ -10,7 +10,7 @@ module Tap
       # Load CSV data as an array of arrays, selecting the specified rows and
       # columns.
       # 
-      #   % tap run -- load/csv 'a,b,c.d,e,f' --row-sep '.' --: inspect
+      #   % tap load/csv 'a,b,c.d,e,f' --row-sep '.' -: inspect
       #   [["a", "b", "c"], ["d", "e", "f"]]
       # 
       # Note this task is quite inefficient in that it will load all data
@@ -22,12 +22,12 @@ module Tap
         config :columns, nil, :short => :C, &c.range_or_nil   # Specify a range of columns
         config :rows, nil, :short => :R, &c.range_or_nil      # Specify a range of rows
         
-        config :col_sep, nil, :short => :c, &c.string_or_nil  # The column separator (",")
-        config :row_sep, nil, :short => :r, &c.string_or_nil  # The row separator ("\r\n" or "\n")
+        config :col_sep, ',', :short => :c, &c.string_or_nil  # The column separator (",")
+        config :row_sep, $/, :short => :r, &c.string_or_nil   # The row separator ("\r\n" or "\n")
         
         # Loads the io data as CSV, into an array of arrays.
         def load(io)
-          data = CSV.parse(io.read, col_sep, row_sep)
+          data = parse(io.read)
           
           if rows
             data = data[rows]
@@ -42,6 +42,17 @@ module Tap
           data
         end
         
+        private
+        
+        if RUBY_VERSION >= '1.9'
+          def parse(str)
+            CSV.parse(str, :col_sep => col_sep, :row_sep => row_sep)
+          end
+        else
+          def parse(str)
+            CSV.parse(str, col_sep, row_sep)
+          end
+        end
       end 
     end
   end

data/lib/tap/tasks/load/yaml.rb

@@ -8,7 +8,7 @@ module Tap
       #
       # Loads data from the input IO as YAML.
       #
-      #   % tap run -- load/yaml "{key: value}" --: dump/yaml
+      #   % tap load/yaml "{key: value}" --: dump/yaml
       #   --- 
       #   key: value
       #

data/lib/tap/tasks/null.rb

@@ -8,11 +8,10 @@ module Tap
     # to Null go nowhere.  Null does not accept joins and will not execute
     # the default app joins.
     #
-    #   % tap run -- load a --: null
+    #   % tap load/yaml '[1, 2, 3]' -: null
     #
-    class Null < Tap::Task 
+    class Null < Tap::Task
       def process(*args)
-        nil
       end
       
       def joins

data/lib/tap/tasks/sleep.rb

@@ -0,0 +1,17 @@
+require 'tap/task'
+
+module Tap
+  module Tasks
+    # :startdoc::task sleep
+    #
+    # Sleeps for the specified duration.
+    class Sleep < Tap::Task 
+      config :duration, 1, &c.numeric  # sleep duration (ms)
+      
+      def call(input)
+        sleep duration
+        super
+      end
+    end 
+  end
+end

data/lib/tap/tasks/stream/yaml.rb

@@ -18,7 +18,7 @@ module Tap
       #   --- 
       #   key: value
       # 
-      #   % tap run -- stream/yaml --file example.yml --: inspect
+      #   % tap stream/yaml --file example.yml -: inspect
       #   :sym
       #   [1, 2, 3]
       #   {"key"=>"value"}

data/lib/tap/tasks/version.rb

@@ -1,7 +1,7 @@
 module Tap
   module Tasks
     MAJOR = 0
-    MINOR = 5
+    MINOR = 7
     TINY = 0
 
     VERSION="#{MAJOR}.#{MINOR}.#{TINY}"

data/tap-tasks.gemspec

@@ -0,0 +1,50 @@
+$:.unshift File.expand_path('../../tap/lib', __FILE__)
+$:.unshift File.expand_path('../../tap-test/lib', __FILE__)
+$:.unshift File.expand_path('../../tap-tasks/lib', __FILE__)
+
+require 'tap/version'
+require 'tap/test/version'
+require 'tap/tasks/version'
+
+Gem::Specification.new do |s|
+  s.name = 'tap-tasks'
+  s.version = Tap::Tasks::VERSION
+  s.author = 'Simon Chiang'
+  s.email = 'simon.a.chiang@gmail.com'
+  s.homepage = File.join(Tap::WEBSITE, 'tap-tasks')
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A set of standard Tap tasks'
+  s.require_path = 'lib'
+  s.rubyforge_project = 'tap'
+  s.add_dependency('tap', ">= #{Tap::VERSION}")
+  s.add_development_dependency('tap-test', ">= #{Tap::Test::VERSION}")
+  s.has_rdoc = true
+  s.rdoc_options.concat %W{--main README -S -N --title Tap-Tasks}
+  
+  # list extra rdoc files here.
+  s.extra_rdoc_files = %W{
+    History
+    README
+    MIT-LICENSE
+  }
+  
+  # list the files you want to include here. you can
+  # check this manifest using 'rap print_manifest'
+  s.files = %W{
+    lib/tap/tasks/insert.rb
+    lib/tap/tasks/console.rb
+    lib/tap/tasks/dump/csv.rb
+    lib/tap/tasks/dump/inspect.rb
+    lib/tap/tasks/dump/yaml.rb
+    lib/tap/tasks/error.rb
+    lib/tap/tasks/glob.rb
+    lib/tap/tasks/load/csv.rb
+    lib/tap/tasks/load/yaml.rb
+    lib/tap/tasks/null.rb
+    lib/tap/tasks/sleep.rb
+    lib/tap/tasks/stream/yaml.rb
+    lib/tap/tasks/version.rb
+    tap-tasks.gemspec
+    tap.yml
+  }
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: tap-tasks
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,29 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-05 00:00:00 -07:00
+date: 2010-05-02 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: tap
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.19.0
-    version: 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: tap-test
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.0
-    version: 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id002
 description: 
 email: simon.a.chiang@gmail.com
 executables: []
@@ -43,24 +56,26 @@ extra_rdoc_files:
 - README
 - MIT-LICENSE
 files: 
-- lib/tap/joins/gate.rb
-- lib/tap/middlewares/profiler.rb
+- lib/tap/tasks/insert.rb
+- lib/tap/tasks/console.rb
 - lib/tap/tasks/dump/csv.rb
 - lib/tap/tasks/dump/inspect.rb
 - lib/tap/tasks/dump/yaml.rb
-- lib/tap/tasks/load/yaml.rb
+- lib/tap/tasks/error.rb
+- lib/tap/tasks/glob.rb
 - lib/tap/tasks/load/csv.rb
+- lib/tap/tasks/load/yaml.rb
 - lib/tap/tasks/null.rb
-- lib/tap/tasks/glob.rb
-- lib/tap/tasks/stream.rb
+- lib/tap/tasks/sleep.rb
 - lib/tap/tasks/stream/yaml.rb
 - lib/tap/tasks/version.rb
+- tap-tasks.gemspec
 - tap.yml
 - History
 - README
 - MIT-LICENSE
 has_rdoc: true
-homepage: http://tap.rubyforge.org/tap-tasks/
+homepage: http://tap.rubyforge.org/tap-tasks
 licenses: []
 
 post_install_message: 
@@ -77,18 +92,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: tap
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A set of standard Tap tasks

data/lib/tap/joins/gate.rb

@@ -1,87 +0,0 @@
-require 'tap/join'
-
-module Tap
-  module Joins
-    
-    # :startdoc::join collects results before the join
-    #
-    # Similar to a synchronized merge, but collects all results regardless of
-    # where they come from.  Gates enque themselves when called as a join, and
-    # won't let results pass until they get run as a node.
-    # 
-    #   % tap run -- load a -- load b -- inspect --[0,1][2].gate
-    #   ["a", "b"]
-    # 
-    # Gates are useful in conjunction with iteration where a single task may
-    # feed multiple results to a single join; in this case a sync merge doesn't
-    # produce the desired behavior of collecting the results.
-    # 
-    #   % tap run -- load/yaml "[1, 2, 3]" --:i inspect --:.gate inspect
-    #   1
-    #   2
-    #   3
-    #   [1, 2, 3]
-    # 
-    #   % tap run -- load/yaml "[1, 2, 3]" --:i inspect --:.sync inspect
-    #   1
-    #   [1]
-    #   2
-    #   [2]
-    #   3
-    #   [3]
-    # 
-    # When a limit is specified, the gate will collect results up to the limit
-    # and then pass the results.  Any leftover results are still passed at the
-    # end.
-    #
-    #   % tap run -- load/yaml "[1, 2, 3]" --:i inspect -- inspect --. gate 1 2 --limit 2
-    #   1
-    #   2
-    #   [1, 2]
-    #   3
-    #   [3]
-    #
-    class Gate < Join
-      
-      # An array of results collected thusfar.
-      attr_reader :results
-      
-      config :limit, nil, :short => :l, &c.integer_or_nil   # Pass results after limit
-      
-      def initialize(config={}, app=Tap::App.instance)
-        super
-        @results = nil
-      end
-      
-      def call(result)
-        if @results
-          # Results are set, so self is already enqued and collecting
-          # results.  If the input is the collection, then it's time
-          # to dispatch the results and reset.  Otherwise, just
-          # collect the input and wait.
-          
-          if result == @results
-            @results = nil
-            super(result)
-          else
-            @results << result
-            
-            if limit && @results.length >= limit
-              super(@results.dup)
-              @results.clear
-            end
-          end
-          
-        else
-          # No results are set, so this is a first call and self is
-          # not enqued.  Setup the collection.
-          
-          @results = [result]
-          app.enq(self, @results)
-        end
-        
-        self
-      end
-    end
-  end
-end

data/lib/tap/middlewares/profiler.rb

@@ -1,72 +0,0 @@
-require 'tap/middleware'
-
-module Tap
-  module Middlewares
-    
-    # :startdoc::middleware profile the workflow execution time
-    #
-    #
-    class Profiler < Tap::Middleware
-      
-      attr_reader :app_time
-      attr_reader :nodes
-      attr_reader :counts
-      
-      def initialize(stack, config={})
-        super
-        reset
-        at_exit { app.quiet = false; app.log(:profile, "\n" + summary.join("\n")) }
-      end
-      
-      def reset
-        @app_time = 0
-        @last = nil
-        @nodes = Hash.new(0)
-        @counts = Hash.new(0)
-      end
-      
-      def total_time
-        nodes.values.inject(0) {|sum, elapsed| sum + elapsed }
-      end
-      
-      def total_counts
-        counts.values.inject(0) {|sum, n| sum + n }
-      end
-      
-      def call(node, inputs=[])
-        @app_time += Time.now - @last if @last
-        
-        start = Time.now
-        result = super
-        elapsed = Time.now - start
-        
-        nodes[node] += elapsed
-        counts[node] += 1
-        
-        @last = Time.now
-        result
-      end
-      
-      def summary
-        lines = []
-        lines << "App Time: #{app_time}s"
-        lines << "Node Time: #{total_time}s"
-        lines << "Nodes Run: #{total_counts}"
-        lines << "Breakdown:"
-        
-        nodes_by_class = {}
-        nodes.each_key do |node|
-          (nodes_by_class[node.class.to_s] ||= []) << node
-        end
-        
-        nodes_by_class.keys.sort.each do |node_class|
-          nodes_by_class[node_class].each do |node|
-            lines << "- #{node_class}: [#{nodes[node]}, #{counts[node]}]"
-          end
-        end
-        
-        lines
-      end
-    end
-  end
-end

data/lib/tap/tasks/stream.rb

@@ -1,64 +0,0 @@
-require 'tap/tasks/load'
-
-module Tap
-  module Tasks
-    
-    # Stream recurrently loads data from $stdin by requeing self until an
-    # end-of-file is reached.  This behavior is useful for creating tasks
-    # that load a bit of data from an IO, send it into a workflow, and then
-    # repeat.
-    #
-    # The eof cutoff can be modified using complete? method.  Streaming will
-    # stop when complete? returns true.  For instance, this is a prompt task:
-    #
-    #   class Prompt < Tap::Tasks::Stream
-    #     config :exit_seq, "\n"
-    #
-    #     def load(io)
-    #       if io.eof?
-    #         nil
-    #       else
-    #         io.readline
-    #       end
-    #     end
-    #
-    #     def complete?(io, line)
-    #       line == nil || line == exit_seq
-    #     end
-    #   end
-    #
-    class Stream < Load
-      
-      # Loads data from io.  Process will open the input io object, load
-      # a result, then check to see if the loading is complete (using the
-      # complete? method).  Unless loading is complete, process will enque
-      # io to self.  Process will close io when loading is complete, provided
-      # use_close or file is specified.
-      def process(io=$stdin)
-        io = open(io)
-        result = load(io)
-        
-        if complete?(io, result)
-          if use_close || file
-            close(io)
-          end
-        else
-          reque(io)
-        end
-        
-        result
-      end
-      
-      # Returns true by default.  Override in subclasses to allow recurrent 
-      # loading (see process).
-      def complete?(io, last)
-        io.eof?
-      end
-      
-      # Reques self with io to the top of the queue.
-      def reque(io)
-        app.queue.unshift(self, [io])
-      end
-    end
-  end
-end