rake 0.6.2 → 0.7.0

data/CHANGES

@@ -1,6 +1,31 @@
 = Rake Changelog
 
-== PreVersion 0.5.5
+== Pre-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).

data/README

@@ -1,6 +1,6 @@
 = RAKE -- Ruby Make 
 
-Supporting Rake version: 0.6
+Supporting Rake version: 0.7.x
 
 This package contains Rake, a simple ruby build program with
 capabilities similar to make.
@@ -43,6 +43,16 @@ Download and install  rake with the following.
 
    gem install --remote rake
 
+=== 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
@@ -53,8 +63,8 @@ Download and install  rake with the following.
 
 == Presentations and Articles about Rake
 
-* Jim Weirich\u2019s 2003 RubyConf presentation: http://onestepback.org/articles/buildingwithrake/
-* Martin Fowler\u2019s article on Rake: http://martinfowler.com/articles/rake.html
+* 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
 
@@ -101,8 +111,10 @@ other projects with similar (and not so similar) goals.
 * 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
 

data/Rakefile

@@ -1,6 +1,6 @@
 # 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
@@ -30,8 +30,8 @@ end
 
 # Determine the current version of the software
 
-if `ruby -Ilib ./bin/rake --version` =~ /\S+$/
-  CURRENT_VERSION = $&
+if `ruby -Ilib ./bin/rake --version` =~ /rake, version ([0-9.]+)$/
+  CURRENT_VERSION = $1
 else
   CURRENT_VERSION = "0.0.0"
 end
@@ -42,23 +42,24 @@ else
   PKG_VERSION = CURRENT_VERSION
 end
 
-
 SRC_RB = FileList['lib/**/*.rb']
 
 # The default task is run if rake is given no explicit arguments.
 
 desc "Default Task"
-task :default => :alltests
+task :default => :test_all
 
 # Test Tasks ---------------------------------------------------------
 
-task :ta => :alltests
-task :tf => :funtests
-task :tu => :unittests
-task :tc => :contribtests
-task :test => :unittests
+# 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(:alltests) do |t|
+Rake::TestTask.new(:test_all) do |t|
   t.test_files = FileList[
     'test/test*.rb',
     'test/contrib/test*.rb',
@@ -68,26 +69,26 @@ Rake::TestTask.new(:alltests) do |t|
   t.verbose = true
 end
 
-Rake::TestTask.new(:unittests) do |t|
+Rake::TestTask.new(:test_units) do |t|
   t.test_files = FileList['test/test*.rb']
   t.warning = true
   t.verbose = false
 end
 
-Rake::TestTask.new(:funtests) do |t|
+Rake::TestTask.new(:test_functional) do |t|
   t.test_files = FileList['test/fun*.rb']
   t.warning = true
   t.warning = true
 end
 
-Rake::TestTask.new(:contribtests) do |t|
+Rake::TestTask.new(:test_contribs) do |t|
   t.test_files = FileList['test/contrib/test*.rb']
   t.verbose = false
   t.warning = true
 end
 
 directory 'testdata'
-[:alltests, :unittests, :contribtests, :funtests].each do |t|
+[:test_all, :test_units, :test_contribs, :test_functional].each do |t|
   task t => ['testdata']
 end
 
@@ -106,7 +107,7 @@ rd = Rake::RDocTask.new("rdoc") { |rdoc|
   rdoc.rdoc_dir = 'html'
 #  rdoc.template = 'kilmer'
 #  rdoc.template = 'css2'
-  rdoc.template = 'doc/jamis.rb'
+  rdoc.template = '/home/jim/working/rubyforge/rake/doc/jamis.rb'
   rdoc.title    = "Rake -- Ruby Make"
   rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
   rdoc.rdoc_files.include('README', 'MIT-LICENSE', 'TODO', 'CHANGES')
@@ -257,6 +258,7 @@ 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
@@ -265,7 +267,7 @@ desc "Make a new release"
 task :release => [
   :prerelease,
   :clobber,
-  :alltests,
+  :test_all,
   :update_version,
   :package,
   :tag] do
@@ -348,6 +350,14 @@ task :tag => [:prerelease] do
   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')

data/bin/rake

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

data/doc/rakefile.rdoc

@@ -110,6 +110,46 @@ both prerequisites and actions can be added later.  For example ...
     cp Dir["standard_data/*.data"], "testdata"
   end
 
+== Tasks with Parallel Prerequisites
+
+Rake allows parallel execution of prerequisites using the following syntax:
+
+  multitask :copy_files => [:copy_src, :copy_doc, :copy_bin] do
+    puts "All Copies Complete"
+  end
+
+In this example, +copy_files+ is a normal rake task.  Its actions are
+executed whereever all of its prerequisites are done.  The big
+difference is that the prerequisites (+copy_src+, +copy_bin+ and
++copy_doc+) are executed in parallel.  Each of the prerequisites are
+run in their own Ruby thread, possibly allowing faster overall runtime.
+
+=== Secondary Prerequisites
+
+If any of the primary prerequites of a multitask have common secondary
+prerequisites, all of the primary/parallel prerequisites will wait
+until the common prerequisites have been run.
+
+For example, if the <tt>copy_<em>xxx</em></tt> tasks have the
+following prerequisites:
+
+  task :copy_src => [:prep_for_copy]
+  task :copy_bin => [:prep_for_copy]
+  task :copy_doc => [:prep_for_copy]
+
+Then the +prep_for_copy+ task is run before starting all the copies in
+parallel.  Once +prep_for_copy+ is complete, +copy_src+, +copy_bin+,
+and +copy_doc+ are all run in parallel.  Note that +prep_for_copy+ is
+run only once, even though it is referenced in multiple threads.
+
+=== Thread Safety
+
+The Rake internal data structures are thread-safe with respect
+to the multitask parallel execution, so there is no need for the user
+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.
+
 == Rules
 
 When a file is named as a prerequisite, but does not have a file task
@@ -231,6 +271,91 @@ Only tasks with descriptions will be displayed with the "-T" switch.
 Use "-P" (or "--prereqs") to get a list of all tasks and their
 prerequisites.
 
+== Namespaces
+
+As projects grow (and along with it, the number of tasks), it is
+common for task names to begin to clash.  For example, if you might
+have a main program and a set of sample programs built by a single
+Rakefile.  By placing the tasks related to the main program in one
+namespace, and the tasks for building the sample programs in a
+different namespace, the task names will not will not interfer with
+each other.
+
+For example:
+
+  namespace "main"
+    task :build do
+      # Build the main program
+    end
+  end
+
+  namespace "samples" do
+    task :build do
+      # Build the sample programs
+    end
+  end
+
+  task :build => ["main:build", "samples:build"]
+
+Referencing a task in a separate namespace can be achieved by
+prefixing the task name with the namespace and a colon
+(e.g. "main:build" refers to the :build task in the +main+ namespace).
+Nested namespaces are supported, so
+
+Note that the name given in the +task+ command is always the unadorned
+task name without any namespace prefixes.  The +task+ command always
+defines a task in the current namespace.  
+
+=== FileTasks
+
+File task names are not scoped by the namespace command.  Since the
+name of a file task is the name of an actual file in the file system,
+it makes little sense to include file task names in name space.
+Directory tasks (created by the +directory+ command) are a type of
+file task and are also not affected by namespaces.
+
+=== Name Resolution
+
+When looking up a task name, rake will start with the current
+namespace and attempt to find the name there.  If it fails to find a
+name in the current namespace, it will search the parent namespaces
+until a match is found (or an error occurs if there is no match).
+
+The "rake" namespace is a special implicit namespace that refers to
+the toplevel names.
+
+If a task name begins with a "^" character, the name resolution will
+start in the parent namespace.  Multiple "^" characters are allowed.
+
+Here is an example file with multiple :run tasks and how various names
+resolve in different locations.
+
+  task :run
+
+  namespace "one" do
+    task :run
+
+    namespace "two" do
+      task :run
+
+      # :run            => "one:two:run"
+      # "two:run"       => "one:two:run"
+      # "one:two:run"   => "one:two:run"
+      # "one:run"       => "one:run"
+      # "^run"          => "one:run"
+      # "^^run"         => "rake:run" (the top level task)
+      # "rake:run"      => "rake:run" (the top level task)
+    end
+
+    # :run       => "one:run"
+    # "two:run"  => "one:two:run"
+    # "^run"     => "rake:run"
+  end
+
+  # :run           => "rake:run"
+  # "one:run"      => "one:run"
+  # "one:two:run"  => "one:two:run"
+
 == Odds and Ends
 
 === do/end verses { }
@@ -262,6 +387,7 @@ This is the proper way to specify the task ...
   end
 
 ----
+
 == See
 
 * README -- Main documentation for Rake.

data/doc/release_notes/rake-0.7.0.rdoc

@@ -0,0 +1,119 @@
+= Rake 0.7.0 Released
+
+These changes for Rake have been brewing for a long time.  Here they
+are, I hope you enjoy them.
+
+== Changes
+
+=== New Features
+
+* Name space support for task names (see below).
+
+* Prerequisites can be executed in parallel (see below).
+
+* Added safe_ln support for openAFS (via Ludvig Omholt).
+
+* RDoc defaults to internal (in-process) invocation.  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.
+
+* Task objects my now be used in prerequisite lists directly.
+
+* Task objects (in addition to task names) may now be included in the
+  prerequisite list of a task.
+
+* Internals cleanup and refactoring.
+
+=== Bug Fixes
+
+* Compatibility fixes for Ruby 1.8.4 FileUtils changes.
+
+=== Namespaces
+
+Tasks can now be nested inside their own namespaces.  Tasks within one
+namespace will not accidently interfer with tasks named in a different
+namespace.
+
+For example:
+
+  namespace "main" do
+    task :build do
+      # Build the main program
+    end
+  end
+
+  namespace "samples" do
+    task :build do
+      # Build the sample programs
+    end
+  end
+
+  task :build_all => ["main:build", "samples:build"]
+
+Even though both tasks are named :build, they are separate tasks in
+their own namespaces.  The :build_all task (defined in the toplevel
+namespace) references both build tasks in its prerequisites.
+
+You may invoke each of the individual build tasks with the following
+commands:
+
+  rake main:build
+  rake samples:build
+
+Or invoke both via the :build_all command:
+
+  rake build_all  
+
+Namespaces may be nested arbitrarily.  Since the name of file tasks
+correspond to the name of a file in the external file system,
+FileTasks are not affected by the namespaces.
+
+See the Rakefile format documentation (in the Rake API documents) for
+more information.
+
+=== Parallel Tasks
+
+Sometimes you have several tasks that can be executed in parallel.  By
+specifying these tasks as prerequisites to a +multitask+ task.
+
+In the following example the tasks copy_src, copy_doc and copy_bin
+will all execute in parallel in their own thread.
+
+  multitask :copy_files => [:copy_src, :copy_doc, :copy_bin] do
+    puts "All Copies Complete"
+  end
+
+== 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
+
+== 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 ...
+
+* Doug Young (inspriation for the parallel task)
+
+* David Heinemeier Hansson (for --trace message enhancement and for
+  pushing for namespace support).
+
+* Ludvig Omholt (for the openAFS fix)
+
+-- Jim Weirich