rake 0.4.11 → 0.8.7

data/Rakefile

@@ -1,9 +1,9 @@
 # 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
+# This file may be distributed under an MIT style license.  See
 # MIT-LICENSE for details.
 
 begin
@@ -16,64 +16,109 @@ require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-CLEAN.include('**/*.o')
-CLOBBER.include('doc/example/main')
+CLEAN.include('**/*.o', '*.dot', '**/.*.rbc')
+CLOBBER.include('doc/example/main', 'testdata')
+CLOBBER.include('test/data/**/temp_*')
+CLOBBER.include('test/data/chains/play.*')
+CLOBBER.include('test/data/file_creation_task/build')
+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
 
 # Determine the current version of the software
 
-if `ruby -Ilib ./bin/rake --version` =~ /\S+$/
-  PKG_VERSION = $&
+if `ruby -Ilib ./bin/rake --version` =~ /rake, version ([0-9.]+)$/
+  CURRENT_VERSION = $1
 else
-  PKG_VERSION = "0.0.0"
+  CURRENT_VERSION = "0.0.0"
 end
 
+$package_version = CURRENT_VERSION
+
 SRC_RB = FileList['lib/**/*.rb']
 
 # The default task is run if rake is given no explicit arguments.
 
 desc "Default Task"
-task :default => :test
+task :default => :test_all
 
 # Test Tasks ---------------------------------------------------------
-
-Rake::TestTask.new do |t|
-  t.test_files = FileList['test/test*.rb']
-  t.verbose = true
+task :dbg do |t|
+  puts "Arguments are: #{t.args.join(', ')}"
 end
 
-Rake::TestTask.new(:testfun) do |t|
-  t.pattern = 'test/fun*.rb'
-  t.verbose = true
+# 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
 end
 
-Rake::TestTask.new(:testcontrib) do |t|
-  t.pattern = 'test/contrib/test*.rb'
-  t.verbose = true
+Rake::TestTask.new(:test_units) do |t|
+  t.test_files = FileList['test/test*.rb']
+  t.warning = true
+  t.verbose = false
 end
 
-directory 'testdata'
-task :test => ['testdata']
+Rake::TestTask.new(:test_functional) do |t|
+  t.test_files = FileList['test/fun*.rb']
+  t.warning = true
+  t.verbose = false
+end
 
-desc "Run all test targets"
-task :testall => [:test, :testcontrib, :testfun]
+Rake::TestTask.new(:test_contribs) do |t|
+  t.test_files = FileList['test/contrib/test*.rb']
+  t.warning = true
+  t.verbose = false
+end
 
-# Abbreviations
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new do |t|
+    t.libs << "test"
+    dot_rakes = 
+    t.rcov_opts = [
+      '-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'
+    ]
+    t.output_dir = 'coverage'
+    t.verbose = true
+  end
+rescue LoadError
+  puts "RCov is not available"
+end
 
-task :ta => [:testall]
-task :tf => [:testfun]
-task :tc => [:testcontrib]
+directory 'testdata'
+[:test_all, :test_units, :test_contribs, :test_functional].each do |t|
+  task t => ['testdata']
+end
 
 # CVS Tasks ----------------------------------------------------------
 
-desc "Tag all the CVS files with the latest release number (TAG=x)"
-task :tag do
-  rel = "REL_" + PKG_VERSION.gsub(/\./, '_')
-  rel << ENV['TAG'] if ENV['TAG']
-  puts rel
-  sh %{cvs commit -m 'pre-tag commit'}
-  sh %{cvs tag #{rel}}
-end
-
 # Install rake using the standard install.rb script.
 
 desc "Install the application"
@@ -83,17 +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 = 'jamis'
+  rdoc.template = 'doc/jamis.rb'
   rdoc.title    = "Rake -- Ruby Make"
-  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  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
@@ -105,20 +163,25 @@ PKG_FILES = FileList[
   'bin/**/*', 
   'lib/**/*.rb', 
   'test/**/*.rb',
+  '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.
 
     s.name = 'rake'
-    s.version = PKG_VERSION
+    s.version = $package_version
     s.summary = "Ruby based make-like utility."
     s.description = <<-EOF
       Rake is a Make-like program implemented in Ruby. Tasks
@@ -150,10 +213,7 @@ else
 
     s.has_rdoc = true
     s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
-    s.rdoc_options <<
-      '--title' <<  'Rake -- Ruby Make' <<
-      '--main' << 'README' <<
-      '--line-numbers'
+    s.rdoc_options = BASE_RDOC_OPTIONS
 
     #### Author and project details.
 
@@ -161,12 +221,24 @@ else
     s.email = "jim@weirichhouse.org"
     s.homepage = "http://rake.rubyforge.org"
     s.rubyforge_project = "rake"
+#     if ENV['CERT_DIR']
+#       s.signing_key = File.join(ENV['CERT_DIR'], 'gem-private_key.pem')
+#       s.cert_chain  = [File.join(ENV['CERT_DIR'], 'gem-public_cert.pem')]
+#     end
   end
 
-  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 =========================================================
@@ -203,13 +275,156 @@ task :lines do
   show_line("TOTAL", total_lines, total_code)
 end
 
-ARCHIVEDIR = '/mnt/usb'
-
-task :archive => [:package] do
-  cp FileList["pkg/*.tgz", "pkg/*.zip", "pkg/*.gem"], ARCHIVEDIR
-end
-
 # Define an optional publish target in an external file.  If the
 # publish.rf file is not found, the publish targets won't be defined.
 
 load "publish.rf" if File.exist? "publish.rf"
+
+# Support Tasks ------------------------------------------------------
+
+RUBY_FILES = FileList['**/*.rb'].exclude('pkg')
+
+desc "Look for TODO and FIXME tags in the code"
+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 
+  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
+
+def plugin(plugin_name)
+  require "rake/plugins/#{plugin_name}"
+end
+
+task :noop
+#plugin "release_manager"
+
+desc "Make a new release"
+task :release, :rel, :reuse, :reltest,
+  :needs => [
+    :prerelease,
+    :clobber,
+    :test_all,
+    :update_version,
+    :package,
+    :tag
+  ] do
+  announce 
+  announce "**************************************************************"
+  announce "* Release #{$package_version} Complete."
+  announce "* Packages ready to upload."
+  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 "* Making RubyGem Release #{$package_version}"
+  announce "* (current version #{CURRENT_VERSION})"
+  announce "**************************************************************"
+  announce  
+
+  # Is a release number supplied?
+  unless args.rel
+    fail "Usage: rake release[X.Y.Z] [REUSE=tag_suffix]"
+  end
+
+  # Is the release different than the current release.
+  # (or is REUSE set?)
+  if $package_version == CURRENT_VERSION && ! args.reuse
+    fail "Current version is #{$package_version}, must specify REUSE=tag_suffix to reuse version"
+  end
+
+  # Are all source files checked in?
+  if args.reltest
+    announce "Release Task Testing, skipping checked-in file test"
+  else
+    announce "Checking for unchecked-in files..."
+    data = `svn st`
+    unless data =~ /^$/
+      abort "svn status is not clean ... do you have unchecked-in files?"
+    end
+    announce "No outstanding checkins found ... OK"
+  end
+end
+
+task :update_version, :rel, :reuse, :reltest,
+  :needs => [:prerelease] do |t, args|
+  if args.rel == CURRENT_VERSION
+    announce "No version change ... skipping version update"
+  else
+    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
+      end
+    end
+    mv "lib/rake.rb.new", "lib/rake.rb"
+    if args.reltest
+      announce "Release Task Testing, skipping commiting of new version"
+    else
+      sh %{svn commit -m "Updated to version #{args.rel}" lib/rake.rb} # "
+    end
+  end
+end
+
+desc "Tag all the CVS files with the latest release number (REL=x.y.z)"
+task :tag, :rel, :reuse, :reltest,
+  :needs => [:prerelease] do |t, args|
+  reltag = "REL_#{args.rel.gsub(/\./, '_')}"
+  reltag << args.reuse.gsub(/\./, '_') if args.reuse
+  announce "Tagging Repository with [#{reltag}]"
+  if args.reltest
+    announce "Release Task Testing, skipping CVS tagging"
+  else
+    sh %{svn copy svn+ssh://rubyforge.org/var/svn/rake/trunk svn+ssh://rubyforge.org/var/svn/rake/tags/#{reltag} -m 'Commiting release #{reltag}'} ###'
+  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')
+
+desc "Where is the current directory.  This task displays\nthe current rake directory"
+task :where_am_i do
+  puts Rake.original_dir
+end

data/TODO

@@ -4,6 +4,7 @@ Send suggestions for this list to mailto:jim@weirichhouse.org or on
 the rake-devel@rubyforge.org mailing list.
 
 === To Do
+* Need a nice API for accessing tasks in namespaces, namespaces in an app, etc.
 * Provide a way to disable -w warning mode.
 * Define a set of default rules that work in the absense of any Rakefile
 * What about cyclic dependencies?

data/bin/rake

@@ -1,8 +1,31 @@
+#!/usr/bin/env ruby
+
+#--
+# Copyright (c) 2003, 2004, 2005, 2006, 2007  Jim Weirich
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+#++
+
 begin
   require 'rake'
 rescue LoadError
   require 'rubygems'
-  require_gem 'rake'
+  require 'rake'
 end
-RakeApp.new.run
-
+Rake.application.run

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.