autoproj 2.14.0 → 2.15.0

data/lib/autoproj/configuration.rb

@@ -1,8 +1,8 @@
-require 'backports/2.4.0/float/dup'
-require 'backports/2.4.0/fixnum/dup'
-require 'backports/2.4.0/nil_class/dup'
-require 'backports/2.4.0/false_class/dup'
-require 'backports/2.4.0/true_class/dup'
+require "backports/2.4.0/float/dup"
+require "backports/2.4.0/fixnum/dup"
+require "backports/2.4.0/nil_class/dup"
+require "backports/2.4.0/false_class/dup"
+require "backports/2.4.0/true_class/dup"
 
 module Autoproj
     # Class that does the handling of configuration options as well as
@@ -89,14 +89,13 @@ module Autoproj
             overrides[option_name] = value
         end
 
-        # Remove a specific override
-        def reset_overrides(name)
-            @overrides.delete(name)
-        end
-
         # Remove all overrides
-        def reset_overrides
-            @overrides.clear
+        def reset_overrides(*names)
+            if names.empty?
+                @overrides.clear
+            else
+                names.each { |n| @overrides.delete(n) }
+            end
         end
 
         # Tests whether a value is set for the given option name
@@ -108,32 +107,26 @@ module Autoproj
 
         # Get the value for a given option
         def get(key, *default_value)
-            if overrides.has_key?(key)
-                return overrides[key].dup
-            end
+            return overrides[key].dup if overrides.has_key?(key)
 
             has_value = config.has_key?(key)
             value, validated = config[key]
 
             if !declared?(key)
                 if has_value
-                    return value.dup
+                    value.dup
                 elsif default_value.empty?
                     raise ConfigError, "undeclared option '#{key}'"
                 else
                     default_value.first.dup
                 end
+            elsif validated
+                doc = declared_options[key].short_doc
+                doc = "#{doc}:" if doc[-1, 1] != "?"
+                displayed_options[key] = value
+                value.dup
             else
-                if validated
-                    doc = declared_options[key].short_doc
-                    if doc[-1, 1] != "?"
-                        doc = "#{doc}:"
-                    end
-                    displayed_options[key] = value
-                    value.dup
-                else
-                    configure(key).dup
-                end
+                configure(key).dup
             end
         end
 
@@ -184,8 +177,8 @@ module Autoproj
         # @return [Object] the new option value
         # @raise ConfigError if the option is not declared
         def configure(option_name)
-            if opt = declared_options[option_name]
-                if current_value = config[option_name]
+            if (opt = declared_options[option_name])
+                if (current_value = config[option_name])
                     current_value = current_value.first
                 end
                 is_default = false
@@ -210,15 +203,13 @@ module Autoproj
 
         def load(path: self.path, reconfigure: false)
             current_keys = @config.keys
-            if h = YAML.load(File.read(path))
-                h.each do |key, value|
-                    current_keys.delete(key)
-                    set(key, value, !reconfigure)
-                end
-                if current_keys.empty?
-                    @modified = false
-                end
+            return unless (h = YAML.load(File.read(path)))
+
+            h.each do |key, value|
+                current_keys.delete(key)
+                set(key, value, !reconfigure)
             end
+            @modified = false if current_keys.empty?
         end
 
         def reconfigure!
@@ -245,35 +236,36 @@ module Autoproj
         end
 
         def each_reused_autoproj_installation(&block)
-            if has_value_for?('reused_autoproj_installations')
-                get('reused_autoproj_installations').each(&block)
-            else [].each(&block)
+            if has_value_for?("reused_autoproj_installations")
+                get("reused_autoproj_installations").each(&block)
+            else
+                [].each(&block)
             end
         end
 
         def import_log_enabled?
-            get('import_log_enabled', true)
+            get("import_log_enabled", true)
         end
 
         def import_log_enabled=(value)
-            set('import_log_enabled', !!value)
+            set("import_log_enabled", !!value)
         end
 
         def parallel_build_level
-            get('parallel_build_level', nil) || Autobuild.parallel_build_level
+            get("parallel_build_level", nil) || Autobuild.parallel_build_level
         end
 
         def parallel_build_level=(level)
-            set('parallel_build_level', level)
+            set("parallel_build_level", level)
             Autobuild.parallel_build_level = level
         end
 
         def parallel_import_level
-            get('parallel_import_level', 10)
+            get("parallel_import_level", 10)
         end
 
         def parallel_import_level=(level)
-            set('parallel_import_level', level)
+            set("parallel_import_level", level)
         end
 
         # The user-wide place where RubyGems installs gems
@@ -283,8 +275,8 @@ module Autoproj
 
         # The Ruby platform and version-specific subdirectory used by bundler and rubygem
         def self.gems_path_suffix
-            @gems_path_suffix ||= Pathname.new(Gem.user_dir).
-                relative_path_from(Pathname.new(dot_gem_dir)).to_s
+            @gems_path_suffix ||= Pathname.new(Gem.user_dir)
+                                          .relative_path_from(Pathname.new(dot_gem_dir)).to_s
         end
 
         # The gem install root into which the workspace gems are installed
@@ -300,7 +292,7 @@ module Autoproj
         # @param [Workspace] ws the workspace whose gems are being considered
         # @return [String]
         def gems_install_path
-            get('gems_install_path')
+            get("gems_install_path")
         end
 
         # The GEM_HOME into which the workspace gems are installed
@@ -313,55 +305,54 @@ module Autoproj
 
         # The full path to the expected ruby executable
         def ruby_executable
-            if path = get('ruby_executable', nil)
-                path
-            else
+            unless (path = get("ruby_executable", nil))
                 path = OSPackageResolver.autodetect_ruby_program
-                set('ruby_executable', path, true)
-                path
+                set("ruby_executable", path, true)
             end
+
+            path
         end
 
         # Verify that the Ruby executable that is being used to run autoproj
         # matches the one expected in the configuration
         def validate_ruby_executable
-            actual   = OSPackageResolver.autodetect_ruby_program
-            if has_value_for?('ruby_executable')
-                expected = get('ruby_executable')
+            actual = OSPackageResolver.autodetect_ruby_program
+            if has_value_for?("ruby_executable")
+                expected = get("ruby_executable")
                 if expected != actual
                     raise ConfigError.new, "this autoproj installation was bootstrapped using #{expected}, but you are currently running under #{actual}. Changing the Ruby executable for in an existing autoproj workspace is unsupported"
                 end
             else
-                set('ruby_executable', actual, true)
+                set("ruby_executable", actual, true)
             end
         end
 
         def use_prerelease?
             use_prerelease =
-                if env_flag = ENV['AUTOPROJ_USE_PRERELEASE']
-                    env_flag == '1'
-                elsif has_value_for?('autoproj_use_prerelease')
-                    get('autoproj_use_prerelease')
+                if (env_flag = ENV["AUTOPROJ_USE_PRERELEASE"])
+                    env_flag == "1"
+                elsif has_value_for?("autoproj_use_prerelease")
+                    get("autoproj_use_prerelease")
                 end
             set "autoproj_use_prerelease", (use_prerelease ? true : false), true
             use_prerelease
         end
 
         def shell_helpers?
-            get 'shell_helpers', true
+            get "shell_helpers", true
         end
 
         def shell_helpers=(flag)
-            set 'shell_helpers', flag, true
+            set "shell_helpers", flag, true
         end
 
         def bundler_version
-            get 'bundler_version', nil
+            get "bundler_version", nil
         end
 
         def apply_autobuild_configuration
-            if has_value_for?('autobuild')
-                params = get('autobuild')
+            if has_value_for?("autobuild")
+                params = get("autobuild")
                 if params.kind_of?(Hash)
                     params.each do |k, v|
                         Autobuild.send("#{k}=", v)
@@ -372,17 +363,17 @@ module Autoproj
 
         # A cache directory for autobuild's importers
         def importer_cache_dir
-            get('importer_cache_dir', nil)
+            get("importer_cache_dir", nil)
         end
 
         # Set import and gem cache directory
         def importer_cache_dir=(path)
-            set('importer_cache_dir', path, true)
+            set("importer_cache_dir", path, true)
         end
 
         # Sets the directory in which packages will be installed
         def prefix_dir=(path)
-            set('prefix', path, true)
+            set("prefix", path, true)
         end
 
         # The directory in which packages will be installed.
@@ -394,19 +385,19 @@ module Autoproj
         #
         # @return [String]
         def prefix_dir
-            get('prefix', 'install')
+            get("prefix", "install")
         end
 
         # Sets the shells used in this workspace.
         def user_shells=(shells)
-            set('user_shells', shells, true)
+            set("user_shells", shells, true)
         end
 
         # The shells used in this workspace.
         #
         # @return [Array<String>]
         def user_shells
-            get('user_shells', [])
+            get("user_shells", [])
         end
 
         # Defines the temporary area in which packages should put their build
@@ -420,7 +411,7 @@ module Autoproj
         #
         # @return [String]
         def build_dir
-            get('build', 'build')
+            get("build", "build")
         end
 
         # Defines a folder to which source packages will be layed out relative to
@@ -432,7 +423,7 @@ module Autoproj
         #
         # @return [String,nil]
         def source_dir
-            get('source', nil)
+            get("source", nil)
         end
 
         # Returns true if there should be one prefix per package
@@ -441,14 +432,14 @@ module Autoproj
         #
         # @return [Boolean]
         def separate_prefixes?
-            get('separate_prefixes', false)
+            get("separate_prefixes", false)
         end
 
         # Controls whether there should be one prefix per package
         #
         # @see separate_prefixes?
         def separate_prefixes=(flag)
-            set('separate_prefixes', flag, true)
+            set("separate_prefixes", flag, true)
         end
 
         # Returns true if packages and prefixes should be auto-generated, based
@@ -459,7 +450,7 @@ module Autoproj
         #
         # @return [Boolean]
         def randomize_layout?
-            get('randomize_layout', false)
+            get("randomize_layout", false)
         end
 
         # Sets whether the layout should be randomized
@@ -467,7 +458,7 @@ module Autoproj
         # @return [Boolean]
         # @see randomize_layout?
         def randomize_layout=(value)
-            set('randomize_layout', value, true)
+            set("randomize_layout", value, true)
         end
 
         # Returns true if the configuration should be performed interactively
@@ -477,17 +468,18 @@ module Autoproj
         def interactive?
             if !interactive.nil?
                 return interactive
-            elsif ENV['AUTOPROJ_NONINTERACTIVE'] == '1'
+            elsif ENV["AUTOPROJ_NONINTERACTIVE"] == "1"
                 return false
             elsif has_value_for?("interactive")
-                return get('interactive')
+                return get("interactive")
             end
+
             true
         end
 
         DEFAULT_UTILITY_SETUP = Hash[
-            'doc' => true,
-            'test' => false]
+            "doc" => true,
+            "test" => false]
 
         # The configuration key that should be used to store the utility
         # enable/disable information
@@ -513,7 +505,8 @@ module Autoproj
             utility_config = get(utility_key(utility), Hash.new)
             if utility_config.has_key?(package)
                 utility_config[package]
-            else get("#{utility_key(utility)}_default", DEFAULT_UTILITY_SETUP[utility])
+            else
+                get("#{utility_key(utility)}_default", DEFAULT_UTILITY_SETUP[utility])
             end
         end
 
@@ -596,7 +589,7 @@ module Autoproj
         #
         # This is false by default
         def prefer_indep_over_os_packages?
-            get('prefer_indep_over_os_packages', false)
+            get("prefer_indep_over_os_packages", false)
         end
 
         # The configuration as a key => value map

data/lib/autoproj/environment.rb

@@ -1,7 +1,8 @@
 module Autoproj
     ENV_FILENAME =
         if Autobuild.windows? then "env.bat"
-        else "env.sh"
+        else
+            "env.sh"
         end
 
     class Environment < Autobuild::Environment
@@ -9,7 +10,7 @@ module Autoproj
 
         def prepare(root_dir)
             @root_dir = root_dir
-            set 'AUTOPROJ_CURRENT_ROOT', root_dir
+            set "AUTOPROJ_CURRENT_ROOT", root_dir
             super()
         end
 
@@ -18,30 +19,31 @@ module Autoproj
         end
 
         def env_filename(shell, *subdir)
-            env_filename = if shell == 'sh'
+            env_filename = if shell == "sh"
                                ENV_FILENAME
                            else
-                               (Pathname(ENV_FILENAME).sub_ext '').to_s.concat(".#{shell}")
+                               (Pathname(ENV_FILENAME).sub_ext "").to_s.concat(".#{shell}")
                            end
 
             File.join(root_dir, *subdir, env_filename)
         end
 
         def each_env_filename(*subdir)
-            (['sh'] + Autoproj.workspace.config.user_shells).to_set.each do |shell|
+            (["sh"] + Autoproj.workspace.config.user_shells).to_set.each do |shell|
                 yield shell, env_filename(shell, *subdir)
             end
         end
 
         def export_env_sh(subdir = nil, options = Hash.new)
             if subdir.kind_of?(Hash)
-                subdir, options = nil, subdir
+                options = subdir
+                subdir = nil
             end
             options = validate_options options,
-                shell_helpers: true
+                                       shell_helpers: true
 
             shell_dir = File.expand_path(File.join("..", "..", "shell"), File.dirname(__FILE__))
-            completion_dir = File.join(shell_dir, 'completion')
+            completion_dir = File.join(shell_dir, "completion")
             env_updated = false
 
             each_env_filename(*[subdir].compact) do |shell, filename|
@@ -50,7 +52,9 @@ module Autoproj
                     source_after(helper, shell: shell) if File.file?(helper)
                     %w[alocate alog amake aup autoproj].each do |tool|
                         completion_file = File.join(completion_dir, "#{tool}_#{shell}")
-                        source_after(completion_file, shell: shell) if File.file?(completion_file)
+                        if File.file?(completion_file)
+                            source_after(completion_file, shell: shell)
+                        end
                     end
                 end
 
@@ -59,7 +63,7 @@ module Autoproj
                     rescue SystemCallError
                     end
 
-                StringIO.open(new_content = String.new, 'w') do |io|
+                StringIO.open(new_content = String.new, "w") do |io|
                     if inherit?
                         io.write <<-EOF
                         if test -n "$AUTOPROJ_CURRENT_ROOT" && test "$AUTOPROJ_CURRENT_ROOT" != "#{root_dir}"; then
@@ -84,46 +88,57 @@ module Autoproj
     def self.env_set(name, *value)
         env.set(name, *value)
     end
+
     # @deprecated call Autoproj.env.add instead
     def self.env_add(name, *value)
         env.add(name, *value)
     end
+
     # @deprecated call Autoproj.env.set_path instead
     def self.env_set_path(name, *value)
         env.set_path(name, *value)
     end
+
     # @deprecated call Autoproj.env.add_path instead
     def self.env_add_path(name, *value)
         env.add_path(name, *value)
     end
+
     # @deprecated call Autoproj.env.source_after instead
-    def self.env_source_file(file, shell: 'sh')
+    def self.env_source_file(file, shell: "sh")
         env.source_after(file, shell: shell)
     end
+
     # @deprecated call Autoproj.env.source_after instead
-    def self.env_source_after(file, shell: 'sh')
+    def self.env_source_after(file, shell: "sh")
         env.source_after(file, shell: shell)
     end
+
     # @deprecated call Autoproj.env.source_before instead
-    def self.env_source_before(file, shell: 'sh')
+    def self.env_source_before(file, shell: "sh")
         env.source_before(file, shell: shell)
     end
+
     # @deprecated call Autoproj.env.inherit instead
     def self.env_inherit(*names)
         env.inherit(*names)
     end
+
     # @deprecated use Autoproj.env.isolate instead
     def self.set_initial_env
         isolate_environment
     end
+
     # @deprecated use Autoproj.env.isolate instead
     def self.isolate_environment
         env.isolate
     end
+
     # @deprecated call Autoproj.env.prepare directly
     def self.prepare_environment(env = Autoproj.env, manifest = Autoproj.manifest)
         env.prepare(manifest)
     end
+
     # @deprecated use Autoproj.env.export_env_sh instead
     def self.export_env_sh(subdir = nil)
         env.export_env_sh(subdir)

data/lib/autoproj/exceptions.rb

@@ -1,13 +1,15 @@
-require 'autobuild/exceptions'
+require "autobuild/exceptions"
 
 module Autoproj
     class ConfigError < RuntimeError
         attr_accessor :file
+
         def initialize(file = nil)
             super
             @file = file
         end
     end
+
     class InternalError < RuntimeError; end
 
     class ImportFailed < Autobuild::CompositeException
@@ -48,8 +50,11 @@ module Autoproj
     # Exception raised when a caller requires to use an excluded package
     class ExcludedPackage < ConfigError
         attr_reader :name
+
         def initialize(name)
             @name = name
+
+            super()
         end
     end
 
@@ -65,8 +70,11 @@ module Autoproj
     # selection is completely excluded
     class ExcludedSelection < ConfigError
         attr_reader :selection
+
         def initialize(selection)
             @selection = selection
+
+            super()
         end
     end
 
@@ -90,5 +98,3 @@ module Autoproj
     # Raised by 'which' when an executable cannot be found
     class ExecutableNotFound < ArgumentError; end
 end
-
-

data/lib/autoproj/find_workspace.rb

@@ -1,10 +1,10 @@
-require 'pathname'
-require 'yaml'
+require "pathname"
+require "yaml"
 
 module Autoproj
     # The base path from which we search for workspaces
     def self.default_find_base_dir
-        ENV['AUTOPROJ_CURRENT_ROOT'] || Dir.pwd
+        ENV["AUTOPROJ_CURRENT_ROOT"] || Dir.pwd
     end
 
     # Looks for the autoproj workspace that is related to a given directory
@@ -29,19 +29,16 @@ module Autoproj
     #   if base_dir is not part of a workspace
     def self.find_v2_workspace_config(base_dir)
         path = Pathname.new(base_dir).expand_path
-        while !path.root?
-            if (path + ".autoproj" + "config.yml").exist?
-                break
-            end
+        until path.root?
+            break if path.join(".autoproj", "config.yml").exist?
+
             path = path.parent
         end
 
-        if path.root?
-            return
-        end
+        return if path.root?
 
-        config_path = path + ".autoproj" + "config.yml"
-        return path.to_s, (YAML.load(config_path.read) || Hash.new)
+        config_path = path.join(".autoproj", "config.yml")
+        [path.to_s, (YAML.load(config_path.read) || Hash.new)]
     end
 
     # @private
@@ -58,17 +55,18 @@ module Autoproj
     #   there's none
     def self.find_v2_root_dir(base_dir, config_field_name)
         path, config = find_v2_workspace_config(base_dir)
-        return if !path
+        return unless path
+
         result = config[config_field_name] || path.to_s
         result = File.expand_path(result, path.to_s)
-        if result == path.to_s
-            return result
-        end
+        return result if result == path.to_s
+
         resolved = find_v2_root_dir(result, config_field_name)
 
         if !resolved || (resolved != result)
             raise ArgumentError, "found #{path} as possible workspace root for #{base_dir}, but it contains a configuration file that points to #{result} and #{result} is not an autoproj workspace root"
         end
+
         resolved
     end
 
@@ -84,7 +82,7 @@ module Autoproj
                 ws_path, ws_config = find_v2_workspace_config(p)
                 if ws_path
                     known_workspace_dirs << "#{ws_path}/"
-                    if ws_dir = ws_config['workspace']
+                    if (ws_dir = ws_config["workspace"])
                         known_workspace_dirs << "#{ws_dir}/"
                     end
                     false
@@ -97,12 +95,12 @@ module Autoproj
 
     # {#find_workspace_dir} for v2 workspaces
     def self.find_v2_workspace_dir(base_dir = default_find_base_dir)
-        find_v2_root_dir(base_dir, 'workspace')
+        find_v2_root_dir(base_dir, "workspace")
     end
 
     # {#find_prefix_dir} for v2 workspaces
     def self.find_v2_prefix_dir(base_dir = default_find_base_dir)
-        find_v2_root_dir(base_dir, 'prefix')
+        find_v2_root_dir(base_dir, "prefix")
     end
 
     # {#find_workspace_dir} for v1 workspaces
@@ -110,15 +108,12 @@ module Autoproj
     # Note that for v1 workspaces {#find_prefix_dir} cannot be implemented
     def self.find_v1_workspace_dir(base_dir = default_find_base_dir)
         path = Pathname.new(base_dir)
-        while !path.root?
-            if (path + "autoproj").exist?
-                if !(path + ".autoproj").exist?
-                    return path.to_s
-                end
+        until path.root?
+            if path.join("autoproj").exist?
+                return path.to_s unless path.join(".autoproj").exist?
             end
             path = path.parent
         end
         nil
     end
 end
-