jimweirich-rake 0.8.3.1 → 0.8.3.99

data/CHANGES

@@ -1,6 +1,28 @@
 
 = Rake Changelog
 
+== 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.
+
 == Version 0.8.3
 
 * Enhanced the system directory detection in windows. We now check

data/README

@@ -1,6 +1,6 @@
 = RAKE -- Ruby Make 
 
-Supporting Rake version: 0.8.2
+Supporting Rake version: 0.8.4
 
 This package contains Rake, a simple ruby build program with
 capabilities similar to make.
@@ -15,103 +15,126 @@ Rake has the following features:
 
 * 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.
 
-== Download
+* Supports parallel execution of tasks.
 
-The latest version of rake can be found at
 
-* http://rubyforge.org/project/showfiles.php?group_id=50
-
-== Source Repository
+== Installation
 
-Rake is currently hosted at github. The github web page is
-http://github.com/jimweirich/rake. The public git clone URL is
+=== Gem Installation
 
-* git://github.com/jimweirich/rake.git
+Download and install  rake with the following.
 
-== Installation
+   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:
 
-* Install the 'session' gem in order to run the functional tests. adf
-  asdf asdf
-* 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
-* Rake Source Code Repo:  http://github.com/jimweirich/rake
-* Rake Git Repo Clone URL: git://github.com/jimweirich/rake.git
+  % 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
+
+=== Source Repository
+
+Rake is currently hosted at github. The github web page is
+http://github.com/jimweirich/rake. The public git clone URL is
+
+* git://github.com/jimweirich/rake.git
 
-  % rake [options ...]  [VAR=VALUE ...]  [tasks...]
+=== Running the Rake Test Suite
 
-Type "rake --help" for an up-to-date option summary.
+If you wish to run the unit and functional tests that come with Rake:
 
-Invoking <tt>rake</tt> without any options or targets causes rake to
-look for a rakefile and invoke the default task in that rakefile.
+* Install the 'session' gem in order to run the functional tests.
+* CD into the top project directory of rake.
+* Type one of the following:
 
-For example, given a simple rakefile like this ...
+     rake                  # If you have a version of rake installed
+     ruby -Ilib bin/rake   # If you do not have a version of rake installed.
 
-  task :default => [:test]
+=== Issues and Bug Reports
 
-  task :test do
-    ruby "test/unittest.rb"
-  end
+Bugs, features requests and other issues can be logged at
 
-The command 
+* http://onestepback.org/redmine/projects/show/rake
 
-  $ 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)
 
-will invoke the +default+ task.  As +default+ satisfies its
-prerequisites, the +test+ task will run the unit tests for the
-package.
+
+== 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 ...
 
@@ -153,127 +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>--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)]
-    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.
-
----
-
-= 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

@@ -130,13 +130,11 @@ end
 
 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' <<
-    '--title' <<  'Rake -- Ruby Make' 
+    '--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/)

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.

data/doc/rakefile.rdoc

@@ -1,4 +1,4 @@
-= Rakefile Format (as of version 0.8.2)
+= Rakefile Format (as of version 0.8.3)
 
 First of all, there is no special format for a Rakefile.  A Rakefile
 contains executable Ruby code.  Anything legal in a ruby script is
@@ -225,8 +225,8 @@ where we specify default values for the first and last names:
 === Tasks that Expect Parameters and Have Prerequisites
 
 Tasks that use parameters have a slightly different format for
-prerequisites.  Use the <tt>:needs</tt> keyword to specify the
-prerequisites for tasks with arguments.  For example:
+prerequisites.  Use the arrow notation to indicate the prerequisites
+for tasks with arguments.  For example:
 
    task :name, [:first_name, :last_name] => [:pre_name] do |t, args|
      args.with_defaults(:first_name => "John", :last_name => "Dough")
@@ -237,7 +237,7 @@ prerequisites for tasks with arguments.  For example:
 === Deprecated Task Parameters Format
 
 There is an older format for declaring task parameters that omitted
-the task array and used the :needs keyword to introduce the
+the task argument array and used the :needs keyword to introduce the
 dependencies.  That format is still supported for compatibility, but
 is not recommended for use.
 

data/doc/release_notes/rake-0.8.4.rdoc

@@ -0,0 +1,125 @@
+= Rake 0.8.4 Released
+
+Rake version 0.8.4 is a bug-fix release of rake.
+
+== Changes
+
+=== New Features / Enhancements in Version 0.8.4
+
+* Case is preserved on rakefile names. (patch from James
+  M. Lawrence/quix)
+
+* 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)
+
+=== Bug Fixes in Version 0.8.4
+
+* Fixed stray ARGV option problem that was interfering with
+  Test::Unit::Runner. (patch from Pivotal Labs)
+
+=== Infrastructure Improvements in Version 0.8.4
+
+* Numerous fixes to the windows test suite (patch from Luis Lavena).
+
+* Improved Rakefile case insensitivity testing (patch from Luis
+  Lavena).
+
+* Better support for windows paths in the test task (patch from Simon
+  Chiang/bahuvrihi)
+
+== What is Rake
+
+Rake is a build tool similar to the make program in many ways. But
+instead of cryptic make recipes, Rake uses standard Ruby code to
+declare tasks and dependencies. You have the full power of a modern
+scripting language built right into your build tool.
+
+== Availability
+
+The easiest way to get and install rake is via RubyGems ...
+
+  gem install rake    (you may need root/admin privileges)
+
+Otherwise, you can get it from the more traditional places:
+
+Home Page:: http://rake.rubyforge.org/
+Download::  http://rubyforge.org/project/showfiles.php?group_id=50
+GitHub::    git://github.com/jimweirich/rake.git 
+
+== Task Argument Examples
+
+Prior to version 0.8.0, rake was only able to handle command line
+arguments of the form NAME=VALUE that were passed into Rake via the
+ENV hash.  Many folks had asked for some kind of simple command line
+arguments, perhaps using "--" to separate regular task names from
+argument values on the command line.  The problem is that there was no
+easy way to associate positional arguments on the command line with
+different tasks.  Suppose both tasks :a and :b expect a command line
+argument: does the first value go with :a?  What if :b is run first?
+Should it then get the first command line argument.
+
+Rake 0.8.0 solves this problem by explicitly passing values directly
+to the tasks that need them.  For example, if I had a release task
+that required a version number, I could say:
+
+   rake release[0.8.4]
+
+And the string "0.8.4" will be passed to the :release task.  Multiple
+arguments can be passed by separating them with a comma, for example:
+
+   rake name[john,doe]
+
+Just a few words of caution.  The rake task name and its arguments
+need to be a single command line argument to rake.  This generally
+means no spaces.  If spaces are needed, then the entire rake +
+argument string should be quoted.  Something like this:
+
+   rake "name[billy bob, smith]"
+
+(Quoting rules vary between operating systems and shells, so make sure
+you consult the proper docs for your OS/shell).
+
+=== Tasks that Expect Parameters
+
+Parameters are only given to tasks that are setup to expect them.  In
+order to handle named parameters, the task declaration syntax for
+tasks has been extended slightly.
+
+For example, a task that needs a first name and last name might be
+declared as:
+
+   task :name, :first_name, :last_name
+
+The first argument is still the name of the task (:name in this case).
+The next to argumements are the names of the parameters expected by
+:name (:first_name and :last_name in the example).
+
+To access the values of the paramters, the block defining the task
+behaviour can now accept a second parameter:
+
+   task :name, :first_name, :last_name do |t, args|
+     puts "First name is #{args.first_name}"
+     puts "Last  name is #{args.last_name}"
+   end
+
+The first argument of the block "t" is always bound to the current
+task object.  The second argument "args" is an open-struct like object
+that allows access to the task arguments.  Extra command line
+arguments to a task are ignored.  Missing command line arguments are
+given the nil value.
+
+== Thanks
+
+As usual, it was input from users that drove a alot of these changes. The
+following people either contributed patches, made suggestions or made
+otherwise helpful comments.  Thanks to ...
+
+* James M. Lawrence/quix
+* Luis Lavena
+* Pivotal Labs
+* Simon Chiang/bahuvrihi
+
+-- Jim Weirich

data/lib/rake/gempackagetask.rb

@@ -9,12 +9,6 @@ require 'rake/packagetask'
 require 'rubygems/user_interaction'
 require 'rubygems/builder'
 
-begin
-  Gem.manage_gems
-rescue NoMethodError => ex
-  # Using rubygems prior to 0.6.1
-end
-
 module Rake
 
   # Create a package based upon a Gem spec.  Gem packages, as well as

data/lib/rake/loaders/makefile.rb

@@ -4,11 +4,13 @@ module Rake
 
   # Makefile loader to be used with the import file loader.
   class MakefileLoader
+    SPACE_MARK = "__ __"
 
     # Load the makefile dependencies in +fn+.
     def load(fn)
       open(fn) do |mf|
         lines = mf.read
+        lines.gsub!(/\\ /, SPACE_MARK)
         lines.gsub!(/#[^\n]*\n/m, "")
         lines.gsub!(/\\\n/, ' ')
         lines.split("\n").each do |line|
@@ -23,11 +25,16 @@ module Rake
     def process_line(line)
       file_tasks, args = line.split(':')
       return if args.nil?
-      dependents = args.split
+      dependents = args.split.map { |d| respace(d) }
       file_tasks.strip.split.each do |file_task|
+        file_task = respace(file_task)
         file file_task => dependents
       end
     end
+    
+    def respace(str)
+      str.gsub(/#{SPACE_MARK}/, ' ')
+    end
   end
 
   # Install the handler

data/lib/rake/packagetask.rb

@@ -122,7 +122,6 @@ module Rake
           task :package => ["#{package_dir}/#{file}"]
           file "#{package_dir}/#{file}" => [package_dir_path] + package_files do
             chdir(package_dir) do
-              sh %{env}
               sh %{#{@tar_command} #{flag}cvf #{file} #{package_name}}
             end
           end