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

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,9 +6,9 @@ module Rake
   #
   class MultiTask < Task
     private
+
     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

data/lib/rake/packagetask.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 # Define a package task library to aid in the definition of
 # redistributable package files.
 
-require 'rake'
-require 'rake/tasklib'
+require "rake"
+require "rake/tasklib"
 
 module Rake
 
@@ -11,27 +12,27 @@ module Rake
   #
   # The PackageTask will create the following targets:
   #
-  # [<b>:package</b>]
+  # +:package+ ::
   #   Create all the requested package files.
   #
-  # [<b>:clobber_package</b>]
+  # +:clobber_package+ ::
   #   Delete all the package files.  This target is automatically
   #   added to the main clobber target.
   #
-  # [<b>:repackage</b>]
+  # +:repackage+ ::
   #   Rebuild the package files from scratch, even if they are not out
   #   of date.
   #
-  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tgz"</b>]
+  # <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tgz"</tt> ::
   #   Create a gzipped tar package (if <em>need_tar</em> is true).
   #
-  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.gz"</b>]
+  # <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.gz"</tt> ::
   #   Create a gzipped tar package (if <em>need_tar_gz</em> is true).
   #
-  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.bz2"</b>]
+  # <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.bz2"</tt> ::
   #   Create a bzip2'd tar package (if <em>need_tar_bz2</em> is true).
   #
-  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.zip"</b>]
+  # <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.zip"</tt> ::
   #   Create a zip package archive (if <em>need_zip</em> is true).
   #
   # Example:
@@ -51,15 +52,21 @@ module Rake
     # Directory used to store the package files (default is 'pkg').
     attr_accessor :package_dir
 
-    # True if a gzipped tar file (tgz) should be produced (default is false).
+    # True if a gzipped tar file (tgz) should be produced (default is
+    # false).
     attr_accessor :need_tar
 
-    # True if a gzipped tar file (tar.gz) should be produced (default is false).
+    # True if a gzipped tar file (tar.gz) should be produced (default
+    # is false).
     attr_accessor :need_tar_gz
 
-    # True if a bzip2'd tar file (tar.bz2) should be produced (default is false).
+    # True if a bzip2'd tar file (tar.bz2) should be produced (default
+    # is false).
     attr_accessor :need_tar_bz2
 
+    # True if a xz'd tar file (tar.xz) should be produced (default is false)
+    attr_accessor :need_tar_xz
+
     # True if a zip file should be produced (default is false)
     attr_accessor :need_zip
 
@@ -72,6 +79,9 @@ module Rake
     # Zip command for zipped archives.  The default is 'zip'.
     attr_accessor :zip_command
 
+    # True if parent directory should be omited (default is false)
+    attr_accessor :without_parent_dir
+
     # Create a Package Task with the given name and version.  Use +:noversion+
     # as the version to build a package without a version or to provide a
     # fully-versioned package name.
@@ -87,13 +97,15 @@ module Rake
       @name = name
       @version = version
       @package_files = Rake::FileList.new
-      @package_dir = 'pkg'
+      @package_dir = "pkg"
       @need_tar = false
       @need_tar_gz = false
       @need_tar_bz2 = false
+      @need_tar_xz = false
       @need_zip = false
-      @tar_command = 'tar'
-      @zip_command = 'zip'
+      @tar_command = "tar"
+      @zip_command = "zip"
+      @without_parent_dir = false
     end
 
     # Create the tasks defined by this task library.
@@ -105,47 +117,45 @@ module Rake
       task :package
 
       desc "Force a rebuild of the package files"
-      task :repackage => [:clobber_package, :package]
+      task repackage: [:clobber_package, :package]
 
       desc "Remove package products"
       task :clobber_package do
         rm_r package_dir rescue nil
       end
 
-      task :clobber => [:clobber_package]
+      task clobber: [:clobber_package]
 
       [
         [need_tar, tgz_file, "z"],
         [need_tar_gz, tar_gz_file, "z"],
-        [need_tar_bz2, tar_bz2_file, "j"]
-      ].each do |(need, file, flag)|
+        [need_tar_bz2, tar_bz2_file, "j"],
+        [need_tar_xz, tar_xz_file, "J"]
+      ].each do |need, file, flag|
         if need
-          task :package => ["#{package_dir}/#{file}"]
-          file "#{package_dir}/#{file}" => [package_dir_path] + package_files do
-            chdir(package_dir) do
-              sh %{#{@tar_command} #{flag}cvf #{file} #{package_name}}
-            end
+          task package: ["#{package_dir}/#{file}"]
+          file "#{package_dir}/#{file}" =>
+            [package_dir_path] + package_files do
+            chdir(working_dir) { sh @tar_command, "#{flag}cvf", file, target_dir }
+            mv "#{package_dir_path}/#{target_dir}", package_dir if without_parent_dir
           end
         end
       end
 
       if need_zip
-        task :package => ["#{package_dir}/#{zip_file}"]
-        file "#{package_dir}/#{zip_file}" => [package_dir_path] + package_files do
-          chdir(package_dir) do
-            sh %{#{@zip_command} -r #{zip_file} #{package_name}}
-          end
+        task package: ["#{package_dir}/#{zip_file}"]
+        file "#{package_dir}/#{zip_file}" =>
+          [package_dir_path] + package_files do
+          chdir(working_dir) { sh @zip_command, "-r", zip_file, target_dir }
+          mv "#{package_dir_path}/#{zip_file}", package_dir if without_parent_dir
         end
       end
 
-      directory package_dir
-
-      file package_dir_path => @package_files do
-        mkdir_p package_dir rescue nil
+      directory package_dir_path => @package_files do
         @package_files.each do |fn|
           f = File.join(package_dir_path, fn)
           fdir = File.dirname(f)
-          mkdir_p(fdir) if !File.exist?(fdir)
+          mkdir_p(fdir) unless File.exist?(fdir)
           if File.directory?(fn)
             mkdir_p(f)
           else
@@ -157,29 +167,56 @@ module Rake
       self
     end
 
+    # The name of this package
+
     def package_name
       @version ? "#{@name}-#{@version}" : @name
     end
 
+    # The directory this package will be built in
+
     def package_dir_path
       "#{package_dir}/#{package_name}"
     end
 
+    # The package name with .tgz added
+
     def tgz_file
       "#{package_name}.tgz"
     end
 
+    # The package name with .tar.gz added
+
     def tar_gz_file
       "#{package_name}.tar.gz"
     end
 
+    # The package name with .tar.bz2 added
+
     def tar_bz2_file
       "#{package_name}.tar.bz2"
     end
 
+    # The package name with .tar.xz added
+
+    def tar_xz_file
+      "#{package_name}.tar.xz"
+    end
+
+    # The package name with .zip added
+
     def zip_file
       "#{package_name}.zip"
     end
+
+    def working_dir
+      without_parent_dir ? package_dir_path : package_dir
+    end
+
+    # target directory relative to working_dir
+    def target_dir
+      without_parent_dir ? "." : package_name
+    end
   end
 
 end

data/lib/rake/phony.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
 # Defines a :phony task that you can use as a dependency. This allows
 # file-based tasks to use non-file-based tasks as prerequisites
 # without forcing them to rebuild.
 #
 # See FileTask#out_of_date? and Task#timestamp for more info.
 
-require 'rake'
+require "rake"
 
 task :phony
 
-def (Rake::Task[:phony]).timestamp
-  Time.at 0
+Rake::Task[:phony].tap do |task|
+  def task.timestamp # :nodoc:
+    Time.at 0
+  end
 end

data/lib/rake/private_reader.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Rake
+
+  # Include PrivateReader to use +private_reader+.
+  module PrivateReader           # :nodoc: all
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      # Declare a list of private accessors
+      def private_reader(*names)
+        attr_reader(*names)
+        private(*names)
+      end
+    end
+
+  end
+end

data/lib/rake/promise.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+module Rake
+
+  # A Promise object represents a promise to do work (a chore) in the
+  # future. The promise is created with a block and a list of
+  # arguments for the block. Calling value will return the value of
+  # the promised chore.
+  #
+  # Used by ThreadPool.
+  #
+  class Promise               # :nodoc: all
+    NOT_SET = Object.new.freeze # :nodoc:
+
+    attr_accessor :recorder
+
+    # Create a promise to do the chore specified by the block.
+    def initialize(args, &block)
+      @mutex = Mutex.new
+      @result = NOT_SET
+      @error = NOT_SET
+      @args = args
+      @block = block
+    end
+
+    # Return the value of this promise.
+    #
+    # If the promised chore is not yet complete, then do the work
+    # synchronously. We will wait.
+    def value
+      unless complete?
+        stat :sleeping_on, item_id: object_id
+        @mutex.synchronize do
+          stat :has_lock_on, item_id: object_id
+          chore
+          stat :releasing_lock_on, item_id: object_id
+        end
+      end
+      error? ? raise(@error) : @result
+    end
+
+    # If no one else is working this promise, go ahead and do the chore.
+    def work
+      stat :attempting_lock_on, item_id: object_id
+      if @mutex.try_lock
+        stat :has_lock_on, item_id: object_id
+        chore
+        stat :releasing_lock_on, item_id: object_id
+        @mutex.unlock
+      else
+        stat :bailed_on, item_id: object_id
+      end
+    end
+
+    private
+
+    # Perform the chore promised
+    def chore
+      if complete?
+        stat :found_completed, item_id: object_id
+        return
+      end
+      stat :will_execute, item_id: object_id
+      begin
+        @result = @block.call(*@args)
+      rescue Exception => e
+        @error = e
+      end
+      stat :did_execute, item_id: object_id
+      discard
+    end
+
+    # Do we have a result for the promise
+    def result?
+      !@result.equal?(NOT_SET)
+    end
+
+    # Did the promise throw an error
+    def error?
+      !@error.equal?(NOT_SET)
+    end
+
+    # Are we done with the promise
+    def complete?
+      result? || error?
+    end
+
+    # free up these items for the GC
+    def discard
+      @args = nil
+      @block = nil
+    end
+
+    # Record execution statistics if there is a recorder
+    def stat(*args)
+      @recorder.call(*args) if @recorder
+    end
+
+  end
+
+end