hoe 1.0.4 → 1.0.5

data/History.txt

@@ -1,3 +1,14 @@
+= 1.0.5 2006-10-03
+
+* Doco cleanup.
+* Removed Manifest.txt from rdoc and added title.
+* Added changeset support.
+* Added spec_extras for easy gemspec attribute setting.
+* Added release_notes, changeset setting for releases.
+* Added paragraphs_of utility method.
+* Added email and rubyforge news announcement tasks.
+* Url attribute may now be an array of urls.
+
 = 1.0.4 2006-09-23
 
 * Damnit... I messed up. There is no rubygems gem to be dependent upon. Duh.

data/README.txt

@@ -35,7 +35,7 @@ See class rdoc for help. Hint: ri Hoe
 
 == SYNOPSYS:
 
-  require './lib/hoe.rb'
+  require 'hoe'
   
   Hoe.new(projectname, version) do |p|
     # ... project specific data ...

data/Rakefile

@@ -5,6 +5,9 @@ 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."
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
 end
 
 # vim: syntax=Ruby

data/lib/hoe.rb

@@ -50,21 +50,26 @@ require 'rbconfig'
 #
 # The attributes that you can provide inside the new block above are:
 #
-# ==== Mandatory (or damn good to set)
+# ==== Mandatory
+#
+# * name        - The name of the release.
+# * version     - The version. Don't hardcode! use a constant in the project.
+#
+# ==== Damn Good to Set
 #
 # * author      - The author of the package. (can be array of authors)
+# * changes     - A description of the release's latest changes.
 # * description - A description of the project.
-# * email       - The author's email address.
-# * name        - The name of the release.
+# * email       - The author's email address. (can be array of urls)
 # * 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]
+# * spec_extras    - A hash of extra values to set in the gemspec.
 #
 # === Environment Variables
 #
@@ -74,7 +79,7 @@ require 'rbconfig'
 # * FILTER     - Used to add flags to test_unit (e.g., -n test_borked)
 
 class Hoe
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 
   rubyprefix = Config::CONFIG['prefix']
   sitelibdir = Config::CONFIG['sitelibdir']
@@ -91,7 +96,7 @@ class Hoe
     (RUBY_DEBUG ? " #{RUBY_DEBUG}" : '')
   FILTER = ENV['FILTER'] # for tests (eg FILTER="-n test_blah")
 
-  attr_accessor :author, :bin_files, :clean_globs, :description, :email, :extra_deps, :lib_files, :name, :rubyforge_name, :spec, :summary, :test_files, :url, :version
+  attr_accessor :author, :bin_files, :changes, :clean_globs, :description, :email, :extra_deps, :lib_files, :name, :rubyforge_name, :spec, :spec_extras, :summary, :test_files, :url, :version
 
   def initialize(name, version)
     self.name = name
@@ -102,16 +107,18 @@ 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 ri *.gem **/*~)
+    self.clean_globs = %w(diff diff.txt demo.rb email.txt ri *.gem **/*~)
+    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.extra_deps = []
+    self.spec_extras = {}
 
     if name == 'hoe' then
       extra_deps << ['rake']
-      extra_deps << ['rubyforge']
+      extra_deps << ['rubyforge', '>= 0.3.0']
     else
-      extra_deps << ['hoe']
+      extra_deps << ['hoe', ">= #{VERSION}"]
     end
 
     yield self if block_given?
@@ -147,7 +154,7 @@ class Hoe
         s.author = author
       end
       s.email = email
-      s.homepage = url
+      s.homepage = Array(url).first
       s.rubyforge_project = rubyforge_name
 
       s.description = description
@@ -156,6 +163,10 @@ class Hoe
         s.add_dependency(*dep)
       end
 
+      spec_extras.each do |msg, val|
+        s.send "#{msg}=", val
+      end
+
       s.files = File.read("Manifest.txt").split
       s.executables = s.files.grep(/bin/) { |f| File.basename(f) }
 
@@ -216,6 +227,12 @@ class Hoe
       rf = RubyForge.new
       puts "Logging in"
       rf.login
+
+      c = rf.config
+      c["release_notes"] = description if description
+      c["release_changes"] = changes if changes
+      c["preformatted"] = true
+
       puts "Releasing #{name} v. #{version} tarball"
       release_id = rf.add_release rubyforge_name, name, version, "#{pkg}.tgz"
       if release_id then
@@ -232,9 +249,16 @@ class Hoe
 
     Rake::RDocTask.new(:docs) do |rd|
       rd.main = "README.txt"
-      rd.options << '-d' if `which dot` =~ /\/dot/ and RUBY_PLATFORM !~ /win32/
+      rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/
       rd.rdoc_dir = 'doc'
-      rd.rdoc_files.push(*spec.files.grep(/^(lib|bin)|txt$/))
+      files = spec.files.grep(/^(lib|bin)|txt$/)
+      files -= ['Manifest.txt']
+      rd.rdoc_files.push(*files)
+
+      title = "#{name}-#{version} Documentation"
+      title = "#{rubyforge_name}'s " + title if rubyforge_name != title
+
+      rd.options << "-t #{title}"
     end
 
     desc "Generate ri locally for testing"
@@ -279,21 +303,69 @@ class Hoe
         rm_rf files unless files.empty?
       end
     end
+
+    desc 'Generate email announcement file.'
+    task :email do
+      require 'rubyforge'
+      subject, body = announcement
+
+      File.open("email.txt", "w") do |mail|
+        mail.puts subject
+        mail.puts
+        mail.puts body
+      end
+      puts "Created email.txt"
+    end
+
+    desc 'Post announcement to rubyforge.'
+    task :post_news do
+      require 'rubyforge'
+      subject, body = announcement
+
+      rf = RubyForge.new
+      rf.login
+      rf.post_news(rubyforge_name, subject, body)
+      puts "Posted to rubyforge"
+    end
+
+    desc 'Generate email announcement file and post to rubyforge.'
+    task :announce => [:email, :post_news]
+
   end # end define
 
-  def run_tests(multi=false)
+  def announcement
+    urls = "  " + Array(url).map {|s| s.strip}.join("\n  ")
+
+    subject = "Subject: #{name} #{version} Released"
+    body = "#{name} version #{version} has been released!\n\n#{urls}\n\n#{description}\n\nChanges:\n\n#{changes}\n\n#{urls}\n"
+
+    return subject, body
+  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 = (Dir.glob("test/**/test_*.rb") + ['test/unit']).map { |f|
-        "require \"#{f}\""
-      }
+            tests = ((Dir.glob("test/**/test_*.rb") + ['test/unit']).map { |f|
+                       "require \"#{f}\""
+                     })
             "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
           end
     cmd = "multiruby #{cmd}" if multi
     send msg, cmd
   end
+
+  ##
+  # Reads a file at +path+ and spits out an array of the +paragraphs+ specified
+  #
+  #   changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  #   summary, *description = p.paragraphs_of('Readme.txt', 3, 3..8)
+
+  def paragraphs_of(path, *paragraphs)
+    file = File.read(path)
+    file.split(/\n\n+/).values_at(*paragraphs)
+  end
 end
 
 class ::Rake::SshDirPublisher # :nodoc:

data/test/test_hoe.rb

@@ -9,9 +9,13 @@ class TestHoe < Test::Unit::TestCase
     Rake.application.clear
   end
 
+  ##
+  # Yes, these tests suck, but it is damn hard to test this since
+  # everything is forked out.
+
   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 = %w(audit announce clean debug_gem default docs email gem install multi package post_news publish_docs release ridocs test uninstall)
     expected += boring
 
     Hoe.new('blah', '1.0.0')

metadata

@@ -3,16 +3,16 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: hoe
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
-date: 2006-09-23 00:00:00 -07:00
+  version: 1.0.5
+date: 2006-10-03 00:00:00 -07:00
 summary: Hoe is a way to write Rakefiles much easier and cleaner.
 require_paths: 
 - lib
 - test
 email: ryand-ruby@zenspider.com
-homepage: http://www.zenspider.com/ZSS/Products/hoe/
+homepage: "    http://rubyforge.org/projects/seattlerb/"
 rubyforge_project: seattlerb
-description: Ryan Davis is too lazy to write a 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.  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"
 autorequire: 
 default_executable: 
 bindir: bin
@@ -63,7 +63,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: 0.3.0
     version: