rake 0.4.8 → 0.7.3

data/CHANGES

@@ -1,5 +1,188 @@
 = Rake Changelog
 
+== Pre-version 0.7.3
+
+* Added existing and existing! methods to FileList
+* FileLists now claim to be Arrays (via is_a?) to get better support
+  from the FileUtil module.
+* Added init and top_level for custom rake applications.
+
+== Version 0.7.2
+
+* Error messages are now send to stderr rather than stdout (from
+  Payton Quackenbush).
+* Better error handling on invalid command line arguments (from Payton
+  Quackenbush).
+* Added rcov task and updated unit testing for better code coverage.
+* Fixed some bugs where the application object was going to the global
+  appliation instead of using its own data.
+* Added square and curly bracket patterns to FileList#include (Tilman
+  Sauerbeck). 
+* Added plain filename support to rule dependents (suggested by Nobu
+  Nakada). 
+* Added pathmap support to rule dependents.
+* Added a 'tasks' method to a namespace to get a list of tasks
+  associated with the namespace.
+* Fixed the method name leak from FileUtils (bug found by Glenn
+  Vanderburg). 
+* Added rake_extension to handle detection of extension collisions.
+* Added test for noop, bad_option and verbose flags to sh command.
+* Removed dependency on internal fu_xxx functions from FileUtils.
+* Added a 'shame' task to the Rakefile.
+* Added tar_command and zip_command options to the Package task.
+* Added a description to the gem task in GemPackageTask.
+* Fixed a bug when rules have multiple prerequisites (patch by Joel
+  VanderWerf)
+* Added a protected 'require "rubygems"' to test/test_application to
+  unbreak cruisecontrol.rb.
+* Added the handful of RakeFileUtils to the private method as well.
+* Added block based exclusion.
+* The clean task will no longer delete 'core' if it is a directory.
+* Removed rake_dup.  Now we just simply rescue a bad dup.
+* Refactored the FileList reject logic to remove duplication.
+* Removed if __FILE__ at the end of the rake.rb file.
+
+== Version 0.7.1
+
+* Added optional filter parameter to the --tasks command line option.
+* Added flatten to allow rule transform procs to return lists of
+  prereqs (Joel VanderWerf provided patch).
+* Added pathmap to String and FileList.
+* The -r option will now load .rake files (but a straight require
+  doesn't yet).  NOTE: This is experimental ... it may be
+  discontinued.
+* The -f option without a value will disable the search for a
+  Rakefile.  The assumption is that the -r files are adequate.
+* Fixed the safe_ln function to fall back to cp in more error
+  scenarios.
+
+== Version 0.7.0
+
+* Added Rake.original_dir to return the original starting directory of
+  the rake application.
+* Added safe_ln support for openAFS (from Ludvig Omholt).
+* Added --trace reminder on short exception messages (David Heinemeier
+  Hansson suggestion).
+* Added multitask declaration that executes prerequisites in
+  parallel. (Doug Young providied an initial implementation).
+* Fixed missing_const hack to be compatible with Rails. (Jamis Buck
+  supplied test case).
+* Made the RDoc task default to internal (in-process) RDoc formatting.
+  The old behavior is still available by setting the +external+ flag
+  to true.
+* Rakefiles are now loaded with the expanded path to prevent
+  accidental polution from the Ruby load path.
+* The +namespace+ command now returns a NameSpace object that can be
+  used to lookup tasks defined in that namespace.  This allows for
+  better anonymous namespace behavior.
+* Task objects my now be used in prerequisite lists directly.
+
+== Version 0.6.1
+
+* Rebuilt 0.6.0 gem without signing.
+
+== Version 0.6.0
+
+* Fixed file creation bug in the unit tests (caused infinite loop on
+  windows).
+* Fixed bug where session based functional tests were run under
+  windows.
+* Fixed bug in directory tasks so that updating a directory will not
+  retrigger file tasks depending on the directory (see
+  FileCreationTask and EarlyTime).
+* Added egrep to FileList
+* ruby command now runs same ruby version as rake.
+* Added investigation to task object. (suggested by Martin Fowler)
+* Added ruby_opts to the test task to allow arbitrary ruby options to
+  be passed to the test script. (Greg Fast)
+* Fixed the test loader to ignore options. (Greg Fast)
+* Moved Task, FileTask, FileCreationTask and RakeApp into the Rake
+  module namespace.  Old style namespace behavior can be invoked via
+  the --classic-namespace option. (requested by Kelly Felkins).
+* GemTask is now sensitive to the gem platform (Masao Mutoh).
+* A non-existing file prerequisite will no longer cause an exception
+  (Philipp Neubeck).
+* Multiple prerequisites on Rake rules now allowed (initial patch
+  supplied by Stuart Jansen).
+
+== Version 0.5.4
+
+* Added double quotes to the test runner.
+* Added .svn to default ignore list.
+* Updated FileList#include to support nested arrays and filelists.
+
+== Version 0.5.3
+
+* Added support for importing Rakefile and other dependencies.
+* Fixed bug so that now rules can chain off of existing tasks as well
+  as existing files.
+* Fixed verbose flag bug in the testing task.  Shortened some failure
+  messages.
+* Make FileUtils methods private at the top level module to avoid
+  accidental method leaking into other objects.
+* Added test loader option to test task.  "testrb" is no longer the
+  default test loader.  It is now eating syntax errors that should
+  halt the unit tests.
+* Revamped FileList so that it works more like and array (addressed
+  flatten bug).  Added many tests around file list.
+* Added +ext+ method to both String and FileList.
+
+== Version 0.5.0
+
+* Fixed documentation that was lacking the Rake module name (Tilman
+  Sauerbeck).
+* Added tar.gz and tar.bz2 support to package task (Tilman Sauerbeck).
+* Recursive rules are now supported (Tilman Sauerbeck).
+* Added warning option for the Test Task (requested by Eric Hodel).
+* The jamis rdoc template is only used if it exists.
+* Added fix for Ruby 1.8.2 test/unit and rails problem.
+* Added contributed rake man file (Jani Monoses).
+* Added Brian Candler's fix for problems in --trace and --dry-run
+  mode.
+
+== Version 0.4.15
+
+* Fixed a bug that prevented the TESTOPTS flag from working with the
+  revised for 1.8.2 test task.
+* Updated the docs on --trace to indicate that it also enables a full
+  backtrace on errors. 
+
+== Version 0.4.14
+
+* Modified the TestTask to workaround the Ruby 1.8.2 change in
+  autoexecuting unit tests.
+
+== Version 0.4.13
+
+* Fixed the dry-run flag so it is operating again.
+* Multiple arguments to sh and ruby commands will not be interpreted
+  by the shell (patch provided by Jonathan Paisley).
+
+== Version 0.4.12
+
+* Added --silent (-s) to suppress the (in directory) rake message.
+
+== Version 0.4.11
+
+* Changed the "don't know how to rake" message (finally)
+* Changes references to a literal "Rakefile" to reference the global
+  variable $rakefile (which contains the actual name of the rakefile).
+
+== Version 0.4.10
+
+* Added block support to the "sh" command, allowing users to take
+  special actions on the result of the system call.  E.g.
+
+    sh "shell_command" do |ok, res|
+      puts "Program returned #{res.exitstatus}" if ! ok
+    end
+
+== Version 0.4.9
+
+* Switched to Jamis Buck's RDoc template.
+* Removed autorequire from Rake's gem spec.  This prevents the Rake
+  libraries from loading while using rails.
+
 == Version 0.4.8
 
 * Added support for .rb versions of Rakefile.

data/README

@@ -1,5 +1,7 @@
 = RAKE -- Ruby Make 
 
+Supporting Rake version: 0.7.x
+
 This package contains Rake, a simple ruby build program with
 capabilities similar to make.
 
@@ -13,9 +15,11 @@ Rake has the following features:
 
 * Rake supports rule patterns to sythesize implicit tasks.
 
-* Rake is lightweight.  It can be distributed with other projects as a
-  single file.  Projects that depend upon rake do not require that
-  rake be installed on target systems.
+*  Flexible FileLists that act like arrays but know about manipulating
+   file names and paths.
+
+* A library of prepackaged tasks to make building rakefiles easier.
+
 
 == Download
 
@@ -23,12 +27,6 @@ The latest version of rake can be found at
 
 * http://rubyforge.org/project/showfiles.php?group_id=50
 
-Online Resources can be found at ...
-
-* Online Rake Documentation: http://rake.rubyforge.org
-* Rake Project Page: http://rubyforge.org/projects/rake
-* Rake Project Wiki: http://rake.rubyforge.org/wiki/wiki.pl
-
 == Installation
 
 === Normal Installation
@@ -45,7 +43,30 @@ Download and install  rake with the following.
 
    gem install --remote rake
 
-== Roadmap
+=== Running the Rake Test Suite
+
+If you wish to run the unit and functional tests that come with Rake:
+
+* CD into the top project directory of rake.
+* Type one of the following:
+
+     rake                  # If you have a version of rake installed
+     ruby -Ilib bin/rake   # If you do not have a version of rake installed.
+
+== Online Resources
+
+== Rake References
+
+* Rake Documentation Home: http://docs.rubyrake.org
+* Rake Project Page: http://rubyforge.org/projects/rake
+* Rake API Documents: http://rake.rubyforge.org
+
+== Presentations and Articles about Rake
+
+* Jim Weirich's 2003 RubyConf presentation: http://onestepback.org/articles/buildingwithrake/
+* Martin Fowler's article on Rake: http://martinfowler.com/articles/rake.html
+
+=== Road Map
 
 * If you want to see how to invoke rake to build your projects, read on.
 * If you want to see the format of a Rakefile, see
@@ -55,7 +76,6 @@ Download and install  rake with the following.
 * If you want to see a glossary of terms, see
   doc/glossary.rdoc[http://rake.rubyforge.org/files/doc/glossary_rdoc.html].
 
-
 == Simple Example
 
 Once installed, you can run rake as follows ...
@@ -88,11 +108,15 @@ package.
 Rake is a late entry in the make replacement field.  Here are links to
 other projects with similar (and not so similar) goals.
 
+* http://directory.fsf.org/bras.html -- Bras, one of earliest
+  implementations of "make in a scripting language".
 * http://www.a-a-p.org -- Make in Python
 * http://www.aromatic.com/tools/jam.txt -- JAM, Java Automated Make
 * http://ant.apache.org -- The Ant project
-* http://www.perl.com/language/ppt/src/make/index.html -- Make from
-  the Perl Power Tools implementation.
+* http://ppt.perl.org/commands/make/index.html -- Make from the Perl
+  Power Tools implementation.
+* http://search.cpan.org/search?query=PerlBuildSystem -- The Perl Build System
+* http://make.rubyforge.org -- Rant, another Ruby make tool.
 
 == Credits
 
@@ -100,6 +124,8 @@ other projects with similar (and not so similar) goals.
 
 [<b>nobu.nokada@softhome.net</b>] For the initial patch for rule support.
 
+[<b>Tilman Sauerbeck <tilman@code-monkey.de></b>] For the recursive rule patch.
+
 == License
 
 Rake is available under an MIT-style license.
@@ -134,6 +160,13 @@ Options are:
     during the execution of the <b>rake</b> command.  You can access
     the value by using ENV['<em>name</em>'].
 
+[<tt>--classic-namespace</tt> (-n)]
+    Import the Task, FileTask, and FileCreateTask into the top-level
+    scope to be compatible with older versions of Rake.  Alternatively
+    you can include the line <code>require
+    'rake/classic_namespace'</code> in your Rakefile to get the
+    classic behavior.
+
 [<tt>--dry-run</tt> (-n)]
     Do a dry run.  Print the tasks invoked and executed, but do not
     actually execute any of the actions.
@@ -169,7 +202,7 @@ Options are:
     are defined using the "desc" command.
 
 [<tt>--trace</tt> (-t)]
-    Turn on invoke/execute tracing.
+    Turn on invoke/execute tracing.  Also enable full backtrace on errors.
 
 [<tt>--usage</tt> (-h)]
     Display a usage message and exit.

data/Rakefile

@@ -1,9 +1,9 @@
 # Rakefile for rake        -*- ruby -*-
 
-# Copyright 2003, 2004 by Jim Weirich (jim@weirichhouse.org)
+# Copyright 2003, 2004, 2005 by Jim Weirich (jim@weirichhouse.org)
 # All rights reserved.
 
-# This file is may be distributed under an MIT style license.  See
+# This file may be distributed under an MIT style license.  See
 # MIT-LICENSE for details.
 
 begin
@@ -16,15 +16,31 @@ require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-CLEAN.include('**/*.o')
-CLOBBER.include('doc/example/main')
+CLEAN.include('**/*.o', '*.dot')
+CLOBBER.include('doc/example/main', 'testdata')
+CLOBBER.include('test/data/**/temp_*')
+CLOBBER.include('test/data/chains/play.*')
+CLOBBER.include('test/data/file_creation_task/build')
+CLOBBER.include('test/data/file_creation_task/src')
+CLOBBER.include('TAGS')
+CLOBBER.include('coverage')
+
+def announce(msg='')
+  STDERR.puts msg
+end
 
 # Determine the current version of the software
 
-if `ruby -Ilib ./bin/rake --version` =~ /\S+$/
-  PKG_VERSION = $&
+if `ruby -Ilib ./bin/rake --version` =~ /rake, version ([0-9.]+)$/
+  CURRENT_VERSION = $1
+else
+  CURRENT_VERSION = "0.0.0"
+end
+
+if ENV['REL']
+  PKG_VERSION = ENV['REL']
 else
-  PKG_VERSION = "0.0.0"
+  PKG_VERSION = CURRENT_VERSION
 end
 
 SRC_RB = FileList['lib/**/*.rb']
@@ -32,48 +48,69 @@ SRC_RB = FileList['lib/**/*.rb']
 # The default task is run if rake is given no explicit arguments.
 
 desc "Default Task"
-task :default => :test
+task :default => :test_all
 
 # Test Tasks ---------------------------------------------------------
 
-Rake::TestTask.new do |t|
-  t.test_files = FileList['test/test*.rb']
-  t.verbose = true
+# Common Abbreviations ...
+
+task :ta => :test_all
+task :tf => :test_functional
+task :tu => :test_units
+task :tc => :test_contribs
+task :test => :test_units
+
+Rake::TestTask.new(:test_all) do |t|
+  t.test_files = FileList[
+    'test/test*.rb',
+    'test/contrib/test*.rb',
+    'test/fun*.rb'
+  ]
+  t.warning = true
+  t.verbose = false
 end
 
-Rake::TestTask.new(:testfun) do |t|
-  t.pattern = 'test/fun*.rb'
-  t.verbose = true
+Rake::TestTask.new(:test_units) do |t|
+  t.test_files = FileList['test/test*.rb']
+  t.warning = true
+  t.verbose = false
 end
 
-Rake::TestTask.new(:testcontrib) do |t|
-  t.pattern = 'test/contrib/test*.rb'
-  t.verbose = true
+Rake::TestTask.new(:test_functional) do |t|
+  t.test_files = FileList['test/fun*.rb']
+  t.warning = true
+  t.warning = true
 end
 
-directory 'testdata'
-task :test => ['testdata']
-
-desc "Run all test targets"
-task :testall => [:test, :testcontrib, :testfun]
+Rake::TestTask.new(:test_contribs) do |t|
+  t.test_files = FileList['test/contrib/test*.rb']
+  t.verbose = false
+  t.warning = true
+end
 
-# Abbreviations
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new do |t|
+    t.libs << "test"
+    t.rcov_opts = ['-xRakefile', '-xrakefile', '-xpublish.rf', '--text-report']
+    t.test_files = FileList[
+      'test/test*.rb',
+      'test/contrib/test*.rb'
+    ]
+    t.verbose = true
+  end
+rescue LoadError
+  # No rcov available
+end
 
-task :ta => [:testall]
-task :tf => [:testfun]
-task :tc => [:testcontrib]
+directory 'testdata'
+[:test_all, :test_units, :test_contribs, :test_functional].each do |t|
+  task t => ['testdata']
+end
 
 # CVS Tasks ----------------------------------------------------------
 
-desc "Tag all the CVS files with the latest release number (TAG=x)"
-task :tag do
-  rel = "REL_" + PKG_VERSION.gsub(/\./, '_')
-  rel << ENV['TAG'] if ENV['TAG']
-  puts rel
-  sh %{cvs commit -m 'pre-tag commit'}
-  sh %{cvs tag #{rel}}
-end
-
 # Install rake using the standard install.rb script.
 
 desc "Install the application"
@@ -87,8 +124,11 @@ rd = Rake::RDocTask.new("rdoc") { |rdoc|
   rdoc.rdoc_dir = 'html'
 #  rdoc.template = 'kilmer'
 #  rdoc.template = 'css2'
+  rdoc.template = 'doc/jamis.rb'
   rdoc.title    = "Rake -- Ruby Make"
-  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' <<  'Rake -- Ruby Make' 
   rdoc.rdoc_files.include('README', 'MIT-LICENSE', 'TODO', 'CHANGES')
   rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
   rdoc.rdoc_files.exclude(/\bcontrib\b/)
@@ -104,6 +144,9 @@ PKG_FILES = FileList[
   'bin/**/*', 
   'lib/**/*.rb', 
   'test/**/*.rb',
+  'test/**/*.rf',
+  'test/**/*.mf',
+  'test/**/Rakefile',
   'doc/**/*'
 ]
 PKG_FILES.exclude('doc/example/*.o')
@@ -140,7 +183,6 @@ else
     #### Load-time details: library and application (you will need one or both).
 
     s.require_path = 'lib'                         # Use these for libraries.
-    s.autorequire = 'rake'
 
     s.bindir = "bin"                               # Use these for applications.
     s.executables = ["rake"]
@@ -150,21 +192,22 @@ else
 
     s.has_rdoc = true
     s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
-    s.rdoc_options <<
-      '--title' <<  'Rake -- Ruby Make' <<
-      '--main' << 'README' <<
-      '--line-numbers'
+    s.rdoc_options = rd.options
 
     #### Author and project details.
 
     s.author = "Jim Weirich"
     s.email = "jim@weirichhouse.org"
-    s.homepage = "http://onestepback.org"
+    s.homepage = "http://rake.rubyforge.org"
     s.rubyforge_project = "rake"
+#     if ENV['CERT_DIR']
+#       s.signing_key = File.join(ENV['CERT_DIR'], 'gem-private_key.pem')
+#       s.cert_chain  = [File.join(ENV['CERT_DIR'], 'gem-public_cert.pem')]
+#     end
   end
 
-  Rake::GemPackageTask.new(spec) do |pkg|
-	  #pkg.need_zip = true
+  package_task = Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
     pkg.need_tar = true
   end
 end
@@ -213,3 +256,128 @@ end
 # publish.rf file is not found, the publish targets won't be defined.
 
 load "publish.rf" if File.exist? "publish.rf"
+
+# Support Tasks ------------------------------------------------------
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  FileList['**/*.rb'].exclude('pkg').egrep(/#.*(FIXME|TODO|TBD)/)
+end
+
+desc "Look for Debugging print lines"
+task :dbg do
+  FileList['**/*.rb'].egrep(/\bDBG|\bbreakpoint\b/)
+end
+
+desc "List all ruby files"
+task :rubyfiles do 
+  puts Dir['**/*.rb'].reject { |fn| fn =~ /^pkg/ }
+  puts Dir['bin/*'].reject { |fn| fn =~ /CVS|(~$)|(\.rb$)/ }
+end
+task :rf => :rubyfiles
+
+# --------------------------------------------------------------------
+# Creating a release
+
+desc "Make a new release"
+task :release => [
+  :prerelease,
+  :clobber,
+  :test_all,
+  :update_version,
+  :package,
+  :tag] do
+  
+  announce 
+  announce "**************************************************************"
+  announce "* Release #{PKG_VERSION} Complete."
+  announce "* Packages ready to upload."
+  announce "**************************************************************"
+  announce 
+end
+
+# Validate that everything is ready to go for a release.
+task :prerelease do
+  announce 
+  announce "**************************************************************"
+  announce "* Making RubyGem Release #{PKG_VERSION}"
+  announce "* (current version #{CURRENT_VERSION})"
+  announce "**************************************************************"
+  announce  
+
+  # Is a release number supplied?
+  unless ENV['REL']
+    fail "Usage: rake release REL=x.y.z [REUSE=tag_suffix]"
+  end
+
+  # Is the release different than the current release.
+  # (or is REUSE set?)
+  if PKG_VERSION == CURRENT_VERSION && ! ENV['REUSE']
+    fail "Current version is #{PKG_VERSION}, must specify REUSE=tag_suffix to reuse version"
+  end
+
+  # Are all source files checked in?
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping checked-in file test"
+  else
+    announce "Checking for unchecked-in files..."
+    data = `cvs -q update`
+    unless data =~ /^$/
+      fail "CVS update is not clean ... do you have unchecked-in files?"
+    end
+    announce "No outstanding checkins found ... OK"
+  end
+end
+
+task :update_version => [:prerelease] do
+  if PKG_VERSION == CURRENT_VERSION
+    announce "No version change ... skipping version update"
+  else
+    announce "Updating Rake version to #{PKG_VERSION}"
+    open("lib/rake.rb") do |rakein|
+      open("lib/rake.rb.new", "w") do |rakeout|
+	rakein.each do |line|
+	  if line =~ /^RAKEVERSION\s*=\s*/
+	    rakeout.puts "RAKEVERSION = '#{PKG_VERSION}'"
+	  else
+	    rakeout.puts line
+	  end
+	end
+      end
+    end
+    mv "lib/rake.rb.new", "lib/rake.rb"
+    if ENV['RELTEST']
+      announce "Release Task Testing, skipping commiting of new version"
+    else
+      sh %{cvs commit -m "Updated to version #{PKG_VERSION}" lib/rake.rb} # "
+    end
+  end
+end
+
+desc "Tag all the CVS files with the latest release number (REL=x.y.z)"
+task :tag => [:prerelease] do
+  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
+  reltag << ENV['REUSE'].gsub(/\./, '_') if ENV['REUSE']
+  announce "Tagging CVS with [#{reltag}]"
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping CVS tagging"
+  else
+    sh %{cvs tag #{reltag}}
+  end
+end
+
+desc "Install the jamis RDoc template"
+task :install_jamis_template do
+  require 'rbconfig'
+  dest_dir = File.join(Config::CONFIG['rubylibdir'], "rdoc/generators/template/html")
+  fail "Unabled to write to #{dest_dir}" unless File.writable?(dest_dir)
+  install "doc/jamis.rb", dest_dir, :verbose => true
+end
+
+# Require experimental XForge/Metaproject support.
+
+load 'xforge.rf' if File.exist?('xforge.rf')
+
+task :where_am_i do
+  puts Rake.original_dir
+end

data/bin/rake

@@ -2,7 +2,6 @@ begin
   require 'rake'
 rescue LoadError
   require 'rubygems'
-  require_gem 'rake'
+  require 'rake'
 end
-RakeApp.new.run
-
+Rake.application.run