autobuild 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43869aed86ff761f4f091a8c5dbd4d27cdb481cd2b60bf4843bd259366d2a88b
-  data.tar.gz: c62531880b13b4401323193c8bbbc1d095ae1f0201aecf16646c5f316f7aff03
+  metadata.gz: c3203bb516411ada5796ebf11313d0be7731f6068361ac526424938700c886bf
+  data.tar.gz: 5b988ac45c9c2cc3216e73d7917a61555a0171d830e94fe4d59edb95938ed49d
 SHA512:
-  metadata.gz: 47a3d57e94becd1e6e96ccf36902e5cb908d56d3faf0ee0f18904c041caae1940eaa959b51ae641c9de826c6cf211a42953a81268a61d4bf60efce9173bf373f
-  data.tar.gz: e6edd90897e22b8dd0e89e490027ebb2c2632bc3c201355a787bf83413b8958a5ee97a3aab6da0e6dbe96fde093d453032244fcca7145af99f578ad3c425874d
+  metadata.gz: 46805b87b14989037a618067c414b046945e586a138f9dfb56c3ab80d34132c233f9df28a55860cf41f69b799ffe98b0d22bdcbe6d86aea7c788f4783bfc1838
+  data.tar.gz: b3afdff0d56e867853f4d440eb758c9866885efedea1099cedaf19271653d8680646d5efeca895aa814024e09e58cef7cbe5966116ef02337d1d546582319f86

data/.rubocop.yml

@@ -0,0 +1,107 @@
+inherit_gem:
+  rubocop-rock: defaults.yml
+
+AllCops:
+    TargetRubyVersion: "2.3"
+    Exclude:
+    - lib/autobuild/packages/genom.rb
+    - vendor/**/*
+    - pkg/**/*
+
+Style/ClassVars:
+    Enabled: false
+
+Style/TrivialAccessors:
+    IgnoreClassMethods: true
+
+Naming/PredicateName:
+    Enabled: false
+
+Lint/SplatKeywordArguments:
+    Enabled: false
+
+Style/FrozenStringLiteralComment:
+    Enabled: false
+
+Style/AccessModifierDeclarations:
+    EnforcedStyle: inline
+
+Naming/FileName:
+    Exclude:
+      - lib/autobuild/import/git-lfs.rb
+
+
+
+
+Layout/AlignParameters:
+    Enabled: false
+
+Layout/DotPosition:
+    Enabled: false
+
+Layout/FirstParameterIndentation:
+    Enabled: false
+
+Layout/IndentAssignment:
+    Enabled: false
+
+Layout/IndentationWidth:
+    Enabled: false
+
+Layout/MultilineMethodCallBraceLayout:
+    Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+    Enabled: false
+
+Lint/RescueException:
+    Enabled: false
+
+Metrics/AbcSize:
+    Enabled: false
+
+Metrics/BlockLength:
+    Enabled: false
+
+Metrics/ClassLength:
+    Enabled: false
+
+Metrics/CyclomaticComplexity:
+    Enabled: false
+
+Metrics/MethodLength:
+    Enabled: false
+
+Metrics/PerceivedComplexity:
+    Enabled: false
+
+Style/ClassCheck:
+    Enabled: false
+
+Style/Documentation:
+    Enabled: false
+
+Style/EmptyLiteral:
+    Enabled: false
+
+Style/GuardClause:
+    Enabled: false
+
+Style/HashSyntax:
+    Enabled: false
+
+Style/PerlBackrefs:
+    Enabled: false
+
+Style/StringLiterals:
+    Enabled: false
+
+Layout/IndentHeredoc:
+    Enabled: false
+
+Metrics/LineLength:
+    Max: 90
+    Exclude:
+    - test/**/*
+
+

data/Gemfile

@@ -3,10 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 group :vscode do
+    gem 'debase', '>= 0.2.2.beta10'
     gem 'pry'
     gem 'pry-byebug'
     gem 'rubocop', '>= 0.6.0'
+    gem 'rubocop-rock'
     gem 'ruby-debug-ide', '>= 0.6.0'
-    gem 'debase', '>= 0.2.2.beta10'
     gem 'solargraph'
 end

data/Rakefile

@@ -8,9 +8,6 @@ Rake::TestTask.new(:test) do |t|
     t.libs << "lib" << Dir.pwd
 
     test_files = Rake::FileList['test/**/test_*.rb']
-    if !File.executable?('/usr/bin/cvs')
-        test_files.exclude('test/import/test_cvs.rb')
-    end
+    test_files.exclude('test/import/test_cvs.rb') unless File.executable?('/usr/bin/cvs')
     t.test_files = test_files
 end
-

data/autobuild.gemspec

@@ -1,33 +1,36 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'autobuild/version'
 
 Gem::Specification.new do |s|
     s.name = "autobuild"
     s.version = Autobuild::VERSION
-    s.required_ruby_version = '>= 2.1.0'
+    s.required_ruby_version = '>= 2.3.0'
     s.authors = ["Sylvain Joyeux"]
     s.email = "sylvain.joyeux@m4x.org"
     s.summary = "Library to handle build systems and import mechanisms"
-    s.description = "Collection of classes to handle build systems (CMake, autotools, ...) and import mechanisms (tarballs, CVS, SVN, git, ...). It also offers a Rake integration to import and build such software packages. It is the backbone of the autoproj (http://rock-robotics.org/autoproj) integrated software project management tool."
+    s.description = "Collection of classes to handle build systems "\
+        "(CMake, autotools, ...) and import mechanisms "\
+        "(tarballs, CVS, SVN, git, ...). It also offers a Rake integration "\
+        "to import and build such software packages. It is the backbone "\
+        "of the autoproj (http://rock-robotics.org/autoproj) integrated "\
+        "software project management tool."
     s.homepage = "http://rock-robotics.org"
     s.licenses = ["BSD"]
 
-    s.required_ruby_version = ">= 1.9.3"
     s.require_paths = ["lib"]
     s.extensions = []
-    s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    s.files = `git ls-files -z`.split("\x0")
+        .reject { |f| f.match(%r{^(test|spec|features)/}) }
 
+    s.add_runtime_dependency 'pastel', '~> 0.7.0', '>= 0.7.0'
     s.add_runtime_dependency "rake", "~> 12.0", ">= 12.3.0"
-    s.add_runtime_dependency "utilrb", "~> 3.0", ">= 3.0"
-    s.add_runtime_dependency 'tty-prompt', '~> 0.15.0'
     s.add_runtime_dependency 'tty-cursor', '~> 0.5.0'
+    s.add_runtime_dependency 'tty-prompt', '~> 0.15.0'
     s.add_runtime_dependency 'tty-screen', '~> 0.6.4'
-    s.add_runtime_dependency 'pastel', '~> 0.7.0', '>= 0.7.0'
+    s.add_runtime_dependency "utilrb", "~> 3.0", ">= 3.0"
+    s.add_development_dependency "fakefs"
     s.add_development_dependency "flexmock", '~> 2.0', ">= 2.0.0"
     s.add_development_dependency "minitest", "~> 5.0", ">= 5.0"
-    s.add_development_dependency "fakefs"
     s.add_development_dependency "simplecov"
 end
-

data/bin/autobuild

@@ -2,12 +2,14 @@
 
 begin
     require 'daemons'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
 
 require 'autobuild'
 
+# rubocop:disable Style/MixinUsage
 include Autobuild
+# rubocop:enable Style/MixinUsage
 
 DEFAULT_HTTP_PORT = 2000
 
@@ -20,7 +22,7 @@ Autobuild.packages = packages
 conffile = File.expand_path(conffile, Dir.pwd)
 if Autobuild.daemonize
     puts "Going into daemon mode ..."
-    Daemons.daemonize 
+    Daemons.daemonize
 end
 
 Reporting << StdoutReporter.new
@@ -40,4 +42,3 @@ rescue ThreadError
 rescue Interrupt
     STDERR.puts "interrupted"
 end
- 

data/lib/autobuild.rb

@@ -1,13 +1,13 @@
 require 'rake'
 
-if defined? Rake::DSL
-    include Rake::DSL
-end
+# rubocop:disable Style/MixinUsage
+include Rake::DSL if defined?(Rake::DSL)
+# rubocop:enable Style/MixinUsage
 
 require 'utilrb/logger'
 
 module Autobuild
-    LIB_DIR = File.expand_path(File.dirname(__FILE__))
+    LIB_DIR = __dir__
     extend Logger::Root('Autobuild', Logger::INFO)
 end
 
@@ -15,7 +15,6 @@ module Autobuild
 require 'socket'
 require 'etc'
 require 'find'
-require 'thread'
 require 'pathname'
 require 'shellwords'
 require 'find'

data/lib/autobuild/build_logfile.rb

@@ -28,9 +28,11 @@ def diff(other)
             result = []
             by_package.each do |pkg_name, phases|
                 other_phases = other.by_package[pkg_name]
-                next if !other_phases
+                next unless other_phases
+
                 phases.each do |phase, duration|
-                    next if !other_phases.has_key?(phase)
+                    next unless other_phases.key?(phase)
+
                     other_duration = other_phases[phase]
                     result << Entry.new(pkg_name, phase, nil, other_duration - duration)
                 end
@@ -44,7 +46,8 @@ def self.parse(file)
                 next if line.empty?
 
                 cols = line.split(/\s+/)
-                date, time = cols.shift, cols.shift
+                date = cols.shift
+                time = cols.shift
                 start_time = Time.parse("#{date} #{time}")
                 duration = Float(cols.pop)
                 phase = cols.pop
@@ -55,4 +58,3 @@ def self.parse(file)
         end
     end
 end
-

data/lib/autobuild/config.rb

@@ -1,5 +1,5 @@
 # Evaluates +script+ in autobuild context
-def Autobuild(&script)
+def Autobuild(&script) # rubocop:disable Naming/MethodName
     Autobuild.send(:module_eval, &script)
 end
 
@@ -18,7 +18,8 @@ def Autobuild(&script)
 # do_rebuild:: if we should cleanly rebuild every packages
 # do_doc:: if we should produce the documentation
 # doc_errors:: if errors during the documentation generation are treated as errors
-# daemonize:: if the build should go into daemon mode (only if the daemons gem is available)
+# daemonize:: if the build should go into daemon mode (only if the daemons gem
+#   is available)
 # clean_log:: remove all logs before starting the build
 # packages:: a list of packages to build specifically
 # default_packages:: the list of packages to build if Autobuild.packages is empty.
@@ -27,10 +28,10 @@ def Autobuild(&script)
 #   Otherwise, the existing logfile contents is erased.
 module Autobuild
     class << self
-        %w{ nice srcdir prefix
+        %w[ nice srcdir prefix
             verbose debug do_update do_build do_rebuild do_forced_build
             daemonize clean_log packages default_packages
-            keep_oldlogs}.each do |name|
+            keep_oldlogs ].each do |name|
             attr_accessor name
         end
 
@@ -45,12 +46,14 @@ class << self
         # @yieldparam [Hash] utility options
         # @return [void]
         def each_utility
-            return enum_for(__method__) if !block_given?
+            return enum_for(__method__) unless block_given?
+
             utilities.each { |name, (utl, options)| yield(name, utl, options) }
         end
 
         def register_utility_class(name, klass, disabled_by_default: false, **options)
-            utilities[name] = [klass, Hash[disabled_by_default: disabled_by_default], options]
+            creation_options = { disabled_by_default: disabled_by_default }
+            utilities[name] = [klass, creation_options, options]
             singleton_class.class_eval do
                 attr_accessor "only_#{name}"
                 attr_accessor "do_#{name}"
@@ -70,7 +73,9 @@ def create_utility(utility_name, package)
                 package.utilities[utility_name] = utility
                 utility.enabled = !creation_options[:disabled_by_default]
                 utility
-            else raise ArgumentError, "there is no utility called #{utility_name}, available utilities are #{utilities.keys.sort.join(", ")}"
+            else
+                raise ArgumentError, "there is no utility called #{utility_name}, "\
+                    "available utilities are #{utilities.keys.sort.join(', ')}"
             end
         end
         # The directory in which logs are saved. Defaults to PREFIX/log.
@@ -85,10 +90,13 @@ def full_build?
     register_utility_class 'doc', Utility, disabled_by_default: false
     register_utility_class 'test', TestUtility, disabled_by_default: true
 
-    DEFAULT_OPTIONS = { :nice => nil,
-        :srcdir => Dir.pwd, :prefix => Dir.pwd, :logdir => nil,
-        :verbose => false, :debug => false, :do_build => true, :do_forced_build => false, :do_rebuild => false, :do_update => true, 
-        :daemonize => false, :packages => [], :default_packages => [], :keep_oldlogs => false }
+    DEFAULT_OPTIONS = {
+        :nice => nil, :srcdir => Dir.pwd, :prefix => Dir.pwd,
+        :logdir => nil, :verbose => false, :debug => false, :do_build => true,
+        :do_forced_build => false, :do_rebuild => false, :do_update => true,
+        :daemonize => false, :packages => [], :default_packages => [],
+        :keep_oldlogs => false
+    }.freeze
 
     DEFAULT_OPTIONS.each do |name, value|
         send("#{name}=", value)
@@ -128,14 +136,15 @@ def self.apply_post_install(pkg, info)
     @mail = Hash.new
     class << self
         # Mailing configuration. It is a hash with the following keys (as symbols)
-        # [:to] the mail destination. Defaults to USER@HOSTNAME, where USER is the username
-        #       of autobuild's caller, and HOSTNAME the hostname of the current machine.
+        # [:to] the mail destination. Defaults to USER@HOSTNAME, where USER is
+        #     the username of autobuild's caller, and HOSTNAME the hostname of the
+        #     current machine.
         # [:from] the mail origin. Defaults to the same value than +:to+
         # [:smtp] the hostname of the SMTP server, defaults to localhost
         # [:port] the port of the SMTP server, defauts to 22
         # [:only_errors] mail only on errors. Defaults to false.
         attr_reader :mail
-        
+
         # call-seq:
         #   post_success_message => string
         #   post_success_message "msg" => "msg"
@@ -159,7 +168,9 @@ def post_success_message(*args, &block)
         end
 
         # The directory in which logs are saved
-        def logdir; @logdir || "#{prefix}/log" end
+        def logdir
+            @logdir || "#{prefix}/log"
+        end
 
         # Removes all log files
         def clean_log!
@@ -173,33 +184,67 @@ def clean_log!
         def commandline(args)
             parser = OptionParser.new do |opts|
                 opts.separator "Path specification"
-                opts.on("--srcdir PATH", "sources are installed in PATH") do |v| Autobuild.srcdir=v end
-                opts.on("--prefix PATH", "built packages are installed in PATH") do |v| Autobuild.prefix = v end
-                opts.on("--logdir PATH", "logs are saved in PATH (default: <prefix>/autobuild)") do |v| Autobuild.logdir = v end
+                opts.on("--srcdir PATH", "sources are installed in PATH") do |v|
+                    Autobuild.srcdir = v
+                end
+                opts.on("--prefix PATH", "built packages are installed in PATH") do |v|
+                    Autobuild.prefix = v
+                end
+                opts.on("--logdir PATH", "logs are saved in PATH "\
+                    "(default: <prefix>/autobuild)") do |v|
+                    Autobuild.logdir = v
+                end
 
                 opts.separator ""
                 opts.separator "General behaviour"
-                opts.on('--nice NICE', Integer, 'nice the subprocesses to the given value') do |v| Autobuild.nice = v end
+                opts.on('--nice NICE', Integer,
+                    'nice the subprocesses to the given value') do |v|
+                    Autobuild.nice = v
+                end
                 opts.on("-h", "--help", "Show this message") do
                     puts opts
                     exit
                 end
                 if defined? Daemons
-                    opts.on("--[no-]daemon", "go into daemon mode") do |v| Autobuild.daemonize = v end
+                    opts.on("--[no-]daemon", "go into daemon mode") do |v|
+                        Autobuild.daemonize = v
+                    end
+                end
+                opts.on("--no-update", "update already checked-out sources") do |v|
+                    Autobuild.do_update = v
+                end
+                opts.on("--no-build",  "only prepare packages, do not build them") do |v|
+                    Autobuild.do_build = v
+                end
+                opts.on("--forced-build", "force the trigger of "\
+                    "all the build commands") do |v|
+                    Autobuild.do_forced_build = v
+                end
+                opts.on("--rebuild", "clean and rebuild") do |v|
+                    Autobuild.do_forced_build = v
+                end
+                opts.on("--only-doc", "only generate documentation") do |v|
+                    Autobuild.only_doc = v
+                end
+                opts.on("--no-doc", "don't generate documentation") do |v|
+                    Autobuild.do_doc = v
+                end
+                opts.on("--doc-errors", "treat documentation failure as error") do |v|
+                    Autobuild.pass_doc_errors = v
                 end
-                opts.on("--no-update", "update already checked-out sources") do |v|  Autobuild.do_update = v end
-                opts.on("--no-build",  "only prepare packages, do not build them") do |v| Autobuild.do_build = v end 
-                opts.on("--forced-build",  "force the trigger of all the build commands") do |v| Autobuild.do_forced_build = v end 
-                opts.on("--rebuild",  "clean and rebuild") do |v| Autobuild.do_forced_build = v end 
-                opts.on("--only-doc", "only generate documentation") do |v| Autobuild.only_doc = v end
-                opts.on("--no-doc", "don't generate documentation") do |v| Autobuild.do_doc = v end
-                opts.on("--doc-errors", "treat documentation failure as error") do |v| Autobuild.pass_doc_errors = v end
 
                 opts.separator ""
                 opts.separator "Program output"
-                opts.on("--[no-]verbose", "display output of commands on stdout") do |v| Autobuild.verbose = v end
-                opts.on("--[no-]debug", "debug information (for debugging purposes)") do |v| Autobuild.debug = v end
-                opts.on("--keep-oldlogs", "old logs will be kept, new program output being appended") do |v| Autobuild.keep_oldlogs = v end
+                opts.on("--[no-]verbose", "display output of commands on stdout") do |v|
+                    Autobuild.verbose = v
+                end
+                opts.on("--[no-]debug", "debug information") do |v|
+                    Autobuild.debug = v
+                end
+                opts.on("--keep-oldlogs", "old logs will be kept, "\
+                    "new program output being appended") do |v|
+                    Autobuild.keep_oldlogs = v
+                end
                 opts.on('--version', "displays autobuild version and then exits") do
                     puts "autobuild v#{Autobuild::VERSION}"
                     exit 0
@@ -207,29 +252,35 @@ def commandline(args)
 
                 opts.separator ""
                 opts.separator "Mail reports"
-                opts.on("--mail-from EMAIL", String, "From: field of the sent mails") do |from_email|
+                opts.on("--mail-from EMAIL", String,
+                    "From: field of the sent mails") do |from_email|
                     mail[:from] = from_email
                 end
-                opts.on("--mail-to EMAILS", String, "comma-separated list of emails to which the reports should be sent") do |emails| 
+                opts.on("--mail-to EMAILS", String, "comma-separated list of emails "\
+                    "to which the reports should be sent") do |emails|
                     mail[:to] ||= []
                     mail[:to] += emails.split(',')
                 end
-                opts.on("--mail-subject SUBJECT", String, "Subject: field of the sent mails") do |subject_email|
+                opts.on("--mail-subject SUBJECT", String,
+                    "Subject: field of the sent mails") do |subject_email|
                     mail[:subject] = subject_email
                 end
-                opts.on("--mail-smtp HOSTNAME", String, " address of the mail server written as hostname[:port]") do |smtp|
-                    raise "invalid SMTP specification #{smtp}" unless smtp =~ /^([^:]+)(?::(\d+))?$/
+                opts.on("--mail-smtp HOSTNAME", String, "address of the mail server "\
+                    "written as hostname[:port]") do |smtp|
+                    unless smtp =~ /^([^:]+)(?::(\d+))?$/
+                        raise "invalid SMTP specification #{smtp}"
+                    end
+
                     mail[:smtp] = $1
                     mail[:port] = Integer($2) if $2 && !$2.empty?
                 end
                 opts.on("--mail-only-errors", "send mail only on errors") do
                     mail[:only_errors] = true
                 end
-
             end
 
             parser.parse!(args)
-            if !args[0]
+            unless args[0]
                 puts parser
                 exit
             end
@@ -244,7 +295,7 @@ def commandline(args)
     #
     # @return [Array<String>]
     def self.all_phases
-        %w{import prepare build} +
+        %w[import prepare build] +
             utilities.keys
     end
 
@@ -278,7 +329,7 @@ def self.apply(packages, buildname = "autobuild", phases = [], options = Hash.ne
                 phases  = ['doc']
             else
                 phases  = ['import']
-                phases += ['prepare', 'build'] if Autobuild.do_build
+                phases += %w[prepare build] if Autobuild.do_build
                 phases << 'doc' if Autobuild.do_doc
             end
         end
@@ -308,4 +359,3 @@ def self.apply(packages, buildname = "autobuild", phases = [], options = Hash.ne
         end
     end
 end
-