echoe 1.3 → 1.4

data/CHANGELOG

@@ -1,6 +1,7 @@
 
+1.4. auto-detect readme file; make rdoc default pattern compatible with manifest generator; fix publish_docs task; use env var for rdoc template if available
 1.3. avoid rubyforge gem multi-activation conflict
 1.2. build_manifest Rake task
-1.1. Sane error messages on releasing new or duplicate gems; allow Manifest to not end in .txt
-1.0.0. Fork from Hoe
+1.1. sane error messages on releasing new or duplicate gems; allow Manifest to not end in .txt
+1.0.0. fork from Hoe
 

data/lib/echoe.rb

@@ -62,12 +62,12 @@ require 'rbconfig'
 # * name        - The name of the release.
 # * version     - The version. Don't hardcode! use a constant in the project.
 #
-# ==== Damn Good to Set
+# ==== Good to Set
 #
-# * author      - The author of the package. (can be array of authors)
+# * author      - The author of the package.
 # * 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)
+# * email       - The author's email address.
 # * summary     - A short summary of the project.
 # * url         - The url of the project.
 #
@@ -78,6 +78,7 @@ require 'rbconfig'
 # * 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.
+# * rdoc_template  - Path to an external rdoc template file
 # * 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]
@@ -105,7 +106,7 @@ class Echoe
     "-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_tar_gz, :need_zip, :rdoc_pattern, :rubyforge_name, :spec, :spec_extras, :summary, :test_files, :test_globs, :url, :version, :tar_extension #, :tar_separator, :zip_separator
+  attr_accessor :author, :bin_files, :changes, :clean_globs, :description, :email, :extra_deps, :lib_files, :name, :need_tar, :need_tar_gz, :need_zip, :rdoc_pattern, :rubyforge_name, :spec, :spec_extras, :summary, :test_files, :test_globs, :url, :version, :tar_extension, :rdoc_template #, :tar_separator, :zip_separator
 
   def initialize(name, version)
     self.name = name
@@ -121,7 +122,7 @@ class Echoe
     self.changes = ""
     self.description = ""
     self.summary = ""
-    self.rdoc_pattern = /^(lib|bin)|txt$/
+    self.rdoc_pattern = /^(\.\/|)(lib|bin|tasks)|README|CHANGELOG|LICENSE|txt$/
     self.extra_deps = []
     self.spec_extras = {}
     self.need_tar = true
@@ -167,12 +168,7 @@ class Echoe
       s.name = name
       s.version = version
       s.summary = summary
-      case author
-      when Array
-        s.authors = author
-      else
-        s.author = author
-      end
+      s.author = Array(author).join(", ")
       s.email = email
       s.homepage = Array(url).first
       s.rubyforge_project = rubyforge_name
@@ -183,8 +179,7 @@ class Echoe
         s.add_dependency(*dep)
       end
 
-      manifest = "Manifest"
-      manifest += ".txt" if File.exist? "Manifest.txt"
+      manifest = File.exist?('Manifest.txt') ? 'Manifest.txt' : 'Manifest'
       begin
         s.files = File.read(manifest).split
       rescue Errno::ENOENT
@@ -197,7 +192,7 @@ class Echoe
       s.require_paths = dirs unless dirs.empty?
       s.has_rdoc = true
 
-      if test ?f, "test/test_all.rb" then
+      if File.exist? "test/test_all.rb"
         s.test_file = "test/test_all.rb"
       else
         s.test_files = Dir[*test_globs]
@@ -229,21 +224,8 @@ class Echoe
       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
+    task :install => [:clean, :package] do
       sh "sudo gem install pkg/*.gem"
     end
 
@@ -259,7 +241,7 @@ class Echoe
 
     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"
+      v = ENV["VERSION"] or abort "Must supply VERSION=x"
       abort "Versions don't match #{v} vs #{version}" if v != version
 
       gem 'rubyforge', '>= 0.4.0'
@@ -283,7 +265,7 @@ class Echoe
       c = rf.userconfig
       c["release_notes"] = description if description
       c["release_changes"] = changes if changes
-      c["preformatted"] = true
+      c["preformatted"] = false
 
       files = [(@need_tar ? pkg_tar : nil),
                 (@need_tar_gz ? pkg_tar_gz : nil),
@@ -303,17 +285,22 @@ class Echoe
     ############################################################
     # Doco
 
-    Rake::RDocTask.new(:docs) do |rd|
-      rd.main = "README.txt"
+    Rake::RDocTask.new(:docs) do |rd|      
+      rd.main = Dir['*'].detect {|f| f =~ /^readme/i}
       rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/
+      rd.options << '--line-numbers' << '--inline-source'
       rd.rdoc_dir = 'doc'
       files = spec.files.grep(rdoc_pattern)
       files -= ['Manifest.txt', 'Manifest']
-      rd.rdoc_files.push(*files)
+      rd.rdoc_files.push *files
 
-      title = "#{name}-#{version} Documentation"
-      title = "#{rubyforge_name}'s " + title if rubyforge_name != title
+      if rdoc_template
+        rd.template = rdoc_template 
+      elsif ENV['RDOC_TEMPLATE'] and File.exist? ENV['RDOC_TEMPLATE']
+        rd.template = ENV['RDOC_TEMPLATE']
+      end      
 
+      title = name.capitalize if name.downcase == name
       rd.options << "-t #{title}"
     end
 
@@ -324,7 +311,7 @@ class Echoe
 
     desc 'Publish RDoc to RubyForge'
     task :publish_docs => [:clean, :docs] do
-      config = YAML.load(File.read(File.expand_path("~/.rubyforge/config.yml")))
+      config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
       user = "#{config["username"]}@rubyforge.org"
       project = "/var/www/gforge-projects/#{rubyforge_name}"
       project += "/#{name}" if rubyforge_name != name
@@ -342,16 +329,12 @@ class Echoe
       end
       pub.upload
     end
+    
+    task :doc => [:docs]
 
     ############################################################
     # 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|
@@ -360,39 +343,6 @@ class Echoe
       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"
@@ -429,16 +379,6 @@ class Echoe
     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
@@ -452,16 +392,6 @@ class Echoe
     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:

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: echoe
 version: !ruby/object:Gem::Version 
-  version: "1.3"
-date: 2007-05-12 00:00:00 -04:00
+  version: "1.4"
+date: 2007-08-02 00:00:00 -04:00
 summary: Echoe is a simple packaging tool for working with rubygems.
 require_paths: 
 - lib