autobuild 1.17.0 → 1.18.0

data/lib/autobuild/packages/dummy.rb

@@ -7,27 +7,28 @@ class DummyPackage < Package
         def installstamp
             "#{srcdir}/#{STAMPFILE}"
         end
-        
+
         def initialize(*args)
             super
         end
 
-        def import(options = Hash.new)
-        end
+        def import(options = Hash.new); end
 
         def prepare
-            %w{import prepare build doc}.each do |phase|
+            %w[import prepare build doc].each do |phase|
                 task "#{name}-#{phase}"
                 t = Rake::Task["#{name}-#{phase}"]
-                def t.needed?; false end
+                def t.needed?
+                    false
+                end
             end
             task(installstamp)
             t = Rake::Task[installstamp]
-            def t.needed?; false end
+            def t.needed?
+                false
+            end
 
             super
         end
     end
 end
-    
-

data/lib/autobuild/packages/genom.rb

@@ -74,7 +74,7 @@ def get_requires
             end
         end
 
-        # Alias this package to the ones defined in the EXTRA_PKGCONFIG 
+        # Alias this package to the ones defined in the EXTRA_PKGCONFIG
         # flag in configure.ac.user
         def get_provides
             configure_ac_user = File.join(srcdir, 'configure.ac.user')

data/lib/autobuild/packages/gnumake.rb

@@ -4,13 +4,13 @@ module Autobuild
     def self.make_is_gnumake?(pkg, path = Autobuild.tool(:make))
         @make_is_gnumake ||= Hash.new
         @gnumake_version ||= Hash.new
-        if @make_is_gnumake.has_key?(path)
+        if @make_is_gnumake.key?(path)
             @make_is_gnumake[path]
         else
             begin
                 result = pkg.run('prepare', path, '--version')
                 @make_is_gnumake[path] = (result.first =~ /GNU Make/)
-                @gnumake_version[path] = result.first.scan(/[\d.]+/)[0]
+                @gnumake_version[path] = Gem::Version.new(result.first.scan(/[\d.]+/)[0])
             rescue Autobuild::SubcommandFailed
                 @make_is_gnumake[path] = false
             end
@@ -28,31 +28,37 @@ def self.make_has_gnumake_jobserver?(pkg, path = Autobuild.tool(:make))
     def self.invoke_make_parallel(pkg, cmd_path = Autobuild.tool(:make))
         reserved = nil
         if make_has_j_option?(pkg, cmd_path) && pkg.parallel_build_level != 1
-            if manager = Autobuild.parallel_task_manager
+            if (manager = Autobuild.parallel_task_manager)
                 job_server = manager.job_server
-                if !make_has_gnumake_jobserver?(pkg, cmd_path) || (pkg.parallel_build_level != Autobuild.parallel_build_level)
+
+                specific_parallel_level = (pkg.parallel_build_level !=
+                    Autobuild.parallel_build_level)
+                if !make_has_gnumake_jobserver?(pkg, cmd_path) || specific_parallel_level
                     reserved = pkg.parallel_build_level
-                    job_server.get(reserved - 1) # We already have one token taken by autobuild itself
+                    # Account for the one token autobuild uses
+                    job_server.get(reserved - 1)
                     yield("-j#{pkg.parallel_build_level}")
                 end
-                if Gem::Version.new(@gnumake_version[cmd_path]) >= Gem::Version.new("4.2.0")
-                    yield("--jobserver-auth=#{job_server.rio.fileno},#{job_server.wio.fileno}", "-j")
+
+                jobserver_fds_arg = "#{job_server.rio.fileno},#{job_server.wio.fileno}"
+
+                if @gnumake_version[cmd_path] >= Gem::Version.new("4.2.0")
+                    yield("--jobserver-auth=#{jobserver_fds_arg}", "-j")
                 else
-                    yield("--jobserver-fds=#{job_server.rio.fileno},#{job_server.wio.fileno}", "-j")
+                    yield("--jobserver-fds=#{jobserver_fds_arg}", "-j")
                 end
             end
             yield("-j#{pkg.parallel_build_level}")
         else yield
         end
     ensure
-        if reserved
-            job_server.put(reserved)
-        end
+        job_server.put(reserved) if reserved
     end
-    
+
     def self.make_subcommand(pkg, phase, *options, &block)
         invoke_make_parallel(pkg, Autobuild.tool(:make)) do |*make_parallel_options|
-            pkg.run(phase, Autobuild.tool(:make), *make_parallel_options, *options, &block)
+            pkg.run(phase, Autobuild.tool(:make),
+                *make_parallel_options, *options, &block)
         end
     end
 end

data/lib/autobuild/packages/import.rb

@@ -5,7 +5,7 @@ module Autobuild
     def self.import(spec, &proc)
         ImporterPackage.new(spec, &proc)
     end
-    
+
     class ImporterPackage < Package
         attr_reader :exclude
 
@@ -19,9 +19,7 @@ def prepare
 
             exclude = self.exclude.dup
             exclude << Regexp.new("^#{Regexp.quote(installstamp)}")
-            if doc_dir
-                exclude << Regexp.new("^#{Regexp.quote(doc_dir)}")
-            end
+            exclude << Regexp.new("^#{Regexp.quote(doc_dir)}") if doc_dir
 
             source_tree(srcdir) do |pkg|
                 pkg.exclude.concat exclude
@@ -32,5 +30,3 @@ def prepare
         end
     end
 end
-
-

data/lib/autobuild/packages/orogen.rb

@@ -41,7 +41,7 @@ class << self
             # This is still considered experimental. Use
             # Orogen.always_regenerate= to set it
             def always_regenerate?
-                !!@always_regenerate
+                @always_regenerate
             end
         end
 
@@ -63,14 +63,15 @@ def self.orocos_target
 
         class << self
             attr_accessor :default_type_export_policy
-            # The list of enabled transports as an array of strings (default: typelib, corba)
+            # The list of enabled transports as an array of strings (default:
+            # typelib, corba)
             attr_reader :transports
 
             attr_reader :orogen_options
         end
         @orogen_options = []
         @default_type_export_policy = :used
-        @transports = %w{corba typelib mqueue}
+        @transports = %w[corba typelib mqueue]
         @rtt_scripting = true
 
         attr_reader :orogen_options
@@ -121,12 +122,13 @@ def orogen_file
             if @orogen_file
                 @orogen_file
             else
-                return if !File.directory?(srcdir)
-                    
+                return unless File.directory?(srcdir)
+
                 Dir.glob(File.join(srcdir, '*.orogen')) do |path|
                     return File.basename(path)
                 end
-                raise ArgumentError, "cannot find an oroGen specification file in #{srcdir}"
+                raise ArgumentError,
+                    "cannot find an oroGen specification file in #{srcdir}"
             end
         end
 
@@ -141,7 +143,7 @@ def initialize(*args, &config)
 
         def prepare_for_forced_build
             super
-            FileUtils.rm_f genstamp 
+            FileUtils.rm_f genstamp
         end
 
         def update_environment
@@ -158,9 +160,7 @@ def orogen_version
             if !@orogen_version && (root = orogen_root)
                 version_file = File.join(root, 'lib', 'orogen', 'version.rb')
                 version_line = File.readlines(version_file).grep(/VERSION\s*=\s*"/).first
-                if version_line =~ /.*=\s+"(.+)"$/
-                    @orogen_version = $1
-                end
+                @orogen_version = $1 if version_line =~ /.*=\s+"(.+)"$/
             end
             @orogen_version
         end
@@ -168,9 +168,7 @@ def orogen_version
         def orogen_root
             if orogen_tool_path
                 root = File.expand_path(File.join('..', '..'), orogen_tool_path)
-                if File.directory?(File.join(root, 'lib', 'orogen'))
-                    root
-                end
+                root if File.directory?(File.join(root, 'lib', 'orogen'))
             end
         end
 
@@ -187,7 +185,9 @@ def prepare
             super
         end
 
-        def genstamp; File.join(srcdir, '.orogen', 'orogen-stamp') end
+        def genstamp
+            File.join(srcdir, '.orogen', 'orogen-stamp')
+        end
 
         def add_cmd_to_cmdline(cmd, cmdline)
             if cmd =~ /^([\w-]+)$/
@@ -210,31 +210,30 @@ def regen
             cmdline << '--corba' if corba
 
             ext_states = extended_states
-            if !ext_states.nil?
+            unless ext_states.nil?
                 cmdline.delete_if { |str| str =~ /extended-states/ }
-                if ext_states
-                    cmdline << '--extended-states'
-                else
-                    cmdline << '--no-extended-states'
-                end
+                cmdline <<
+                    if ext_states
+                        '--extended-states'
+                    else
+                        '--no-extended-states'
+                    end
             end
 
-            @orogen_tool_path = find_in_path 'orogen'
-            if !orogen_tool_path
+            unless (@orogen_tool_path = find_in_path('orogen'))
                 raise ArgumentError, "cannot find 'orogen' in #{resolved_env['PATH']}"
             end
 
-            version = orogen_version
-            if !version
+            unless (version = orogen_version)
                 raise ArgumentError, "cannot determine the orogen version"
             end
 
-            if (version >= "1.0")
+            if version >= "1.0" # rubocop:disable Style/IfUnlessModifier
                 cmdline << "--parallel-build=#{parallel_build_level}"
             end
-            if (version >= "1.1")
+            if version >= "1.1"
                 cmdline << "--type-export-policy=#{Orogen.default_type_export_policy}"
-                cmdline << "--transports=#{Orogen.transports.sort.uniq.join(",")}"
+                cmdline << "--transports=#{Orogen.transports.sort.uniq.join(',')}"
             end
 
             # Now, add raw options
@@ -269,9 +268,11 @@ def regen
             needs_regen ||= !generation_uptodate?
 
             if needs_regen
-                progress_start "generating oroGen %s", :done_message => 'generated oroGen %s' do
+                progress_start "generating oroGen %s",
+                               done_message: 'generated oroGen %s' do
                     in_dir(srcdir) do
-                        run 'orogen', Autobuild.tool('ruby'), '-S', orogen_tool_path, *cmdline
+                        run 'orogen', Autobuild.tool('ruby'), '-S',
+                            orogen_tool_path, *cmdline
                         File.open(genstamp, 'w') do |io|
                             io.print cmdline.join("\n")
                         end
@@ -287,11 +288,11 @@ def generation_uptodate?
             if !File.file?(genstamp)
                 true
             elsif File.file?(File.join(builddir, 'Makefile'))
-                system("#{Autobuild.tool('make')} -C #{builddir} check-uptodate > /dev/null 2>&1")
+                make = Autobuild.tool('make')
+                system("#{make} -C #{builddir} check-uptodate > /dev/null 2>&1")
             else
                 true
             end
         end
     end
 end
-

data/lib/autobuild/packages/pkgconfig.rb

@@ -16,9 +16,10 @@ def installstamp
             return std_stamp if File.file?(std_stamp)
 
             pcfile = File.join(pkgconfig.prefix, "lib", "pkgconfig", "#{name}.pc")
-            if !File.file?(pcfile)
+            unless File.file?(pcfile)
                 raise "cannot find the .pc file for #{name}, tried #{pcfile}"
             end
+
             pcfile
         end
     end
@@ -26,4 +27,3 @@ def self.installed_pkgconfig(name, &block)
         InstalledPkgConfig.new(name, &block)
     end
 end
- 

data/lib/autobuild/packages/python.rb

@@ -56,13 +56,17 @@ def python_path
                 raise "Unable to set PYTHONPATH: #{e.message}"
             end
 
-            return output.read.chomp if ret.value.success?
-            raise 'Unable to set PYTHONPATH: user site directory disabled?'
+            if ret.value.success?
+                output.read.chomp
+            else
+                raise 'Unable to set PYTHONPATH: user site directory disabled?'
+            end
         end
 
         # Do the build in builddir
         def build
             return unless @install_mode
+
             command = generate_build_command
             command << '--force' if @forced
             progress_start 'building %s [progress not available]',
@@ -75,6 +79,7 @@ def build
         # Install the result in prefix
         def install
             return unless @install_mode
+
             command = generate_install_command
             command << '--force' if @forced
             progress_start 'installing %s',

data/lib/autobuild/packages/ruby.rb

@@ -22,7 +22,7 @@ class Ruby < ImporterPackage
         def initialize(*args)
             self.rake_setup_task = "default"
             self.rake_doc_task   = "redocs"
-            self.rake_clean_task   = "clean"
+            self.rake_clean_task = "clean"
             self.rake_test_task  = "test"
             self.rake_test_options = []
 
@@ -36,19 +36,23 @@ def initialize(*args)
 
         def with_doc
             doc_task do
-                progress_start "generating documentation for %s", :done_message => 'generated documentation for %s' do
+                progress_start "generating documentation for %s",
+                               done_message: 'generated documentation for %s' do
                     run 'doc',
-                        Autobuild.tool_in_path('ruby'), '-S', Autobuild.tool('rake'), rake_doc_task,
-                        :working_directory => srcdir
+                        Autobuild.tool_in_path('ruby'), '-S',
+                            Autobuild.tool('rake'), rake_doc_task,
+                        working_directory: srcdir
                 end
             end
         end
 
         def with_tests
             test_utility.task do
-                progress_start "running tests for %s", :done_message => 'tests passed for %s' do
+                progress_start "running tests for %s",
+                               done_message: 'tests passed for %s' do
                     run 'test',
-                        Autobuild.tool_in_path('ruby'), '-S', Autobuild.tool('rake'), rake_test_task, *rake_test_options,
+                        Autobuild.tool_in_path('ruby'), '-S',
+                            Autobuild.tool('rake'), rake_test_task, *rake_test_options,
                         working_directory: srcdir
                 end
             end
@@ -57,13 +61,15 @@ def with_tests
         def invoke_rake(setup_task = rake_setup_task)
             if setup_task && File.file?(File.join(srcdir, 'Rakefile'))
                 run 'post-install',
-                    Autobuild.tool_in_path('ruby'), '-S', Autobuild.tool('rake'), setup_task,
-                    :working_directory => srcdir
+                    Autobuild.tool_in_path('ruby'), '-S',
+                        Autobuild.tool('rake'), setup_task,
+                    working_directory: srcdir
             end
         end
 
         def install
-            progress_start "setting up Ruby package %s", :done_message => 'set up Ruby package %s' do
+            progress_start "setting up Ruby package %s",
+                           done_message: 'set up Ruby package %s' do
                 invoke_rake
             end
             super
@@ -71,10 +77,11 @@ def install
 
         def prepare_for_forced_build # :nodoc:
             super
-            %w{ext tmp}.each do |extdir|
+            %w[ext tmp].each do |extdir|
                 if File.directory?(extdir)
                     Find.find(extdir) do |file|
                         next if file !~ /\<Makefile\>|\<CMakeCache.txt\>$/
+
                         FileUtils.rm_rf file
                     end
                 end
@@ -86,10 +93,11 @@ def prepare_for_rebuild # :nodoc:
             if rake_clean_task && File.file?(File.join(srcdir, 'Rakefile'))
                 begin
                     run 'clean',
-                        Autobuild.tool_in_path('ruby'), '-S', Autobuild.tool('rake'), rake_clean_task,
-                        :working_directory => srcdir
+                        Autobuild.tool_in_path('ruby'), '-S',
+                            Autobuild.tool('rake'), rake_clean_task,
+                        working_directory: srcdir
                 rescue Autobuild::SubcommandFailed => e
-                    warn "%s: cleaning failed. If this package does not need a clean target,"
+                    warn "%s: clean failed. If this package does not need a clean target,"
                     warn "%s: set pkg.rake_clean_task = nil in the package definition."
                     warn "%s: see #{e.logfile} for more details"
                 end
@@ -99,9 +107,7 @@ def prepare_for_rebuild # :nodoc:
         def update_environment
             env_add_prefix srcdir
             libdir = File.join(srcdir, 'lib')
-            if File.directory?(libdir)
-                env_add_path 'RUBYLIB', libdir
-            end
+            env_add_path 'RUBYLIB', libdir if File.directory?(libdir)
         end
     end
 
@@ -109,4 +115,3 @@ def self.ruby(spec, &proc)
         Ruby.new(spec, &proc)
     end
 end
-

data/lib/autobuild/parallel.rb

@@ -1,5 +1,3 @@
-require 'thread'
-
 module Autobuild
     # This is a rewrite of the Rake task invocation code to use parallelism
     #
@@ -23,9 +21,11 @@ def initialize(level)
                 wio.fcntl(Fcntl::F_SETFD, 0)
                 put(level)
             end
+
             def get(token_count = 1)
                 @rio.read(token_count)
             end
+
             def put(token_count = 1)
                 @wio.write(" " * token_count)
             end
@@ -36,7 +36,6 @@ def initialize(level = Autobuild.parallel_build_level)
             @available_workers = Array.new
             @finished_workers = Queue.new
             @workers = Array.new
-
         end
 
         def wait_for_worker_to_end(state)
@@ -46,9 +45,12 @@ def wait_for_worker_to_end(state)
             if error
                 if available_workers.size != workers.size
                     if finished_task.respond_to?(:package) && finished_task.package
-                        Autobuild.error "got an error processing #{finished_task.package.name}, waiting for pending jobs to end"
+                        Autobuild.error "got an error processing "\
+                            "#{finished_task.package.name}, "\
+                            "waiting for pending jobs to end"
                     else
-                        Autobuild.error "got an error doing parallel processing, waiting for pending jobs to end"
+                        Autobuild.error "got an error doing parallel processing, "\
+                            "waiting for pending jobs to end"
                     end
                 end
                 begin
@@ -61,16 +63,14 @@ def wait_for_worker_to_end(state)
             state.process_finished_task(finished_task)
         end
 
-        def discover_dependencies(all_tasks, reverse_dependencies, t)
-            if t.already_invoked?
-                return 
-            end
+        def discover_dependencies(all_tasks, reverse_dependencies, task)
+            return if task.already_invoked?
+            return if all_tasks.include?(task) # already discovered or being discovered
 
-            return if all_tasks.include?(t) # already discovered or being discovered
-            all_tasks << t
+            all_tasks << task
 
-            t.prerequisite_tasks.each do |dep_t|
-                reverse_dependencies[dep_t] << t
+            task.prerequisite_tasks.each do |dep_t|
+                reverse_dependencies[dep_t] << task
                 discover_dependencies(all_tasks, reverse_dependencies, dep_t)
             end
         end
@@ -101,7 +101,7 @@ def push(task, base_priority = 1)
             end
 
             def find_task
-                if task = queue.sort_by { |t, p| p }.first
+                if (task = queue.min_by { |_t, p| p })
                     priorities[task.first] = task.last
                     task.first
                 end
@@ -146,7 +146,8 @@ def process_finished_task(task)
             end
 
             def trivial_task?(task)
-                (task.kind_of?(Autobuild::SourceTreeTask) || task.kind_of?(Rake::FileTask)) && task.actions.empty?
+                (task.kind_of?(Autobuild::SourceTreeTask) ||
+                    task.kind_of?(Rake::FileTask)) && task.actions.empty?
             end
         end
 
@@ -163,11 +164,9 @@ def invoke_parallel(required_tasks)
             # set of tasks that can be queued for execution.
             state = ProcessingState.new(reverse_dependencies)
             tasks.each do |t|
-                if state.ready?(t)
-                    state.push(t)
-                end
+                state.push(t) if state.ready?(t)
             end
-            
+
             # Build a reverse dependency graph (i.e. a mapping from a task to
             # the tasks that depend on it)
 
@@ -175,9 +174,9 @@ def invoke_parallel(required_tasks)
             # topological sort since we would then have to scan all tasks each
             # time for tasks that have no currently running prerequisites
 
-            while true
+            loop do
                 pending_task = state.pop
-                if !pending_task
+                unless pending_task
                     # If we have pending workers, wait for one to be finished
                     # until either they are all finished or the queue is not
                     # empty anymore
@@ -186,9 +185,7 @@ def invoke_parallel(required_tasks)
                         pending_task = state.pop
                     end
 
-                    if !pending_task && available_workers.size == workers.size
-                        break
-                    end
+                    break if !pending_task && available_workers.size == workers.size
                 end
 
                 if state.trivial_task?(pending_task)
@@ -204,9 +201,7 @@ def invoke_parallel(required_tasks)
                 # Get a job server token
                 job_server.get
 
-                while !finished_workers.empty?
-                    wait_for_worker_to_end(state)
-                end
+                wait_for_worker_to_end(state) until finished_workers.empty?
 
                 # We do have a job server token, so we are allowed to allocate a
                 # new worker if none are available
@@ -222,9 +217,9 @@ def invoke_parallel(required_tasks)
             end
 
             not_processed = tasks.find_all { |t| !t.already_invoked? }
-            if !not_processed.empty?
+            unless not_processed.empty?
                 cycle = resolve_cycle(tasks, not_processed, reverse_dependencies)
-                raise "cycle in task graph: #{cycle.map(&:name).sort.join(", ")}"
+                raise "cycle in task graph: #{cycle.map(&:name).sort.join(', ')}"
             end
         end
 
@@ -232,7 +227,7 @@ def resolve_cycle(all_tasks, tasks, reverse_dependencies)
             cycle = tasks.dup
             chain = []
             next_task = tasks.first
-            while true
+            loop do
                 task = next_task
                 chain << task
                 tasks.delete(next_task)
@@ -244,10 +239,12 @@ def resolve_cycle(all_tasks, tasks, reverse_dependencies)
                         true
                     end
                 end
-                if !next_task
-                    Autobuild.fatal "parallel processing stopped prematurely, but no cycle is present in the remaining tasks"
-                    Autobuild.fatal "remaining tasks: #{cycle.map(&:name).join(", ")}"
-                    Autobuild.fatal "known dependencies at initialization time that could block the processing of the remaining tasks"
+                unless next_task
+                    Autobuild.fatal "parallel processing stopped prematurely, "\
+                        "but no cycle is present in the remaining tasks"
+                    Autobuild.fatal "remaining tasks: #{cycle.map(&:name).join(', ')}"
+                    Autobuild.fatal "known dependencies at initialization time that "\
+                        "could block the processing of the remaining tasks"
                     reverse_dependencies.each do |parent_task, parents|
                         if cycle.include?(parent_task)
                             parents.each do |p|
@@ -255,13 +252,14 @@ def resolve_cycle(all_tasks, tasks, reverse_dependencies)
                             end
                         end
                     end
-                    Autobuild.fatal "known dependencies right now that could block the processing of the remaining tasks"
+                    Autobuild.fatal "known dependencies right now that could block "\
+                        "the processing of the remaining tasks"
                     all_tasks.each do |p|
                         (cycle & p.prerequisite_tasks).each do |t|
                             Autobuild.fatal "  #{p}: #{t}"
                         end
                     end
-                    raise "failed to resolve cycle in #{cycle.map(&:name).join(", ")}"
+                    raise "failed to resolve cycle in #{cycle.map(&:name).join(', ')}"
                 end
             end
             chain
@@ -301,7 +299,7 @@ def do_task(task)
             end
 
             def last_result
-                return @last_finished_task, @last_error
+                [@last_finished_task, @last_error]
             end
 
             def queue(task)
@@ -321,5 +319,3 @@ class << self
         attr_accessor :parallel_task_manager
     end
 end
-
-