tap 0.10.1 → 0.11.0

data/lib/tap/test/utils.rb

@@ -0,0 +1,231 @@
+require 'tap/root'
+require 'fileutils'
+require 'tempfile'
+
+module Tap
+  module Support
+    autoload(:Templater, 'tap/support/templater')
+  end
+  
+  module Test
+    module Utils
+      module_function
+      
+      # Generates an array of [source, reference] pairs mapping source
+      # files to reference files under the source and reference dirs,
+      # respectively.  Only files under source dir matching the pattern
+      # will be mapped.  Mappings are either (in this order):
+      #
+      # - the path under reference_dir contained in the source file
+      # - a direct translation of the source file from the source to
+      #   the reference dir, minus the extname
+      #
+      # Notes:
+      # - Source files may contain comments but should otherwise
+      #   consist only of indentation (which is stripped) and
+      #   the reference path.
+      # - If a mapped path cannot be found, dereference raises  
+      #   a DereferenceError.
+      #
+      # === example
+      #
+      #   root
+      #   |- input
+      #   |   |- dir.ref
+      #   |   |- ignored.txt
+      #   |   |- one.txt.ref
+      #   |   `- two.txt.ref
+      #   `- ref
+      #       |- dir
+      #       |- one.txt
+      #       `- path
+      #           `- to
+      #               `- two.txt
+      #
+      # The 'two.txt.ref' file contains a reference path:
+      #
+      #  File.read('/root/input/two.txt.ref')    # => 'path/to/two.txt'
+      #
+      # Now:
+      #
+      #  reference_map('/root/input', '/root/ref')
+      #  # => [
+      #  # ['/root/input/dir.ref',     '/root/ref/dir'],
+      #  # ['/root/input/one.txt.ref', '/root/ref/one.txt'],
+      #  # ['/root/input/two.txt.ref', '/root/ref/path/to/two.txt']]
+      #
+      # And since no path matches 'ignored.txt':
+      #
+      #  reference_map('/root/input', '/root/ref', '**/*.txt')     
+      #  # !> DereferenceError
+      #
+      def reference_map(source_dir, reference_dir, pattern='**/*.ref')
+        Dir.glob(File.join(source_dir, pattern)).sort.collect do |source|
+          # use the path specified in the source file
+          relative_path = File.read(source).gsub(/#.*$/, "").strip
+          
+          # use the relative filepath of the source file to the
+          # source dir (minus the extname) if no path is specified
+          if relative_path.empty?
+            relative_path = Tap::Root.relative_filepath(source_dir, source).chomp(File.extname(source))
+          end
+          
+          reference = File.join(reference_dir, relative_path)
+          
+          # raise an error if no reference file is found
+          unless File.exists?(reference)
+            raise DereferenceError, "no reference found for: #{source}"
+          end
+
+          [source, reference]
+        end
+      end
+      
+      # Dereferences source files with reference files for the duration
+      # of the block.  The mappings of source to reference files are
+      # determined using reference_map; dereferenced files are at the
+      # same location as the source files, but with the '.ref' extname
+      # removed.
+      #
+      # Notes:
+      # - The reference extname is implicitly specified in pattern;
+      #   the final extname of the source file is removed during
+      #   dereferencing regardless of what it is.
+      #
+      def dereference(source_dirs, reference_dir, pattern='**/*.ref', tempdir=Dir::tmpdir)
+        mapped_paths = []
+        begin
+          [*source_dirs].each do |source_dir|
+            reference_map(source_dir, reference_dir, pattern).each do |source, reference|
+              
+              # move the source file to a temporary location
+              tempfile = Tempfile.new(File.basename(source), tempdir)
+              tempfile.close
+              FileUtils.mv(source, tempfile.path)
+              
+              # copy the reference to the target
+              target = source.chomp(File.extname(source))
+              FileUtils.cp_r(reference, target)
+              
+              mapped_paths << [target, source, tempfile]
+            end
+          end unless reference_dir == nil
+          
+          yield
+          
+        ensure
+          mapped_paths.each do |target, source, tempfile|
+            # remove the target and restore the original source file
+            FileUtils.rm_r(target) if File.exists?(target)
+            FileUtils.mv(tempfile.path, source)
+          end
+        end
+      end
+      
+      # Uses a Tap::Support::Templater to template and replace the contents of path, 
+      # for the duration of the block.  The attributes will be available in the
+      # template context.
+      def template(paths, attributes={}, tempdir=Dir::tmpdir)
+        mapped_paths = []
+        begin
+          [*paths].each do |path|
+            # move the source file to a temporary location
+            tempfile = Tempfile.new(File.basename(path), tempdir)
+            tempfile.close
+            FileUtils.cp(path, tempfile.path)
+              
+            # template the source file
+            content = File.read(path)
+            File.open(path, "wb") do |file|
+              file << Support::Templater.new(content, attributes).build
+            end
+            
+            mapped_paths << [path, tempfile]
+          end
+
+          yield
+          
+        ensure
+          mapped_paths.each do |path, tempfile|
+            # restore the original source file
+            FileUtils.rm(path) if File.exists?(path)
+            FileUtils.mv(tempfile.path, path)
+          end
+        end
+      end
+      
+      # Yields to the input block for each pair of entries in the input 
+      # arrays.  An error is raised if the input arrays do not have equal 
+      # numbers of entries.
+      def each_pair(a, b, &block) # :yields: entry_a, entry_b,
+        each_pair_with_index(a,b) do |entry_a, entry_b, index|
+          yield(entry_a, entry_b)
+        end
+      end
+
+      # Same as each_pair but yields the index of the entries as well.
+      def each_pair_with_index(a, b, error_msg=nil, &block) # :yields: entry_a, entry_b, index
+        a = [a] unless a.kind_of?(Array)
+        b = [b] unless b.kind_of?(Array)
+        
+        unless a.length == b.length
+          raise ArgumentError, (error_msg || "The input arrays must have an equal number of entries.")
+        end
+        
+        0.upto(a.length-1) do |index|
+          yield(a[index], b[index], index)
+        end
+      end
+      
+      # Attempts to recursively remove the specified method directory and all 
+      # files within it.  Raises an error if the removal does not succeed.
+      def clear_dir(dir)
+        # clear out the folder if it exists
+        FileUtils.rm_r(dir) if File.exists?(dir)
+      end
+      
+      # Attempts to remove the specified directory.  The root 
+      # will not be removed if the directory does not exist, or
+      # is not empty.  
+      def try_remove_dir(dir)
+        # Remove the directory if possible
+        begin
+          FileUtils.rmdir(dir) if File.exists?(dir) && Dir.glob(File.join(dir, "*")).empty?
+        rescue
+          # rescue cases where there is a hidden file, for example .svn
+        end
+      end
+      
+      # Sets ARGV to the input argv for the duration of the block.
+      def with_argv(argv=[])
+        current_argv = ARGV.dup
+        begin
+          ARGV.clear
+          ARGV.concat(argv)
+          
+          yield
+          
+        ensure
+          ARGV.clear
+          ARGV.concat(current_argv)
+        end
+      end
+      
+      def whitespace_escape(str)
+        str.to_s.gsub(/\s/) do |match|
+          case match
+          when "\n" then "\\n\n"
+          when "\t" then "\\t"
+          when "\r" then "\\r"
+          when "\f" then "\\f"
+          else match
+          end
+        end
+      end
+      
+      # Raised when no reference can be found for a reference path.
+      class DereferenceError < StandardError
+      end
+    end
+  end
+end

data/lib/tap/test.rb

@@ -1,37 +1,64 @@
-require 'tap/test/tap_methods'
+require 'test/unit'
+$:.unshift File.expand_path("#{File.dirname(__FILE__)}/..")
+require 'tap/test/extensions'
 
 module Test # :nodoc:
   module Unit # :nodoc:
     
-    # Methods extending TestCase.  
-    #
-    # === Method Availability
-    # Note that these methods are added piecemeal by Tap::Test::SubsetMethods, 
-    # Tap::Test::FileMethods and Tap::Test::TapMethods, but that fact doesn't 
-    # come through in the documentation.  Hence, not all of them will be available 
-    # if you're only using SubsetMethods or FileMethods.  Breaks down like this:
-    #
-    #   Using:           Methods Available:
-    #   TapMethods       all
-    #   FileMethods      all, except acts_as_tap_test
-    #   SubsetMethods    all, except acts_as_tap_test, acts_as_file_test, file_test_root
-    #
+    # Methods extending TestCase. For more information see:
+    # - Tap::Test::SubsetTest
+    # - Tap::Test::FileTest
+    # - Tap::Test::TapTest
+    #   
     #--
     #See the TestTutorial for more information.
     class TestCase
-    end
-  end
-end
-
-module Tap
-  
-  # Modules facilitating testing.  TapMethods are specific to
-  # Tap, but SubsetMethods and FileMethods are more general in 
-  # their utility.
-  module Test
-  end
-end
+      extend Tap::Test::Extensions
+      
+      class << self
+        alias tap_original_test_case_inherited inherited
+        
+        def inherited(child)
+          super
+          tap_original_test_case_inherited(child)
+          child.instance_variable_set(:@skip_messages, [])
+          child.instance_variable_set(:@run_test_suite, true)
+        end
+        
+        # Indicates when the test suite should be run or skipped.
+        attr_accessor :run_test_suite
+        
+        # An array of messages printed when a test is skipped
+        # by setting run_test_suite to false.
+        attr_reader :skip_messages
 
+        # Causes a test suite to be skipped.  If a message is given, it will
+        # print and notify the user the test suite has been skipped.
+        def skip_test(msg=nil)
+          self.run_test_suite = false
 
+          # experimental -- perhaps use this so that a test can be skipped
+          # for multiple reasons?
+          skip_messages << msg
+        end
 
+        alias :original_suite :suite
 
+        # Modifies the default suite method to skip the suit unless
+        # run_test_suite is true.  If the test is skipped, the skip_messages 
+        # will be printed along with the default 'Skipping <Test>' message.
+        def suite # :nodoc:
+          if run_test_suite
+            original_suite
+          else
+            skip_message = skip_messages.compact.join(', ')
+            puts "Skipping #{name}#{skip_message.empty? ? '' : ': ' + skip_message}"
+            
+            # return an empty test suite of the appropriate name
+            Test::Unit::TestSuite.new(name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tap.rb

@@ -1,27 +1,10 @@
-require 'yaml'                   # expensive to load
-require 'thread'
-
-# Apply version-specific patches
-case RUBY_VERSION
-when /^1.9/
-  $: << File.expand_path(File.dirname(__FILE__) + "/tap/patches/ruby19")
-end
+autoload(:YAML, 'yaml')                   # expensive to load
 
 $:.unshift File.expand_path(File.dirname(__FILE__))
 
 require 'tap/constants'
 
 # require in order...
-require 'tap/env'
-require 'tap/app'
+require 'tap/exe'
 require 'tap/task'
-require 'tap/file_task'
-require 'tap/workflow'
-
-require 'tap/support/declarations'
-Tap.extend Tap::Support::Declarations
-
-# Apply platform-specific patches
-# case RUBY_PLATFORM
-# when 'java' 
-# end
+require 'tap/file_task'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tap
 version: !ruby/object:Gem::Version 
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-21 00:00:00 -06:00
+date: 2008-10-20 00:00:00 -06:00
 default_executable: tap
 dependencies: []
 
@@ -17,19 +17,19 @@ description:
 email: simon.a.chiang@gmail.com
 executables: 
 - tap
+- rap
 extensions: []
 
 extra_rdoc_files: 
 - README
 - MIT-LICENSE
 - History
-- doc/Tutorial
 - doc/Class Reference
 - doc/Command Reference
+- doc/Syntax Reference
+- doc/Tutorial
 files: 
-- README
-- MIT-LICENSE
-- History
+- cgi/run.rb
 - cmd/console.rb
 - cmd/destroy.rb
 - cmd/generate.rb
@@ -38,9 +38,11 @@ files:
 - doc/Tutorial
 - doc/Class Reference
 - doc/Command Reference
+- bin/rap
 - bin/tap
 - lib/tap/app.rb
 - lib/tap/constants.rb
+- lib/tap/declarations.rb
 - lib/tap/env.rb
 - lib/tap/exe.rb
 - lib/tap/file_task.rb
@@ -57,67 +59,88 @@ files:
 - lib/tap/generator/generators/file_task/templates/result.yml
 - lib/tap/generator/generators/file_task/templates/task.erb
 - lib/tap/generator/generators/file_task/templates/test.erb
+- lib/tap/generator/generators/generator/generator_generator.rb
+- lib/tap/generator/generators/generator/templates/task.erb
 - lib/tap/generator/generators/root/root_generator.rb
+- lib/tap/generator/generators/root/templates/README
 - lib/tap/generator/generators/root/templates/Rakefile
 - lib/tap/generator/generators/root/templates/tapfile
 - lib/tap/generator/generators/root/templates/gemspec
 - lib/tap/generator/generators/root/templates/test/tap_test_helper.rb
 - lib/tap/generator/generators/root/templates/test/tap_test_suite.rb
-- lib/tap/generator/generators/root/templates/test/tapfile_test.rb
 - lib/tap/generator/generators/task/task_generator.rb
 - lib/tap/generator/generators/task/templates/task.erb
 - lib/tap/generator/generators/task/templates/test.erb
 - lib/tap/generator/manifest.rb
-- lib/tap/patches/rake/rake_test_loader.rb
-- lib/tap/patches/rake/testtask.rb
-- lib/tap/patches/ruby19/backtrace_filter.rb
-- lib/tap/patches/ruby19/parsedate.rb
+- lib/tap/patches/optparse/summarize.rb
 - lib/tap/root.rb
 - lib/tap/support/aggregator.rb
 - lib/tap/support/assignments.rb
 - lib/tap/support/audit.rb
-- lib/tap/support/batchable.rb
-- lib/tap/support/batchable_class.rb
 - lib/tap/support/class_configuration.rb
-- lib/tap/support/command_line.rb
-- lib/tap/support/comment.rb
+- lib/tap/support/combinator.rb
 - lib/tap/support/configurable.rb
 - lib/tap/support/configurable_class.rb
 - lib/tap/support/configuration.rb
 - lib/tap/support/constant.rb
-- lib/tap/support/constant_utils.rb
-- lib/tap/support/declarations.rb
+- lib/tap/support/constant_manifest.rb
+- lib/tap/support/dependencies.rb
+- lib/tap/support/dependency.rb
 - lib/tap/support/executable.rb
 - lib/tap/support/executable_queue.rb
-- lib/tap/support/framework.rb
-- lib/tap/support/framework_class.rb
 - lib/tap/support/gems/rake.rb
 - lib/tap/support/gems.rb
 - lib/tap/support/instance_configuration.rb
+- lib/tap/support/intern.rb
+- lib/tap/support/join.rb
+- lib/tap/support/joins.rb
+- lib/tap/support/joins/fork.rb
+- lib/tap/support/joins/merge.rb
+- lib/tap/support/joins/sequence.rb
+- lib/tap/support/joins/switch.rb
+- lib/tap/support/joins/sync_merge.rb
 - lib/tap/support/lazy_attributes.rb
 - lib/tap/support/lazydoc.rb
+- lib/tap/support/lazydoc/comment.rb
+- lib/tap/support/lazydoc/config.rb
+- lib/tap/support/lazydoc/definition.rb
+- lib/tap/support/lazydoc/document.rb
+- lib/tap/support/lazydoc/method.rb
 - lib/tap/support/manifest.rb
-- lib/tap/support/run_error.rb
+- lib/tap/support/minimap.rb
+- lib/tap/support/node.rb
+- lib/tap/support/parser.rb
+- lib/tap/support/schema.rb
 - lib/tap/support/shell_utils.rb
+- lib/tap/support/string_ext.rb
 - lib/tap/support/tdoc.rb
 - lib/tap/support/tdoc/tdoc_html_generator.rb
 - lib/tap/support/tdoc/tdoc_html_template.rb
-- lib/tap/support/summary.rb
 - lib/tap/support/templater.rb
 - lib/tap/support/validation.rb
 - lib/tap/support/versions.rb
 - lib/tap/task.rb
 - lib/tap/tasks/dump.rb
+- lib/tap/tasks/load.rb
 - lib/tap/tasks/rake.rb
+- lib/tap/test/assertions.rb
 - lib/tap/test/env_vars.rb
-- lib/tap/test/file_methods.rb
-- lib/tap/test/script_methods.rb
-- lib/tap/test/script_methods/script_test.rb
-- lib/tap/test/subset_methods.rb
-- lib/tap/test/tap_methods.rb
+- lib/tap/test/extensions.rb
+- lib/tap/test/file_test.rb
+- lib/tap/test/file_test_class.rb
+- lib/tap/test/script_test.rb
+- lib/tap/test/regexp_escape.rb
+- lib/tap/test/script_tester.rb
+- lib/tap/test/subset_test.rb
+- lib/tap/test/subset_test_class.rb
+- lib/tap/test/tap_test.rb
+- lib/tap/test/utils.rb
 - lib/tap/test.rb
-- lib/tap/workflow.rb
 - lib/tap.rb
+- README
+- MIT-LICENSE
+- History
+- doc/Syntax Reference
 has_rdoc: true
 homepage: http://tap.rubyforge.org
 post_install_message: 

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

@@ -1,15 +0,0 @@
-require File.dirname(__FILE__) + '/tap_test_helper.rb'
-require File.dirname(__FILE__) + '/../tapfile.rb'
-
-class TapfileTest < Test::Unit::TestCase
-  acts_as_tap_test
-  
-  def test_goodnight
-    task = Goodnight.new :message => "goodnight"
-    
-    # a simple test
-    assert_equal({:message  => 'goodnight'}, task.config)
-    assert_equal "goodnight moon", task.process("moon")
-  end
-  
-end

data/lib/tap/patches/rake/rake_test_loader.rb

@@ -1,8 +0,0 @@
-# this is the same code as in rake/rake_test_loader.rb
-# except it duplicates ARGV before iterating over it.
-#
-# This prevents an error in Ruby 1.9 when one of the 
-# loaded files attempts to modify ARGV.  In that case
-# you get an error like: 'can't modify array during 
-# iteration (RuntimeError)'
-ARGV.dup.each { |f| load f unless f =~ /^-/  }

data/lib/tap/patches/rake/testtask.rb

@@ -1,57 +0,0 @@
-# NO idea why this prevents an error with @ruby_opts=nil,
-# or even how @ruby_opts could be nil, on ruby 1.9 with
-# rake test and tdoc.  It does, though.
-require 'pp'
-
-module Rake # :nodoc:
-
-  class TestTask < TaskLib # :nodoc:
-    
-    # Patch for TestTask#define in 'rake\testtask.rb'
-    #
-    # This patch lets you specify Windows-style paths in lib 
-    # (ie with spaces and slashes) and to do something like:
-    #
-    #   Rake::TestTask.new(:test) do |t|
-    #     t.libs = $:  << 'lib'
-    #   end
-    #
-    # Using this patch you can specify additional load paths 
-    # for the test from the command line using --lib-dir
-    #
-    def define
-      lib_opt = @libs.collect {|f| "-I\"#{File.expand_path(f)}\""}.join(' ')
-      desc "Run tests" + (@name==:test ? "" : " for #{@name}")
-      task @name do
-        run_code = ''
-        RakeFileUtils.verbose(@verbose) do
-          run_code =
-            case @loader
-            when :direct
-              "-e 'ARGV.each{|f| load f}'"
-            when :testrb
-              "-S testrb #{fix}"
-            when :rake
-              rake_loader
-            end
-          @ruby_opts.unshift(lib_opt)
-          @ruby_opts.unshift( "-w" ) if @warning
-          ruby @ruby_opts.join(" ") +
-            " \"#{run_code}\" " +
-            file_list.collect { |fn| "\"#{fn}\"" }.join(' ') +
-            " #{option_list}"
-        end
-      end
-      self
-    end
-    
-    # Loads in the patched rake_test_loader to avoid the ARGV 
-    # modification error, which arises within TDoc.
-    #--
-    # May be out of date...
-    def rake_loader # :nodoc:
-      File.expand_path(File.join(File.dirname(__FILE__), 'rake_test_loader.rb'))
-    end
-  end
-  
-end

data/lib/tap/patches/ruby19/backtrace_filter.rb

@@ -1,51 +0,0 @@
-module Test
-  module Unit
-    module Util # :nodoc:
-      module BacktraceFilter # :nodoc:
-        
-        if method_defined?(:filter_backtrace)
-          alias :tap_original_filter_backtrace :filter_backtrace
-        end
-        
-        # This is a slightly-modified version of the default BacktraceFilter
-        # provided in the Ruby 1.9 distribution.  It solves the issue documented
-        # below, and hopefully will not be necessary when Ruby 1.9 is stable.
-        #
-        def filter_backtrace(backtrace, prefix=nil)
-          return ["No backtrace"] unless(backtrace)
-          split_p = if(prefix)
-            prefix.split(TESTUNIT_FILE_SEPARATORS)
-          else
-            TESTUNIT_PREFIX
-          end
-          match = proc do |e|
-            split_e = e.split(TESTUNIT_FILE_SEPARATORS)[0, split_p.size]
-            next false unless(split_e[0..-2] == split_p[0..-2])
-            split_e[-1].sub(TESTUNIT_RB_FILE, '') == split_p[-1]
-          end
-          
-          # The Ruby 1.9 issue is that sometimes backtrace is a String
-          # and String is no longer Enumerable (hence it doesn't respond
-          # respond to detect).  Arrayify to solve.
-          backtrace = [backtrace] unless backtrace.kind_of?(Array)
-          
-          return backtrace unless(backtrace.detect(&match))
-          found_prefix = false
-          new_backtrace = backtrace.reverse.reject do |e|
-            if(match[e])
-              found_prefix = true
-              true
-            elsif(found_prefix)
-              false
-            else
-              true
-            end
-          end.reverse
-          new_backtrace = (new_backtrace.empty? ? backtrace : new_backtrace)
-          new_backtrace = new_backtrace.reject(&match)
-          new_backtrace.empty? ? backtrace : new_backtrace
-        end
-      end
-    end
-  end
-end

data/lib/tap/patches/ruby19/parsedate.rb

@@ -1,16 +0,0 @@
-require 'date/format'
-
-# Taken directly from the Ruby 1.8.6 standard library.  Ruby 1.9 has apparently
-# eliminated this class, but it is currently (2008-02-08) required by ActiveSupport.
-#
-# Making this file available to ActiveSupport allows testing under Ruby 1.9,
-# but this patch should be unnecessary when ActiveSupport upgrades and becomes
-# compatible with Ruby 1.9
-module ParseDate # :nodoc:
-  def parsedate(str, comp=false)
-    Date._parse(str, comp).
-      values_at(:year, :mon, :mday, :hour, :min, :sec, :zone, :wday)
-  end
-
-  module_function :parsedate
-end