tap 0.9.0 → 0.9.1

data/History

@@ -29,13 +29,13 @@ Documentation is still patchy, but improving.
 Major update to Tap. Many changes in this release ARE NOT BACKWARD COMPATIBLE.  
 
 * Reworked Task and App such that methods,  are
-  enqued and executed.  Made the Executable module 
+  enqued and executed.  Made the Executable module 
   to allow any Method to be enqued and executed.
 * App now aggregates results for methods that have no 
   on_complete block; enabled access through App#results 
   and App#_results.
 * Removed iteration from tasks
-* Task no longer templates app.config_templates.  Templating code
+* Task no longer templates app.config_templates.  Templating code
   removed from this distribution.
 * Work to improve audit usability and visualization
 * Removed methods forwarding from Audit to Audit#_current,
@@ -46,7 +46,17 @@ Major update to Tap. Many changes in this release ARE NOT BACKWARD COMPATIBLE.
 * Generalized rake support; now supports version 0.8.1
 * Fixes in generators
 * Improvements in running of multithread tasks
-* Removed condition blocks from tasks
+* Removed condition blocks from tasks
 * many other things also...
 
-  
+== 0.9.1 / 2008-04-26 revision 253
+
+Relatively minor update, but with one important refactoring that
+removes the Tap::Script module.  This breaks backward compatibility
+but only should affect people who have made their own commands.
+Simply sub Tap::Support::CommandLine for Tap::Script to fix.
+
+* Added constants methods (ex try_constantize) to String
+* Added gem discovery when no tap.yml file is present
+* Cleanup and refactoring -- removal of Tap::Script
+* Bug fix for JRuby 1.1.1

data/bin/tap

@@ -12,14 +12,12 @@
 
 require File.join( File.dirname(__FILE__), "../lib/tap.rb")
 
-# setup environment
+# setup the environment
 env = Tap::Env.instance
 app = Tap::App.instance
 
 env.logger = app.logger
-if ARGV.delete("-d-")
-  env.debug_setup
-end
+env.debug_setup if ARGV.delete('-d-')
 
 before = nil
 after = nil
@@ -36,19 +34,18 @@ def handle_error(err)
 end
 
 # configure the app to tap.yml if it exists
-default_config_file = File.expand_path( Tap::Env::DEFAULT_CONFIG_FILE )
+default_config_file = Tap::Env::DEFAULT_CONFIG_FILE
 begin
-  env.load_config(default_config_file, app) do |app, config_file, config|
-    unless config_file == default_config_file
-      env.log(:warn, "ignoring configs: #{config_file} (#{config.keys.join(',')})", Logger::WARN) 
-      next
-    end
+  
+  env.load_config(default_config_file, app) do |non_env_configs|
+    before = non_env_configs.delete('before')
+    after = non_env_configs.delete('after')
     
-    before = config.delete('before')
-    after = config.delete('after')
-    
-    app.reconfigure(config)
+    app.reconfigure(non_env_configs)
   end
+  
+  env.discover_gems unless File.exists?(default_config_file)
+
 rescue(Exception)
   # catch errors and exit gracefully
   # (errors usu from gem loading errors)

data/lib/tap.rb

@@ -6,6 +6,9 @@ require 'ostruct'
 require 'thread'
 require 'erb'
 
+autoload(:GetoptLong, 'getoptlong')
+autoload(:PP, "pp")
+
 # Apply version-specific patches
 case RUBY_VERSION
 when /^1.9/
@@ -36,10 +39,17 @@ end
 
 $:.unshift File.dirname(__FILE__)
 
+require 'tap/constants'
+class String # :nodoc:
+  include Tap::Constants
+end
+
 require 'tap/support/aggregator'
 require 'tap/support/audit'
+require 'tap/support/batchable_methods'
 require 'tap/support/batchable'
 require 'tap/support/class_configuration'
+require 'tap/support/command_line_methods'
 require 'tap/support/configurable'
 require 'tap/support/configurable_methods'
 require 'tap/support/executable'
@@ -48,7 +58,6 @@ require 'tap/support/logger'
 require 'tap/support/run_error'
 require 'tap/support/shell_utils'
 require 'tap/support/validation'
-require 'tap/constants'
 require 'tap/env'
 require 'tap/app'
 require 'tap/task'

data/lib/tap/app.rb

@@ -446,7 +446,7 @@ module Tap
           end
 
         else 
-          Object.module_eval const_name
+          const_name.constantize
         end
        
       rescue(NameError)

data/lib/tap/cmd/console.rb

@@ -6,8 +6,6 @@
 # in tap.yml. Access the Tap::App.instance through 'app'
 #
 
-require 'tap/script'
-
 #
 # handle options
 #
@@ -15,12 +13,10 @@ require 'tap/script'
 opts = [
   ['--help', '-h', GetoptLong::NO_ARGUMENT, "Print this help."]]
   
-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", :keep_headers => false)
-    puts
-    puts Tap::Script.usage_options(opts)
+    puts Tap::Support::CommandLine.command_help(__FILE__, opts)
     exit
 
   end

data/lib/tap/cmd/run.rb

@@ -6,7 +6,6 @@
 #   tap run -- task --help         Prints help for task
 #
 
-require 'tap/script'
 env = Tap::Env.instance
 app = Tap::App.instance
 
@@ -20,13 +19,10 @@ opts = [
   ['--force', '-f', GetoptLong::NO_ARGUMENT, "Force execution at checkpoints"],
   ['--quiet', '-q', GetoptLong::NO_ARGUMENT, "Suppress logging"]]
 
-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", :keep_headers => false)
-    puts
-    puts "Options:"
-    puts Tap::Script.usage_options(opts)
+    puts Tap::Support::CommandLine.command_help(__FILE__, opts)
     exit
     
   when '--quiet', '--force', '--debug'
@@ -40,70 +36,69 @@ end
 #
 # handle options for each specified task
 #
-rounds = Tap::Script.split_argv(ARGV).collect do |argv|
-  argv.each do |args|
-    ARGV.clear  
-    ARGV.concat(args)
-   
-    td = Tap::Script.next_arg(ARGV)
-    case td
-    when 'rake', nil  
-      # remove --help as this will print the Rake help
-      ARGV.delete_if do |arg|
-        if arg == "--help"
-          env.log(:warn, "ignoring --help config for rake command") 
-          true
-        else
-          false
-        end
-      end
-      next if ARGV.empty?
-      
-      rake = env.rake_setup
-    
-      # takes the place of rake.top_level
-      if rake.options.show_tasks
-        rake.display_tasks_and_comments
-        exit
-      elsif rake.options.show_prereqs
-        rake.display_prerequisites
-        exit
-      else
-        rake.top_level_tasks.each do |task_name| 
-          app.task(task_name).enq
-        end
-      end
-      
-    else  
-      begin
-        # attempt lookup the task class
-        task_class = app.task_class(td)
-      rescue(Tap::App::LookupError)
-      end
-
-      # unless a Tap::Task was found, treat the
-      # args as a specification for Rake.
-      if task_class == nil || !task_class.include?(Tap::Support::Configurable)
-        args.unshift('rake')
-        redo
-      end
-    
-      # now let the class handle the argv
-      ARGV.collect! {|str| Tap::Script.parse_yaml(str) }
-      ARGV.unshift(td)
-      task_class.argv_enq(app)
-    end
-  end
-
-  app.queue.clear
-end
-ARGV.clear
-
-rounds.delete_if {|round| round.empty? }
-if rounds.empty?
-  puts "no task specified"
-  exit
-end
+rounds = Tap::Support::CommandLine.split_argv(ARGV).collect do |argv|
+  argv.each do |args|
+    ARGV.clear  
+    ARGV.concat(args)
+   
+    td = Tap::Support::CommandLine.next_arg(ARGV)
+    case td
+    when 'rake', nil  
+      # remove --help as this will print the Rake help
+      ARGV.delete_if do |arg|
+        if arg == "--help"
+          env.log(:warn, "ignoring --help config for rake command") 
+          true
+        else
+          false
+        end
+      end
+ 
+      rake = env.rake_setup
+    
+      # takes the place of rake.top_level
+      if rake.options.show_tasks
+        rake.display_tasks_and_comments
+        exit
+      elsif rake.options.show_prereqs
+        rake.display_prerequisites
+        exit
+      else
+        rake.top_level_tasks.each do |task_name| 
+          app.task(task_name).enq
+        end
+      end
+      
+    else  
+      begin
+        # attempt lookup the task class
+        task_class = app.task_class(td)
+      rescue(Tap::App::LookupError)
+      end
+
+      # unless a Tap::Task was found, treat the
+      # args as a specification for Rake.
+      if task_class == nil || !task_class.include?(Tap::Support::Configurable)
+        args.unshift('rake')
+        redo
+      end
+    
+      # now let the class handle the argv
+      ARGV.collect! {|str| Tap::Support::CommandLine.parse_yaml(str) }
+      ARGV.unshift(td)
+      task_class.argv_enq(app)
+    end
+  end
+
+  app.queue.clear
+end
+ARGV.clear
+
+rounds.delete_if {|round| round.empty? }
+if rounds.empty?
+  puts "no task specified"
+  exit
+end
 
 #
 # set signals 
@@ -145,12 +140,12 @@ if signals.include?("INT")
 
   puts "ctl-c interupts execution"
 end
-
-#
-# enque tasks and run!
+
+#
+# enque tasks and run!
 #
 puts "beginning run..."
-rounds.each_with_index do |queue, i|
-  app.queue.concat(queue)
-  app.run
-end
+rounds.each_with_index do |queue, i|
+  app.queue.concat(queue)
+  app.run
+end

data/lib/tap/constants.rb

@@ -1,4 +1,35 @@
 module Tap
-  VERSION="0.9.0" 
+  MAJOR = 0
+  MINOR = 9
+  TINY = 1
+  
+  VERSION="#{MAJOR}.#{MINOR}.#{TINY}" 
   WEBSITE="http://tap.rubyforge.org"
-end
+  
+  # Under Construction
+  module Constants
+    def try_constantize
+      begin
+        constantize  
+      rescue(NameError)
+        yield 
+      end
+    end
+
+    def constants_split
+      camel_cased_word = camelize
+      unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
+        raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
+      end
+
+      constants = $1.split(/::/)
+      current = Object
+      while !constants.empty?
+        break unless current.const_defined?(constants[0])
+        current = current.const_get(constants.shift)
+      end
+
+      [current, constants]
+    end
+  end
+end

data/lib/tap/env.rb

@@ -92,7 +92,6 @@ module Tap
     def initialize
       @config = nil
       @logger = nil
-      # @on_handle_unknown_configs = nil
       reset
     end
     
@@ -177,7 +176,7 @@ module Tap
     # Configuration paths are expanded relative to the parent directory
     # of the loaded file.  Raises an error if non-env configuration are 
     # found (as determined by Tap::Env::Configurtion::ENV_CONFIG_KEYS).
-    def load_config(path, root=Tap::Root.new, &block)
+    def load_config(path, root=Tap::Root.new, &block) # :yields: non_env_configs
       path = File.join(path, DEFAULT_CONFIG_FILE) if File.directory?(path)
       path = File.expand_path(path)
 
@@ -192,17 +191,12 @@ module Tap
       config = read_config(path)
       config['root'] = File.dirname(path) unless config['root']
       
-      configure(config, root) do |configured_root, other_configs|
-        if block_given?
-          yield(configured_root, path, other_configs)
-        else
-          log(:warn, "ignoring configs: #{path} (#{other_configs.keys.join(',')})", Logger::WARN) 
-        end
-      end
-      
+      configure(config, root, &block)
     end
     
-    def configure(config, root=Tap::Root.new, &block)
+    #--
+    # Note: always yields to the block, even if non_env_configs is empty
+    def configure(config, root=Tap::Root.new, &block) # :yields: non_env_configs
       root_configs, env_configs, other_configs = partition_configs(config, ['root', 'directories', 'absolute_paths'], DEFAULT_CONFIG.keys)
       env_configs = join_configs(DEFAULT_CONFIG, env_configs) 
       
@@ -214,20 +208,19 @@ module Tap
       
       # handle unknown configs (handle before setting 
       # env configs in case the configs modify root)
-      unless other_configs.empty?
-        if block_given?
-          yield(root, other_configs)
-        else
-          log(:warn, "ignoring configs: (#{other_configs.keys.join(',')})", Logger::WARN) 
-        end
+      case
+      when block_given?
+        yield(other_configs) 
+      when !other_configs.empty?
+        log(:warn, "ignoring non-env configs: #{other_configs.keys.join(',')}", Logger::DEBUG)
       end
-        
+      
       # load gems and configurations 
       gem_paths = env_configs.delete('gems').collect do |gem_name| 
         full_gem_path(gem_name)
       end
       config_paths = env_configs.delete('config_paths') + gem_paths
-      config_paths.each {|path| load_config(root[path], &block) }
+      config_paths.each {|path| load_config(root[path]) }
       
       # assign env configs
       env_configs.each_pair do |key, value|
@@ -239,7 +232,7 @@ module Tap
         when /_paths$/ 
           assign_paths(root, value, self.config[key])
         else
-          handle_unknown_config(key, value)
+          handle_unknown_env_config(root, key, value)
         end
       end
 
@@ -266,10 +259,36 @@ module Tap
       spec.full_gem_path
     end
     
+    # Loads the config for the specified gem.  A gem version can be 
+    # specified in the name, see full_gem_path.
     def load_gem(gem_name)
       load_config(full_gem_path(gem_name))
     end
     
+    # Returns the path to all DEFAULT_CONFIG_FILEs for installed gems.
+    # If latest==true, then only the config files for the latest gem
+    # specs will be returned (ie for the most current version of a
+    # gem).
+    def gem_config_files(latest=true)
+      if latest
+        Gem.source_index.latest_specs.collect do |spec| 
+          config_file = File.join(spec.full_gem_path, DEFAULT_CONFIG_FILE)
+          File.exists?(config_file) ? config_file : nil
+        end.compact
+      else
+        Gem.path.collect do |dir|
+          Dir.glob( File.join(dir, "gems/*", DEFAULT_CONFIG_FILE) )
+        end.flatten.uniq
+      end
+    end
+    
+    # Loads the config files discovered by gem_config_files(true).
+    def discover_gems
+      gem_config_files.collect do |config_file|
+        load_config(config_file)
+      end
+    end
+    
     # Searches for and returns all .rb files under each of the command_paths
     # as well as the default tap commands.  Commands with conflicting names
     # raise an error; however, user commands are allowed to override the
@@ -309,7 +328,7 @@ module Tap
       end
     end
     
-    def handle_unknown_config(key, value)
+    def handle_unknown_env_config(key, value)
       raise "unknown env config: #{key}"
     end
   end