hoe 1.0.2 → 1.0.4

data/History.txt

@@ -1,3 +1,20 @@
+= 1.0.4 2006-09-23
+
+* Damnit... I messed up. There is no rubygems gem to be dependent upon. Duh.
+
+= 1.0.3 2006-09-23
+
+* Added debug_gem rule.
+* Added lots of doco.
+* Added proper deps to hoe for other's gems, and rake/rubyforge/rubygems for hoe.
+* Added ridocs to generate ri locally for testing.
+* Added support for multiple authors.
+* Fixed include paths.
+* Rdoc now includes any top level .txt files.
+* Renamed deploy to release.
+* Renamed upload to publish_docs.
+* publish_docs is now smart about subprojects and missing subdirectories.
+
 = 1.0.2 2006-09-20
 
 * Wee little tests.

data/README.txt

@@ -1,47 +1,39 @@
 Hoe
     http://rubyforge.org/projects/seattlerb/
+    http://seattlerb.rubyforge.org/hoe/
     ryand-ruby@zenspider.com
 
-** DESCRIPTION:
+== 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.
 
-As an example:
-
-  require './lib/hoe.rb'
-  
-  Hoe.new("Hoe", Hoe::VERSION) do |p|
-    p.rubyforge_name = "seattlerb"
-    p.summary = "Hoe is a way to write Rakefiles much easier and cleaner."
-  end
-
-generates:
-
-  % rake -T
-  rake audit            # Run ZenTest against the package
-  rake clean            # Clean up all the extras
-  rake clobber_docs     # Remove rdoc products
-  rake clobber_package  # Remove package products
-  rake default          # Run the default tasks
-  rake docs             # Build the docs HTML Files
-  rake install          # Install the package. Uses PREFIX and RUBYLIB
-  rake multi            # Run the test suite using multiruby
-  rake package          # Build all the packages
-  rake redocs           # Force a rebuild of the RDOC files
-  rake repackage        # Force a rebuild of the package files
-  rake test             # Run the test suite. Use FILTER to add to the command line.
-  rake uninstall        # Uninstall the package.
-  rake upload           # Upload RDoc to RubyForge
-
-** FEATURES/PROBLEMS:
+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
+* 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
+
+See class rdoc for help. Hint: ri Hoe
+
+== FEATURES/PROBLEMS:
   
-+ Really basic and rather specific to Seattle.rb/ZenSpider projects
-+ Will become cleaner/better very quickly.
-+ At some point it will have tests and stuff.
+* Really basic and rather specific to Seattle.rb/ZenSpider projects
+* Will become cleaner/better very quickly.
+* At some point it will have real tests and stuff.
 
-** SYNOPSYS:
+== SYNOPSYS:
 
   require './lib/hoe.rb'
   
@@ -51,16 +43,17 @@ generates:
 
   # ... project specific tasks ...
 
-** REQUIREMENTS:
+== REQUIREMENTS:
 
-+ rake
-+ rubygems
+* rake
+* rubyforge
+* rubygems
 
-** INSTALL:
+== INSTALL:
 
-+ sudo gem install hoe
+* sudo gem install hoe
 
-** LICENSE:
+== LICENSE:
 
 (The MIT License)
 

data/lib/hoe.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 
-begin require 'rubygems'; rescue LoadError; end
+require 'rubygems'
 require 'rake'
 require 'rake/contrib/sshpublisher'
 require 'rake/gempackagetask'
@@ -8,8 +8,73 @@ require 'rake/rdoctask'
 require 'rake/testtask'
 require 'rbconfig'
 
+##
+# hoe - a tool to help rake
+#
+# 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.
+#
+# == Using Hoe
+#
+# === Basics
+#
+# Use this as a minimal starting point:
+#
+#   require 'hoe'
+# 
+#   Hoe.new("project_name", '1.0.0') do |p|
+#     p.rubyforge_name = "rf_project"
+#     # add other details here
+#   end
+#
+#   # add other tasks here
+#
+# === 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
+# * 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
+#
+# === Attributes
+#
+# The attributes that you can provide inside the new block above are:
+#
+# ==== Mandatory (or damn good to set)
+#
+# * author      - The author of the package. (can be array of authors)
+# * description - A description of the project.
+# * email       - The author's email address.
+# * name        - The name of the release.
+# * summary     - A short summary of the project.
+# * url         - The url of the project.
+# * version     - The version. Don't hardcode! use a constant in the project.
+#
+# ==== Optional
+#
+# * clean_globs    - An array of file patterns to delete on clean.
+# * extra_deps     - An array of rubygem dependencies.
+# * rubyforge_name - The name of the rubyforge project. [default: name.downcase]
+#
+# === Environment Variables
+#
+# * 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)
+
 class Hoe
-  VERSION = '1.0.2'
+  VERSION = '1.0.4'
 
   rubyprefix = Config::CONFIG['prefix']
   sitelibdir = Config::CONFIG['sitelibdir']
@@ -22,7 +87,7 @@ class Hoe
             end
   RUBY_DEBUG = ENV['RUBY_DEBUG']
   RUBY_FLAGS = ENV['RUBY_FLAGS'] ||
-    "-w -I#{%w(lib bin ../../RubyInline/dev).join(File::PATH_SEPARATOR)}" +
+    "-w -I#{%w(lib bin test).join(File::PATH_SEPARATOR)}" +
     (RUBY_DEBUG ? " #{RUBY_DEBUG}" : '')
   FILTER = ENV['FILTER'] # for tests (eg FILTER="-n test_blah")
 
@@ -37,10 +102,17 @@ class Hoe
     self.url = "http://www.zenspider.com/ZSS/Products/#{name}/"
     self.author = "Ryan Davis"
     self.email = "ryand-ruby@zenspider.com"
-    self.clean_globs = %w(diff diff.txt demo.rb *.gem **/*~)
+    self.clean_globs = %w(diff diff.txt demo.rb ri *.gem **/*~)
     self.description = "#{author} is too lazy to write a description"
     self.summary = "#{author} is too lazy to write a summary"
-    self.extra_deps = [name == 'hoe' ? 'rake' : 'hoe']
+    self.extra_deps = []
+
+    if name == 'hoe' then
+      extra_deps << ['rake']
+      extra_deps << ['rubyforge']
+    else
+      extra_deps << ['hoe']
+    end
 
     yield self if block_given?
 
@@ -68,7 +140,12 @@ class Hoe
       s.name = name
       s.version = version
       s.summary = summary
-      s.author = author
+      case author
+      when Array
+        s.authors = author
+      else
+        s.author = author
+      end
       s.email = email
       s.homepage = url
       s.rubyforge_project = rubyforge_name
@@ -86,8 +163,11 @@ class Hoe
       s.require_paths = Dir['{lib,test}']
       s.has_rdoc = true
       s.test_suite_file = "test/test_all.rb" if test ?f, "test/test_all.rb"
+    end
 
-      puts s.to_ruby if $DEBUG
+    desc 'Show information about the gem.'
+    task :debug_gem do
+      puts spec.to_ruby
     end
 
     self.lib_files = spec.files.grep(/^lib/)
@@ -121,8 +201,8 @@ class Hoe
       end
     end
 
-    desc 'Deploy the package to rubyforge.'
-    task :deploy => [:clean, :package] do |t|
+    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"
       abort "Versions don't match #{v} vs #{version}" if v != version
       require 'rubyforge'
@@ -154,16 +234,32 @@ class Hoe
       rd.main = "README.txt"
       rd.options << '-d' if `which dot` =~ /\/dot/ and RUBY_PLATFORM !~ /win32/
       rd.rdoc_dir = 'doc'
-      rd.rdoc_files.push(*spec.files.grep(/^(lib|bin|READ|Hist)/))
+      rd.rdoc_files.push(*spec.files.grep(/^(lib|bin)|txt$/))
     end
 
-    desc 'Upload RDoc to RubyForge'
-    task :upload => [:clean, :docs] do
+    desc "Generate ri locally for testing"
+    task :ridocs => :clean do
+      sh %q{ rdoc --ri -o ri . }
+    end
+
+    desc 'Publish RDoc to RubyForge'
+    task :publish_docs => [:clean, :docs] do
       config = YAML.load(File.read(File.expand_path("~/.rubyforge/config.yml")))
-      user = "#{config["username"]}rubyforge.org"
+      user = "#{config["username"]}@rubyforge.org"
       project = "/var/www/gforge-projects/#{rubyforge_name}"
+      project += "/#{name}" if rubyforge_name != name
       local_dir = 'doc'
       pub = Rake::SshDirPublisher.new user, project, local_dir
+      if rubyforge_name != name then
+        def pub.upload
+          begin
+            super
+          rescue
+            # project directory probably doesn't exist, transfer as a whole
+            sh %{scp -qr #{local_dir} #{host}:#{remote_dir}}
+          end
+        end
+      end
       pub.upload
     end
 
@@ -199,3 +295,7 @@ class Hoe
     send msg, cmd
   end
 end
+
+class ::Rake::SshDirPublisher # :nodoc:
+  attr_reader :host, :remote_dir, :local_dir
+end

data/test/test_hoe.rb

@@ -10,9 +10,13 @@ class TestHoe < Test::Unit::TestCase
   end
 
   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 clean debug_gem default docs gem install multi package publish_docs release ridocs test uninstall)
+    expected += boring
+
     Hoe.new('blah', '1.0.0')
     tasks = Rake.application.tasks.map { |t| t.name }.sort
-    expected = ["audit", "clean", "clobber", "clobber_docs", "clobber_package", "default", "deploy", "doc", "doc/index.html", "docs", "gem", "install", "multi", "package", "pkg", "pkg/blah-1.0.0", "pkg/blah-1.0.0.gem", "pkg/blah-1.0.0.tgz", "redocs", "repackage", "test", "uninstall", "upload"]
-    assert_equal expected, tasks
+
+    assert_equal expected.sort, tasks
   end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: hoe
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
-date: 2006-09-20 00:00:00 -07:00
+  version: 1.0.4
+date: 2006-09-23 00:00:00 -07:00
 summary: Hoe is a way to write Rakefiles much easier and cleaner.
 require_paths: 
 - lib
@@ -58,3 +58,12 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: