hoe 1.7.0 → 1.8.0

data/History.txt

@@ -1,3 +1,14 @@
+=== 1.8.0 / 2008-10-09
+
+* 5 minor enhancements:
+
+  * Added Hoe.add_include_dirs to make setting up rake deps easier.
+  * Removed unused optional group arg in sow.
+  * Added testlib variable so you can specify what test library to use.
+  * Added deps:list to help you review dependent projects.
+  * Added deps:email to help you communicate with dependent projects.
+  * Added deps:fetch to help you search through dependent projects.
+
 === 1.7.0 / 2008-06-30
 
 * 3 minor enhancements:

data/README.txt

@@ -12,27 +12,31 @@ testing, packaging, and deployment.
 
 Tasks Provided:
 
-* announce       - Create news email file and post to rubyforge.
-* audit          - Run ZenTest against the package.
-* check_manifest - Verify the manifest.
-* clean          - Clean up all the extras.
-* config_hoe     - Create a fresh ~/.hoerc file.
-* debug_gem      - Show information about the gem.
-* default        - Run the default tasks.
-* docs           - Build the docs HTML Files
-* email          - Generate email announcement file.
-* gem            - Build the gem file hoe-1.5.0.gem
-* generate_key   - Generate a key for signing your gems.
-* install_gem    - Install the package as a gem.
-* multi          - Run the test suite using multiruby.
-* package        - Build all the packages
-* post_blog      - Post announcement to blog.
-* post_news      - Post announcement to rubyforge.
-* publish_docs   - Publish RDoc to RubyForge.
-* release        - Package and upload the release to rubyforge.
-* ridocs         - Generate ri locally for testing.
-* test           - Run the test suite.
-* test_deps      - Show which test files fail when run alone.
+* announce         - Create news email file and post to rubyforge.
+* audit            - Run ZenTest against the package.
+* check_manifest   - Verify the manifest.
+* clean            - Clean up all the extras.
+* config_hoe       - Create a fresh ~/.hoerc file.
+* debug_gem        - Show information about the gem.
+* default          - Run the default tasks.
+* deps:email       - Print a contact list for gems dependent on this gem
+* deps:fetch       - Fetch all the dependent gems of this gem into tarballs
+* deps:list        - List all the dependent gems of this gem
+* docs             - Build the docs HTML Files
+* email            - Generate email announcement file.
+* gem              - Build the gem file hoe-1.8.0.gem
+* generate_key     - Generate a key for signing your gems.
+* install_gem      - Install the package as a gem.
+* multi            - Run the test suite using multiruby.
+* package          - Build all the packages
+* post_blog        - Post announcement to blog.
+* post_news        - Post announcement to rubyforge.
+* publish_docs     - Publish RDoc to RubyForge.
+* release          - Package and upload the release to rubyforge.
+* ridocs           - Generate ri locally for testing.
+* tasks            - Generate a list of tasks for doco.
+* test             - Run the test suite.
+* test_deps        - Show which test files fail when run alone.
 
 See class rdoc for help. Hint: ri Hoe
 

data/bin/sow

@@ -4,18 +4,15 @@ $t ||= false
 $d ||= false
 
 if defined? $h then
-  puts "usage: #{File.dirname($0)} [-d|-t] [group] project"
+  puts "usage: #{File.dirname($0)} [-d|-t] project"
   puts "  -t = add project to subdir under 'trunk'"
   puts "  -d = add project to subdir under 'dev'"
 end
 
 abort "You must specify only one of -t or -d" if $t and $d
 
-group = ARGV.shift
 project = ARGV.shift
 
-project ||= group
-
 # prevents false positives on my tag reporter
 X = 'FI' + 'X'
 

data/lib/hoe.rb

@@ -38,27 +38,31 @@ end
 #
 # === Tasks Provided:
 #
-# announce::       Create news email file and post to rubyforge.
-# audit::          Run ZenTest against the package.
-# check_manifest:: Verify the manifest.
-# clean::          Clean up all the extras.
-# config_hoe::     Create a fresh ~/.hoerc file.
-# debug_gem::      Show information about the gem.
-# default::        Run the default tasks.
-# docs::           Build the docs HTML Files
-# email::          Generate email announcement file.
-# gem::            Build the gem file hoe-1.5.0.gem
-# generate_key::   Generate a key for signing your gems.
-# install_gem::    Install the package as a gem.
-# multi::          Run the test suite using multiruby.
-# package::        Build all the packages
-# post_blog::      Post announcement to blog.
-# post_news::      Post announcement to rubyforge.
-# publish_docs::   Publish RDoc to RubyForge.
-# release::        Package and upload the release to rubyforge.
-# ridocs::         Generate ri locally for testing.
-# test::           Run the test suite.
-# test_deps::      Show which test files fail when run alone.
+# announce::          Create news email file and post to rubyforge.
+# audit::             Run ZenTest against the package.
+# check_manifest::    Verify the manifest.
+# clean::             Clean up all the extras.
+# config_hoe::        Create a fresh ~/.hoerc file.
+# debug_gem::         Show information about the gem.
+# default::           Run the default tasks.
+# deps:email::        Print a contact list for gems dependent on this gem
+# deps:fetch::        Fetch all the dependent gems of this gem into tarballs
+# deps:list::         List all the dependent gems of this gem
+# docs::              Build the docs HTML Files
+# email::             Generate email announcement file.
+# gem::               Build the gem file hoe-1.8.0.gem
+# generate_key::      Generate a key for signing your gems.
+# install_gem::       Install the package as a gem.
+# multi::             Run the test suite using multiruby.
+# package::           Build all the packages
+# post_blog::         Post announcement to blog.
+# post_news::         Post announcement to rubyforge.
+# publish_docs::      Publish RDoc to RubyForge.
+# release::           Package and upload the release to rubyforge.
+# ridocs::            Generate ri locally for testing.
+# tasks::             Generate a list of tasks for doco.
+# test::              Run the test suite.
+# test_deps::         Show which test files fail when run alone.
 #
 # === Extra Configuration Options:
 #
@@ -120,7 +124,8 @@ end
 #
 
 class Hoe
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
+  GEMURL = URI.parse 'http://gems.rubyforge.org' # for namespace :deps below
 
   ruby_prefix = Config::CONFIG['prefix']
   sitelibdir = Config::CONFIG['sitelibdir']
@@ -303,6 +308,11 @@ class Hoe
 
   attr_accessor :test_globs
 
+  ##
+  # Optional: What test library to require [default: test/unit]
+
+  attr_accessor :testlib
+
   ##
   # Optional: The url(s) of the project. (can be array). Auto-populates.
 
@@ -313,6 +323,15 @@ class Hoe
 
   attr_accessor :version
 
+  ##
+  # Add extra dirs to both $: and RUBY_FLAGS (for test runs)
+
+  def self.add_include_dirs(*dirs)
+    dirs = dirs.flatten
+    $:.unshift(*dirs)
+    Hoe::RUBY_FLAGS.sub!(/-I/, "-I#{dirs.join(":")}:")
+  end
+
   def normalize_deps deps
     Array(deps).map { |o| String === o ? [o] : o }
   end
@@ -328,7 +347,7 @@ class Hoe
 
     # Defaults
     self.author = []
-    self.clean_globs = %w(diff diff.txt email.txt ri
+    self.clean_globs = %w(diff diff.txt email.txt ri deps .source_index
                           *.gem *~ **/*~ *.rbc **/*.rbc)
     self.description_sections = %w(description)
     self.blog_categories = [name]
@@ -345,6 +364,7 @@ class Hoe
     self.spec_extras = {}
     self.summary_sentences = 1
     self.test_globs = ['test/**/test_*.rb']
+    self.testlib = 'test/unit'
     self.post_install_message = nil
 
     yield self if block_given?
@@ -635,6 +655,133 @@ class Hoe
       end
     end
 
+    ############################################################
+    # Dependencies:
+
+    namespace :deps do
+      require 'zlib' # HACK for rubygems 1.3.0
+      require 'rubygems/remote_fetcher'
+
+      @@index = nil
+
+      def self.get_source_index
+        return @@index if @@index
+
+        dump = unless File.exist? '.source_index' then
+                 url = GEMURL + "Marshal.#{Gem.marshal_version}.Z"
+                 dump = Gem::RemoteFetcher.fetcher.fetch_path url
+                 dump = Gem.inflate dump
+                 open '.source_index', 'wb' do |io| io.write dump end
+                 dump
+               else
+                 open '.source_index', 'rb' do |io| io.read end
+               end
+
+        @@index = Marshal.load dump
+      end
+
+      def self.get_latest_gems
+        @@cache ||= get_source_index.latest_specs
+      end
+
+      def self.get_gems_by_name
+        @@by_name ||= Hash[*get_latest_gems.map { |gem|
+                             [gem.name, gem, gem.full_name, gem]
+                           }.flatten]
+      end
+
+      def self.dependent_upon name
+        get_latest_gems.find_all { |gem|
+          gem.dependencies.any? { |dep| dep.name == name }
+        }
+      end
+
+
+      desc "List all the dependent gems of this gem"
+      task :list do
+        gems = self.get_gems_by_name
+        gem  = gems[self.name]
+
+        abort "Couldn't find gem: #{self.name}" unless gem
+
+        deps = self.dependent_upon self.name
+        max  = deps.map { |s| s.full_name.size }.max
+
+        puts "  dependents:"
+        unless deps.empty? then
+          deps.sort_by { |spec| spec.full_name }.each do |spec|
+            vers = spec.dependencies.find {|s| s.name == name }.requirement_list
+            puts "    %-*s - %s" % [max, spec.full_name, vers.join(", ")]
+          end
+        else
+          puts "    none"
+        end
+      end
+
+      desc "Print a contact list for gems dependent on this gem"
+      task :email do
+        gems = self.get_gems_by_name
+        gem  = gems[self.name]
+
+        abort "Couldn't find gem: #{self.name}" unless gem
+
+        deps = self.dependent_upon self.name
+
+        email = deps.map { |s| s.email }.flatten.sort.uniq
+        email = email.map { |s| s.split(/,\s*/) }.flatten.sort.uniq
+
+        email.map! { |s| # don't you people realize how easy this is?
+          s.gsub(/ at | _at_ |\s*(atmark|@nospam@|-at?-|@at?@|<at?>|\[at?\]|\(at?\))\s*/i, '@').gsub(/\s*(dot|\[d(ot)?\]|\.dot\.)\s*/i, '.').gsub(/\s+com$/, '.com')
+        }
+
+        bad, good = email.partition { |e| e !~ /^[\w.+-]+\@[\w.+-]+$/ }
+
+        warn "Rejecting #{bad.size} email. I couldn't unmunge them." unless
+          bad.empty?
+
+        puts good.join(", ")
+      end
+
+      desc "Fetch all the dependent gems of this gem into tarballs"
+      task :fetch do
+        gems = self.get_gems_by_name
+        gem  = gems[self.name]
+        deps = self.dependent_upon self.name
+
+        mkdir "deps" unless File.directory? "deps"
+        Dir.chdir "deps" do
+          begin
+            deps.sort_by { |spec| spec.full_name }.each do |spec|
+              full_name = spec.full_name
+              tgz_name  = "#{full_name}.tgz"
+              gem_name  = "#{full_name}.gem"
+
+              next if File.exist? tgz_name
+              FileUtils.rm_rf [full_name, gem_name]
+
+              begin
+                warn "downloading #{full_name}"
+                Gem::RemoteFetcher.fetcher.download(spec, GEMURL, Dir.pwd)
+                FileUtils.mv "cache/#{gem_name}", '.'
+              rescue Gem::RemoteFetcher::FetchError
+                warn "  failed"
+                next
+              end
+
+              warn "converting #{gem_name} to tarball"
+
+              system "gem unpack #{gem_name} 2> /dev/null"
+              system "gem spec -l #{gem_name} > #{full_name}/gemspec.rb"
+              system "tar zmcf #{tgz_name} #{full_name}"
+              FileUtils.rm_rf [full_name, gem_name, "cache"]
+            end
+          ensure
+            FileUtils.rm_rf "cache"
+          end
+        end
+      end
+    end
+
     ############################################################
     # Misc/Maintenance:
 
@@ -825,7 +972,8 @@ class Hoe
     cmd = if test ?f, 'test/test_all.rb' then
             "#{RUBY_FLAGS} test/test_all.rb #{FILTER}"
           else
-            tests = ['test/unit'] + test_globs.map { |g| Dir.glob(g) }.flatten
+            tests = ["rubygems", self.testlib] +
+              test_globs.map { |g| Dir.glob(g) }.flatten
             tests.map! {|f| %Q(require "#{f}")}
             "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
           end
@@ -862,5 +1010,11 @@ end
 
 if $0 == __FILE__ then
   out = `rake -T | egrep -v "redocs|repackage|clobber|trunk"`
-  puts out.gsub(/\#/, '-').gsub(/^rake /, '# * ')
+  if ARGV.empty? then
+    # # default::        Run the default tasks.
+    puts out.gsub(/(\s*)\#/, '::\1').gsub(/^rake /, '# ')
+  else
+    # * default        - Run the default tasks.
+    puts out.gsub(/\#/, '-').gsub(/^rake /, '* ')
+  end
 end

data/test/test_hoe.rb

@@ -22,6 +22,9 @@ class TestHoe < Test::Unit::TestCase
                   config_hoe
                   debug_gem
                   default
+                  deps:email
+                  deps:fetch
+                  deps:list
                   docs
                   email
                   generate_key

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hoe
 version: !ruby/object:Gem::Version 
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-30 00:00:00 -07:00
+date: 2008-10-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,9 +30,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.1
+        version: 0.8.3
     version: 
-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:  * announce       - Create news email file and post to rubyforge. * audit          - Run ZenTest against the package. * check_manifest - Verify the manifest. * clean          - Clean up all the extras. * config_hoe     - Create a fresh ~/.hoerc file. * debug_gem      - Show information about the gem. * default        - Run the default tasks. * docs           - Build the docs HTML Files * email          - Generate email announcement file. * gem            - Build the gem file hoe-1.5.0.gem * generate_key   - Generate a key for signing your gems. * install_gem    - Install the package as a gem. * multi          - Run the test suite using multiruby. * package        - Build all the packages * post_blog      - Post announcement to blog. * post_news      - Post announcement to rubyforge. * publish_docs   - Publish RDoc to RubyForge. * release        - Package and upload the release to rubyforge. * ridocs         - Generate ri locally for testing. * test           - Run the test suite. * test_deps      - Show which test files fail when run alone.  See class rdoc for help. Hint: ri Hoe"
+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:  * announce         - Create news email file and post to rubyforge. * audit            - Run ZenTest against the package. * check_manifest   - Verify the manifest. * clean            - Clean up all the extras. * config_hoe       - Create a fresh ~/.hoerc file. * debug_gem        - Show information about the gem. * default          - Run the default tasks. * deps:email       - Print a contact list for gems dependent on this gem * deps:fetch       - Fetch all the dependent gems of this gem into tarballs * deps:list        - List all the dependent gems of this gem * docs             - Build the docs HTML Files * email            - Generate email announcement file. * gem              - Build the gem file hoe-1.8.0.gem * generate_key     - Generate a key for signing your gems. * install_gem      - Install the package as a gem. * multi            - Run the test suite using multiruby. * package          - Build all the packages * post_blog        - Post announcement to blog. * post_news        - Post announcement to rubyforge. * publish_docs     - Publish RDoc to RubyForge. * release          - Package and upload the release to rubyforge. * ridocs           - Generate ri locally for testing. * tasks            - Generate a list of tasks for doco. * test             - Run the test suite. * test_deps        - Show which test files fail when run alone.  See class rdoc for help. Hint: ri Hoe"
 email: 
 - ryand-ruby@zenspider.com
 executables: 
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: seattlerb
-rubygems_version: 1.2.0
+rubygems_version: 1.3.0
 signing_key: 
 specification_version: 2
 summary: Hoe is a simple rake/rubygems helper for project Rakefiles