rake 0.9.2.2 → 13.0.6

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.
@@ -117,12 +146,15 @@ module Rake
     # is invoked again.
     def reenable
       @already_invoked = false
+      @invocation_exception = nil
     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
 
@@ -138,6 +170,18 @@ module Rake
       self
     end
 
+    # Clear the existing comments on a rake task.
+    def clear_comments
+      @comments = []
+      self
+    end
+
+    # Clear the existing arguments on a rake task.
+    def clear_args
+      @arg_names = nil
+      self
+    end
+
     # Invoke the task if it is needed.  Prerequisites are invoked first.
     def invoke(*args)
       task_args = TaskArguments.new(arg_names, args)
@@ -146,35 +190,71 @@ 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
-          $stderr.puts "** 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
 
     # Invoke all the prerequisites of a task.
     def invoke_prerequisites(task_args, invocation_chain) # :nodoc:
-      prerequisite_tasks.each { |prereq|
-        prereq_args = task_args.new_scope(prereq.arg_names)
-        prereq.invoke_with_call_chain(prereq_args, invocation_chain)
-      }
+      if application.options.always_multitask
+        invoke_prerequisites_concurrently(task_args, invocation_chain)
+      else
+        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(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|
+          r.invoke_with_call_chain(prereq_args, invocation_chain)
+        end
+      end
+      # Iterate in reverse to improve performance related to thread waiting and switching
+      futures.reverse_each(&:value)
     end
 
     # Format the trace flags for display.
@@ -190,20 +270,15 @@ module Rake
     def execute(args=nil)
       args ||= EMPTY_TASK_ARGS
       if application.options.dryrun
-        $stderr.puts "** Execute (dry run) #{name}"
+        application.trace "** Execute (dry run) #{name}"
         return
       end
-      if application.options.trace
-        $stderr.puts "** 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
 
@@ -215,65 +290,97 @@ module Rake
     # Timestamp for this task.  Basic tasks return the current time for their
     # time stamp.  Other tasks can be more sophisticated.
     def timestamp
-      prerequisite_tasks.collect { |pre| pre.timestamp }.max || Time.now
+      Time.now
     end
 
     # 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
     #
@@ -319,7 +426,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

data/lib/rake/task_argument_error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Rake
 
   # Error indicating an ill-formed task declaration.

data/lib/rake/task_arguments.rb

@@ -1,30 +1,43 @@
+# frozen_string_literal: true
 module Rake
 
-  ####################################################################
+  ##
   # TaskArguments manage the arguments passed to a task.
   #
   class TaskArguments
     include Enumerable
 
+    # Argument names
     attr_reader :names
 
-    # Create a TaskArgument object with a list of named arguments
-    # (given by :names) and a set of associated values (given by
-    # :values).  :parent is the parent argument object.
+    # Create a TaskArgument object with a list of argument +names+ and a set
+    # of associated +values+.  +parent+ is the parent argument object.
     def initialize(names, values, parent=nil)
       @names = names
       @parent = parent
       @hash = {}
+      @values = values
       names.each_with_index { |name, i|
-        @hash[name.to_sym] = values[i] unless values[i].nil?
+        next if values[i].nil? || values[i] == ""
+        @hash[name.to_sym] = values[i]
       }
     end
 
+    # Retrieve the complete array of sequential values
+    def to_a
+      @values.dup
+    end
+
+    # Retrieve the list of values not associated with named arguments
+    def extras
+      @values[@names.length..-1] || []
+    end
+
     # Create a new argument scope using the prerequisite argument
     # names.
     def new_scope(names)
-      values = names.collect { |n| self[n] }
-      self.class.new(names, values, self)
+      values = names.map { |n| self[n] }
+      self.class.new(names, values + extras, self)
     end
 
     # Find an argument value by name or index.
@@ -39,33 +52,51 @@ module Rake
       @hash = defaults.merge(@hash)
     end
 
+    # Enumerates the arguments and their values
     def each(&block)
       @hash.each(&block)
     end
 
+    # Extracts the argument values at +keys+
     def values_at(*keys)
       keys.map { |k| lookup(k) }
     end
 
-    def method_missing(sym, *args, &block)
+    # Returns the value of the given argument via method_missing
+    def method_missing(sym, *args)
       lookup(sym.to_sym)
     end
 
+    # Returns a Hash of arguments and their values
     def to_hash
-      @hash
+      @hash.dup
+    end
+
+    def to_s # :nodoc:
+      inspect
+    end
+
+    def inspect # :nodoc:
+      inspection = @hash.map do |k,v|
+        "#{k.to_s}: #{v.to_s}"
+      end.join(", ")
+
+      "#<#{self.class} #{inspection}>"
     end
 
-    def to_s
-      @hash.inspect
+    # Returns true if +key+ is one of the arguments
+    def has_key?(key)
+      @hash.has_key?(key)
     end
+    alias key? has_key?
 
-    def inspect
-      to_s
+    def fetch(*args, &block)
+      @hash.fetch(*args, &block)
     end
 
     protected
 
-    def lookup(name)
+    def lookup(name) # :nodoc:
       if @hash.has_key?(name)
         @hash[name]
       elsif @parent
@@ -74,5 +105,5 @@ module Rake
     end
   end
 
-  EMPTY_TASK_ARGS = TaskArguments.new([], [])
+  EMPTY_TASK_ARGS = TaskArguments.new([], []) # :nodoc:
 end