echoe 2.1 → 2.3

data/CHANGELOG

@@ -1,7 +1,11 @@
 
+v2.3. Work around metadependencies issue by including gemspecs instead of Rakefiles by default; include_gemspec and include_rakefile accessors.
+
+v2.2. Need_gem option; announce task.
+
 v2.1. Adjust default RDoc include pattern; extra_deps now dependencies; rubyforge_name now project; support install messages; manifest instead of build_manifest.
 
-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.
+v2. Support documentation hosts other than rubyforge; auto-load CHANGELOG contents; remove bin/echoe which doesn't work anyway. Incompatible changes.
 
 v1.4. Auto-detect readme file; make rdoc default pattern compatible with manifest generator; fix publish_docs task.
 

data/Manifest

@@ -1,5 +1,6 @@
 test/test_echoe.rb
 lib/echoe.rb
+TODO
 Rakefile
 README
 Manifest

data/README

@@ -5,7 +5,7 @@ Echoe is a simple tool for working with Rubygems. It generates Rake tasks for do
 
 == License
 
-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.
+Copyright 2007 Cloudburst, LLC. See the included LICENSE file. Portions copyright 2006 Ryan Davis/Zen Spider Software and used with permission. See the included MIT-LICENSE file.
 
 == Features
 

data/Rakefile

@@ -7,6 +7,10 @@ Echoe.new('echoe') do |p|
   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']
+  p.dependencies = ['rake', 'rubyforge >=0.4.3', 'highline']
+
+  # Echoe is self-dependent
+  p.include_gemspec = false
+  p.include_rakefile = true
 end
 

data/TODO

@@ -0,0 +1,3 @@
+
+* Figure out why need_gem = false caused releasing to fail
+* Add support for Rubyforge release announcements

data/lib/echoe.rb

@@ -7,24 +7,30 @@ require 'rake/gempackagetask'
 require 'rake/rdoctask'
 require 'rake/testtask'
 require 'rbconfig'
+require 'open-uri'
 require 'highline/import'
-gem 'rubyforge', '>= 0.4.0'
+gem 'rubyforge', '>=0.4.0'
 require 'rubyforge'
 
 =begin rdoc
 
 Echoe includes some optional accessors for more advanced gem configuration.
 
-For example, Echoe's own <tt>Rakefile</tt> looks like this:
+For example, a simple <tt>Rakefile</tt> might look like this:
 
-  Echoe.new('echoe') do |p|
-    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']
+  Echoe.new("uncapitalizer") do |p|
+    p.author = "Evan Weaver"
+    p.summary = "A library that uncapitalizes strings. It's awesome."
+    p.url = "http://www.uncapitalizer.com"
+    p.docs_host = "uncapitalizer.com:~/www/files/doc/"
+    p.dependencies = ["string_tools >=1.4.0"]
   end
+  
+== Metadependencies
+
+Echoe does not force packages to depend on Echoe itself. Instead, it generates a <tt>gemspec</tt> from your <tt>Rakefile</tt> and includes that, along with a comment containing the original <tt>Rakefile</tt> source. Downstream repackagers can use the <tt>gemspec</tt> as-is to build new versions of your gem. This way no dependencies are added, but no contents are lost.
+
+If you do want metadependencies, add <tt>'echoe'</tt> to the <tt>p.dependencies</tt> array, and set <tt>p.include_rakefile = true</tt> and <tt>p.include_gemspec = false</tt>.
 
 == Accessor options
 
@@ -46,14 +52,19 @@ Packaging options:
 
 * <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_gem</tt> - Whether to generate a gem package (default <tt>true</tt>).
 * <tt>need_tar_gz</tt> - Whether to generate a <tt>.tar.gz</tt> package (default <tt>true</tt>).
+* <tt>need_tgz</tt> - Whether to generate a <tt>.tgz</tt> package (default <tt>false</tt>).
 * <tt>need_zip</tt> - Whether to generate a <tt>.zip</tt> package (default <tt>false</tt>).
+* <tt>extensions</tt> - Any extension files that need to be executed (defaults to <tt>"ext/extconf.rb"</tt> if it exists).
+* <tt>include_gemspec</tt> - Include the generated gemspec file within the package. Default <tt>true</tt>.
+* <tt>include_rakefile</tt> - Include the Rakefile within the package. Default <tt>false</tt>.
 
 Publishing options:
 
 * <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).
+* <tt>docs_host</tt> - A host and filesystem path to publish the documentation to (defaults to the Rubyforge project).
+* <tt>announce</tt> - Generate a release announcement, edit it, and post it to Rubyforge.
 
 Documentation options:
 
@@ -80,10 +91,10 @@ class Echoe
   FILTER = ENV['FILTER'] # for tests (eg FILTER="-n test_blah")
   
   # user-configurable
-  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
+  attr_accessor :author, :changes, :clean_pattern, :description, :email, :dependencies, :need_tgz, :need_tar_gz, :need_gem, :need_zip, :rdoc_pattern, :project, :summary, :test_pattern, :url, :version, :docs_host, :rdoc_template, :manifest_name, :install_message, :extensions
   
   # best left alone
-  attr_accessor :name, :lib_files, :test_files, :bin_files, :spec, :rdoc_options, :rubyforge_name
+  attr_accessor :name, :lib_files, :test_files, :bin_files, :spec, :rdoc_options, :rubyforge_name, :has_rdoc, :include_gemspec, :include_rakefile, :gemspec_name
   
   # legacy
   attr_accessor :extra_deps
@@ -116,15 +127,22 @@ class Echoe
     self.description = ""
     self.summary = ""
     self.install_message = nil
+    self.has_rdoc = true
     self.rdoc_pattern = /^(lib|bin|tasks)|^README|^CHANGELOG|^TODO|^LICENSE$/
     self.rdoc_options = ['--line-numbers', '--inline-source']
     self.dependencies = []
     self.manifest_name = "Manifest"
+    self.extensions = ["ext/extconf.rb"] if File.exist?("ext/extconf.rb")
 
-    self.need_tar = false    
+    self.need_gem = true
     self.need_tar_gz = true
+    self.need_tgz = false    
     self.need_zip = false
 
+    self.include_rakefile = false
+    self.include_gemspec = true    
+    self.gemspec_name = "#{name}.gemspec"
+
     yield self if block_given?
     
     # set some post-defaults
@@ -161,33 +179,68 @@ class Echoe
 
       begin
         s.files = File.read(manifest_name).split
+        s.files += [gemspec_name] if include_gemspec
+        s.files += ["Rakefile"] if include_rakefile
+        s.files.uniq! # not really necessary
       rescue Errno::ENOENT
-        $stderr.puts "Missing Manifest. You can build one with\n$ rake build_manifest."
+        puts "Missing manifest. You can build one with 'rake manifest'."
+        exit
       end
       s.executables = s.files.grep(/bin/) { |f| File.basename(f) }
 
       s.bindir = "bin"
       dirs = Dir['{lib,ext}']
+      s.extensions = Array(extensions) if extensions
       s.require_paths = dirs unless dirs.empty?
-      s.has_rdoc = true
+      s.has_rdoc = has_rdoc
 
       if File.exist? "test/test_all.rb"
         s.test_file = "test/test_all.rb"
       else
         s.test_files = Dir[*test_pattern]
       end
-
     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
+    Rake::GemPackageTask.new(spec) do |pkg|
+      pkg.need_tar = @need_tgz
       pkg.need_tar_gz = @need_tar_gz
       pkg.need_zip = @need_zip
     end
+        
+    task :build_gemspec do
+      # Construct the gemspec file, if needed.
+      if include_gemspec
+        File.open(gemspec_name, 'w') do |f|          
+          f.puts "\n# Gem::Specification for #{name.capitalize}-#{version}\n# Originally generated by Echoe\n\n"
+          f.puts spec.to_ruby
+          
+          f.puts "\n\n# # Original Rakefile source (requires the Echoe gem):\n# \n"
+          File.open("Rakefile").readlines.each do |line|
+            f.write "# #{line}"
+          end                    
+        end
+      end      
+    end
+    
+    # Chain it to the gemspec task prerequisite
+    task gemspec_name.to_sym => [:build_gemspec] 
+        
+    task :package do
+      # Chain some cleanup tasks to the default :package task.
+      # Remove the gemfile if it wasn't actually requested. 
+      unless @need_gem
+        puts "  Gem file not requested. Removed."
+        system "rm pkg/*.gem"
+      end
+      # Remove the generated gemspec once the packaging is done, to discourage people from modifying it by hand.
+      if include_gemspec and File.exist? gemspec_name
+        File.delete gemspec_name
+      end
+    end  
 
     desc 'Install the gem'
     task :install => [:clean, :package] do
@@ -219,23 +272,20 @@ class Echoe
         c["release_changes"] = changes if changes
         c["preformatted"] = false
   
-        files = [(@need_tar ? pkg_tar : nil),
+        files = [(@need_tgz ? pkg_tar : nil),
                   (@need_tar_gz ? pkg_tar_gz : nil),
-                 (@need_zip ? pkg_zip : nil),
-                 pkg_gem].compact
+                  (@need_zip ? pkg_zip : nil),
+                  (@need_gem ? pkg_gem : nil)].compact
   
         puts "Releasing #{name} v. #{version}"
         self.version = self.version.ljust(3)
-  
-        begin
-          rf.add_release project, name, version, *files
-        rescue NoMethodError
-        end
+          
+        rf.add_release project, name, version, *files
       end
       
     end
     
-    ### RDoc
+    ### Documentation
 
     Rake::RDocTask.new(:docs) do |rd|      
       rd.main = Dir['*'].detect {|f| f =~ /^readme/i}
@@ -289,6 +339,39 @@ class Echoe
         sh("scp -qr #{local_dir} #{host}:#{dir}/#{remote_dir_name}")
       end      
     end
+        
+    desc 'Generate a release announcement, edit it, and post it to Rubyforge.'
+    task :announce do
+      
+      filename = "/tmp/#{name}_#{version}_announcement.txt"
+      
+      if !File.exist?(filename) or agree "Overwrite existing announcement file? "        
+        File.open(filename, 'w') do |f|
+          f.write "Subject: #{name.capitalize} #{version}\n\n"
+          f.write "#{name.capitalize} has been updated to #{version}. #{name.capitalize} is #{summary.uncapitalize}\n\n"
+          f.write "Changes in this version: #{changes.sub(/^\s*[\w\d\.]+\s+/, '').uncapitalize}\n\n" unless changes.empty?
+          f.write "More information is available at #{url} .\n\n" unless url.empty?
+        end
+      end
+      
+      begin        
+        system("nano #{filename}") or raise "Editor returned an error"
+        puts File.open(filename).read
+      end while !agree "Done editing? "
+      
+      if agree "Publish announcement to Rubyforge? "
+        File.open(filename).readlines.detect { |line| line =~ /Subject: (.*)/ }
+        subject = $1 or raise "Subject line seems to have disappeared"
+        
+        body = File.open(filename).readlines.reject { |line| line =~ /Subject: / }.join.gsub("\n\n\n", "\n\n")
+        
+        rf = RubyForge.new
+        rf.login
+        rf.post_news(project, subject, body)
+        puts "Published."
+        File.delete filename
+      end
+    end    
     
     ### Clean
 
@@ -307,13 +390,19 @@ class Echoe
       files = []
       Find.find '.' do |file|
         file = file[2..-1]
-        unless !file or file =~ /^(pkg|doc)|\.svn|CVS|\.bzr|\.DS/ or File.directory? file
-          files << file
-        end
+        next unless file
+        next if file =~ /^(pkg|doc)|\.svn|CVS|\.bzr|\.DS/
+        next if File.directory?(file)
+        next if !include_rakefile and file == "Rakefile"
+        files << file
       end
-      files = (files << manifest_name).uniq
-      File.open(manifest_name, 'w').puts files
-      puts files
+
+      files << "Rakefile" if include_rakefile
+      files << manifest_name
+      files.uniq!
+      
+      File.open(manifest_name, 'w').puts(files)
+      puts(files)
     end
     
     task :build_manifest => [:manifest]
@@ -340,3 +429,10 @@ end
 class ::Rake::SshDirPublisher # :nodoc:
   attr_reader :host, :remote_dir, :local_dir
 end
+
+class String #:nodoc:
+  def uncapitalize #:nodoc:
+    "#{self[0..0].downcase}#{self[1..-1]}"
+  end
+end
+

data/test/test_echoe.rb

@@ -2,7 +2,7 @@
 require 'test/unit/testcase'
 require 'echoe'
 
-$rakefile = nil # shuts up a warning in rdoctask.rb
+$rakefile = nil # Avoids a warning in rdoctask.rb
 
 class TestEchoe < Test::Unit::TestCase
   def setup
@@ -10,10 +10,8 @@ class TestEchoe < Test::Unit::TestCase
   end
 
   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.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
-
+    expected = ["announce", "blah.gemspec", "build_gemspec", "build_manifest", "clean", "clobber", "clobber_docs", "clobber_package", "default", "doc", "doc/index.html", "docs", "gem", "install", "manifest", "package", "pkg", "pkg/blah-1.0.0", "pkg/blah-1.0.0.gem", "pkg/blah-1.0.0.tar.gz", "publish_docs", "redocs", "release", "repackage", "test", "uninstall"]
+    
     Echoe.new('blah', '1.0.0')
     tasks = Rake.application.tasks.map { |t| t.name }
     assert((expected - tasks).empty?)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: echoe
 version: !ruby/object:Gem::Version 
-  version: "2.1"
-date: 2007-08-06 00:00:00 -04:00
+  version: "2.3"
+date: 2007-08-13 00:00:00 -04:00
 summary: A tool for packaging Ruby gems.
 require_paths: 
 - lib
@@ -31,6 +31,7 @@ authors:
 files: 
 - test/test_echoe.rb
 - lib/echoe.rb
+- TODO
 - Rakefile
 - README
 - Manifest
@@ -66,10 +67,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 0.4.0
+        version: 0.4.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: highline