autobuild 1.18.1 → 1.22.0

data/lib/autobuild/import/hg.rb

@@ -17,9 +17,9 @@ module Autobuild
         # @option options [String] :branch (default) the branch to track
         def initialize(repository, options = {})
             hgopts, _common = Kernel.filter_options options,
-                branch: 'default'
+                                                    branch: 'default'
             sourceopts, common = Kernel.filter_options options,
-                :repository_id, :source_id
+                                                       :repository_id, :source_id
 
             super(common)
             @branch = hgopts[:branch]
@@ -48,8 +48,8 @@ module Autobuild
         def validate_importdir(package)
             unless File.directory?(File.join(package.importdir, '.hg'))
                 raise ConfigException.new(package, 'import'),
-                    "while importing #{package.name}, "\
-                    "#{package.importdir} is not a hg repository"
+                      "while importing #{package.name}, "\
+                      "#{package.importdir} is not a hg repository"
             end
         end
 
@@ -61,9 +61,9 @@ module Autobuild
             end
             validate_importdir(package)
             package.run(:import, Autobuild.tool('hg'), 'pull',
-                repository, retry: true, working_directory: package.importdir)
+                        repository, retry: true, working_directory: package.importdir)
             package.run(:import, Autobuild.tool('hg'), 'update',
-                branch, working_directory: package.importdir)
+                        branch, working_directory: package.importdir)
             true # no easy to know if package was updated, keep previous behavior
         end
 
@@ -72,7 +72,7 @@ module Autobuild
             FileUtils.mkdir_p(base_dir) unless File.directory?(base_dir)
 
             package.run(:import, Autobuild.tool('hg'), 'clone',
-                '-u', branch, repository, package.importdir, retry: true)
+                        '-u', branch, repository, package.importdir, retry: true)
         end
     end
 

data/lib/autobuild/import/svn.rb

@@ -14,9 +14,11 @@ module Autobuild
         #   Autobuild.programs['svn'] = 'my_svn_tool'
         def initialize(svnroot, options = {})
             svnroot = [*svnroot].join("/")
-            svnopts, common = Kernel.filter_options options,
+            svnopts, common = Kernel.filter_options(
+                options,
                 :svnup => [], :svnco => [], :revision => nil,
                 :repository_id => "svn:#{svnroot}"
+            )
             common[:repository_id] = svnopts.delete(:repository_id)
             relocate(svnroot, svnopts)
             super(common.merge(repository_id: svnopts[:repository_id]))
@@ -67,7 +69,7 @@ module Autobuild
             revision = svninfo.grep(/^Revision: /).first
             unless revision
                 raise ConfigException.new(package, 'import'),
-                    "cannot get SVN information for #{package.importdir}"
+                      "cannot get SVN information for #{package.importdir}"
             end
             revision =~ /Revision: (\d+)/
             Integer($1)
@@ -79,7 +81,9 @@ module Autobuild
         # @return [String]
         # @raises (see svn_info)
         def vcs_fingerprint(package)
-            Digest::SHA1.hexdigest(svn_info(package).grep(/^(URL|Revision):/).sort.join("\n"))
+            Digest::SHA1.hexdigest(
+                svn_info(package).grep(/^(URL|Revision):/).sort.join("\n")
+            )
         end
 
         # Returns the URL of the remote SVN repository
@@ -93,7 +97,7 @@ module Autobuild
             url = svninfo.grep(/^URL: /).first
             unless url
                 raise ConfigException.new(package, 'import'),
-                    "cannot get SVN information for #{package.importdir}"
+                      "cannot get SVN information for #{package.importdir}"
             end
             url.chomp =~ /URL: (.+)/
             $1
@@ -165,8 +169,9 @@ module Autobuild
                     Hash.new
                 end
 
-            options, other_options = Kernel.filter_options options,
-                working_directory: package.importdir, retry: true
+            options, other_options = Kernel.filter_options(
+                options, working_directory: package.importdir, retry: true
+            )
             options = options.merge(other_options)
             package.run(:import, Autobuild.tool(:svn), *args, options, &block)
         end
@@ -203,7 +208,8 @@ module Autobuild
 
             unless svninfo.grep(/is not a working copy/).empty?
                 raise ConfigException.new(package, 'import'),
-                    "#{package.importdir} does not appear to be a Subversion working copy"
+                      "#{package.importdir} does not appear to be a "\
+                      "Subversion working copy"
             end
             svninfo
         ensure
@@ -241,8 +247,8 @@ module Autobuild
 
         def checkout(package, _options = Hash.new) # :nodoc:
             run_svn(package, 'co', "--non-interactive", *@options_co,
-                svnroot, package.importdir,
-                working_directory: nil)
+                    svnroot, package.importdir,
+                    working_directory: nil)
         end
     end
 

data/lib/autobuild/importer.rb

@@ -107,7 +107,11 @@ module Autobuild
         # @return [Array<String>,nil]
         # @see .cache_dirs
         def self.default_cache_dirs
-            [@default_cache_dirs] if @default_cache_dirs ||= ENV['AUTOBUILD_CACHE_DIR']
+            if @default_cache_dirs
+                @default_cache_dirs
+            elsif (from_env = ENV['AUTOBUILD_CACHE_DIR'])
+                @default_cache_dirs = [from_env]
+            end
         end
 
         # Sets the cache directory for a given importer type
@@ -199,7 +203,8 @@ module Autobuild
 
             patches_fingerprint_string = patches_fingerprint(package)
             if patches_fingerprint_string
-                Digest::SHA1.hexdigest(vcs_fingerprint_string + patches_fingerprint_string)
+                Digest::SHA1.hexdigest(vcs_fingerprint_string +
+                                       patches_fingerprint_string)
             elsif patches.empty?
                 vcs_fingerprint_string
             end
@@ -207,16 +212,19 @@ module Autobuild
 
         # basic fingerprint of the package and its dependencies
         def vcs_fingerprint(package)
-            #each importer type should implement its own 
-            Autoproj.warn "Fingerprint in #{package.name} has not been implemented for this type of packages, results should be discarded"
-            return nil
+            # each importer type should implement its own
+            Autoproj.warn "Fingerprint in #{package.name} has not been implemented "\
+                          "for this type of packages, results should be discarded"
+            nil
         end
 
         # fingerprint for patches associated to this package
         def patches_fingerprint(package)
             cur_patches = currently_applied_patches(package)
-            cur_patches.map(&:shift) #leave only level and source information
-            Digest::SHA1.hexdigest(cur_patches.sort.flatten.join("")) if !patches.empty? && cur_patches
+            cur_patches.map(&:shift) # leave only level and source information
+            if !patches.empty? && cur_patches
+              Digest::SHA1.hexdigest(cur_patches.sort.flatten.join(""))
+            end
         end
 
         # Sets the number of times update / checkout should be retried before giving
@@ -310,12 +318,10 @@ module Autobuild
         end
 
         # Enumerate the post-import hooks for this importer
-        def each_post_hook(error: false)
+        def each_post_hook(error: false, &block)
             return enum_for(__method__, error: false) unless block_given?
 
-            self.class.each_post_hook(error: error) do |callback|
-                yield(callback)
-            end
+            self.class.each_post_hook(error: error, &block)
 
             post_hooks.each do |hook|
                 yield(hook.callback) if hook.always || !error
@@ -353,9 +359,9 @@ module Autobuild
                     raise last_error
                 else raise
                 end
-            rescue ::Exception => original_error
+            rescue ::Exception => e
                 message = Autobuild.color('update failed', :red)
-                last_error = original_error
+                last_error = e
                 # If the package is patched, it might be that the update
                 # failed because we needed to unpatch first. Try it out
                 #
@@ -374,11 +380,11 @@ module Autobuild
                     rescue Interrupt
                         raise
                     rescue ::Exception
-                        raise original_error
+                        raise e
                     end
                 end
 
-                retry_count = update_retry_count(original_error, retry_count)
+                retry_count = update_retry_count(e, retry_count)
                 raise unless retry_count
 
                 package.message "update failed in #{package.importdir}, "\
@@ -395,20 +401,20 @@ module Autobuild
             fallback(e, package, :import, package)
         end
 
-        def perform_checkout(package, options = Hash.new)
+        def perform_checkout(package, **options)
             last_error = nil
             package.progress_start "checking out %s", :done_message => 'checked out %s' do
                 retry_count = 0
                 begin
-                    checkout(package, options)
+                    checkout(package, **options)
                     execute_post_hooks(package)
                 rescue Interrupt
                     if last_error then raise last_error
                     else raise
                     end
-                rescue ::Exception => original_error
-                    last_error = original_error
-                    retry_count = update_retry_count(original_error, retry_count)
+                rescue ::Exception => e
+                    last_error = e
+                    retry_count = update_retry_count(e, retry_count)
                     raise unless retry_count
 
                     package.message "checkout of %s failed, "\
@@ -452,31 +458,26 @@ module Autobuild
         #   ID is given will, in this mode, reset the repository to the requested ID
         #   (if that does not involve losing commits). Otherwise, it will only
         #   ensure that the requested commit ID is present in the current HEAD.
-        def import(package, options = Hash.new)
+        def import( # rubocop:disable Metrics/ParameterLists
+            package, *old_boolean,
+            ignore_errors: false, checkout_only: false, allow_interactive: true, **options
+        )
             # Backward compatibility
-            unless options.kind_of?(Hash)
-                options = options
+            unless old_boolean.empty?
+                old_boolean = old_boolean.first
                 Autoproj.warn "calling #import with a boolean as second argument "\
                     "is deprecated, switch to the named argument interface instead"
-                Autoproj.warn "   e.g. call import(package, only_local: #{options})"
+                Autoproj.warn "   e.g. call import(package, only_local: #{old_boolean})"
                 Autoproj.warn "   #{caller(1..1).first}"
-                options = Hash[only_local: options]
+                options[:only_local] = old_boolean
             end
 
-            options = Kernel.validate_options options,
-                only_local: false,
-                reset: false,
-                checkout_only: false,
-                ignore_errors: false,
-                allow_interactive: true
-            ignore_errors = options.delete(:ignore_errors)
-
             importdir = package.importdir
             if File.directory?(importdir)
                 package.isolate_errors(mark_as_failed: false,
                                        ignore_errors: ignore_errors) do
-                    if !options[:checkout_only] && package.update?
-                        perform_update(package, options)
+                    if !checkout_only && package.update?
+                        perform_update(package, checkout_only: false, **options)
                     elsif Autobuild.verbose
                         package.message "%s: not updating"
                     end
@@ -484,12 +485,11 @@ module Autobuild
 
             elsif File.exist?(importdir)
                 raise ConfigException.new(package, 'import'),
-                    "#{importdir} exists but is not a directory"
+                      "#{importdir} exists but is not a directory"
             else
                 package.isolate_errors(mark_as_failed: true,
                                        ignore_errors: ignore_errors) do
-                    perform_checkout(package,
-                        allow_interactive: options[:allow_interactive])
+                    perform_checkout(package, allow_interactive: allow_interactive)
                     true
                 end
             end

data/lib/autobuild/mail_reporter.rb

@@ -22,8 +22,11 @@ if Autobuild::HAS_RMAIL
             end
 
             attr_reader :from_email, :to_email, :smtp_hostname, :smtp_port,
-                :subject, :only_errors
+                        :subject, :only_errors
+
             def initialize(config)
+                super()
+
                 @from_email = (config[:from] || default_mail)
                 @to_email   = (config[:to]   || default_mail)
                 @subject =
@@ -78,7 +81,7 @@ if Autobuild::HAS_RMAIL
                         to_email.each do |email|
                             mail.header.to = email
                             smtp.send_mail(RMail::Serialize.write('', mail),
-                                from_email, email)
+                                           from_email, email)
                         end
                     end
 

data/lib/autobuild/package.rb

@@ -64,7 +64,7 @@ module Autobuild
         # Some statistics about the commands that have been run
         attr_reader :statistics
 
-        EnvOp = Struct.new :type, :name, :values
+        EnvOp = Struct.new :type, :name, :values # rubocop:disable Lint/StructNewOverride
 
         # List of environment values added by this package with {#env_add},
         # {#env_add_path} or {#env_set}
@@ -150,6 +150,7 @@ module Autobuild
             @imported = false
             @prepared = false
             @built = false
+            @disabled = nil
 
             if Hash === spec
                 name, depends = spec.to_a.first
@@ -207,28 +208,20 @@ module Autobuild
             File.directory?(srcdir)
         end
 
-        def prepare_invoked?
-            task("#{name}-prepare").already_invoked?
-        end
-
-        def prepared?
-            @prepared
-        end
-
         def import_invoked?
-            task("#{name}-import").already_invoked?
+            @import_invoked
         end
 
         def imported?
             @imported
         end
 
-        def build_invoked?
-            task("#{name}-build").already_invoked?
+        def install_invoked?
+            @install_invoked
         end
 
-        def built?
-            @built
+        def installed?
+            @installed
         end
 
         def to_s
@@ -410,8 +403,8 @@ module Autobuild
         def isolate_errors(options = Hash.new)
             options = Hash[mark_as_failed: true] unless options.kind_of?(Hash)
             options = validate_options options,
-                mark_as_failed: true,
-                ignore_errors: Autobuild.ignore_errors
+                                       mark_as_failed: true,
+                                       ignore_errors: Autobuild.ignore_errors
 
             # Don't do anything if we already have failed
             if failed?
@@ -456,15 +449,16 @@ module Autobuild
         # be done there as well.
         #
         # (see Importer#import)
-        def import(options = Hash.new)
-            options = Hash[only_local: options] unless options.respond_to?(:to_hash)
+        def import(*old_boolean, **options)
+            options = { only_local: old_boolean.first } unless old_boolean.empty?
 
+            @import_invoked = true
             if @importer
-                result = @importer.import(self, options)
-                @imported = true
+                result = @importer.import(self, **options)
             elsif update?
                 message "%s: no importer defined, doing nothing"
             end
+            @imported = true
 
             # Add the dependencies declared in spec
             depends_on(*@spec_dependencies) if @spec_dependencies
@@ -480,7 +474,10 @@ module Autobuild
             stamps = dependencies.map { |p| Package[p].installstamp }
 
             file installstamp => stamps do
-                isolate_errors { install }
+                isolate_errors do
+                    @install_invoked = true
+                    install
+                end
             end
             task "#{name}-build" => installstamp
 
@@ -499,12 +496,12 @@ module Autobuild
                 end
             end
             if suffix.empty?
-                return msg
+                msg
             elsif prefix_style.empty?
-                return (prefix + suffix).join(" ")
+                (prefix + suffix).join(" ")
             else
                 colorized_prefix = Autobuild.color(prefix.join(" "), *prefix_style)
-                return [colorized_prefix, *suffix].join(" ")
+                [colorized_prefix, *suffix].join(" ")
             end
         end
 
@@ -531,7 +528,7 @@ module Autobuild
             args[0] = process_formatting_string(args[0], :bold)
             done_message = process_formatting_string(done_message) if done_message
             Autobuild.progress_start(self, *args,
-                done_message: done_message, **raw_options, &block)
+                                     done_message: done_message, **raw_options, &block)
         end
 
         def progress(*args)
@@ -563,7 +560,7 @@ module Autobuild
 
             Autobuild.touch_stamp(installstamp)
 
-            @built = true
+            @installed = true
         end
 
         def run(*args, &block)
@@ -580,6 +577,14 @@ module Autobuild
 
         module TaskExtension
             attr_accessor :package
+
+            def disabled?
+                if @disabled.nil? && package
+                    package.disabled?
+                else
+                    super
+                end
+            end
         end
 
         def source_tree(*args, &block)
@@ -659,6 +664,10 @@ module Autobuild
             end
         end
 
+        def self_fingerprint
+            importer.fingerprint(self)
+        end
+
         # Returns a unique hash representing a state of the package and
         # its dependencies, if any dependency can't calculate its own
         # fingerprint the result will be nil
@@ -666,18 +675,23 @@ module Autobuild
         def fingerprint(recursive: true, memo: {})
             return memo[name] if memo.key?(name)
 
-            self_fingerprint = importer.fingerprint(self)
+            self_fingerprint = self.self_fingerprint
             return unless self_fingerprint
-            return self_fingerprint if !recursive || dependencies.empty?
+            if dependencies.empty?
+                return (memo[name] = self_fingerprint)
+            elsif !recursive
+                return self_fingerprint
+            end
 
             dependency_fingerprints = dependencies.sort.map do |pkg_name|
                 pkg = Autobuild::Package[pkg_name]
                 unless (fingerprint = memo[pkg.name])
                     fingerprint = pkg.fingerprint(recursive: true, memo: memo)
-                    return unless fingerprint
+                    break unless fingerprint
                 end
                 fingerprint
             end
+            return unless dependency_fingerprints
 
             memo[name] = Digest::SHA1.hexdigest(
                 self_fingerprint + dependency_fingerprints.join(""))
@@ -820,17 +834,13 @@ module Autobuild
             phases.each do |phase|
                 task "#{name}-#{phase}"
                 t = Rake::Task["#{name}-#{phase}"]
-                t.disable!
+                t.disable
             end
         end
 
         # Make sure that this package will be ignored in the build
-        def disable(phases = Autobuild.all_phases)
+        def disable(_phases = Autobuild.all_phases)
             @disabled = true
-            disable_phases(*phases)
-            task(installstamp)
-            t = Rake::Task[installstamp]
-            t.disable!
         end
 
         def utility(utility_name)