autoproj 2.12.0 → 2.15.0

data/lib/autoproj/package_set.rb

@@ -8,8 +8,11 @@ module Autoproj
         # loaded is called before {PackageSet#load_description_file} is called
         class NotLoaded < RuntimeError
             attr_reader :package_set
+
             def initialize(package_set)
                 @package_set = package_set
+
+                super()
             end
         end
 
@@ -85,7 +88,9 @@ module Autoproj
 
         # If true, this package set has been loaded because another set imports
         # it. If false, it is loaded explicitely by the user
-        def explicit?; !!@explicit end
+        def explicit?
+            !!@explicit
+        end
         attr_writer :explicit
 
         # Definition of key => value mappings used to resolve e.g. $KEY values
@@ -111,9 +116,12 @@ module Autoproj
         #
         # @see auto_imports?
         attr_writer :auto_imports
+
         # If true (the default), imports listed in this package set will be
         # automatically loaded by autoproj
-        def auto_imports?; !!@auto_imports end
+        def auto_imports?
+            !!@auto_imports
+        end
 
         # The VCS definition entries from the 'imports' section of the YAML file
         # @return [Array<VCSDefinition>]
@@ -147,31 +155,34 @@ module Autoproj
         def initialize(
             ws, vcs,
             name: self.class.name_of(ws, vcs),
-            raw_local_dir: self.class.raw_local_dir_of(ws, vcs))
+            raw_local_dir: self.class.raw_local_dir_of(ws, vcs)
+        )
 
             @ws = ws
             @vcs = vcs
-            if !vcs
+            unless vcs
                 raise ArgumentError, "cannot create a package set with a nil vcs, create a null VCS using VCSDefinition.none"
             end
+
             @name = name
             @os_repository_resolver = OSRepositoryResolver.new
             @os_package_resolver = OSPackageResolver.new(
                 operating_system: ws.os_package_resolver.operating_system,
                 package_managers: ws.os_package_resolver.package_managers,
-                os_package_manager: ws.os_package_resolver.os_package_manager)
+                os_package_manager: ws.os_package_resolver.os_package_manager
+            )
             @importer_definitions_cache = Hash.new
             @all_osdeps = []
             @all_osrepos = []
             @constants_definitions = Hash.new
-            @required_autoproj_version = '0'
+            @required_autoproj_version = "0"
             @version_control = Array.new
             @overrides = Array.new
             @raw_local_dir = raw_local_dir
-            @default_importer = VCSDefinition.from_raw(type: 'none')
+            @default_importer = VCSDefinition.from_raw({ type: "none" })
 
-            @imports  = Set.new
-            @imports_vcs  = Array.new
+            @imports = Set.new
+            @imports_vcs = Array.new
             @imported_from = Array.new
             @explicit = false
             @auto_imports = true
@@ -182,7 +193,8 @@ module Autoproj
             new_osdeps = OSPackageResolver.load(
                 file,
                 suffixes: ws.osdep_suffixes,
-                **options)
+                **options
+            )
             all_osdeps << new_osdeps
             os_package_resolver.merge(all_osdeps.last)
             new_osdeps
@@ -208,16 +220,25 @@ module Autoproj
 
         # True if this source has already been checked out on the local autoproj
         # installation
-        def present?; File.directory?(raw_local_dir) end
+        def present?
+            File.directory?(raw_local_dir)
+        end
+
         # True if this is the main package set (i.e. the main autoproj
         # configuration)
-        def main?; false end
+        def main?
+            false
+        end
+
         # True if this source is local, i.e. is not under a version control
-        def local?; vcs.local? end
+        def local?
+            vcs.local?
+        end
+
         # True if this source defines nothing
         def empty?
             version_control.empty? && overrides.empty?
-                !each_package.find { true } &&
+            !each_package.find { true } &&
                 !File.exist?(File.join(raw_local_dir, "overrides.rb")) &&
                 !File.exist?(File.join(raw_local_dir, "init.rb"))
         end
@@ -239,7 +260,7 @@ module Autoproj
             else
                 package = create_autobuild_package
                 if package.importer.respond_to?(:snapshot)
-                    package.importer.snapshot(package, target_dir, options)
+                    package.importer.snapshot(package, target_dir, **options)
                 end
             end
         end
@@ -254,9 +275,9 @@ module Autoproj
         def self.name_of(ws, vcs, raw_local_dir: raw_local_dir_of(ws, vcs), ignore_load_errors: false)
             if File.directory?(raw_local_dir)
                 begin
-                    return raw_description_file(raw_local_dir, package_set_name: "#{vcs.type}:#{vcs.url}")['name']
+                    return raw_description_file(raw_local_dir, package_set_name: "#{vcs.type}:#{vcs.url}")["name"]
                 rescue ConfigError
-                    raise if !ignore_load_errors
+                    raise unless ignore_load_errors
                 end
             end
             vcs.to_s
@@ -271,7 +292,7 @@ module Autoproj
         def self.raw_local_dir_of(ws, vcs)
             if vcs.needs_import?
                 repository_id = vcs.create_autobuild_importer.repository_id
-                path = File.join(ws.remotes_dir, repository_id.gsub(/[^\w]/, '_'))
+                path = File.join(ws.remotes_dir, repository_id.gsub(/[^\w]/, "_"))
                 File.expand_path(path)
             elsif !vcs.none?
                 File.expand_path(vcs.url)
@@ -279,10 +300,10 @@ module Autoproj
         end
 
         def self.default_expansions(ws)
-            ws.config.to_hash.
-                merge(ws.manifest.constant_definitions).
-                merge("AUTOPROJ_ROOT" => ws.root_dir,
-                      "AUTOPROJ_CONFIG" => ws.config_dir)
+            ws.config.to_hash
+              .merge(ws.manifest.constant_definitions)
+              .merge("AUTOPROJ_ROOT" => ws.root_dir,
+                     "AUTOPROJ_CONFIG" => ws.config_dir)
         end
 
         # Resolve the VCS information for a package set
@@ -297,7 +318,7 @@ module Autoproj
             options, vcs_spec = Kernel.filter_options spec, auto_imports: true
 
             vcs_spec = Autoproj.expand(vcs_spec, vars)
-            return VCSDefinition.from_raw(vcs_spec, from: from, raw: raw), options
+            [VCSDefinition.from_raw(vcs_spec, from: from, raw: raw), options]
         end
 
         # Returns a string that uniquely represents the version control
@@ -328,9 +349,9 @@ module Autoproj
         # For local sources, is simply returns the path to the source directory.
         def user_local_dir
             if local?
-                return vcs.url
+                vcs.url
             else
-                File.join(ws.config_dir, 'remotes', name)
+                File.join(ws.config_dir, "remotes", name)
             end
         end
 
@@ -352,23 +373,23 @@ module Autoproj
         # Validate and normalizes a raw source file
         def self.validate_and_normalize_source_file(yaml_path, yaml)
             yaml = yaml.dup
-            %w{imports version_control}.each do |entry_name|
+            %w[imports version_control].each do |entry_name|
                 yaml[entry_name] ||= Array.new
-                if !yaml[entry_name].respond_to?(:to_ary)
+                unless yaml[entry_name].respond_to?(:to_ary)
                     raise ConfigError.new(yaml_path), "expected the '#{entry_name}' entry to be an array"
                 end
             end
 
-            %w{constants}.each do |entry_name|
+            %w[constants].each do |entry_name|
                 yaml[entry_name] ||= Hash.new
-                if !yaml[entry_name].respond_to?(:to_h)
+                unless yaml[entry_name].respond_to?(:to_h)
                     raise ConfigError.new(yaml_path), "expected the '#{entry_name}' entry to be a map"
                 end
             end
 
-            if yaml.has_key?('overrides')
-                yaml['overrides'] ||= Array.new
-                if !yaml['overrides'].respond_to?(:to_ary)
+            if yaml.has_key?("overrides")
+                yaml["overrides"] ||= Array.new
+                unless yaml["overrides"].respond_to?(:to_ary)
                     raise ConfigError.new(yaml_path), "expected the 'overrides' entry to be an array"
                 end
             end
@@ -384,14 +405,14 @@ module Autoproj
         # @return [Hash] the raw description information
         def self.raw_description_file(raw_local_dir, package_set_name: nil)
             master_source_file = File.join(raw_local_dir, PackageSet.master_source_file)
-            if !File.exist?(master_source_file)
+            unless File.exist?(master_source_file)
                 raise ConfigError.new, "package set #{package_set_name} present in #{raw_local_dir} should have a source.yml file, but does not"
             end
 
             source_definition = Hash.new
             PackageSet.source_files.each do |name|
                 source_file = File.join(raw_local_dir, name)
-                next if !File.file?(source_file)
+                next unless File.file?(source_file)
 
                 newdefs = Autoproj.in_file(source_file, Autoproj::YAML_LOAD_ERROR) do
                     YAML.load(File.read(source_file))
@@ -400,11 +421,12 @@ module Autoproj
                 source_definition.merge!(newdefs) do |k, old, new|
                     if old.respond_to?(:to_ary)
                         old + new
-                    else new
+                    else
+                        new
                     end
                 end
             end
-            if !source_definition['name']
+            unless source_definition["name"]
                 raise ConfigError.new(master_source_file), "#{master_source_file} does not have a 'name' field"
             end
 
@@ -416,7 +438,7 @@ module Autoproj
         # Raises InternalError if the source has not been checked out yet (it
         # should have), and ConfigError if the source.yml file is not valid.
         def raw_description_file
-            if !present?
+            unless present?
                 raise InternalError, "source #{vcs} has not been fetched yet, cannot load description for it"
             end
 
@@ -461,7 +483,7 @@ module Autoproj
         end
 
         # Add a new entry in the list of version control resolutions
-        def add_overrides_entry(matcher, vcs_definition, file: '#add_overrides_entry')
+        def add_overrides_entry(matcher, vcs_definition, file: "#add_overrides_entry")
             if (last_entry = overrides.last) && last_entry[0] == file
                 last_entry[1] << [matcher, vcs_definition]
             else
@@ -471,82 +493,82 @@ module Autoproj
 
         # Path to the source.yml file
         def source_file
-            if local_dir
-                File.join(local_dir, 'source.yml')
-            end
+            File.join(local_dir, "source.yml") if local_dir
         end
 
         # Load the source.yml file and resolves all information it contains.
         def load_description_file
             source_definition = raw_description_file
-            name = source_definition['name']
-            if name !~ /^[\w\.-]+$/
+            name = source_definition["name"]
+            if name !~ /^[\w.-]+$/
                 raise ConfigError.new(source_file),
-                    "in #{source_file}: invalid source name '#{@name}': source names can only contain alphanumeric characters, and .-_"
+                      "in #{source_file}: invalid source name '#{@name}': source names can only contain alphanumeric characters, and .-_"
             elsif name == "local"
                 raise ConfigError.new(source_file),
-                    "in #{source_file}: the name 'local' is a reserved name"
+                      "in #{source_file}: the name 'local' is a reserved name"
             end
 
             parse_source_definition(source_definition)
         end
 
         def load_overrides(source_definition)
-            if data = source_definition['overrides']
+            if (data = source_definition["overrides"])
                 [[source_file, data]]
             end
         end
 
         def parse_source_definition(source_definition)
-            @name = source_definition['name'] || self.name
+            @name = source_definition["name"] || name
             @required_autoproj_version = source_definition.fetch(
-                'required_autoproj_version', self.required_autoproj_version)
+                "required_autoproj_version", required_autoproj_version
+            )
 
             # Compute the definition of constants
-            if new_constants = source_definition['constants']
+            if (new_constants = source_definition["constants"])
                 Autoproj.in_file(source_file) do
                     variables = inject_constants_and_config_for_expansion(Hash.new)
                     @constants_definitions = Autoproj.resolve_constant_definitions(
-                        new_constants, variables)
+                        new_constants, variables
+                    )
                 end
             end
 
-            if new_imports = source_definition['imports']
+            if (new_imports = source_definition["imports"])
                 variables = inject_constants_and_config_for_expansion(Hash.new)
-                @imports_vcs  = Array(new_imports).map do |set_def|
+                @imports_vcs = Array(new_imports).map do |set_def|
                     if !set_def.kind_of?(Hash) && !set_def.respond_to?(:to_str)
                         raise ConfigError.new(source_file), "in #{source_file}: "\
-                            "wrong format for 'imports' section. Expected an array of "\
-                            "maps or strings (e.g. - github: my/url)."
+                                                            "wrong format for 'imports' section. Expected an array of "\
+                                                            "maps or strings (e.g. - github: my/url)."
                     end
 
                     Autoproj.in_file(source_file) do
                         PackageSet.resolve_definition(ws, set_def, from: self,
-                            vars: variables,
-                            raw: [VCSDefinition::RawEntry.new(self, source_file, set_def)])
+                                                                   vars: variables,
+                                                                   raw: [VCSDefinition::RawEntry.new(self, source_file, set_def)])
                     end
                 end
             end
 
-            if new_version_control = source_definition['version_control']
+            if (new_version_control = source_definition["version_control"])
                 invalidate_importer_definitions_cache
-                @version_control = normalize_vcs_list('version_control', source_file,
-                    new_version_control)
+                @version_control = normalize_vcs_list("version_control", source_file,
+                                                      new_version_control)
 
                 Autoproj.in_file(source_file) do
                     default_vcs_spec, raw = version_control_field(
-                        'default', version_control,
-                        file: source_file, section: 'version_control'
+                        "default", version_control,
+                        file: source_file, section: "version_control"
                     )
                     if default_vcs_spec
                         @default_importer = VCSDefinition.from_raw(default_vcs_spec,
-                            raw: raw, from: self)
+                                                                   raw: raw, from: self)
                     end
                 end
             end
-            if new_overrides = load_overrides(source_definition)
+            if (new_overrides = load_overrides(source_definition))
                 @overrides = new_overrides.map do |file, entries|
-                    [file, normalize_vcs_list('overrides', file, entries)]
+                    [file, normalize_vcs_list("overrides", file, entries)]
                 end
             end
         end
@@ -561,16 +583,14 @@ module Autoproj
             defs = Hash[
                 "AUTOPROJ_ROOT" => ws.root_dir,
                 "AUTOPROJ_CONFIG" => ws.config_dir,
-                "AUTOPROJ_SOURCE_DIR" => local_dir].
-                merge(manifest.constant_definitions).
-                merge(constants_definitions).
-                merge(additional_expansions)
+                "AUTOPROJ_SOURCE_DIR" => local_dir]
+                   .merge(manifest.constant_definitions)
+                   .merge(constants_definitions)
+                   .merge(additional_expansions)
 
             config = ws.config
             Hash.new do |h, k|
-                if config.has_value_for?(k) || config.declared?(k)
-                    config.get(k)
-                end
+                config.get(k) if config.has_value_for?(k) || config.declared?(k)
             end.merge(defs)
         end
 
@@ -591,7 +611,7 @@ module Autoproj
         #
         # Converts a number to an ordinal string representation (i.e. 1st, 25th)
         def number_to_nth(number)
-            Hash[1 => '1st', 2 => '2nd', 3 => '3rd'].fetch(number, "#{number}th")
+            Hash[1 => "1st", 2 => "2nd", 3 => "3rd"].fetch(number, "#{number}th")
         end
 
         # @api private
@@ -606,12 +626,23 @@ module Autoproj
 
             list.each_with_index.map do |spec, spec_idx|
                 spec_nth = number_to_nth(spec_idx + 1)
-                if !spec.kind_of?(Hash)
+                unless spec.kind_of?(Hash)
                     raise InvalidYAMLFormatting, "wrong format for the #{spec_nth} entry (#{spec.inspect}) of the #{section_name} section of #{file}, expected a package name, followed by a colon, and one importer option per following line"
                 end
 
                 spec = spec.dup
-                if spec.values.size != 1
+                if spec.values.size == 1
+                    name, spec = spec.to_a.first
+                    if spec.respond_to?(:to_str)
+                        if spec == "none"
+                            spec = Hash["type" => "none"]
+                        else
+                            raise ConfigError.new, "invalid VCS specification in the #{section_name} section of #{file}: '#{name}: #{spec}'. One can only use this shorthand to declare the absence of a VCS with the 'none' keyword"
+                        end
+                    elsif !spec.kind_of?(Hash)
+                        raise InvalidYAMLFormatting, "expected '#{name}:' followed by version control options, but got nothing, in the #{spec_nth} entry of the #{section_name} section of #{file}"
+                    end
+                else
                     # Maybe the user wrote the spec like
                     #   - package_name:
                     #     type: git
@@ -619,29 +650,16 @@ module Autoproj
                     #
                     # In that case, we should have the package name as
                     # "name => nil". Check that.
-                    name, _ = spec.find { |n, v| v.nil? }
+                    name, = spec.find { |n, v| v.nil? }
                     if name
                         spec.delete(name)
                     else
                         raise InvalidYAMLFormatting, "cannot make sense of the #{spec_nth} entry in the #{section_name} section of #{file}: #{spec}"
                     end
-                else
-                    name, spec = spec.to_a.first
-                    if spec.respond_to?(:to_str)
-                        if spec == "none"
-                            spec = Hash['type' => "none"]
-                        else
-                            raise ConfigError.new, "invalid VCS specification in the #{section_name} section of #{file}: '#{name}: #{spec}'. One can only use this shorthand to declare the absence of a VCS with the 'none' keyword"
-                        end
-                    elsif !spec.kind_of?(Hash)
-                        raise InvalidYAMLFormatting, "expected '#{name}:' followed by version control options, but got nothing, in the #{spec_nth} entry of the #{section_name} section of #{file}"
-                    end
                 end
 
                 name_match = name
-                if name_match =~ /[^\w\/-]/
-                    name_match = Regexp.new("^" + name_match)
-                end
+                name_match = Regexp.new("^#{name_match}") if name_match =~ /[^\w\/-]/
 
                 [name_match, spec]
             end
@@ -656,7 +674,7 @@ module Autoproj
         #   The Hash part is nil if there are no matching entries. Hash keys are
         #   normalized to symbols
         def version_control_field(package_name, entry_list, validate: true,
-                                  file: source_file, section: nil)
+            file: source_file, section: nil)
             raw = []
             vcs_spec = entry_list.inject({}) do |resolved_spec, (name_match, spec)|
                 next(resolved_spec) unless name_match === package_name
@@ -666,7 +684,7 @@ module Autoproj
                     VCSDefinition.update_raw_vcs_spec(resolved_spec, spec)
                 rescue ArgumentError => e
                     raise ConfigError.new,
-                          'invalid VCS definition while resolving package '\
+                          "invalid VCS definition while resolving package "\
                           "'#{package_name}', entry '#{name_match}' of "\
                           "#{section ? "section '#{section}'" : ''}: "\
                           "#{e.message}", e.backtrace
@@ -676,8 +694,8 @@ module Autoproj
             return nil, [] if vcs_spec.empty?
 
             expansions = {
-                'PACKAGE' => package_name,
-                'PACKAGE_BASENAME' => File.basename(package_name)
+                "PACKAGE" => package_name,
+                "PACKAGE_BASENAME" => File.basename(package_name)
             }
 
             vcs_spec = expand(vcs_spec, expansions)
@@ -686,7 +704,7 @@ module Autoproj
             end
 
             # Resolve relative paths w.r.t. the workspace root dir
-            if (url = (vcs_spec.delete('url') || vcs_spec.delete(:url)))
+            if (url = (vcs_spec.delete("url") || vcs_spec.delete(:url)))
                 vcs_spec[:url] = VCSDefinition.to_absolute_url(url, ws.root_dir)
             end
 
@@ -697,7 +715,7 @@ module Autoproj
                     VCSDefinition.from_raw(vcs_spec)
                 rescue ArgumentError => e
                     raise ConfigError.new,
-                          'invalid resulting VCS definition for package '\
+                          "invalid resulting VCS definition for package "\
                           "'#{package_name}': #{e.message}",
                           e.backtrace
                 end
@@ -725,7 +743,7 @@ module Autoproj
             importer_definitions_cache[package_name] ||= Autoproj.in_file source_file do
                 vcs_spec, raw = version_control_field(
                     package_name, version_control,
-                    file: source_file, section: 'version_control'
+                    file: source_file, section: "version_control"
                 )
                 if vcs_spec
                     VCSDefinition.from_raw(vcs_spec, raw: raw, from: self)
@@ -758,19 +776,17 @@ module Autoproj
                     Autoproj.in_file file do
                         version_control_field(
                             key, file_overrides,
-                            validate: false, file: file, section: 'overrides'
+                            validate: false, file: file, section: "overrides"
                         )
                     end
 
                 if new_spec
                     Autoproj.in_file file do
-                        begin
-                            vcs = vcs.update(new_spec, raw: new_raw_entry, from: self)
-                        rescue ConfigError => e
-                            raise ConfigError.new, "invalid resulting VCS specification "\
-                                                   "in the overrides section for "\
-                                                   "#{key}: #{e.message}"
-                        end
+                        vcs = vcs.update(new_spec, raw: new_raw_entry, from: self)
+                    rescue ConfigError => e
+                        raise ConfigError.new,
+                              "invalid resulting VCS specification in the overrides "\
+                              "section for #{key}: #{e.message}"
                     end
                 end
             end
@@ -780,20 +796,17 @@ module Autoproj
         # Enumerates the Autobuild::Package instances that are defined in this
         # source
         def each_package
-            if !block_given?
-                return enum_for(:each_package)
-            end
+            return enum_for(:each_package) unless block_given?
 
             manifest.each_package_definition do |pkg|
-                if pkg.package_set == self
-                    yield(pkg.autobuild)
-                end
+                yield(pkg.autobuild) if pkg.package_set == self
             end
         end
 
         # List the autobuild files that are part of this package set
         def each_autobuild_file
-            return enum_for(__method__) if !block_given?
+            return enum_for(__method__) unless block_given?
+
             Dir.glob(File.join(local_dir, "*.autobuild")).sort.each do |file|
                 yield(file)
             end
@@ -802,7 +815,8 @@ module Autoproj
         # Yields each osdeps definition files that are present in this package
         # set
         def each_osdeps_file
-            return enum_for(__method__) if !block_given?
+            return enum_for(__method__) unless block_given?
+
             Dir.glob(File.join(local_dir, "*.osdeps")).each do |file|
                 yield(file)
             end
@@ -811,11 +825,11 @@ module Autoproj
         # Yields each osdeps definition files that are present in this package
         # set
         def each_osrepos_file
-            return enum_for(__method__) if !block_given?
+            return enum_for(__method__) unless block_given?
+
             Dir.glob(File.join(local_dir, "*.osrepos")).each do |file|
                 yield(file)
             end
         end
     end
 end
-