rake 0.8.0 → 0.8.7

data/CHANGES

@@ -1,10 +1,121 @@
+
 = Rake Changelog
 
-== Pre-Version 0.7.4
+== Version 0.8.7
+
+* Fixed EXEEXT for JRuby on windows.
+
+== Version 0.8.6
+
+* Minor fixes to the RDoc generation (removed dependency on darkfish
+  and removed inline source option).
+
+== Version 0.8.5
+
+* Better support for the system command on Windows.
+
+== Version 0.8.4
+
+* Preserve case when locating rakefiles (patch from James
+  M. Lawrence/quix)
+
+* Better support for windows paths in the test task (patch from Simon
+  Chiang/bahuvrihi)
+
+* Windows system dir search order is now: HOME, HOMEDRIVE + HOMEPATH,
+  APPDATA, USERPROFILE (patch from Luis Lavena)
+
+* MingGW is now recognized as a windows platform.  (patch from Luis
+  Lavena)
+
+* Numerous fixes to the windows test suite (patch from Luis Lavena).
+
+* Improved Rakefile case insensitivity testing (patch from Luis
+  Lavena).
+
+* Fixed stray ARGV option problem that was interfering with
+  Test::Unit::Runner.
+
+* Fixed default verbose mode (was accidently changed to false).  
+
+* Removed reference to manage_gem to fix the warning produced by the
+  gem package task.
+
+== Version 0.8.3
+
+* Enhanced the system directory detection in windows. We now check
+  HOMEDRIVE/HOMEPATH and USERPROFILE if APPDATA isn't found. (Patch
+  supplied by James Tucker). Rake no long aborts if it can't find the
+  directory.
+
+* Added fix to handle ruby installations in directories with spaces in
+  their name.  
+
+== Version 0.8.2
+
+* Fixed bug in package task so that it will include the subdir
+  directory in the package for testing. (Bug found by Adam Majer)
+
+* Added ENV var to rakefile to prevent OS X from including extended
+  attribute junk in a tar file. (Bug found by Adam Majer)
+
+* Fixed filename dependency order bug in test_inspect_pending and
+  test_to_s_pending. (Bug found by Adam Majer)
+
+* Fixed check for file utils options to make them immune to the
+  symbol/string differences. (Patch supplied by Edwin Pratomo)
+
+* Fixed bug with rules involving multiple source (Patch supplied by
+  Emanuel Inderm�hle)
+
+* Switched from getoptlong to optparse (patches supplied by Edwin
+  Pratomo)
+
+* The -T option will now attempt to dynamically sense the size of the
+  terminal.  RAKE_COLUMNS will override any dynamic sensing.
+
+* FileList#clone and FileList#dup have better sematics w.r.t. taint
+  and freeze.
+
+* Added ability clear prerequisites, and/or actions from an existing
+  task.
+
+* Added the ability to reenable a task to be invoked a second time.
+
+* Changed RDoc test task to have no default template. This makes it
+  easier for the tempate to pick up the template from the environment.
+
+* Changed from using Mutex to Monitor. Evidently Mutex causes thread
+  join errors when Ruby is compiled with -disable-pthreads. (Patch
+  supplied by Ittay Dror) 
+
+* Fixed bug in makefile parser that had problems with extra spaces in
+  file task names. (Patch supplied by Ittay Dror)
+
+* Added a performance patch for reading large makefile dependency
+  files. (Patch supplied by Ittay Dror)
+
+* Default values for task arguments can easily be specified with the
+  :with_defaults method. (Idea for default argument merging supplied
+  by (Adam Q. Salter)
+
+* The -T output will only self-truncate if the output is a tty.
+  However, if RAKE_COLUMNS is explicitly set, it will be honored in
+  any case. (Patch provided by Gavin Stark).
+
+* Numerous fixes for running under windows. A big thanks to Bheeshmar
+  Redheendran for spending a good part of the afternoon at the
+  Lonestar Ruby Conference to help me work out these issues.
+
+== Version 0.8.1
+
+* Removed requires on parsedate.rb (in Ftptools)
+* Removed ftools from rake.rb.  Made it options in sys.rb
+
+== Version 0.8.0
 
 * Added task parameters (e.g. "rake build[version7]")
 * Made task parameters passable to prerequisites.
-* The 'desc' command will now document task argument names.
 * Comments are limited to 80 columns or so (suggested by Jamis Buck).
 * Added -D to display full comments (suggested by Jamis Buck).
 * The rake program will set the status value used in any explicit

data/README

@@ -1,6 +1,6 @@
 = RAKE -- Ruby Make 
 
-Supporting Rake version: 0.7.x
+Supporting Rake version: 0.8.6
 
 This package contains Rake, a simple ruby build program with
 capabilities similar to make.
@@ -13,95 +13,128 @@ Rake has the following features:
 
 * Users can specify tasks with prerequisites.
 
-* Rake supports rule patterns to sythesize implicit tasks.
+* Rake supports rule patterns to synthesize implicit tasks.
 
-*  Flexible FileLists that act like arrays but know about manipulating
-   file names and paths.
+* Flexible FileLists that act like arrays but know about manipulating
+  file names and paths.
 
-* A library of prepackaged tasks to make building rakefiles easier.
+* A library of prepackaged tasks to make building rakefiles easier. For example,
+  tasks for building tarballs, gems and RDoc output are provided.
 
+* Supports parallel execution of tasks.
 
-== Download
 
-The latest version of rake can be found at
+== Installation
 
-* http://rubyforge.org/project/showfiles.php?group_id=50
+=== Gem Installation
 
-== Installation
+Download and install  rake with the following.
+
+   gem install rake
 
 === Normal Installation
 
-You can install rake with the following command.
+You can download the source tarball of the latest version of Rake from
 
-  % ruby install.rb
+* http://rubyforge.org/project/showfiles.php?group_id=50
 
-from its distribution directory.
+Extract the tarball and run
 
-=== GEM Installation
+  % ruby install.rb
 
-Download and install  rake with the following.
+from its distribution directory.
 
-   gem install --remote rake
+== Usage
 
-=== Running the Rake Test Suite
+=== Simple Example
 
-If you wish to run the unit and functional tests that come with Rake:
+First, you must write a "Rakefile" file which contains the build rules. Here's
+a simple example:
 
-* CD into the top project directory of rake.
-* Type one of the following:
+  task :default => [:test]
+  
+  task :test do
+    ruby "test/unittest.rb"
+  end
 
-     rake                  # If you have a version of rake installed
-     ruby -Ilib bin/rake   # If you do not have a version of rake installed.
+This Rakefile has two tasks:
 
-== Online Resources
+* A task named "test", which - upon invocation - will run a unit test file in
+  Ruby.
+* A task named "default". This task does nothing by itself, but it has exactly
+  one dependency, namely the "test" task. Invoking the "default" task will
+  cause Rake to invoke the "test" task as well.
 
-== Rake References
+Running the "rake" command without any options will cause it to run the
+"default" task in the Rakefile:
 
-* Rake Documentation Home: http://docs.rubyrake.org
-* Rake Project Page: http://rubyforge.org/projects/rake
-* Rake API Documents: http://rake.rubyforge.org
+  % ls
+  Rakefile     test/
+  % rake
+  (in /home/some_user/Projects/rake)
+  ruby test/unittest.rb
+  ....unit test output here...
 
-== Presentations and Articles about Rake
+Type "rake --help" for all available options.
 
-* 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
+=== More Information
 
-* 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
+* For details on Rake's command-line invocation, read
+  doc/command_line_usage.rdoc[http://rake.rubyforge.org/files/doc/command_line_usage_rdoc.html]
+* For details on writing Rakefiles, see
   doc/rakefile.rdoc[http://rake.rubyforge.org/files/doc/rakefile_rdoc.html].
-* If you want to see the original announcement of rake, see
+* For the original announcement of Rake, see
   doc/rational.rdoc[http://rake.rubyforge.org/files/doc/rational_rdoc.html].
-* If you want to see a glossary of terms, see
+* For 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 ...
+== Development
 
-  % rake [options ...]  [VAR=VALUE ...]  [tasks...]
+=== Source Repository
 
-Type "rake --help" for an up-to-date option summary.
+Rake is currently hosted at github. The github web page is
+http://github.com/jimweirich/rake. The public git clone URL is
 
-Invoking <tt>rake</tt> without any options or targets causes rake to
-look for a rakefile and invoke the default task in that rakefile.
+* git://github.com/jimweirich/rake.git
 
-For example, given a simple rakefile like this ...
+=== Running the Rake Test Suite
 
-  task :default => [:test]
+If you wish to run the unit and functional tests that come with Rake:
 
-  task :test do
-    ruby "test/unittest.rb"
-  end
+* Install the 'session' gem in order to run the functional tests.
+* 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.
 
-The command 
+=== Issues and Bug Reports
 
-  $ rake
+Bugs, features requests and other issues can be logged at
 
-will invoke the +default+ task.  As +default+ satisfies its
-prerequisites, the +test+ task will run the unit tests for the
-package.
+* http://onestepback.org/redmine/projects/show/rake
+
+You will need an account to before you can post issues.  Register at
+http://onestepback.org/redmine/account/register.  Or you can send me
+an email (at jim dot weirich at gmail dot com)
+
+
+== 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
+* Rake Source Code Repo:  http://github.com/jimweirich/rake
+* Rake Git Repo Clone URL: git://github.com/jimweirich/rake.git
+
+=== 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
 
 == Other Make Reinvisionings ...
 
@@ -143,94 +176,15 @@ new feature to be submitted in the form of new unit tests.
 
 For other information, feel free to ask on the ruby-talk mailing list
 (which is mirrored to comp.lang.ruby) or contact
-mailto:jim@weirichhouse.org.
-
-----
-
-= Usage
-
-Rake is invoked from the command line using:
-
-   % rake [<em>options</em> ...]  [<em>VAR</em>=<em>VALUE</em>]  [<em>targets</em> ...]
-
-Options are:
-
-[<tt><em>name</em>=<em>value</em></tt>]
-    Set the environment variable <em>name</em> to <em>value</em>
-    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.
-
-[<tt>--help</tt>  (-H)]
-    Display some help text and exit.
-
-[<tt>--libdir</tt> _directory_  (-I)]
-    Add _directory_ to the list of directories searched for require.
-
-[<tt>--nosearch</tt>  (-N)]
-    Do not search for a Rakefile in parent directories.
-
-[<tt>--prereqs</tt>  (-P)]
-    Display a list of all tasks and their immediate prerequisites.
-
-[<tt>--quiet</tt> (-q)]
-    Do not echo commands from FileUtils.
-
-[<tt>--rakefile</tt> _filename_ (-f)]
-    Use _filename_ as the name of the rakefile.  The default rakefile
-    names are +rakefile+ and +Rakefile+ (with +rakefile+ taking
-    precedence).  If the rakefile is not found in the current
-    directory, +rake+ will search parent directories for a match.  The
-    directory where the Rakefile is found will become the current
-    directory for the actions executed in the Rakefile.
-
-[<tt>--require</tt> _name_ (-r)]
-    Require _name_ before executing the Rakefile.
-
-[<tt>--tasks</tt> (-T)]
-    Display a list of the major tasks and their comments.  Comments
-    are defined using the "desc" command.
-
-[<tt>--trace</tt> (-t)]
-    Turn on invoke/execute tracing.  Also enable full backtrace on errors.
-
-[<tt>--usage</tt> (-h)]
-    Display a usage message and exit.
-
-[<tt>--verbose</tt> (-v)]
-    Echo the Sys commands to standard output.
-
-[<tt>--version</tt> (-V)]
-    Display the program version and exit.
-
-In addition, any command line option of the form
-<em>VAR</em>=<em>VALUE</em> will be added to the environment hash
-<tt>ENV</tt> and may be tested in the Rakefile.
-
----
-
-= Rakefile Format
-
-See doc/rakefile.rdoc[http://rake.rubyforge.org/files/doc/rakefile_rdoc.html]
-for details on the Rakefile format.
+jim dot weirich at gmail.com.
 
 ---
 
 = Other stuff
 
-Author::   Jim Weirich <jim@weirichhouse.org>
+Author::   Jim Weirich <jim.weirich@gmail.com>
 Requires:: Ruby 1.8.0 or later
-License::  Copyright 2003, 2004 by Jim Weirich.
+License::  Copyright 2003-2008 by Jim Weirich.
            Released under an MIT-style license.  See the LICENSE file
            included in the distribution.
 

data/Rakefile

@@ -16,7 +16,7 @@ require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-CLEAN.include('**/*.o', '*.dot')
+CLEAN.include('**/*.o', '*.dot', '**/.*.rbc')
 CLOBBER.include('doc/example/main', 'testdata')
 CLOBBER.include('test/data/**/temp_*')
 CLOBBER.include('test/data/chains/play.*')
@@ -25,6 +25,9 @@ CLOBBER.include('test/data/file_creation_task/src')
 CLOBBER.include('TAGS')
 CLOBBER.include('coverage', 'rcov_aggregate')
 
+# Prevent OS X from including extended attribute junk in the tar output
+ENV['COPY_EXTENDED_ATTRIBUTES_DISABLE'] = 'true'
+
 def announce(msg='')
   STDERR.puts msg
 end
@@ -92,9 +95,13 @@ begin
 
   Rcov::RcovTask.new do |t|
     t.libs << "test"
+    dot_rakes = 
     t.rcov_opts = [
-      '-xRakefile', '-xrakefile', '-xpublish.rf', '--text-report',
-    ]
+      '-xRakefile', '-xrakefile', '-xpublish.rf',
+      '-xlib/rake/contrib', '-x/Library', 
+      '--text-report',
+      '--sort coverage'
+    ] + FileList['rakelib/*.rake'].pathmap("-x%p")
     t.test_files = FileList[
       'test/test*.rb', 'test/functional.rb'
     ]
@@ -121,19 +128,30 @@ end
 
 # Create a task to build the RDOC documentation tree.
 
-rd = Rake::RDocTask.new("rdoc") { |rdoc|
+begin
+  require 'darkfish-rdoc'
+  DARKFISH_ENABLED = true
+rescue LoadError => ex
+  DARKFISH_ENABLED = false
+end
+
+BASE_RDOC_OPTIONS = [
+  '--line-numbers',
+  '--main', 'README',
+  '--title', 'Rake -- Ruby Make',
+]
+
+rd = Rake::RDocTask.new("rdoc") do |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' <<
-    '--title' <<  'Rake -- Ruby Make' 
+  rdoc.options = BASE_RDOC_OPTIONS.dup
+  rdoc.options << '-SHN' << '-f' << 'darkfish' if DARKFISH_ENABLED
+    
   rdoc.rdoc_files.include('README', 'MIT-LICENSE', 'TODO', 'CHANGES')
   rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
   rdoc.rdoc_files.exclude(/\bcontrib\b/)
-}
+end
 
 # ====================================================================
 # Create a task that will package the Rake software into distributable
@@ -148,15 +166,17 @@ PKG_FILES = FileList[
   'test/**/*.rf',
   'test/**/*.mf',
   'test/**/Rakefile',
+  'test/**/subdir',
   'doc/**/*'
 ]
 PKG_FILES.exclude('doc/example/*.o')
+PKG_FILES.exclude('TAGS')
 PKG_FILES.exclude(%r{doc/example/main$})
 
 if ! defined?(Gem)
   puts "Package Target requires RubyGEMs"
 else
-  spec = Gem::Specification.new do |s|
+  SPEC = Gem::Specification.new do |s|
     
     #### Basic information.
 
@@ -193,7 +213,7 @@ else
 
     s.has_rdoc = true
     s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
-    s.rdoc_options = rd.options
+    s.rdoc_options = BASE_RDOC_OPTIONS
 
     #### Author and project details.
 
@@ -207,10 +227,18 @@ else
 #     end
   end
 
-  package_task = Rake::GemPackageTask.new(spec) do |pkg|
+  package_task = Rake::GemPackageTask.new(SPEC) do |pkg|
     pkg.need_zip = true
     pkg.need_tar = true
   end
+
+  file "rake.gemspec" => ["Rakefile", "lib/rake.rb"] do |t|
+    require 'yaml'
+    open(t.name, "w") { |f| f.puts SPEC.to_yaml }
+  end
+
+  desc "Create a stand-alone gemspec"
+  task :gemspec => "rake.gemspec"
 end
 
 # Misc tasks =========================================================

data/doc/command_line_usage.rdoc

@@ -0,0 +1,102 @@
+= Rake Command Line Usage
+
+Rake is invoked from the command line using:
+
+   % rake [<em>options</em> ...]  [<em>VAR</em>=<em>VALUE</em>]  [<em>targets</em> ...]
+
+Options are:
+
+[<tt><em>name</em>=<em>value</em></tt>]
+    Set the environment variable <em>name</em> to <em>value</em>
+    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>--describe</tt> _pattern_ (-D)]
+    Describe the tasks (matching optional PATTERN), then exit.
+
+[<tt>--dry-run</tt> (-n)]
+    Do a dry run.  Print the tasks invoked and executed, but do not
+    actually execute any of the actions.
+
+[<tt>--execute</tt> _code_ (-e)]
+    Execute some Ruby code and exit.
+
+[<tt>--execute-print</tt> _code_ (-p)]
+    Execute some Ruby code, print the result, and exit.
+
+[<tt>--execute-continue</tt> _code_ (-p)]
+    Execute some Ruby code, then continue with normal task processing.
+
+[<tt>--help</tt>  (-H)]
+    Display some help text and exit.
+
+[<tt>--libdir</tt> _directory_  (-I)]
+    Add _directory_ to the list of directories searched for require.
+
+[<tt>--nosearch</tt>  (-N)]
+    Do not search for a Rakefile in parent directories.
+
+[<tt>--prereqs</tt>  (-P)]
+    Display a list of all tasks and their immediate prerequisites.
+
+[<tt>--quiet</tt> (-q)]
+    Do not echo commands from FileUtils.
+
+[<tt>--rakefile</tt> _filename_ (-f)]
+    Use _filename_ as the name of the rakefile. The default rakefile
+    names are +rakefile+ and +Rakefile+ (with +rakefile+ taking
+    precedence). If the rakefile is not found in the current
+    directory, +rake+ will search parent directories for a match. The
+    directory where the Rakefile is found will become the current
+    directory for the actions executed in the Rakefile.
+
+[<tt>--rakelibdir</tt> _rakelibdir_ (-R)]
+    Auto-import any .rake files in RAKELIBDIR. (default is 'rakelib')
+
+[<tt>--require</tt> _name_ (-r)]
+    Require _name_ before executing the Rakefile.
+
+[<tt>--rules</tt>]
+    Trace the rules resolution.
+
+[<tt>--silent (-s)</tt>]
+    Like --quiet, but also suppresses the 'in directory' announcement.
+
+[<tt>--system</tt> (-g)]
+    Use the system wide (global) rakefiles. The project Rakefile is
+    ignored. By default, the system wide rakefiles are used only if no
+    project Rakefile is found. On Unix-like system, the system wide
+    rake files are located in $HOME/.rake. On a windows system they
+    are stored in $APPDATA/Rake.
+
+[<tt>--no-system</tt> (-G)]
+    Use the project level Rakefile, ignoring the system-wide (global)
+    rakefiles.
+
+[<tt>--tasks</tt> (-T)]
+    Display a list of the major tasks and their comments.  Comments
+    are defined using the "desc" command.
+
+[<tt>--trace</tt> (-t)]
+    Turn on invoke/execute tracing. Also enable full backtrace on
+    errors.
+
+[<tt>--usage</tt> (-h)]
+    Display a usage message and exit.
+
+[<tt>--verbose</tt> (-v)]
+    Echo the Sys commands to standard output.
+
+[<tt>--version</tt> (-V)]
+    Display the program version and exit.
+
+In addition, any command line option of the form
+<em>VAR</em>=<em>VALUE</em> will be added to the environment hash
+<tt>ENV</tt> and may be tested in the Rakefile.