autoproj 2.12.0 → 2.15.0

data/lib/autoproj/package_managers/shell_script_manager.rb

@@ -5,50 +5,56 @@ module Autoproj
         class ShellScriptManager < Manager
             def self.execute(command_line, with_locking, with_root, env: Autobuild.env)
                 if with_locking
-                    File.open('/tmp/autoproj_osdeps_lock', 'w') do |lock_io|
-                        begin
-                            while !lock_io.flock(File::LOCK_EX | File::LOCK_NB)
-                                Autoproj.message "  waiting for other autoproj instances to finish their osdeps installation"
-                                sleep 5
-                            end
-                            return execute(command_line, false, with_root, env: env)
-                        ensure
-                            lock_io.flock(File::LOCK_UN)
+                    File.open("/tmp/autoproj_osdeps_lock", "w") do |lock_io|
+                        until lock_io.flock(File::LOCK_EX | File::LOCK_NB)
+                            Autoproj.message "  waiting for other autoproj "\
+                                             "instances to finish their osdeps "\
+                                             "installation"
+                            sleep 5
                         end
+                        return execute(command_line, false, with_root, env: env)
+                    ensure
+                        lock_io.flock(File::LOCK_UN)
                     end
                 end
-                
+
                 if with_root
-                    sudo = Autobuild.tool_in_path('sudo', env: env)
+                    sudo = Autobuild.tool_in_path("sudo", env: env)
                     command_line = [sudo, *command_line]
                 end
 
-                Autobuild::Subprocess.run 'autoproj', 'osdeps', *command_line
+                Autobuild::Subprocess.run "autoproj", "osdeps", *command_line
             end
 
             # Overrides the {#needs_locking?} flag
             attr_writer :needs_locking
+
             # Whether two autoproj instances can run this package manager at the
             # same time
             #
             # This declares if this package manager cannot be used concurrently.
             # If it is the case, autoproj will ensure that there is no two
             # autoproj instances running this package manager at the same time
-            # 
+            #
             # @return [Boolean]
             # @see needs_locking=
-            def needs_locking?; !!@needs_locking end
+            def needs_locking?
+                @needs_locking
+            end
 
             # Overrides the {#needs_root?} flag
             attr_writer :needs_root
+
             # Whether this package manager needs root access.
             #
             # This declares if the command line(s) for this package manager
             # should be started as root. Root access is provided using sudo
-            # 
+            #
             # @return [Boolean]
             # @see needs_root=
-            def needs_root?; !!@needs_root end
+            def needs_root?
+                @needs_root
+            end
 
             # Command line used by autoproj to install packages
             #
@@ -83,10 +89,13 @@ module Autoproj
             #   itself, see {#auto_install_cmd}.
             # @param [Boolean] needs_root if the command lines should be started
             #   as root or not. See {#needs_root?}
-            def initialize(ws, needs_locking, user_install_cmd, auto_install_cmd,needs_root=true)
+            def initialize(ws, needs_locking, user_install_cmd,
+                auto_install_cmd, needs_root = true)
                 super(ws)
-                @needs_locking, @user_install_cmd, @auto_install_cmd,@needs_root =
-                    needs_locking, user_install_cmd, auto_install_cmd, needs_root
+                @needs_locking = needs_locking
+                @user_install_cmd = user_install_cmd
+                @auto_install_cmd = auto_install_cmd
+                @needs_root = needs_root
             end
 
             # Generate the shell script that would allow the user to install
@@ -98,10 +107,12 @@ module Autoproj
             #   command-line pattern that should be used to generate the script.
             #   If given, it overrides the default value stored in
             #   {#user_install_cmd]
-            def generate_user_os_script(os_packages, user_install_cmd: self.user_install_cmd)
+            def generate_user_os_script(os_packages,
+                user_install_cmd: self.user_install_cmd)
                 if user_install_cmd
-                    user_install_cmd.join(" ") + " " + os_packages.join("' '")
-                else generate_auto_os_script(os_packages)
+                    generate_script(user_install_cmd, os_packages)
+                else
+                    generate_auto_os_script(os_packages)
                 end
             end
 
@@ -114,8 +125,16 @@ module Autoproj
             #   command-line pattern that should be used to generate the script.
             #   If given, it overrides the default value stored in
             #   {#auto_install_cmd]
-            def generate_auto_os_script(os_packages, auto_install_cmd: self.auto_install_cmd)
-                auto_install_cmd.join(" ") + " " + os_packages.join("' '")
+            def generate_auto_os_script(os_packages,
+                auto_install_cmd: self.auto_install_cmd)
+                generate_script(auto_install_cmd, os_packages)
+            end
+
+            # Helper for {#generate_user_os_script} and {#generate_auto_os_script}
+            def generate_script(cmd, args)
+                cmd = cmd.join(" ")
+                args = args.join("' '")
+                "#{cmd} #{args}"
             end
 
             # Handles interaction with the user
@@ -139,9 +158,11 @@ module Autoproj
                 # anyway, do so now
                 puts <<-EOMSG
 
-                #{Autoproj.color("The build process and/or the packages require some other software to be installed", :bold)}
-                #{Autoproj.color("and you required autoproj to not install them itself", :bold)}
-                #{Autoproj.color("\nIf these packages are already installed, simply ignore this message\n", :red) if !respond_to?(:filter_uptodate_packages)}
+                #{Autoproj.color('The build process and/or the packages require some other software to be installed', :bold)}
+                #{Autoproj.color('and you required autoproj to not install them itself', :bold)}
+                #{unless respond_to?(:filter_uptodate_packages)
+                      Autoproj.color('\nIf these packages are already installed, simply ignore this message\n', :red)
+                  end}
     The following packages are available as OS dependencies, i.e. as prebuilt
     packages provided by your distribution / operating system. You will have to
     install them manually if they are not already installed
@@ -152,8 +173,8 @@ module Autoproj
 
                 #{shell_script.split("\n").join("\n|   ")}
 
-            EOMSG
-                print "    #{Autoproj.color("Press ENTER to continue ", :bold)}"
+                EOMSG
+                print "    #{Autoproj.color('Press ENTER to continue ', :bold)}"
                 STDOUT.flush
                 STDIN.readline
                 puts
@@ -172,23 +193,33 @@ module Autoproj
             #   packages. See the option in {#generate_auto_os_script}
             # @return [Boolean] true if packages got installed, false otherwise
             def install(packages, filter_uptodate_packages: false, install_only: false,
-                        auto_install_cmd: self.auto_install_cmd, user_install_cmd: self.user_install_cmd)
+                auto_install_cmd: self.auto_install_cmd,
+                user_install_cmd: self.user_install_cmd)
                 return if packages.empty?
 
                 handled_os = ws.supported_operating_system?
                 if handled_os
-                    shell_script = generate_auto_os_script(packages, auto_install_cmd: auto_install_cmd)
-                    user_shell_script = generate_user_os_script(packages, user_install_cmd: user_install_cmd)
+                    shell_script = generate_auto_os_script(
+                        packages, auto_install_cmd: auto_install_cmd
+                    )
+                    user_shell_script = generate_user_os_script(
+                        packages, user_install_cmd: user_install_cmd
+                    )
                 end
                 if osdeps_interaction(packages, user_shell_script)
-                    Autoproj.message "  installing OS packages: #{packages.sort.join(", ")}"
+                    Autoproj.message "  installing OS packages: "\
+                                     "#{packages.sort.join(', ')}"
 
                     if Autoproj.verbose
-                        Autoproj.message "Generating installation script for non-ruby OS dependencies"
+                        Autoproj.message "Generating installation script for "\
+                                         "non-ruby OS dependencies"
                         Autoproj.message shell_script
                     end
 
-                    ShellScriptManager.execute([*auto_install_cmd, *packages], needs_locking?, needs_root?, env: ws.env)
+                    ShellScriptManager.execute(
+                        [*auto_install_cmd, *packages], needs_locking?,
+                        needs_root?, env: ws.env
+                    )
                     return true
                 end
                 false
@@ -196,4 +227,3 @@ module Autoproj
         end
     end
 end
-

data/lib/autoproj/package_managers/unknown_os_manager.rb

@@ -10,8 +10,8 @@ module Autoproj
 
             def osdeps_interaction_unknown_os(osdeps)
                 puts <<-EOMSG
-  #{Autoproj.color("The build process requires some other software packages to be installed on our operating system", :bold)}
-  #{Autoproj.color("If they are already installed, simply ignore this message", :red)}
+  #{Autoproj.color('The build process requires some other software packages to be installed on our operating system', :bold)}
+  #{Autoproj.color('If they are already installed, simply ignore this message', :red)}
 
     #{osdeps.to_a.sort.join("\n    ")}
 
@@ -25,18 +25,15 @@ module Autoproj
 
             def install(osdeps)
                 if silent?
-                    return false
+                    false
                 else
                     osdeps = osdeps.to_set
                     osdeps -= @installed_osdeps
-                    if !osdeps.empty?
-                        result = osdeps_interaction_unknown_os(osdeps)
-                    end
+                    result = osdeps_interaction_unknown_os(osdeps) unless osdeps.empty?
                     @installed_osdeps |= osdeps
-                    return result
+                    result
                 end
             end
         end
     end
 end
-

data/lib/autoproj/package_managers/yum_manager.rb

@@ -4,8 +4,8 @@ module Autoproj
         class YumManager < ShellScriptManager
             def initialize(ws)
                 super(ws, true,
-                      %w{yum install},
-                      %w{yum install -y})
+                      %w[yum install],
+                      %w[yum install -y])
             end
 
             def filter_uptodate_packages(packages)
@@ -17,15 +17,17 @@ module Autoproj
                     line = line.strip
                     if line =~ /package (.*) is not installed/
                         package_name = $1
-                        if !packages.include?(package_name) # something is wrong, fallback to installing everything
+                        unless packages.include?(package_name) # something is wrong, fallback to installing everything
                             return packages
                         end
+
                         new_packages << package_name
-                    else 
+                    else
                         package_name = line.strip
-                        if !packages.include?(package_name) # something is wrong, fallback to installing everything
+                        unless packages.include?(package_name) # something is wrong, fallback to installing everything
                             return packages
                         end
+
                         installed_packages << package_name
                     end
                 end
@@ -33,21 +35,17 @@ module Autoproj
             end
 
             def install(packages, filter_uptodate_packages: false, install_only: false)
-                if filter_uptodate_packages
-                    packages = filter_uptodate_packages(packages)
-                end
+                packages = filter_uptodate_packages(packages) if filter_uptodate_packages
 
                 patterns, packages = packages.partition { |pkg| pkg =~ /^@/ }
                 patterns = patterns.map { |str| str[1..-1] }
                 result = false
-                if !patterns.empty?
+                unless patterns.empty?
                     result |= super(patterns,
-                                    auto_install_cmd: %w{yum groupinstall -y},
-                                    user_install_cmd: %w{yum groupinstall})
-                end
-                if !packages.empty?
-                    result |= super(packages)
+                                    auto_install_cmd: %w[yum groupinstall -y],
+                                    user_install_cmd: %w[yum groupinstall])
                 end
+                result |= super(packages) unless packages.empty?
                 if result
                     # Invalidate caching of installed packages, as we just
                     # installed new packages !
@@ -57,4 +55,3 @@ module Autoproj
         end
     end
 end
-

data/lib/autoproj/package_managers/zypper_manager.rb

@@ -1,21 +1,21 @@
 module Autoproj
     module PackageManagers
-        #Package manger for OpenSuse and Suse (untested)
+        # Package manger for OpenSuse and Suse (untested)
         class ZypperManager < ShellScriptManager
             def initialize(ws)
                 super(ws, true,
-                        %w{zypper install},
-                        %w{zypper -n install})
+                        %w[zypper install],
+                        %w[zypper -n install])
             end
 
             def filter_uptodate_packages(packages)
                 `LANG=C rpm -q --whatprovides '#{packages.join("' '")}'`
                 has_all_pkgs = $?.success?
 
-                if !has_all_pkgs
-                    return packages # let zypper filter, we need root now anyways
-                else 
-                    return []
+                if has_all_pkgs
+                    []
+                else
+                    packages # let zypper filter, we need root now anyways
                 end
             end
 
@@ -27,14 +27,12 @@ module Autoproj
                 patterns, packages = packages.partition { |pkg| pkg =~ /^@/ }
                 patterns = patterns.map { |str| str[1..-1] }
                 result = false
-                if !patterns.empty?
+                unless patterns.empty?
                     result |= super(patterns,
-                                    auto_install_cmd: %w{zypper --non-interactive install --type pattern},
-                                    user_install_cmd: %w{zypper install --type pattern})
-                end
-                if !packages.empty?
-                    result |= super(packages)
+                                    auto_install_cmd: %w[zypper --non-interactive install --type pattern],
+                                    user_install_cmd: %w[zypper install --type pattern])
                 end
+                result |= super(packages) unless packages.empty?
                 if result
                     # Invalidate caching of installed packages, as we just
                     # installed new packages !
@@ -44,4 +42,3 @@ module Autoproj
         end
     end
 end
-

data/lib/autoproj/package_manifest.rb

@@ -30,13 +30,15 @@ module Autoproj
         # @param [Boolean] ros_manifest whether the file follows the ROS format
         # @return [PackageManifest]
         # @see load
-        def self.parse(package, contents, path: '<loaded from string>', loader_class: Loader)
+        def self.parse(package, contents,
+            path: "<loaded from string>", loader_class: Loader)
             manifest = PackageManifest.new(package, path)
             loader = loader_class.new(path, manifest)
             begin
                 REXML::Document.parse_stream(contents, loader)
             rescue REXML::ParseException => e
-                raise Autobuild::PackageException.new(package.name, 'prepare'), "invalid #{file}: #{e.message}"
+                raise Autobuild::PackageException.new(package.name, "prepare"),
+                      "invalid #{file}: #{e.message}"
             end
             manifest
         end
@@ -45,7 +47,7 @@ module Autoproj
         Dependency  = Struct.new :name, :optional, :modes
 
         # The Autobuild::Package instance this manifest applies on
-        attr_reader :package
+        attr_accessor :package
         attr_reader :path
         attr_accessor :description
         attr_accessor :brief_description
@@ -64,7 +66,7 @@ module Autoproj
         end
 
         def has_documentation?
-            !!description
+            description
         end
 
         def documentation
@@ -72,7 +74,7 @@ module Autoproj
         end
 
         def has_short_documentation?
-            !!brief_description
+            brief_description
         end
 
         def short_documentation
@@ -95,11 +97,12 @@ module Autoproj
         # Whether this is a null manifest (used for packages that have actually
         # no manifest) or not
         def null?
-            !!@null
+            @null
         end
 
-        def each_dependency(in_modes = Array.new, &block)
-            return enum_for(__method__, in_modes) if !block_given?
+        def each_dependency(in_modes = [])
+            return enum_for(__method__, in_modes) unless block_given?
+
             dependencies.each do |dep|
                 if dep.modes.empty? || in_modes.any? { |m| dep.modes.include?(m) }
                     yield(dep.name, dep.optional)
@@ -108,24 +111,28 @@ module Autoproj
         end
 
         def each_os_dependency(modes = Array.new, &block)
-            Autoproj.warn_deprecated "#{self.class}##{__method__}", "call #each_dependency instead"
-            return each_dependency(modes, &block)
+            Autoproj.warn_deprecated "#{self.class}##{__method__}",
+                                     "call #each_dependency instead"
+            each_dependency(modes, &block)
         end
 
         def each_package_dependency(modes = Array.new, &block)
-            Autoproj.warn_deprecated "#{self.class}##{__method__}", "call #each_dependency instead"
-            return each_dependency(modes, &block)
+            Autoproj.warn_deprecated "#{self.class}##{__method__}",
+                                     "call #each_dependency instead"
+            each_dependency(modes, &block)
         end
 
         def each_rock_maintainer
-            return enum_for(__method__) if !block_given?
+            return enum_for(__method__) unless block_given?
+
             rock_maintainers.each do |m|
                 yield(m.name, m.email)
             end
         end
 
         def each_maintainer
-            return enum_for(__method__) if !block_given?
+            return enum_for(__method__) unless block_given?
+
             maintainers.each do |m|
                 yield(m.name, m.email)
             end
@@ -134,7 +141,8 @@ module Autoproj
         # Enumerates the name and email of each author. If no email is present,
         # yields (name, nil)
         def each_author
-            return enum_for(__method__) if !block_given?
+            return enum_for(__method__) unless block_given?
+
             authors.each do |m|
                 yield(m.name, m.email)
             end
@@ -177,64 +185,66 @@ module Autoproj
             end
 
             def parse_depend_tag(tag_name, attributes, modes: [], optional: false)
-                package = attributes['package'] || attributes['name']
-                if !package
-                    raise InvalidPackageManifest, "found '#{tag_name}' tag in #{path} without a 'package' attribute"
+                package = attributes["package"] || attributes["name"]
+                unless package
+                    raise InvalidPackageManifest,
+                          "found '#{tag_name}' tag in #{path} "\
+                          "without a 'package' attribute"
                 end
 
-                if tag_modes = attributes['modes']
-                    modes += tag_modes.split(',')
+                if (tag_modes = attributes["modes"])
+                    modes += tag_modes.split(",")
                 end
 
                 manifest.add_dependency(
                     package,
-                    optional: optional || (attributes['optional'] == '1'),
-                    modes: modes)
+                    optional: optional || (attributes["optional"] == "1"),
+                    modes: modes
+                )
             end
 
             def parse_contact_field(text)
-                text.strip.split(',').map do |str|
-                    name, email = str.split('/').map(&:strip)
-                    email = nil if email && email.empty?
+                text.strip.split(",").map do |str|
+                    name, email = str.split("/").map(&:strip)
+                    email = nil if email&.empty?
                     ContactInfo.new(name, email)
                 end
             end
 
-            TEXT_FIELDS = Set['url', 'license', 'version', 'description']
-            AUTHOR_FIELDS = Set['author', 'maintainer', 'rock_maintainer']
+            TEXT_FIELDS = Set["url", "license", "version", "description"]
+            AUTHOR_FIELDS = Set["author", "maintainer", "rock_maintainer"]
 
             def toplevel_tag_start(name, attributes)
-                if name == 'depend'
+                if name == "depend"
                     parse_depend_tag(name, attributes)
-                elsif name == 'depend_optional'
+                elsif name == "depend_optional"
                     parse_depend_tag(name, attributes, optional: true)
-                elsif name == 'rosdep'
+                elsif name == "rosdep"
                     parse_depend_tag(name, attributes)
                 elsif name =~ /^(\w+)_depend$/
                     parse_depend_tag(name, attributes, modes: [$1])
-                elsif name == 'description'
-                    if brief = attributes['brief']
+                elsif name == "description"
+                    if (brief = attributes["brief"])
                         manifest.brief_description = brief
                     end
-                    @tag_text = ''
+                    @tag_text = ""
                 elsif TEXT_FIELDS.include?(name) || AUTHOR_FIELDS.include?(name)
-                    @tag_text = ''
-                elsif name == 'tags'
-                    @tag_text = ''
+                    @tag_text = ""
+                elsif name == "tags"
+                    @tag_text = ""
                 else
                     @tag_text = nil
                 end
             end
+
             def toplevel_tag_end(name)
                 if AUTHOR_FIELDS.include?(name)
                     manifest.send("#{name}s").concat(parse_contact_field(@tag_text))
                 elsif TEXT_FIELDS.include?(name)
                     field = @tag_text.strip
-                    if !field.empty?
-                        manifest.send("#{name}=", field)
-                    end
-                elsif name == 'tags'
-                    manifest.tags.concat(@tag_text.strip.split(',').map(&:strip))
+                    manifest.send("#{name}=", field) unless field.empty?
+                elsif name == "tags"
+                    manifest.tags.concat(@tag_text.strip.split(",").map(&:strip))
                 end
                 @tag_text = nil
             end
@@ -245,19 +255,19 @@ module Autoproj
         # REXML stream parser object used to load the XML contents into a
         # {PackageManifest} object
         class RosLoader < Loader
-            SUPPORTED_MODES = ['test', 'doc'].freeze
-            DEPEND_TAGS = Set['depend', 'build_depend', 'build_export_depend',
-                              'buildtool_depend', 'buildtool_export_depend',
-                              'exec_depend', 'test_depend', 'run_depend', 'doc_depend']
+            SUPPORTED_MODES = %w[test doc].freeze
+            DEPEND_TAGS = %w[depend build_depend build_export_depend
+                             buildtool_depend buildtool_export_depend
+                             exec_depend test_depend run_depend doc_depend].to_set.freeze
 
             def toplevel_tag_start(name, attributes)
                 if DEPEND_TAGS.include?(name)
-                    @tag_text = ''
+                    @tag_text = ""
                 elsif TEXT_FIELDS.include?(name)
-                    @tag_text = ''
+                    @tag_text = ""
                 elsif AUTHOR_FIELDS.include?(name)
-                    @author_email = attributes['email']
-                    @tag_text = ''
+                    @author_email = attributes["email"]
+                    @tag_text = ""
                 else
                     @tag_text = nil
                 end
@@ -265,18 +275,21 @@ module Autoproj
 
             def toplevel_tag_end(name)
                 if DEPEND_TAGS.include?(name)
-                    raise InvalidPackageManifest, "found '#{name}' tag in #{path} without content" if @tag_text.strip.empty?
+                    if @tag_text.strip.empty?
+                        raise InvalidPackageManifest, "found '#{name}' tag in #{path} "\
+                                                      "without content"
+                    end
 
                     mode = []
-                    if name =~ /^(\w+)_depend$/
-                        mode = SUPPORTED_MODES & [$1]
+                    if (m = /^(\w+)_depend$/.match(name))
+                        mode = SUPPORTED_MODES & [m[1]]
                     end
 
                     manifest.add_dependency(@tag_text, modes: mode)
                 elsif AUTHOR_FIELDS.include?(name)
                     author_name = @tag_text.strip
                     email = @author_email ? @author_email.strip : nil
-                    email = nil if email && email.empty?
+                    email = nil if email&.empty?
                     contact = ContactInfo.new(author_name, email)
                     manifest.send("#{name}s").concat([contact])
                 elsif TEXT_FIELDS.include?(name)