autoproj 2.12.1 → 2.15.1

data/lib/autoproj/os_package_installer.rb

@@ -1,36 +1,36 @@
 # frozen_string_literal: true
 
-require 'autoproj/package_managers/manager'
-require 'autoproj/package_managers/unknown_os_manager'
-require 'autoproj/package_managers/shell_script_manager'
-
-require 'autoproj/package_managers/apt_dpkg_manager'
-require 'autoproj/package_managers/emerge_manager'
-require 'autoproj/package_managers/homebrew_manager'
-require 'autoproj/package_managers/pacman_manager'
-require 'autoproj/package_managers/pkg_manager'
-require 'autoproj/package_managers/port_manager'
-require 'autoproj/package_managers/yum_manager'
-require 'autoproj/package_managers/zypper_manager'
-
-require 'autoproj/package_managers/bundler_manager'
-require 'autoproj/package_managers/pip_manager'
+require "autoproj/package_managers/manager"
+require "autoproj/package_managers/unknown_os_manager"
+require "autoproj/package_managers/shell_script_manager"
+
+require "autoproj/package_managers/apt_dpkg_manager"
+require "autoproj/package_managers/emerge_manager"
+require "autoproj/package_managers/homebrew_manager"
+require "autoproj/package_managers/pacman_manager"
+require "autoproj/package_managers/pkg_manager"
+require "autoproj/package_managers/port_manager"
+require "autoproj/package_managers/yum_manager"
+require "autoproj/package_managers/zypper_manager"
+
+require "autoproj/package_managers/bundler_manager"
+require "autoproj/package_managers/pip_manager"
 
 module Autoproj
     class OSPackageInstaller
         attr_reader :ws
 
         PACKAGE_MANAGERS = Hash[
-           'apt-dpkg' => PackageManagers::AptDpkgManager,
-           'gem'      => PackageManagers::BundlerManager,
-           'emerge'   => PackageManagers::EmergeManager,
-           'pacman'   => PackageManagers::PacmanManager,
-           'brew'     => PackageManagers::HomebrewManager,
-           'yum'      => PackageManagers::YumManager,
-           'macports' => PackageManagers::PortManager,
-           'zypper'   => PackageManagers::ZypperManager,
-           'pip'      => PackageManagers::PipManager ,
-           'pkg'      => PackageManagers::PkgManager
+           "apt-dpkg" => PackageManagers::AptDpkgManager,
+           "gem" => PackageManagers::BundlerManager,
+           "emerge" => PackageManagers::EmergeManager,
+           "pacman" => PackageManagers::PacmanManager,
+           "brew" => PackageManagers::HomebrewManager,
+           "yum" => PackageManagers::YumManager,
+           "macports" => PackageManagers::PortManager,
+           "zypper" => PackageManagers::ZypperManager,
+           "pip" => PackageManagers::PipManager,
+           "pkg" => PackageManagers::PkgManager
         ]
 
         attr_reader :os_package_resolver
@@ -39,6 +39,7 @@ module Autoproj
         attr_reader :installed_resolved_packages
 
         attr_writer :silent
+
         def silent?
             @silent
         end
@@ -83,10 +84,10 @@ module Autoproj
             package_managers.each(&block)
         end
 
-        HANDLE_ALL  = 'all'
-        HANDLE_RUBY = 'ruby'
-        HANDLE_OS   = 'os'
-        HANDLE_NONE = 'none'
+        HANDLE_ALL  = "all"
+        HANDLE_RUBY = "ruby"
+        HANDLE_OS   = "os"
+        HANDLE_NONE = "none"
 
         def osdeps_mode_option_unsupported_os(config)
             long_doc = <<-EOT
@@ -117,16 +118,16 @@ about the OS packages that you will need to install manually.
 
 So, what do you want ? (all, none or a comma-separated list of: gem pip)
             EOT
-            message = [ "Which prepackaged software (a.k.a. 'osdeps') should autoproj install automatically (all, none or a comma-separated list of: gem pip) ?", long_doc.strip ]
+            message = ["Which prepackaged software (a.k.a. 'osdeps') should autoproj install automatically (all, none or a comma-separated list of: gem pip) ?", long_doc.strip]
 
-            config.declare 'osdeps_mode', 'string',
-                default: 'ruby',
-                doc: message,
-                lowercase: true
+            config.declare "osdeps_mode", "string",
+                           default: "ruby",
+                           doc: message,
+                           lowercase: true
         end
 
         def osdeps_mode_option_supported_os(config)
-            long_doc =<<-EOT
+            long_doc = <<-EOT
 The software packages that autoproj will have to build may require other
 prepackaged softwares (a.k.a. OS dependencies) to be installed (RubyGems
 packages, packages from your operating system/distribution, ...). Autoproj
@@ -158,10 +159,10 @@ about the OS packages that you will need to install manually.
 
 So, what do you want ? (all, none or a comma-separated list of: os gem pip)
             EOT
-            message = [ "Which prepackaged software (a.k.a. 'osdeps') should autoproj install automatically (all, none or a comma-separated list of: os gem pip) ?", long_doc.strip ]
+            message = ["Which prepackaged software (a.k.a. 'osdeps') should autoproj install automatically (all, none or a comma-separated list of: os gem pip) ?", long_doc.strip]
 
-            config.declare 'osdeps_mode', 'string',
-                           default: 'all',
+            config.declare "osdeps_mode", "string",
+                           default: "all",
                            doc: message,
                            lowercase: true
         end
@@ -175,21 +176,21 @@ So, what do you want ? (all, none or a comma-separated list of: os gem pip)
         end
 
         def osdeps_mode_string_to_value(string)
-            user_modes = string.to_s.downcase.split(',')
+            user_modes = string.to_s.downcase.split(",")
             modes = []
             user_modes.each do |str|
                 case str
-                when 'all'  then modes.concat(%w[os gem pip])
-                when 'ruby' then modes << 'gem'
-                when 'gem'  then modes << 'gem'
-                when 'pip'  then modes << 'pip'
-                when 'os'   then modes << 'os'
-                when 'none' then
+                when "all"  then modes.concat(%w[os gem pip])
+                when "ruby" then modes << "gem"
+                when "gem"  then modes << "gem"
+                when "pip"  then modes << "pip"
+                when "os"   then modes << "os"
+                when "none" then # rubocop:disable Lint/EmptyWhen
                 else
                     if package_managers.key?(str)
                         modes << str
                     else
-                        raise ArgumentError, "#{str} is not a known package handler, known handlers are #{package_managers.keys.sort.join(", ")}"
+                        raise ArgumentError, "#{str} is not a known package handler, known handlers are #{package_managers.keys.sort.join(', ')}"
                     end
                 end
             end
@@ -197,7 +198,7 @@ So, what do you want ? (all, none or a comma-separated list of: os gem pip)
         end
 
         def configure_manager
-            os_package_manager.configure_manager if osdeps_mode.include?('os')
+            os_package_manager.configure_manager if osdeps_mode.include?("os")
         end
 
         # If set to true (the default), #install will try to remove the list of
@@ -224,37 +225,38 @@ So, what do you want ? (all, none or a comma-separated list of: os gem pip)
             # AUTOPROJ_OSDEPS_MODE and/or configuration file. Moreover, it
             # allows to override the osdeps mode by using
             # OSPackageInstaller#osdeps_mode=
-            if @osdeps_mode
-                return @osdeps_mode
-            end
+            return @osdeps_mode if @osdeps_mode
 
             config = ws.config
-            while true
+            loop do
                 mode =
-                    if !config.has_value_for?('osdeps_mode') && mode_name = ENV['AUTOPROJ_OSDEPS_MODE']
+                    if !config.has_value_for?("osdeps_mode") &&
+                       (mode_name = ENV["AUTOPROJ_OSDEPS_MODE"])
                         begin osdeps_mode_string_to_value(mode_name)
                         rescue ArgumentError
-                            Autoproj.warn "invalid osdeps mode given through AUTOPROJ_OSDEPS_MODE (#{mode})"
+                            Autoproj.warn "invalid osdeps mode given through "\
+                                          "AUTOPROJ_OSDEPS_MODE (#{mode})"
                             nil
                         end
                     else
-                        mode_name = config.get('osdeps_mode')
+                        mode_name = config.get("osdeps_mode")
                         begin osdeps_mode_string_to_value(mode_name)
                         rescue ArgumentError
-                            Autoproj.warn "invalid osdeps mode stored in configuration file"
+                            Autoproj.warn "invalid osdeps mode stored "\
+                                          "in configuration file"
                             nil
                         end
                     end
 
                 if mode
                     @osdeps_mode = mode
-                    config.set('osdeps_mode', mode_name, true)
+                    config.set("osdeps_mode", mode_name, true)
                     return mode
                 end
 
                 # Invalid configuration values. Retry
-                config.reset('osdeps_mode')
-                ENV['AUTOPROJ_OSDEPS_MODE'] = nil
+                config.reset("osdeps_mode")
+                ENV["AUTOPROJ_OSDEPS_MODE"] = nil
             end
         end
 
@@ -275,27 +277,25 @@ So, what do you want ? (all, none or a comma-separated list of: os gem pip)
                 handler.enabled = false
             end
             osdeps_mode.each do |m|
-                if m == 'os'
+                if m == "os"
                     os_package_manager.enabled = true
-                elsif pkg = package_managers[m]
+                elsif (pkg = package_managers[m])
                     pkg.enabled = true
                 else
-                    Autoproj.warn "osdep handler #{m.inspect} found in osdep_mode has no handler, available handlers are #{package_managers.keys.map(&:inspect).sort.join(", ")}"
+                    available = package_managers.keys.map(&:inspect).sort.join(", ")
+                    Autoproj.warn "osdep handler #{m.inspect} found in osdep_mode "\
+                                  "has no handler, available handlers are #{available}"
                 end
             end
-            os_package_manager.silent = self.silent?
+            os_package_manager.silent = silent?
             package_managers.each_value do |v|
-                v.silent = self.silent?
+                v.silent = silent?
             end
 
             enabled_handlers = []
-            if os_package_manager.enabled?
-                enabled_handlers << os_package_manager
-            end
+            enabled_handlers << os_package_manager if os_package_manager.enabled?
             package_managers.each_value do |v|
-                if v.enabled?
-                    enabled_handlers << v
-                end
+                enabled_handlers << v if v.enabled?
             end
             enabled_handlers
         end
@@ -310,19 +310,17 @@ So, what do you want ? (all, none or a comma-separated list of: os gem pip)
             packages = os_package_resolver.resolve_os_packages(packages)
 
             packages = packages.map do |handler_name, list|
-                if manager = package_managers[handler_name]
-                    [manager, list]
-                else
+                unless (manager = package_managers[handler_name])
                     raise ArgumentError, "no package manager called #{handler_name} found"
                 end
+
+                [manager, list]
             end
 
             _, other_packages =
                 packages.partition { |handler, list| handler == os_package_manager }
             other_packages.each do |handler, list|
-                if handler.respond_to?(:pristine)
-                    handler.pristine(list)
-                end
+                handler.pristine(list) if handler.respond_to?(:pristine)
             end
         end
 
@@ -338,11 +336,11 @@ So, what do you want ? (all, none or a comma-separated list of: os gem pip)
         def resolve_package_managers_in_mapping(mapping)
             resolved = Hash.new
             mapping.each do |manager_name, package_list|
-                if manager = package_managers[manager_name]
-                    resolved[manager] = package_list
-                else
+                unless (manager = package_managers[manager_name])
                     raise ArgumentError, "no package manager called #{handler_name} found"
                 end
+
+                resolved[manager] = package_list
             end
             resolved
         end
@@ -378,9 +376,10 @@ So, what do you want ? (all, none or a comma-separated list of: os gem pip)
                 # If the manager is strict, we need to bypass it if we did not
                 # get the complete list of osdep packages
                 if manager.strict? && !all_osdep_packages
-                    if !manager_selected.empty?
-                        raise InternalError, "requesting to install the osdeps #{partitioned_packages[manager].to_a.sort.join(", ")} through #{manager_name} but the complete list of osdep packages managed by this manager was not provided. This would break the workspace"
+                    unless manager_selected.empty?
+                        raise InternalError, "requesting to install the osdeps #{partitioned_packages[manager].to_a.sort.join(', ')} through #{manager_name} but the complete list of osdep packages managed by this manager was not provided. This would break the workspace"
                     end
+
                     next
                 end
 
@@ -412,29 +411,40 @@ So, what do you want ? (all, none or a comma-separated list of: os gem pip)
                     end
 
                     partitioned_packages[nested_manager] += deps
-                    partitioned_packages = resolve_managers_dependencies(partitioned_packages) if enable_recursion
-               end
+                    if enable_recursion
+                        partitioned_packages = resolve_managers_dependencies(partitioned_packages)
+                    end
+                end
             end
             partitioned_packages
         end
 
         # Requests the installation of the given set of packages
-        def install(osdep_packages, all: nil, install_only: false, run_package_managers_without_packages: false, **options)
+        def install(
+            osdep_packages, all: nil, install_only: false,
+            run_package_managers_without_packages: false, **options
+        )
             setup_package_managers(**options)
             partitioned_packages =
                 resolve_and_partition_osdep_packages(osdep_packages, all)
 
             # Install OS packages first, as the other package handlers might
             # depend on OS packages
-            if os_packages = partitioned_packages.delete(os_package_manager)
-                install_manager_packages(os_package_manager, os_packages,
-                                         install_only: install_only,
-                                         run_package_managers_without_packages: run_package_managers_without_packages)
+            if (os_packages = partitioned_packages.delete(os_package_manager))
+                install_manager_packages(
+                    os_package_manager, os_packages,
+                    install_only: install_only,
+                    run_package_managers_without_packages:
+                        run_package_managers_without_packages
+                )
             end
             partitioned_packages.each do |manager, package_list|
-                install_manager_packages(manager, package_list,
-                                         install_only: install_only,
-                                         run_package_managers_without_packages: run_package_managers_without_packages)
+                install_manager_packages(
+                    manager, package_list,
+                    install_only: install_only,
+                    run_package_managers_without_packages:
+                        run_package_managers_without_packages
+                )
             end
         end
 
@@ -445,10 +455,10 @@ So, what do you want ? (all, none or a comma-separated list of: os gem pip)
                 manager.install(
                     list.to_a,
                     filter_uptodate_packages: filter_uptodate_packages?,
-                    install_only: install_only)
+                    install_only: install_only
+                )
                 installed_resolved_packages[manager].merge(list)
             end
         end
     end
 end
-

data/lib/autoproj/os_package_query.rb

@@ -18,10 +18,10 @@ module Autoproj
     #   * package_manager: a regexp that matches the underlying package manager
     #
     class OSPackageQuery < QueryBase
-        ALLOWED_FIELDS = [
-            'name',
-            'real_package',
-            'package_manager'
+        ALLOWED_FIELDS = %w[
+            name
+            real_package
+            package_manager
         ]
         DEFAULT_FIELDS = {
         }
@@ -76,17 +76,11 @@ module Autoproj
                 v.send(field_name)
             end
 
-            if pkg_value.include?(value)
-                return EXACT
-            end
+            return EXACT if pkg_value.include?(value)
 
-            if !partial?
-                return
-            end
+            return unless partial?
 
-            if pkg_value.any? { |v| @value_rx === v }
-                return PARTIAL
-            end
+            PARTIAL if pkg_value.any? { |v| @value_rx === v }
         end
 
         # Parse a single field in a query (i.e. a FIELD[=~]VALUE string)