rake 10.0.0.beta.2 → 13.0.0.pre.1

data/lib/rake/pseudo_status.rb

@@ -1,21 +1,27 @@
+# frozen_string_literal: true
 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)
       @exitstatus = code
     end
+
     def to_i
       @exitstatus << 8
     end
+
     def >>(n)
       to_i >> n
     end
+
     def stopped?
       false
     end
+
     def exited?
       true
     end

data/lib/rake/rake_module.rb

@@ -1,9 +1,8 @@
-require 'rake/application'
+# frozen_string_literal: true
+require "rake/application"
 
 module Rake
 
-  # Rake module singleton methods.
-  #
   class << self
     # Current Rake Application
     def application
@@ -15,6 +14,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,16 +32,35 @@ 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
 
-    # Get a sorted list of files matching the pattern. This method
-    # should be prefered 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
+    # Make +block_application+ the default rake application inside a block so
+    # you can load rakefiles into a different application.
+    #
+    # This is useful when you want to run rake tasks inside a library without
+    # running rake in a sub-shell.
+    #
+    # Example:
+    #
+    #   Dir.chdir 'other/directory'
+    #
+    #   other_rake = Rake.with_application do |rake|
+    #     rake.load_rakefile
+    #   end
+    #
+    #   puts other_rake.tasks
+
+    def with_application(block_application = Rake::Application.new)
+      orig_application = Rake.application
+
+      Rake.application = block_application
+
+      yield block_application
+
+      block_application
+    ensure
+      Rake.application = orig_application
     end
   end
 

data/lib/rake/rake_test_loader.rb

@@ -1,22 +1,27 @@
-require 'rake'
+# frozen_string_literal: true
+require "rake"
 
 # Load the test files from the command line.
 argv = ARGV.select do |argument|
-  case argument
-  when /^-/ then
-    argument
-  when /\*/ then
-    FileList[argument].to_a.each do |file|
-      require File.expand_path file
-    end
+  begin
+    case argument
+    when /^-/ then
+      argument
+    when /\*/ then
+      FileList[argument].to_a.each do |file|
+        require File.expand_path file
+      end
 
-    false
-  else
-    require File.expand_path argument
+      false
+    else
+      require File.expand_path argument
 
-    false
+      false
+    end
+  rescue LoadError => e
+    raise unless e.path
+    abort "\nFile does not exist: #{e.path}\n\n"
   end
 end
 
 ARGV.replace argv
-

data/lib/rake/rule_recursion_overflow_error.rb

@@ -1,4 +1,4 @@
-
+# frozen_string_literal: true
 module Rake
 
   # Error indicating a recursion overflow error in task selection.
@@ -13,7 +13,7 @@ module Rake
     end
 
     def message
-      super + ": [" + @targets.reverse.join(' => ') + "]"
+      super + ": [" + @targets.reverse.join(" => ") + "]"
     end
   end
 

data/lib/rake/scope.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module Rake
+  class Scope < LinkedList # :nodoc: all
+
+    # Path for the scope.
+    def path
+      map(&:to_s).reverse.join(":")
+    end
+
+    # Path for the scope + the named path.
+    def path_with_task_name(task_name)
+      "#{path}:#{task_name}"
+    end
+
+    # Trim +n+ innermost scope levels from the scope. In no case will
+    # this trim beyond the toplevel scope.
+    def trim(n)
+      result = self
+      while n > 0 && !result.empty?
+        result = result.tail
+        n -= 1
+      end
+      result
+    end
+
+    # Scope lists always end with an EmptyScope object. See Null
+    # Object Pattern)
+    class EmptyScope < EmptyLinkedList
+      @parent = Scope
+
+      def path
+        ""
+      end
+
+      def path_with_task_name(task_name)
+        task_name
+      end
+    end
+
+    # Singleton null object for an empty scope.
+    EMPTY = EmptyScope.new
+  end
+end

data/lib/rake/task.rb

@@ -1,8 +1,9 @@
-require 'rake/invocation_exception_mixin'
+# frozen_string_literal: true
+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
@@ -14,6 +15,10 @@ module Rake
   class Task
     # List of prerequisites for a task.
     attr_reader :prerequisites
+    alias prereqs prerequisites
+
+    # List of order only prerequisites for a task.
+    attr_reader :order_only_prerequisites
 
     # List of actions attached to a task.
     attr_reader :actions
@@ -21,13 +26,6 @@ module Rake
     # Application owning this task.
     attr_accessor :application
 
-    # Comment for this task.  Restricted to a single line of no more than 50
-    # characters.
-    attr_reader :comment
-
-    # Full text of the (possibly multi-line) comment.
-    attr_reader :full_comment
-
     # Array of nested namespaces names used for task lookup by this task.
     attr_reader :scope
 
@@ -36,50 +34,81 @@ module Rake
     # location option set).
     attr_reader :locations
 
+    # Has this task already been invoked?  Already invoked tasks
+    # will be skipped unless you reenable them.
+    attr_reader :already_invoked
+
     # Return task name
     def to_s
       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
     def prerequisite_tasks
-      prerequisites.collect { |pre| lookup_prerequisite(pre) }
+      (prerequisites + order_only_prerequisites).map { |pre| lookup_prerequisite(pre) }
     end
 
-    def lookup_prerequisite(prerequisite_name)
-      application[prerequisite_name, @scope]
+    def lookup_prerequisite(prerequisite_name) # :nodoc:
+      scoped_prerequisite_task = application[prerequisite_name, @scope]
+      if scoped_prerequisite_task == self
+        unscoped_prerequisite_task = application[prerequisite_name]
+      end
+      unscoped_prerequisite_task || scoped_prerequisite_task
     end
     private :lookup_prerequisite
 
+    # List of all unique prerequisite tasks including prerequisite tasks'
+    # prerequisites.
+    # Includes self when cyclic dependencies are found.
+    def all_prerequisite_tasks
+      seen = {}
+      collect_prerequisites(seen)
+      seen.values
+    end
+
+    def collect_prerequisites(seen) # :nodoc:
+      prerequisite_tasks.each do |pre|
+        next if seen[pre.name]
+        seen[pre.name] = pre
+        pre.collect_prerequisites(seen)
+      end
+    end
+    protected :collect_prerequisites
+
     # 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
     # +enhance+ to add actions and prerequisites.
     def initialize(task_name, app)
-      @name = task_name.to_s
-      @prerequisites = []
-      @actions = []
+      @name            = task_name.to_s
+      @prerequisites   = []
+      @actions         = []
       @already_invoked = false
-      @full_comment = nil
-      @comment = nil
-      @lock = Monitor.new
-      @application = app
-      @scope = app.current_scope
-      @arg_names = nil
-      @locations = []
+      @comments        = []
+      @lock            = Monitor.new
+      @application     = app
+      @scope           = app.current_scope
+      @arg_names       = nil
+      @locations       = []
+      @invocation_exception = nil
+      @order_only_prerequisites = []
     end
 
     # Enhance a task with prerequisites or actions.  Returns self.
@@ -105,7 +134,7 @@ module Rake
 
     # Argument description (nil if none).
     def arg_description # :nodoc:
-      @arg_names ? "[#{(arg_names || []).join(',')}]" : nil
+      @arg_names ? "[#{arg_names.join(',')}]" : nil
     end
 
     # Name of arguments for this task.
@@ -119,11 +148,12 @@ module Rake
       @already_invoked = false
     end
 
-    # Clear the existing prerequisites and actions of a rake task.
+    # Clear the existing prerequisites, actions, comments, and arguments of a rake task.
     def clear
       clear_prerequisites
       clear_actions
       clear_comments
+      clear_args
       self
     end
 
@@ -141,8 +171,13 @@ module Rake
 
     # Clear the existing comments on a rake task.
     def clear_comments
-      @full_comment = nil
-      @comment = nil
+      @comments = []
+      self
+    end
+
+    # Clear the existing arguments on a rake task.
+    def clear_args
+      @arg_names = nil
       self
     end
 
@@ -154,25 +189,45 @@ module Rake
 
     # Same as invoke, but explicitly pass a call chain to detect
     # circular dependencies.
-    def invoke_with_call_chain(task_args, invocation_chain) # :nodoc:
-      new_chain = InvocationChain.append(self, invocation_chain)
+    #
+    # If multiple tasks depend on this
+    # one in parallel, they will all fail if the first execution of
+    # this task fails.
+    def invoke_with_call_chain(task_args, invocation_chain)
+      new_chain = Rake::InvocationChain.append(self, invocation_chain)
       @lock.synchronize do
-        if application.options.trace
-          application.trace "** Invoke #{name} #{format_trace_flags}"
+        begin
+          if application.options.trace
+            application.trace "** Invoke #{name} #{format_trace_flags}"
+          end
+
+          if @already_invoked
+            if @invocation_exception
+              if application.options.trace
+                application.trace "** Previous invocation of #{name} failed #{format_trace_flags}"
+              end
+              raise @invocation_exception
+            else
+              return
+            end
+          end
+
+          @already_invoked = true
+
+          invoke_prerequisites(task_args, new_chain)
+          execute(task_args) if needed?
+        rescue Exception => ex
+          add_chain_to(ex, new_chain)
+          @invocation_exception = ex
+          raise ex
         end
-        return if @already_invoked
-        @already_invoked = true
-        invoke_prerequisites(task_args, new_chain)
-        execute(task_args) if needed?
       end
-    rescue Exception => ex
-      add_chain_to(ex, new_chain)
-      raise ex
     end
     protected :invoke_with_call_chain
 
-    def add_chain_to(exception, new_chain)
-      exception.extend(InvocationExceptionMixin) unless exception.respond_to?(: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?
     end
     private :add_chain_to
@@ -182,21 +237,23 @@ module Rake
       if application.options.always_multitask
         invoke_prerequisites_concurrently(task_args, invocation_chain)
       else
-        prerequisite_tasks.each { |prereq|
-          prereq_args = task_args.new_scope(prereq.arg_names)
-          prereq.invoke_with_call_chain(prereq_args, invocation_chain)
+        prerequisite_tasks.each { |p|
+          prereq_args = task_args.new_scope(p.arg_names)
+          p.invoke_with_call_chain(prereq_args, invocation_chain)
         }
       end
     end
 
     # Invoke all the prerequisites of a task in parallel.
-    def invoke_prerequisites_concurrently(args, invocation_chain) # :nodoc:
-      futures = @prerequisites.collect do |p|
+    def invoke_prerequisites_concurrently(task_args, invocation_chain)# :nodoc:
+      futures = prerequisite_tasks.map do |p|
+        prereq_args = task_args.new_scope(p.arg_names)
         application.thread_pool.future(p) do |r|
-          application[r, @scope].invoke_with_call_chain(args, invocation_chain)
+          r.invoke_with_call_chain(prereq_args, invocation_chain)
         end
       end
-      futures.each { |f| f.call }
+      # Iterate in reverse to improve performance related to thread waiting and switching
+      futures.reverse_each(&:value)
     end
 
     # Format the trace flags for display.
@@ -215,17 +272,12 @@ module Rake
         application.trace "** Execute (dry run) #{name}"
         return
       end
-      if application.options.trace
-        application.trace "** Execute #{name}"
-      end
+      application.trace "** Execute #{name}" if application.options.trace
       application.enhance_with_matching_rule(name) if @actions.empty?
-      @actions.each do |act|
-        case act.arity
-        when 1
-          act.call(self)
-        else
-          act.call(self, args)
-        end
+      if opts = Hash.try_convert(args) and !opts.empty?
+        @actions.each { |act| act.call(self, args, **opts)}
+      else
+        @actions.each { |act| act.call(self, args)}
       end
     end
 
@@ -243,59 +295,91 @@ module Rake
     # Add a description to the task.  The description can consist of an option
     # argument list (enclosed brackets) and an optional comment.
     def add_description(description)
-      return if ! description
+      return unless description
       comment = description.strip
-      add_comment(comment) if comment && ! comment.empty?
+      add_comment(comment) if comment && !comment.empty?
     end
 
-    # Writing to the comment attribute is the same as adding a description.
-    def comment=(description)
-      add_description(description)
+    def comment=(comment) # :nodoc:
+      add_comment(comment)
     end
 
-    # Add a comment to the task.  If a comment already exists, separate
-    # the new comment with " / ".
-    def add_comment(comment)
-      if @full_comment
-        @full_comment << " / "
-      else
-        @full_comment = ''
-      end
-      @full_comment << comment
-      if @full_comment =~ /\A([^.]+?\.)( |$)/
-        @comment = $1
+    def add_comment(comment) # :nodoc:
+      return if comment.nil?
+      @comments << comment unless @comments.include?(comment)
+    end
+    private :add_comment
+
+    # Full collection of comments. Multiple comments are separated by
+    # newlines.
+    def full_comment
+      transform_comments("\n")
+    end
+
+    # First line (or sentence) of all comments. Multiple comments are
+    # separated by a "/".
+    def comment
+      transform_comments(" / ") { |c| first_sentence(c) }
+    end
+
+    # Transform the list of comments as specified by the block and
+    # join with the separator.
+    def transform_comments(separator, &block)
+      if @comments.empty?
+        nil
       else
-        @comment = @full_comment
+        block ||= lambda { |c| c }
+        @comments.map(&block).join(separator)
       end
     end
-    private :add_comment
+    private :transform_comments
+
+    # Get the first sentence in a string. The sentence is terminated
+    # by the first period, exclamation mark, or the end of the line.
+    # Decimal points do not count as periods.
+    def first_sentence(string)
+      string.split(/(?<=\w)(\.|!)[ \t]|(\.$|!)|\n/).first
+    end
+    private :first_sentence
 
     # Set the names of the arguments for this task. +args+ should be
     # an array of symbols, one for each argument name.
     def set_arg_names(args)
-      @arg_names = args.map { |a| a.to_sym }
+      @arg_names = args.map(&:to_sym)
     end
 
     # Return a string describing the internal state of a task.  Useful for
     # debugging.
     def investigation
-      result = "------------------------------\n"
+      result = "------------------------------\n".dup
       result << "Investigating #{name}\n"
       result << "class: #{self.class}\n"
       result <<  "task needed: #{needed?}\n"
       result <<  "timestamp: #{timestamp}\n"
       result << "pre-requisites: \n"
       prereqs = prerequisite_tasks
-      prereqs.sort! {|a,b| a.timestamp <=> b.timestamp}
+      prereqs.sort! { |a, b| a.timestamp <=> b.timestamp }
       prereqs.each do |p|
         result << "--#{p.name} (#{p.timestamp})\n"
       end
-      latest_prereq = prerequisite_tasks.collect { |pre| pre.timestamp }.max
+      latest_prereq = prerequisite_tasks.map(&:timestamp).max
       result <<  "latest-prerequisite time: #{latest_prereq}\n"
       result << "................................\n\n"
       return result
     end
 
+    # Format dependencies parameter to pass to task.
+    def self.format_deps(deps)
+      deps = [deps] unless deps.respond_to?(:to_ary)
+      deps.map { |d| Rake.from_pathname(d).to_s }
+    end
+
+    # Add order only dependencies.
+    def |(deps)
+      @order_only_prerequisites |= Task.format_deps(deps) - @prerequisites
+      self
+    end
+
     # ----------------------------------------------------------------
     # Rake Module Methods
     #
@@ -341,7 +425,7 @@ module Rake
       # this kind of task.  Generic tasks will accept the scope as
       # part of the name.
       def scope_name(scope, task_name)
-        (scope + [task_name]).join(':')
+        scope.path_with_task_name(task_name)
       end
 
     end # class << Rake::Task