rake 0.8.1 → 0.8.2

data/CHANGES

@@ -1,5 +1,62 @@
+
 = Rake Changelog
 
+== 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)
@@ -9,7 +66,6 @@
 
 * 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.3
 
 This package contains Rake, a simple ruby build program with
 capabilities similar to make.
@@ -13,20 +13,26 @@ 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.
 
 * A library of prepackaged tasks to make building rakefiles easier.
 
-
 == Download
 
 The latest version of rake can be found at
 
 * http://rubyforge.org/project/showfiles.php?group_id=50
 
+== 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
+
 == Installation
 
 === Normal Installation
@@ -47,6 +53,8 @@ Download and install  rake with the following.
 
 If you wish to run the unit and functional tests that come with Rake:
 
+* 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:
 
@@ -60,6 +68,8 @@ If you wish to run the unit and functional tests that come with Rake:
 * 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
 
@@ -158,7 +168,7 @@ 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>'].
+    the value by using ENV['<em>name</em>'].  
 
 [<tt>--classic-namespace</tt> (-n)]
     Import the Task, FileTask, and FileCreateTask into the top-level
@@ -167,10 +177,22 @@ Options are:
     '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.
 
@@ -187,22 +209,43 @@ Options are:
     Do not echo commands from FileUtils.
 
 [<tt>--rakefile</tt> _filename_ (-f)]
-    Use _filename_ as the name of the rakefile.  The default rakefile
+    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
+    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.
+    Turn on invoke/execute tracing. Also enable full backtrace on
+    errors.
 
 [<tt>--usage</tt> (-h)]
     Display a usage message and exit.

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'
     ]
@@ -148,6 +155,7 @@ PKG_FILES = FileList[
   'test/**/*.rf',
   'test/**/*.mf',
   'test/**/Rakefile',
+  'test/**/subdir',
   'doc/**/*'
 ]
 PKG_FILES.exclude('doc/example/*.o')
@@ -156,7 +164,7 @@ 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.
 
@@ -207,10 +215,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/rakefile.rdoc

@@ -1,4 +1,4 @@
-= Rakefile Format
+= Rakefile Format (as of version 0.8.2)
 
 First of all, there is no special format for a Rakefile.  A Rakefile
 contains executable Ruby code.  Anything legal in a ruby script is
@@ -150,6 +150,131 @@ to do extra synchronization for Rake's benefit.  However, if there are
 user data structures shared between the parallel prerequisites, the
 user must do whatever is necessary to prevent race conditions.
 
+== Tasks with Arguments
+
+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.2]
+
+And the string "0.8.2" 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 in an array (: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.
+
+If you wish to specify default values for the arguments, you can use
+the with_defaults method in the task body.  Here is the above example
+where we specify default values for the first and last names:
+
+   task :name, [:first_name, :last_name] do |t, args|
+     args.with_defaults(:first_name => "John", :last_name => "Dough")
+     puts "First name is #{args.first_name}"
+     puts "Last  name is #{args.last_name}"
+   end
+
+=== 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:
+
+   task :name, [:first_name, :last_name] => [:pre_name] do |t, args|
+     args.with_defaults(:first_name => "John", :last_name => "Dough")
+     puts "First name is #{args.first_name}"
+     puts "Last  name is #{args.last_name}"
+   end
+
+=== 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
+dependencies.  That format is still supported for compatibility, but
+is not recommended for use.
+
+== Accessing Task Programatically
+
+Sometimes it is useful to manipulate tasks programatically in a
+Rakefile. To find a task object, use the <tt>:[]</tt> operator on the
+<tt>Rake::Task</tt>.
+
+=== Programmatic Task Example
+
+For example, the following Rakefile defines two tasks.  The :doit task
+simply prints a simple "DONE" message.  The :dont class will lookup
+the doit class and remove (clear) all of its prerequisites and
+actions.
+
+   task :doit do
+     puts "DONE"
+   end
+
+   task :dont do
+     Rake::Task[:doit].clear
+   end        
+
+Running this example:
+
+  $ rake doit
+  (in /Users/jim/working/git/rake/x)
+  DONE
+  $ rake dont doit
+  (in /Users/jim/working/git/rake/x)
+  $ 
+
+The ability to programmatically manipulate tasks gives rake very
+powerful meta-programming capabilities w.r.t. task execution, but
+should be used with cation.
+
 == Rules
 
 When a file is named as a prerequisite, but does not have a file task
@@ -372,8 +497,6 @@ Or give it a glob pattern:
 
    fl = FileList['*.rb']
 
-   
-
 == Odds and Ends
 
 === do/end verses { }

data/doc/release_notes/rake-0.8.0.rdoc

@@ -0,0 +1,114 @@
+= Rake 0.8.0/0.8.1 Released
+
+Rake version 0.8.0 is a new release of rake that includes serveral new
+features.  
+
+== Changes
+
+=== New Features in Version 0.8.0
+
+* Tasks can now receive command line parameters.  See the examples
+  below for more details.
+
+* Comments are limited to 80 columns on output, but full comments can
+  be seen by using the -D parameter. (feature suggested by Jamis
+  Buck).
+
+* Explicit exit(n) calls will now set the exit status to n. (patch
+  provided by Stephen Touset).
+
+* Rake is now compatible with Ruby 1.9.
+
+Version 0.8.1 is a minor update that includes additional Ruby 1.9
+compatibility fixes.
+
+== 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
+
+== 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.0]
+
+And the string "0.8.0" 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 ...
+
+* Jamis Buck (for comment formatting suggestions)
+* Stephen Touset (for exit status patch).
+
+-- Jim Weirich