echoe 2.4.1 → 2.5

data/CHANGELOG

@@ -1,4 +1,6 @@
 
+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).
 
 v2.4. Sign gems automatically if ENV['GEM_PRIVATE_KEY'] is present; add certificate_chain and private_key accessors.

data/README

@@ -28,13 +28,13 @@ The public certificate for this gem is at http://rubyforge.org/frs/download.php/
 Organize your gem according to the usual structure:
 
   lib/
-  bin/  
-  ext/
   README
   LICENSE
   CHANGELOG
   Rakefile
 
+You can add the <tt>bin/</tt> or <tt>ext/</tt> folders if you have executables or extensions, respectively.
+
 Your <tt>CHANGELOG</tt> should be formatted as follows (including newlines):
 
   v2.1. newest change

data/lib/echoe.rb

@@ -68,17 +68,25 @@ 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:
+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>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.
+
+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>extensions</tt> - Any extension files that need to be executed (defaults to <tt>"ext/extconf.rb"</tt> if it exists).
+* <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>include_rakefile</tt> - Include the Rakefile within the package. Default <tt>false</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.
 
 Security options:
 
@@ -93,7 +101,7 @@ Publishing options:
 
 Documentation options:
 
-* <tt>rdoc_files</tt> - An array or regex for filenames that should be passed to RDoc.
+* <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).
 
 =end
@@ -116,7 +124,7 @@ 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
+  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
   
   # 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
@@ -132,7 +140,7 @@ class Echoe
     self.url = ""
     self.author = ""
     self.email = ""
-    self.clean_pattern = %w(diff diff.txt email.txt ri *.gem **/*~)
+    self.clean_pattern = ["pkg", "doc", "lib/*.#{Config::CONFIG['DLEXT']}", "ext/**/*.#{Config::CONFIG['DLEXT']}", ".config"]
     self.test_pattern = ['test/**/test_*.rb']
     
     self.version = if version
@@ -153,11 +161,11 @@ class Echoe
     self.summary = ""
     self.install_message = nil
     self.has_rdoc = true
-    self.rdoc_files = /^(lib|bin|tasks)|^README|^CHANGELOG|^TODO|^LICENSE$/
+    self.rdoc_files = /^(lib|bin|tasks)|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/
     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.extensions = "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
@@ -177,6 +185,8 @@ class Echoe
     self.certificate_chain = Array(certificate_chain)
     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?
@@ -199,22 +209,15 @@ class Echoe
       s.homepage = url
       s.rubyforge_project = project
       s.post_install_message = install_message if install_message
-      
+      s.description = description
+      s.required_ruby_version = ruby_version
+      s.platform = platform if platform
+
       if private_key and File.exist? private_key
         s.signing_key = private_key
         s.cert_chain = certificate_chain
-        puts "Signing gem."
-        puts "Certificate chain is:"
-        certificate_chain.each do |cert|
-          puts "  #{cert}"
-        end
-      else
-        puts "Missing private key; gem will not be signed."
-        raise "Signed gem required. Maybe you forget to set ENV['GEM_PRIVATE_KEY']." if require_signed
       end
 
-      s.description = description
-
       dependencies.each do |dep|
         dep = dep.split(" ") if dep.is_a? String
         s.add_dependency(*dep)
@@ -235,7 +238,7 @@ class Echoe
 
       s.bindir = "bin"
       dirs = Dir['{lib,ext}']
-      s.extensions = Array(extensions) if extensions
+      s.extensions = extensions if extensions.any?
       s.require_paths = dirs unless dirs.empty?
       s.has_rdoc = has_rdoc
 
@@ -246,7 +249,7 @@ class Echoe
       end
       
       if eval
-        self.instance_eval &eval
+        s.instance_eval &eval
       end
       
     end
@@ -294,16 +297,24 @@ class Echoe
       if include_gemspec and File.exist? gemspec_name
         File.delete gemspec_name
       end
+      
+      # Test signing status
+      if private_key and File.exist? private_key
+        puts "Signing gem."
+      else
+        raise "Key required, but not found. Maybe you forget to set ENV['GEM_PRIVATE_KEY']?" if require_signed
+        puts "Private key not found; gem will not be signed."
+      end      
     end  
 
     desc 'Install the gem'
     task :install => [:clean, :package] do
-      sh "sudo gem install pkg/*.gem -P MediumSecurity"
+      system "sudo gem install pkg/*.gem -P MediumSecurity"
     end
 
     desc 'Uninstall the gem'
     task :uninstall do
-      sh "sudo gem uninstall #{name} -a -i -x"
+      system "sudo gem uninstall #{name} -a -i -x"
     end
 
     desc 'Package and upload the release to Rubyforge'
@@ -339,6 +350,31 @@ class Echoe
       
     end
     
+    ### Extension building
+
+    task :lib do
+      directory "lib"
+    end
+    
+    if extensions.any?
+    
+      task :compile => [:lib] do    
+        extensions.each do |extension|
+          directory = File.dirname(extension)
+          Dir.chdir(directory) do 
+            ruby File.basename(extension)
+            system(PLATFORM =~ /win32/ ? 'nmake' : 'make')
+          end
+          Dir["#{directory}/*.#{Config::CONFIG['DLEXT']}"].each do |file|
+            cp file, "lib"
+          end
+        end
+      end
+      
+      task :test => [:compile]
+      
+    end
+    
     ### Documentation
 
     Rake::RDocTask.new(:docs) do |rd|      
@@ -347,13 +383,18 @@ class Echoe
       
       rd.rdoc_dir = 'doc'
       
-      files = (if rdoc_files.is_a? Array
-        rdoc_files
-      elsif rdoc_pattern.is_a? Regexp
-        spec.files.grep(rdoc_pattern).uniq
-      else
-        []
-      end) - [manifest_name]
+      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 -= [manifest_name]
       
       rd.rdoc_files.push(*files)
 
@@ -387,7 +428,9 @@ class Echoe
               super
             rescue
               # project directory probably doesn't exist, transfer as a whole
-              sh("scp -qr #{local_dir} #{host}:#{remote_dir}")
+              cmd = "scp -qr #{local_dir} #{host}:#{remote_dir}"
+              puts "Uploading: #{cmd}"
+              system(cmd)
             end
           end
         end
@@ -396,8 +439,15 @@ class Echoe
         # you may need ssh keys configured for this to work
         host, dir = docs_host.split(":")
         dir.chomp!("/")
-        sh("ssh #{host} 'rm -rf #{dir}/#{remote_dir_name}'") # XXX too dangerous?
-        sh("scp -qr #{local_dir} #{host}:#{dir}/#{remote_dir_name}")
+        
+        # XXX too dangerous?
+        cmd = "ssh #{host} 'rm -rf #{dir}/#{remote_dir_name}'"
+        puts "Deleting existing docs: #{cmd}"
+        system(cmd) 
+        
+        cmd = "scp -qr #{local_dir} #{host}:#{dir}/#{remote_dir_name}"
+        puts "Uploading: #{cmd}"
+        system(cmd)
       end      
     end
         
@@ -436,23 +486,30 @@ class Echoe
     
     ### Clean
 
-    desc 'Delete the generated documentation and packages'
-    task :clean => [ :clobber_docs, :clobber_package ] do
+    desc 'Clean up auto-generated files'
+    task :clean do
+      puts "Cleaning"
       clean_pattern.each do |pattern|
         files = Dir[pattern]
-        rm_rf files unless files.empty?
+        files.each do |file|
+          if File.exist?(file)
+            puts "- #{file}"
+            rm_rf file
+          end
+        end
       end
     end
     
     ### Manifest
 
     desc "Build a Manifest list"
-    task :manifest do
+    task :manifest => [:clean] do
       files = []
       Find.find '.' do |file|
         file = file[2..-1]
         next unless file
-        next if file =~ /^(pkg|doc)|\.svn|CVS|\.bzr|\.DS/
+        next if file =~ /^(pkg|doc)|\.svn|CVS|\.bzr|\.DS|\.git/
+        next if file =~ ignore_pattern and ignore_pattern
         next if File.directory?(file)
         next if !include_rakefile and file == "Rakefile"
         files << file

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: echoe
 version: !ruby/object:Gem::Version 
-  version: 2.4.1
-date: 2007-09-21 00:00:00 -04:00
+  version: "2.5"
+date: 2007-09-22 00:00:00 -04:00
 summary: A tool for packaging Ruby gems.
 require_paths: 
 - lib