tap 0.10.0 → 0.10.1

data/lib/tap/exe.rb

@@ -0,0 +1,63 @@
+module Tap
+  class Exe < Env
+    
+    class << self
+      def instantiate
+        app = Tap::App.instance
+        exe = super(app, load_config(Tap::Env::GLOBAL_CONFIG_FILE), app.logger)
+        
+        # add all gems if no gems are specified (Note this is VERY SLOW ~ 1/3 the overhead for tap)
+        if !File.exists?(Tap::Env::DEFAULT_CONFIG_FILE)
+          exe.gems = gemspecs(true)
+        end
+      
+        tap = instance_for("#{File.dirname(__FILE__)}/../..")
+        tap.manifest(:tasks).search_paths = tap.root.glob(:lib, "tap/tasks/*").collect do |path|
+          [tap.root[:lib], path]
+        end
+        exe.push(tap)
+        exe
+      end
+      
+      def instance_for(path)
+        path = pathify(path)
+        instances.has_key?(path) ? instances[path] : Env.instantiate(path)
+      end   
+    end
+    
+    config :before, nil
+    config :after, nil
+    config :aliases, {}, &c.hash_or_nil
+    
+    def handle_error(err)
+      case
+      when $DEBUG
+        puts err.message
+        puts
+        puts err.backtrace
+      else puts err.message
+      end
+    end
+    
+    def run(argv=ARGV)
+      command = argv.shift.to_s
+      
+      if aliases && aliases.has_key?(command)
+        aliases[command].reverse_each {|arg| argv.unshift(arg)}
+        command = argv.shift
+      end
+
+      case command  
+      when '', '--help'
+        yield
+      else
+        if path = search(:commands, command)
+          load path # run the command, if it exists
+        else
+          puts "Unknown command: '#{command}'"
+          puts "Type 'tap help' for usage information."
+        end
+      end
+    end
+  end
+end

data/lib/tap/file_task.rb

@@ -115,20 +115,45 @@ module Tap
       end
     end
     
+    # Returns the path, exchanging the extension with extname.  
+    # A false or nil extname removes the extension, while true 
+    # preserves the existing extension (and effectively does
+    # nothing).
+    #
+    #   t = FileTask.new
+    #   t.basepath('path/to/file.txt')           # => 'path/to/file'
+    #   t.basepath('path/to/file.txt', '.html')  # => 'path/to/file.html'
+    #
+    #   t.basepath('path/to/file.txt', false)    # => 'path/to/file'
+    #   t.basepath('path/to/file.txt', true)     # => 'path/to/file.txt'
+    #
+    # Compare to basename.
+    def basepath(path, extname=false)
+      case extname
+      when false, nil 
+        path.chomp(File.extname(path))
+      when true
+        path
+      else
+        extname = extname[1, extname.length-1] if extname[0] == ?.
+        "#{path.chomp(File.extname(path))}.#{extname}"
+      end
+    end
+    
     # Returns the basename of path, exchanging the extension 
-    # with extname, if provided.
+    # with extname.  A false or nil extname removes the
+    # extension, while true preserves the existing extension.
     #
     #   t = FileTask.new
     #   t.basename('path/to/file.txt')           # => 'file.txt'
     #   t.basename('path/to/file.txt', '.html')  # => 'file.html'
     #
-    def basename(path, extname=nil)
-      basename = File.basename(path)
-      unless extname == nil
-        extname = $1 if extname =~ /^\.?(.*)/
-        basename = "#{basename.chomp(File.extname(basename))}.#{extname}"
-      end
-      basename
+    #   t.basename('path/to/file.txt', false)    # => 'file'
+    #   t.basename('path/to/file.txt', true)     # => 'file.txt'
+    #
+    # Compare to basepath.
+    def basename(path, extname=true)
+      basepath(File.basename(path), extname)
     end
     
     # Constructs a filepath using the dir, name, and the specified paths.

data/lib/tap/generator/base.rb

@@ -4,38 +4,17 @@ module Tap
   module Generator 
     class Base < Tap::Task
       class << self
-        def lazydoc(resolve=false, args_method=:manifest)
-          if resolve
-            lazydoc = super(false)
-            lazydoc.resolve(nil, /^\s*def\s+#{args_method}(\((.*?)\))?/) do |comment, match|
-              args = match[2].to_s.split(',').collect do |arg|
-                arg = arg.strip.upcase
-                case arg
-                when /^&/ then nil
-                when /^\*/ then arg[1..-1] + "..."
-                else arg
-                end
-              end
-              args.shift
-              
-              comment.subject = args.join(', ')
-              lazydoc.default_attributes['args'] ||= comment
-            end
-          end
-
-          super(false)
-        end
-        
-        def help
-          Tap::Support::Templater.new(DEFAULT_HELP_TEMPLATE, 
-            :task_class => self, 
-            :manifest => lazydoc(true)[to_s]['generator'] || Tap::Support::Comment.new
-          ).build
+        def lazydoc(resolve=true)
+          lazydoc = super(false)
+          lazydoc.register_method_pattern('args', :manifest, 1..-1) unless lazydoc.resolved?
+          super
         end
       end
       
       Constant = Tap::Support::Constant
-
+      
+      lazy_attr :manifest, :generator
+      
       config :pretend, false, &c.flag         # Run but rollback any changes.
       config :force, false, &c.flag           # Overwrite files that already exist.
       config :skip, false, &c.flag            # Skip files that already exist.

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

@@ -17,12 +17,16 @@ module Tap::Generator::Generators
   #       |- 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
+    
     # ::args ROOT, PROJECT_NAME=basename(ROOT)
-    def manifest(m, root, project_name=File.basename(root))
-      project_name = 'project' if project_name == '.'
+    def manifest(m, root, project_name=nil)
       r = Tap::Root.new(root)
+      project_name = File.basename(r.root) if project_name == nil
       
       m.directory r.root
       m.directory r['lib']
@@ -32,24 +36,26 @@ module Tap::Generator::Generators
         when File.directory?(source)
           m.directory r[target]
         when target == 'gemspec'
-          m.template r[project_name + '.gemspec'], source, :project_name => project_name
-        when target == 'tapfile'
-          m.template r['tapfile.rb'], source, :project_name => project_name
+          m.template r[project_name + '.gemspec'], source, :project_name => project_name, :tapfile => tapfile, :config_file => config_file
+        when target =~ /tapfile/
+          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
       end
       
-      # m.file(r['tap.yml']) do |file|
-      #  Tap::App.configurations.format_str(: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)
-      # end
+      m.file(r['tap.yml']) do |file|
+       Tap::App.configurations.format_str(: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)
+      end if config_file
     end
   end
 end

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

@@ -44,7 +44,7 @@ task :print_manifest do
   
   # sort and output the results
   files.values.sort_by {|exists, file| file }.each do |entry| 
-    puts "%-5s : %s" % entry
+    puts "%-5s %s" % entry
   end
 end
 

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

@@ -19,7 +19,8 @@ Gem::Specification.new do |s|
   # list the files you want to include here. you can
   # check this manifest using 'rake :print_manifest'
   s.files = %W{
-    tapfile.rb
+<%= config_file ? "    tap.yml\n" : '' %>
+<%= tapfile ? "    tapfile.rb\n" : '' %>
     test/tap_test_helper.rb
     test/tap_test_suite.rb
     test/tapfile_test.rb

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

@@ -47,6 +47,8 @@ module Rake # :nodoc:
     
     # 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

data/lib/tap/support/class_configuration.rb

@@ -16,8 +16,7 @@ module Tap
       # Tracks the assignment of the config keys to receivers
       attr_reader :assignments
       
-      # A map of config keys and instance methods used to set a 
-      # config (ie the reader and writer for a config)
+      # A map of (key, config) pairs.
       attr_reader :map
 
       def initialize(receiver, parent=nil)
@@ -111,8 +110,8 @@ module Tap
       
       # Initializes and returns a new InstanceConfiguration set to self 
       # and bound to the receiver, if specified.
-      def instance_config(receiver=nil)
-        InstanceConfiguration.new(self, receiver)
+      def instance_config(receiver=nil, store={})
+        InstanceConfiguration.new(self, receiver, store)
       end
       
       # Returns a hash of the (key, config.default) values in self.
@@ -122,6 +121,7 @@ module Tap
         hash
       end
       
+      # An array of config descriptions that are Comment objects.
       def code_comments
         code_comments = []
         values.each do |config| 
@@ -148,7 +148,6 @@ module Tap
       # templater is assigned the following attributes for use in formatting:
       #
       # receiver:: The receiver
-      # class_doc:: The TDoc for the receiver, from Tap::Support::TDoc[receiver]
       # configurations:: An array of configurations and associated comments
       # 
       # In the template these can be accessed as any ERB locals, for example:
@@ -161,7 +160,7 @@ module Tap
       # The input template may be a String or an ERB; either may be used to 
       # initialize the templater.
       def format_str(template=:doc, target="")
-        Lazydoc.resolve(code_comments)
+        Lazydoc.resolve_comments(code_comments)
         
         template = case template
         when :doc then File.read(DOC_TEMPLATE_PATH)

data/lib/tap/support/configurable_class.rb

@@ -1,6 +1,6 @@
 require 'tap/support/class_configuration'
 require 'tap/support/validation'
-require 'tap/support/lazydoc'
+require 'tap/support/lazy_attributes'
 
 module Tap
   module Support
@@ -47,13 +47,10 @@ module Tap
     #   ac.one               # => 'eulav'
     #
     module ConfigurableClass
+      include Tap::Support::LazyAttributes
       
       # A ClassConfiguration holding the class configurations.
       attr_reader :configurations
-      
-      # The source_file for self.  By default the first file
-      # to define the class inheriting ConfigurableClass.
-      attr_accessor :source_file
 
       # Sets the source_file for base and initializes base.configurations.
       def self.extended(base)
@@ -82,16 +79,15 @@ module Tap
         super
       end
       
-      # Returns the lazydoc for source_file
-      def lazydoc(resolve=false)
-        Lazydoc.resolve(configurations.code_comments) if resolve
-        Lazydoc[source_file]
+      def lazydoc(resolve=true)
+        Lazydoc.resolve_comments(configurations.code_comments) if resolve
+        super
       end
       
       # Loads the contents of path as YAML.  Returns an empty hash if the path 
       # is empty, does not exist, or is not a file.
       def load_config(path)
-        return {} if path == nil || !File.exists?(path) || File.directory?(path)
+        return {} if path == nil || !File.file?(path)
 
         YAML.load_file(path) || {}
       end
@@ -213,9 +209,10 @@ module Tap
       # Idiosyncratically, true, false, and nil may also be provided as 
       # reader/writer options. Specifying true is the same as using the 
       # default.  Specifying false or nil prevents config_attr from 
-      # defining accessors, but the configuration still expects to use 
-      # the default reader/writer methods (ie <tt>key</tt> and <tt>key=</tt>) 
-      # which must be defined elsewhere.
+      # defining accessors; false sets the configuration to use 
+      # the default reader/writer methods (ie <tt>key</tt> and <tt>key=</tt>,
+      # which must be defined elsewhere) while nil prevents read/write
+      # mapping of the config to a method.
       def config_attr(key, value=nil, options={}, &block)
         
         # add arg_type implied by block, if necessary
@@ -231,7 +228,7 @@ module Tap
         # define the public writer method
         case
         when options.has_key?(:writer) && options[:writer] != true
-          raise ArgumentError.new("block may not be specified with writer") if block_given?
+          raise(ArgumentError, "a block may not be specified with writer option") if block_given?
         when block_given? 
           define_method("#{key}=", &block)
           public "#{key}="
@@ -240,17 +237,17 @@ module Tap
           public "#{key}="
         end
 
-        # remove any true, false, nil reader/writer declarations...
+        # remove any true, false reader/writer declarations...
         # implicitly reverting the option to the default reader
         # and writer methods
         [:reader, :writer].each do |option|
           case options[option]
-          when true, false, nil then options.delete(option)
+          when true, false then options.delete(option)
           end
         end
         
-        # register with TDoc so that all extra documentation can be extracted
-        caller.each_with_index do |line, index|
+        # register with Lazydoc so that all extra documentation can be extracted
+        caller.each do |line|
           case line
           when /in .config.$/ then next
           when /^(([A-z]:)?[^:]+):(\d+)/

data/lib/tap/support/configuration.rb

@@ -53,8 +53,8 @@ module Tap
         @name = name
         self.default = default
         
-        self.reader = options.delete(:reader) || name
-        self.writer = options.delete(:writer) || "#{name}="
+        self.reader = options.has_key?(:reader) ? options.delete(:reader) : name
+        self.writer = options.has_key?(:writer) ? options.delete(:writer) : "#{name}="
         @attributes = options
       end
 
@@ -76,14 +76,16 @@ module Tap
         duplicate && duplicable ? @default.dup : @default
       end
       
-      # Sets the reader for self.  The reader is symbolized.
+      # Sets the reader for self.  The reader is symbolized,
+      # but may also be set to nil.
       def reader=(value)
-        @reader = value.to_sym
+        @reader = value == nil ? value : value.to_sym
       end
       
-      # Sets the writer for self.  The writer is symbolized.
+      # Sets the writer for self.  The writer is symbolized,
+      # but may also be set to nil.
       def writer=(value)
-        @writer = value.to_sym
+        @writer = value == nil ? value : value.to_sym
       end
       
       def arg_name

data/lib/tap/support/declarations.rb

@@ -47,7 +47,7 @@ module Tap
       protected
 
       def config(key, value=nil, options={}, &block)
-        caller.each_with_index do |line, index|
+        caller.each do |line|
           case line
           when /^(([A-z]:)?[^:]+):(\d+)/
             options[:desc] = Support::Lazydoc.register($1, $3.to_i - 1)
@@ -59,7 +59,7 @@ module Tap
       end
 
       def config_attr(key, value=nil, options={}, &block)
-        caller.each_with_index do |line, index|
+        caller.each do |line|
           case line
           when /^(([A-z]:)?[^:]+):(\d+)/
             options[:desc] = Support::Lazydoc.register($1, $3.to_i - 1)

data/lib/tap/support/framework.rb

@@ -17,6 +17,8 @@ module Tap
         mod.extend Support::BatchableClass
         mod.extend Support::ConfigurableClass
         mod.extend Support::FrameworkClass
+        mod.lazy_attr :manifest
+        mod.lazy_attr :args
       end
     
       # The application used to load config_file templates 
@@ -24,6 +26,9 @@ module Tap
       attr_reader :app
       
       # The name of self.
+      #--
+      # Currently names may be any object.  Audit makes use of name
+      # via to_s, as does app when figuring configuration filepaths. 
       attr_accessor :name
       
       # Initializes a new instance and associated batch objects.  Batch
@@ -34,7 +39,14 @@ module Tap
         super()
         @app = app
         @name = name || self.class.default_name
-        initialize_config(config)
+        
+        case config
+        when InstanceConfiguration 
+          @config = config
+          config.bind(self)
+        else 
+          initialize_config(config)
+        end
       end
       
       # Creates a new batched object and adds the object to batch. The batched object 
@@ -63,7 +75,7 @@ module Tap
       
       # Returns self.name
       def to_s
-        name
+        name.to_s
       end
       
     end