hoe 1.8.3 → 1.9.0

data/History.txt

@@ -1,3 +1,20 @@
+=== 1.9.0 / 2009-02-26:
+
+* 7 minor enhancements:
+
+  * Added flog, flay, and rdoc tasks.
+  * Added ~/.hoe_template and basic erb templating to sow.
+  * install_gem automatically installs missing dependencies. From Dr. Nic.
+  * Parameterized history and readme paths for github users (*sigh*).
+  * Added rspec support including having both tests and specs.
+  * Match RubyGems' RDoc behavior and removed rdoc_pattern attribute.  Use
+    extra_rdoc_files instead.
+  * Added testlib and SUPPORTED_TEST_FRAMEWORKS to switch your testing library.
+
+* 1 bug fix:
+
+  * Fixed rdoc title command-line parameters.
+
 === 1.8.3 / 2009-01-20:
 
 * 1 minor enhancement:

data/Manifest.txt

@@ -4,4 +4,12 @@ README.txt
 Rakefile
 bin/sow
 lib/hoe.rb
+template/.autotest.erb
+template/History.txt.erb
+template/Manifest.txt.erb
+template/README.txt.erb
+template/Rakefile.erb
+template/bin/file_name.erb
+template/lib/file_name.rb.erb
+template/test/test_file_name.rb.erb
 test/test_hoe.rb

data/README.txt

@@ -12,31 +12,35 @@ testing, packaging, and deployment.
 
 Tasks Provided:
 
-* announce         - Create news email file and post to rubyforge.
-* audit            - Run ZenTest against the package.
-* check_manifest   - Verify the manifest.
-* clean            - Clean up all the extras.
-* config_hoe       - Create a fresh ~/.hoerc file.
-* debug_gem        - Show information about the gem.
-* default          - Run the default tasks.
-* deps:email       - Print a contact list for gems dependent on this gem
-* deps:fetch       - Fetch all the dependent gems of this gem into tarballs
-* deps:list        - List all the dependent gems of this gem
-* docs             - Build the docs HTML Files
-* email            - Generate email announcement file.
-* gem              - Build the gem file hoe-1.8.0.gem
-* generate_key     - Generate a key for signing your gems.
-* install_gem      - Install the package as a gem.
-* multi            - Run the test suite using multiruby.
-* package          - Build all the packages
-* post_blog        - Post announcement to blog.
-* post_news        - Post announcement to rubyforge.
-* publish_docs     - Publish RDoc to RubyForge.
-* release          - Package and upload the release to rubyforge.
-* ridocs           - Generate ri locally for testing.
-* tasks            - Generate a list of tasks for doco.
-* test             - Run the test suite.
-* test_deps        - Show which test files fail when run alone.
+* announce          - Create news email file and post to rubyforge.
+* audit             - Run ZenTest against the package.
+* check_extra_deps  - Install missing dependencies.
+* check_manifest    - Verify the manifest.
+* clean             - Clean up all the extras.
+* config_hoe        - Create a fresh ~/.hoerc file.
+* debug_gem         - Show information about the gem.
+* default           - Run the default task(s).
+* deps:email        - Print a contact list for gems dependent on this gem
+* deps:fetch        - Fetch all the dependent gems of this gem into tarballs
+* deps:list         - List all the dependent gems of this gem
+* docs              - Build the docs HTML Files
+* email             - Generate email announcement file.
+* flay              - Analyze for code duplication.
+* flog              - Analyze code complexity.
+* gem               - Build the gem file hoe-1.9.0.gem
+* generate_key      - Generate a key for signing your gems.
+* install_gem       - Install the package as a gem.
+* multi             - Run the test suite using multiruby.
+* package           - Build all the packages
+* post_blog         - Post announcement to blog.
+* post_news         - Post announcement to rubyforge.
+* publish_docs      - Publish RDoc to RubyForge.
+* rcov              - Analyze code coverage with tests
+* release           - Package and upload the release to rubyforge.
+* ridocs            - Generate ri locally for testing.
+* tasks             - Generate a list of tasks for doco.
+* test              - Run the test suite.
+* test_deps         - Show which test files fail when run alone.
 
 See class rdoc for help. Hint: ri Hoe
 

data/bin/sow

@@ -1,69 +1,78 @@
 #!/usr/bin/env ruby -ws
 
+$h ||= false
 $t ||= false
 $d ||= false
 
 require 'rubygems'
 require 'hoe'
+require 'fileutils'
+require 'erb'
 
-if defined? $h then
-  puts "usage: #{File.dirname($0)} [-d|-t] project"
+if $h || ARGV.empty? || ($t && $d) then
+  puts "usage: #{File.dirname $0} [-d|-t] project"
   puts "  -t = add project to subdir under 'trunk'"
   puts "  -d = add project to subdir under 'dev'"
+  exit
 end
 
-abort "You must specify only one of -t or -d" if $t and $d
-
 project = ARGV.shift
 
-# prevents false positives on my tag reporter
-X = 'FI' + 'X'
-
-abort "You must supply a project name on the commandline" unless project
 abort "Project #{project} seems to exist" if test ?d, project
-puts "creating project #{project}"
 
+# variables for erb:
+XIF                       = 'FI' + 'X' # prevents extra hits on my TAG reporter
 project, file_name, klass = Hoe.normalize_names project
+template_path             = File.expand_path("~/.hoe_template")
+source_path               = File.join(File.dirname(File.dirname(__FILE__)),
+                                      "template")
+
+unless File.directory? template_path then
+  FileUtils.cp_r source_path, template_path, :verbose => true
+  paths = (Dir["#{template_path}/**/*"] +
+           Dir["#{template_path}/**/.*"]).select { |f| File.file? f }
+  FileUtils.chmod 0644, paths, :verbose => true
+  FileUtils.chmod 0755, paths.grep(/bin\//), :verbose => true
+end
 
-Dir.mkdir project
-Dir.chdir project do
+FileUtils.cp_r template_path, project, :verbose => true
 
-  if $d then
-    Dir.mkdir "dev"
-    Dir.chdir "dev"
-  elsif $t then
-    Dir.mkdir "trunk"
-    Dir.chdir "trunk"
+Dir.chdir project do
+  dirs = Dir["**/*"].select { |f| File.directory? f }.sort
+  dirs.grep(/file_name/).each do |file|
+    FileUtils.mv file, file.gsub(/file_name/, file_name), :verbose => true
   end
 
-  %w(bin lib test).each do |path|
-    Dir.mkdir path
-  end
+  paths = (Dir["**/*"] + Dir["**/.*"]).select { |f| File.file? f }.sort
+  paths.each do |path|
+    file = File.read path
 
-  files = {
-    "History.txt" => "=== 1.0.0 / #{Time.new.strftime("%Y-%m-%d")}\n\n* 1 major enhancement\n\n  * Birthday!\n\n",
-    "README.txt" => "= #{project}\n\n* #{X} (url)\n\n== DESCRIPTION:\n\n#{X} (describe your package)\n\n== FEATURES/PROBLEMS:\n\n* #{X} (list of features or problems)\n\n== SYNOPSIS:\n\n  #{X} (code sample of usage)\n\n== REQUIREMENTS:\n\n* #{X} (list of requirements)\n\n== INSTALL:\n\n* #{X} (sudo gem install, anything else)\n\n== LICENSE:\n\n(The MIT License)\n\nCopyright (c) #{Time.new.strftime("%Y")} #{X}\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n",
-    "Manifest.txt" => "",
-    "bin/#{file_name}" => "",
-    "lib/#{file_name}.rb" => "class #{klass}\n  VERSION = '1.0.0'\nend",
-    "test/test_#{file_name}.rb" => "",
-    "Rakefile" => "# -*- ruby -*-\n\nrequire 'rubygems'\nrequire 'hoe'\nrequire './lib/#{file_name}.rb'\n\nHoe.new('#{project}', #{klass}::VERSION) do |p|\n  # p.rubyforge_name = '#{project}x' # if different than lowercase project name\n  # p.developer('#{X}', '#{X}@example.com')\nend\n\n# vim: syntax=Ruby\n"
-  }
-
-  files["Manifest.txt"] = files.keys.sort.join("\n")
-
-  files.each do |file, content|
-    File.open(file, "w") do |f|
-      f.write content
+    warn "erb: #{path}"
+
+    File.open path, "w" do |f|
+      f.puts ERB.new(file).result(binding)
     end
   end
+
+  paths.grep(/file_name|\.erb$/).each do |file|
+    new_file = file.sub(/file_name/, file_name).sub(/\.erb$/, '')
+    FileUtils.mv file, new_file, :verbose => true
+  end
+end
+
+if $d || $t then
+  temp_dir = "#{project}.#{$$}"
+  FileUtils.mv project, temp_dir, :verbose => true
+  FileUtils.mkdir project, :verbose => true
+  FileUtils.mv temp_dir, "#{project}/#{$d ? 'dev' : 'trunk'}", :verbose => true
 end
 
 WINDOZE = /mswin|mingw/ =~ RUBY_PLATFORM
 
-puts "... done, now go fix all occurrences of '#{X}'"
+puts
+puts "... done, now go fix all occurrences of '#{XIF}':"
 if WINDOZE then
-  puts `findstr /N /S /C:#{X} #{project}\\*`
+  puts `findstr /N /S /C:#{XIF} #{project}\\*`
 else
-  puts `find #{project} -type f | xargs grep -n #{X}`.gsub(/\A|\n/, "\n  ")
+  puts `find #{project} -type f | xargs grep -n #{XIF}`.gsub(/\A|\n/, "\n  ")
 end

data/lib/hoe.rb

@@ -28,9 +28,11 @@ end
 # Use this as a minimal starting point:
 #
 #   require 'hoe'
+#   require './lib/project.rb'
 #
-#   Hoe.new("project_name", '1.0.0') do |p|
+#   Hoe.new("project_name", Project::VERSION) do |p|
 #     p.rubyforge_name = "rf_project"
+#     p.developer("Joe Blow", "joe@example.com")
 #     # add other details here
 #   end
 #
@@ -38,31 +40,35 @@ end
 #
 # === Tasks Provided:
 #
-# announce::          Create news email file and post to rubyforge.
-# audit::             Run ZenTest against the package.
-# check_manifest::    Verify the manifest.
-# clean::             Clean up all the extras.
-# config_hoe::        Create a fresh ~/.hoerc file.
-# debug_gem::         Show information about the gem.
-# default::           Run the default tasks.
-# deps:email::        Print a contact list for gems dependent on this gem
-# deps:fetch::        Fetch all the dependent gems of this gem into tarballs
-# deps:list::         List all the dependent gems of this gem
-# docs::              Build the docs HTML Files
-# email::             Generate email announcement file.
-# gem::               Build the gem file hoe-1.8.0.gem
-# generate_key::      Generate a key for signing your gems.
-# install_gem::       Install the package as a gem.
-# multi::             Run the test suite using multiruby.
-# package::           Build all the packages
-# post_blog::         Post announcement to blog.
-# post_news::         Post announcement to rubyforge.
-# publish_docs::      Publish RDoc to RubyForge.
-# release::           Package and upload the release to rubyforge.
-# ridocs::            Generate ri locally for testing.
-# tasks::             Generate a list of tasks for doco.
-# test::              Run the test suite.
-# test_deps::         Show which test files fail when run alone.
+# announce::           Create news email file and post to rubyforge.
+# audit::              Run ZenTest against the package.
+# check_extra_deps::   Install missing dependencies.
+# check_manifest::     Verify the manifest.
+# clean::              Clean up all the extras.
+# config_hoe::         Create a fresh ~/.hoerc file.
+# debug_gem::          Show information about the gem.
+# default::            Run the default task(s).
+# deps:email::         Print a contact list for gems dependent on this gem
+# deps:fetch::         Fetch all the dependent gems of this gem into tarballs
+# deps:list::          List all the dependent gems of this gem
+# docs::               Build the docs HTML Files
+# email::              Generate email announcement file.
+# flay::               Analyze for code duplication.
+# flog::               Analyze code complexity.
+# gem::                Build the gem file hoe-1.9.0.gem
+# generate_key::       Generate a key for signing your gems.
+# install_gem::        Install the package as a gem.
+# multi::              Run the test suite using multiruby.
+# package::            Build all the packages
+# post_blog::          Post announcement to blog.
+# post_news::          Post announcement to rubyforge.
+# publish_docs::       Publish RDoc to RubyForge.
+# rcov::               Analyze code coverage with tests
+# release::            Package and upload the release to rubyforge.
+# ridocs::             Generate ri locally for testing.
+# tasks::              Generate a list of tasks for doco.
+# test::               Run the test suite.
+# test_deps::          Show which test files fail when run alone.
 #
 # === Extra Configuration Options:
 #
@@ -124,16 +130,19 @@ end
 #
 
 class Hoe
-  VERSION = '1.8.3'
+  VERSION = '1.9.0'
   GEMURL = URI.parse 'http://gems.rubyforge.org' # for namespace :deps below
 
   ruby_prefix = Config::CONFIG['prefix']
   sitelibdir = Config::CONFIG['sitelibdir']
 
   ##
-  # Used to specify a custom install location (for rake install).
+  # Configuration for the supported test frameworks for test task.
 
-  PREFIX = ENV['PREFIX'] || ruby_prefix
+  SUPPORTED_TEST_FRAMEWORKS = {
+    :testunit => "test/unit",
+    :minitest => "minitest/autorun",
+  }
 
   ##
   # Used to add extra flags to RUBY_FLAGS.
@@ -150,17 +159,13 @@ class Hoe
 
   ##
   # Used to add flags to test_unit (e.g., -n test_borked).
+  #
+  # eg FILTER="-n test_blah"
 
-  FILTER = ENV['FILTER'] # for tests (eg FILTER="-n test_blah")
+  FILTER = ENV['FILTER'] || ENV['TESTOPTS']
 
   # :stopdoc:
 
-  RUBYLIB = if PREFIX == ruby_prefix then
-              sitelibdir
-            else
-              File.join(PREFIX, sitelibdir[ruby_prefix.size..-1])
-            end
-
   DLEXT = Config::CONFIG['DLEXT']
 
   WINDOZE = /mswin|mingw/ =~ RUBY_PLATFORM unless defined? WINDOZE
@@ -178,8 +183,7 @@ class Hoe
   # :startdoc:
 
   ##
-  # *Recommended*: The author(s) of the package. (can be array)
-  # Really. Set this or we'll tease you.
+  # *MANDATORY*: The author(s) of the package. (can be array)
 
   attr_accessor :author
 
@@ -214,7 +218,7 @@ class Hoe
   attr_accessor :description_sections
 
   ##
-  # *Recommended*: The author's email address(es). (can be array)
+  # *MANDATORY*: The author's email address(es). (can be array)
 
   attr_accessor :email
 
@@ -228,6 +232,18 @@ class Hoe
 
   attr_accessor :extra_dev_deps
 
+  ##
+  # Optional: Extra files you want to add to RDoc.
+  #
+  # .txt files are automatically included (excluding the obvious).
+
+  attr_accessor :extra_rdoc_files
+
+  ##
+  # Optional: The filename for the project history. [default: History.txt]
+
+  attr_accessor :history_file
+
   ##
   # Populated automatically from the manifest. List of library files.
 
@@ -259,15 +275,25 @@ class Hoe
   attr_accessor :post_install_message
 
   ##
-  # Optional: A regexp to match documentation files against the manifest.
+  # Optional: The filename for the project readme. [default: README.txt]
 
-  attr_accessor :rdoc_pattern
+  attr_accessor :readme_file
 
   ##
   # Optional: Name of RDoc destination directory on Rubyforge. [default: +name+]
 
   attr_accessor :remote_rdoc_dir
 
+  ##
+  # Optional: RSpec dirs. [default: %w(spec lib)]
+
+  attr_accessor :rspec_dirs
+
+  ##
+  # Optional: RSpec options. [default: []]
+
+  attr_accessor :rspec_options
+
   ##
   # Optional: Flags for RDoc rsync. [default: "-av --delete"]
 
@@ -309,7 +335,7 @@ class Hoe
   attr_accessor :test_globs
 
   ##
-  # Optional: What test library to require [default: test/unit]
+  # Optional: What test library to require [default: :testunit]
 
   attr_accessor :testlib
 
@@ -351,36 +377,40 @@ class Hoe
   end
 
   def initialize(name, version) # :nodoc:
-    self.name = name
+    self.name    = name
     self.version = version
 
     # Defaults
-    self.author = []
-    self.clean_globs = %w(diff diff.txt email.txt ri deps .source_index
-                          *.gem *~ **/*~ *.rbc **/*.rbc)
+    self.author               = []
+    self.blog_categories      = [name]
+    self.clean_globs          = %w(diff diff.txt email.txt ri deps .source_index
+                                   *.gem **/*~ **/.*~ **/*.rbc)
     self.description_sections = %w(description)
-    self.blog_categories = [name]
-    self.email = []
-    self.extra_deps = []
-    self.extra_dev_deps = []
-    self.multiruby_skip = []
-    self.need_tar = true
-    self.need_zip = false
-    self.rdoc_pattern = /^(lib|bin|ext)|txt$/
-    self.remote_rdoc_dir = name
-    self.rsync_args = '-av --delete'
-    self.rubyforge_name = name.downcase
-    self.spec_extras = {}
-    self.summary_sentences = 1
-    self.test_globs = ['test/**/test_*.rb']
-    self.testlib = 'test/unit'
+    self.email                = []
+    self.extra_deps           = []
+    self.extra_dev_deps       = []
+    self.extra_rdoc_files     = []
+    self.history_file         = "History.txt"
+    self.multiruby_skip       = []
+    self.need_tar             = true
+    self.need_zip             = false
     self.post_install_message = nil
+    self.readme_file          = "README.txt"
+    self.remote_rdoc_dir      = name
+    self.rspec_dirs           = %w(spec lib)
+    self.rspec_options        = []
+    self.rsync_args           = '-av --delete'
+    self.rubyforge_name       = name.downcase
+    self.spec_extras          = {}
+    self.summary_sentences    = 1
+    self.test_globs           = ['test/**/test_*.rb']
+    self.testlib              = :testunit
 
     yield self if block_given?
 
     # Intuit values:
 
-    readme   = File.read("README.txt").split(/^(=+ .*)$/)[1..-1] rescue ''
+    readme = File.read(readme_file).split(/^(=+ .*)$/)[1..-1] rescue ''
     unless readme.empty? then
       sections = readme.map { |s|
         s =~ /^=/ ? s.strip.downcase.chomp(':').split.last : s.strip
@@ -390,17 +420,17 @@ class Hoe
       summ = desc.split(/\.\s+/).first(summary_sentences).join(". ")
 
       self.description ||= desc
-      self.summary ||= summ
-      self.url ||= readme[1].gsub(/^\* /, '').split(/\n/).grep(/\S+/)
+      self.summary     ||= summ
+      self.url         ||= readme[1].gsub(/^\* /, '').split(/\n/).grep(/\S+/)
     else
-      missing 'README.txt'
+      missing readme_file
     end
 
     self.changes ||= begin
-                       h = File.read("History.txt")
+                       h = File.read(history_file)
                        h.split(/^(===.*)/)[1..2].join.strip
                      rescue
-                       missing 'History.txt'
+                       missing history_file
                        ''
                      end
 
@@ -448,31 +478,104 @@ class Hoe
   end
 
   def define_tasks # :nodoc:
-    desc 'Run the default tasks.'
-    task :default => :test
+    default_tasks = []
 
-    desc 'Run the test suite. Use FILTER to add to the command line.'
-    task :test do
-      run_tests
-    end
+    if File.directory? "test" then
+      desc 'Run the test suite. Use FILTER or TESTOPTS to add flags/args.'
+      task :test do
+        run_tests
+      end
+
+      desc 'Run the test suite using multiruby.'
+      task :multi do
+        run_tests :multi
+      end
+
+      desc 'Show which test files fail when run alone.'
+      task :test_deps do
+        tests = Dir["test/**/test_*.rb"]  +  Dir["test/**/*_test.rb"]
+
+        paths = ['bin', 'lib', 'test'].join(File::PATH_SEPARATOR)
+        null_dev = WINDOZE ? '> NUL 2>&1' : '&> /dev/null'
+
+        tests.each do |test|
+          if not system "ruby -I#{paths} #{test} #{null_dev}" then
+            puts "Dependency Issues: #{test}"
+          end
+        end
+      end
 
-    desc 'Show which test files fail when run alone.'
-    task :test_deps do
-      tests = Dir["test/**/test_*.rb"]  +  Dir["test/**/*_test.rb"]
+      default_tasks << :test
+    end
 
-      paths = ['bin', 'lib', 'test'].join(File::PATH_SEPARATOR)
-      null_dev = WINDOZE ? '> NUL 2>&1' : '&> /dev/null'
+    if File.directory? "spec" then
+      begin
+        require 'spec/rake/spectask'
 
-      tests.each do |test|
-        if not system "ruby -I#{paths} #{test} #{null_dev}" then
-          puts "Dependency Issues: #{test}"
+        desc "Run all specifications"
+        Spec::Rake::SpecTask.new(:spec) do |t|
+          t.libs = self.rspec_dirs
+          t.spec_opts = self.rspec_options
         end
+      rescue LoadError
+        # do nothing
+      end
+      default_tasks << :spec
+    end
+
+    desc 'Run the default task(s).'
+    task :default => default_tasks
+
+    begin # take a whack at defining rcov tasks
+      require 'rcov/rcovtask'
+
+      Rcov::RcovTask.new do |t|
+        pattern = ENV['PATTERN'] || 'test/test_*.rb'
+
+        t.test_files = FileList[pattern]
+        t.verbose = true
+        t.rcov_opts << "--threshold 80"
+        t.rcov_opts << "--no-color"
+        t.rcov_opts << "-x ^/"
       end
+
+      # this is for autotest's rcov... also used by my emacs integration
+      task :rcov_info do
+        pattern = ENV['PATTERN'] || "test/test_*.rb"
+        ruby "-Ilib -S rcov --text-report --save coverage.info --test-unit-only #{pattern}"
+      end
+
+      # this is for my emacs rcov overlay stuff on emacswiki.
+      task :rcov_overlay do
+        rcov, eol = Marshal.load(File.read("coverage.info")).last[ENV["FILE"]], 1
+        puts rcov[:lines].zip(rcov[:coverage]).map { |line, coverage|
+          bol, eol = eol, eol + line.length
+          [bol, eol, "#ffcccc"] unless coverage
+        }.compact.inspect
+      end
+    rescue LoadError
+      # skip
     end
 
-    desc 'Run the test suite using multiruby.'
-    task :multi do
-      run_tests :multi
+    desc "Analyze for code duplication."
+    task :flay do
+      sh "find lib test -name \*.rb | xargs flay"
+    end
+
+    desc "Analyze code complexity."
+    task :flog do
+      print "lib : "
+      sh "flog -s lib"
+
+      if File.directory? "test" then
+        print "test: "
+        sh "flog -s test"
+      end
+
+      if File.directory? "spec" then
+        print "spec: "
+        sh "flog -s spec"
+      end
     end
 
     ############################################################
@@ -521,8 +624,11 @@ class Hoe
       dirs = Dir['{lib,ext}']
       s.require_paths = dirs unless dirs.empty?
 
-      s.rdoc_options = ['--main', 'README.txt']
-      s.extra_rdoc_files = s.files.grep(/txt$/)
+      s.rdoc_options = ['--main', readme_file]
+
+      s.extra_rdoc_files += s.files.grep(/txt$/)
+      s.extra_rdoc_files.reject! { |f| f =~ %r%^(test|spec|vendor|template|data|tmp)/% }
+      s.extra_rdoc_files += @extra_rdoc_files
       s.has_rdoc = true
 
       s.post_install_message = post_install_message
@@ -530,7 +636,7 @@ class Hoe
       if test ?f, "test/test_all.rb" then
         s.test_file = "test/test_all.rb"
       else
-        s.test_files = Dir[*test_globs]
+        s.test_files = Dir[*self.test_globs]
       end
 
       if signing_key and cert_chain then
@@ -589,8 +695,8 @@ class Hoe
       puts spec.to_ruby
     end
 
-    self.lib_files = spec.files.grep(/^(lib|ext)/)
-    self.bin_files = spec.files.grep(/^bin/)
+    self.lib_files  = spec.files.grep(/^(lib|ext)/)
+    self.bin_files  = spec.files.grep(/^bin/)
     self.test_files = spec.files.grep(/^test/)
 
     Rake::GemPackageTask.new spec do |pkg|
@@ -599,7 +705,7 @@ class Hoe
     end
 
     desc 'Install the package as a gem.'
-    task :install_gem => [:clean, :package] do
+    task :install_gem => [:clean, :package, :check_extra_deps] do
       gem = Dir['pkg/*.gem'].first
       sh "#{'sudo ' unless WINDOZE}gem install --local #{gem}"
     end
@@ -636,18 +742,18 @@ class Hoe
     # Doco
 
     Rake::RDocTask.new(:docs) do |rd|
-      rd.main = "README.txt"
-      rd.options << '-d' if
-        `which dot` =~ /\/dot/ unless ENV['NODOT'] unless WINDOZE
+      rd.main = readme_file
+      rd.options << '-d' if (`which dot` =~ /\/dot/) unless
+        ENV['NODOT'] || WINDOZE
       rd.rdoc_dir = 'doc'
-      files = spec.files.grep(rdoc_pattern)
-      files -= ['Manifest.txt']
-      rd.rdoc_files.push(*files)
+
+      rd.rdoc_files += spec.require_paths
+      rd.rdoc_files += spec.extra_rdoc_files
 
       title = "#{name}-#{version} Documentation"
       title = "#{rubyforge_name}'s " + title if rubyforge_name != name
 
-      rd.options << "-t #{title}"
+      rd.options << "-t" << title
     end
 
     desc 'Generate ri locally for testing.'
@@ -809,14 +915,30 @@ class Hoe
       sh "zentest -I=#{libs} #{spec.files.grep(/^(lib|test)/).join(' ')}"
     end
 
+    task :clobber_rcov # in case rcov didn't load
+
     desc 'Clean up all the extras.'
-    task :clean => [ :clobber_docs, :clobber_package ] do
+    task :clean => [ :clobber_docs, :clobber_package, :clobber_rcov ] do
       clean_globs.each do |pattern|
         files = Dir[pattern]
         rm_rf files, :verbose => true unless files.empty?
       end
     end
 
+    desc 'Install missing dependencies.'
+    task :check_extra_deps do
+      # extra_deps = [["rubyforge", ">= 1.0.0"], ["rake", ">= 0.8.1"]]
+      extra_deps.each do |dep|
+        begin
+          gem(*dep)
+        rescue Gem::LoadError
+          dep_gem, dep_version = dep
+          dep_version = "--version '#{dep_version}'" if dep_version
+          sh "#{'sudo ' unless WINDOZE}gem install #{dep_gem} #{dep_version}"
+        end
+      end
+    end
+
     desc 'Create a fresh ~/.hoerc file.'
     task :config_hoe do
       with_config do |config, path|
@@ -975,6 +1097,24 @@ class Hoe
 
   end # end define
 
+  def run_tests(multi=false) # :nodoc:
+    framework = SUPPORTED_TEST_FRAMEWORKS[testlib]
+    raise "unsupported test framework #{testlib}" unless framework
+
+    tests = ["rubygems", framework] +
+      test_globs.map { |g| Dir.glob(g) }.flatten
+    tests.map! {|f| %(require "#{f}")}
+
+    cmd = "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
+
+    if multi then
+      ENV['EXCLUDED_VERSIONS'] = multiruby_skip.join ":"
+      cmd = "-S multiruby #{cmd}"
+    end
+
+    ruby cmd
+  end
+
   def announcement # :nodoc:
     changes = self.changes.rdoc_to_markdown
     subject = "#{name} #{version} Released"
@@ -985,24 +1125,6 @@ class Hoe
     return subject, title, body, urls
   end
 
-  def run_tests(multi=false) # :nodoc:
-    msg = multi ? :sh : :ruby
-    cmd = if test ?f, 'test/test_all.rb' then
-            "#{RUBY_FLAGS} test/test_all.rb #{FILTER}"
-          else
-            tests = ["rubygems", self.testlib] +
-              test_globs.map { |g| Dir.glob(g) }.flatten
-            tests.map! {|f| %Q(require "#{f}")}
-            "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
-          end
-
-    excludes = multiruby_skip.join(":")
-    ENV['EXCLUDED_VERSIONS'] = excludes
-    cmd = "multiruby #{cmd}" if multi
-
-    send msg, cmd
-  end
-
   ##
   # Reads a file at +path+ and spits out an array of the +paragraphs+ specified.
   #

data/template/.autotest.erb

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/template/History.txt.erb

@@ -0,0 +1,6 @@
+=== 1.0.0 / <%= Time.new.strftime("%Y-%m-%d") %>
+
+* 1 major enhancement
+
+  * Birthday!
+

data/template/Manifest.txt.erb

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/<%= project %>
+lib/<%= project %>.rb
+test/test_<%= project %>.rb

data/template/README.txt.erb

@@ -0,0 +1,48 @@
+= <%= project %>
+
+* <%= XIF %> (url)
+
+== DESCRIPTION:
+
+<%= XIF %> (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* <%= XIF %> (list of features or problems)
+
+== SYNOPSIS:
+
+  <%= XIF %> (code sample of usage)
+
+== REQUIREMENTS:
+
+* <%= XIF %> (list of requirements)
+
+== INSTALL:
+
+* <%= XIF %> (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) <%= Time.new.strftime("%Y") %> <%= XIF %>
+
+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/template/Rakefile.erb

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/<%= project %>.rb'
+
+Hoe.new('<%= project %>', <%= klass %>::VERSION) do |p|
+  # p.rubyforge_name = '<%= project %>x' # if different than lowercase project name
+  # p.developer('<%= XIF %>', '<%= XIF %>@example.com')
+end
+
+# vim: syntax=Ruby

data/template/bin/file_name.erb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/template/lib/file_name.rb.erb

@@ -0,0 +1,3 @@
+class <%= klass %>
+  VERSION = '1.0.0'
+end

data/template/test/test_file_name.rb.erb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "<%= file_name %>"
+
+class Test<%= klass %> < Test::Unit::TestCase
+  def test_sanity
+    flunk "write tests or I will kneecap you"
+  end
+end

data/test/test_hoe.rb

@@ -14,9 +14,15 @@ class TestHoe < Test::Unit::TestCase
   # everything is forked out.
 
   def test_basics
-    boring   = %w(clobber_docs clobber_package gem redocs repackage)
+    boring   = %w(clobber_docs
+                  clobber_package
+                  clobber_rcov
+                  gem
+                  redocs
+                  repackage)
     expected = %w(audit
                   announce
+                  check_extra_deps
                   check_manifest
                   clean
                   config_hoe
@@ -27,6 +33,8 @@ class TestHoe < Test::Unit::TestCase
                   deps:list
                   docs
                   email
+                  flay
+                  flog
                   generate_key
                   install_gem
                   multi
@@ -34,6 +42,7 @@ class TestHoe < Test::Unit::TestCase
                   post_blog
                   post_news
                   publish_docs
+                  rcov
                   release
                   ridocs
                   test
@@ -63,6 +72,8 @@ class TestHoe < Test::Unit::TestCase
 
     spec = hoe.spec
 
+    text_files = files.grep(/txt$/).reject { |f| f =~ /template/ }
+
     assert_equal 'blah', spec.name
     assert_equal '1.2.3', spec.version.to_s
     assert_equal '>= 0', spec.required_rubygems_version.to_s
@@ -73,7 +84,7 @@ class TestHoe < Test::Unit::TestCase
     assert_match(/Hoe.*Rakefiles/, spec.description)
     assert_equal ['email'], spec.email
     assert_equal ['sow'], spec.executables
-    assert_equal files.grep(/txt$/), spec.extra_rdoc_files
+    assert_equal text_files, spec.extra_rdoc_files
     assert_equal files, spec.files
     assert_equal true, spec.has_rdoc
     assert_equal "http://rubyforge.org/projects/seattlerb/", spec.homepage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hoe
 version: !ruby/object:Gem::Version 
-  version: 1.8.3
+  version: 1.9.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-20 00:00:00 -08:00
+date: 2009-02-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.2
+        version: 1.0.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.8.3
     version: 
-description: "Hoe is a simple rake/rubygems helper for project Rakefiles. It generates all the usual tasks for projects including rdoc generation, testing, packaging, and deployment.  Tasks Provided:  * announce         - Create news email file and post to rubyforge. * audit            - Run ZenTest against the package. * check_manifest   - Verify the manifest. * clean            - Clean up all the extras. * config_hoe       - Create a fresh ~/.hoerc file. * debug_gem        - Show information about the gem. * default          - Run the default tasks. * deps:email       - Print a contact list for gems dependent on this gem * deps:fetch       - Fetch all the dependent gems of this gem into tarballs * deps:list        - List all the dependent gems of this gem * docs             - Build the docs HTML Files * email            - Generate email announcement file. * gem              - Build the gem file hoe-1.8.0.gem * generate_key     - Generate a key for signing your gems. * install_gem      - Install the package as a gem. * multi            - Run the test suite using multiruby. * package          - Build all the packages * post_blog        - Post announcement to blog. * post_news        - Post announcement to rubyforge. * publish_docs     - Publish RDoc to RubyForge. * release          - Package and upload the release to rubyforge. * ridocs           - Generate ri locally for testing. * tasks            - Generate a list of tasks for doco. * test             - Run the test suite. * test_deps        - Show which test files fail when run alone.  See class rdoc for help. Hint: ri Hoe"
+description: "Hoe is a simple rake/rubygems helper for project Rakefiles. It generates all the usual tasks for projects including rdoc generation, testing, packaging, and deployment.  Tasks Provided:  * announce          - Create news email file and post to rubyforge. * audit             - Run ZenTest against the package. * check_extra_deps  - Install missing dependencies. * check_manifest    - Verify the manifest. * clean             - Clean up all the extras. * config_hoe        - Create a fresh ~/.hoerc file. * debug_gem         - Show information about the gem. * default           - Run the default task(s). * deps:email        - Print a contact list for gems dependent on this gem * deps:fetch        - Fetch all the dependent gems of this gem into tarballs * deps:list         - List all the dependent gems of this gem * docs              - Build the docs HTML Files * email             - Generate email announcement file. * flay              - Analyze for code duplication. * flog              - Analyze code complexity. * gem               - Build the gem file hoe-1.9.0.gem * generate_key      - Generate a key for signing your gems. * install_gem       - Install the package as a gem. * multi             - Run the test suite using multiruby. * package           - Build all the packages * post_blog         - Post announcement to blog. * post_news         - Post announcement to rubyforge. * publish_docs      - Publish RDoc to RubyForge. * rcov              - Analyze code coverage with tests * release           - Package and upload the release to rubyforge. * ridocs            - Generate ri locally for testing. * tasks             - Generate a list of tasks for doco. * test              - Run the test suite. * test_deps         - Show which test files fail when run alone.  See class rdoc for help. Hint: ri Hoe"
 email: 
 - ryand-ruby@zenspider.com
 executables: 
@@ -50,6 +50,14 @@ files:
 - Rakefile
 - bin/sow
 - lib/hoe.rb
+- template/.autotest.erb
+- template/History.txt.erb
+- template/Manifest.txt.erb
+- template/README.txt.erb
+- template/Rakefile.erb
+- template/bin/file_name.erb
+- template/lib/file_name.rb.erb
+- template/test/test_file_name.rb.erb
 - test/test_hoe.rb
 has_rdoc: true
 homepage: http://rubyforge.org/projects/seattlerb/