rake 10.1.1 → 10.2.0

data/lib/rake/ext/module.rb

@@ -0,0 +1 @@
+# TODO: remove in Rake 11

data/lib/rake/ext/string.rb

@@ -1,8 +1,5 @@
 require 'rake/ext/core'
 
-######################################################################
-# Rake extension methods for String.
-#
 class String
 
   rake_extension("ext") do
@@ -11,6 +8,8 @@ class String
     # is not given, or is the empty string, remove any existing extension.
     #
     # +ext+ is a user added method for the String class.
+    #
+    # This String extension comes from Rake
     def ext(newext='')
       return self.dup if ['.', '..'].include? self
       newext = (newext =~ /^\./) ? newext : ("." + newext) if newext != ''
@@ -20,6 +19,8 @@ class String
 
   rake_extension("pathmap") do
     # Explode a path into individual components.  Used by +pathmap+.
+    #
+    # This String extension comes from Rake
     def pathmap_explode
       head, tail = File.split(self)
       return [self] if head == self
@@ -32,6 +33,8 @@ class String
     # Extract a partial path from the path.  Include +n+ directories from the
     # front end (left hand side) if +n+ is positive.  Include |+n+|
     # directories from the back end (right hand side) if +n+ is negative.
+    #
+    # This String extension comes from Rake
     def pathmap_partial(n)
       dirs = File.dirname(self).pathmap_explode
       partial_dirs =
@@ -48,6 +51,8 @@ class String
 
     # Preform the pathmap replacement operations on the given path. The
     # patterns take the form 'pat1,rep1;pat2,rep2...'.
+    #
+    # This String extension comes from Rake
     def pathmap_replace(patterns, &block)
       result = self
       patterns.split(';').each do |pair|
@@ -69,35 +74,36 @@ class String
     # controls the details of the mapping.  The following special patterns are
     # recognized:
     #
-    # * <b>%p</b> -- The complete path.
-    # * <b>%f</b> -- The base file name of the path, with its file extension,
-    #   but without any directories.
-    # * <b>%n</b> -- The file name of the path without its file extension.
-    # * <b>%d</b> -- The directory list of the path.
-    # * <b>%x</b> -- The file extension of the path.  An empty string if there
-    #   is no extension.
-    # * <b>%X</b> -- Everything *but* the file extension.
-    # * <b>%s</b> -- The alternate file separator if defined, otherwise use
-    #   the standard file separator.
-    # * <b>%%</b> -- A percent sign.
-    #
-    # The %d specifier can also have a numeric prefix (e.g. '%2d'). If the
-    # number is positive, only return (up to) +n+ directories in the path,
-    # starting from the left hand side.  If +n+ is negative, return (up to)
-    # |+n+| directories from the right hand side of the path.
+    # <tt>%p</tt> :: The complete path.
+    # <tt>%f</tt> :: The base file name of the path, with its file extension,
+    #                but without any directories.
+    # <tt>%n</tt> :: The file name of the path without its file extension.
+    # <tt>%d</tt> :: The directory list of the path.
+    # <tt>%x</tt> :: The file extension of the path.  An empty string if there
+    #                is no extension.
+    # <tt>%X</tt> :: Everything *but* the file extension.
+    # <tt>%s</tt> :: The alternate file separator if defined, otherwise use #
+    #                the standard file separator.
+    # <tt>%%</tt> :: A percent sign.
+    #
+    # The <tt>%d</tt> specifier can also have a numeric prefix (e.g. '%2d').
+    # If the number is positive, only return (up to) +n+ directories in the
+    # path, starting from the left hand side.  If +n+ is negative, return (up
+    # to) +n+ directories from the right hand side of the path.
     #
     # Examples:
     #
     #   'a/b/c/d/file.txt'.pathmap("%2d")   => 'a/b'
     #   'a/b/c/d/file.txt'.pathmap("%-2d")  => 'c/d'
     #
-    # Also the %d, %p, %f, %n, %x, and %X operators can take a
-    # pattern/replacement argument to perform simple string substitutions on a
-    # particular part of the path.  The pattern and replacement are separated
-    # by a comma and are enclosed by curly braces.  The replacement spec comes
-    # after the % character but before the operator letter.  (e.g.
-    # "%{old,new}d").  Multiple replacement specs should be separated by
-    # semi-colons (e.g. "%{old,new;src,bin}d").
+    # Also the <tt>%d</tt>, <tt>%p</tt>, <tt>%f</tt>, <tt>%n</tt>,
+    # <tt>%x</tt>, and <tt>%X</tt> operators can take a pattern/replacement
+    # argument to perform simple string substitutions on a particular part of
+    # the path.  The pattern and replacement are separated by a comma and are
+    # enclosed by curly braces.  The replacement spec comes after the %
+    # character but before the operator letter.  (e.g. "%{old,new}d").
+    # Multiple replacement specs should be separated by semi-colons (e.g.
+    # "%{old,new;src,bin}d").
     #
     # Regular expressions may be used for the pattern, and back refs may be
     # used in the replacement text.  Curly braces, commas and semi-colons are
@@ -106,11 +112,11 @@ class String
     #
     # For example:
     #
-    #    "src/org/onestepback/proj/A.java".pathmap("%{^src,bin}X.class")
+    #    "src/org/onestepback/proj/A.java".pathmap("%{^src,class}X.class")
     #
     # returns:
     #
-    #    "bin/org/onestepback/proj/A.class"
+    #    "class/org/onestepback/proj/A.class"
     #
     # If the replacement text is '*', then a block may be provided to perform
     # some arbitrary calculation for the replacement.
@@ -125,6 +131,7 @@ class String
     #
     #  "/path/to/file.txt"
     #
+    # This String extension comes from Rake
     def pathmap(spec=nil, &block)
       return self if spec.nil?
       result = ''

data/lib/rake/ext/time.rb

@@ -3,7 +3,7 @@
 
 require 'rake/early_time'
 
-class Time
+class Time # :nodoc: all
   alias rake_original_time_compare :<=>
   def <=>(other)
     if Rake::EarlyTime === other

data/lib/rake/file_list.rb

@@ -2,10 +2,10 @@ require 'rake/cloneable'
 require 'rake/file_utils_ext'
 require 'rake/pathmap'
 
-######################################################################
+
 module Rake
 
-  # #########################################################################
+  ##
   # A FileList is essentially an array with a few helper methods defined to
   # make file manipulation a bit easier.
   #
@@ -156,7 +156,6 @@ module Rake
       self
     end
 
-
     # Clear all the exclude patterns so that we exclude nothing.
     def clear_exclude
       @exclude_patterns = []
@@ -164,7 +163,7 @@ module Rake
       self
     end
 
-    # Define equality.
+    # A FileList is equal through array equality.
     def ==(array)
       to_ary == array
     end
@@ -208,7 +207,7 @@ module Rake
       self
     end
 
-    def resolve_add(fn)
+    def resolve_add(fn) # :nodoc:
       case fn
       when %r{[*?\[\{]}
         add_matching(fn)
@@ -218,7 +217,7 @@ module Rake
     end
     private :resolve_add
 
-    def resolve_exclude
+    def resolve_exclude # :nodoc:
       reject! { |fn| excluded_from_list?(fn) }
       self
     end
@@ -276,7 +275,6 @@ module Rake
       collect { |fn| fn.ext(newext) }
     end
 
-
     # Grep each of the files in the filelist using the given pattern. If a
     # block is given, call the block on each matching line, passing the file
     # name, line number, and the matching line of text.  If no block is given,
@@ -377,7 +375,7 @@ module Rake
       proc { |fn| fn =~ /(^|[\/\\])core$/ && ! File.directory?(fn) }
     ]
 
-    def import(array)
+    def import(array) # :nodoc:
       @items = array
       self
     end
@@ -391,7 +389,7 @@ module Rake
       end
 
       # Get a sorted list of files matching the pattern. This method
-      # should be prefered to Dir[pattern] and Dir.glob(pattern) because
+      # should be preferred to Dir[pattern] and Dir.glob(pattern) because
       # the files returned are guaranteed to be sorted.
       def glob(pattern, *args)
         Dir.glob(pattern, *args).sort

data/lib/rake/file_task.rb

@@ -2,7 +2,7 @@ require 'rake/task.rb'
 require 'rake/early_time'
 
 module Rake
-  # #########################################################################
+
   # A FileTask is a task that includes time based dependencies.  If any of a
   # FileTask's prerequisites have a timestamp that is later than the file
   # represented by this task, then the file must be rebuilt (using the

data/lib/rake/gempackagetask.rb

@@ -1,2 +1,4 @@
+# TODO: Remove in Rake 11
+
 fail "ERROR: 'rake/gempackagetask' is obsolete and no longer supported. " +
-  "Use 'rubygems/packagetask' instead."
+  "Use 'rubygems/package_task' instead."

data/lib/rake/invocation_chain.rb

@@ -1,6 +1,5 @@
 module Rake
 
-  ####################################################################
   # InvocationChain tracks the chain of task invocations to detect
   # circular dependencies.
   class InvocationChain < LinkedList

data/lib/rake/linked_list.rb

@@ -80,7 +80,7 @@ module Rake
     #
     # When inheriting from the LinkedList class, you should implement
     # a type specific Empty class as well. Make sure you set the class
-    # instance variable @parent to the assocated list class (this
+    # instance variable @parent to the associated list class (this
     # allows conj, cons and make to work polymorphically).
     class EmptyLinkedList < LinkedList
       @parent = LinkedList

data/lib/rake/packagetask.rb

@@ -11,27 +11,27 @@ module Rake
   #
   # The PackageTask will create the following targets:
   #
-  # [<b>:package</b>]
+  # +:package+ ::
   #   Create all the requested package files.
   #
-  # [<b>:clobber_package</b>]
+  # +:clobber_package+ ::
   #   Delete all the package files.  This target is automatically
   #   added to the main clobber target.
   #
-  # [<b>:repackage</b>]
+  # +:repackage+ ::
   #   Rebuild the package files from scratch, even if they are not out
   #   of date.
   #
-  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tgz"</b>]
+  # <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tgz"</tt> ::
   #   Create a gzipped tar package (if <em>need_tar</em> is true).
   #
-  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.gz"</b>]
+  # <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.gz"</tt> ::
   #   Create a gzipped tar package (if <em>need_tar_gz</em> is true).
   #
-  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.bz2"</b>]
+  # <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.bz2"</tt> ::
   #   Create a bzip2'd tar package (if <em>need_tar_bz2</em> is true).
   #
-  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.zip"</b>]
+  # <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.zip"</tt> ::
   #   Create a zip package archive (if <em>need_zip</em> is true).
   #
   # Example:
@@ -162,26 +162,38 @@ module Rake
       self
     end
 
+    # The name of this package
+
     def package_name
       @version ? "#{@name}-#{@version}" : @name
     end
 
+    # The directory this package will be built in
+
     def package_dir_path
       "#{package_dir}/#{package_name}"
     end
 
+    # The package name with .tgz added
+
     def tgz_file
       "#{package_name}.tgz"
     end
 
+    # The package name with .tar.gz added
+
     def tar_gz_file
       "#{package_name}.tar.gz"
     end
 
+    # The package name with .tar.bz2 added
+
     def tar_bz2_file
       "#{package_name}.tar.bz2"
     end
 
+    # The package name with .zip added
+
     def zip_file
       "#{package_name}.zip"
     end

data/lib/rake/pathmap.rb

@@ -1 +1,3 @@
+# TODO: Remove in Rake 11
+
 require 'rake/ext/string'

data/lib/rake/pseudo_status.rb

@@ -1,8 +1,8 @@
 module Rake
 
-  ####################################################################
+  ##
   # Exit status class for times the system just gives us a nil.
-  class PseudoStatus
+  class PseudoStatus # :nodoc: all
     attr_reader :exitstatus
 
     def initialize(code=0)

data/lib/rake/rake_module.rb

@@ -2,8 +2,6 @@ require 'rake/application'
 
 module Rake
 
-  # Rake module singleton methods.
-  #
   class << self
     # Current Rake Application
     def application
@@ -15,6 +13,11 @@ module Rake
       @application = app
     end
 
+    def suggested_thread_count # :nodoc:
+      @cpu_count ||= Rake::CpuCounter.count
+      @cpu_count + 4
+    end
+
     # Return the original directory where the Rake application was started.
     def original_dir
       application.original_dir
@@ -28,9 +31,7 @@ module Rake
     # Add files to the rakelib list
     def add_rakelib(*files)
       application.options.rakelib ||= []
-      files.each do |file|
-        application.options.rakelib << file
-      end
+      application.options.rakelib.concat(files)
     end
   end
 

data/lib/rake/rdoctask.rb

@@ -1,2 +1,4 @@
+# TODO: Remove in Rake 11
+
 fail "ERROR: 'rake/rdoctask' is obsolete and no longer supported. " +
   "Use 'rdoc/task' (available in RDoc 2.4.2+) instead."

data/lib/rake/ruby182_test_unit_fix.rb

@@ -1,3 +1,5 @@
+# TODO: Remove in rake 11
+
 # Local Rake override to fix bug in Ruby 0.8.2
 module Test                     # :nodoc:
   # Local Rake override to fix bug in Ruby 0.8.2

data/lib/rake/runtest.rb

@@ -5,7 +5,12 @@ require 'rake/file_list'
 module Rake
   include Test::Unit::Assertions
 
-  def run_tests(pattern='test/test*.rb', log_enabled=false)
+  ##
+  # Deprecated way of running tests in process, but only for Test::Unit.
+  #--
+  # TODO: Remove in rake 11
+
+  def run_tests(pattern='test/test*.rb', log_enabled=false) # :nodoc:
     FileList.glob(pattern).each do |fn|
       $stderr.puts fn if log_enabled
       begin

data/lib/rake/scope.rb

@@ -1,5 +1,5 @@
 module Rake
-  class Scope < LinkedList
+  class Scope < LinkedList # :nodoc: all
 
     # Path for the scope.
     def path

data/lib/rake/task.rb

@@ -2,7 +2,7 @@ require 'rake/invocation_exception_mixin'
 
 module Rake
 
-  # #########################################################################
+  ##
   # A Task is the basic unit of work in a Rakefile.  Tasks have associated
   # actions (possibly more than one) and a list of prerequisites.  When
   # invoked, a task will first ensure that all of its prerequisites have an
@@ -34,14 +34,18 @@ module Rake
       name
     end
 
-    def inspect
+    def inspect # :nodoc:
       "<#{self.class} #{name} => [#{prerequisites.join(', ')}]>"
     end
 
     # List of sources for task.
     attr_writer :sources
     def sources
-      @sources ||= []
+      if defined?(@sources)
+        @sources
+      else
+        prerequisites
+      end
     end
 
     # List of prerequisite tasks
@@ -49,7 +53,7 @@ module Rake
       prerequisites.map { |pre| lookup_prerequisite(pre) }
     end
 
-    def lookup_prerequisite(prerequisite_name)
+    def lookup_prerequisite(prerequisite_name) # :nodoc:
       application[prerequisite_name, @scope]
     end
     private :lookup_prerequisite
@@ -63,7 +67,7 @@ module Rake
       seen.values
     end
 
-    def collect_prerequisites(seen)
+    def collect_prerequisites(seen) # :nodoc:
       prerequisite_tasks.each do |pre|
         next if seen[pre.name]
         seen[pre.name] = pre
@@ -74,7 +78,7 @@ module Rake
 
     # First source from a rule (nil if no sources)
     def source
-      @sources.first if defined?(@sources)
+      sources.first
     end
 
     # Create a task named +task_name+ with no actions or prerequisites. Use
@@ -180,7 +184,7 @@ module Rake
     end
     protected :invoke_with_call_chain
 
-    def add_chain_to(exception, new_chain)
+    def add_chain_to(exception, new_chain) # :nodoc:
       exception.extend(InvocationExceptionMixin) unless
         exception.respond_to?(:chain)
       exception.chain = new_chain if exception.chain.nil?
@@ -257,11 +261,12 @@ module Rake
       add_comment(comment) if comment && ! comment.empty?
     end
 
-    def comment=(comment)
+    def comment=(comment) # :nodoc:
       add_comment(comment)
     end
 
-    def add_comment(comment)
+    def add_comment(comment) # :nodoc:
+      return if comment.nil?
       @comments << comment unless @comments.include?(comment)
     end
     private :add_comment