rake 0.9.2.2 → 13.0.6

data/lib/rake/file_utils.rb

@@ -1,31 +1,41 @@
-require 'rbconfig'
-require 'fileutils'
+# frozen_string_literal: true
+require "rbconfig"
+require "fileutils"
 
 #--
 # This a FileUtils extension that defines several additional commands to be
 # added to the FileUtils utility functions.
 module FileUtils
   # Path to the currently running Ruby program
-  RUBY = File.join(
-    RbConfig::CONFIG['bindir'],
-    RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT']).
+  RUBY = ENV["RUBY"] || File.join(
+    RbConfig::CONFIG["bindir"],
+    RbConfig::CONFIG["ruby_install_name"] + RbConfig::CONFIG["EXEEXT"]).
     sub(/.*\s.*/m, '"\&"')
 
-  OPT_TABLE['sh']  = %w(noop verbose)
-  OPT_TABLE['ruby'] = %w(noop verbose)
-
-  # Run the system command +cmd+. If multiple arguments are given the command
-  # is not run with the shell (same semantics as Kernel::exec and
+  # Run the system command +cmd+.  If multiple arguments are given the command
+  # is run directly (without the shell, same semantics as Kernel::exec and
   # Kernel::system).
   #
-  # Example:
-  #   sh %{ls -ltr}
+  # It is recommended you use the multiple argument form over interpolating
+  # user input for both usability and security reasons.  With the multiple
+  # argument form you can easily process files with spaces or other shell
+  # reserved characters in them.  With the multiple argument form your rake
+  # tasks are not vulnerable to users providing an argument like
+  # <code>; rm # -rf /</code>.
+  #
+  # If a block is given, upon command completion the block is called with an
+  # OK flag (true on a zero exit status) and a Process::Status object.
+  # Without a block a RuntimeError is raised when the command exits non-zero.
+  #
+  # Examples:
+  #
+  #   sh 'ls -ltr'
   #
   #   sh 'ls', 'file with spaces'
   #
   #   # check exit status after command runs
   #   sh %{grep pattern file} do |ok, res|
-  #     if ! ok
+  #     if !ok
   #       puts "pattern not found (status = #{res.exitstatus})"
   #     end
   #   end
@@ -33,53 +43,65 @@ module FileUtils
   def sh(*cmd, &block)
     options = (Hash === cmd.last) ? cmd.pop : {}
     shell_runner = block_given? ? block : create_shell_runner(cmd)
+
     set_verbose_option(options)
-    options[:noop] ||= Rake::FileUtilsExt.nowrite_flag
-    Rake.rake_check_options options, :noop, :verbose
-    Rake.rake_output_message cmd.join(" ") if options[:verbose]
+    verbose = options.delete :verbose
+    noop    = options.delete(:noop) || Rake::FileUtilsExt.nowrite_flag
+
+    Rake.rake_output_message sh_show_command cmd if verbose
 
-    unless options[:noop]
-      res = rake_system(*cmd)
+    unless noop
+      res = (Hash === cmd.last) ? system(*cmd) : system(*cmd, options)
       status = $?
-      status = PseudoStatus.new(1) if !res && status.nil?
+      status = Rake::PseudoStatus.new(1) if !res && status.nil?
       shell_runner.call(res, status)
     end
   end
 
   def create_shell_runner(cmd) # :nodoc:
-    show_command = cmd.join(" ")
-    show_command = show_command[0,42] + "..." unless $trace
-    lambda { |ok, status|
-      ok or fail "Command failed with status (#{status.exitstatus}): [#{show_command}]"
-    }
+    show_command = sh_show_command cmd
+    show_command = show_command[0, 42] + "..." unless $trace
+
+    lambda do |ok, status|
+      ok or
+        fail "Command failed with status (#{status.exitstatus}): " +
+        "[#{show_command}]"
+    end
   end
   private :create_shell_runner
 
+  def sh_show_command(cmd) # :nodoc:
+    cmd = cmd.dup
+
+    if Hash === cmd.first
+      env = cmd.first
+      env = env.map { |name, value| "#{name}=#{value}" }.join " "
+      cmd[0] = env
+    end
+
+    cmd.join " "
+  end
+  private :sh_show_command
+
   def set_verbose_option(options) # :nodoc:
     unless options.key? :verbose
       options[:verbose] =
-        Rake::FileUtilsExt.verbose_flag == Rake::FileUtilsExt::DEFAULT ||
+        (Rake::FileUtilsExt.verbose_flag == Rake::FileUtilsExt::DEFAULT) ||
         Rake::FileUtilsExt.verbose_flag
     end
   end
   private :set_verbose_option
 
-  def rake_system(*cmd) # :nodoc:
-    Rake::AltSystem.system(*cmd)
-  end
-  private :rake_system
-
   # Run a Ruby interpreter with the given arguments.
   #
   # Example:
   #   ruby %{-pe '$_.upcase!' <README}
   #
-  def ruby(*args,&block)
-    options = (Hash === args.last) ? args.pop : {}
-    if args.length > 1 then
-      sh(*([RUBY] + args + [options]), &block)
+  def ruby(*args, **options, &block)
+    if args.length > 1
+      sh(RUBY, *args, **options, &block)
     else
-      sh("#{RUBY} #{args.first}", options, &block)
+      sh("#{RUBY} #{args.first}", **options, &block)
     end
   end
 
@@ -87,17 +109,15 @@ module FileUtils
 
   #  Attempt to do a normal file link, but fall back to a copy if the link
   #  fails.
-  def safe_ln(*args)
-    unless LN_SUPPORTED[0]
-      cp(*args)
-    else
+  def safe_ln(*args, **options)
+    if LN_SUPPORTED[0]
       begin
-        ln(*args)
+        return options.empty? ? ln(*args) : ln(*args, **options)
       rescue StandardError, NotImplementedError
         LN_SUPPORTED[0] = false
-        cp(*args)
       end
     end
+    options.empty? ? cp(*args) : cp(*args, **options)
   end
 
   # Split a file path into individual directory names.
@@ -107,8 +127,8 @@ module FileUtils
   #
   def split_all(path)
     head, tail = File.split(path)
-    return [tail] if head == '.' || tail == '/'
-    return [head, tail] if head == '/'
+    return [tail] if head == "." || tail == "/"
+    return [head, tail] if head == "/"
     return split_all(head) + [tail]
   end
 end

data/lib/rake/file_utils_ext.rb

@@ -1,4 +1,5 @@
-require 'rake/file_utils'
+# frozen_string_literal: true
+require "rake/file_utils"
 
 module Rake
   #
@@ -18,25 +19,22 @@ module Rake
     FileUtilsExt.verbose_flag = DEFAULT
     FileUtilsExt.nowrite_flag = false
 
-    $fileutils_verbose = true
-    $fileutils_nowrite = false
-
-    FileUtils::OPT_TABLE.each do |name, opts|
+    FileUtils.commands.each do |name|
+      opts = FileUtils.options_of name
       default_options = []
-      if opts.include?(:verbose) || opts.include?("verbose")
-        default_options << ':verbose => FileUtilsExt.verbose_flag'
+      if opts.include?("verbose")
+        default_options << "verbose: FileUtilsExt.verbose_flag"
       end
-      if opts.include?(:noop) || opts.include?("noop")
-        default_options << ':noop => FileUtilsExt.nowrite_flag'
+      if opts.include?("noop")
+        default_options << "noop: FileUtilsExt.nowrite_flag"
       end
 
       next if default_options.empty?
       module_eval(<<-EOS, __FILE__, __LINE__ + 1)
-      def #{name}( *args, &block )
-        super(
-          *rake_merge_option(args,
-            #{default_options.join(', ')}
-            ), &block)
+      def #{name}(*args, **options, &block)
+        super(*args,
+            #{default_options.join(', ')},
+            **options, &block)
       end
       EOS
     end
@@ -114,16 +112,6 @@ module Rake
       end
     end
 
-    # Merge the given options with the default values.
-    def rake_merge_option(args, defaults)
-      if Hash === args.last
-        defaults.update(args.last)
-        args.pop
-      end
-      args.push defaults
-      args
-    end
-
     # Send the message to the default rake output (which is $stderr).
     def rake_output_message(message)
       $stderr.puts(message)
@@ -137,7 +125,8 @@ module Rake
       optdecl.each do |name|
         h.delete name
       end
-      raise ArgumentError, "no such option: #{h.keys.join(' ')}" unless h.empty?
+      raise ArgumentError, "no such option: #{h.keys.join(' ')}" unless
+        h.empty?
     end
 
     extend self

data/lib/rake/invocation_chain.rb

@@ -1,46 +1,52 @@
+# frozen_string_literal: true
 module Rake
 
-  ####################################################################
   # InvocationChain tracks the chain of task invocations to detect
   # circular dependencies.
-  class InvocationChain
-    def initialize(value, tail)
-      @value = value
-      @tail = tail
-    end
+  class InvocationChain < LinkedList
 
-    def member?(obj)
-      @value == obj || @tail.member?(obj)
+    # Is the invocation already in the chain?
+    def member?(invocation)
+      head == invocation || tail.member?(invocation)
     end
 
-    def append(value)
-      if member?(value)
-        fail RuntimeError, "Circular dependency detected: #{to_s} => #{value}"
+    # Append an invocation to the chain of invocations. It is an error
+    # if the invocation already listed.
+    def append(invocation)
+      if member?(invocation)
+        fail RuntimeError, "Circular dependency detected: #{to_s} => #{invocation}"
       end
-      self.class.new(value, self)
+      conj(invocation)
     end
 
+    # Convert to string, ie: TOP => invocation => invocation
     def to_s
-      "#{prefix}#{@value}"
+      "#{prefix}#{head}"
     end
 
-    def self.append(value, chain)
-      chain.append(value)
+    # Class level append.
+    def self.append(invocation, chain)
+      chain.append(invocation)
     end
 
     private
 
     def prefix
-      "#{@tail.to_s} => "
+      "#{tail} => "
     end
 
-    class EmptyInvocationChain
+    # Null object for an empty chain.
+    class EmptyInvocationChain < LinkedList::EmptyLinkedList
+      @parent = InvocationChain
+
       def member?(obj)
         false
       end
-      def append(value)
-        InvocationChain.new(value, self)
+
+      def append(invocation)
+        conj(invocation)
       end
+
       def to_s
         "TOP"
       end

data/lib/rake/invocation_exception_mixin.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Rake
   module InvocationExceptionMixin
     # Return the invocation chain (list of Rake tasks) that were in

data/lib/rake/late_time.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Rake
+  # LateTime is a fake timestamp that occurs _after_ any other time value.
+  class LateTime
+    include Comparable
+    include Singleton
+
+    def <=>(other)
+      1
+    end
+
+    def to_s
+      "<LATE TIME>"
+    end
+  end
+
+  LATE = LateTime.instance
+end

data/lib/rake/linked_list.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+module Rake
+
+  # Polylithic linked list structure used to implement several data
+  # structures in Rake.
+  class LinkedList
+    include Enumerable
+    attr_reader :head, :tail
+
+    # Polymorphically add a new element to the head of a list. The
+    # type of head node will be the same list type as the tail.
+    def conj(item)
+      self.class.cons(item, self)
+    end
+
+    # Is the list empty?
+    # .make guards against a list being empty making any instantiated LinkedList
+    # object not empty by default
+    # You should consider overriding this method if you implement your own .make method
+    def empty?
+      false
+    end
+
+    # Lists are structurally equivalent.
+    def ==(other)
+      current = self
+      while !current.empty? && !other.empty?
+        return false if current.head != other.head
+        current = current.tail
+        other = other.tail
+      end
+      current.empty? && other.empty?
+    end
+
+    # Convert to string: LL(item, item...)
+    def to_s
+      items = map(&:to_s).join(", ")
+      "LL(#{items})"
+    end
+
+    # Same as +to_s+, but with inspected items.
+    def inspect
+      items = map(&:inspect).join(", ")
+      "LL(#{items})"
+    end
+
+    # For each item in the list.
+    def each
+      current = self
+      while !current.empty?
+        yield(current.head)
+        current = current.tail
+      end
+      self
+    end
+
+    # Make a list out of the given arguments. This method is
+    # polymorphic
+    def self.make(*args)
+      # return an EmptyLinkedList if there are no arguments
+      return empty if !args || args.empty?
+
+      # build a LinkedList by starting at the tail and iterating
+      # through each argument
+      # inject takes an EmptyLinkedList to start
+      args.reverse.inject(empty) do |list, item|
+        list = cons(item, list)
+        list # return the newly created list for each item in the block
+      end
+    end
+
+    # Cons a new head onto the tail list.
+    def self.cons(head, tail)
+      new(head, tail)
+    end
+
+    # The standard empty list class for the given LinkedList class.
+    def self.empty
+      self::EMPTY
+    end
+
+    protected
+
+    def initialize(head, tail=EMPTY)
+      @head = head
+      @tail = tail
+    end
+
+    # Represent an empty list, using the Null Object Pattern.
+    #
+    # 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 associated list class (this
+    # allows conj, cons and make to work polymorphically).
+    class EmptyLinkedList < LinkedList
+      @parent = LinkedList
+
+      def initialize
+      end
+
+      def empty?
+        true
+      end
+
+      def self.cons(head, tail)
+        @parent.cons(head, tail)
+      end
+    end
+
+    EMPTY = EmptyLinkedList.new
+  end
+end

data/lib/rake/loaders/makefile.rb

@@ -1,17 +1,31 @@
+# frozen_string_literal: true
 module Rake
 
-  # Makefile loader to be used with the import file loader.
+  # Makefile loader to be used with the import file loader.  Use this to
+  # import dependencies from make dependency tools:
+  #
+  #   require 'rake/loaders/makefile'
+  #
+  #   file ".depends.mf" => [SRC_LIST] do |t|
+  #     sh "makedepend -f- -- #{CFLAGS} -- #{t.prerequisites} > #{t.name}"
+  #   end
+  #
+  #   import ".depends.mf"
+  #
+  # See {Importing Dependencies}[link:doc/rakefile_rdoc.html#label-Importing+Dependencies]
+  # for further details.
+
   class MakefileLoader
     include Rake::DSL
 
-    SPACE_MARK = "\0"
+    SPACE_MARK = "\0" # :nodoc:
 
     # Load the makefile dependencies in +fn+.
-    def load(fn)
+    def load(fn) # :nodoc:
       lines = File.read fn
       lines.gsub!(/\\ /, SPACE_MARK)
       lines.gsub!(/#[^\n]*\n/m, "")
-      lines.gsub!(/\\\n/, ' ')
+      lines.gsub!(/\\\n/, " ")
       lines.each_line do |line|
         process_line(line)
       end
@@ -20,8 +34,8 @@ module Rake
     private
 
     # Process one logical line of makefile data.
-    def process_line(line)
-      file_tasks, args = line.split(':', 2)
+    def process_line(line) # :nodoc:
+      file_tasks, args = line.split(":", 2)
       return if args.nil?
       dependents = args.split.map { |d| respace(d) }
       file_tasks.scan(/\S+/) do |file_task|
@@ -30,11 +44,11 @@ module Rake
       end
     end
 
-    def respace(str)
-      str.tr SPACE_MARK, ' '
+    def respace(str) # :nodoc:
+      str.tr SPACE_MARK, " "
     end
   end
 
   # Install the handler
-  Rake.application.add_loader('mf', MakefileLoader.new)
+  Rake.application.add_loader("mf", MakefileLoader.new)
 end

data/lib/rake/multi_task.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Rake
 
   # Same as a regular task, but the immediate prerequisites are done in
@@ -5,12 +6,9 @@ module Rake
   #
   class MultiTask < Task
     private
-    def invoke_prerequisites(args, invocation_chain)
-      threads = @prerequisites.collect { |p|
-        Thread.new(p) { |r| application[r, @scope].invoke_with_call_chain(args, invocation_chain) }
-      }
-      threads.each { |t| t.join }
+
+    def invoke_prerequisites(task_args, invocation_chain) # :nodoc:
+      invoke_prerequisites_concurrently(task_args, invocation_chain)
     end
   end
-
 end

data/lib/rake/name_space.rb

@@ -1,25 +1,38 @@
-module Rake
-
-  # The NameSpace class will lookup task names in the the scope
-  # defined by a +namespace+ command.
-  #
-  class NameSpace
-
-    # Create a namespace lookup object using the given task manager
-    # and the list of scopes.
-    def initialize(task_manager, scope_list)
-      @task_manager = task_manager
-      @scope = scope_list.dup
-    end
-
-    # Lookup a task named +name+ in the namespace.
-    def [](name)
-      @task_manager.lookup(name, @scope)
-    end
-
-    # Return the list of tasks defined in this and nested namespaces.
-    def tasks
-      @task_manager.tasks_in_scope(@scope)
-    end
+# frozen_string_literal: true
+##
+# The NameSpace class will lookup task names in the scope defined by a
+# +namespace+ command.
+
+class Rake::NameSpace
+
+  ##
+  # Create a namespace lookup object using the given task manager
+  # and the list of scopes.
+
+  def initialize(task_manager, scope_list)
+    @task_manager = task_manager
+    @scope = scope_list.dup
   end
+
+  ##
+  # Lookup a task named +name+ in the namespace.
+
+  def [](name)
+    @task_manager.lookup(name, @scope)
+  end
+
+  ##
+  # The scope of the namespace (a LinkedList)
+
+  def scope
+    @scope.dup
+  end
+
+  ##
+  # Return the list of tasks defined in this and nested namespaces.
+
+  def tasks
+    @task_manager.tasks_in_scope(@scope)
+  end
+
 end