echoe 2 → 2.1

data/CHANGELOG

@@ -1,12 +1,14 @@
 
-v2. support documentation hosts other than rubyforge, switch to Snax-style gem versioning; auto-load CHANGELOG contents; remove bin/echoe which doesn't work anyway
+v2.1. Adjust default RDoc include pattern; extra_deps now dependencies; rubyforge_name now project; support install messages; manifest instead of build_manifest.
 
-v1.4. auto-detect readme file; make rdoc default pattern compatible with manifest generator; fix publish_docs task
+v2. Support documentation hosts other than rubyforge; switch to Snax-style gem versioning; auto-load CHANGELOG contents; remove bin/echoe which doesn't work anyway. Incompatible changes.
 
-v1.3. avoid rubyforge gem multi-activation conflict
+v1.4. Auto-detect readme file; make rdoc default pattern compatible with manifest generator; fix publish_docs task.
 
-v1.2. build_manifest Rake task
+v1.3. Avoid rubyforge gem multi-activation conflict.
 
-v1.1. sane error messages on releasing new or duplicate gems; allow Manifest to not end in .txt
+v1.2. build_manifest Rake task.
 
-v1.0.0. fork from Hoe
+v1.1. Sane error messages on releasing new or duplicate gems; allow Manifest to not end in .txt.
+
+v1.0.0. Fork from Hoe.

data/README

@@ -7,9 +7,22 @@ Echoe is a simple tool for working with Rubygems. It generates Rake tasks for do
 
 Copyright 2007 Cloudburst, LLC. See included LICENSE file. Portions copyright 2006 Ryan Davis, Zen Spider Software, and used with permission. See included MIT-LICENSE file.
 
-== Usage
+== Features
 
-First, organize your gem according to the usual structure:
+* simple configuration
+* comprehensive gem deployment
+* automatic changeset parsing
+* documentation upload to any host
+
+= Usage
+
+== Installation
+
+  sudo gem install echoe
+
+== Project configuration
+
+Organize your gem according to the usual structure:
 
   lib/
   bin/  
@@ -31,19 +44,25 @@ This way Echoe can parse the latest version and changeset message automatically.
 
 Your <tt>Rakefile</tt> needs the following minimal contents:
 
-  require "rubygems"
-  require "echoe"  
-  Echoe.new("gem_name")
+  require 'rubygems'
+  require 'echoe'  
+  Echoe.new('gem_name')
   
 More advanced configuration is described in the Echoe class.
 
 == Deploying your gem
 
-Now, to build your documentation and deploy the gem:
+First, run <tt>rubyforge setup</tt> and <tt>rubyforge config</tt> if you haven't already. Make sure your Rubyforge password is correctly set.
 
-  rake build_manifest
-  rake publish_docs
+Now, to deploy the gem and documentation:
+
+  rake manifest
   rake release
+  rake publish_docs
+
+Once you've built your manifest, you only need to rebuild it if you add or remove files from the package structure.
+
+= Extras
 
 == All Rake tasks
 
@@ -51,7 +70,7 @@ The following tasks are made available to your gem.
 
 Packaging:
 
-* <tt>build_manifest</tt> -  Build a Manifest list.
+* <tt>manifest</tt> -  Build a manifest list.
 * <tt>docs</tt> -  Build the documentation.
 * <tt>package</tt> -  Build all the packages.
 
@@ -72,3 +91,7 @@ Cleaning:
 * <tt>redocs</tt> -  Force a rebuild of the Rdoc files.
 * <tt>repackage</tt> -  Force a rebuild of the package files.
 
+== Further resources
+
+* http://blog.evanweaver.com/pages/code#echoe
+* http://rubyforge.org/forum/forum.php?forum_id=13986

data/Rakefile

@@ -2,11 +2,11 @@
 require 'lib/echoe'
 
 Echoe.new('echoe') do |p|
-  p.rubyforge_name = "fauna"
-  p.author = "Evan Weaver"
-  p.summary = "Echoe is a simple packaging tool for Ruby gems."
-  p.url = "http://blog.evanweaver.com/pages/code#echoe"
-  p.docs_host = "blog.evanweaver.com:~/www/snax/public/files/doc/"
-  p.extra_deps = ['rake', 'rubyforge >= 0.4.0', 'highline']
+  p.project = 'fauna'
+  p.author = 'Evan Weaver'
+  p.summary = 'A tool for packaging Ruby gems.'
+  p.url = 'http://blog.evanweaver.com/pages/code#echoe'
+  p.docs_host = 'blog.evanweaver.com:~/www/snax/public/files/doc/'
+  p.dependencies = ['rake', 'rubyforge >= 0.4.0', 'highline']
 end
 

data/lib/echoe.rb

@@ -1,6 +1,7 @@
 
 require 'rubygems'
 require 'rake'
+require 'rake/clean'
 require 'rake/contrib/sshpublisher'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
@@ -17,15 +18,15 @@ Echoe includes some optional accessors for more advanced gem configuration.
 For example, Echoe's own <tt>Rakefile</tt> looks like this:
 
   Echoe.new('echoe') do |p|
-    p.rubyforge_name = "fauna"
-    p.author = "Evan Weaver"
-    p.summary = "Echoe is a simple tool for packaging Rubygems."
-    p.url = "http://blog.evanweaver.com/pages/code#echoe"
-    p.docs_host = "blog.evanweaver.com:~/www/snax/public/files/doc/"
-    p.extra_deps = ['rake', 'rubyforge >= 0.4.0', 'highline']
+    p.project = 'fauna'
+    p.author = 'Evan Weaver'
+    p.summary = 'A tool for packaging Ruby gems.'
+    p.url = 'http://blog.evanweaver.com/pages/code#echoe'
+    p.docs_host = 'blog.evanweaver.com:~/www/snax/public/files/doc/'
+    p.dependencies = ['rake', 'rubyforge >= 0.4.0', 'highline']
   end
 
-== Available options
+== Accessor options
 
 Descriptive options:
 
@@ -34,15 +35,16 @@ Descriptive options:
 * <tt>description</tt> - A more detailed description of the library.
 * <tt>summary</tt> - A shorter description of the library.
 * <tt>url</tt> - A url for the library.
+* <tt>install_message</tt> - A message to display after the gem is installed.
 
-Version options:
+Versioning options:
 
 * <tt>version</tt> - A string for the version number. Parsed from CHANGELOG otherwise.
 * <tt>changes</tt> - A string describing the most recent changes. Parsed from CHANGELOG otherwise.
 
 Packaging options:
 
-* <tt>extra_deps</tt> - An array of dependencies for this gem, in 'gem_name [= version]' format.
+* <tt>dependencies</tt> - An array of dependencies for this gem, in 'gem_name [= version]' format.
 * <tt>manifest_name</tt> - The name of the manifest file (defaults to <tt>Manifest</tt>).
 * <tt>need_tar</tt> - Whether to generate a <tt>.tgz</tt> package (default <tt>false</tt>).
 * <tt>need_tar_gz</tt> - Whether to generate a <tt>.tar.gz</tt> package (default <tt>true</tt>).
@@ -50,7 +52,7 @@ Packaging options:
 
 Publishing options:
 
-* <tt>rubyforge_name</tt> - The name of the Rubyforge project to upload to (defaults to the name of the gem).
+* <tt>project</tt> - The name of the Rubyforge project to upload to (defaults to the name of the gem).
 * <tt>docs_host</tt> - A host and path to publish the documentation to (defaults to the Rubyforge project).
 
 Documentation options:
@@ -78,21 +80,24 @@ class Echoe
   FILTER = ENV['FILTER'] # for tests (eg FILTER="-n test_blah")
   
   # user-configurable
-  attr_accessor :author, :changes, :clean_pattern, :description, :email, :extra_deps, :name, :need_tar, :need_tar_gz, :need_zip, :rdoc_pattern, :rubyforge_name, :summary, :test_patterns, :url, :version, :docs_host, :rdoc_template, :manifest_name
+  attr_accessor :author, :changes, :clean_pattern, :description, :email, :dependencies, :need_tar, :need_tar_gz, :need_zip, :rdoc_pattern, :project, :summary, :test_pattern, :url, :version, :docs_host, :rdoc_template, :manifest_name, :install_message
   
   # best left alone
-  attr_accessor :lib_files, :test_files, :bin_files, :spec
+  attr_accessor :name, :lib_files, :test_files, :bin_files, :spec, :rdoc_options, :rubyforge_name
+  
+  # legacy
+  attr_accessor :extra_deps
   
   def initialize(name, version = nil)
     # Defaults
 
     self.name = name
-    self.rubyforge_name = name.downcase
+    self.project = name.downcase
     self.url = ""
     self.author = ""
     self.email = ""
     self.clean_pattern = %w(diff diff.txt email.txt ri *.gem **/*~)
-    self.test_patterns = ['test/**/test_*.rb']
+    self.test_pattern = ['test/**/test_*.rb']
     
     self.version = if version
       version
@@ -110,8 +115,10 @@ class Echoe
         
     self.description = ""
     self.summary = ""
-    self.rdoc_pattern = /^(lib|bin|tasks)|README|CHANGELOG|LICENSE|txt$/
-    self.extra_deps = []
+    self.install_message = nil
+    self.rdoc_pattern = /^(lib|bin|tasks)|^README|^CHANGELOG|^TODO|^LICENSE$/
+    self.rdoc_options = ['--line-numbers', '--inline-source']
+    self.dependencies = []
     self.manifest_name = "Manifest"
 
     self.need_tar = false    
@@ -119,21 +126,22 @@ class Echoe
     self.need_zip = false
 
     yield self if block_given?
+    
+    # set some post-defaults
+    self.description = summary if description.empty?
+    self.summary = description if summary.empty?
+    
+    # legacy compatibility
+    self.dependencies = extra_deps if extra_deps and dependencies.empty?
+    self.project = rubyforge_name if rubyforge_name
 
     define_tasks
   end
 
   def define_tasks
-    task :default => :test
-
-    desc 'Run the test suite'
-    task :test do
-      run_tests
-    end
-
-    ############################################################
-    # Packaging and Installing
 
+    ### Packaging and Installing
+    
     self.spec = Gem::Specification.new do |s|
       s.name = name
       s.version = version
@@ -141,11 +149,12 @@ class Echoe
       s.author = Array(author).join(", ")
       s.email = email
       s.homepage = url
-      s.rubyforge_project = rubyforge_name
+      s.rubyforge_project = project
+      s.post_install_message = install_message if install_message
 
       s.description = description
 
-      extra_deps.each do |dep|
+      dependencies.each do |dep|
         dep = dep.split(" ") if dep.is_a? String
         s.add_dependency(*dep)
       end
@@ -165,7 +174,7 @@ class Echoe
       if File.exist? "test/test_all.rb"
         s.test_file = "test/test_all.rb"
       else
-        s.test_files = Dir[*test_patterns]
+        s.test_files = Dir[*test_pattern]
       end
 
     end
@@ -219,20 +228,23 @@ class Echoe
         self.version = self.version.ljust(3)
   
         begin
-          rf.add_release rubyforge_name, name, version, *files
+          rf.add_release project, name, version, *files
         rescue NoMethodError
         end
       end
       
     end
+    
+    ### RDoc
 
     Rake::RDocTask.new(:docs) do |rd|      
       rd.main = Dir['*'].detect {|f| f =~ /^readme/i}
-      rd.options << '--line-numbers' << '--inline-source'
+      rd.options += Array(rdoc_options)
+      
       rd.rdoc_dir = 'doc'
 
       files = (spec.files.grep(rdoc_pattern) - [manifest_name]).uniq
-      rd.rdoc_files.push *files
+      rd.rdoc_files.push(*files)
 
       if rdoc_template
         rd.template = rdoc_template 
@@ -243,20 +255,22 @@ class Echoe
       title = name.downcase == name ? name.capitalize : name
       rd.options << "-t #{title}"
     end
+        
+    task :doc => [:redocs]
 
     desc "Publish documentation to #{docs_host ? "'#{docs_host}'" : "rubyforge"}"
     task :publish_docs => [:clean, :docs] do
 
       local_dir = 'doc'
-      remote_dir_name = rubyforge_name
-      remote_dir_name += "/#{name}" if rubyforge_name != name
+      remote_dir_name = project
+      remote_dir_name += "/#{name}" if project != name
 
       unless docs_host  
         config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
         pub = Rake::SshDirPublisher.new "#{config["username"]}@rubyforge.org", 
           "/var/www/gforge-projects/#{remote_dir_name}", 
           local_dir
-        if rubyforge_name != name then
+        if project != name then
           def pub.upload
             begin
               super
@@ -275,8 +289,8 @@ class Echoe
         sh("scp -qr #{local_dir} #{host}:#{dir}/#{remote_dir_name}")
       end      
     end
-        
-    task :doc => [:redocs]
+    
+    ### Clean
 
     desc 'Delete the generated documentation and packages'
     task :clean => [ :clobber_docs, :clobber_package ] do
@@ -285,13 +299,15 @@ class Echoe
         rm_rf files unless files.empty?
       end
     end
+    
+    ### Manifest
 
     desc "Build a Manifest list"
-    task :build_manifest do
+    task :manifest do
       files = []
       Find.find '.' do |file|
         file = file[2..-1]
-        unless !file or file =~ /^(pkg|doc)|\.svn|CVS|\.bzr/ or File.directory? file
+        unless !file or file =~ /^(pkg|doc)|\.svn|CVS|\.bzr|\.DS/ or File.directory? file
           files << file
         end
       end
@@ -299,18 +315,26 @@ class Echoe
       File.open(manifest_name, 'w').puts files
       puts files
     end
+    
+    task :build_manifest => [:manifest]
+  
+    ### Tests
+  
+    # XXX unreadable
+    desc 'Run the test suite'
+    task :test do
+      ruby(if File.exist? 'test/test_all.rb'
+        "#{RUBY_FLAGS} test/test_all.rb #{FILTER}"
+      else
+        tests = test_pattern.map { |g| Dir.glob(g) }.flatten << 'test/unit'
+        tests.map! {|f| %Q(require "#{f}")}
+        "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
+      end)
+    end
+  
+    task :default => :test
+    
   end
-
-  def run_tests # :nodoc:
-    ruby(if File.exist? 'test/test_all.rb'
-      "#{RUBY_FLAGS} test/test_all.rb #{FILTER}"
-    else
-      tests = test_patterns.map { |g| Dir.glob(g) }.flatten << 'test/unit'
-      tests.map! {|f| %Q(require "#{f}")}
-      "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
-    end)
-  end
-
 end
 
 class ::Rake::SshDirPublisher # :nodoc:

data/test/test_echoe.rb

@@ -9,18 +9,14 @@ class TestEchoe < Test::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 clobber_docs clobber_package doc doc/index.html pkg pkg/blah-1.0.0 pkg/blah-1.0.0.gem pkg/blah-1.0.0.tgz redocs repackage)
-    expected = %w(audit announce check_manifest clean debug_gem default docs email gem install install_gem multi package post_news publish_docs release ridocs test test_deps uninstall)
+    boring = %w(clobber clobber_docs clobber_package doc doc/index.html pkg pkg/blah-1.0.0 pkg/blah-1.0.0.gem pkg/blah-1.0.0.tar.gz redocs repackage default)
+    expected = %w(clean clobber clobber_docs clobber_package docs gem install manifest package publish_docs redocs release repackage test uninstall build_manifest)
     expected += boring
 
     Echoe.new('blah', '1.0.0')
-    tasks = Rake.application.tasks.map { |t| t.name }.sort
-
-    assert_equal expected.sort, tasks
+    tasks = Rake.application.tasks.map { |t| t.name }
+    assert((expected - tasks).empty?)
+    assert((tasks - expected).empty?)
   end
 end

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: echoe
 version: !ruby/object:Gem::Version 
-  version: "2"
-date: 2007-08-03 00:00:00 -04:00
-summary: Echoe is a simple packaging tool for Ruby gems.
+  version: "2.1"
+date: 2007-08-06 00:00:00 -04:00
+summary: A tool for packaging Ruby gems.
 require_paths: 
 - lib
 email: ""
 homepage: http://blog.evanweaver.com/pages/code#echoe
 rubyforge_project: fauna
-description: ""
+description: A tool for packaging Ruby gems.
 autorequire: 
 default_executable: 
 bindir: bin