hoe 2.15.0 → 2.16.0

data/History.txt

@@ -1,3 +1,22 @@
+=== 2.16.0 / 2012-03-06
+
+* 9 minor enhancements:
+
+  * Added Gem.bin_wrapper to provide API to bin wrapped files.
+  * Added check_manifest task to compile_tasks in the compiler plugin.
+  * Decoupled from rcov task. Solves isolate/hoe bootstrap issues.
+  * Decoupled from rdoc tasks. Solves isolate/hoe bootstrap issues.
+  * Updated default exclude config to skip extconf.h and .o files.
+  * Updated known 3rd party plugin list in readme.
+  * Warn against using system installed rake (eg osx ships their own on 1.8).
+  * Removed rcov plugin from the default loaded set.
+  * Added dev dependency for rcov when the plugin is loaded.
+
+* 2 bug fixes:
+
+  * Fix Rake::DSL include warnings.
+  * Removing check_manifest from prerelease. (should be pushed to the hoe-git plugin)
+
 === 2.15.0 / 2012-02-29
 
 * 5 minor enhancements:

data/Manifest.txt

@@ -33,5 +33,6 @@ template/bin/file_name.erb
 template/lib/file_name.rb.erb
 template/test/test_file_name.rb.erb
 test/test_hoe.rb
+test/test_hoe_debug.rb
 test/test_hoe_gemcutter.rb
 test/test_hoe_test.rb

data/README.txt

@@ -171,16 +171,26 @@ Again, this must be done before the Hoe spec, or it won't be useful.
 
 === Known 3rd-Party Plugins:
 
-* hoe-bundler   - Generates a Gemfile based on a Hoe's declared dependencies.
-* hoe-debugging - A Hoe plugin to help you debug your codes.
-* hoe-doofus    - A Hoe plugin that helps me keep from messing up gem releases.
-* hoe-gemcutter - Adds gemcutter release automation to Hoe.
-* hoe-gemspec   - Generate a prerelease gemspec based on a Hoe spec.
-* hoe-git       - A set of Hoe plugins for tighter Git integration.
-* hoe-mercurial - A Hoe plugin for Mercurial integration.
-* hoe-rubygems  - A Hoe plugin with additional RubyGems tasks.
-* hoe-seattlerb - Minitest, email announcements, release branching.
-* hoe-yard      - A Hoe plugin for generating YARD documentation.
+* hoe-bundler    - Generates a Gemfile based on a Hoe's declared dependencies.
+* hoe-debugging  - A Hoe plugin to help you debug your codes.
+* hoe-deveiate   - A collection of Rake tasks and utility functions.
+* hoe-doofus     - A Hoe plugin that helps me keep from messing up gem releases.
+* hoe-gemcutter  - Adds gemcutter release automation to Hoe.
+* hoe-geminabox  - Allows you to push your gems to geminabox
+* hoe-gemspec    - Generate a prerelease gemspec based on a Hoe spec.
+* hoe-git        - A set of Hoe plugins for tighter Git integration.
+* hoe-heroku     - Helps you get your stuff on Heroku.
+* hoe-hg         - A Hoe plugin for Mercurial integration.
+* hoe-highline   - A Hoe plugin for building interactive Rake tasks
+* hoe-manualgen  - A manual-generation plugin for Hoe
+* hoe-mercurial  - A Hoe plugin for Mercurial integration.
+* hoe-reek       - Integrates the reek code smell engine into your hoe projects.
+* hoe-roodi      - Integrates the roodi code smell tool into your hoe projects.
+* hoe-rubygems   - Additional RubyGems tasks.
+* hoe-seattlerb  - Minitest, email announcements, release branching.
+* hoe-telicopter - Provides tasks used by hotelicopter.
+* hoe-travis     - Allows your gem to gain maximum benefit from <http://travis-ci.org>.
+* hoe-yard       - A Hoe plugin for generating YARD documentation.
 
 === Writing Plugins:
 

data/lib/hoe.rb

@@ -1,6 +1,12 @@
 # -*- mode: ruby; coding: us-ascii; -*-
 
 require 'rubygems'
+
+begin
+  gem 'rake'
+rescue Gem::LoadError
+  warn "Using the crusty system installed rake... you probably want to upgrade"
+end
 require 'rake'
 require 'rake/testtask'
 require 'rbconfig'
@@ -68,10 +74,10 @@ class Hoe
   include Rake::DSL if defined?(Rake::DSL)
 
   # duh
-  VERSION = '2.15.0'
+  VERSION = '2.16.0'
 
   @@plugins = [:clean, :debug, :deps, :flay, :flog, :newb, :package,
-               :publish, :rcov, :gemcutter, :signing, :test]
+               :publish, :gemcutter, :signing, :test]
 
   @bad_plugins = []
 
@@ -93,7 +99,7 @@ class Hoe
   # this on load.
 
   DEFAULT_CONFIG = {
-    "exclude" => /tmp$|CVS|\.svn|\.log$/,
+    "exclude" => /tmp$|CVS|\.svn|TAGS|extconf.h|\.o$|\.log$/,
   }
 
   ##
@@ -815,3 +821,7 @@ class File
     end
   end
 end
+
+def Gem.bin_wrapper name # HACK
+  File.join Gem.dir, "bin", Gem.default_exec_format % name
+end unless Gem.respond_to? :bin_wrapper

data/lib/hoe/compiler.rb

@@ -23,7 +23,7 @@ module Hoe::Compiler
   # Initialize variables for compiler plugin.
 
   def initialize_compiler
-    self.compile_tasks = [:multi, :test]
+    self.compile_tasks = [:multi, :test, :check_manifest]
     self.spec_extras   = { :extensions => ["ext/#{self.name}/extconf.rb"] }
 
     clean_globs << "lib/#{self.name}/*.{so,bundle,dll}"

data/lib/hoe/debug.rb

@@ -8,6 +8,9 @@
 # debug_gem::          Show information about the gem.
 
 module Hoe::Debug
+
+  include Rake::DSL if defined? ::Rake::DSL
+
   Hoe::DEFAULT_CONFIG["exclude"] = /tmp$|CVS|TAGS|\.(svn|git|DS_Store)/
 
   # :stopdoc:
@@ -42,27 +45,7 @@ module Hoe::Debug
 
     desc 'Verify the manifest.'
     task :check_manifest => :clean do
-      f = "Manifest.tmp"
-      require 'find'
-      files = []
-      with_config do |config, _|
-        exclusions = config["exclude"]
-        abort "exclude entry missing from .hoerc. Run rake config_hoe." if
-          exclusions.nil?
-
-        Find.find '.' do |path|
-          next unless File.file? path
-          next if path =~ exclusions
-          files << path[2..-1]
-        end
-        files = files.sort.join "\n"
-        File.open f, 'w' do |fp| fp.puts files end
-        begin
-          sh "#{DIFF} -du Manifest.txt #{f}"
-        ensure
-          rm f
-        end
-      end
+      check_manifest
     end
 
     desc 'Show information about the gem.'
@@ -70,4 +53,34 @@ module Hoe::Debug
       puts spec.to_ruby
     end
   end
+
+  ##
+  # Verifies your Manifest.txt against the files in your project.
+
+  def check_manifest
+    f = "Manifest.tmp"
+    require 'find'
+    files = []
+    with_config do |config, _|
+      exclusions = config["exclude"]
+
+      Find.find '.' do |path|
+        next unless File.file? path
+        next if path =~ exclusions
+        files << path[2..-1]
+      end
+
+      files = files.sort.join "\n"
+
+      File.open f, 'w' do |fp| fp.puts files end
+
+      verbose = { :verbose => Rake.application.options.verbose }
+
+      begin
+        sh "#{DIFF} -du Manifest.txt #{f}", verbose
+      ensure
+        rm f, verbose
+      end
+    end
+  end
 end

data/lib/hoe/package.rb

@@ -55,7 +55,7 @@ module Hoe::Package
     task :release => [:prerelease, :release_to, :postrelease]
 
     # no doco, invisible hook
-    task :prerelease => [:check_manifest] do
+    task :prerelease do
       abort "Fix your version before you release" if spec.version =~ /borked/
     end
 

data/lib/hoe/publish.rb

@@ -96,6 +96,23 @@ module Hoe::Publish
     self.rsync_args      ||= '-av --delete'
   end
 
+  def make_rdoc_cmd extra_args = nil
+    title = "#{name}-#{version} Documentation"
+    title = "#{rubyforge_name}'s #{title}" if rubyforge_name != name
+    rdoc  = Gem.bin_wrapper "rdoc"
+
+    cmd = %W[#{rdoc}
+             --title "#{title}"
+             -o "#{local_rdoc_dir}"
+            ] +
+      spec.rdoc_options +
+      Array(extra_args) +
+      spec.require_paths +
+      spec.extra_rdoc_files
+
+    cmd.join " "
+  end
+
   ##
   # Define tasks for plugin.
 
@@ -103,72 +120,29 @@ module Hoe::Publish
     if need_rdoc then
       dependency "rdoc", "~> 3.10", :developer
 
-      Rake.application[:isolate].invoke if plugin? :isolate
-
-      unless defined? RDoc::Task then
-        begin
-          gem 'rdoc'
-        rescue Gem::LoadError
-          warn $!
-          warn ""
-          warn "please run: rake check_extra_deps"
-        end unless Object.const_defined? :RDoc
-
-        begin
-          require 'rdoc/task'
-        rescue LoadError
-          require 'rake/rdoctask'
-        end
-      end
-
-      return unless Object.const_defined? :RDoc
-
-      RDoc::Task.new(:docs) do |rd|
-        rd.main = readme_file
-        rd.options << '-d' if (`which dot` =~ /\/dot/) unless
-          ENV['NODOT'] || Hoe::WINDOZE
-        rd.rdoc_dir = local_rdoc_dir
-
-        rd.rdoc_files += spec.require_paths
-        rd.rdoc_files += spec.extra_rdoc_files
-
-        title = spec.rdoc_options.grep(/^(-t|--title)=?$/).first
+      task :isolate # ensure it exists
 
-        if title then
-          rd.options << title
-
-          unless title =~ /\=/ then # for ['-t', 'title here']
-            title_index = spec.rdoc_options.index(title)
-            rd.options << spec.rdoc_options[title_index + 1]
-          end
-        else
-          title = "#{name}-#{version} Documentation"
-          title = "#{rubyforge_name}'s " + title if rubyforge_name != name
-          rd.options << '--title' << title
-        end
+      desc "Generate rdoc"
+      task :docs => [:clobber_docs, :isolate] do
+        ruby make_rdoc_cmd
       end
 
-      desc 'Generate ri locally for testing.'
-      task :ridocs => :clean do
-        sh %q{ rdoc --ri -o ri . }
+      desc "Generate rdoc coverage report"
+      task :dcov => :isolate do
+        ruby make_rdoc_cmd '-C'
       end
 
-      RDoc::Task.new(:dcov) do |rd|
-        rd.options << '-C'
-        rd.rdoc_files += spec.require_paths
-        rd.rdoc_files += spec.extra_rdoc_files
+      desc "Remove RDoc files"
+      task :clobber_docs do
+        rm_rf local_rdoc_dir
       end
 
-      task(:redcov).clear       # lame
-      task(:clobber_dcov).clear # lame
+      task :clobber => :clobber_docs
 
-      task :docs do
-        Dir.chdir local_rdoc_dir do
-          sh "chmod -R g+w ."
-        end
+      desc 'Generate ri locally for testing.'
+      task :ridocs => [:clean, :isolate] do
+        ruby make_rdoc_cmd "--ri -o ri"
       end
-
-      task :docs => :isolate if plugin? :isolate
     end
 
     desc "Publish RDoc to wherever you want."

data/lib/hoe/rcov.rb

@@ -6,29 +6,27 @@
 # rcov::               Analyze code coverage with tests
 
 module Hoe::RCov
+  def initialize_rcov
+    dependency "rcov", "~> 0.9", :development
+  end
+
   ##
   # Define tasks for plugin.
 
   def define_rcov_tasks
     begin # take a whack at defining rcov tasks
-      Rake.application[:isolate].invoke if plugin? :isolate
-
-      require 'rcov/rcovtask'
-
-      Rcov::RcovTask.new do |t|
-        pattern = ENV['PATTERN'] || test_globs
-
-        t.test_files = FileList[pattern]
-        t.verbose = true
-        t.libs = %w[lib test .]
-        t.rcov_opts << Hoe::RUBY_FLAGS
-        t.rcov_opts << "--no-color"
-        t.rcov_opts << "--save coverage.info"
-        t.rcov_opts << "-x ^/"
-        t.rcov_opts << "-x tmp/isolate"
-        t.rcov_opts << "--sort coverage --sort-reverse"
+      task :isolate # ensure it exists
+
+      task :rcov => :isolate do
+        ruby make_rcov_cmd
+      end
+
+      task :clobber_rcov do
+        rm_rf "coverage"
       end
 
+      task :clobber => :clobber_rcov
+
       # this is for my emacs rcov overlay stuff on emacswiki.
       task :rcov_overlay do
         path = ENV["FILE"]
@@ -43,6 +41,25 @@ module Hoe::RCov
       task :clobber_rcov # in case rcov didn't load
     end
   end
+
+  def make_rcov_cmd extra_args = nil
+    rcov  = Gem.bin_wrapper "rcov"
+    tests = test_globs.sort.map { |g| Dir.glob(g) }.flatten.map(&:inspect)
+
+    cmd = %W[#{rcov}
+             #{Hoe::RUBY_FLAGS}
+             --text-report
+             --no-color
+             --save coverage.info
+             -x ^/
+             -x tmp/isolate
+             --sort coverage
+             --sort-reverse
+             -o "coverage"
+            ] + tests
+
+    cmd.join " "
+  end
 end
 
 task :clean => :clobber_rcov

data/test/test_hoe.rb

@@ -20,7 +20,8 @@ class TestHoe < MiniTest::Unit::TestCase
   def setup
     Rake.application.clear
 
-    Hoe.instance_variable_set :@bad_plugins, []
+    Hoe.plugins.clear
+    Hoe.bad_plugins.clear
     Hoe.instance_variable_set :@files, nil
     Hoe.instance_variable_set :@found, nil
     Hoe.instance_variable_set :@loaded, nil
@@ -270,13 +271,15 @@ class TestHoe < MiniTest::Unit::TestCase
     spec = hoe.spec
 
     urls = {
-      "home"  => "https://github.com/seattlerb/hoe",
+      "home"  => "http://www.zenspider.com/projects/hoe.html",
+      "code"  => "https://github.com/seattlerb/hoe",
+      "bugs"  => "https://github.com/seattlerb/hoe/issues",
       "rdoc"  => "http://seattlerb.rubyforge.org/hoe/",
       "doco"  => "http://seattlerb.rubyforge.org/hoe/Hoe.pdf",
       "other" => "http://github.com/jbarnette/hoe-plugin-examples",
     }
 
-    assert_equal "https://github.com/seattlerb/hoe", hoe.url
+    assert_equal urls["home"], hoe.url
     assert_equal urls, hoe.urls
 
     text_files = files.grep(/txt$/).reject { |f| f =~ /template/ }
@@ -292,8 +295,7 @@ class TestHoe < MiniTest::Unit::TestCase
     assert_equal ['sow'], spec.executables
     assert_equal text_files, spec.extra_rdoc_files
     assert_equal files, spec.files
-    assert_equal "https://github.com/seattlerb/hoe", spec.homepage
-    # TODO: assert_equal "https://github.com/seattlerb/hoe", spec.metadata
+    assert_equal urls["home"], spec.homepage
     assert_equal ['--main', 'README.txt'], spec.rdoc_options
     assert_equal ['lib'], spec.require_paths
     assert_equal 'blah', spec.rubyforge_project

data/test/test_hoe_debug.rb

@@ -0,0 +1,107 @@
+require 'hoe'
+require File.expand_path 'lib/hoe/debug.rb' # ugh. avoid dupe warnings
+require 'tmpdir'
+require 'tempfile'
+require 'minitest/autorun'
+
+class TestHoeDebug < MiniTest::Unit::TestCase
+
+  include Hoe::Debug
+
+  attr_accessor :generated_files
+
+  def setup
+    super
+
+    @generated_files = []
+  end
+
+  def test_check_manifest
+    in_tmpdir do
+      manifest
+
+      assert_silent do
+        check_manifest
+      end
+    end
+  end
+
+  def test_check_manifest_generated
+    in_tmpdir do
+      manifest 'generated.rb'
+
+      open 'generated.rb', 'w' do |io| io.puts 'generated = true' end
+
+      assert_silent do
+        check_manifest
+      end
+    end
+  end
+
+  def test_check_manifest_missing
+    in_tmpdir do
+      manifest
+
+      open 'missing.rb', 'w' do |io| io.puts 'missing = true' end
+
+      e = nil
+
+      out = capture_STDOUT do
+        e = assert_raises RuntimeError do
+          check_manifest
+        end
+      end
+
+      assert_match %r%^Command failed with status%, e.message
+
+      assert_match %r%^\+missing.rb%, out
+    end
+  end
+
+  def capture_STDOUT
+    orig_STDOUT = STDOUT.dup
+
+    Tempfile.open __name__ do |io|
+      STDOUT.reopen io
+
+      yield
+
+      io.flush
+
+      return File.read io.path
+    end
+  ensure
+    STDOUT.reopen orig_STDOUT
+  end
+
+  def in_tmpdir
+    old_LOAD_PATH = $LOAD_PATH.dup
+    $LOAD_PATH.map! { |path| File.expand_path path }
+
+    Dir.mktmpdir do |path|
+      Dir.chdir path do
+        yield
+      end
+    end
+  ensure
+    $LOAD_PATH.replace old_LOAD_PATH
+  end
+
+  def manifest extra = nil
+    open 'Manifest.txt', 'w' do |io| # sorted
+      io.puts 'History.txt'
+      io.puts 'Manifest.txt'
+      io.puts 'README.txt'
+      io.puts extra if extra
+    end
+
+    open 'README.txt',  'w'  do |io| io.puts '= blah' end
+    open 'History.txt', 'w'  do |io| io.puts '=== 1.0' end
+  end
+
+  def with_config
+    yield({ 'exclude' => [] }, '~/.hoerc')
+  end
+
+end
+

data/test/test_hoe_test.rb

@@ -19,6 +19,8 @@ class TestHoeTest < MiniTest::Unit::TestCase
   end
 
   def test_make_test_cmd_with_different_testlibs
+    skip "Using TESTOPTS... skipping" if ENV['TESTOPTS']
+
     expected = ['-w -Ilib:bin:test:. -e \'require "rubygems"; %s',
                 'require "test/test_hoe_test.rb"',
                 "' -- ",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hoe
 version: !ruby/object:Gem::Version 
-  hash: 51
+  hash: 79
   prerelease: 
   segments: 
   - 2
-  - 15
+  - 16
   - 0
-  version: 2.15.0
+  version: 2.16.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -36,7 +36,7 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2012-03-01 00:00:00 Z
+date: 2012-03-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -140,6 +140,7 @@ files:
 - template/lib/file_name.rb.erb
 - template/test/test_file_name.rb.erb
 - test/test_hoe.rb
+- test/test_hoe_debug.rb
 - test/test_hoe_gemcutter.rb
 - test/test_hoe_test.rb
 - .gemtest
@@ -180,5 +181,6 @@ specification_version: 3
 summary: Hoe is a rake/rubygems helper for project Rakefiles
 test_files: 
 - test/test_hoe.rb
+- test/test_hoe_debug.rb
 - test/test_hoe_gemcutter.rb
 - test/test_hoe_test.rb