hoe 2.8.0 → 2.9.0

data/History.txt

@@ -1,3 +1,26 @@
+=== 2.9.0 / 2011-01-31
+
+* 11 minor enhancements:
+
+  * Added Hoe::Package#pkg_path to make package hook writing easier.
+  * Added Hoe::Test#test_prelude to allow for code to run before test loading.
+  * Added plugin?(name) to allow for easier plugin guarding in hoe spec.
+  * Added support for multiple template dirs for sow.
+  * Added support for rubygems-test. See http://www.gem-testers.org/
+  * Clean up sow a LOT using: include FileUtils::Verbose
+  * Don't warn about missing plugins without rake -t
+  * Hoe requires Gem::PackageTask from RubyGems 1.4+
+  * Moved post_news from publish to rubyforge
+  * Plugins can now be loaded from a +plugins+ array in ~/.hoerc
+  * rubyforge plugin now uses plain globs to push. Fixes releases for rubygems itself
+
+* 4 bug fixes:
+
+  * Failed plugins should notify on both trace and debug.
+  * Fixed rdoc_dir for custom rdoc locations
+  * Fixed require 'rubyforge' that was too late
+  * Fixed sow to properly rename dirs depth first
+
 === 2.8.0 / 2010-12-08
 
 * 6 minor enhancements:

data/Rakefile

@@ -16,7 +16,7 @@ Hoe.spec "hoe" do
   blog_categories << "Seattle.rb" << "Ruby"
 
   pluggable!
-  require_ruby_version '>= 1.3.6'
+  require_rubygems_version '>= 1.4'
 end
 
 task :plugins do

data/bin/sow

@@ -1,21 +1,50 @@
-#!/usr/bin/env ruby -ws
-
-$h ||= false
-$t ||= false
-$d ||= false
+#!/usr/bin/env ruby -w
 
+require 'optparse'
 require 'rubygems'
 require 'hoe'
 require 'fileutils'
 require 'erb'
 
-if $h || ARGV.empty? || ($t && $d) then
-  puts "usage: #{File.basename $0} [-d|-t] project"
-  puts "  -t = add project to subdir under 'trunk'"
-  puts "  -d = add project to subdir under 'dev'"
-  exit
+option = {
+  :style  => "default",
+  :subdir => nil,
+}
+
+def check_subdir
+  if option[:subdir] then
+    warn "ERROR: you can't specify multiple subdirs"
+    abort opts.to_s
+  end
 end
 
+OptionParser.new do |opts|
+  opts.separator "Standard options:"
+
+  opts.on("-t", "--trunk", "Add project to subdir under 'trunk'.") do
+    check_subdir
+    option[:subdir] = "trunk"
+  end
+
+  opts.on("-d", "--dev", "Add project to subdir under 'dev'.") do
+    check_subdir
+    option[:subdir] = "dev"
+  end
+
+  opts.on("-s style", "--style style", String, "Use template <style>.") do |s|
+    option[:style] = s
+  end
+
+  opts.on("-h", "--help", "Show this message.") do
+    puts opts
+    exit
+  end
+end.parse!
+
+# TODO: fail if both dev and trunk
+
+include FileUtils::Verbose
+
 project = ARGV.shift
 
 abort "Project #{project} seems to exist" if test ?d, project
@@ -23,24 +52,36 @@ abort "Project #{project} seems to exist" if test ?d, project
 # variables for erb:
 XIF                       = 'FI' + 'X' # prevents extra hits on my TAG reporter
 project, file_name, klass = Hoe.normalize_names project
-template_path             = File.expand_path("~/.hoe_template")
+template_dir              = File.expand_path("~/.hoe_template")
+template_path             = File.join template_dir, option[:style]
 source_path               = File.join(File.dirname(File.dirname(__FILE__)),
                                       "template")
 
+default_dir = File.join template_dir, "default"
+if File.directory? template_dir and not File.directory? default_dir then
+  warn "Detected old #{template_dir}"
+  warn "Moving to #{default_dir}"
+  tmp = "#{template_dir}.#{$$}"
+  File.rename template_dir, tmp
+  FileUtils.mkdir template_dir
+  File.rename tmp, default_dir
+end
+
 unless File.directory? template_path then
-  FileUtils.cp_r source_path, template_path, :verbose => true
+  warn "Creating missing #{option[:style]} template."
+  FileUtils.cp_r source_path, template_path
   paths = (Dir["#{template_path}/**/*"] +
            Dir["#{template_path}/**/.*"]).select { |f| File.file? f }
-  FileUtils.chmod 0644, paths, :verbose => true
-  FileUtils.chmod 0755, paths.grep(/bin\//), :verbose => true
+  FileUtils.chmod 0644, paths
+  FileUtils.chmod 0755, paths.grep(/bin\//)
 end
 
-FileUtils.cp_r template_path, project, :verbose => true
+FileUtils.cp_r template_path, project
 
 Dir.chdir project do
-  dirs = Dir["**/*"].select { |f| File.directory? f }.sort
-  dirs.grep(/file_name/).each do |file|
-    FileUtils.mv file, file.gsub(/file_name/, file_name), :verbose => true
+  dirs = Dir["**/*"].select { |f| File.directory? f }.sort.reverse
+  dirs.grep(/file_name$/).each do |file|
+    FileUtils.mv file, file.sub(/file_name$/, file_name)
   end
 
   paths = (Dir["**/*"] + Dir["**/.*"]).select { |f| File.file? f }.sort
@@ -56,15 +97,15 @@ Dir.chdir project do
 
   paths.grep(/file_name|\.erb$/).each do |file|
     new_file = file.sub(/file_name/, file_name).sub(/\.erb$/, '')
-    FileUtils.mv file, new_file, :verbose => true
+    FileUtils.mv file, new_file
   end
 end
 
-if $d || $t then
+if option[:dev] || option[:trunk] then
   temp_dir = "#{project}.#{$$}"
-  FileUtils.mv project, temp_dir, :verbose => true
-  FileUtils.mkdir project, :verbose => true
-  FileUtils.mv temp_dir, "#{project}/#{$d ? 'dev' : 'trunk'}", :verbose => true
+  FileUtils.mv project, temp_dir
+  FileUtils.mkdir project
+  FileUtils.mv temp_dir, "#{project}/#{option[:dev] ? 'dev' : 'trunk'}"
 end
 
 puts

data/lib/hoe.rb

@@ -58,7 +58,7 @@ require 'hoe/rake'
 
 class Hoe
   # duh
-  VERSION = '2.8.0'
+  VERSION = '2.9.0'
 
   @@plugins = [:clean, :debug, :deps, :flay, :flog, :newb, :package,
                :publish, :rcov, :gemcutter, :signing, :test]
@@ -228,23 +228,26 @@ class Hoe
   #
   # It is called at the end of hoe.rb
 
-  def self.load_plugins
-    loaded, found = {}, {}
+  def self.load_plugins plugins = Hoe.plugins
+    @found  ||= {}
+    @loaded ||= {}
 
     Gem.find_files("hoe/*.rb").reverse.each do |path|
-      found[File.basename(path, ".rb").intern] = path
+      @found[File.basename(path, ".rb").intern] = path
     end
 
-    :keep_doing_this while found.map { |name, plugin|
-      next unless Hoe.plugins.include? name
-      next if loaded[name]
+    :keep_doing_this while @found.map { |name, plugin|
+      next unless plugins.include? name
+      next if @loaded[name]
       begin
         warn "loading #{plugin}" if $DEBUG
-        loaded[name] = load plugin
+        @loaded[name] = require plugin
       rescue LoadError => e
         warn "error loading #{plugin.inspect}: #{e.message}. skipping..."
       end
     }.any?
+
+    return @loaded, @found
   end
 
   ##
@@ -261,15 +264,20 @@ class Hoe
   end
 
   ##
-  # Activate plugins.
+  # Activates +plugins+.  If a plugin cannot be loaded it will be ignored.
+  #
+  # Plugins may also be activated through a +plugins+ array in
+  # <tt>~/.hoerc</tt>.  This should only be used for plugins that aren't
+  # critical to your project and plugins that you want to use on other
+  # projects.
 
-  def self.plugin *names
-    self.plugins.concat names
+  def self.plugin *plugins
+    self.plugins.concat plugins
     self.plugins.uniq!
   end
 
   ##
-  # Return the list of activated plugins.
+  # The list of active plugins.
 
   def self.plugins
     @@plugins
@@ -298,11 +306,21 @@ class Hoe
   # Activate plugin modules and add them to the current instance.
 
   def activate_plugins
-    names = self.class.constants.map { |s| s.to_s }
+    plugins = Hoe.plugins
+
+    with_config do |config, _|
+      config_plugins = config['plugins']
+      break unless config_plugins
+      plugins += config_plugins.map { |plugin| plugin.intern }
+    end
+
+    Hoe.load_plugins plugins
+
+    names = Hoe.constants.map { |s| s.to_s }
     names.reject! { |n| n =~ /^[A-Z_]+$/ }
 
     names.each do |name|
-      next unless Hoe.plugins.include? name.downcase.intern
+      next unless plugins.include? name.downcase.intern
       warn "extend #{name}" if $DEBUG
       self.extend Hoe.const_get(name)
     end
@@ -506,7 +524,9 @@ class Hoe
       begin
         send "define_#{plugin}_tasks"
       rescue NoMethodError => e
-        warn "warning: couldn't activate the #{plugin} plugin, skipping"
+        warn "warning: couldn't activate the #{plugin} plugin, skipping" if
+          Rake.application.options.trace or $DEBUG
+
         bad << plugin
         next
       end
@@ -561,6 +581,20 @@ class Hoe
     require_rubygems_version '>= 1.3.1'
   end
 
+  ##
+  # Is a plugin activated? Used for guarding missing plugins in your
+  # hoe spec:
+  #
+  #   Hoe.spec "blah" do
+  #     if plugin? :enhancement then
+  #       self.enhancement = true # or whatever...
+  #     end
+  #   end
+
+  def plugin? name
+    self.class.plugins.include? name
+  end
+
   ##
   # Finalize configuration
 
@@ -610,9 +644,9 @@ class Hoe
   end
 
   ##
-  # Load or create a default config and yield it
+  # Loads ~/.hoerc and yields the configuration and its path
 
-  def with_config # :nodoc:
+  def with_config
     rc = File.expand_path("~/.hoerc")
     exists = File.exist? rc
     config = exists ? YAML.load_file(rc) : {}

data/lib/hoe/package.rb

@@ -72,6 +72,14 @@ module Hoe::Package
     end
   end
 
+  ##
+  # Returns the path used for packaging. Convenience method for those
+  # that need to write a package hook.
+
+  def pkg_path
+    "pkg/#{spec.full_name}"
+  end
+
   ##
   # Install the named gem.
 

data/lib/hoe/publish.rb

@@ -100,7 +100,7 @@ module Hoe::Publish
         rd.main = readme_file
         rd.options << '-d' if (`which dot` =~ /\/dot/) unless
           ENV['NODOT'] || Hoe::WINDOZE
-        rd.rdoc_dir = 'doc'
+        rd.rdoc_dir = local_rdoc_dir
 
         rd.rdoc_files += spec.require_paths
         rd.rdoc_files += spec.extra_rdoc_files
@@ -173,17 +173,6 @@ module Hoe::Publish
       end
     end
 
-    desc 'Post announcement to rubyforge.'
-    task :post_news do
-      require 'rubyforge'
-      subject, title, body, urls = announcement
-
-      rf = RubyForge.new.configure
-      rf.login
-      rf.post_news(rubyforge_name, subject, "#{title}\n\n#{body}")
-      puts "Posted to rubyforge"
-    end
-
     desc 'Announce your release.'
     task :announce => [:post_blog, :publish_on_announce ]
   end

data/lib/hoe/rubyforge.rb

@@ -10,6 +10,8 @@
 
 module Hoe::RubyForge
   def initialize_rubyforge
+    require 'rubyforge'
+
     dependency_target << ['rubyforge', ">= #{::RubyForge::VERSION}"]
   end
 
@@ -19,8 +21,6 @@ module Hoe::RubyForge
 
     desc 'Release to rubyforge.'
     task :release_to_rubyforge => [:clean, :package, :release_sanity] do
-      require 'rubyforge'
-
       rf = RubyForge.new.configure
       puts "Logging in"
       rf.login
@@ -30,12 +30,12 @@ module Hoe::RubyForge
       c["release_changes"] = changes     if changes
       c["preformatted"]    = true
 
-      pkg   = "pkg/#{name}-#{version}"
-      files = [(@need_tar ? "#{pkg}.tgz" : nil),
-               (@need_zip ? "#{pkg}.zip" : nil),
-               Dir["#{pkg}*.gem"]].flatten.compact
+      files = [(@need_tar ? Dir["pkg/*.tgz"] : nil),
+               (@need_zip ? Dir["pkg/*.zip"] : nil),
+               Dir["pkg/*.gem"]].flatten.compact
 
       puts "Releasing #{name} v. #{version}"
+
       rf.add_release rubyforge_name, name, version, *files
     end
 
@@ -50,6 +50,17 @@ module Hoe::RubyForge
       else
         warn "Couldn't read #{path}. Run `rubyforge setup`."
       end
+
+      desc 'Post announcement to rubyforge.'
+      task :post_news do
+        require 'rubyforge'
+        subject, title, body, urls = announcement
+
+        rf = RubyForge.new.configure
+        rf.login
+        rf.post_news(rubyforge_name, subject, "#{title}\n\n#{body}")
+        puts "Posted to rubyforge"
+      end
     end
   end
 end

data/lib/hoe/test.rb

@@ -36,6 +36,11 @@ module Hoe::Test
 
   attr_accessor :testlib
 
+  ##
+  # Optional: Additional ruby to run before the test framework is loaded.
+
+  attr_accessor :test_prelude
+
   ##
   # Optional: RSpec dirs. [default: %w(spec lib)]
 
@@ -52,6 +57,7 @@ module Hoe::Test
   def initialize_test
     self.multiruby_skip ||= []
     self.testlib        ||= :testunit
+    self.test_prelude   ||= nil
     self.rspec_dirs     ||= %w(spec lib)
     self.rspec_options  ||= []
   end
@@ -125,6 +131,23 @@ module Hoe::Test
     desc 'Run the default task(s).'
     task :default => default_tasks
 
+    unless default_tasks.empty? then
+      ##
+      # This is for Erik Hollensbe's rubygems-test project. Hoe is
+      # test-happy, so by using this plugin you're already testable. For
+      # more information, see: <https://github.com/erikh/rubygems-test>
+      # and/or <http://www.gem-testers.org/>
+
+      self.spec.files += [".gemtest"]
+
+      pkg  = pkg_path
+      turd = "#{pkg}/.gemtest"
+
+      task pkg do
+        touch turd
+      end
+    end
+
     desc 'Run ZenTest against the package.'
     task :audit do
       libs = %w(lib test ext).join(File::PATH_SEPARATOR)
@@ -143,6 +166,8 @@ module Hoe::Test
       test_globs.map { |g| Dir.glob(g) }.flatten
     tests.map! {|f| %(require "#{f}")}
 
+    tests.insert 1, test_prelude if test_prelude
+
     cmd = "#{Hoe::RUBY_FLAGS} -e '#{tests.join("; ")}' -- #{FILTER}"
 
     if multi then

data/test/test_hoe.rb

@@ -9,6 +9,59 @@ class TestHoe < MiniTest::Unit::TestCase
     Rake.application.clear
   end
 
+  def test_class_load_plugins
+    loaded, = Hoe.load_plugins
+
+    assert_includes loaded.keys, :clean
+    assert_includes loaded.keys, :debug
+    assert_includes loaded.keys, :deps
+  end
+
+  def test_activate_plugins
+    hoe = Hoe.spec 'blah' do
+      developer 'author', 'email'
+    end
+
+    initializers = hoe.methods.grep(/^initialize/)
+
+    assert_includes initializers, 'initialize_clean'
+    assert_includes initializers, 'initialize_flay'
+    assert_includes initializers, 'initialize_flog'
+    assert_includes initializers, 'initialize_package'
+    assert_includes initializers, 'initialize_publish'
+    assert_includes initializers, 'initialize_test'
+  end
+
+  def test_activate_plugins_hoerc
+    home = ENV['HOME']
+    load_path = $LOAD_PATH.dup
+
+    Dir.mktmpdir do |path|
+      ENV['HOME'] = path
+      $LOAD_PATH << path
+
+      Dir.mkdir File.join(path, 'hoe')
+      open File.join(path, 'hoe', 'hoerc.rb'), 'w' do |io|
+        io.write 'module Hoe::Hoerc; def initialize_hoerc; end; end'
+      end
+
+      open File.join(path, '.hoerc'), 'w' do |io|
+        io.write YAML.dump 'plugins' => %w[hoerc]
+      end
+
+      spec = Hoe.spec 'blah' do
+        developer 'author', 'email'
+      end
+
+      assert_includes spec.methods.grep(/^initialize/), 'initialize_hoerc'
+    end
+  ensure
+    Hoe.instance_variable_get(:@loaded).delete :hoerc
+    Hoe.plugins.delete :hoerc
+    $LOAD_PATH.replace load_path
+    ENV['HOME'] = home
+  end
+
   def test_file_read_utf
     Tempfile.open 'BOM' do |io|
       io.write "\xEF\xBB\xBFBOM"
@@ -24,7 +77,7 @@ class TestHoe < MiniTest::Unit::TestCase
       developer 'author', 'email'
     end
 
-    files = File.read("Manifest.txt").split(/\n/)
+    files = File.read("Manifest.txt").split(/\n/) + [".gemtest"]
 
     spec = hoe.spec
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hoe
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 43
+  prerelease: 
   segments: 
   - 2
-  - 8
+  - 9
   - 0
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -35,16 +36,18 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2010-12-08 00:00:00 -08:00
+date: 2011-01-31 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 49
         segments: 
         - 0
         - 8
@@ -56,14 +59,16 @@ dependencies:
   name: minitest
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 2
         - 0
-        - 0
-        version: 2.0.0
+        - 2
+        version: 2.0.2
   type: :development
   version_requirements: *id002
 description: |-
@@ -124,6 +129,7 @@ files:
 - template/test/test_file_name.rb.erb
 - test/test_hoe.rb
 - test/test_hoe_gemcutter.rb
+- .gemtest
 has_rdoc: true
 homepage: http://rubyforge.org/projects/seattlerb/
 licenses: []
@@ -135,27 +141,28 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 6
-      version: 1.3.6
+      - 0
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 7
       segments: 
       - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 4
+      version: "1.4"
 requirements: []
 
 rubyforge_project: seattlerb
-rubygems_version: 1.3.6
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Hoe is a rake/rubygems helper for project Rakefiles