rake 0.8.7 → 0.9.0.beta.0

data/CHANGES

@@ -1,6 +1,70 @@
-
 = Rake Changelog
 
+== Pre-Version 0.9.x
+
+* Rake history is now UTF-8 encoded.
+
+* Rake now uses case-insensitive comparisons to find the Rakefile on Windows.
+  Based on patch by Roger Pack.
+
+* Rake now requires (instead of loads) files in the test task.  Patch by Cezary
+  Baginski.
+
+* Rake now runs tasks when they have equal timestamps.  Patch by James M.
+  Lawrence.
+
+* Fixed typos.  Patches by Sean Scot August Moon and R.T. Lechow.
+
+* Rake now prints the Rakefile directory only when it's different from the
+  current directory.  Patch by Alex Chaffee.
+
+* Improved rakefile_location discovery on Windows.  Patch by James Tucker.
+
+* Rake now recognizes "Windows Server" as a windows system.  Patch by Matthias
+  Lüdtke
+
+* Rake::RDocTask is deprecated.  Use RDoc::Task from RDoc 2.4.2+ (require
+  'rdoc/task')
+
+* Rake::GemPackageTask is deprecated.  Use Gem::PackageTask (require
+  'rubygems/package_task')
+
+* Rake now outputs various messages to $stderr instead of $stdout.
+
+* Rake no longer emits warnings for Config.  Patch by Santiago Pastorino.
+
+* Removed Rake's DSL methods from the top level scope.  If you need to
+  call 'task :xzy' in your code, include Rake::DSL into your class, or
+  put the code in a Rake::DSL.environment do ... end block.
+
+* Allow single line comments immediately prior to a task to be used in
+  place of +desc+.
+
+* Split rake.rb into individual files.
+
+* Support for the --where (-W) flag for showing where a task is defined.
+
+* Fixed quoting in test task.
+  (http://onestepback.org/redmine/issues/show/44,
+  http://www.pivotaltracker.com/story/show/1223138)
+
+* Fixed the silent option parsing problem.
+  (http://onestepback.org/redmine/issues/show/47)
+
+* Fixed :verbose=>false flag on sh and ruby commands.
+
+* Rake command line options may be given by default in a RAKEOPT
+  environment variable.
+
+* Errors in Rake will now display the task invocation chain in effect
+  at the time of the error.
+
+* Accepted change by warnickr to not expand test patterns in shell
+  (allowing more files in the test suite).
+
+* Fixed that file tasks did not perform prereq lookups in scope
+  (Redmine #57).
+
 == Version 0.8.7
 
 * Fixed EXEEXT for JRuby on windows.
@@ -10,6 +74,10 @@
 * Minor fixes to the RDoc generation (removed dependency on darkfish
   and removed inline source option).
 
+== PreVersion 0.8.6
+
+* Now allow # comments to comment a task definition.
+
 == Version 0.8.5
 
 * Better support for the system command on Windows.
@@ -36,7 +104,7 @@
 * Fixed stray ARGV option problem that was interfering with
   Test::Unit::Runner.
 
-* Fixed default verbose mode (was accidently changed to false).  
+* Fixed default verbose mode (was accidently changed to false).
 
 * Removed reference to manage_gem to fix the warning produced by the
   gem package task.
@@ -49,7 +117,7 @@
   directory.
 
 * Added fix to handle ruby installations in directories with spaces in
-  their name.  
+  their name.
 
 == Version 0.8.2
 
@@ -66,7 +134,7 @@
   symbol/string differences. (Patch supplied by Edwin Pratomo)
 
 * Fixed bug with rules involving multiple source (Patch supplied by
-  Emanuel Inderm�hle)
+  Emanuel Indermühle)
 
 * Switched from getoptlong to optparse (patches supplied by Edwin
   Pratomo)
@@ -87,7 +155,7 @@
 
 * Changed from using Mutex to Monitor. Evidently Mutex causes thread
   join errors when Ruby is compiled with -disable-pthreads. (Patch
-  supplied by Ittay Dror) 
+  supplied by Ittay Dror)
 
 * Fixed bug in makefile parser that had problems with extra spaces in
   file task names. (Patch supplied by Ittay Dror)
@@ -142,14 +210,14 @@
 * 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). 
+  Sauerbeck).
 * Added plain filename support to rule dependents (suggested by Nobu
-  Nakada). 
+  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). 
+  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.
@@ -270,7 +338,7 @@
 * 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. 
+  backtrace on errors.
 
 == Version 0.4.14
 

data/{README → README.rdoc}

@@ -1,6 +1,6 @@
-= RAKE -- Ruby Make 
+= RAKE -- Ruby Make
 
-Supporting Rake version: 0.8.6
+Supporting Rake version: 0.8.7.
 
 This package contains Rake, a simple ruby build program with
 capabilities similar to make.
@@ -52,7 +52,7 @@ First, you must write a "Rakefile" file which contains the build rules. Here's
 a simple example:
 
   task :default => [:test]
-  
+
   task :test do
     ruby "test/unittest.rb"
   end
@@ -89,7 +89,6 @@ Type "rake --help" for all available options.
 * For a glossary of terms, see
   doc/glossary.rdoc[http://rake.rubyforge.org/files/doc/glossary_rdoc.html].
 
-
 == Development
 
 === Source Repository
@@ -103,6 +102,7 @@ http://github.com/jimweirich/rake. The public git clone URL is
 
 If you wish to run the unit and functional tests that come with Rake:
 
+* Install the 'flexmock' gem
 * Install the 'session' gem in order to run the functional tests.
 * CD into the top project directory of rake.
 * Type one of the following:
@@ -112,14 +112,16 @@ If you wish to run the unit and functional tests that come with Rake:
 
 === Issues and Bug Reports
 
-Bugs, features requests and other issues can be logged at
+Feature requests and bug reports can be made here
+
+* http://onestepback.org/cgi-bin/bugs.cgi?project=rake
 
-* http://onestepback.org/redmine/projects/show/rake
+No account is needed for posting requests.  Or you can send me an
+email (at jim dot weirich at gmail dot com)
 
-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)
+Issues and bug reports can be tracked here:
 
+* http://www.pivotaltracker.com/projects/28469
 
 == Online Resources
 
@@ -130,6 +132,8 @@ an email (at jim dot weirich at gmail dot com)
 * 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
+* Rake Issue Tracking: http://www.pivotaltracker.com/projects/28469
+* Rake Bug Reports: http://onestepback.org/cgi-bin/bugs.cgi?project=rake
 
 === Presentations and Articles about Rake
 
@@ -171,7 +175,7 @@ The Rake homepage is http://rake.rubyforge.org.  You can find the Rake
 RubyForge page at http://rubyforge.org/projects/rake.
 
 Feel free to submit commits or feature requests.  If you send a patch,
-remember to update the corresponding unit tests.  If fact, I prefer
+remember to update the corresponding unit tests.  In fact, I prefer
 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

data/Rakefile

@@ -6,17 +6,28 @@
 # This file may be distributed under an MIT style license.  See
 # MIT-LICENSE for details.
 
-begin
-  require 'rubygems'
-  require 'rake/gempackagetask'
-rescue Exception
-  nil
+require 'rbconfig'
+require 'rubygems'
+
+system_rake = File.join RbConfig::CONFIG['rubylibdir'], 'rake.rb'
+
+# Use our rake, not the installed rake from system
+if $".include? system_rake then
+  exec Gem.ruby, '-Ilib', 'bin/rake', *ARGV
 end
+
+require 'rubygems/package_task'
+
 require 'rake/clean'
 require 'rake/testtask'
-require 'rake/rdoctask'
 
-CLEAN.include('**/*.o', '*.dot', '**/.*.rbc')
+begin
+  gem 'rdoc'
+  require 'rdoc/task'
+rescue Gem::LoadError
+end
+
+CLEAN.include('**/*.o', '*.dot', '**/*.rbc')
 CLOBBER.include('doc/example/main', 'testdata')
 CLOBBER.include('test/data/**/temp_*')
 CLOBBER.include('test/data/chains/play.*')
@@ -34,7 +45,7 @@ end
 
 # Determine the current version of the software
 
-if `ruby -Ilib ./bin/rake --version` =~ /rake, version ([0-9.]+)$/
+if `ruby -Ilib ./bin/rake --version` =~ /rake, version ([0-9a-z.]+)$/
   CURRENT_VERSION = $1
 else
   CURRENT_VERSION = "0.0.0"
@@ -47,47 +58,50 @@ SRC_RB = FileList['lib/**/*.rb']
 # The default task is run if rake is given no explicit arguments.
 
 desc "Default Task"
-task :default => :test_all
+task :default => "test:all"
 
 # Test Tasks ---------------------------------------------------------
-task :dbg do |t|
-  puts "Arguments are: #{t.args.join(', ')}"
-end
 
 # 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
+task :ta => "test:all"
+task :tf => "test:functional"
+task :tu => "test:units"
+task :tc => "test:contribs"
+task :test => "test:units"
+
+module TestFiles
+  UNIT = FileList['test/lib/*_test.rb']
+  FUNCTIONAL = FileList['test/functional/*_test.rb']
+  CONTRIB = FileList['test/contrib/test*.rb']
+  TOP = FileList['test/*_test.rb']
+  ALL = TOP + UNIT + FUNCTIONAL + CONTRIB
 end
 
-Rake::TestTask.new(:test_units) do |t|
-  t.test_files = FileList['test/test*.rb']
-  t.warning = true
-  t.verbose = false
-end
+namespace :test do
+  Rake::TestTask.new(:all) do |t|
+    t.test_files = TestFiles::ALL
+    t.libs << "."
+    t.warning = true
+  end
 
-Rake::TestTask.new(:test_functional) do |t|
-  t.test_files = FileList['test/fun*.rb']
-  t.warning = true
-  t.verbose = false
-end
+  Rake::TestTask.new(:units) do |t|
+    t.test_files = TestFiles::UNIT
+    t.libs << "."
+    t.warning = true
+  end
 
-Rake::TestTask.new(:test_contribs) do |t|
-  t.test_files = FileList['test/contrib/test*.rb']
-  t.warning = true
-  t.verbose = false
+  Rake::TestTask.new(:functional) do |t|
+    t.test_files = TestFiles::FUNCTIONAL
+    t.libs << "."
+    t.warning = true
+  end
+
+  Rake::TestTask.new(:contribs) do |t|
+    t.test_files = TestFiles::CONTRIB
+    t.libs << "."
+    t.warning = true
+  end
 end
 
 begin
@@ -95,25 +109,29 @@ begin
 
   Rcov::RcovTask.new do |t|
     t.libs << "test"
-    dot_rakes = 
+    dot_rakes =
     t.rcov_opts = [
       '-xRakefile', '-xrakefile', '-xpublish.rf',
-      '-xlib/rake/contrib', '-x/Library', 
+      '-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'
+      'test/lib/*_test.rb',
+      'test/contrib/*_test.rb',
+      'test/functional/*_test.rb'
     ]
     t.output_dir = 'coverage'
     t.verbose = true
   end
 rescue LoadError
-  puts "RCov is not available"
+  task :rcov do
+    puts "RCov is not available"
+  end
 end
 
 directory 'testdata'
-[:test_all, :test_units, :test_contribs, :test_functional].each do |t|
+["test:all", :test_units, :test_contribs, :test_functional].each do |t|
   task t => ['testdata']
 end
 
@@ -128,29 +146,24 @@ end
 
 # Create a task to build the RDOC documentation tree.
 
-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',
+  '--line-numbers', '--show-hash',
+  '--main', 'README.rdoc',
+  '--title', 'Rake -- Ruby Make'
 ]
 
-rd = Rake::RDocTask.new("rdoc") do |rdoc|
-  rdoc.rdoc_dir = 'html'
-  rdoc.template = 'doc/jamis.rb'
-  rdoc.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/)
+if defined?(RDoc::Task) then
+  RDoc::Task.new do |rdoc|
+    rdoc.rdoc_dir = 'html'
+    rdoc.title    = "Rake -- Ruby Make"
+    rdoc.options = BASE_RDOC_OPTIONS.dup
+
+    rdoc.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'TODO', 'CHANGES')
+    rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+    rdoc.rdoc_files.exclude(/\bcontrib\b/)
+  end
+else
+  warn "RDoc 2.4.2+ is required to build documentation"
 end
 
 # ====================================================================
@@ -158,10 +171,11 @@ end
 # tar, zip and gem files.
 
 PKG_FILES = FileList[
+  '.gemtest',
   'install.rb',
   '[A-Z]*',
-  'bin/**/*', 
-  'lib/**/*.rb', 
+  'bin/**/*',
+  'lib/**/*.rb',
   'test/**/*.rb',
   'test/**/*.rf',
   'test/**/*.mf',
@@ -177,7 +191,7 @@ if ! defined?(Gem)
   puts "Package Target requires RubyGEMs"
 else
   SPEC = Gem::Specification.new do |s|
-    
+
     #### Basic information.
 
     s.name = 'rake'
@@ -185,13 +199,14 @@ else
     s.summary = "Ruby based make-like utility."
     s.description = <<-EOF
       Rake is a Make-like program implemented in Ruby. Tasks
-      and dependencies are specified in standard Ruby syntax. 
+      and dependencies are specified in standard Ruby syntax.
     EOF
 
     #### Dependencies and requirements.
 
-    #s.add_dependency('log4r', '> 1.0.4')
-    #s.requirements << ""
+    s.required_rubygems_version = '>= 1.3.2'
+    s.add_development_dependency 'session', '~> 2.4'
+    s.add_development_dependency 'flexmock', '~> 0.8.11'
 
     #### Which files are to be included in this gem?  Everything!  (Except CVS directories.)
 
@@ -211,8 +226,14 @@ else
 
     #### Documentation and testing.
 
-    s.has_rdoc = true
-    s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+    s.extra_rdoc_files = FileList[
+      'README.rdoc',
+      'MIT-LICENSE',
+      'TODO',
+      'CHANGES',
+      'doc/**/*.rdoc'
+    ]
+
     s.rdoc_options = BASE_RDOC_OPTIONS
 
     #### Author and project details.
@@ -227,7 +248,7 @@ else
 #     end
   end
 
-  package_task = Rake::GemPackageTask.new(SPEC) do |pkg|
+  package_task = Gem::PackageTask.new(SPEC) do |pkg|
     pkg.need_zip = true
     pkg.need_tar = true
   end
@@ -289,28 +310,13 @@ task :todo do
   RUBY_FILES.egrep(/#.*(FIXME|TODO|TBD)/)
 end
 
-desc "Look for Debugging print lines"
-task :dbg do
-  RUBY_FILES.egrep(/\bDBG|\bbreakpoint\b/)
-end
-
 desc "List all ruby files"
-task :rubyfiles do 
+task :rubyfiles do
   puts RUBY_FILES
   puts FileList['bin/*'].exclude('bin/*.rb')
 end
 task :rf => :rubyfiles
 
-desc "Create a TAGS file"
-task :tags => "TAGS"
-
-TAGS = 'xctags -e'
-
-file "TAGS" => RUBY_FILES do
-  puts "Makings TAGS"
-  sh "#{TAGS} #{RUBY_FILES}", :verbose => false
-end
-
 # --------------------------------------------------------------------
 # Creating a release
 
@@ -326,28 +332,28 @@ task :release, :rel, :reuse, :reltest,
   :needs => [
     :prerelease,
     :clobber,
-    :test_all,
+    "test:all",
     :update_version,
     :package,
     :tag
   ] do
-  announce 
+  announce
   announce "**************************************************************"
   announce "* Release #{$package_version} Complete."
   announce "* Packages ready to upload."
   announce "**************************************************************"
-  announce 
+  announce
 end
 
 # Validate that everything is ready to go for a release.
 task :prerelease, :rel, :reuse, :reltest do |t, args|
   $package_version = args.rel
-  announce 
+  announce
   announce "**************************************************************"
   announce "* Making RubyGem Release #{$package_version}"
   announce "* (current version #{CURRENT_VERSION})"
   announce "**************************************************************"
-  announce  
+  announce
 
   # Is a release number supplied?
   unless args.rel
@@ -381,13 +387,13 @@ task :update_version, :rel, :reuse, :reltest,
     announce "Updating Rake version to #{args.rel}"
     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 = '#{args.rel}'"
-	  else
-	    rakeout.puts line
-	  end
-	end
+        rakein.each do |line|
+          if line =~ /^RAKEVERSION\s*=\s*/
+            rakeout.puts "RAKEVERSION = '#{args.rel}'"
+          else
+            rakeout.puts line
+          end
+        end
       end
     end
     mv "lib/rake.rb.new", "lib/rake.rb"
@@ -412,14 +418,6 @@ task :tag, :rel, :reuse, :reltest,
   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')
@@ -428,3 +426,8 @@ desc "Where is the current directory.  This task displays\nthe current rake dire
 task :where_am_i do
   puts Rake.original_dir
 end
+
+task :failure => :really_fail
+task :really_fail do
+  fail "oops"
+end