bahuvrihi-tap 0.10.7 → 0.10.8

data/lib/tap/generator/destroy.rb

@@ -21,18 +21,14 @@ module Tap
       end
       
       def file(target, options={})
-        prepare(target, options)
-      end
-      
-      def prepare(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
       

data/lib/tap/generator/generate.rb

@@ -16,31 +16,36 @@ module Tap
         end
       end
     
-      def file(target, options={})
-        prepare(target, options) do |path|
-          File.open(path, "wb") {|file| yield(file) if block_given? }
-        end
-      end
-      
-      def prepare(target, options={})
+      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)
         
-        case
+        copy_file = case
         when !File.exists?(target)
           log_relative :create, target
-          # should check for identical...
+          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
-          return
+          false
         end
         
-        unless pretend
+        if copy_file && !pretend
           file_task.prepare(target) 
-          yield(target)
-        end
-      end
+          FileUtils.mv(source, target)
+        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
+  # 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:

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
+  # 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/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
+  # 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/generator/generator_generator.rb

@@ -0,0 +1,27 @@
+module Tap::Generator::Generators
+  
+  # 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,17 +2,17 @@ require 'tap/root'
 
 module Tap::Generator::Generators
   
-  # :startdoc::generator a basic tap directory structure
+  # Tap::Generator::Generators::RootGenerator::generator a basic tap directory structure
   #
   # Generates a tap root directory structure.  Use the switches to 
-  # generate a tapfile and/or a tap config file:
+  # 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
@@ -20,8 +20,8 @@ module Tap::Generator::Generators
   #
   class RootGenerator < Tap::Generator::Base
     
-    config :config_file, false, &c.switch   # create a tap.yml file
-    config :tapfile, false, &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)

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.tasc('goodnight', :message => 'goodnight') do |name|
-  log message, name
-  "#{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/task/task_generator.rb

@@ -1,6 +1,6 @@
 module Tap::Generator::Generators
   
-  # :startdoc::generator a task and test
+  # 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/root.rb

@@ -126,11 +126,13 @@ module Tap
       # 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
         
@@ -264,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

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

data/lib/tap/support/assignments.rb

@@ -5,14 +5,12 @@ module Tap
     # which values are assigned to a particular key.  A value may only 
     # be assigned to one key at a time.  
     #
-    # Assignments tracks the order in which keys are declared, and the
+    # Assignments tracks the order of key declaration, and the
     # order in which values are assigned to a key.  This behavior is
-    # used by ClassConfiguration to track the order in which configurations  
-    # are assigned to a class; the order, in turn, is used in the formation
+    # used by ClassConfiguration to track the order of configurations  
+    # in a class; the order, in turn, is used in the formation
     # of config files, command line documentation, etc.
     #
-    # === Example
-    #
     #   a = Assignments.new
     #   a.assign(:one, 'one')
     #   a.assign(:two, 'two')
@@ -35,6 +33,9 @@ module Tap
     class Assignments
       include Enumerable
       
+      # Generates a new Assignments using the parent array of
+      # [key, values] pairs.  Uses parent.array if parent is
+      # an Assignments, or [] if parent is nil.
       def initialize(parent=nil)
         existing_array = case parent
         when Assignments then parent.array
@@ -139,7 +140,7 @@ module Tap
         nil
       end
 
-      # Yields each key, value pair in the order in which
+      # Yields each [key, value] pair in the order in which
       # the keys were declared. Keys with no values are 
       # skipped.
       def each
@@ -148,7 +149,7 @@ module Tap
         end
       end
       
-      # Yields each key, values pair in the order in which
+      # Yields each [key, values] pair in the order in which
       # the keys were declared.
       def each_pair
         array.each do |key, values|
@@ -156,7 +157,7 @@ module Tap
         end
       end
       
-      # Returns the [key, values] as an array
+      # Returns self as an array
       def to_a
         array.collect {|key, values| [key, values.dup] }
       end
@@ -164,7 +165,7 @@ module Tap
       protected
       
       # An array of [key, values] arrays tracking the 
-      # key and order in which values were assigned. 
+      # order in which values are assigned. 
       attr_reader :array
       
     end

data/lib/tap/support/audit.rb

@@ -3,43 +3,41 @@ module Tap
     
     # Marks the merge of multiple Audit trails
     class AuditMerge < Array
+      
+      # True if another is an AuditMerge and passes Array#==
       def ==(another)
         another.kind_of?(AuditMerge) && super
       end
     end
     
-    # Marks a split in an Audit trail
-    class AuditSplit
-      attr_reader :block
-      def initialize(block) @block = block end
-        
-      def ==(another)
-        another.kind_of?(AuditSplit) && another.block == block
-      end
-    end
-    
     # Marks the expansion of an Audit trail
-    class AuditExpand
+    class AuditIterate
       attr_reader :index
       def initialize(index) @index = index end
-        
+      
+      # True if another is an AuditIterate with the same index.
       def ==(another)
-        another.kind_of?(AuditExpand) && another.index == index
+        another.kind_of?(AuditIterate) && another.index == index
+      end
+      
+      # Returns a string like '_iterate(<index>)'.
+      def to_s
+        "_iterate(#{index})"
       end
     end
 
-    # Audit provides a way to track the values (inputs and results) passed
-    # among tasks or, more generally, any Executable method.  Audits allow 
-    # you to track inputs as they make their way through a workflow, and 
-    # have great utility in debugging and record keeping. 
+    # Audit provides a way to track the values (inputs and results) passed among 
+    # tasks or, more generally, any Executable.  Audits allow you to track inputs
+    # as they make their way through a workflow, and have great utility in 
+    # debugging and record keeping. 
     #
-    # During execution, the group of inputs for a task are used to initialize 
-    # an Audit.  These inputs mark the begining of an audit trail; every 
-    # task that processes them (including the first) adds to the trail by 
-    # recording it's result using itself as the 'source' of the result.
+    # During execution, the inputs to a task are used to initialize an Audit.
+    # These inputs are the original value of the audit and mark the begining 
+    # of an audit trail; every task adds to the trail by recording it's result
+    # and itself as the 'source' of the result.
     #
-    # Since Audits are meant to be fairly general structures, they can take 
-    # any object as a source, so for illustration lets use some symbols:
+    # Audits can take any object as a source, so for illustration lets use some
+    # symbols:
     #   
     #   # initialize a new audit
     #   a = Audit.new(1, nil)
@@ -48,8 +46,8 @@ module Tap
     #   a._record(:A, 2)
     #   a._record(:B, 3)
     #
-    # Now you can pull up the source and value trails, as well as 
-    # information like the current and original values:
+    # Now you can pull up the source and value trails, as well as the current
+    # and original values:
     #
     #   a._source_trail      # => [nil, :A, :B]
     #   a._value_trail       # => [1, 2, 3]
@@ -60,9 +58,9 @@ module Tap
     #   a._current           # => 3
     #   a._current_source    # => :B
     #
-    # Merges are supported by using an array of the merging trails (internally
-    # an AuditMerge) as the source, and an array of the merging values as the 
-    # initial value.  
+    # Merges are supported by using an array of the merged trails (actually
+    # an AuditMerge) as the source, and an array of the merged values as the 
+    # original value.  
     #
     #   b = Audit.new(10, nil)
     #   b._record(:C, 11)
@@ -81,9 +79,9 @@ module Tap
     #   c._value_trail       # => [ [[1,2,3], [10, 11, 12]], "a string value", {'a' => 'hash value'}, ['an', 'array', 'value']]
     #
     # Audit supports forks by duplicating the source and value trails.  Forks
-    # can be developed independently.  Importantly, Audits are forked during 
-    # a merge; notice the additional record in +a+ doesn't change the source 
-    # trail for +c+:
+    # can be developed independently.  Audits are also forked during a merge; 
+    # notice the additional record in 'a' doesn't change the source trail for
+    # 'c':
     #
     #   a1 = a._fork
     #
@@ -99,23 +97,23 @@ module Tap
     # to help gain access, as well as a printing method to visualize the
     # audit trail:
     #
-    #   [c._to_s]
-    #   o-[] 1
-    #   o-[A] 2
-    #   o-[B] 3
-    #   | 
-    #   | o-[] 10
-    #   | o-[C] 11
-    #   | o-[D] 12
-    #   | | 
-    #   `-`-o-[E] "a string value"
-    #       o-[F] {"a"=>"hash value"}
-    #       o-[G] ["an", "array", "value"]
+    #   c._to_s
+    #   # =>
+    #   # o-[] 1
+    #   # o-[A] 2
+    #   # o-[B] 3
+    #   # | 
+    #   # | o-[] 10
+    #   # | o-[C] 11
+    #   # | o-[D] 12
+    #   # | | 
+    #   # `-`-o-[E] "a string value"
+    #   #     o-[F] {"a"=>"hash value"}
+    #   #     o-[G] ["an", "array", "value"]
     #
     # In practice, tasks are recored as sources. Thus source trails can be used  
     # to access task configurations and other information that may be useful 
-    # when creating reports or making workflow decisions (ex: raise an 
-    # error after looping to a given task too many times). 
+    # when creating reports or making workflow decisions. 
     #
     #--
     # TODO:
@@ -141,9 +139,9 @@ module Tap
       class << self
 
         # Creates a new Audit by merging the input audits. The value of the new 
-        # Audit will be an array of the _current values of the audits.  The source 
-        # will be an AuditMerge whose values are forks of the audits. Non-Audit 
-        # sources can be provided; they are initialized to Audits before merging.
+        # Audit will be an array of the _current values of the inputs.  The source 
+        # will be an AuditMerge whose values are forks of the inputs. Non-Audit 
+        # sources may be provided; they are initialized to Audits before merging.
         #
         #   a = Audit.new
         #   a._record(:a, 'a')
@@ -179,9 +177,9 @@ module Tap
       # An array of the values in self
       attr_reader :_values
       
-      # An arbitrary constant used to identify when no inputs have been
-      # provided to Audit.new.  (nil itself cannot be used as nil is a 
-      # valid initial value for an audit trail)
+      # An arbitrary object used to identify when no inputs have been
+      # provided to Audit.new.  (nil cannot be used since nil is a valid 
+      # initial value)
       AUDIT_NIL = Object.new
       
       # A new audit takes a value and/or source.  A nil source is typically given
@@ -268,7 +266,7 @@ module Tap
       end
       
       # Produces a new Audit with duplicate sources and values, suitable for
-      # separate development along a separate path.
+      # independent development.
       def _fork
         a = Audit.new
         a._sources = _sources.dup
@@ -276,18 +274,16 @@ module Tap
         a
       end
 
-      # _forks self and records the next value as [<return from block>, AuditSplit.new(block)] 
-      def _split(&block) # :yields: _current
-        _fork._record(AuditSplit.new(block), yield(_current))
-      end
-      
-      # _forks self for each member in _current.  Records the next value as
-      # [item, AuditExpand.new(<index of item>)].  Raises an error if _current 
-      # does not respond to each.
-      def _expand
+      # Produces a fork of self for each item in the current value (_current).
+      # Iterate is useful for developing each item of (say) an array along 
+      # different paths.
+      # 
+      # Records the next value of each fork as [item, AuditIterate.new(<index of item>)].  
+      # Raises an error if _current does not respond to each.
+      def _iterate
         expanded = []
         _current.each do |value|
-          expanded << _fork._record(AuditExpand.new(expanded.length), value)
+          expanded << _fork._record(AuditIterate.new(expanded.length), value)
         end
         expanded
       end