rake 0.9.2 → 13.0.3

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2003, 2004 Jim Weirich
+Copyright (c) Jim Weirich
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,9 +1,13 @@
 = RAKE -- Ruby Make
 
-Supporting Rake version: 0.8.7.
+home :: https://github.com/ruby/rake
+bugs :: https://github.com/ruby/rake/issues
+docs :: https://ruby.github.io/rake
 
-This package contains Rake, a simple ruby build program with
-capabilities similar to make.
+== Description
+
+Rake is a Make-like program implemented in Ruby. Tasks and dependencies are
+specified in standard Ruby syntax.
 
 Rake has the following features:
 
@@ -19,30 +23,19 @@ Rake has the following features:
   file names and paths.
 
 * A library of prepackaged tasks to make building rakefiles easier. For example,
-  tasks for building tarballs, gems and RDoc output are provided.
+  tasks for building tarballs. (Formerly
+  tasks for building RDoc, Gems, and publishing to FTP were included in rake but they're now
+  available in RDoc, RubyGems, and rake-contrib respectively.)
 
 * Supports parallel execution of tasks.
 
-
 == Installation
 
 === Gem Installation
 
-Download and install  rake with the following.
-
-   gem install rake
-
-=== Normal Installation
-
-You can download the source tarball of the latest version of Rake from
+Download and install rake with the following.
 
-* http://rubyforge.org/project/showfiles.php?group_id=50
-
-Extract the tarball and run
-
-  % ruby install.rb
-
-from its distribution directory.
+  gem install rake
 
 == Usage
 
@@ -51,7 +44,7 @@ from its distribution directory.
 First, you must write a "Rakefile" file which contains the build rules. Here's
 a simple example:
 
-  task :default => [:test]
+  task default: %w[test]
 
   task :test do
     ruby "test/unittest.rb"
@@ -59,8 +52,8 @@ a simple example:
 
 This Rakefile has two tasks:
 
-* A task named "test", which - upon invocation - will run a unit test file in
-  Ruby.
+* 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.
@@ -77,124 +70,86 @@ Running the "rake" command without any options will cause it to run the
 
 Type "rake --help" for all available options.
 
+== Resources
 
-=== More Information
-
-* 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].
-* For the original announcement of Rake, see
-  doc/rational.rdoc[http://rake.rubyforge.org/files/doc/rational_rdoc.html].
-* For a glossary of terms, see
-  doc/glossary.rdoc[http://rake.rubyforge.org/files/doc/glossary_rdoc.html].
-
-== 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
-
-=== Running the Rake Test Suite
-
-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:
-
-     rake                  # If you have a version of rake installed
-     ruby -Ilib bin/rake   # If you do not have a version of rake installed.
-
-=== Issues and Bug Reports
-
-Feature requests and bug reports can be made here
+=== Rake Information
 
-* http://onestepback.org/cgi-bin/bugs.cgi?project=rake
-
-No account is needed for posting requests.  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
-
-=== 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
-* Rake Issue Tracking: http://www.pivotaltracker.com/projects/28469
-* Rake Bug Reports: http://onestepback.org/cgi-bin/bugs.cgi?project=rake
+* {Rake command-line}[link:doc/command_line_usage.rdoc]
+* {Writing Rakefiles}[link:doc/rakefile.rdoc]
+* The original {Rake announcement}[link:doc/rational.rdoc]
+* Rake {glossary}[link:doc/glossary.rdoc]
 
 === 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
+* Avdi Grimm's rake series:
+  1. {Rake Basics}[https://avdi.codes/rake-part-1-basics/]
+  2. {Rake File Lists}[https://avdi.codes/rake-part-2-file-lists-2/]
+  3. {Rake Rules}[https://avdi.codes/rake-part-3-rules/]
+  4. {Rake Pathmap}[https://avdi.codes/rake-part-4-pathmap/]
+  5. {File Operations}[https://avdi.codes/rake-part-5-file-operations/]
+  6. {Clean and Clobber}[https://avdi.codes/rake-part-6-clean-and-clobber/]
+  7. {MultiTask}[https://avdi.codes/rake-part-7-multitask/]
+* {Jim Weirich's 2003 RubyConf presentation}[https://web.archive.org/web/20140221123354/http://onestepback.org/articles/buildingwithrake/]
+* Martin Fowler's article on Rake: https://martinfowler.com/articles/rake.html
 
-== Other Make Reinvisionings ...
+== Other Make Re-envisionings ...
 
 Rake is a late entry in the make replacement field.  Here are links to
 other projects with similar (and not so similar) goals.
 
-* http://directory.fsf.org/bras.html -- Bras, one of earliest
+* https://directory.fsf.org/wiki/Bras -- Bras, one of earliest
   implementations of "make in a scripting language".
 * 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://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.
+* https://ant.apache.org -- The Ant project
+* https://search.cpan.org/search?query=PerlBuildSystem -- The Perl Build System
+* https://www.rubydoc.info/gems/rant/0.5.7/frames -- Rant, another Ruby make tool.
 
 == Credits
 
+[<b>Jim Weirich</b>] Who originally created Rake.
+
 [<b>Ryan Dlugosz</b>] For the initial conversation that sparked Rake.
 
-[<b>nobu.nokada@softhome.net</b>] For the initial patch for rule support.
+[<b>Nobuyoshi Nakada <nobu@ruby-lang.org></b>] For the initial patch for rule support.
 
 [<b>Tilman Sauerbeck <tilman@code-monkey.de></b>] For the recursive rule patch.
 
+[<b>Eric Hodel</b>] For aid in maintaining rake.
+
+[<b>Hiroshi SHIBATA</b>] Maintainer of Rake 10.X and Rake 11.X
+
 == License
 
 Rake is available under an MIT-style license.
 
 :include: MIT-LICENSE
 
-== Support
-
-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.  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
-(which is mirrored to comp.lang.ruby) or contact
-jim dot weirich at gmail.com.
-
 ---
 
 = Other stuff
 
 Author::   Jim Weirich <jim.weirich@gmail.com>
-Requires:: Ruby 1.8.0 or later
-License::  Copyright 2003-2008 by Jim Weirich.
-           Released under an MIT-style license.  See the LICENSE file
-           included in the distribution.
+Requires:: Ruby 2.0.0 or later
+License::  Copyright Jim Weirich.
+           Released under an MIT-style license.  See the MIT-LICENSE
+           file included in the distribution.
 
 == Warranty
 
-This software is provided "as is" and without any express or
-implied warranties, including, without limitation, the implied
-warranties of merchantibility and fitness for a particular
-purpose.
+This software is provided "as is" and without any express or implied
+warranties, including, without limitation, the implied warranties of
+merchantability and fitness for a particular purpose.
+
+== Historical
+
+Rake was originally created by Jim Weirich, who unfortunately passed away in
+February 2014. This repository was originally hosted at
+{github.com/jimweirich/rake}[https://github.com/jimweirich/rake/], however
+with his passing, has been moved to {ruby/rake}[https://github.com/ruby/rake].
+
+You can view Jim's last commit here:
+https://github.com/jimweirich/rake/tree/336559f28f55bce418e2ebcc0a57548dcbac4025
+
+You can {read more about Jim}[https://en.wikipedia.org/wiki/Jim_Weirich] at Wikipedia.
+
+Thank you for this great tool, Jim. We'll remember you.

data/Rakefile

@@ -6,400 +6,36 @@
 # This file may be distributed under an MIT style license.  See
 # MIT-LICENSE for details.
 
-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'
-
-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.*')
-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` =~ /rake, version ([0-9a-z.]+)$/
-  CURRENT_VERSION = $1
-else
-  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
-
-# Test Tasks ---------------------------------------------------------
-
-Rake::TestTask.new do |t|
-  files = FileList['test/helper.rb', 'test/test_*.rb']
-  t.test_files = files
-  t.libs << "."
-  t.warning = true
-end
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 begin
-  require 'rcov/rcovtask'
-  IGNORE_COVERAGE_IN = FileList[
-    'lib/rake/rdoctask.rb',
-    'lib/rake/testtask.rb',
-    'lib/rake/packagetask.rb',
-    'lib/rake/clean.rb',
-  ]
-
-  unless File::ALT_SEPARATOR
-    IGNORE_COVERAGE_IN.include(
-      'lib/rake/alt_system.rb',
-      'lib/rake/win32.rb')
-  end
-
-  Rcov::RcovTask.new do |t|
-    t.libs << "test"
-    t.rcov_opts = [
-      '-xRakefile', '-xrakefile', '-xpublish.rf',
-      '-xlib/rake/contrib', '-x/Library', '-x.rvm',
-      '--text-report',
-      '--sort coverage'
-    ] + FileList['rakelib/*.rake'].pathmap("-x%p") +
-      IGNORE_COVERAGE_IN.map { |fn| "-x#{fn}" }
-    t.test_files = FileList[
-      'test/lib/*_test.rb',
-      'test/contrib/*_test.rb',
-      'test/functional/*_test.rb'
-    ]
-    t.output_dir = 'coverage'
-    t.verbose = true
-  end
+  require "bundler/gem_tasks"
 rescue LoadError
-  task :rcov do
-    puts "RCov is not available"
-  end
-end
-
-directory 'testdata'
-task :test => ['testdata']
-
-# CVS Tasks ----------------------------------------------------------
-
-# Install rake using the standard install.rb script.
-
-desc "Install the application"
-task :install do
-  ruby "install.rb"
-end
-
-# Create a task to build the RDOC documentation tree.
-
-BASE_RDOC_OPTIONS = [
-  '--line-numbers', '--show-hash',
-  '--main', 'README.rdoc',
-  '--title', 'Rake -- Ruby Make'
-]
-
-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
-
-# ====================================================================
-# Create a task that will package the Rake software into distributable
-# tar, zip and gem files.
-
-PKG_FILES = FileList[
-  '.gemtest',
-  'install.rb',
-  '[A-Z]*',
-  '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|
-
-    #### Basic information.
-
-    s.name = 'rake'
-    s.version = $package_version
-    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.
-    EOF
-
-    #### Dependencies and requirements.
-
-    s.required_rubygems_version = '>= 1.3.2'
-    s.add_development_dependency 'minitest', '~> 2.1'
-    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.)
-
-    s.files = PKG_FILES.to_a
-
-    #### C code extensions.
-
-    #s.extensions << "ext/rmagic/extconf.rb"
-
-    #### Load-time details: library and application (you will need one or both).
-
-    s.require_path = 'lib'                         # Use these for libraries.
-
-    s.bindir = "bin"                               # Use these for applications.
-    s.executables = ["rake"]
-
-    #### Documentation and testing.
-
-    s.extra_rdoc_files = FileList[
-      'README.rdoc',
-      'MIT-LICENSE',
-      'TODO',
-      'CHANGES',
-      'doc/**/*.rdoc'
-    ]
-
-    s.rdoc_options = BASE_RDOC_OPTIONS
-
-    #### Author and project details.
-
-    s.author = "Jim Weirich"
-    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
-
-  Gem::PackageTask.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 =========================================================
-
-def count_lines(filename)
-  lines = 0
-  codelines = 0
-  open(filename) { |f|
-    f.each do |line|
-      lines += 1
-      next if line =~ /^\s*$/
-      next if line =~ /^\s*#/
-      codelines += 1
-    end
-  }
-  [lines, codelines]
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.verbose = true
+  t.test_files = FileList["test/**/test_*.rb"]
 end
 
-def show_line(msg, lines, loc)
-  printf "%6s %6s   %s\n", lines.to_s, loc.to_s, msg
+require "rdoc/task"
+RDoc::Task.new do |doc|
+  doc.main   = "README.rdoc"
+  doc.title  = "Rake -- Ruby Make"
+  doc.rdoc_files = FileList.new %w[lib MIT-LICENSE doc/**/*.rdoc *.rdoc]
+  doc.rdoc_dir = "html"
 end
 
-desc "Count lines in the main rake file"
-task :lines do
-  total_lines = 0
-  total_code = 0
-  show_line("File Name", "LINES", "LOC")
-  SRC_RB.each do |fn|
-    lines, codelines = count_lines(fn)
-    show_line(fn, lines, codelines)
-    total_lines += lines
-    total_code  += codelines
-  end
-  show_line("TOTAL", total_lines, total_code)
+task ghpages: :rdoc do
+  %x[git checkout gh-pages]
+  require "fileutils"
+  FileUtils.rm_rf "/tmp/html"
+  FileUtils.mv "html", "/tmp"
+  FileUtils.rm_rf "*"
+  FileUtils.cp_r Dir.glob("/tmp/html/*"), "."
 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 "List all ruby files"
-task :rubyfiles do
-  puts RUBY_FILES
-  puts FileList['bin/*'].exclude('bin/*.rb')
-end
-task :rf => :rubyfiles
-
-# --------------------------------------------------------------------
-# 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] => [
-    :prerelease,
-    :clobber,
-    :test,
-    :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] => [: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] => [: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
-
-# 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
-
-task :failure => :really_fail
-task :really_fail do
-  fail "oops"
-end
+task default: :test