tap 0.9.0 → 0.9.1

data/lib/tap/generator/generators/command/templates/command.erb

@@ -7,7 +7,6 @@
 #
 
 require 'tap'
-require 'tap/script'
 
 app = Tap::App.instance   
 
@@ -19,13 +18,10 @@ opts = [
   ['--help', '-h', GetoptLong::NO_ARGUMENT, "Print this help."],
   ['--debug', nil, GetoptLong::NO_ARGUMENT, "Specifies debug mode."]]
   
-Tap::Script.handle_options(*opts) do |opt, value| 
+Tap::Support::CommandLine.handle_options(*opts) do |opt, value| 
   case opt
   when '--help'
-    puts Tap::Script.usage(__FILE__, "Usage", "Description", "Information", :keep_headers => false)
-    puts
-    puts "Options:"
-    puts Tap::Script.usage_options(opts)
+    puts Tap::Support::CommandLine.command_help(__FILE__, opts)
     exit
     
   when '--debug'

data/lib/tap/generator/generators/root/templates/tap.yml

@@ -75,5 +75,6 @@
 # Specify code to execute before and after Tap executes
 #before: |
 #  puts "beginning..."
+#  Tap::Env.instance.discover_gems
 #after: |
 #  puts "done!"

data/lib/tap/support/batchable.rb

@@ -1,35 +1,12 @@
 module Tap
   module Support
-    
+
     # Batchable encapsulates the methods used to support batching
     # of tasks. See the 'Batches' section in the Tap::Task 
     # documentation for more details on how Batchable works in 
     # practice.
     module Batchable
-      
-      # Merges the batches for the specified objects.  All objects 
-      # sharing the individual object batches will be affected, even 
-      # if they are not listed explicitly as an input.
-      #
-      #  t1 = Tap::Task.new
-      #  t2 = Tap::Task.new
-      #  t3 = t2.initialize_batch_obj
-      #
-      #  Batchable.batch(t1, t2)
-      #  t3.batch                    # => [t1,t2,t3]
-      #
-      # Returns the new batch.
-      def self.batch(*tasks)
-        merged = []
-        batches = tasks.collect {|task| task.batch }.uniq
-        batches.each do |batch| 
-           merged.concat(batch)
-           batch.clear
-         end
-        merged.uniq!
-        batches.each {|batch| batch.concat(merged) }
-        merged
-      end
+      extend Support::BatchableMethods
       
       # The object batch. (must be initializd by classes that
       # include Batchable)

data/lib/tap/support/batchable_methods.rb

@@ -0,0 +1,34 @@
+module Tap
+  module Support
+    
+    # BatchableMethods encapsulates class methods related to Batchable.
+    module BatchableMethods
+      
+      # Merges the batches for the specified objects.  All objects 
+      # sharing the individual object batches will be affected, even 
+      # if they are not listed explicitly as an input.
+      #
+      #  t1 = Tap::Task.new
+      #  t2 = Tap::Task.new
+      #  t3 = t2.initialize_batch_obj
+      #
+      #  Batchable.batch(t1, t2)
+      #  t3.batch                    # => [t1,t2,t3]
+      #
+      # Returns the new batch.
+      def batch(*batchables)
+        merged = []
+        batches = batchables.collect {|batchable| batchable.batch }.uniq
+        batches.each do |batch| 
+           merged.concat(batch)
+           batch.clear
+         end
+        merged.uniq!
+        batches.each {|batch| batch.concat(merged) }
+        merged
+      end
+      
+    end
+    
+  end
+end

data/lib/tap/support/command_line.rb

@@ -0,0 +1,103 @@
+module Tap
+  module Support
+    
+    # Under Construction
+    module CommandLine
+      module_function
+
+      # Parses the input string as YAML, if the string matches the YAML document 
+      # specifier (ie it begins with "---\s*\n").  Otherwise returns the string.
+      #
+      #   str = {'key' => 'value'}.to_yaml    # => "--- \nkey: value\n"
+      #   Tap::Script.parse_yaml(str)            # => {'key' => 'value'}
+      #   Tap::Script.parse_yaml("str")          # => "str"
+      def parse_yaml(str)
+        str =~ /\A---\s*\n/ ? YAML.load(str) : str
+      end
+
+      def split_argv(argv)
+        current = []
+        current_split = []
+        splits = [current_split]
+
+        argv.each do |arg|
+          if arg =~ /\A-{2}(\+*)\z/
+            current_split << current  unless current.empty?
+            current = []
+            current_split = (splits[$1.length] ||= [])
+          else
+            current << arg
+          end
+        end
+
+        current_split << current unless current.empty?
+        splits.delete_if {|split| split.nil? || split.empty? }
+        splits
+      end
+
+      def next_arg(argv)
+        index = nil
+        argv.each_with_index do |arg, i|
+          if arg !~ /\A-/
+            index = i 
+            break
+          end
+        end
+        index == nil ? nil : argv.delete_at(index)
+      end
+
+      # Handles options using GetoptLong, and passes each option and
+      # value in ARGV to the block. 
+      #
+      #--
+      # expect [long, <short>, type, desc]
+      #++
+      def handle_options(*options)
+        options = options.collect do |opt|
+          opt = opt[0..-2]
+          opt.compact
+        end
+
+        opts = GetoptLong.new(*options)
+        opts.quiet = true
+        opts.each do |opt, value| 
+          yield(opt, value)
+        end
+      end
+      
+      def command_help(program_file, opts)
+        lines = []
+        lines << usage(program_file, "Usage", "Description", :keep_headers => false)
+        unless opts.empty?
+          lines.concat ["Options:", usage_options(opts)]
+        end
+        lines.join("\n")
+      end
+
+      def usage(program_file, *sections)
+        options = sections.last.kind_of?(Hash) ? sections.pop : {}
+        options = {:keep_headers => true}.merge(options)
+        comment = Tap::Support::TDoc.usage(program_file, sections, options[:keep_headers])
+        comment.rstrip + "\n"
+      end
+
+      def usage_options(opts)
+        opt_lines = []
+        opts.each do |long, short, mode, desc|
+
+          if desc.kind_of?(Class) && desc.include?(Tap::Support::Configurable)
+            key = desc.configurations.opt_map(long)
+            default = PP.singleline_pp(desc.configurations.default[key], "")
+            config_attr = desc.tdoc.find_configuration_named(key.to_s)
+            desc = config_attr.desc
+          end
+
+          short = short == nil ? "    " : "(#{short})"
+          opt_lines << "  %-25s %s      %s" % [long, short, desc]
+        end
+        opt_lines.join("\n")
+      end
+      
+    end
+  end
+end

data/lib/tap/support/command_line_methods.rb

@@ -0,0 +1,76 @@
+module Tap
+  module Support
+    autoload(:TDoc, 'tap/support/tdoc')
+    autoload(:CommandLine, 'tap/support/command_line')
+    
+    # Under Construction
+    module CommandLineMethods
+      
+      # Returns the TDoc documentation for self. 
+      def tdoc
+        @tdoc ||= Tap::Support::TDoc[self]
+      end
+
+      # EXPERIMENTAL
+      def help(opts=configurations.to_opts) 
+        return "could not find help for '#{self}'" if tdoc == nil
+
+        sections = tdoc.comment_sections(/Description|Usage/i, true)
+        %Q{#{self}
+#{sections["Description"]}
+Usage:
+#{sections["Usage"]}
+Options:
+#{Tap::Support::CommandLine.usage_options(opts)}
+
+}
+      end
+
+      # EXPERIMENTAL
+      def argv_enq(app=App.instance, &block) 
+        if block_given?
+          @argv_enq_block = block
+          return
+        end
+        return @argv_enq_block.call(app) if @argv_enq_block ||= nil
+
+        config = {}
+        opts = configurations.to_opts
+        opts << ['--help', nil, GetoptLong::NO_ARGUMENT, "Print this help."]
+        opts << ['--debug', nil, GetoptLong::NO_ARGUMENT, "Trace execution and debug"]
+        opts << ['--use', nil, GetoptLong::REQUIRED_ARGUMENT, "Loads inputs from file."]
+        opts << ['--iterate', nil, GetoptLong::NO_ARGUMENT, "Iterates over inputs."]
+
+        iterate = false
+        Tap::Support::CommandLine.handle_options(*opts) do |opt, value|
+          case opt
+          when '--help'
+            puts help(opts)
+            exit
+
+          when '--debug'
+            app.options.debug = true
+
+          when '--use'
+            hash = YAML.load_file(value)
+            hash.values.each do |args| 
+              ARGV.concat(args)
+            end
+
+          when '--iterate'
+            iterate = true
+
+          else
+            key = configurations.opt_map(opt)
+            config[key] = YAML.load(value)
+          end
+        end
+
+        # instantiate and configure task
+        task = new(ARGV.shift, config, app)
+        iterate ? ARGV.each {|input| task.enq(input) } : task.enq(*ARGV)
+      end
+    end
+    
+  end
+end

data/lib/tap/support/configurable.rb

@@ -22,6 +22,7 @@ module Tap
       include Batchable
     
       def self.included(mod)
+        mod.extend Support::BatchableMethods
         mod.extend Support::ConfigurableMethods
         mod.instance_variable_set(:@configurations, Support::ClassConfiguration.new(mod))
         mod.instance_variable_set(:@source_files, [])

data/lib/tap/support/configurable_methods.rb

@@ -1,7 +1,6 @@
 module Tap
   module Support
-    autoload(:TDoc, 'tap/support/tdoc')
-
+    
     # ConfigurableMethods encapsulates all class methods used to declare
     # configurations in Tasks.  ConfigurableMethods extends classes that
     # include Tap::Support::Configurable.
@@ -188,78 +187,7 @@ module Tap
       def default_name
         @default_name ||= to_s.underscore
       end
-
-      # Alias for Batchable.batch
-      def batch(*batchables)
-        Batchable.batch(*batchables)
-      end
-
-      # Returns the TDoc documentation for self. 
-      def tdoc
-        @tdoc ||= Tap::Support::TDoc[self]
-      end
-      
-      # EXPERIMENTAL
-      def help(opts=configurations.to_opts) # :nodoc:
-        return "could not find help for '#{self}'" if tdoc == nil
-
-        sections = tdoc.comment_sections(/Description|Usage/i, true)
-        %Q{#{self}
-        
-#{sections["Description"]}
-Usage:
-#{sections["Usage"]}
-Options:
-#{Tap::Script.usage_options(opts)}
-
-}
-      end
       
-      # EXPERIMENTAL
-      def argv_enq(app=App.instance, &block) # :nodoc:
-        if block_given?
-          @argv_enq_block = block
-          return
-        end
-        return @argv_enq_block.call(app) if @argv_enq_block ||= nil
-
-        config = {}
-        opts = configurations.to_opts
-        opts << ['--help', nil, GetoptLong::NO_ARGUMENT, "Print this help."]
-        opts << ['--debug', nil, GetoptLong::NO_ARGUMENT, "Trace execution and debug"]
-        opts << ['--use', nil, GetoptLong::REQUIRED_ARGUMENT, "Loads inputs from file."]
-        opts << ['--iterate', nil, GetoptLong::NO_ARGUMENT, "Iterates over inputs."]
-        
-        iterate = false
-        Tap::Script.handle_options(*opts) do |opt, value|
-          case opt
-          when '--help'
-            puts help(opts)
-            exit
-            
-          when '--debug'
-            app.options.debug = true
-            
-          when '--use'
-            hash = YAML.load_file(value)
-            hash.values.each do |args| 
-              ARGV.concat(args)
-            end
-          
-          when '--iterate'
-            iterate = true
-            
-          else
-            key = configurations.opt_map(opt)
-            config[key] = YAML.load(value)
-          end
-        end
-
-        # configure task
-        task = app.task(ARGV.shift, config)
-        iterate ? ARGV.each {|input| task.enq(input) } : task.enq(*ARGV)
-      end
-
       protected
 
       attr_writer :config_mode