hoe 1.2.2 → 1.3.0

data/History.txt

@@ -1,4 +1,15 @@
-== 1.2.2 / 2007-07-23
+=== 1.3.0 / 2007-08-13
+
+* 1 major enhancement:
+  * Hoe now builds signed gems automatically.  Run the generate_key task to
+    automatically create a signing key.
+* 4 minor enhancements:
+  * Extended rdoc pattern to include ext dirs.
+  * Fixed dependency adding for versionless dependencies.
+  * Added NODOT env var to disable RDoc diagram generation.
+  * The config_hoe task automatically merges in new config entries.
+
+=== 1.2.2 / 2007-07-23
 
 * 2 minor enhancement:
   * Added exclude parameter for check_manifest filtering to .hoerc.
@@ -6,7 +17,7 @@
 * 1 bug fix:
   * Various (untested) fixes for windows compatibility.
 
-== 1.2.1 / 2007-05-21
+=== 1.2.1 / 2007-05-21
 
 * 8 minor enhancements:
   * Allow for spaces in filenames in manifest. Thanks to Aaron Patterson.
@@ -20,14 +31,14 @@
 * 1 bug fixes:
   * Fixed executables regexp to /^bin/.
 
-== 1.2.0 / 2007-02-13
+=== 1.2.0 / 2007-02-13
 
 * Added more support for ext dirs.
 * Added a simple config file (yaml). Use 'rake config_hoe' to edit.
 * Added post_blog task (thanks Aaron!), configured via config_hoe.
 * Announce task now posts to your blogs and/or publishes API depending on config.
 
-== 1.1.7 / 2007-01-10
+=== 1.1.7 / 2007-01-10
 
 * extra_deps is now self-healing, and ensures no (direct) cycles.
 * cleans check_manifest for CVS projects.
@@ -35,22 +46,22 @@
 * Now uses rsync for publish_docs. YAY for fast!
 * Bug #7193 fix spelling of 'synopsys'.  Submitted by Jacob Atzen.
 
-== 1.1.6 / 2006-11-29
+=== 1.1.6 / 2006-11-29
 
 * Fix release to work correctly with need_zip and need_tar.
 
-== 1.1.5 / 2006-11-29
+=== 1.1.5 / 2006-11-29
 
 * Reduced check_manifest dependencies to just diff for windows.
 * Don't use default author in summary, description or changes.
 
-== 1.1.4 / 2006-11-12
+=== 1.1.4 / 2006-11-12
 
 * Added need_tar and need_zip to customize package requirements. Stupid windoze.
 * Extended spec_extras to take procs as values. Passes in named parameter.
 * Removed test from require_paths. I thought I already parameterized this. :/
 
-== 1.1.3 / 2006-11-09
+=== 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!
@@ -59,7 +70,7 @@
 * Fixed doco and automated updating of it.
 * Added rdoc_pattern. Go doco go!
 
-== 1.1.2 / 2006-10-22
+=== 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.
@@ -67,17 +78,17 @@
 * Removed demo.rb from clean_globs. I'm torn on this one.
 * Fixed bug in install rule.
 
-== 1.1.1 / 2006-10-11
+=== 1.1.1 / 2006-10-11
 
 * Fixed minor problem with subject of email.
 * Fixed problem in test.
 
-== 1.1.0 / 2006-10-04
+=== 1.1.0 / 2006-10-04
 
 * Added sow, a command-line tool for quickly creating new projects.
 * Added check_manifest task
 
-== 1.0.5 / 2006-10-03
+=== 1.0.5 / 2006-10-03
 
 * Doco cleanup.
 * Removed Manifest.txt from rdoc and added title.
@@ -88,11 +99,11 @@
 * Added email and rubyforge news announcement tasks.
 * Url attribute may now be an array of urls.
 
-== 1.0.4 / 2006-09-23
+=== 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
+=== 1.0.3 / 2006-09-23
 
 * Added debug_gem rule.
 * Added lots of doco.
@@ -105,12 +116,12 @@
 * Renamed upload to publish_docs.
 * publish_docs is now smart about subprojects and missing subdirectories.
 
-== 1.0.2 / 2006-09-20
+=== 1.0.2 / 2006-09-20
 
 * Wee little tests.
 * Fixed up gemspec's require_paths.
 
-== 1.0.1 / 2006-09-20
+=== 1.0.1 / 2006-09-20
 
 * Finally got deployment straightened out. Maybe. Some might be on rubyforge.org.
 * Added default description and summary.
@@ -118,6 +129,6 @@
 * Improved gemspec debugging.
 * Swapped gem with tgz in deploy... we'd rather screw up on tgz
 
-== 1.0.0 / 2006-09-19
+=== 1.0.0 / 2006-09-19
 
 * Birthday!

data/lib/hoe.rb

@@ -8,6 +8,7 @@ require 'rake/rdoctask'
 require 'rake/testtask'
 require 'rbconfig'
 require 'rubyforge'
+require 'yaml'
 
 ##
 # hoe - a tool to help rake
@@ -64,12 +65,39 @@ require 'rubyforge'
 # exclude::             A regular expression of files to exclude from
 #                       +check_manifest+.
 # publish_on_announce:: Run +publish_docs+ when you run +release+.
+# signing_key_file:: Signs your gems with this private key.
+# signing_cert_file:: Signs your gem with this certificate.
 # blogs::               An array of hashes of blog settings.
 #
 # Run +config_hoe+ and see ~/.hoerc for examples.
 #
+# === Signing Gems:
+#
+# Run the 'generate_key' task.  This will:
+#
+# 1. Configure your ~/.hoerc.
+# 2. Generate a signing key and certificate.
+# 3. Install the private key and public certificate files into ~/.gem.
+# 4. Upload the certificate to RubyForge.
+#
+# Hoe will now generate signed gems when the package task is run.  If you have
+# multiple machines you build gems on, be sure to install your key and
+# certificate on each machine.
+#
+# Keep your private key secret!  Keep your private key safe!
+#
+# To make sure your gems are signed run:
+#
+#   rake package; tar tf pkg/yourproject-1.2.3.gem
+#
+# If your gem is signed you will see:
+#
+#   data.tar.gz
+#   data.tar.gz.sig
+#   metadata.gz
+#   metadata.gz.sig
 class Hoe
-  VERSION = '1.2.2'
+  VERSION = '1.3.0'
 
   ruby_prefix = Config::CONFIG['prefix']
   sitelibdir = Config::CONFIG['sitelibdir']
@@ -243,7 +271,7 @@ class Hoe
     self.extra_deps = []
     self.need_tar = true
     self.need_zip = false
-    self.rdoc_pattern = /^(lib|bin)|txt$/
+    self.rdoc_pattern = /^(lib|bin|ext)|txt$/
     self.remote_rdoc_dir = name
     self.rsync_args = '-av --delete'
     self.rubyforge_name = name.downcase
@@ -259,9 +287,8 @@ class Hoe
       'rubyforge' => ">= #{::RubyForge::VERSION}",
     }
 
-    self.extra_deps = Array(extra_deps) # just in case user used = instead of <<
-    self.extra_deps = [extra_deps] unless
-      extra_deps.empty? or Array === extra_deps.first
+    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]
@@ -274,6 +301,13 @@ class Hoe
   end
 
   def define_tasks # :nodoc:
+    def with_config # :nodoc:
+      rc = File.expand_path("~/.hoerc")
+      exists = File.exist? rc
+      config = exists ? YAML.load_file(rc) : {}
+      yield(config, rc)
+    end
+
     desc 'Run the default tasks'
     task :default => :test
 
@@ -301,6 +335,18 @@ class Hoe
     ############################################################
     # Packaging and Installing
 
+    signing_key = nil
+    cert_chain = []
+
+    with_config do |config, path|
+      break unless config['signing_key_file'] and config['signing_cert_file']
+      key_file = File.expand_path config['signing_key_file'].to_s
+      signing_key = key_file if File.exist? key_file
+
+      cert_file = File.expand_path config['signing_cert_file'].to_s
+      cert_chain << cert_file if File.exist? cert_file
+    end
+
     self.spec = Gem::Specification.new do |s|
       s.name = name
       s.version = version
@@ -338,6 +384,11 @@ class Hoe
         s.test_files = Dir[*test_globs]
       end
 
+      if signing_key and cert_chain then
+        s.signing_key = signing_key
+        s.cert_chain = cert_chain
+      end
+
       # Do any extra stuff the user wants
       spec_extras.each do |msg, val|
         case val
@@ -424,7 +475,7 @@ class Hoe
 
     Rake::RDocTask.new(:docs) do |rd|
       rd.main = "README.txt"
-      rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/
+      rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/ and not ENV['NODOT']
       rd.rdoc_dir = 'doc'
       files = spec.files.grep(rdoc_pattern)
       files -= ['Manifest.txt']
@@ -454,32 +505,14 @@ class Hoe
 
     # no doco for this one
     task :publish_on_announce do
-      with_config do |rc, path|
-        if rc["publish_on_announce"] then
-          Rake::Task['publish_docs'].invoke
-        end
+      with_config do |config, _|
+        Rake::Task['publish_docs'].invoke if config["publish_on_announce"]
       end
     end
 
     ############################################################
     # Misc/Maintenance:
 
-    def with_config(create=false) # :nodoc:
-      require 'yaml'
-      rc = File.expand_path("~/.hoerc")
-
-      unless create then
-        if test ?f, rc then
-          config = YAML.load_file(rc)
-          yield(config, rc)
-        end
-      else
-        unless test ?f, rc then
-          yield(rc)
-        end
-      end
-    end
-
     desc 'Run ZenTest against the package'
     task :audit do
       libs = %w(lib test ext).join(File::PATH_SEPARATOR)
@@ -496,10 +529,12 @@ class Hoe
 
     desc 'Create a fresh ~/.hoerc file'
     task :config_hoe do
-      with_config(:create) do |rc, path|
-        blog = {
+      with_config do |config, path|
+        default_config = {
           "exclude" => /tmp$|CVS|\.svn/,
           "publish_on_announce" => false,
+          "signing_key_file" => "~/.gem/gem-private_key.pem",
+          "signing_cert_file" => "~/.gem/gem-public_cert.pem",
           "blogs" => [ {
                          "user" => "user",
                          "url" => "url",
@@ -510,14 +545,12 @@ class Hoe
                          "password"=>"password",
                        } ],
         }
-        File.open(rc, "w") do |f|
-          YAML.dump(blog, f)
+        File.open(path, "w") do |f|
+          YAML.dump(default_config.merge(config), f)
         end
-      end
 
-      with_config do |rc, path|
         editor = ENV['EDITOR'] || 'vi'
-        system "#{editor} #{path}"
+        system "#{editor} #{path}" if ENV['SHOW_EDITOR'] != 'no'
       end
     end
 
@@ -545,8 +578,9 @@ class Hoe
       require 'xmlrpc/client'
 
       with_config do |config, path|
-        subject, title, body, urls = announcement
+        break unless config['blogs']
 
+        subject, title, body, urls = announcement
         body += "\n\n#{urls}"
 
         config['blogs'].each do |site|
@@ -596,6 +630,56 @@ class Hoe
       end
     end
 
+    desc 'Generate a key for signing your gems.'
+    task :generate_key do
+      email = spec.email
+      abort "No email in your gemspec" if email.nil? or email.empty?
+
+      key_file = with_config { |config, _| config['signing_key_file'] }
+      cert_file = with_config { |config, _| config['signing_cert_file'] }
+
+      if key_file.nil? or cert_file.nil? then
+        ENV['SHOW_EDITOR'] ||= 'no'
+        Rake::Task['config_hoe'].invoke
+
+        key_file = with_config { |config, _| config['signing_key_file'] }
+        cert_file = with_config { |config, _| config['signing_cert_file'] }
+      end
+
+      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
+        sh "gem cert --build #{email}"
+        mv "gem-private_key.pem", key_file, :verbose => true
+        mv "gem-public_cert.pem", cert_file, :verbose => true
+
+        puts "Installed key and certificate."
+
+        rf = RubyForge.new
+        rf.login
+
+        cert_package = "#{rubyforge_name}-certificates"
+
+        begin
+          rf.lookup 'package', cert_package
+        rescue
+          rf.create_package rubyforge_name, cert_package
+        end
+
+        begin
+          rf.lookup('release', cert_package)['certificates']
+          rf.add_file rubyforge_name, cert_package, 'certificates', cert_file
+        rescue
+          rf.add_release rubyforge_name, cert_package, 'certificates', cert_file
+        end
+
+        puts "Uploaded certificate to release \"certificates\" in package #{cert_package}"
+      else
+        puts "Keys already exist."
+      end
+    end
+
   end # end define
 
   def announcement # :nodoc:

data/test/test_hoe.rb

@@ -24,6 +24,7 @@ class TestHoe < Test::Unit::TestCase
                   default
                   docs
                   email
+                  generate_key
                   install
                   install_gem
                   multi

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: hoe
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
-date: 2007-07-23 00:00:00 -07:00
+  version: 1.3.0
+date: 2007-08-13 00:00:00 -07:00
 summary: Hoe is a way to write Rakefiles much easier and cleaner.
 require_paths: 
 - lib
@@ -59,7 +59,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.2
+        version: 0.4.4
     version: 
 - !ruby/object:Gem::Dependency 
   name: rake