hoe 2.1.0 → 2.2.0

data/History.txt

@@ -1,3 +1,22 @@
+=== 2.2.0 / 2009-06-17
+
+* 8 minor enhancements:
+
+  * Alter task descriptions to say what plugin they come from. jbarnette
+  * Fix and improve generate_key task.  Patch #20441 by Matthew Kent.
+  * Hoe.plugin can take multiple names. jbarnette
+  * Increase configurability of RDoc tasks.  Patch #19597 by Sylvain Joyeux.
+  * Refactored and renamed email task to debug_email, removed from announce.
+  * Removed email task from announce task.
+  * Switched to seattlerb plugin
+  * check_extra_deps now installs developer dependencies as well
+
+* 3 bug fixes:
+
+  * Fixed blogs entry in DEFAULT_CONFIG.
+  * activated but missing plugins are properly skipped now
+  * exclude field was missing from DEFAULT_CONFIG
+
 === 2.1.0 / 2009-06-14
 
 * 6 minor enhancements:

data/Rakefile

@@ -1,9 +1,10 @@
 # -*- ruby -*-
 
+$: << 'lib'
+
 require './lib/hoe.rb'
 
-Hoe.plugin :perforce
-Hoe.plugin :minitest
+Hoe.plugin :seattlerb
 
 Hoe.spec "hoe" do
   developer "Ryan Davis", "ryand-ruby@zenspider.com"
@@ -15,4 +16,4 @@ Hoe.spec "hoe" do
   pluggable!
 end
 
-# vim: syntax=Ruby
+# vim: syntax=ruby

data/lib/hoe.rb

@@ -69,7 +69,7 @@ end
 
 class Hoe
   # duh
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 
   ##
   # Used to add extra flags to RUBY_FLAGS.
@@ -245,10 +245,10 @@ class Hoe
   end
 
   ##
-  # Activate a plugin.
+  # Activate plugins.
 
-  def self.plugin name
-    self.plugins << name
+  def self.plugin *names
+    self.plugins.concat names
   end
 
   ##
@@ -451,10 +451,28 @@ class Hoe
   # Load activated plugins by calling their define tasks method.
 
   def load_plugin_tasks
+    bad = []
+
+    $plugin_max = self.class.plugins.map { |s| s.to_s.size }.max
+
     self.class.plugins.each do |plugin|
       warn plugin if $DEBUG
-      send "define_#{plugin}_tasks"
+
+      old_tasks = Rake::Task.tasks.dup
+
+      begin
+        send "define_#{plugin}_tasks"
+      rescue NoMethodError => e
+        warn "warning: couldn't activate the #{plugin} plugin, skipping"
+        bad << plugin
+        next
+      end
+
+      (Rake::Task.tasks - old_tasks).each do |task|
+        task.plugin = plugin # "%-#{max}s" % plugin
+      end
     end
+    @@plugins -= bad
   end
 
   ##
@@ -542,3 +560,13 @@ class File
     File.read(path).sub(/\A\xEF\xBB\xBF/, '')
   end
 end
+
+module Rake
+  class Task
+    attr_accessor :plugin
+    alias :old_comment :comment
+    def comment
+      "%-#{$plugin_max}s # %s" % [plugin, old_comment] if old_comment
+    end
+  end
+end

data/lib/hoe/debug.rb

@@ -10,6 +10,8 @@
 module Hoe::Debug
   Hoe.plugin :debug
 
+  Hoe::DEFAULT_CONFIG["exclude"] = /tmp$|CVS|TAGS|\.(svn|git|DS_Store)/
+
   # :stopdoc:
 
   DIFF = if Hoe::WINDOZE

data/lib/hoe/deps.rb

@@ -111,7 +111,7 @@ module Hoe::Deps
     desc 'Install missing dependencies.'
     task :check_extra_deps do
       # extra_deps = [["rubyforge", ">= 1.0.0"], ["rake", ">= 0.8.1"]]
-      extra_deps.each do |dep|
+      (extra_deps + extra_dev_deps).each do |dep|
         begin
           gem(*dep)
         rescue Gem::LoadError

data/lib/hoe/publish.rb

@@ -4,7 +4,7 @@
 # === Tasks Provided:
 #
 # announce::           Create news email file and post to rubyforge.
-# email::              Generate email announcement file.
+# debug_email::        Generate email announcement file.
 # post_blog::          Post announcement to blog.
 # post_news::          Post announcement to rubyforge.
 # publish_docs::       Publish RDoc to RubyForge.
@@ -19,10 +19,25 @@ module Hoe::Publish
   Hoe.plugin :publish
 
   ##
-  # *Optional*: An array of the project's blog categories. Defaults to project name.
+  # Optional: An array of the project's blog categories. Defaults to project
+  # name.
 
   attr_accessor :blog_categories
 
+  ##
+  # Optional: Name of destination directory for RDoc generated files.
+  # [default: rdoc]
+
+  attr_accessor :local_rdoc_dir
+
+  ##
+  # Optional: Should RDoc and ri generation tasks be defined? [default: true]
+  #
+  # Allows you to define custom RDoc tasks then use the publish_rdoc task to
+  # upload them all.  See also local_rdoc_dir
+
+  attr_accessor :need_rdoc
+
   ##
   # Optional: Name of RDoc destination directory on Rubyforge. [default: +name+]
 
@@ -34,23 +49,25 @@ module Hoe::Publish
   attr_accessor :rsync_args
 
   Hoe::DEFAULT_CONFIG["publish_on_announce"] = true
-  Hoe::DEFAULT_CONFIG["blog"] = [
-                                 {
-                                   "user"     => "user",
-                                   "password" => "password",
-                                   "url"      => "url",
-                                   "blog_id"  => "blog_id",
-                                   "extra_headers" => {
-                                     "mt_convert_breaks" => "markdown"
-                                   },
-                                 }
-                                ]
+  Hoe::DEFAULT_CONFIG["blogs"] = [
+                                  {
+                                    "user"     => "user",
+                                    "password" => "password",
+                                    "url"      => "url",
+                                    "blog_id"  => "blog_id",
+                                    "extra_headers" => {
+                                      "mt_convert_breaks" => "markdown"
+                                    },
+                                  }
+                                 ]
 
   ##
   # Initialize variables for plugin.
 
   def initialize_publish
     self.blog_categories ||= [self.name]
+    self.local_rdoc_dir  ||= 'doc'
+    self.need_rdoc       ||= true
     self.remote_rdoc_dir ||= self.name
     self.rsync_args      ||= '-av --delete'
   end
@@ -59,24 +76,26 @@ module Hoe::Publish
   # Define tasks for plugin.
 
   def define_publish_tasks
-    Rake::RDocTask.new(:docs) do |rd|
-      rd.main = readme_file
-      rd.options << '-d' if (`which dot` =~ /\/dot/) unless
-        ENV['NODOT'] || Hoe::WINDOZE
-      rd.rdoc_dir = 'doc'
+    if need_rdoc then
+      Rake::RDocTask.new(:docs) do |rd|
+        rd.main = readme_file
+        rd.options << '-d' if (`which dot` =~ /\/dot/) unless
+          ENV['NODOT'] || Hoe::WINDOZE
+        rd.rdoc_dir = 'doc'
 
-      rd.rdoc_files += spec.require_paths
-      rd.rdoc_files += spec.extra_rdoc_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
+        title = "#{name}-#{version} Documentation"
+        title = "#{rubyforge_name}'s " + title if rubyforge_name != name
 
-      rd.options << "-t" << title
-    end
+        rd.options << "-t" << title
+      end
 
-    desc 'Generate ri locally for testing.'
-    task :ridocs => :clean do
-      sh %q{ rdoc --ri -o ri . }
+      desc 'Generate ri locally for testing.'
+      task :ridocs => :clean do
+        sh %q{ rdoc --ri -o ri . }
+      end
     end
 
     desc 'Publish RDoc to RubyForge.'
@@ -85,7 +104,7 @@ module Hoe::Publish
       host = "#{config["username"]}@rubyforge.org"
 
       remote_dir = "/var/www/gforge-projects/#{rubyforge_name}/#{remote_rdoc_dir}"
-      local_dir = 'doc'
+      local_dir = local_rdoc_dir
 
       sh %{rsync #{rsync_args} #{local_dir}/ #{host}:#{remote_dir}}
     end
@@ -98,22 +117,8 @@ module Hoe::Publish
     end
 
     desc 'Generate email announcement file.'
-    task :email do
-      require 'rubyforge'
-      subject, title, body, urls = announcement
-
-      File.open("email.txt", "w") do |mail|
-        mail.puts "Subject: [ANN] #{subject}"
-        mail.puts
-        mail.puts title
-        mail.puts
-        mail.puts urls
-        mail.puts
-        mail.puts body
-        mail.puts
-        mail.puts urls
-      end
-      puts "Created email.txt"
+    task :debug_email do
+      puts generate_email
     end
 
     desc 'Post announcement to blog.'
@@ -153,8 +158,26 @@ module Hoe::Publish
       puts "Posted to rubyforge"
     end
 
-    desc 'Create news email file and post to rubyforge.'
-    task :announce => [:email, :post_news, :post_blog, :publish_on_announce ]
+    desc 'Announce your release.'
+    task :announce => [:post_news, :post_blog, :publish_on_announce ]
+  end
+
+  def generate_email full = nil
+    abort "No email 'to' entry. Run `rake config_hoe` to fix." unless
+      !full || email_to
+
+    from_name, from_email      = author.first, email.first
+    subject, title, body, urls = announcement
+
+    [
+     full && "From: #{from_name} <#{from_email}>",
+     full && "To: #{email_to.join(", ")}",
+     full && "Date: #{Time.now.rfc2822}",
+     "Subject: [ANN] #{subject}",
+     "", title,
+     "", urls,
+     "", body,
+    ].compact.join("\n")
   end
 
   def announcement # :nodoc:

data/lib/hoe/signing.rb

@@ -82,7 +82,13 @@ module Hoe::Signing
       key_file = File.expand_path key_file
       cert_file = File.expand_path cert_file
 
-      unless File.exist? key_file or File.exist? cert_file then
+      unless File.exist? key_file then
+        puts "Generating certificate"
+
+        if File.exist? key_file then
+          abort "Have #{key_file} but no #{cert_file}, aborting as a precaution"
+        end
+
         warn "NOTICE: using #{email.first} for certificate" if email.size > 1
 
         sh "gem cert --build #{email.first}"
@@ -90,29 +96,25 @@ module Hoe::Signing
         mv "gem-public_cert.pem", cert_file, :verbose => true
 
         puts "Installed key and certificate."
+      end
 
-        rf = RubyForge.new.configure
-        rf.login
-
-        cert_package = "#{rubyforge_name}-certificates"
+      rf = RubyForge.new.configure
+      rf.login
 
-        begin
-          rf.lookup 'package', cert_package
-        rescue
-          rf.create_package rubyforge_name, cert_package
-        end
+      cert_package = "#{rubyforge_name}-certificates"
 
-        begin
-          rf.lookup('release', cert_package)['certificates']
-          rf.add_file rubyforge_name, cert_package, 'certificates', cert_file
-        rescue
-          rf.create_package rubyforge_name, cert_package
-          rf.add_release rubyforge_name, cert_package, 'certificates', cert_file
-        end
+      begin
+        rf.lookup 'package', cert_package
+      rescue
+        rf.create_package rubyforge_name, cert_package
+      end
 
-        puts "Uploaded certificate to release \"certificates\" in package #{cert_package}"
+      unless rf.lookup('release', cert_package)['certificates'] then
+        rf.add_release rubyforge_name, cert_package, 'certificates', cert_file
+        puts "Uploaded certificates to release \"certificates\" in package #{cert_package}"
       else
-        puts "Keys already exist: #{key_file} and #{cert_file}"
+        puts '"certificates" release exists, adding file anyway (will not overwrite)'
+        rf.add_file rubyforge_name, cert_package, 'certificates', cert_file
       end
     end
   end

data/test/test_hoe.rb

@@ -8,61 +8,6 @@ class TestHoe < MiniTest::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_docs
-                  clobber_package
-                  clobber_rcov
-                  gem
-                  redocs
-                  repackage)
-    expected = %w(audit
-                  announce
-                  check_extra_deps
-                  check_manifest
-                  clean
-                  config_hoe
-                  debug_gem
-                  default
-                  deps:email
-                  deps:fetch
-                  deps:list
-                  docs
-                  email
-                  generate_key
-                  install_gem
-                  multi
-                  package
-                  post_blog
-                  post_news
-                  publish_docs
-                  rcov
-                  release
-                  release_sanity
-                  release_to_rubyforge
-                  ridocs
-                  test
-                  test_deps)
-    expected += boring
-
-    spec = Hoe.spec('blah') do
-      self.version = '1.0.0'
-      developer("name", "email")
-    end
-
-    assert_equal ["name"], spec.author
-    assert_equal ["email"], spec.email
-
-    tasks = Rake.application.tasks
-    public_tasks = tasks.reject { |t| t.comment.nil? }.map { |t| t.name }.sort
-    public_tasks -= %w(flay flog)
-
-    assert_equal expected.sort, public_tasks
-  end
-
   def test_possibly_better
     t = Gem::Specification::TODAY
     hoe = Hoe.spec("blah") do
@@ -108,6 +53,15 @@ class TestHoe < MiniTest::Unit::TestCase
     assert_equal ">= #{Hoe::VERSION}", dep.version_requirements.to_s
   end
 
+  def test_plugins
+    before = Hoe.plugins.dup
+    Hoe.plugin :first, :second
+    assert_equal before + [:first, :second], Hoe.plugins
+  ensure
+    # FIX: maybe add Hoe.reset
+    Hoe.plugins.replace before
+  end
+
   def test_rename
     # project, file_name, klass = Hoe.normalize_names 'project_name'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hoe
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -30,7 +30,7 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2009-06-14 00:00:00 -07:00
+date: 2009-06-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency