tap 0.12.2 → 0.12.3

data/History

@@ -1,3 +1,10 @@
+== 0.12.3 / 2009-03-05
+
+* Updates to allow Tap to use the latest Configurable.
+* Updated RootGenerator
+* Fixed minor task --help bugs
+* Documentation updates
+
 == 0.12.2 / 2009-02-23
 
 * Added --no-yaml option to Dump and Load

data/README

@@ -110,5 +110,5 @@ Tap requires an updated version of RubyGems[http://docs.rubygems.org/]
 Copyright (c) 2006-2009, Regents of the University of Colorado.
 Developer:: {Simon Chiang}[http://bahuvrihi.wordpress.com], {Biomolecular Structure Program}[http://biomol.uchsc.edu/], {Hansen Lab}[http://hsc-proteomics.uchsc.edu/hansenlab/] 
 Support:: CU Denver School of Medicine Deans Academic Enrichment Fund
-Licence:: {MIT-Style}[link:files/MIT-LICENSE.html]
+License:: {MIT-Style}[link:files/MIT-LICENSE.html]
 

data/cmd/console.rb

@@ -1,11 +1,14 @@
-# tap console [options]
+# usage: tap console [options]
 #
-# Opens up an IRB session with Tap initialized to the configurations 
+# Opens up an IRB session with the Tap environment initialized as specified
 # in tap.yml. Access the Tap::App.instance through 'app', and
-# Tap::Env.instance through 'env'.
-
+# Tap::Env.instance through 'env'.  For example:
 #
-# handle options
+#   % tap console
+#   >> env.tasks.search('tap:dump').constantize=> Tap::Tasks::Dump
+#   >> app.info
+#   => "state: 0 (READY) queue: 0 results: 0"
+#   >> 
 #
 
 ConfigParser.new do |opts|
@@ -40,4 +43,4 @@ module CleanExit # :nodoc:
     __exit__(ret)
   end
 end
-IRB.CurrentContext.extend CleanExit
+IRB.CurrentContext.extend CleanExit

data/cmd/destroy.rb

@@ -1,9 +1,20 @@
+# usage: tap destroy GENERATOR ...
+#
+# Runs a generator in reverse.  Each generator works a little differently; the
+# best way to figure out what a generator does is to use --help. For example:
+#
+#   % tap generate root --help
+#
+
 require 'tap/generator/base'
 require 'tap/generator/destroy'
 
 env = Tap::Env.instance
 
 if ARGV.empty? || ARGV == ['--help']
+  puts Lazydoc.usage(__FILE__)
+  puts
+  puts "generators:"
   puts env.summarize(:generators)
   exit
 end

data/cmd/generate.rb

@@ -1,9 +1,20 @@
+# usage: tap generate GENERATOR ...
+#
+# Runs a generator.  Each generator works a little differently; the best way to
+# figure out what a generator does is to use --help. For example:
+#
+#   % tap generate root --help
+#
+
 require 'tap/generator/base'
 require 'tap/generator/generate'
 
 env = Tap::Env.instance
 
 if ARGV.empty? || ARGV == ['--help']
+  puts Lazydoc.usage(__FILE__)
+  puts
+  puts "generators:"
   puts env.summarize(:generators)
   exit
 end

data/cmd/manifest.rb

@@ -1,7 +1,6 @@
-# tap manifest [options]
-#
-# Prints information about the current tap environment.
+# usage: tap manifest [options]
 #
+# Prints a manifest of all resources in the current tap environment.
 
 options = {}
 ConfigParser.new do |opts|

data/cmd/run.rb

@@ -1,4 +1,4 @@
-# tap run FILEPATHS... [options] -- [SCHEMA]
+# usage: tap run FILEPATHS... [options] -- [SCHEMA]
 #
 # examples:
 #   tap run --help                     Prints this help

data/lib/tap/constants.rb

@@ -1,7 +1,7 @@
 module Tap
   MAJOR = 0
   MINOR = 12
-  TINY = 0
+  TINY = 3
   
   VERSION="#{MAJOR}.#{MINOR}.#{TINY}" 
   WEBSITE="http://tap.rubyforge.org"

data/lib/tap/env.rb

@@ -103,13 +103,7 @@ module Tap
     attr_reader :envs
     
     # The Root directory structure for self.
-    nest(:root, Tap::Root) do |config|
-      case config
-      when Root then config
-      when String then Root.new(config)
-      else Root.new.reconfigure(config)
-      end
-    end
+    nest(:root, Tap::Root, :initializer => false)
     
     # Specify gems to load as nested Envs.  Gems may be specified 
     # by name and/or version, like 'gemname >= 1.2'; by default the 
@@ -482,6 +476,14 @@ module Tap
     # A hash of the manifests for self.
     attr_reader :manifests
     
+    def initialize_root(config)
+      case config
+      when Root then config
+      when String then Root.new(config)
+      else Root.new.reconfigure(config)
+      end
+    end
+    
     def minikey(env)
       env.root.root
     end

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

@@ -4,24 +4,24 @@ module Tap::Generator::Generators
   
   # :startdoc: 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:
+  # Generates a tap root directory structure.  Use the switches to turn on or
+  # off the creation of various files:
   #
-  #   root
+  #   project
+  #   |- MIT-LICENSE
+  #   |- README
   #   |- Rakefile
   #   |- lib
-  #   |- sample.gemspec
+  #   |- project.gemspec
   #   |- tap.yml
-  #   |- Tapfile
   #   `- test
-  #       |- tap_test_helper.rb
-  #       |- tap_test_suite.rb
-  #       `- tapfile_test.rb
+  #       `- tap_test_helper.rb
   #
   class RootGenerator < Tap::Generator::Base
     
-    config :config_file, true, &c.switch   # create a tap.yml file
-    config :rapfile, false, &c.switch      # create a rapfile
+    config :config_file, true, &c.switch   # Create a tap.yml file
+    config :license, true, &c.switch       # Create an MIT-LICENSE
+    config :rapfile, false, &c.switch      # Create a Rapfile
     
     # ::args ROOT, PROJECT_NAME=basename(ROOT)
     def manifest(m, root, project_name=nil)
@@ -38,18 +38,20 @@ module Tap::Generator::Generators
           m.directory r[target]
           next
         when source =~ /gemspec$/
-          m.template r[project_name + '.gemspec'], source, :project_name => project_name, :config_file => config_file
+          m.template r[project_name + '.gemspec'], source, :project_name => project_name, :config_file => config_file, :license => license
           next
         when source =~ /Rapfile$/
           next unless rapfile
+        when source =~ /MIT-LICENSE$/
+          next unless license
         end
         
-        m.template r[target], source, :project_name => project_name
+        m.template r[target], source, :project_name => project_name, :license => license
       end
       
       m.file(r['tap.yml']) do |file|
-        Configurable::Utils.dump(Tap::App.configurations, file) do |key, delegate|
-          default = delegate.default
+        Configurable::Utils.dump(Tap::Env.configurations, file) do |key, delegate|
+          default = delegate.default(false)
           
           # get the description
           desc = delegate.attributes[:desc]
@@ -57,13 +59,16 @@ module Tap::Generator::Generators
           doc = desc.comment if doc.empty?
           
           # wrap as lines
-          lines = Lazydoc::Utils.wrap(doc, 50).collect {|line| "# #{line}"}
+          lines = Lazydoc::Utils.wrap(doc, 78).collect {|line| "# #{line}"}
           lines << "" unless lines.empty?
           
+          # note: this causes order to be lost...
+          default = default.to_hash if delegate.is_nest?
+
           # setup formatting
           leader = key == 'root' || default == nil ? '# ' : ''
-          config = YAML.dump({key => default})[5..-1]
-          "#{lines.join("\n")}#{leader}#{config.strip}\n\n"
+          config = YAML.dump({key => default})[5..-1].strip.gsub(/\n+/, "\n#{leader}")
+          "#{lines.join("\n")}#{leader}#{config}\n\n"
         end
       end if config_file
     end

data/lib/tap/generator/generators/root/templates/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) <%= Time.now.year %>, <copyright holders>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

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

@@ -0,0 +1,14 @@
+= <%= project_name.capitalize %>
+
+== Description
+
+== Usage
+
+== Installation
+
+== Info
+<% if license %>
+
+Copyright (c) <%= Time.now.year %>, <copyright holders>
+License:: {MIT-Style}[link:files/MIT-LICENSE.html]
+<% end %>

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

@@ -3,8 +3,6 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
 
-require 'tap/constants'
-
 #
 # Gem specification
 #
@@ -56,11 +54,11 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   spec = gemspec
   
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = '<%= project_name %>'
-  rdoc.main     = 'README'
-  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options.concat(spec.rdoc_options)
   rdoc.rdoc_files.include( spec.extra_rdoc_files )
-  rdoc.rdoc_files.include( spec.files.select {|file| file =~ /^lib.*\.rb$/} )
+  
+  files = spec.files.select {|file| file =~ /^lib.*\.rb$/}
+  rdoc.rdoc_files.include( files )
   
   # Using CDoc to template your RDoc will result in configurations being
   # listed with documentation in a subsection following attributes.  Not

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

@@ -7,20 +7,20 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   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.has_rdoc = true
+  s.rdoc_options.concat %W{--main README -S -N --title <%= project_name.capitalize %>}
   
   # list extra rdoc files here.
   s.extra_rdoc_files = %W{
     README
+<%= license ? "    MIT-LICENSE\n" : '' %>
   }
   
   # 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" : '' %>
-    test/tap_test_helper.rb
   }
 end

data/lib/tap/task.rb

@@ -168,10 +168,13 @@ module Tap
       # Same as parse, but removes switches destructively.
       def parse!(argv=ARGV, app=Tap::App.instance)
         opts = ConfigParser.new
-        opts.separator "configurations:"
-        opts.add(configurations)
         
-        opts.separator ""
+        unless configurations.empty?
+          opts.separator "configurations:"
+          opts.add(configurations)
+          opts.separator ""
+        end
+        
         opts.separator "options:"
         
         # add option to print help
@@ -390,8 +393,7 @@ module Tap
       #
       def define(name, baseclass=Tap::Task, configs={}, options={}, &block)
         # define the subclass
-        const_name = options.delete(:const_name) || name.to_s.camelize
-        subclass = const_set(const_name, Class.new(baseclass))
+        subclass = Class.new(baseclass)
         subclass.default_name = name.to_s
         
         configs.each_pair do |key, value|
@@ -409,7 +411,7 @@ module Tap
         options[:desc] ||= Lazydoc.register_caller(Lazydoc::Trailer, 1)
         
         # add the configuration
-        nest(name, subclass, options) {|overrides| subclass.new(overrides) }
+        nest(name, subclass, {:const_name => name.to_s.camelize}.merge!(options))
       end
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tap
 version: !ruby/object:Gem::Version 
-  version: 0.12.2
+  version: 0.12.3
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-23 00:00:00 -07:00
+date: 2009-03-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.0
+        version: 0.4.0
     version: 
 description: 
 email: simon.a.chiang@gmail.com
@@ -60,6 +60,7 @@ files:
 - lib/tap/generator/generators/generator/templates/task.erb
 - lib/tap/generator/generators/generator/templates/test.erb
 - lib/tap/generator/generators/root/root_generator.rb
+- lib/tap/generator/generators/root/templates/MIT-LICENSE
 - lib/tap/generator/generators/root/templates/README
 - lib/tap/generator/generators/root/templates/Rakefile
 - lib/tap/generator/generators/root/templates/Rapfile