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

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
 
+    # 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

data/lib/rake/task_manager.rb

@@ -1,37 +1,47 @@
+# frozen_string_literal: true
 module Rake
 
   # The TaskManager module is a mixin for managing tasks.
   module TaskManager
     # Track the last comment made in the Rakefile.
     attr_accessor :last_description
-    alias :last_comment :last_description    # Backwards compatibility
 
-    def initialize
+    def initialize # :nodoc:
       super
       @tasks = Hash.new
       @rules = Array.new
-      @scope = Array.new
+      @scope = Scope.make
       @last_description = nil
     end
 
-    def create_rule(*args, &block)
-      pattern, _, deps = resolve_args(args)
-      pattern = Regexp.new(Regexp.quote(pattern) + '$') if String === pattern
-      @rules << [pattern, deps, block]
+    def create_rule(*args, &block) # :nodoc:
+      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)
-      task_name, arg_names, deps = resolve_args(args)
+    def define_task(task_class, *args, &block) # :nodoc:
+      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
+        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.collect {|d| 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
 
     # Lookup a task.  Return an existing task if found, otherwise
@@ -46,10 +56,29 @@ 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}'"
+        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 synthesize_file_task(task_name)
+    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:
       return nil unless File.exist?(task_name)
       define_task(Rake::FileTask, task_name)
     end
@@ -80,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
 
@@ -93,19 +122,22 @@ module Rake
     #   task :t, [a] => [:d]
     #
     def resolve_args_with_dependencies(args, hash) # :nodoc:
-      fail "Task Argument Error" if hash.size != 1
-      key, value = hash.map { |k, v| [k,v] }.first
+      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
         arg_names = []
-        deps = value
+        deps = value || []
       else
         task_name = args.shift
         arg_names = key
         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
 
@@ -116,9 +148,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, extensions, block|
-        if pattern.match(task_name)
-          task = attempt_rule(task_name, 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
@@ -136,7 +169,7 @@ module Rake
     # List of all the tasks defined in the given scope (and its
     # sub-scopes).
     def tasks_in_scope(scope)
-      prefix = scope.join(":")
+      prefix = scope.path
       tasks.select { |t|
         /^#{prefix}:/ =~ t.name
       }
@@ -157,11 +190,11 @@ module Rake
       initial_scope ||= @scope
       task_name = task_name.to_s
       if task_name =~ /^rake:/
-        scopes = []
-        task_name = task_name.sub(/^rake:/, '')
+        scopes = Scope.make
+        task_name = task_name.sub(/^rake:/, "")
       elsif task_name =~ /^(\^+)/
-        scopes = initial_scope[0, initial_scope.size - $1.size]
-        task_name = task_name.sub(/^(\^+)/, '')
+        scopes = initial_scope.trim($1.size)
+        task_name = task_name.sub(/^(\^+)/, "")
       else
         scopes = initial_scope
       end
@@ -170,12 +203,12 @@ module Rake
 
     # Lookup the task name
     def lookup_in_scope(name, scope)
-      n = scope.size
-      while n >= 0
-        tn = (scope[0,n] + [name]).join(':')
+      loop do
+        tn = scope.path_with_task_name(name)
         task = @tasks[tn]
         return task if task
-        n -= 1
+        break if scope.empty?
+        scope = scope.tail
       end
       nil
     end
@@ -184,19 +217,19 @@ module Rake
     # Return the list of scope names currently active in the task
     # manager.
     def current_scope
-      @scope.dup
+      @scope
     end
 
     # Evaluate the block in a nested namespace named +name+.  Create
     # an anonymous namespace if +name+ is nil.
     def in_namespace(name)
       name ||= generate_name
-      @scope.push(name)
+      @scope = Scope.new(name, @scope)
       ns = NameSpace.new(self, @scope)
       yield(ns)
       ns
     ensure
-      @scope.pop
+      @scope = @scope.tail
     end
 
     private
@@ -213,7 +246,7 @@ module Rake
       locations = caller
       i = 0
       while locations[i]
-        return locations[i+1] if locations[i] =~ /rake\/dsl_definition.rb/
+        return locations[i + 1] if locations[i] =~ /rake\/dsl_definition.rb/
         i += 1
       end
       nil
@@ -226,19 +259,20 @@ module Rake
       "_anon_#{@seed}"
     end
 
-    def trace_rule(level, message)
-      options.trace_output.puts "#{"    "*level}#{message}" if Rake.application.options.trace_rules
+    def trace_rule(level, message) # :nodoc:
+      options.trace_output.puts "#{"    " * level}#{message}" if
+        Rake.application.options.trace_rules
     end
 
     # Attempt to create a rule given the list of prerequisites.
-    def attempt_rule(task_name, extensions, block, level)
-      sources = make_sources(task_name, extensions)
-      prereqs = sources.collect { |source|
+    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)
           trace_rule level, "(#{task_name} => #{source} ... EXIST)"
           source
-        elsif parent = enhance_with_matching_rule(source, level+1)
+        elsif parent = enhance_with_matching_rule(source, level + 1)
           trace_rule level, "(#{task_name} => #{source} ... ENHANCE)"
           parent.name
         else
@@ -246,25 +280,26 @@ module Rake
           return nil
         end
       }
-      task = FileTask.define_task({task_name => 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)
-      result = extensions.collect { |ext|
+    def make_sources(task_name, task_pattern, extensions)
+      result = extensions.map { |ext|
         case ext
         when /%/
           task_name.pathmap(ext)
         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
+        when Proc, Method
           if ext.arity == 1
             ext.call(task_name)
           else
@@ -277,9 +312,6 @@ module Rake
       result.flatten
     end
 
-
-    private
-
     # Return the current description, clearing it in the process.
     def get_description(task)
       desc = @last_description
@@ -288,7 +320,7 @@ module Rake
     end
 
     class << self
-      attr_accessor :record_task_metadata
+      attr_accessor :record_task_metadata # :nodoc:
       TaskManager.record_task_metadata = false
     end
   end

data/lib/rake/tasklib.rb

@@ -1,4 +1,5 @@
-require 'rake'
+# frozen_string_literal: true
+require "rake"
 
 module Rake
 
@@ -6,17 +7,6 @@ module Rake
   class TaskLib
     include Cloneable
     include Rake::DSL
-
-    # Make a symbol by pasting two strings together.
-    #
-    # NOTE: DEPRECATED! This method is kinda stupid. I don't know why
-    # I didn't just use string interpolation. But now other task
-    # libraries depend on this so I can't remove it without breaking
-    # other people's code. So for now it stays for backwards
-    # compatibility. BUT DON'T USE IT.
-    def paste(a,b)              # :nodoc:
-      (a.to_s + b.to_s).intern
-    end
   end
 
 end

data/lib/rake/testtask.rb

@@ -1,13 +1,13 @@
-# Define a task library for running unit tests.
-
-require 'rake'
-require 'rake/tasklib'
+# frozen_string_literal: true
+require "rake"
+require "rake/tasklib"
 
 module Rake
 
   # Create a task that runs a set of tests.
   #
   # Example:
+  #   require "rake/testtask"
   #
   #   Rake::TestTask.new do |t|
   #     t.libs << "test"
@@ -37,7 +37,7 @@ module Rake
     # Name of test task. (default is :test)
     attr_accessor :name
 
-    # List of directories to added to $LOAD_PATH before running the
+    # List of directories added to $LOAD_PATH before running the
     # tests. (default is 'lib')
     attr_accessor :libs
 
@@ -51,6 +51,7 @@ module Rake
 
     # Request that the tests be run with the warning flag set.
     # E.g. warning=true implies "ruby -w" used to run the tests.
+    # (default is true)
     attr_accessor :warning
 
     # Glob pattern to match test files. (default is 'test/test*.rb')
@@ -64,9 +65,15 @@ module Rake
     #
     attr_accessor :loader
 
-    # Array of commandline options to pass to ruby when running test loader.
+    # Array of command line options to pass to ruby when running test loader.
     attr_accessor :ruby_opts
 
+    # Description of the test task. (default is 'Run tests')
+    attr_accessor :description
+
+    # Task prerequisites.
+    attr_accessor :deps
+
     # Explicitly define the list of test files to be included in a
     # test.  +list+ is expected to be an array of file names (a
     # FileList is acceptable).  If both +pattern+ and +test_files+ are
@@ -83,22 +90,44 @@ module Rake
       @options = nil
       @test_files = nil
       @verbose = false
-      @warning = false
+      @warning = true
       @loader = :rake
       @ruby_opts = []
+      @description = "Run tests" + (@name == :test ? "" : " for #{@name}")
+      @deps = []
+      if @name.is_a?(Hash)
+        @deps = @name.values.first
+        @name = @name.keys.first
+      end
       yield self if block_given?
-      @pattern = 'test/test*.rb' if @pattern.nil? && @test_files.nil?
+      @pattern = "test/test*.rb" if @pattern.nil? && @test_files.nil?
       define
     end
 
     # Create the tasks defined by this task lib.
     def define
-      desc "Run tests" + (@name==:test ? "" : " for #{@name}")
-      task @name do
+      desc @description
+      task @name => Array(deps) do
         FileUtilsExt.verbose(@verbose) do
-          ruby "#{ruby_opts_string} #{run_code} #{file_list_string} #{option_list}" do |ok, status|
+          puts "Use TESTOPTS=\"--verbose\" to pass --verbose" \
+            ", etc. to runners." if ARGV.include? "--verbose"
+          args =
+            "#{ruby_opts_string} #{run_code} " +
+            "#{file_list_string} #{option_list}"
+          ruby args do |ok, status|
             if !ok && status.respond_to?(:signaled?) && status.signaled?
               raise SignalException.new(status.termsig)
+            elsif !ok
+              status  = "Command failed with status (#{status.exitstatus})"
+              details = ": [ruby #{args}]"
+              message =
+                if Rake.application.options.trace or @verbose
+                  status + details
+                else
+                  status
+                end
+
+              fail message
             end
           end
         end
@@ -107,66 +136,57 @@ module Rake
     end
 
     def option_list # :nodoc:
-      (ENV['TESTOPTS'] ||
-        ENV['TESTOPT'] ||
-        ENV['TEST_OPTS'] ||
-        ENV['TEST_OPT'] ||
+      (ENV["TESTOPTS"] ||
+        ENV["TESTOPT"] ||
+        ENV["TEST_OPTS"] ||
+        ENV["TEST_OPT"] ||
         @options ||
         "")
     end
 
-    def ruby_opts_string
+    def ruby_opts_string # :nodoc:
       opts = @ruby_opts.dup
-      opts.unshift( "-I\"#{lib_path}\"" ) unless @libs.empty?
-      opts.unshift( "-w" ) if @warning
+      opts.unshift("-I\"#{lib_path}\"") unless @libs.empty?
+      opts.unshift("-w") if @warning
       opts.join(" ")
     end
 
-    def lib_path
+    def lib_path # :nodoc:
       @libs.join(File::PATH_SEPARATOR)
     end
 
-    def file_list_string
-      file_list.collect { |fn| "\"#{fn}\"" }.join(' ')
+    def file_list_string # :nodoc:
+      file_list.map { |fn| "\"#{fn}\"" }.join(" ")
     end
 
     def file_list # :nodoc:
-      if ENV['TEST']
-        FileList[ ENV['TEST'] ]
+      if ENV["TEST"]
+        FileList[ENV["TEST"]]
       else
         result = []
         result += @test_files.to_a if @test_files
-        result << @pattern if @pattern
+        result += FileList[@pattern].to_a if @pattern
         result
       end
     end
 
-    def fix # :nodoc:
-      case ruby_version
-      when '1.8.2'
-        "\"#{find_file 'rake/ruby182_test_unit_fix'}\""
-      else
-        nil
-      end || ''
-    end
-
-    def ruby_version
+    def ruby_version # :nodoc:
       RUBY_VERSION
     end
 
-    def run_code
+    def run_code # :nodoc:
       case @loader
       when :direct
         "-e \"ARGV.each{|f| require f}\""
       when :testrb
-        "-S testrb #{fix}"
+        "-S testrb"
       when :rake
-        "-I\"#{rake_lib_dir}\" \"#{rake_loader}\""
+        "#{rake_include_arg} \"#{rake_loader}\""
       end
     end
 
     def rake_loader # :nodoc:
-      find_file('rake/rake_test_loader') or
+      find_file("rake/rake_test_loader") or
         fail "unable to find rake test loader"
     end
 
@@ -178,8 +198,17 @@ module Rake
       nil
     end
 
+    def rake_include_arg # :nodoc:
+      spec = Gem.loaded_specs["rake"]
+      if spec.respond_to?(:default_gem?) && spec.default_gem?
+        ""
+      else
+        "-I\"#{rake_lib_dir}\""
+      end
+    end
+
     def rake_lib_dir # :nodoc:
-      find_dir('rake') or
+      find_dir("rake") or
         fail "unable to find rake lib"
     end