echoe 1.0.0

data/History.txt

@@ -0,0 +1,90 @@
+= 1.0.0 2007-01-10
+
+* Echoe fork to remove unecessary meta-dependency on self in output gems
+
+= 1.1.6 2006-11-29
+
+* Fix release to work correctly with need_zip and need_tar.
+
+= 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
+
+* 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
+
+* Added test_deps, now you can automatically discover test dependency ommisions.
+* Added ext support! Build C extensions with hoe!
+* Gemspec uses test_all.rb or result of test_globs. Tweak those tests.
+* Now uses https to login to rubyforge. Rubyforge crackers beware!
+* Fixed doco and automated updating of it.
+* Added rdoc_pattern. Go doco go!
+
+= 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.
+* Added test_globs to customize your test file list.
+* Removed demo.rb from clean_globs. I'm torn on this one.
+* Fixed bug in install rule.
+
+= 1.1.1 2006-10-11
+
+* Fixed minor problem with subject of email.
+* Fixed problem in test.
+
+= 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
+
+* Doco cleanup.
+* Removed Manifest.txt from rdoc and added title.
+* Added changeset support.
+* Added spec_extras for easy gemspec attribute setting.
+* Added release_notes, changeset setting for releases.
+* Added paragraphs_of utility method.
+* Added email and rubyforge news announcement tasks.
+* Url attribute may now be an array of urls.
+
+= 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
+
+* Added debug_gem rule.
+* Added lots of doco.
+* Added proper deps to hoe for other's gems, and rake/rubyforge/rubygems for hoe.
+* Added ridocs to generate ri locally for testing.
+* Added support for multiple authors.
+* Fixed include paths.
+* Rdoc now includes any top level .txt files.
+* Renamed deploy to release.
+* Renamed upload to publish_docs.
+* publish_docs is now smart about subprojects and missing subdirectories.
+
+= 1.0.2 2006-09-20
+
+* Wee little tests.
+* Fixed up gemspec's require_paths.
+
+= 1.0.1 2006-09-20
+
+* Finally got deployment straightened out. Maybe. Some might be on rubyforge.org.
+* Added default description and summary.
+* Added dependency mechanism.
+* Improved gemspec debugging.
+* Swapped gem with tgz in deploy... we'd rather screw up on tgz
+
+= 1.0.0 2006-09-19
+
+* Birthday!

data/LICENSE.txt

@@ -0,0 +1,184 @@
+Academic Free License (AFL) v. 3.0
+
+This Academic Free License (the "License") applies to any original work
+of authorship (the "Original Work") whose owner (the "Licensor") has
+placed the following licensing notice adjacent to the copyright notice
+for the Original Work:
+
+Licensed under the Academic Free License version 3.0
+
+1) Grant of Copyright License. Licensor grants You a worldwide,
+royalty-free, non-exclusive, sublicensable license, for the duration of
+the copyright, to do the following:
+
+a) to reproduce the Original Work in copies, either alone or as part of
+a collective work;
+
+b) to translate, adapt, alter, transform, modify, or arrange the
+Original Work, thereby creating derivative works ("Derivative Works")
+based upon the Original Work;
+
+c) to distribute or communicate copies of the Original Work and
+Derivative Works to the public, under any license of your choice that
+does not contradict the terms and conditions, including Licensor's
+reserved rights and remedies, in this Academic Free License;
+
+d) to perform the Original Work publicly; and
+
+e) to display the Original Work publicly.
+
+2) Grant of Patent License. Licensor grants You a worldwide,
+royalty-free, non-exclusive, sublicensable license, under patent claims
+owned or controlled by the Licensor that are embodied in the Original
+Work as furnished by the Licensor, for the duration of the patents, to
+make, use, sell, offer for sale, have made, and import the Original Work
+and Derivative Works.
+
+3) Grant of Source Code License. The term "Source Code" means the
+preferred form of the Original Work for making modifications to it and
+all available documentation describing how to modify the Original Work.
+Licensor agrees to provide a machine-readable copy of the Source Code of
+the Original Work along with each copy of the Original Work that
+Licensor distributes. Licensor reserves the right to satisfy this
+obligation by placing a machine-readable copy of the Source Code in an
+information repository reasonably calculated to permit inexpensive and
+convenient access by You for as long as Licensor continues to distribute
+the Original Work.
+
+4) Exclusions From License Grant. Neither the names of Licensor, nor the
+names of any contributors to the Original Work, nor any of their
+trademarks or service marks, may be used to endorse or promote products
+derived from this Original Work without express prior permission of the
+Licensor. Except as expressly stated herein, nothing in this License
+grants any license to Licensor's trademarks, copyrights, patents, trade
+secrets or any other intellectual property. No patent license is granted
+to make, use, sell, offer for sale, have made, or import embodiments of
+any patent claims other than the licensed claims defined in Section 2.
+No license is granted to the trademarks of Licensor even if such marks
+are included in the Original Work. Nothing in this License shall be
+interpreted to prohibit Licensor from licensing under terms different
+from this License any Original Work that Licensor otherwise would have a
+right to license.
+
+5) External Deployment. The term "External Deployment" means the use,
+distribution, or communication of the Original Work or Derivative Works
+in any way such that the Original Work or Derivative Works may be used
+by anyone other than You, whether those works are distributed or
+communicated to those persons or made available as an application
+intended for use over a network. As an express condition for the grants
+of license hereunder, You must treat any External Deployment by You of
+the Original Work or a Derivative Work as a distribution under section
+1(c).
+
+6) Attribution Rights. You must retain, in the Source Code of any
+Derivative Works that You create, all copyright, patent, or trademark
+notices from the Source Code of the Original Work, as well as any
+notices of licensing and any descriptive text identified therein as an
+"Attribution Notice." You must cause the Source Code for any Derivative
+Works that You create to carry a prominent Attribution Notice reasonably
+calculated to inform recipients that You have modified the Original
+Work.
+
+7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants
+that the copyright in and to the Original Work and the patent rights
+granted herein by Licensor are owned by the Licensor or are sublicensed
+to You under the terms of this License with the permission of the
+contributor(s) of those copyrights and patent rights. Except as
+expressly stated in the immediately preceding sentence, the Original
+Work is provided under this License on an "AS IS" BASIS and WITHOUT
+WARRANTY, either express or implied, including, without limitation, the
+warranties of non-infringement, merchantability or fitness for a
+particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL
+WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential
+part of this License. No license to the Original Work is granted by this
+License except under this disclaimer.
+
+8) Limitation of Liability. Under no circumstances and under no legal
+theory, whether in tort (including negligence), contract, or otherwise,
+shall the Licensor be liable to anyone for any indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or the use of the Original Work including,
+without limitation, damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages
+or losses. This limitation of liability shall not apply to the extent
+applicable law prohibits such limitation.
+
+9) Acceptance and Termination. If, at any time, You expressly assented
+to this License, that assent indicates your clear and irrevocable
+acceptance of this License and all of its terms and conditions. If You
+distribute or communicate copies of the Original Work or a Derivative
+Work, You must make a reasonable effort under the circumstances to
+obtain the express assent of recipients to the terms of this License.
+This License conditions your rights to undertake the activities listed
+in Section 1, including your right to create Derivative Works based upon
+the Original Work, and doing so without honoring these terms and
+conditions is prohibited by copyright law and international treaty.
+Nothing in this License is intended to affect copyright exceptions and
+limitations (including "fair use" or "fair dealing"). This License shall
+terminate immediately and You may no longer exercise any of the rights
+granted to You by this License upon your failure to honor the conditions
+in Section 1(c).
+
+10) Termination for Patent Action. This License shall terminate
+automatically and You may no longer exercise any of the rights granted
+to You by this License as of the date You commence an action, including
+a cross-claim or counterclaim, against Licensor or any licensee alleging
+that the Original Work infringes a patent. This termination provision
+shall not apply for an action alleging patent infringement by
+combinations of the Original Work with other software or hardware.
+
+11) Jurisdiction, Venue and Governing Law. Any action or suit relating
+to this License may be brought only in the courts of a jurisdiction
+wherein the Licensor resides or in which Licensor conducts its primary
+business, and under the laws of that jurisdiction excluding its
+conflict-of-law provisions. The application of the United Nations
+Convention on Contracts for the International Sale of Goods is expressly
+excluded. Any use of the Original Work outside the scope of this License
+or after its termination shall be subject to the requirements and
+penalties of copyright or patent law in the appropriate jurisdiction.
+This section shall survive the termination of this License.
+
+12) Attorneys' Fees. In any action to enforce the terms of this License
+or seeking damages relating thereto, the prevailing party shall be
+entitled to recover its costs and expenses, including, without
+limitation, reasonable attorneys' fees and costs incurred in connection
+with such action, including any appeal of such action. This section
+shall survive the termination of this License.
+
+13) Miscellaneous. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable.
+
+14) Definition of "You" in This License. "You" throughout this License,
+whether in upper or lower case, means an individual or a legal entity
+exercising rights under, and complying with all of the terms of, this
+License. For legal entities, "You" includes any entity that controls, is
+controlled by, or is under common control with you. For purposes of this
+definition, "control" means (i) the power, direct or indirect, to cause
+the direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+15) Right to Use. You may use the Original Work in all ways not
+otherwise restricted or conditioned by this License or by law, and
+Licensor promises not to interfere with or be responsible for such uses
+by You.
+
+16) Modification of This License. This License is Copyright (c) 2005
+Lawrence Rosen. Permission is granted to copy, distribute, or
+communicate this License without modification. Nothing in this License
+permits You to modify this License as applied to the Original Work or to
+Derivative Works. However, You may modify the text of this License and
+copy, distribute or communicate your modified version (the "Modified
+License") and apply it to other original works of authorship subject to
+the following conditions: (i) You may not indicate in any way that your
+Modified License is the "Academic Free License" or "AFL" and you may not
+use those names in the name of your Modified License; (ii) You must
+replace the notice specified in the first paragraph above with the
+notice "Licensed under <insert your license name here>" or with a notice
+of your own that is not confusingly similar to the notice in this
+License; and (iii) You may not claim that your original works are open
+source software unless your Modified License has been approved by Open
+Source Initiative (OSI) and You comply with its license review and
+certification process.
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+LICENSE.txt
+Rakefile
+bin/echoe
+lib/echoe.rb
+test/test_echoe.rb

data/README.txt

@@ -0,0 +1,95 @@
+echoe
+    http://rubyforge.org/projects/fauna/
+    Evan Weaver
+
+== DESCRIPTION:
+
+echoe 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         - Generate email announcement file and post to rubyforge.
+* audit            - Run ZenTest against the package
+* check_manifest   - Verify the manifest
+* clean            - Clean up all the extras
+* debug_gem        - Show information about the gem.
+* default          - Run the default tasks
+* docs             - Build the docs HTML Files
+* email            - Generate email announcement file.
+* install          - Install the package. Uses PREFIX and RUBYLIB
+* install_gem      - Install the package as a gem
+* multi            - Run the test suite using multiruby
+* package          - Build all the packages
+* 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. Use FILTER to add to the command line.
+* test_deps        - Show which test files fail when run alone.
+* uninstall        - Uninstall the package.
+
+See class rdoc for help. Hint: ri echoe
+
+== DIFFERENCES FROM HOE:
+
+* Removes unnecessary meta-dependency on self in created gems
+
+== FEATURES/PROBLEMS:
+  
+* Provides 'echoe' command line tool for quick project directory creation.
+* Make making and maintaining Rakefiles fun and easy.
+
+== SYNOPSYS:
+
+  % sow [group] project
+
+or
+
+  require 'echoe'
+  
+  Echoe.new(projectname, version) do |p|
+    # ... project specific data ...
+  end
+
+  # ... project specific tasks ...
+
+== REQUIREMENTS:
+
+* rake
+* rubyforge
+* rubygems
+
+== INSTALL:
+
+* sudo gem install echoe
+
+== LICENSE:
+
+Copyright 2007 Evan Weaver.
+Licensed under the Academic Free License 3.0. See LICENSE.txt, included. 
+The following license also applies to portions of the software:
+
+(The MIT License)
+
+Copyright (c) 2006 Ryan Davis, Zen Spider Software
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+require './lib/echoe.rb'
+
+Echoe.new("echoe", Echoe::VERSION) do |p|
+  p.name = "echoe"
+  p.rubyforge_name = "fauna"
+  p.summary = "Echoe makes gem creation easy."
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/bin/echoe

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby -ws
+
+$t ||= false
+$d ||= false
+
+if defined? $h then
+  puts "usage: #{File.dirname($0)} [-d|-t] [group] 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'
+
+abort "You must supply a project name on the commandline" unless project
+abort "Project #{project} seems to exist" if test ?d, project
+puts "creating project #{project}"
+
+case project
+when /_/ then
+  file_name = project
+  project = project.capitalize.gsub(/_([a-z])/) {$1.upcase}
+  klass = project
+else
+  file_name = project.gsub(/([A-Z])/, '_\1').downcase.sub(/^_/, '')
+  klass = project.capitalize.gsub(/_([a-z])/) {$1.upcase}
+end
+
+Dir.mkdir project
+Dir.chdir project do
+
+  if $d then
+    Dir.mkdir "dev"
+    Dir.chdir "dev"
+  elsif $t then
+    Dir.mkdir "trunk"
+    Dir.chdir "trunk"
+  end
+
+  %w(bin lib test).each do |path|
+    Dir.mkdir path
+  end
+
+  files = {
+    "History.txt" => "== 1.0.0 / #{Time.new.strftime("%Y-%m-%d")}\n\n* 1 major enhancement\n  * Birthday!\n\n",
+    "README.txt" => "#{project}\n    by #{X} (your name)\n    #{X} (url)\n\n== DESCRIPTION:\n  \n#{X} (describe your package)\n\n== FEATURES/PROBLEMS:\n  \n* #{X} (list of features or problems)\n\n== SYNOPSYS:\n\n  #{X} (code sample of usage)\n\n== REQUIREMENTS:\n\n* #{X} (list of requirements)\n\n== INSTALL:\n\n* #{X} (sudo gem install, anything else)\n\n== LICENSE:\n\n(The MIT License)\n\nCopyright (c) #{Time.new.strftime("%Y")} #{X}\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n",
+    "Manifest.txt" => "",
+    "bin/#{file_name}" => "",
+    "lib/#{file_name}.rb" => "class #{klass}\n  VERSION = '1.0.0'\nend",
+    "test/test_#{file_name}.rb" => "",
+    "Rakefile" => "# -*- ruby -*-\n\nrequire 'rubygems'\nrequire 'echoe'\nrequire './lib/#{file_name}.rb'\n\nechoe.new('#{project}', #{klass}::VERSION) do |p|\n  p.rubyforge_name = \'#{group}\'\n  # p.summary = '#{X}'\n  # p.description = p.paragraphs_of('README.txt', 2..5).join(\"\\n\\n\")\n  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\\n/)[1..-1]\n  p.changes = p.paragraphs_of('History.txt', 0..1).join(\"\\n\\n\")\nend\n\n# vim: syntax=Ruby\n"
+  }
+
+  files["Manifest.txt"] = files.keys.sort.join("\n")
+
+  files.each do |file, content|
+    File.open(file, "w") do |f|
+      f.write content
+    end
+  end
+end
+
+puts "... done, now go fix all occurances of '#{X}'"
+puts `find #{project} -type f | xargs grep -n #{X}`.gsub(/\A|\n/, "\n  ")

data/lib/echoe.rb

@@ -0,0 +1,440 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rake'
+require 'rake/contrib/sshpublisher'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'rbconfig'
+
+##
+# echoe - a tool to help rake
+#
+# echoe is a simple rake/rubygems helper for project Rakefiles. It
+# generates all the usual tasks for projects including rdoc generation,
+# testing, packaging, and deployment.
+#
+# == Using echoe
+#
+# === Basics
+#
+# Use this as a minimal starting point:
+#
+#   require 'echoe'
+# 
+#   Echoe.new("project_name", '1.0.0') do |p|
+#     p.rubyforge_name = "rf_project"
+#     # add other details here
+#   end
+#
+#   # add other tasks here
+#
+# === Tasks Provided:
+# 
+# * announce         - Generate email announcement file and post to rubyforge.
+# * audit            - Run ZenTest against the package
+# * check_manifest   - Verify the manifest
+# * clean            - Clean up all the extras
+# * debug_gem        - Show information about the gem.
+# * default          - Run the default tasks
+# * docs             - Build the docs HTML Files
+# * email            - Generate email announcement file.
+# * install          - Install the package. Uses PREFIX and RUBYLIB
+# * install_gem      - Install the package as a gem
+# * multi            - Run the test suite using multiruby
+# * package          - Build all the packages
+# * 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. Use FILTER to add to the command line.
+# * test_deps        - Show which test files fail when run alone.
+# * uninstall        - Uninstall the package.
+#
+# === Attributes
+#
+# The attributes that you can provide inside the new block above are:
+#
+# ==== Mandatory
+#
+# * name        - The name of the release.
+# * version     - The version. Don't hardcode! use a constant in the project.
+#
+# ==== Damn Good to Set
+#
+# * author      - The author of the package. (can be array of authors)
+# * changes     - A description of the release's latest changes.
+# * description - A description of the project.
+# * email       - The author's email address. (can be array of urls)
+# * summary     - A short summary of the project.
+# * url         - The url of the project.
+#
+# ==== Optional
+#
+# * clean_globs    - An array of file patterns to delete on clean.
+# * extra_deps     - An array of rubygem dependencies.
+# * need_tar       - Should package create a tarball? [default: true]
+# * need_zip       - Should package create a zipfile? [default: false]
+# * rdoc_pattern   - A regexp to match documentation files against the manifest.
+# * rubyforge_name - The name of the rubyforge project. [default: name.downcase]
+# * spec_extras    - A hash of extra values to set in the gemspec.
+# * test_globs     - An array of test file patterns [default: test/**/test_*.rb]
+#
+# === Environment Variables
+#
+# * FILTER     - Used to add flags to test_unit (e.g., -n test_borked)
+# * PREFIX     - Used to specify a custom install location (for rake install).
+# * RUBY_DEBUG - Used to add extra flags to RUBY_FLAGS.
+# * RUBY_FLAGS - Used to specify flags to ruby [has smart default].
+
+class Echoe
+  VERSION = '1.0.0'
+
+  rubyprefix = Config::CONFIG['prefix']
+  sitelibdir = Config::CONFIG['sitelibdir']
+
+  PREFIX = ENV['PREFIX'] || rubyprefix
+  RUBYLIB = if PREFIX == rubyprefix then
+              sitelibdir
+            else
+              File.join(PREFIX, sitelibdir[rubyprefix.size..-1])
+            end
+  RUBY_DEBUG = ENV['RUBY_DEBUG']
+  RUBY_FLAGS = ENV['RUBY_FLAGS'] ||
+    "-w -I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}" +
+    (RUBY_DEBUG ? " #{RUBY_DEBUG}" : '')
+  FILTER = ENV['FILTER'] # for tests (eg FILTER="-n test_blah")
+
+  attr_accessor :author, :bin_files, :changes, :clean_globs, :description, :email, :extra_deps, :lib_files, :name, :need_tar, :need_zip, :rdoc_pattern, :rubyforge_name, :spec, :spec_extras, :summary, :test_files, :test_globs, :url, :version
+
+  def initialize(name, version)
+    self.name = name
+    self.version = version
+
+    # Defaults
+    self.rubyforge_name = name.downcase
+    self.url = ""
+    self.author = ""
+    self.email = ""
+    self.clean_globs = %w(diff diff.txt email.txt ri *.gem **/*~)
+    self.test_globs = ['test/**/test_*.rb']
+    self.changes = ""
+    self.description = ""
+    self.summary = ""
+    self.rdoc_pattern = /^(lib|bin)|txt$/
+    self.extra_deps = []
+    self.spec_extras = {}
+    self.need_tar = true
+    self.need_zip = false
+
+    if name == 'echoe' then
+      extra_deps << ['rake']
+      extra_deps << ['rubyforge', '>= 0.4.0']
+    else
+#      extra_deps << ['echoe', ">= #{VERSION}"]
+    end
+
+    yield self if block_given?
+
+    define_tasks
+  end
+
+  def define_tasks
+    desc 'Run the default tasks'
+    task :default => :test
+
+    desc 'Run the test suite. Use FILTER to add to the command line.'
+    task :test do
+      run_tests
+    end
+
+    desc 'Show which test files fail when run alone.'
+    task :test_deps do
+      tests = Dir["test/**/test_*.rb"]  +  Dir["test/**/*_test.rb"]
+
+      tests.each do |test|
+        if not system "ruby -Ibin:lib:test #{test} &> /dev/null" then
+          puts "Dependency Issues: #{test}"
+        end
+      end
+    end
+
+    desc 'Run the test suite using multiruby'
+    task :multi do
+      run_tests :multi
+    end
+
+    ############################################################
+    # Packaging and Installing
+
+    self.spec = Gem::Specification.new do |s|
+      s.name = name
+      s.version = version
+      s.summary = summary
+      case author
+      when Array
+        s.authors = author
+      else
+        s.author = author
+      end
+      s.email = email
+      s.homepage = Array(url).first
+      s.rubyforge_project = rubyforge_name
+
+      s.description = description
+
+      extra_deps.each do |dep|
+        s.add_dependency(*dep)
+      end
+
+      s.files = File.read("Manifest.txt").split
+      s.executables = s.files.grep(/bin/) { |f| File.basename(f) }
+
+      s.bindir = "bin"
+      dirs = Dir['{lib,ext}']
+      s.require_paths = dirs unless dirs.empty?
+      s.has_rdoc = true
+
+      if test ?f, "test/test_all.rb" then
+        s.test_file = "test/test_all.rb"
+      else
+        s.test_files = Dir[*test_globs]
+      end
+
+      # Do any extra stuff the user wants
+      spec_extras.each do |msg, val|
+        case val
+        when Proc
+          val.call(s.send(msg))
+        else
+          s.send "#{msg}=", val
+        end
+      end
+    end
+
+    desc 'Show information about the gem.'
+    task :debug_gem do
+      puts spec.to_ruby
+    end
+
+    self.lib_files = spec.files.grep(/^lib/)
+    self.bin_files = spec.files.grep(/^bin/)
+    self.test_files = spec.files.grep(/^test/)
+
+    Rake::GemPackageTask.new spec do |pkg|
+      pkg.need_tar = @need_tar
+      pkg.need_zip = @need_zip
+    end
+
+    desc 'Install the package. Uses PREFIX and RUBYLIB'
+    task :install do
+      [
+       [lib_files + test_files, RUBYLIB, 0444],
+       [bin_files, File.join(PREFIX, 'bin'), 0555]
+      ].each do |files, dest, mode|
+        FileUtils.mkdir_p dest unless test ?d, dest
+        files.each do |file|
+          install file, dest, :mode => mode
+        end
+      end
+    end
+
+    desc 'Install the package as a gem'
+    task :install_gem => [:clean, :package] do
+      sh "sudo gem install pkg/*.gem"
+    end
+
+    desc 'Uninstall the package.'
+    task :uninstall do
+      Dir.chdir RUBYLIB do
+        rm_f((lib_files + test_files).map { |f| File.basename f })
+      end
+      Dir.chdir File.join(PREFIX, 'bin') do
+        rm_f bin_files.map { |f| File.basename f }
+      end
+    end
+
+    desc 'Package and upload the release to rubyforge.'
+    task :release => [:clean, :package] do |t|
+      v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+      abort "Versions don't match #{v} vs #{version}" if v != version
+      require 'rubyforge'
+      pkg = "pkg/#{name}-#{version}"
+
+      if $DEBUG then
+        puts "release_id = rf.add_release #{rubyforge_name.inspect}, #{name.inspect}, #{version.inspect}, \"#{pkg}.tgz\""
+        puts "rf.add_file #{rubyforge_name.inspect}, #{name.inspect}, release_id, \"#{pkg}.gem\""
+      end
+
+      rf = RubyForge.new
+      puts "Logging in"
+      rf.login
+
+      c = rf.userconfig
+      c["release_notes"] = description if description
+      c["release_changes"] = changes if changes
+      c["preformatted"] = true
+
+      files = [(@need_tar ? "#{pkg}.tgz" : nil),
+               (@need_zip ? "#{pkg}.zip" : nil),
+               "#{pkg}.gem"].compact
+
+      puts "Releasing #{name} v. #{version}"
+      rf.add_release rubyforge_name, name, version, *files
+    end
+
+    ############################################################
+    # Doco
+
+    Rake::RDocTask.new(:docs) do |rd|
+      rd.main = "README.txt"
+      rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/
+      rd.rdoc_dir = 'doc'
+      files = spec.files.grep(rdoc_pattern)
+      files -= ['Manifest.txt']
+      rd.rdoc_files.push(*files)
+
+      title = "#{name}-#{version} Documentation"
+      title = "#{rubyforge_name}'s " + title if rubyforge_name != title
+
+      rd.options << "-t #{title}"
+    end
+
+    desc "Generate ri locally for testing"
+    task :ridocs => :clean do
+      sh %q{ rdoc --ri -o ri . }
+    end
+
+    desc 'Publish RDoc to RubyForge'
+    task :publish_docs => [:clean, :docs] do
+      config = YAML.load(File.read(File.expand_path("~/.rubyforge/config.yml")))
+      user = "#{config["username"]}@rubyforge.org"
+      project = "/var/www/gforge-projects/#{rubyforge_name}"
+      project += "/#{name}" if rubyforge_name != name
+      local_dir = 'doc'
+      pub = Rake::SshDirPublisher.new user, project, local_dir
+      if rubyforge_name != name then
+        def pub.upload
+          begin
+            super
+          rescue
+            # project directory probably doesn't exist, transfer as a whole
+            sh %{scp -qr #{local_dir} #{host}:#{remote_dir}}
+          end
+        end
+      end
+      pub.upload
+    end
+
+    ############################################################
+    # Misc/Maintenance:
+
+    desc 'Run ZenTest against the package'
+    task :audit do
+      libs = %w(lib test).join(File::PATH_SEPARATOR)
+      sh "zentest -I=#{libs} #{spec.files.grep(/^(lib|test)/).join(' ')}"
+    end
+
+    desc 'Clean up all the extras'
+    task :clean => [ :clobber_docs, :clobber_package ] do
+      clean_globs.each do |pattern|
+        files = Dir[pattern]
+        rm_rf files unless files.empty?
+      end
+    end
+
+    desc 'Generate email announcement file.'
+    task :email do
+      require 'rubyforge'
+      subject, title, body, urls = announcement
+
+      File.open("email.txt", "w") do |mail|
+        mail.puts "Subject: [ANN] #{subject}"
+        mail.puts
+        mail.puts title
+        mail.puts
+        mail.puts urls
+        mail.puts
+        mail.puts body
+        mail.puts
+        mail.puts urls
+      end
+      puts "Created email.txt"
+    end
+
+    desc 'Post announcement to rubyforge.'
+    task :post_news do
+      require 'rubyforge'
+      subject, title, body, urls = announcement
+
+      rf = RubyForge.new
+      rf.login
+      rf.post_news(rubyforge_name, subject, "#{title}\n\n#{body}")
+      puts "Posted to rubyforge"
+    end
+
+    desc 'Generate email announcement file and post to rubyforge.'
+    task :announce => [:email, :post_news]
+
+    desc "Verify the manifest"
+    task :check_manifest => :clean do
+      f = "Manifest.tmp"
+      require 'find'
+      files = []
+      Find.find '.' do |path|
+        next unless File.file? path
+        next if path =~ /svn|tmp$/
+        files << path[2..-1]
+      end
+      files = files.sort.join "\n"
+      File.open f, 'w' do |fp| fp.puts files end
+      system "diff -du Manifest.txt #{f}"
+      rm f
+    end
+
+  end # end define
+
+  def announcement
+    urls = "  " + Array(url).map {|s| s.strip}.join("\n  ")
+
+    subject = "#{name} #{version} Released"
+    title = "#{name} version #{version} has been released!"
+    body = "#{description}\n\nChanges:\n\n#{changes}"
+
+    return subject, title, body, urls
+  end
+
+  def run_tests(multi=false) # :nodoc:
+    msg = multi ? :sh : :ruby
+    cmd = if test ?f, 'test/test_all.rb' then
+            "#{RUBY_FLAGS} test/test_all.rb #{FILTER}"
+          else
+            tests = test_globs.map { |g| Dir.glob(g) }.flatten << 'test/unit'
+            tests.map! {|f| %Q(require "#{f}")}
+            "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
+          end
+    cmd = "multiruby #{cmd}" if multi
+    send msg, cmd
+  end
+
+  ##
+  # Reads a file at +path+ and spits out an array of the +paragraphs+ specified
+  #
+  #   changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  #   summary, *description = p.paragraphs_of('Readme.txt', 3, 3..8)
+
+  def paragraphs_of(path, *paragraphs)
+    file = File.read(path)
+    file.split(/\n\n+/).values_at(*paragraphs)
+  end
+end
+
+class ::Rake::SshDirPublisher # :nodoc:
+  attr_reader :host, :remote_dir, :local_dir
+end
+
+if $0 == __FILE__ then
+  out = `rake -T | egrep -v "redocs|repackage|clobber|trunk"`
+  puts out.gsub(/\#/, '-').gsub(/^rake /, '# * ')
+end

data/test/test_echoe.rb

@@ -0,0 +1,26 @@
+
+require 'test/unit/testcase'
+require 'echoe'
+
+$rakefile = nil # shuts up a warning in rdoctask.rb
+
+class TestEchoe < Test::Unit::TestCase
+  def setup
+    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)
+    expected += boring
+
+    Echoe.new('blah', '1.0.0')
+    tasks = Rake.application.tasks.map { |t| t.name }.sort
+
+    assert_equal expected.sort, tasks
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0.9
+specification_version: 1
+name: echoe
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-01-10 00:00:00 -05:00
+summary: Echoe makes gem creation easy.
+require_paths: 
+- lib
+email: ""
+homepage: "    http://rubyforge.org/projects/fauna/"
+rubyforge_project: fauna
+description: "echoe 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         - Generate email announcement file and post to rubyforge. * audit            - Run ZenTest against the package * check_manifest   - Verify the manifest * clean            - Clean up all the extras * debug_gem        - Show information about the gem. * default          - Run the default tasks * docs             - Build the docs HTML Files * email            - Generate email announcement file. * install          - Install the package. Uses PREFIX and RUBYLIB * install_gem      - Install the package as a gem * multi            - Run the test suite using multiruby * package          - Build all the packages * 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. Use FILTER to add to the command line. * test_deps        - Show which test files fail when run alone. * uninstall        - Uninstall the package.  See class rdoc for help. Hint: ri echoe"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- ""
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- LICENSE.txt
+- Rakefile
+- bin/echoe
+- lib/echoe.rb
+- test/test_echoe.rb
+test_files: 
+- test/test_echoe.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- echoe
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: