tap 0.10.1 → 0.11.0

data/lib/tap/generator/destroy.rb

@@ -19,19 +19,19 @@ module Tap
           file_task.rmdir(target) unless pretend    
         end
       end
-    
+      
       def file(target, options={})
-        target = File.expand_path(target, target_dir)
-        
-        if File.exists?(target)
-          log_relative :rm, target
-          file_task.added_files << File.expand_path(target)
-          file_task.rm(target) unless pretend
-        else
-          log_relative :missing, target
+        target = File.expand_path(target, target_dir)
+        
+        if File.exists?(target)
+          log_relative :rm, target
+          file_task.added_files << File.expand_path(target)
+          file_task.rm(target) unless pretend
+        else
+          log_relative :missing, target
         end
       end
+      
     end
-    
   end
 end

data/lib/tap/generator/generate.rb

@@ -16,25 +16,36 @@ module Tap
         end
       end
     
-      def file(target, options={})
-        target = File.expand_path(target, target_dir)
-        
-        case
-        when !File.exists?(target)
-          log_relative :create, target
-          # should check for identical...
-        when force_file_collision?(target)
-          log_relative :force, target
-        else
-          log_relative :skip, target
-          return
+      def file(target, options={})
+        source_file = Tempfile.new('generate')
+        yield(source_file) if block_given?
+        source_file.close
+        
+        source = source_file.path
+        target = File.expand_path(target, target_dir)
+        
+        copy_file = case
+        when !File.exists?(target)
+          log_relative :create, target
+          true
+        when FileUtils.cmp(source, target)
+          log_relative :exists, target
+          false
+        when force_file_collision?(target)
+          log_relative :force, target
+          true
+        else
+          log_relative :skip, target
+          false
+        end
+        
+        if copy_file && !pretend
+          file_task.prepare(target) 
+          FileUtils.mv(source, target)
         end
-        
-        unless pretend
-          file_task.prepare(target) 
-          File.open(target, "wb") {|file| yield(file) if block_given? }
-        end
-      end
+      end
+      
+      protected
       
       # Ask the user interactively whether to force collision.
       def force_file_collision?(target)

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

@@ -1,6 +1,6 @@
 module Tap::Generator::Generators
   
-  # :startdoc::generator a new tap command
+  # :startdoc: Tap::Generator::Generators::CommandGenerator::generator a new tap command
   #
   # Generates a new tap command under the cmd directory. The  
   # new command can be run from the command line using:
@@ -18,4 +18,4 @@ module Tap::Generator::Generators
     end
     
   end
-end
+end

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

@@ -16,7 +16,7 @@ OptionParser.new do |opts|
   opts.separator "options:"
 
   opts.on("-h", "--help", "Show this message") do
-    opts.banner = Tap::Support::CommandLine.usage(__FILE__)
+    opts.banner = Tap::Support::Lazydoc.usage(__FILE__)
     puts opts
     exit
   end
@@ -29,4 +29,4 @@ end.parse!(ARGV)
 #
 
 puts "Received: #{ARGV.join(', ')}"
-puts app.info
+puts app.info

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

@@ -1,6 +1,6 @@
 module Tap::Generator::Generators
   
-  # :startdoc::generator a config file for a task
+  # :startdoc: Tap::Generator::Generators::ConfigGenerator::generator a config file for a task
   # 
   # Generates a new config file for a task.  The configurations, defaults, 
   # and documentation is determined from the task source file.
@@ -13,12 +13,12 @@ module Tap::Generator::Generators
     end
 
     def manifest(m, name, config_name=name)
-      const = env.search(:tasks, name) or raise "unknown task: #{name}"
+      const = env.tasks.search(name) or raise "unknown task: #{name}"
       task_class = const.constantize or raise "unknown task: #{name}"
       
       m.directory app['config']
       m.file app.filepath('config', config_name + '.yml') do |file|
-        task_class.configurations.format_str((doc ? :doc : :nodoc), file)
+        task_class.configurations.inspect((doc ? :doc : :nodoc), file)
       end
     end
     

data/lib/tap/generator/generators/config/templates/doc.erb

@@ -3,7 +3,7 @@
 ###############################################################################
 <% configurations.each do |key, config| %>
 
-<% Comment.wrap(config.desc.to_s.split(/\r?\n/), 50, 2).each do |line|  %>
+<% Lazydoc::Comment.wrap(config.desc.to_s, 50, 2).each do |line|  %>
 # <%=  line %>
 <% end %>
 <%= config.default == nil ? '#' : '' %><%= yamlize({key.to_s => config.default}) %>

data/lib/tap/generator/generators/file_task/file_task_generator.rb

@@ -2,7 +2,7 @@ require 'tap/generator/generators/task/task_generator'
 
 module Tap::Generator::Generators
   
-  # :startdoc::generator a file_task and test
+  # :startdoc: Tap::Generator::Generators::FileTaskGenerator::generator a file_task and test
   #
   # Generates a new Tap::FileTask and associated test files.
   class FileTaskGenerator < TaskGenerator

data/lib/tap/generator/generators/file_task/templates/task.erb

@@ -25,7 +25,7 @@ class <%= const.const_name %> < Tap::FileTask
     end
 
     File.open(target, "wb") do |file|
-      file << letter_count.to_yaml
+      file << YAML.dump(letter_count)
     end
 
     target

data/lib/tap/generator/generators/file_task/templates/test.erb

@@ -17,7 +17,7 @@ class <%= const.name %>Test < Test::Unit::TestCase
     t = <%= const.name %>.new 
     assert_files do |input_files|
       input_files.each do |source|
-        target = method_filepath(:output, 'result.yml') 
+        target = method_root.filepath(:output, 'result.yml') 
         t.enq(source, target)
       end
     

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

@@ -0,0 +1,27 @@
+module Tap::Generator::Generators
+  
+  # :startdoc: Tap::Generator::Generators::GeneratorGenerator::generator a generator task and test
+  #
+  # Generates a new generator.
+  class GeneratorGenerator < Tap::Generator::Base
+    
+    def manifest(m, const_name)
+      const = Constant.new(const_name.camelize)
+      dir= File.join('lib', const.path)
+      
+      # make the directory
+      m.directory app.filepath(dir)
+      
+      # make the generator
+      m.template app.filepath(dir, const.basename + '_generator.rb'), "task.erb", :const => const
+      
+      # make the templates directory
+      m.directory app.filepath(dir, 'templates')
+      m.file app.filepath(dir, 'templates', 'template_file.erb') do |file|
+        file.puts "# A sample template file."
+        file.puts "key: <%= key %>"
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+<% redirect do |target| %># <%= const.name %>::generator <replace with manifest summary>
+# <replace with command line description>
+
+# <%= const.const_name %> Documentation
+class <%= const.const_name %> < Tap::Generator::Base
+
+  config :key, 'value'           # a sample config
+  
+  # The generator will receive the inputs on the command line, and
+  # m, a Manifest object that records the actions of this method.
+  def manifest(m, *inputs)
+
+    # make a directory
+    # m.directory path
+
+    # make a file
+    # m.file path do |file|
+    #   file << contents
+    # end
+
+    # template a file in the templates directory using ERB.
+    # The (key, value) pairs will be available in the 
+    # template as local variables.
+    m.template "<%= const.const_name.underscore %>_file.txt", "template_file.erb", :key => 'value'
+
+  end
+end <% module_nest(const.nesting, '  ') { target } end %>

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

@@ -2,26 +2,26 @@ require 'tap/root'
 
 module Tap::Generator::Generators
   
-  # :startdoc::generator a basic tap directory structure
+  # :startdoc: Tap::Generator::Generators::RootGenerator::generator a basic tap directory structure
   #
-  # Generates a tap root directory structure:
+  # Generates a tap root directory structure.  Use the switches to 
+  # generate a Tapfile and/or a tap config file:
   #
   #   root
   #   |- Rakefile
   #   |- lib
   #   |- sample.gemspec
   #   |- tap.yml
-  #   |- tapfile.rb
+  #   |- Tapfile
   #   `- test
   #       |- tap_test_helper.rb
   #       |- tap_test_suite.rb
   #       `- tapfile_test.rb
   #
-  # By default a tapfile will be created, but not a config file.
   class RootGenerator < Tap::Generator::Base
     
-    config :config_file, false, &c.switch   # create a tap.yml file
-    config :tapfile, true, &c.switch        # create a tapfile
+    config :config_file, true, &c.switch   # create a tap.yml file
+    config :tapfile, false, &c.switch      # create a tapfile
     
     # ::args ROOT, PROJECT_NAME=basename(ROOT)
     def manifest(m, root, project_name=nil)
@@ -35,26 +35,26 @@ module Tap::Generator::Generators
         case
         when File.directory?(source)
           m.directory r[target]
+          next
         when target == 'gemspec'
           m.template r[project_name + '.gemspec'], source, :project_name => project_name, :tapfile => tapfile, :config_file => config_file
-        when target =~ /tapfile/
+          next
+        when target =~ /tapfile/i
           next unless tapfile
-          target = (target == 'tapfile' ? r['tapfile.rb'] : r[target])
-          m.template target, source, :project_name => project_name
-        else
-          m.template r[target], source, :project_name => project_name
         end
+        
+        m.template r[target], source, :project_name => project_name
       end
       
       m.file(r['tap.yml']) do |file|
-       Tap::App.configurations.format_str(:doc, file) do |templater|
+       Tap::App.configurations.inspect(:doc, file) do |templater|
          next unless templater.receiver == Tap::Root
           
          templater.configurations.each do |(key, config)| 
            config.default = nil if key.to_s == 'root'
          end
        end
-       Tap::Env.configurations.format_str(:doc, file)
+       Tap::Env.configurations.inspect(:doc, file)
       end if config_file
     end
   end

data/lib/tap/generator/generators/root/templates/Rakefile

@@ -4,7 +4,6 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 
 require 'tap/constants'
-require 'tap/patches/rake/testtask.rb'
 
 #
 # Gem specification
@@ -36,7 +35,7 @@ task :print_manifest do
   # included already (marking by the absence
   # of a label)
   Dir.glob("**/*").each do |file|
-    next if file =~ /^(rdoc|pkg)/ || File.directory?(file)
+    next if file =~ /^(rdoc|pkg|backup)/ || File.directory?(file)
     
     path = File.expand_path(file)
     files[path] = ["", file] unless files.has_key?(path)
@@ -58,6 +57,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = '<%= project_name %>'
+  rdoc.main     = 'README'
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include( spec.extra_rdoc_files )
   rdoc.rdoc_files.include( spec.files.select {|file| file =~ /^lib.*\.rb$/} )

data/lib/tap/generator/generators/root/templates/gemspec

@@ -5,24 +5,23 @@ Gem::Specification.new do |s|
   #s.email = "your.email@pubfactory.edu"
   #s.homepage = "http://rubyforge.org/projects/<%= project_name %>/"
   s.platform = Gem::Platform::RUBY
-  s.summary = "<%= project_name %> task library"
+  s.summary = "<%= project_name %>"
   s.require_path = "lib"
   s.test_file = "test/tap_test_suite.rb"
   #s.rubyforge_project = "<%= project_name %>"
   #s.has_rdoc = true
-  s.add_dependency("tap", "~> <%= Tap::VERSION %>")
+  s.add_dependency("tap", "= <%= Tap::VERSION %>")
   
-  # list extra rdoc files like README here.
+  # list extra rdoc files here.
   s.extra_rdoc_files = %W{
+    README
   }
   
   # list the files you want to include here. you can
   # check this manifest using 'rake :print_manifest'
   s.files = %W{
 <%= config_file ? "    tap.yml\n" : '' %>
-<%= tapfile ? "    tapfile.rb\n" : '' %>
     test/tap_test_helper.rb
     test/tap_test_suite.rb
-    test/tapfile_test.rb
   }
 end

data/lib/tap/generator/generators/root/templates/tapfile

@@ -1,8 +1,11 @@
-require 'tap'
-
-# Goodnight::manifest your basic goodnight moon task
-# Prints the input with a configurable message.
-Tap.task('goodnight', :message => 'goodnight') do |task, name|
-   task.log task.message, name
-   "#{task.message} #{name}"
-end
+require 'tap/declarations'
+
+module <%= project_name.camelize %>
+  extend Tap::Declarations
+  
+  # ::desc your basic goodnight moon task
+  # Says goodnight with a configurable message.
+  task(:goodnight, :obj, :message => 'goodnight') do |task, args|
+    puts "#{task.message} #{args.obj}"
+  end
+end

data/lib/tap/generator/generators/root/templates/test/tap_test_suite.rb

@@ -1,5 +1,5 @@
 $:.unshift File.join(File.dirname(__FILE__), '../lib')
 
-# runs all subsets (see Tap::Test::SubsetMethods)
+# runs all subsets (see Tap::Test::SubsetTest)
 ENV["ALL"] = "true"
 Dir.glob("./**/*_test.rb").each {|test| require test}

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

@@ -1,6 +1,6 @@
 module Tap::Generator::Generators
   
-  # :startdoc::generator a task and test
+  # :startdoc: Tap::Generator::Generators::TaskGenerator::generator a task and test
   #
   # Generates a new Tap::Task and an associated test file.
   class TaskGenerator < Tap::Generator::Base
@@ -19,8 +19,6 @@ module Tap::Generator::Generators
         m.directory File.dirname(test_path)
         m.template test_path, "test.erb", :const => const
       end
-      
-      const
     end
 
   end

data/lib/tap/generator/generators/task/templates/test.erb

@@ -12,9 +12,7 @@ class <%= const.name %>Test < Test::Unit::TestCase
     assert_equal "goodnight moon", task.process("moon")
     
     # a more complex test
-    task.enq("moon")
-    app.run
-    
+    task.execute("moon")
     assert_equal ["goodnight moon"], app.results(task)
     assert_audit_equal ExpAudit[[nil, "moon"], [task, "goodnight moon"]], app._results(task)[0]
   end

data/lib/tap/patches/optparse/summarize.rb

@@ -0,0 +1,62 @@
+#--
+# This patch fixes some formatting errors in OptParse.
+# In particular, long config names and config names of
+# 13 characters in length cause either ugly wrapping,
+# or an outright error.  It could also wrap long comments,
+# although that feature is currently disabled.
+#
+# See:
+# - http://bahuvrihi.lighthouseapp.com/projects/9908/tickets/97-unlucky-13-character-config-name#ticket-97-1
+
+class OptionParser # :nodoc:
+  class Switch # :nodoc:
+    undef_method :summarize
+    
+    def summarize(sdone = [], ldone = [], width = 1, max = width - 1, indent = "")
+      sopts, lopts = [], []
+      @short.each {|s| sdone.fetch(s) {sopts << s}; sdone[s] = true} if @short
+      @long.each {|s| ldone.fetch(s) {lopts << s}; ldone[s] = true} if @long
+      return if sopts.empty? and lopts.empty? # completely hidden
+
+      left = [sopts.join(', ')]
+      right = desc.dup
+
+      while str = lopts.shift
+        l = left[-1].length + str.length
+        l += arg.length if left.size == 1 && arg
+        #l < max or left << ''
+        left[-1] << if left[-1].empty? then ' ' * 4 else ', ' end << str
+      end
+
+      #left[0] << arg if arg
+      left[-1] << arg if arg
+
+      mlen = left.collect {|s| s.length}.max.to_i
+      while mlen > width and l = left.shift
+        mlen = left.collect {|s| s.length}.max.to_i if l.length == mlen
+        yield(indent + l)
+      end
+
+      # uncomment to justify long comments
+      # comment_indent = width + indent.length + 2
+      # split_right = []
+      # right.each do |obj|
+      #   start_index = 0
+      #   str = obj.to_str
+      #   while start_index < str.length
+      #     split_right << str[start_index, comment_indent].strip
+      #     start_index += comment_indent
+      #   end
+      # end
+      # right = split_right
+
+      while begin l = left.shift; r = right.shift; l or r end
+        l = l.to_s.ljust(width) + ' ' + r if r and !r.empty?
+        #yield(indent + l)
+        yield(indent + l) unless l == nil
+      end
+
+      self
+    end
+  end
+end

data/lib/tap/root.rb

@@ -79,6 +79,19 @@ module Tap
         # empty string is returned
         expanded_path[( expanded_dir.chomp("/").length + 1)..-1] || ""
       end
+      
+      # Generates a target filepath translated from the source_dir to 
+      # the target_dir. Raises an error if the filepath is not relative 
+      # to the source_dir.    
+      #
+      #    Root.translate("/path/to/file.txt", "/path", "/another/path")  # => '/another/path/to/file.txt'
+      #
+      def translate(path, source_dir, target_dir)
+        unless relative_path = relative_filepath(source_dir, path)
+          raise ArgumentError, "\n#{path}\nis not relative to:\n#{source_dir}"
+        end
+        File.join(target_dir, relative_path)
+      end
     
       # Lists all unique paths matching the input glob patterns.  
       def glob(*patterns)
@@ -109,25 +122,21 @@ module Tap
         end.flatten.uniq
       end
       
-      # Executes the block in the specified directory.  Makes the directory, if
-      # necessary when mkdir is specified.  Otherwise, indir raises an error 
-      # for non-existant directories, as well as non-directory inputs.
-      def indir(dir, mkdir=false)
+      # Like Dir.chdir but makes the directory, if necessary, when 
+      # mkdir is specified. chdir raises an error for non-existant 
+      # directories, as well as non-directory inputs.
+      def chdir(dir, mkdir=false, &block)
+        dir = File.expand_path(dir)
+        
         unless File.directory?(dir)
           if !File.exists?(dir) && mkdir
             FileUtils.mkdir_p(dir)
           else
-            raise "not a directory: #{dir}"
+            raise ArgumentError, "not a directory: #{dir}"
           end
         end
-
-        pwd = Dir.pwd
-        begin
-          Dir.chdir(dir)
-          yield
-        ensure
-          Dir.chdir(pwd)
-        end
+        
+        Dir.chdir(dir, &block)
       end
       
       # The path root type indicating windows, *nix, or some unknown
@@ -257,7 +266,7 @@ module Tap
           end.compact
         end
       end
-
+      
       # Returns true if the mini_path matches path.  Matching logic
       # reverses that of minimize: 
       # * a match occurs when path ends with mini_path
@@ -286,8 +295,7 @@ module Tap
       #   Tap::Root.minimal_match?('dir/file-0.1.0.txt', 'r/file')        # => true
       #
       def minimal_match?(path, mini_path)
-        extname = File.extname(mini_path)
-        extname = '' if extname =~ /^\.\d+$/
+        extname = non_version_extname(mini_path)
         version = mini_path =~ /(-\d+(\.\d+)*)#{extname}$/ ? $1 : ''
    
         match_path = case
@@ -296,10 +304,10 @@ module Tap
           path
         when !version.empty?
           # match up to version
-          path.chomp(File.extname(path))
+          path.chomp(non_version_extname(path))
         else
           # match up base
-          path.chomp(File.extname(path)).sub(/(-\d+(\.\d+)*)$/, '')
+          path.chomp(non_version_extname(path)).sub(/(-\d+(\.\d+)*)$/, '')
         end
         
         # key ends with pattern AND basenames of each are equal... 
@@ -391,6 +399,13 @@ module Tap
         just_one
       end
       
+      # utility method for minimal_match --  returns a non-version 
+      # extname, or an empty string if the path ends in a version.
+      def non_version_extname(path) # :nodoc:
+        extname = File.extname(path)
+        extname =~ /^\.\d+$/ ? '' : extname
+      end
+      
     end
   
     include Support::Versions
@@ -527,17 +542,14 @@ module Tap
       Root.relative_filepath(self[dir], filepath)
     end
   
-    # Generates a target filepath translated from the aliased input dir to 
-    # the aliased output dir. Raises an error if the filepath is not relative 
-    # to the aliased input dir.
+    # Generates a target filepath translated from the aliased source_dir to 
+    # the aliased target_dir. Raises an error if the filepath is not relative 
+    # to the aliased source_dir.
     # 
     #  fp = r.filepath(:in, 'path/to/file.txt')    # => '/root_dir/in/path/to/file.txt'
     #  r.translate(fp, :in, :out)                  # => '/root_dir/out/path/to/file.txt'
-    def translate(filepath, input_dir, output_dir)
-      unless relative_path = relative_filepath(input_dir, filepath)
-        raise "\n#{filepath}\nis not relative to:\n#{input_dir}"
-      end
-      filepath(output_dir, relative_path)
+    def translate(filepath, source_dir, target_dir)
+      Root.translate(filepath, self[source_dir], self[target_dir])
     end
   
     # Lists all files in the aliased dir matching the input patterns.  Patterns 
@@ -555,9 +567,9 @@ module Tap
       Root.vglob(filepath(dir, filename), *vpatterns)
     end
     
-    # Executes the provided block in the specified directory using Root.indir.
-    def indir(dir, mkdir=false)
-      Root.indir(self[dir], mkdir) { yield }
+    # chdirs to the specified directory using Root.chdir.
+    def chdir(dir, mkdir=false, &block)
+      Root.chdir(self[dir], mkdir, &block)
     end
     
     private

data/lib/tap/support/aggregator.rb

@@ -2,9 +2,22 @@ module Tap
   module Support
   
     # Aggregator allows thread-safe collection of Audits, organized
-    # by Audit#_current_source.    
+    # by Audit#_current_source.
+    #
+    #   a = Audit.new
+    #   a._record(:src, 'a')
+    # 
+    #   b = Audit.new
+    #   b._record(:src, 'b')
+    #
+    #   agg = Aggregator.new
+    #   agg.store(a)
+    #   agg.store(b)
+    #   agg.retrieve(:src)             # => [a, b]
+    #
     class Aggregator < Monitor
-
+      
+      # Creates a new Aggregator.
       def initialize
         super
         clear
@@ -35,7 +48,7 @@ module Tap
         synchronize { hash[source] }
       end
       
-      # Retreives all audits for the input sources, joined into an array.
+      # Retreives all audits for the input sources, joined as an array.
       def retrieve_all(*sources)
         synchronize do
           sources.collect {|src| hash[src] }.flatten.compact