echoe 2.5 → 2.6

data/CHANGELOG

@@ -1,4 +1,6 @@
 
+v2.6. Unify pattern handling; changelog accessor, version accessor, expand paths of keys and certificates; support verbose (Rails-style) changelogs.
+
 v2.5. Add some extension building tasks; adjust clean behavior; rdoc inclusions definitely depend on Manifest now; ruby_version accessor; ignore_pattern for skipping files during the manifest build; bugfixes.
 
 v2.4.1. Manifest doesn't require itself (willcodeforwork).

data/Manifest

@@ -1,9 +1,8 @@
 TODO
-test/test_echoe.rb
 README
 Rakefile
 MIT-LICENSE
+Manifest
 LICENSE
 lib/echoe.rb
 CHANGELOG
-Manifest

data/README

@@ -47,7 +47,6 @@ 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')
   
@@ -80,6 +79,8 @@ Packaging:
 Testing:
 
 * <tt>test</tt> -  Run the test suite.
+* <tt>compile</tt> - Compile C extensions, if available.
+* <tt>clean</tt> - Clean up generated documentation, packaging, and build files.
 * <tt>install</tt> -  Install the gem locally.
 * <tt>uninstall</tt> -  Uninstall the gem.
 

data/lib/echoe.rb

@@ -18,6 +18,8 @@ Echoe includes some optional accessors for more advanced gem configuration.
 
 For example, a simple <tt>Rakefile</tt> might look like this:
 
+  require 'echoe'
+  
   Echoe.new("uncapitalizer") do |p|
     p.author = "Evan Weaver"
     p.summary = "A library that uncapitalizes strings. It's awesome."
@@ -25,6 +27,8 @@ For example, a simple <tt>Rakefile</tt> might look like this:
     p.docs_host = "uncapitalizer.com:~/www/files/doc/"
     p.dependencies = ["string_tools >=1.4.0"]
   end
+  
+See below for the full list.
 
 == Signing gems
 
@@ -70,23 +74,24 @@ Versioning options:
 
 Common packaging options:
 
-* <tt>dependencies</tt> - An array of dependencies for this gem, in 'gem_name [= version]' format.
-* <tt>extensions</tt> - Any extension files that need to be run at install time (defaults to <tt>"ext/**/extconf.rb"</tt>).
+* <tt>dependencies</tt> - An array of dependencies for this gem. For example, <tt>['mongrel', 'rake >=0.7.1']</tt>.
+* <tt>extension_pattern</tt> - A filename array, glob array, or regex for extension files that need to be run at install time. Defaults to <tt>"ext/**/extconf.rb"</tt>.
 * <tt>clean_pattern</tt> - A filename array, glob array, or regex for files that should be removed when <tt>rake clean</tt> is run.
-* <tt>test_pattern</tt> - A filename array, glob array, or regex for test runners. Defaults to <tt>"test/test_all.rb"</tt> if it exists.
+* <tt>test_pattern</tt> - A filename array, glob array, or regex for test runners. Overridden by <tt>"test/test_all.rb"</tt>, if it exists.
 
 Uncommon packaging options:
 * <tt>platform</tt> - What platform this gem is for.
-* <tt>manifest_name</tt> - The name of the manifest file (defaults to <tt>Manifest</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>include_rakefile</tt> - Include the Rakefile directly within the package. Default <tt>false</tt>.
-* <tt>include_gemspec</tt> - Include the generated gemspec file within the package. Default <tt>true</tt>.
-* <tt>ruby_version</tt> - Version string for which Ruby to require (for example, <tt>'>= 1.8.4'</tt>).
+* <tt>manifest_name</tt> - The name of the manifest file. Defaults to <tt>Manifest</tt>.
+* <tt>need_gem</tt> - Whether to generate a gem package. Defaults to <tt>true</tt>.
+* <tt>need_tar_gz</tt> - Whether to generate a <tt>.tar.gz</tt> package. Defaults to <tt>true</tt>.
+* <tt>need_tgz</tt> - Whether to generate a <tt>.tgz</tt> package. Defaults to <tt>false</tt>.
+* <tt>need_zip</tt> - Whether to generate a <tt>.zip</tt> package. Defaults to <tt>false</tt>.
+* <tt>include_rakefile</tt> - Include the Rakefile directly within the package. Defaults to <tt>false</tt>.
+* <tt>include_gemspec</tt> - Include the generated gemspec file within the package. Defaults to <tt>true</tt>.
+* <tt>ruby_version</tt> - Version string for which Ruby to require (for example, <tt>'>= 1.8.4'</tt>.
 * <tt>eval</tt> - Accepts a proc to be evaluated in the context of the Gem::Specification object. This allows you to set more unusual gemspec options.
-* <tt>ignore_pattern</tt> - A regex for pathnames that should be ignored when building the manifest.
+* <tt>ignore_pattern</tt> - A filename array, glob array, or regex for pathnames that should be ignored when building the manifest.
+* <tt>executable_pattern</tt> - A filename array, glob array, or regex for files that should be installed as wrapped executables.
 
 Security options:
 
@@ -96,13 +101,13 @@ Security options:
 
 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 filesystem path to publish the documentation to (defaults to the Rubyforge project).
+* <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 filesystem path to publish the documentation to. Defaults to the Rubyforge project.
 
 Documentation options:
 
-* <tt>rdoc_files</tt> - A filename array, glob array, or regex for filenames that should be passed to RDoc. Also can be referred to as <tt>rdoc_pattern</tt>.
-* <tt>rdoc_template</tt> - A path to an RDoc template (defaults to the generic template).
+* <tt>rdoc_pattern</tt> - A filename array, glob array, or regex for filenames that should be passed to RDoc.
+* <tt>rdoc_template</tt> - A path to an RDoc template. Defaults to the generic template.
 
 =end
 
@@ -124,48 +129,47 @@ class Echoe
   FILTER = ENV['FILTER'] # for tests (eg FILTER="-n test_blah")
   
   # user-configurable
-  attr_accessor :author, :changes, :clean_pattern, :description, :email, :dependencies, :need_tgz, :need_tar_gz, :need_gem, :need_zip, :rdoc_files, :project, :summary, :test_pattern, :url, :version, :docs_host, :rdoc_template, :manifest_name, :install_message, :extensions, :private_key, :certificate_chain, :require_signed, :ruby_version, :platform, :ignore_pattern
+  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, :extension_pattern, :private_key, :certificate_chain, :require_signed, :ruby_version, :platform, :ignore_pattern, :executable_pattern, :changelog
   
   # best left alone
-  attr_accessor :name, :lib_files, :test_files, :bin_files, :spec, :rdoc_options, :rubyforge_name, :has_rdoc, :include_gemspec, :include_rakefile, :gemspec_name, :eval
+  attr_accessor :name, :lib_files, :test_files, :bin_files, :spec, :rdoc_options, :rubyforge_name, :has_rdoc, :include_gemspec, :include_rakefile, :gemspec_name, :eval, :files, :changelog_patterns
   
   # legacy
-  attr_accessor :extra_deps, :rdoc_pattern
+  attr_accessor :extra_deps, :rdoc_files, :extensions
   
-  def initialize(name, version = nil)
+  def initialize(name, _version = nil)
     # Defaults
 
     self.name = name
     self.project = name.downcase
+    self.changelog = "CHANGELOG"
     self.url = ""
     self.author = ""
     self.email = ""
-    self.clean_pattern = ["pkg", "doc", "lib/*.#{Config::CONFIG['DLEXT']}", "ext/**/*.#{Config::CONFIG['DLEXT']}", ".config"]
+    self.clean_pattern = ["pkg", "doc", 'build/*', '**/*.o', '**/*.so', '**/*.a', 'lib/*-*', '**/*.log', "ext/*.{bundle,so,obj,pdb,lib,def,exp}", "ext/Makefile", "ext/**/*.{bundle,so,obj,pdb,lib,def,exp}", "ext/**/Makefile", "pkg", "lib/*.bundle", "*.gem", ".config"]
     self.test_pattern = ['test/**/test_*.rb']
     
-    self.version = if version
-      version
-    elsif File.exist? "CHANGELOG"
-      open("CHANGELOG").read[/^\s*v([\d\.]+)\. /, 1]
-    else
-      raise "No version supplied in Rakefile"
-    end
-
-    self.changes = if File.exist? "CHANGELOG"
-      open("CHANGELOG").read[/^\s*v([\d\.]+\. .*)/, 1]
-    else
-      ""
-    end
-        
+    self.changelog_patterns = {
+        :version => [
+            /^\s*v([\d\.]+)(\.|\s|$)/, 
+            /\s*\*\s*([\d\.]+)\s*\*\s*$/
+          ],
+        :changes => [
+          /^\s*v([\d\.]+\. .*)/, 
+          /\*\s*[\d\.]+\s*\*\s*(.*)\*\s*[\d\.]+\s*\*$/m
+        ]
+      }
+      
     self.description = ""
     self.summary = ""
     self.install_message = nil
     self.has_rdoc = true
-    self.rdoc_files = /^(lib|bin|tasks)|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/
+    self.rdoc_pattern = /^(lib|bin|tasks|ext)|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/
+    self.executable_pattern = /^bin\//
     self.rdoc_options = ['--line-numbers', '--inline-source']
     self.dependencies = []
     self.manifest_name = "Manifest"
-    self.extensions = "ext/**/extconf.rb"
+    self.extension_pattern = ["ext/**/extconf.rb", "ext/extconf.rb"]
     self.private_key = ENV['GEM_PRIVATE_KEY']
     self.require_signed = false
     self.certificate_chain = ENV['GEM_CERTIFICATE_CHAIN'].to_s.split(/\,\s*/).compact
@@ -178,23 +182,80 @@ class Echoe
     self.include_rakefile = false
     self.include_gemspec = true    
     self.gemspec_name = "#{name}.gemspec"
-
+    
     yield self if block_given?
+
+    # legacy compatibility
+    self.dependencies = extra_deps if extra_deps and dependencies.empty?
+    self.project = rubyforge_name if rubyforge_name
+    self.rdoc_pattern = rdoc_files if rdoc_files
+    self.extension_pattern = extensions if extensions
+
+    # read manifest
+    begin
+      self.files = File.read(manifest_name).split + 
+        [(gemspec_name if include_gemspec)] + 
+        [("Rakefile" if include_rakefile)]
+      self.files = files.compact.uniq
+    rescue Errno::ENOENT
+      unless ARGV.include? "manifest"
+        puts "Missing manifest. You can build one with 'rake manifest'."
+        exit 
+      end
+    end  
+    
+    # snag version and changeset
+    self.version ||= _version    
+    unless version
+      if File.exist? changelog
+        parsed = Array(changelog_patterns[:version]).map do |pattern|
+          open(changelog).read[pattern, 1]
+        end.compact.first
+        raise "Could not parse version from #{changelog}" unless parsed
+        self.version = parsed.chomp(".").strip
+      else
+        raise "No #{changelog} found, and no version supplied in Rakefile."
+      end
+    end
+
+    self.changes = if File.exist? changelog
+      Array(changelog_patterns[:changes]).map do |pattern|
+        open(changelog).read[pattern, 1]
+      end.compact.first or ""
+    else
+      ""
+    end      
     
     # set some post-defaults
-    self.certificate_chain = Array(certificate_chain)
+    self.certificate_chain = Array(certificate_chain).map {|file| File.expand_path(file)}
+    self.private_key = File.expand_path(private_key) if private_key
     self.description = summary if description.empty?
     self.summary = description if summary.empty?
-    self.clean_pattern = Array(clean_pattern) if clean_pattern
-    self.extensions = Array(extensions).map {|ext| Dir[ext]}.flatten
-    
-    # legacy compatibility
-    self.dependencies = extra_deps if extra_deps and dependencies.empty?
-    self.project = rubyforge_name if rubyforge_name
-    self.rdoc_files = rdoc_pattern if rdoc_pattern
+    self.clean_pattern = apply_pattern(clean_pattern)
+    self.extension_pattern = apply_pattern(extension_pattern, files)
+    self.ignore_pattern = apply_pattern(ignore_pattern)
+    self.rdoc_pattern = apply_pattern(rdoc_pattern, files)
+    self.executable_pattern = apply_pattern(executable_pattern, files)
+      
 
     define_tasks
   end
+  
+  def apply_pattern(pattern, files = nil)
+    files ||= Dir['**/**']
+    case pattern
+      when String, Array
+        files & (Array(pattern).map do |p|
+          Dir.glob(p)
+        end.flatten)
+      when Regexp
+        files.select do |file| 
+          file =~ pattern
+        end
+      else
+        []
+    end
+  end
 
   def define_tasks
 
@@ -223,22 +284,20 @@ class Echoe
         s.add_dependency(*dep)
       end
 
-      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
-        unless ARGV.include? "manifest"
-          puts "Missing manifest. You can build one with 'rake manifest'."
-          exit 
-        end
+      s.files = files
+      
+      s.bindir = if executable_pattern.any?
+        executable_pattern[0].split("/")[0]
+      else
+        "bin"
       end
-      s.executables = s.files.grep(/bin/) { |f| File.basename(f) }
-
-      s.bindir = "bin"
+      
+      s.executables = executable_pattern.map do |file|
+        file[(s.bindir.length)..-1]
+      end
+      
       dirs = Dir['{lib,ext}']
-      s.extensions = extensions if extensions.any?
+      s.extensions = extension_pattern if extension_pattern.any?
       s.require_paths = dirs unless dirs.empty?
       s.has_rdoc = has_rdoc
 
@@ -356,10 +415,10 @@ class Echoe
       directory "lib"
     end
     
-    if extensions.any?
+    if extension_pattern.any?
     
       task :compile => [:lib] do    
-        extensions.each do |extension|
+        extension_pattern.each do |extension|
           directory = File.dirname(extension)
           Dir.chdir(directory) do 
             ruby File.basename(extension)
@@ -383,17 +442,7 @@ class Echoe
       
       rd.rdoc_dir = 'doc'
       
-      files = case rdoc_files
-        when Array
-          rdoc_files.map do |pattern|
-            Dir[pattern].select { |file| spec.files.include? file }
-          end.flatten
-        when Regexp
-          spec.files.grep(rdoc_files).uniq
-        else
-          []
-      end
-      
+      files = rdoc_pattern
       files -= [manifest_name]
       
       rd.rdoc_files.push(*files)
@@ -489,13 +538,10 @@ class Echoe
     desc 'Clean up auto-generated files'
     task :clean do
       puts "Cleaning"
-      clean_pattern.each do |pattern|
-        files = Dir[pattern]
-        files.each do |file|
-          if File.exist?(file)
-            puts "- #{file}"
-            rm_rf file
-          end
+      clean_pattern.each do |file|
+        if File.exist?(file)
+          puts "- #{file}"
+          rm_rf file
         end
       end
     end
@@ -504,6 +550,8 @@ class Echoe
 
     desc "Build a Manifest list"
     task :manifest => [:clean] do
+      puts "Building Manifest"
+      old_files = files
       files = []
       Find.find '.' do |file|
         file = file[2..-1]
@@ -520,7 +568,9 @@ class Echoe
       files.uniq!
       
       File.open(manifest_name, 'w').puts(files)
-      puts(files)
+      puts(files.map do |file| 
+        (old_files.include?(file) ? " " : "+") + " " + file
+      end)
     end
     
     task :build_manifest => [:manifest]
@@ -533,7 +583,7 @@ class Echoe
       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 = apply_pattern(test_pattern) << 'test/unit'
         tests.map! {|f| %Q(require "#{f}")}
         "#{RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
       end)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: echoe
 version: !ruby/object:Gem::Version 
-  version: "2.5"
-date: 2007-09-22 00:00:00 -04:00
+  version: "2.6"
+date: 2007-09-24 00:00:00 -04:00
 summary: A tool for packaging Ruby gems.
 require_paths: 
 - lib
@@ -52,16 +52,15 @@ authors:
 - Evan Weaver
 files: 
 - TODO
-- test/test_echoe.rb
 - README
 - Rakefile
 - MIT-LICENSE
+- Manifest
 - LICENSE
 - lib/echoe.rb
 - CHANGELOG
-- Manifest
-test_files: 
-- test/test_echoe.rb
+test_files: []
+
 rdoc_options: []
 
 extra_rdoc_files: []

data/test/test_echoe.rb

@@ -1,20 +0,0 @@
-
-require 'test/unit/testcase'
-require 'echoe'
-
-$rakefile = nil # Avoids a warning in rdoctask.rb
-
-class TestEchoe < Test::Unit::TestCase
-  def setup
-    Rake.application.clear
-  end
-
-  def test_basics
-    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?)
-    assert((tasks - expected).empty?)
-  end
-end