bahuvrihi-tap 0.10.4 → 0.10.5

data/lib/tap/test/subset_methods_class.rb

@@ -2,6 +2,8 @@ require 'tap/test/env_vars'
 
 module Tap
   module Test
+    
+    # Class methods extending tests which include SubsetMethods.
     module SubsetMethodsClass
       include Tap::Test::EnvVars
       
@@ -14,51 +16,9 @@ module Tap
         subclass.instance_variable_set(:@conditions, subclass_conditions)
         subclass.instance_variable_set(:@run_test_suite, nil)
         subclass.instance_variable_set(:@skip_messages, [])
-        
-    #    subclass_inputs = prompt_inputs.inject({}) do |memo, (key, value)|
-    #      memo.update(key => (value.dup rescue value))
-    #    end
-    #    subclass.instance_variable_set("@prompt_inputs", subclass_inputs)
       end
       
-      # Experimental -- The idea is to provide a way to prompt once for inputs
-      # that get used multiple times in a test.  Perhaps create accessors
-      # automatically?
-      
-    #  def prompt_inputs
-    #    @prompt_inputs ||= {}
-    #  end
-      
-    #  def require_inputs(*keys, &block)
-    #    if run_subset?("PROMPT")
-    #      puts "\n#{name} requires inputs -- Enter values or 'skip'."
-          
-    #      argv = ARGV.dup
-    #      begin
-    #        ARGV.clear
-    #        keys.collect do |key|
-    #          print "#{key}: "
-    #          value = gets.strip
-    #          if value =~ /skip/i
-    #            skip_test "missing inputs"
-    #            break
-    #          end
-    #          prompt_inputs[key] = value
-    #        end
-    #      ensure
-    #        ARGV.clear
-    #        ARGV.concat(argv)
-    #      end
-    #    else
-    #      skip_test "prompt test"
-    #    end
-    #  end 
-      
-      #
-      # conditions
-      #
-
-      # A hash of defined conditions
+      # A hash of [name, [msg, condition_block]] pairs defined by condition.
       def conditions
         @conditions ||= {}
       end
@@ -66,34 +26,37 @@ module Tap
       # Defines a condition block and associated message.  
       # Raises an error if no condition block is given.
       def condition(name, msg=nil, &block)
-        raise "no condition block given" unless block_given?
-        conditions[name.to_sym] = [msg, block]
+        raise ArgumentError, "no condition block given" unless block_given?
+        conditions[name] = [msg, block]
       end
       
-      # Returns true if the all blocks for the named conditions return true.
+      # Returns true if the all blocks for the specified conditions return true.
       #
       #   condition(:is_true) { true }
       #   condition(:is_false) { false }
       #   satisfied?(:is_true)              # => true
       #   satisfied?(:is_true, :is_false)   # => false
       #
-      def satisfied?(*conditions)
-        unsatisfied_conditions(*conditions).empty?
+      def satisfied?(*names)
+        unsatisfied_conditions(*names).empty?
       end
         
       # Returns an array of the unsatified conditions.  Raises 
-      # an error if the named condition has not been defined.
+      # an error if a condition has not been defined.
       #
       #   condition(:is_true) { true }
       #   condition(:is_false) { false }
       #   unsatisfied_conditions(:is_true, :is_false)   # => [:is_false]
       #
-      def unsatisfied_conditions(*conditions)
-        conditions = self.conditions.keys if conditions.empty?
+      def unsatisfied_conditions(*condition_names)
+        condition_names = conditions.keys if condition_names.empty?
         unsatified = []
-        conditions.each do |condition|
-          raise "Unknown condition: #{condition}" unless self.conditions.has_key?(condition)
-          unsatified << condition unless (self.conditions[condition.to_sym].last.call() ? true : false)
+        condition_names.each do |name|
+          unless condition = conditions[name]
+            raise ArgumentError, "Unknown condition: #{name}"
+          end
+          
+          unsatified << name unless condition.last.call
         end
         unsatified
       end

data/lib/tap/test/tap_methods.rb

@@ -162,11 +162,7 @@ module Tap
 
       # The configurations used to initialize self.app
       def app_config
-        { :root => method_root, 
-          :directories => trs.directories,
-          :absolute_paths => trs.absolute_paths,
-          :quiet => true, 
-          :debug => true}
+        method_root.config.to_hash.merge(:quiet => true, :debug => true)
       end
       
       # Reconfigures app with the input configurations for the 

data/lib/tap/test/utils.rb

@@ -1,22 +1,31 @@
 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_dir and reference_dir,
-      # respectively.  Only files under source dir with the reference_extname
-      # will be mapped; mappings are either:
+      # 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):
       #
-      # - a direct translation from source_dir to reference_dir, minus
-      #   the extname
-      # - a path under reference_dir with a matching basename, minus
-      #   the extname, so long as the matched path is unique
+      # - 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
       #
-      # If a mapped path cannot be found, dereference raises an ArgumentError.
+      # 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
       #
@@ -33,51 +42,114 @@ module Tap
       #           `- 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']]
       #
-      #  reference_map(:input, :ref, ".txt")  # !> ArgumentError
+      # And since no path matches 'ignored.txt':
       #
-      def reference_map(source_dir, reference_dir, reference_extname='.ref')
-        Dir.glob(File.join(source_dir, "**/*#{reference_extname}")).collect do |path|
-          relative_path = Tap::Root.relative_filepath(source_dir, path).chomp(reference_extname)
-          reference_path = File.join(reference_dir, relative_path)
-
-          unless File.exists?(reference_path)
-            matching_paths = Dir.glob(File.join(reference_dir, "**/#{File.basename(relative_path)}"))
-
-            reference_path = case matching_paths.length
-            when 0 then raise ArgumentError, "no reference found for: #{path}"
-            when 1 then matching_paths[0]
-            else raise ArgumentError, "multiple references found for: #{path} [#{matching_paths.join(', ')}]"
-            end
+      #  reference_map('/root/input', '/root/ref', '**/*.txt')     
+      #  # !> DereferenceError
+      #
+      def reference_map(source_dir, reference_dir, pattern='**/*.ref')
+        Dir.glob(File.join(source_dir, pattern)).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
 
-          [path, reference_path]
+          [source, reference]
         end
       end
       
-      def dereference(source_dirs, reference_dir, extname='.ref')
+      # 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, extname).each do |path, source|
-              FileUtils.rm_r(path)
-              target = path.chomp(extname)
-              FileUtils.cp_r(source, target)
-              mapped_paths << target
+            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 |path|
-            FileUtils.rm_r(path) if File.exists?(path)
-            FileUtils.touch(path + extname)
+          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
@@ -102,6 +174,13 @@ module Tap
         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.  
@@ -113,6 +192,37 @@ module Tap
           # 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bahuvrihi-tap
 version: !ruby/object:Gem::Version 
-  version: 0.10.4
+  version: 0.10.5
 platform: ruby
 authors: 
 - Simon Chiang
@@ -17,6 +17,7 @@ description:
 email: simon.a.chiang@gmail.com
 executables: 
 - tap
+- rap
 extensions: []
 
 extra_rdoc_files: 
@@ -40,6 +41,7 @@ files:
 - doc/Tutorial
 - doc/Class Reference
 - doc/Command Reference
+- bin/rap
 - bin/tap
 - lib/tap/app.rb
 - lib/tap/constants.rb
@@ -60,6 +62,7 @@ files:
 - lib/tap/generator/generators/file_task/templates/task.erb
 - lib/tap/generator/generators/file_task/templates/test.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
@@ -71,6 +74,7 @@ files:
 - lib/tap/generator/generators/task/templates/test.erb
 - lib/tap/generator/manifest.rb
 - lib/tap/parser.rb
+- lib/tap/patches/optparse/summarize.rb
 - lib/tap/patches/rake/rake_test_loader.rb
 - lib/tap/patches/rake/testtask.rb
 - lib/tap/patches/ruby19/backtrace_filter.rb
@@ -88,8 +92,6 @@ files:
 - lib/tap/support/batchable_class.rb
 - lib/tap/support/class_configuration.rb
 - lib/tap/support/combinator.rb
-- lib/tap/support/command_line.rb
-- lib/tap/support/comment.rb
 - lib/tap/support/configurable.rb
 - lib/tap/support/configurable_class.rb
 - lib/tap/support/configuration.rb
@@ -105,6 +107,11 @@ files:
 - lib/tap/support/instance_configuration.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/declaration.rb
+- lib/tap/support/lazydoc/document.rb
+- lib/tap/support/lazydoc/method.rb
 - lib/tap/support/manifest.rb
 - lib/tap/support/parsers/base.rb
 - lib/tap/support/parsers/server.rb
@@ -118,11 +125,13 @@ files:
 - 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/env_vars.rb
 - lib/tap/test/file_methods.rb
 - lib/tap/test/file_methods_class.rb
 - lib/tap/test/script_methods.rb
+- lib/tap/test/script_methods/regexp_escape.rb
 - lib/tap/test/script_methods/script_test.rb
 - lib/tap/test/subset_methods.rb
 - lib/tap/test/subset_methods_class.rb

data/lib/tap/support/command_line.rb

@@ -1,55 +0,0 @@
-require 'optparse'
-
-module Tap
-  module Support
-    
-    # Under Construction
-    module CommandLine
-      module_function
-
-      def usage(path, cols=80)
-        parse_usage(File.read(path), cols)
-      end
-        
-      def parse_usage(str, cols=80)
-        scanner = StringScanner.new(str)
-        scanner.scan(/^#!.*?$/)
-        Comment.parse(scanner, false).wrap(cols, 2).strip
-      end
-      
-      def configv(config)
-        desc = config.desc
-        desc.extend(OptParseComment) if desc.kind_of?(Comment)
-          
-        [config.short, argtype(config), desc].compact
-      end
-      
-      def argtype(config)
-        case config.arg_type
-        when :optional 
-          "#{config.long} [#{config.arg_name}]"
-        when :switch 
-          config.long(true)
-        when :flag
-          config.long
-        when :list
-          "#{config.long} a,b,c"
-        when :mandatory, nil
-          "#{config.long} #{config.arg_name}"
-        else
-          raise "unknown arg_type: #{config.arg_type}"
-        end
-      end
-      
-      module OptParseComment
-        def empty?
-          to_str.empty?
-        end
-
-        def to_str
-          subject.to_s =~ /#(.*)$/ ? $1.strip : ""
-        end
-      end
-    end
-  end
-end