hoe 1.1.2 → 1.1.3

data/History.txt

@@ -1,4 +1,13 @@
-= 1.1.2
+= 1.1.3 2006-11-09
+
+* Added test_deps, now you can automatically discover test dependency ommisions.
+* Added ext support! Build C extensions with hoe!
+* Gemspec uses test_all.rb or result of test_globs. Tweak those tests.
+* Now uses https to login to rubyforge. Rubyforge crackers beware!
+* Fixed doco and automated updating of it.
+* Added rdoc_pattern. Go doco go!
+
+= 1.1.2 2006-10-22
 
 * Added -d and -t flags to sow to make dev or trunk subdirs for p4 and svn projects.
 * Added install_gem to further test gem builds.

data/README.txt

@@ -11,23 +11,25 @@ testing, packaging, and deployment.
 
 Tasks Provided:
 
-* announce       - Generate email announcement file and post to rubyforge.
-* audit          - Run ZenTest against the package
-* check_manifest - Verify the manifest
-* clean          - Clean up all the extras
-* debug_gem      - Show information about the gem.
-* default        - Run the default tasks
-* docs           - Build the docs HTML Files
-* email          - Generate email announcement file.
-* install        - Install the package. Uses PREFIX and RUBYLIB
-* multi          - Run the test suite using multiruby
-* package        - Build all the packages
-* 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
-* test           - Run the test suite. Use FILTER to add to the command line.
-* uninstall      - Uninstall the package.
+* announce         - Generate email announcement file and post to rubyforge.
+* audit            - Run ZenTest against the package
+* check_manifest   - Verify the manifest
+* clean            - Clean up all the extras
+* debug_gem        - Show information about the gem.
+* default          - Run the default tasks
+* docs             - Build the docs HTML Files
+* email            - Generate email announcement file.
+* install          - Install the package. Uses PREFIX and RUBYLIB
+* install_gem      - Install the package as a gem
+* multi            - Run the test suite using multiruby
+* package          - Build all the packages
+* 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
+* test             - Run the test suite. Use FILTER to add to the command line.
+* test_deps        - Show which test files fail when run alone.
+* uninstall        - Uninstall the package.
 
 See class rdoc for help. Hint: ri Hoe
 

data/bin/sow

@@ -50,7 +50,7 @@ Dir.chdir project do
 
   files = {
     "History.txt" => "== 1.0.0 / #{Time.new.strftime("%Y-%m-%d")}\n\n* 1 major enhancement\n  * Birthday!\n\n",
-    "README.txt" => "#{project}\n    by #{X}\n    #{X}\n\n== DESCRIPTION:\n  \n#{X}\n\n== FEATURES/PROBLEMS:\n  \n* #{X}\n\n== SYNOPSYS:\n\n    #{X}\n\n== REQUIREMENTS:\n\n+ #{X}\n\n== INSTALL:\n\n+ #{X}\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",
+    "README.txt" => "#{project}\n    by #{X} (your name)\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== SYNOPSYS:\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",

data/lib/hoe.rb

@@ -32,20 +32,25 @@ require 'rbconfig'
 #
 # === Tasks Provided:
 # 
-# * audit        - Run ZenTest against the package
-# * clean        - Clean up all the extras
-# * debug_gem    - Show information about the gem
-# * default      - Run the default tasks
-# * docs         - Build the docs HTML Files
-# * install      - Install the package. Uses PREFIX and RUBYLIB
-# * install_gem  - Install the package as a gem.
-# * multi        - Run the test suite using multiruby
-# * package      - Build all the packages
-# * publish_docs - Publish RDoc to RubyForge
-# * release      - Package and upload the release to RubyForge
-# * test         - Run the test suite. Use FILTER to add to the command line.
-# * uninstall    - Uninstall the package.
-# * upload       - Upload RDoc to RubyForge
+# * announce         - Generate email announcement file and post to rubyforge.
+# * audit            - Run ZenTest against the package
+# * check_manifest   - Verify the manifest
+# * clean            - Clean up all the extras
+# * debug_gem        - Show information about the gem.
+# * default          - Run the default tasks
+# * docs             - Build the docs HTML Files
+# * email            - Generate email announcement file.
+# * install          - Install the package. Uses PREFIX and RUBYLIB
+# * install_gem      - Install the package as a gem
+# * multi            - Run the test suite using multiruby
+# * package          - Build all the packages
+# * 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
+# * test             - Run the test suite. Use FILTER to add to the command line.
+# * test_deps        - Show which test files fail when run alone.
+# * uninstall        - Uninstall the package.
 #
 # === Attributes
 #
@@ -68,20 +73,21 @@ require 'rbconfig'
 # ==== Optional
 #
 # * clean_globs    - An array of file patterns to delete on clean.
-# * test_globs     - An array of test file patterns [default: test/**/test_*.rb]
 # * extra_deps     - An array of rubygem dependencies.
+# * rdoc_pattern   - A regexp to match documentation files against the manifest.
 # * rubyforge_name - The name of the rubyforge project. [default: name.downcase]
 # * spec_extras    - A hash of extra values to set in the gemspec.
+# * test_globs     - An array of test file patterns [default: test/**/test_*.rb]
 #
 # === Environment Variables
 #
+# * FILTER     - Used to add flags to test_unit (e.g., -n test_borked)
 # * PREFIX     - Used to specify a custom install location (for rake install).
-# * RUBY_FLAGS - Used to specify flags to ruby [has smart default].
 # * RUBY_DEBUG - Used to add extra flags to RUBY_FLAGS.
-# * FILTER     - Used to add flags to test_unit (e.g., -n test_borked)
+# * RUBY_FLAGS - Used to specify flags to ruby [has smart default].
 
 class Hoe
-  VERSION = '1.1.2'
+  VERSION = '1.1.3'
 
   rubyprefix = Config::CONFIG['prefix']
   sitelibdir = Config::CONFIG['sitelibdir']
@@ -94,11 +100,11 @@ class Hoe
             end
   RUBY_DEBUG = ENV['RUBY_DEBUG']
   RUBY_FLAGS = ENV['RUBY_FLAGS'] ||
-    "-w -I#{%w(lib bin test).join(File::PATH_SEPARATOR)}" +
+    "-w -I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}" +
     (RUBY_DEBUG ? " #{RUBY_DEBUG}" : '')
   FILTER = ENV['FILTER'] # for tests (eg FILTER="-n test_blah")
 
-  attr_accessor :author, :bin_files, :changes, :clean_globs, :description, :email, :extra_deps, :lib_files, :name, :rubyforge_name, :spec, :spec_extras, :summary, :test_files, :test_globs, :url, :version
+  attr_accessor :author, :bin_files, :changes, :clean_globs, :description, :email, :extra_deps, :lib_files, :name, :rdoc_pattern, :rubyforge_name, :spec, :spec_extras, :summary, :test_files, :test_globs, :url, :version
 
   def initialize(name, version)
     self.name = name
@@ -114,12 +120,13 @@ class Hoe
     self.changes = "#{author} is too lazy to write a changeset"
     self.description = "#{author} is too lazy to write a description"
     self.summary = "#{author} is too lazy to write a summary"
+    self.rdoc_pattern = /^(lib|bin)|txt$/
     self.extra_deps = []
     self.spec_extras = {}
 
     if name == 'hoe' then
       extra_deps << ['rake']
-      extra_deps << ['rubyforge', '>= 0.3.0']
+      extra_deps << ['rubyforge', '>= 0.3.1']
     else
       extra_deps << ['hoe', ">= #{VERSION}"]
     end
@@ -138,6 +145,17 @@ class Hoe
       run_tests
     end
 
+    desc 'Show which test files fail when run alone.'
+    task :test_deps do
+      tests = Dir["test/**/test_*.rb"]  +  Dir["test/**/*_test.rb"]
+      
+      tests.each do |test|
+        if not system "ruby -Ibin:lib:test #{test} &> /dev/null" then
+          puts "Dependency Issues: #{test}"
+        end
+      end
+    end
+
     desc 'Run the test suite using multiruby'
     task :multi do
       run_tests :multi
@@ -174,10 +192,15 @@ class Hoe
       s.executables = s.files.grep(/bin/) { |f| File.basename(f) }
 
       s.bindir = "bin"
-      dirs = Dir['{lib,test}']
+      dirs = Dir['{lib,ext,test}']
       s.require_paths = dirs unless dirs.empty?
       s.has_rdoc = true
-      s.test_suite_file = "test/test_all.rb" if test ?f, "test/test_all.rb"
+
+      if test ?f, "test/test_all.rb" then
+        s.test_file = "test/test_all.rb"
+      else
+        s.test_files = Dir[*test_globs]
+      end
     end
 
     desc 'Show information about the gem.'
@@ -187,7 +210,7 @@ class Hoe
 
     self.lib_files = spec.files.grep(/^lib/)
     self.bin_files = spec.files.grep(/^bin/)
-    self.test_files = %w(test/test_sexp_processor.rb) # for ruby_to_c's tests.
+    self.test_files = spec.files.grep(/^test/)
 
     Rake::GemPackageTask.new spec do |pkg|
       pkg.need_tar = true
@@ -260,7 +283,7 @@ class Hoe
       rd.main = "README.txt"
       rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/
       rd.rdoc_dir = 'doc'
-      files = spec.files.grep(/^(lib|bin)|txt$/)
+      files = spec.files.grep(rdoc_pattern)
       files -= ['Manifest.txt']
       rd.rdoc_files.push(*files)
 
@@ -371,7 +394,7 @@ class Hoe
     cmd = if test ?f, 'test/test_all.rb' then
             "#{RUBY_FLAGS} test/test_all.rb #{FILTER}"
           else
-            tests = test_globs.map {|g| Dir.glob(g)}.flatten << 'test/unit'
+            tests = test_globs.map { |g| Dir.glob(g) }.flatten << 'test/unit'
             tests.map! {|f| %Q(require "#{f}")}
             "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
           end
@@ -394,3 +417,8 @@ end
 class ::Rake::SshDirPublisher # :nodoc:
   attr_reader :host, :remote_dir, :local_dir
 end
+
+if $0 == __FILE__ then
+  out = `rake -T | egrep -v "redocs|repackage|clobber|trunk"`
+  puts out.gsub(/\#/, '-').gsub(/^rake /, '# * ')
+end

data/test/test_hoe.rb

@@ -15,7 +15,7 @@ class TestHoe < Test::Unit::TestCase
 
   def test_basics
     boring   = %w(clobber clobber_docs clobber_package doc doc/index.html pkg pkg/blah-1.0.0 pkg/blah-1.0.0.gem pkg/blah-1.0.0.tgz redocs repackage)
-    expected = %w(audit announce check_manifest clean debug_gem default docs email gem install install_gem multi package post_news publish_docs release ridocs test uninstall)
+    expected = %w(audit announce check_manifest clean debug_gem default docs email gem install install_gem multi package post_news publish_docs release ridocs test test_deps uninstall)
     expected += boring
 
     Hoe.new('blah', '1.0.0')

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: hoe
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
-date: 2006-10-22 00:00:00 -06:00
+  version: 1.1.3
+date: 2006-11-09 00:00:00 -05:00
 summary: Hoe is a way to write Rakefiles much easier and cleaner.
 require_paths: 
 - lib
@@ -12,7 +12,7 @@ require_paths:
 email: ryand-ruby@zenspider.com
 homepage: "    http://rubyforge.org/projects/seattlerb/"
 rubyforge_project: seattlerb
-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       - Generate email announcement file and post to rubyforge. * audit          - Run ZenTest against the package * check_manifest - Verify the manifest * clean          - Clean up all the extras * debug_gem      - Show information about the gem. * default        - Run the default tasks * docs           - Build the docs HTML Files * email          - Generate email announcement file. * install        - Install the package. Uses PREFIX and RUBYLIB * multi          - Run the test suite using multiruby * package        - Build all the packages * 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 * test           - Run the test suite. Use FILTER to add to the command line. * uninstall      - Uninstall the package.  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         - Generate email announcement file and post to rubyforge. * audit            - Run ZenTest against the package * check_manifest   - Verify the manifest * clean            - Clean up all the extras * debug_gem        - Show information about the gem. * default          - Run the default tasks * docs             - Build the docs HTML Files * email            - Generate email announcement file. * install          - Install the package. Uses PREFIX and RUBYLIB * install_gem      - Install the package as a gem * multi            - Run the test suite using multiruby * package          - Build all the packages * 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 * test             - Run the test suite. Use FILTER to add to the command line. * test_deps        - Show which test files fail when run alone. * uninstall        - Uninstall the package.  See class rdoc for help. Hint: ri Hoe"
 autorequire: 
 default_executable: 
 bindir: bin
@@ -37,8 +37,8 @@ files:
 - bin/sow
 - lib/hoe.rb
 - test/test_hoe.rb
-test_files: []
-
+test_files: 
+- test/test_hoe.rb
 rdoc_options: []
 
 extra_rdoc_files: []
@@ -66,5 +66,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.0
+        version: 0.3.1
     version: