rake 11.3.0 → 13.0.1

data/lib/rake/task.rb

@@ -1,4 +1,5 @@
-require 'rake/invocation_exception_mixin'
+# frozen_string_literal: true
+require "rake/invocation_exception_mixin"
 
 module Rake
 
@@ -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
@@ -54,7 +59,7 @@ module Rake
 
     # List of prerequisite tasks
     def prerequisite_tasks
-      prerequisites.map { |pre| lookup_prerequisite(pre) }
+      (prerequisites + order_only_prerequisites).map { |pre| lookup_prerequisite(pre) }
     end
 
     def lookup_prerequisite(prerequisite_name) # :nodoc:
@@ -102,6 +107,8 @@ module Rake
       @scope           = app.current_scope
       @arg_names       = nil
       @locations       = []
+      @invocation_exception = nil
+      @order_only_prerequisites = []
     end
 
     # Enhance a task with prerequisites or actions.  Returns self.
@@ -139,13 +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
 
@@ -167,6 +176,12 @@ module Rake
       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)
@@ -175,20 +190,39 @@ 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
 
@@ -219,7 +253,8 @@ module Rake
           r.invoke_with_call_chain(prereq_args, invocation_chain)
         end
       end
-      futures.each { |f| f.value }
+      # Iterate in reverse to improve performance related to thread waiting and switching
+      futures.reverse_each(&:value)
     end
 
     # Format the trace flags for display.
@@ -240,13 +275,10 @@ module Rake
       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
 
@@ -266,7 +298,7 @@ module Rake
     def add_description(description)
       return unless description
       comment = description.strip
-      add_comment(comment) if comment && ! comment.empty?
+      add_comment(comment) if comment && !comment.empty?
     end
 
     def comment=(comment) # :nodoc:
@@ -314,13 +346,13 @@ module Rake
     # 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"
@@ -331,12 +363,24 @@ module Rake
       prereqs.each do |p|
         result << "--#{p.name} (#{p.timestamp})\n"
       end
-      latest_prereq = prerequisite_tasks.map { |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
     #
@@ -382,7 +426,6 @@ 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
 

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,3 +1,4 @@
+# frozen_string_literal: true
 module Rake
 
   ##
@@ -17,7 +18,7 @@ module Rake
       @hash = {}
       @values = values
       names.each_with_index { |name, i|
-        next if values[i].nil? || values[i] == ''
+        next if values[i].nil? || values[i] == ""
         @hash[name.to_sym] = values[i]
       }
     end
@@ -68,21 +69,26 @@ module Rake
 
     # Returns a Hash of arguments and their values
     def to_hash
-      @hash
+      @hash.dup
     end
 
     def to_s # :nodoc:
-      @hash.inspect
+      inspect
     end
 
     def inspect # :nodoc:
-      to_s
+      inspection = @hash.map do |k,v|
+        "#{k.to_s}: #{v.to_s}"
+      end.join(", ")
+
+      "#<#{self.class} #{inspection}>"
     end
 
     # Returns true if +key+ is one of the arguments
     def has_key?(key)
       @hash.has_key?(key)
     end
+    alias key? has_key?
 
     def fetch(*args, &block)
       @hash.fetch(*args, &block)

data/lib/rake/task_manager.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Rake
 
   # The TaskManager module is a mixin for managing tasks.
@@ -5,19 +6,6 @@ module Rake
     # Track the last comment made in the Rakefile.
     attr_accessor :last_description
 
-    # Remove Rake 12
-    def last_comment # :nodoc:
-      warn "[DEPRECATION] `last_comment` is deprecated.  Please use `last_description` instead."
-      @last_description
-    end
-
-    # Remove Rake 12
-    def last_comment=(comment) # :nodoc:
-      warn "[DEPRECATION] `last_comment=` is deprecated.  Please use `last_description=` instead."
-      @last_description = comment
-      @last_description # ignore warning
-    end
-
     def initialize # :nodoc:
       super
       @tasks = Hash.new
@@ -27,31 +15,31 @@ module Rake
     end
 
     def create_rule(*args, &block) # :nodoc:
-      pattern, args, deps = resolve_args(args)
-      pattern = Regexp.new(Regexp.quote(pattern) + '$') if String === pattern
-      @rules << [pattern, args, deps, block]
+      pattern, args, deps, order_only = resolve_args(args)
+      pattern = Regexp.new(Regexp.quote(pattern) + "$") if String === pattern
+      @rules << [pattern, args, deps, order_only, block]
     end
 
     def define_task(task_class, *args, &block) # :nodoc:
-      task_name, arg_names, deps = resolve_args(args)
+      task_name, arg_names, deps, order_only = resolve_args(args)
 
       original_scope = @scope
       if String === task_name and
-         not task_class.ancestors.include? Rake::FileTask then
+         not task_class.ancestors.include? Rake::FileTask
         task_name, *definition_scope = *(task_name.split(":").reverse)
         @scope = Scope.make(*(definition_scope + @scope.to_a))
       end
 
       task_name = task_class.scope_name(@scope, task_name)
-      deps = [deps] unless deps.respond_to?(:to_ary)
-      deps = deps.map { |d| Rake.from_pathname(d).to_s }
       task = intern(task_class, task_name)
       task.set_arg_names(arg_names) unless arg_names.empty?
       if Rake::TaskManager.record_task_metadata
         add_location(task)
         task.add_description(get_description(task))
       end
-      task.enhance(deps, &block)
+      task.enhance(Task.format_deps(deps), &block)
+      task | order_only unless order_only.nil?
+      task
     ensure
       @scope = original_scope
     end
@@ -68,7 +56,26 @@ module Rake
       self.lookup(task_name, scopes) or
         enhance_with_matching_rule(task_name) or
         synthesize_file_task(task_name) or
-        fail "Don't know how to build task '#{task_name}' (see --tasks)"
+        fail generate_message_for_undefined_task(task_name)
+    end
+
+    def generate_message_for_undefined_task(task_name)
+      message = "Don't know how to build task '#{task_name}' "\
+                "(See the list of available tasks with `#{Rake.application.name} --tasks`)"
+      message + generate_did_you_mean_suggestions(task_name)
+    end
+
+    def generate_did_you_mean_suggestions(task_name)
+      return "" unless defined?(::DidYouMean::SpellChecker)
+
+      suggestions = ::DidYouMean::SpellChecker.new(dictionary: @tasks.keys).correct(task_name.to_s)
+      if ::DidYouMean.respond_to?(:formatter)# did_you_mean v1.2.0 or later
+        ::DidYouMean.formatter.message_for(suggestions)
+      elsif defined?(::DidYouMean::Formatter) # before did_you_mean v1.2.0
+        ::DidYouMean::Formatter.new(suggestions).to_s
+      else
+        ""
+      end
     end
 
     def synthesize_file_task(task_name) # :nodoc:
@@ -76,8 +83,8 @@ module Rake
       define_task(Rake::FileTask, task_name)
     end
 
-    # Resolve the arguments for a task/rule.  Returns a triplet of
-    # [task_name, arg_name_list, prerequisites].
+    # Resolve the arguments for a task/rule.  Returns a tuple of
+    # [task_name, arg_name_list, prerequisites, order_only_prerequisites].
     def resolve_args(args)
       if args.last.is_a?(Hash)
         deps = args.pop
@@ -102,7 +109,7 @@ module Rake
       else
         arg_names = args
       end
-      [task_name, arg_names, []]
+      [task_name, arg_names, [], nil]
     end
     private :resolve_args_without_dependencies
 
@@ -111,11 +118,17 @@ module Rake
     #
     # The patterns recognized by this argument resolving function are:
     #
+    #   task :t, order_only: [:e]
     #   task :t => [:d]
+    #   task :t => [:d], order_only: [:e]
     #   task :t, [a] => [:d]
+    #   task :t, [a] => [:d], order_only: [:e]
     #
     def resolve_args_with_dependencies(args, hash) # :nodoc:
-      fail "Task Argument Error" if hash.size != 1
+      fail "Task Argument Error" if
+        hash.size != 1 &&
+        (hash.size != 2 || !hash.key?(:order_only))
+      order_only = hash.delete(:order_only)
       key, value = hash.map { |k, v| [k, v] }.first
       if args.empty?
         task_name = key
@@ -123,11 +136,11 @@ module Rake
         deps = value || []
       else
         task_name = args.shift
-        arg_names = key
-        deps = value
+        arg_names = key || args.shift|| []
+        deps = value || []
       end
       deps = [deps] unless deps.respond_to?(:to_ary)
-      [task_name, arg_names, deps]
+      [task_name, arg_names, deps, order_only]
     end
     private :resolve_args_with_dependencies
 
@@ -138,9 +151,10 @@ module Rake
     def enhance_with_matching_rule(task_name, level=0)
       fail Rake::RuleRecursionOverflowError,
         "Rule Recursion Too Deep" if level >= 16
-      @rules.each do |pattern, args, extensions, block|
-        if pattern.match(task_name)
-          task = attempt_rule(task_name, args, extensions, block, level)
+      @rules.each do |pattern, args, extensions, order_only, block|
+        if pattern && pattern.match(task_name)
+          task = attempt_rule(task_name, pattern, args, extensions, block, level)
+          task | order_only unless order_only.nil?
           return task if task
         end
       end
@@ -180,10 +194,10 @@ module Rake
       task_name = task_name.to_s
       if task_name =~ /^rake:/
         scopes = Scope.make
-        task_name = task_name.sub(/^rake:/, '')
+        task_name = task_name.sub(/^rake:/, "")
       elsif task_name =~ /^(\^+)/
         scopes = initial_scope.trim($1.size)
-        task_name = task_name.sub(/^(\^+)/, '')
+        task_name = task_name.sub(/^(\^+)/, "")
       else
         scopes = initial_scope
       end
@@ -254,8 +268,8 @@ module Rake
     end
 
     # Attempt to create a rule given the list of prerequisites.
-    def attempt_rule(task_name, args, extensions, block, level)
-      sources = make_sources(task_name, extensions)
+    def attempt_rule(task_name, task_pattern, args, extensions, block, level)
+      sources = make_sources(task_name, task_pattern, extensions)
       prereqs = sources.map { |source|
         trace_rule level, "Attempting Rule #{task_name} => #{source}"
         if File.exist?(source) || Rake::Task.task_defined?(source)
@@ -269,14 +283,14 @@ module Rake
           return nil
         end
       }
-      task = FileTask.define_task(task_name, {args => prereqs}, &block)
+      task = FileTask.define_task(task_name, { args => prereqs }, &block)
       task.sources = prereqs
       task
     end
 
     # Make a list of sources from the list of file name extensions /
     # translation procs.
-    def make_sources(task_name, extensions)
+    def make_sources(task_name, task_pattern, extensions)
       result = extensions.map { |ext|
         case ext
         when /%/
@@ -284,7 +298,8 @@ module Rake
         when %r{/}
           ext
         when /^\./
-          task_name.ext(ext)
+          source = task_name.sub(task_pattern, ext)
+          source == ext ? task_name.ext(ext) : source
         when String
           ext
         when Proc, Method