hoe 1.5.0 → 1.5.1

data/History.txt

@@ -1,3 +1,18 @@
+=== 1.5.1 / 2008-03-04
+
+* 2 Minor Enhancements:
+
+  * Removed install/uninstall tasks. Too buggy. Gems do a better job.
+  *	Added cleaning of rbc files to default list
+
+* 5 Bug Fixes:
+
+  * Correctly deal with errors intuiting history and readme files. Thanks Aaron!
+  * Fixed rdoc title. Thanks, Sander!
+  * Fixed sow to match new Rakefile and History format. Thanks, me!
+  *	Moved test/unit to the front for rake test. Fixes use of miniunit.
+  * Renamed shadowed variable.
+
 === 1.5.0 / 2008-01-30
 
 * 9 Minor Enhancements:

data/README.txt

@@ -12,28 +12,27 @@ 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
-* config_hoe       - Create a fresh ~/.hoerc file
-* debug_gem        - Show information about the gem.
-* default          - Run the default tasks
-* docs             - Build the docs HTML Files
-* email            - Generate email announcement file.
-* gem              - Build the gem file only.
-* 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_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
-* 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.
+* 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.
+* docs           - Build the docs HTML Files
+* email          - Generate email announcement file.
+* gem            - Build the gem file hoe-1.5.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.
+* test           - Run the test suite.
+* test_deps      - Show which test files fail when run alone.
 
 See class rdoc for help. Hint: ri Hoe
 

data/Rakefile

@@ -7,4 +7,18 @@ Hoe.new("hoe", Hoe::VERSION) do |hoe|
   hoe.developer("Ryan Davis", "ryand-ruby@zenspider.com")
 end
 
+task :tasks do
+  tasks = `rake -T`.scan(/rake (\w+)\s+# (.*)/)
+  tasks.reject! { |t,d| t =~ /^(clobber|re(package|docs))/ }
+  max   = tasks.map { |x,y| x.size }.max
+
+  tasks.each do |t,d|
+    if ENV['RDOC'] then
+      puts "# %-#{max+2}s %s" % [t + "::", d]
+    else
+      puts "* %-#{max}s - %s" % [t, d]
+    end
+  end
+end
+
 # vim: syntax=Ruby

data/bin/sow

@@ -49,13 +49,13 @@ Dir.chdir project do
   end
 
   files = {
-    "History.txt" => "=== 1.0.0 / #{Time.new.strftime("%Y-%m-%d")}\n\n* 1 major enhancement\n  * Birthday!\n\n",
+    "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 = \'#{group}\'\n  # p.author = '#{X}'\n  # p.email = '#{X}'\n  # p.summary = '#{X}'\n  # p.description = p.paragraphs_of('README.txt', 2..5).join(\"\\n\\n\")\n  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\\n/)[1..-1]\n  p.changes = p.paragraphs_of('History.txt', 0..1).join(\"\\n\\n\")\nend\n\n# vim: syntax=Ruby\n"
+    "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")

data/lib/hoe.rb

@@ -34,28 +34,27 @@ require 'yaml'
 #
 # === 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
-# config_hoe::     Create a fresh ~/.hoerc file
+# 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
+# default::        Run the default tasks.
 # docs::           Build the docs HTML Files
 # email::          Generate email announcement file.
-# gem::            Build the gem file only.
-# install::        Install the package. Uses PREFIX and RUBYLIB
-# install_gem::    Install the package as a gem
-# multi::          Run the test suite using multiruby
+# gem::            Build the gem file hoe-1.5.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
+# 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.
+# ridocs::         Generate ri locally for testing.
+# test::           Run the test suite.
 # test_deps::      Show which test files fail when run alone.
-# uninstall::      Uninstall the package.
 #
 # === Extra Configuration Options:
 #
@@ -117,7 +116,7 @@ require 'yaml'
 #
 
 class Hoe
-  VERSION = '1.5.0'
+  VERSION = '1.5.1'
 
   ruby_prefix = Config::CONFIG['prefix']
   sitelibdir = Config::CONFIG['sitelibdir']
@@ -296,7 +295,8 @@ class Hoe
 
     # Defaults
     self.author = []
-    self.clean_globs = %w(diff diff.txt email.txt ri *.gem **/*~)
+    self.clean_globs = %w(diff diff.txt email.txt ri
+                          *.gem *~ **/*~ *.rbc **/*.rbc)
     self.description_sections = %w(description)
     self.email = []
     self.extra_deps = []
@@ -314,17 +314,23 @@ class Hoe
 
     # Intuit values:
 
-    history  = File.read("History.txt").split(/^(===.*)/)
     readme   = File.read("README.txt").split(/^(=+ .*)$/)[1..-1]
-    sections = readme.map { |s| s =~ /^=/ ? s.strip.downcase.chomp(':').split.last : s.strip }
-    sections = Hash[*sections]
-    desc = sections.values_at(*description_sections).join("\n\n")
-    summ = desc.split(/\.\s+/).first(summary_sentences).join(". ")
-
-    self.description ||= desc
-    self.changes ||= history[0..2].join.strip
-    self.summary ||= summ
-    self.url ||= readme[1].gsub(/^\* /, '').split(/\n/).grep(/\S+/)
+    unless readme.empty? then
+      sections = readme.map { |s|
+        s =~ /^=/ ? s.strip.downcase.chomp(':').split.last : s.strip
+      }
+      sections = Hash[*sections]
+      desc = sections.values_at(*description_sections).join("\n\n")
+      summ = desc.split(/\.\s+/).first(summary_sentences).join(". ")
+
+      self.description ||= desc
+      self.changes ||= File.read("History.txt").split(/^(===.*)/)[1..2].join.strip
+      self.summary ||= summ
+      self.url ||= readme[1].gsub(/^\* /, '').split(/\n/).grep(/\S+/)
+    else
+      warn "** README.txt is in the wrong format for auto-intuiting."
+      warn "   run sow blah and look at it's text files"
+    end
 
     %w(email author).each do |field|
       value = self.send(field)
@@ -346,8 +352,8 @@ class Hoe
     self.extra_deps = Array(extra_deps).map { |o| String === o ? [o] : o }
 
     if name == 'hoe' then
-      hoe_deps.each do |pkg, version|
-        extra_deps << [pkg, version]
+      hoe_deps.each do |pkg, vers|
+        extra_deps << [pkg, vers]
       end
     else
       extra_deps << ['hoe', ">= #{VERSION}"] unless hoe_deps.has_key? name
@@ -369,7 +375,7 @@ class Hoe
       yield(config, rc)
     end
 
-    desc 'Run the default tasks'
+    desc 'Run the default tasks.'
     task :default => :test
 
     desc 'Run the test suite. Use FILTER to add to the command line.'
@@ -388,7 +394,7 @@ class Hoe
       end
     end
 
-    desc 'Run the test suite using multiruby'
+    desc 'Run the test suite using multiruby.'
     task :multi do
       run_tests :multi
     end
@@ -507,34 +513,11 @@ class Hoe
       pkg.need_zip = @need_zip
     end
 
-    desc 'Install the package. Uses PREFIX and RUBYLIB'
-    task :install do
-      [
-       [lib_files + test_files, RUBYLIB, 0444],
-       [bin_files, File.join(PREFIX, 'bin'), 0555]
-      ].each do |files, dest, mode|
-        FileUtils.mkdir_p dest unless test ?d, dest
-        files.each do |file|
-          install file, dest, :mode => mode
-        end
-      end
-    end
-
-    desc 'Install the package as a gem'
+    desc 'Install the package as a gem.'
     task :install_gem => [:clean, :package] do
       sh "#{'sudo ' unless WINDOZE}gem install --local pkg/*.gem"
     end
 
-    desc 'Uninstall the package.'
-    task :uninstall do
-      Dir.chdir RUBYLIB do
-        rm_f((lib_files + test_files).map { |f| File.basename f })
-      end
-      Dir.chdir File.join(PREFIX, 'bin') do
-        rm_f bin_files.map { |f| File.basename f }
-      end
-    end
-
     desc 'Package and upload the release to rubyforge.'
     task :release => [:clean, :package] do |t|
       v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
@@ -575,17 +558,17 @@ class Hoe
       rd.rdoc_files.push(*files)
 
       title = "#{name}-#{version} Documentation"
-      title = "#{rubyforge_name}'s " + title if rubyforge_name != title
+      title = "#{rubyforge_name}'s " + title if rubyforge_name != name
 
       rd.options << "-t #{title}"
     end
 
-    desc "Generate ri locally for testing"
+    desc 'Generate ri locally for testing.'
     task :ridocs => :clean do
       sh %q{ rdoc --ri -o ri . }
     end
 
-    desc "Publish RDoc to RubyForge"
+    desc 'Publish RDoc to RubyForge.'
     task :publish_docs => [:clean, :docs] do
       config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
       host = "#{config["username"]}@rubyforge.org"
@@ -606,13 +589,13 @@ class Hoe
     ############################################################
     # Misc/Maintenance:
 
-    desc 'Run ZenTest against the package'
+    desc 'Run ZenTest against the package.'
     task :audit do
       libs = %w(lib test ext).join(File::PATH_SEPARATOR)
       sh "zentest -I=#{libs} #{spec.files.grep(/^(lib|test)/).join(' ')}"
     end
 
-    desc 'Clean up all the extras'
+    desc 'Clean up all the extras.'
     task :clean => [ :clobber_docs, :clobber_package ] do
       clean_globs.each do |pattern|
         files = Dir[pattern]
@@ -620,7 +603,7 @@ class Hoe
       end
     end
 
-    desc 'Create a fresh ~/.hoerc file'
+    desc 'Create a fresh ~/.hoerc file.'
     task :config_hoe do
       with_config do |config, path|
         default_config = {
@@ -701,10 +684,10 @@ class Hoe
       puts "Posted to rubyforge"
     end
 
-    desc 'Generate email announcement file and post to rubyforge.'
+    desc 'Create news email file and post to rubyforge.'
     task :announce => [:email, :post_news, :post_blog, :publish_on_announce ]
 
-    desc "Verify the manifest"
+    desc 'Verify the manifest.'
     task :check_manifest => :clean do
       f = "Manifest.tmp"
       require 'find'
@@ -791,7 +774,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/unit'] + test_globs.map { |g| Dir.glob(g) }.flatten
             tests.map! {|f| %Q(require "#{f}")}
             "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
           end

data/test/test_hoe.rb

@@ -25,7 +25,6 @@ class TestHoe < Test::Unit::TestCase
                   docs
                   email
                   generate_key
-                  install
                   install_gem
                   multi
                   package
@@ -35,8 +34,7 @@ class TestHoe < Test::Unit::TestCase
                   release
                   ridocs
                   test
-                  test_deps
-                  uninstall)
+                  test_deps)
     expected += boring
 
     spec = Hoe.new('blah', '1.0.0') do |h|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hoe
 version: !ruby/object:Gem::Version 
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors: 
 - Ryan Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-31 00:00:00 -08:00
+date: 2008-03-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.8.1
     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         - 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 * config_hoe       - Create a fresh ~/.hoerc file * debug_gem        - Show information about the gem. * default          - Run the default tasks * docs             - Build the docs HTML Files * email            - Generate email announcement file. * gem              - Build the gem file only. * 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_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 * 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"
+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. * docs           - Build the docs HTML Files * email          - Generate email announcement file. * gem            - Build the gem file hoe-1.5.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. * 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: