autobuild 1.17.0 → 1.21.0

data/lib/autobuild/packages/autotools.rb

@@ -10,18 +10,17 @@ module Autobuild
     def self.autotools(opts, &proc)
         Autotools.new(opts, &proc)
     end
-        
-    if Autobuild.macos?
-        Autobuild.programs['libtoolize'] = "glibtoolize"
-    end
 
-    # 
+    Autobuild.programs['libtoolize'] = "glibtoolize" if Autobuild.macos?
+
+    #
     # ==== Handles autotools-based packages
     #
     # == Used programs (see <tt>Autobuild.programs</tt>)
-    # Autotools will use the 'aclocal', 'autoheader', 'autoconf', 'automake' and 'bear'
-    # programs defined on Autobuild.programs. autoheader and bear are disabled by default,
-    # aclocal, autoconf and automake use are autodetected.
+    # Autotools will use the 'aclocal', 'autoheader', 'autoconf', 'automake'
+    # and 'bear' programs defined on Autobuild.programs. autoheader and bear
+    # are disabled by default, aclocal, autoconf and automake use are
+    # autodetected.
     #
     # To override this default behaviour on a per-package basis, use Autotools#use
     #
@@ -47,10 +46,13 @@ def self.enable_bear_globally=(flag)
 
         def using_bear?
             return Autotools.enable_bear_globally? if using[:bear].nil?
+
             using[:bear]
         end
 
-        def configurestamp; "#{builddir}/config.status" end
+        def configurestamp
+            "#{builddir}/config.status"
+        end
 
         def initialize(options)
             @using = Hash.new
@@ -66,11 +68,14 @@ def initialize(options)
 
         def common_utility_handling(utility, target)
             utility.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
                     if internal_doxygen_mode?
                         run_doxygen
                     else
-                        run(utility.name, Autobuild.tool(:make), "-j#{parallel_build_level}", target, :working_directory => builddir)
+                        run(utility.name,
+                            Autobuild.tool(:make), "-j#{parallel_build_level}",
+                            target, working_directory: builddir)
                     end
                     yield if block_given?
                 end
@@ -117,10 +122,9 @@ def use(*programs)
                     programs
                 end
 
-            if !programs.kind_of?(Hash)
-                programs = Array[*programs].inject({}) do |progs, spec|
+            unless programs.kind_of?(Hash)
+                programs = Array[*programs].each_with_object({}) do |spec, progs|
                     progs[spec.first] = spec.last
-                    progs
                 end
             end
             programs.each do |name, opt|
@@ -140,9 +144,7 @@ def prepare_for_forced_build
 
             if using[:automake]
                 Find.find(srcdir) do |path|
-                    if File.basename(path) == "Makefile.in"
-                        FileUtils.rm_f path
-                    end
+                    FileUtils.rm_f(path) if File.basename(path) == "Makefile.in"
                 end
             end
 
@@ -161,7 +163,6 @@ def import(options = Hash.new)
             is_checking_out = !File.directory?(srcdir)
 
             super
-
         ensure
             if is_checking_out && File.directory?(srcdir)
                 FileUtils.touch File.join(srcdir, ".fresh_checkout")
@@ -190,7 +191,9 @@ def prepare
                 if output && (match = /with options "(.*)"/.match(output))
                     options = Shellwords.shellwords(match[1])
                 else
-                    raise UnexpectedConfigStatusOutput, "invalid output of config.status --version, expected a line with `with options \"OPTIONS\"`"
+                    raise UnexpectedConfigStatusOutput, "invalid output of "\
+                        "config.status --version, expected a line with "\
+                        "`with options \"OPTIONS\"`"
                 end
 
                 # Add the --prefix option to the configureflags array
@@ -205,8 +208,8 @@ def prepare
                     else
                         # This is an envvar entry. Ignore it if it is not
                         # explicitely given in configureflags
-                        varname, value = o.split("=").first
-                        if current_flag = testflags.find { |fl| fl =~ /^#{varname}=/ }
+                        varname, = o.split("=").first
+                        if (current_flag = testflags.find { |fl| fl =~ /^#{varname}=/ })
                             current_flag != o
                         else false
                         end
@@ -215,7 +218,8 @@ def prepare
                 new_opt = testflags.find { |o| !options.include?(o) }
                 if old_opt || new_opt
                     if Autobuild.verbose
-                        Autobuild.message "forcing reconfiguration of #{name} (#{old_opt} != #{new_opt})"
+                        Autobuild.message "forcing reconfiguration of #{name} "\
+                            "(#{old_opt} != #{new_opt})"
                     end
                     FileUtils.rm_f configurestamp # to force reconfiguration
                 end
@@ -240,16 +244,15 @@ def tool_program(tool)
         # In general, you should not need that.
         attr_accessor :force_config_status
 
-    private
-        def autodetect_needed_stages
+        private def autodetect_needed_stages
             # Autodetect autoconf/aclocal/automake
             #
             # Let the user disable the use of autoconf explicitely by using 'false'.
             # 'nil' means autodetection
             if using[:autoconf].nil?
-                if File.file?(File.join(srcdir, 'configure.in')) || File.file?(File.join(srcdir, 'configure.ac'))
-                    using[:autoconf] = true 
-                end
+                has_configure_in = %w[configure.in configure.ac].
+                    any? { |p| File.file?(File.join(srcdir, p)) }
+                using[:autoconf] = true if has_configure_in
             end
             using[:aclocal] = using[:autoconf] if using[:aclocal].nil?
             if using[:automake].nil?
@@ -261,7 +264,8 @@ def autodetect_needed_stages
             end
 
             if using[:autogen].nil?
-                using[:autogen] = %w{autogen autogen.sh}.find { |f| File.exist?(File.join(srcdir, f)) }
+                using[:autogen] = %w[autogen autogen.sh]
+                    .find { |f| File.exist?(File.join(srcdir, f)) }
             end
         end
 
@@ -270,21 +274,23 @@ def create_regen_target(confsource = nil)
             conffile = "#{srcdir}/configure"
             if confsource
                 file conffile => confsource
-            elsif confext = %w{.ac .in}.find { |ext| File.exist?("#{conffile}#{ext}") }
+            elsif (confext = %w[.ac .in].find { |ext| File.exist?("#{conffile}#{ext}") })
                 file conffile => "#{conffile}#{confext}"
             elsif using[:autoconf]
-                raise PackageException.new(self, 'prepare'), "neither configure.ac nor configure.in present in #{srcdir}"
+                raise PackageException.new(self, 'prepare'),
+                    "neither configure.ac nor configure.in present in #{srcdir}"
             end
 
             file conffile do
                 isolate_errors do
-                    progress_start "generating autotools for %s", :done_message => 'generated autotools for %s' do
+                    progress_start "generating autotools for %s",
+                                   done_message: 'generated autotools for %s' do
                         regen
                     end
                 end
             end
 
-            return conffile
+            conffile
         end
 
         def regen
@@ -296,8 +302,9 @@ def regen
                 run 'configure', File.expand_path(using[:autogen], srcdir),
                     working_directory: srcdir
             else
-                [ :aclocal, :autoconf, :autoheader, :automake ].each do |tool|
+                %i[aclocal autoconf autoheader automake].each do |tool|
                     next unless using[tool]
+
                     run 'configure', tool_program(tool), *send("#{tool}_flags"),
                         working_directory: srcdir
                 end
@@ -307,14 +314,13 @@ def regen
         # Configure the builddir directory before starting make
         def configure
             super do
-                command = [ "#{srcdir}/configure"]
-                if force_config_status
-                    command << "--no-create"
-                end
+                command = ["#{srcdir}/configure"]
+                command << "--no-create" if force_config_status
                 command << "--prefix=#{prefix}"
                 command += configureflags.flatten
 
-                progress_start "configuring autotools for %s", done_message: 'configured autotools for %s' do
+                progress_start "configuring autotools for %s",
+                               done_message: 'configured autotools for %s' do
                     run('configure', *command, working_directory: builddir)
                 end
             end
@@ -323,10 +329,9 @@ def configure
         # Do the build in builddir
         def build
             in_dir(builddir) do
-                progress_start "building %s [progress not available]", :done_message => 'built %s' do
-                    if force_config_status
-                        run('build', './config.status')
-                    end
+                progress_start "building %s [progress not available]",
+                               done_message: 'built %s' do
+                    run('build', './config.status') if force_config_status
 
                     build_options = []
                     if using_bear?

data/lib/autobuild/packages/cmake.rb

@@ -9,10 +9,18 @@ def self.cmake(options, &block)
     # Handler class to build CMake-based packages
     class CMake < Configurable
         class << self
-            def builddir; @builddir || Configurable.builddir end
+            def builddir
+                @builddir || Configurable.builddir
+            end
+
             def builddir=(new)
-                raise ConfigException, "absolute builddirs are not supported" if (Pathname.new(new).absolute?)
-                raise ConfigException, "builddir must be non-nil and non-empty" if (new.nil? || new.empty?)
+                if Pathname.new(new).absolute?
+                    raise ConfigException, "absolute builddirs are not supported"
+                end
+                if new.nil? || new.empty?
+                    raise ConfigException, "builddir must be non-nil and non-empty"
+                end
+
                 @builddir = new
             end
 
@@ -67,7 +75,7 @@ def all_defines
         # If true, always run cmake before make during the build
         attr_accessor :always_reconfigure
         # If true, we always remove the CMake cache before reconfiguring.
-        # 
+        #
         # See #full_reconfigures? for more details
         attr_writer :full_reconfigures
         # Sets a generator explicitely for this component. See #generator and
@@ -77,9 +85,7 @@ def all_defines
         # Makefiles. If not set for this package explicitely, it is using the
         # global value CMake.generator.
         def generator
-            if @generator then @generator
-            else CMake.generator
-            end
+            @generator || CMake.generator
         end
 
         # If true, we always remove the CMake cache before reconfiguring. This
@@ -96,13 +102,19 @@ def full_reconfigures?
             end
         end
 
-        def cmake_cache; File.join(builddir, "CMakeCache.txt") end
-        def configurestamp; cmake_cache end
+        def cmake_cache
+            File.join(builddir, "CMakeCache.txt")
+        end
+
+        def configurestamp
+            cmake_cache
+        end
 
         def initialize(options)
             @defines = Hash.new
             super
-            @delete_obsolete_files_in_prefix = self.class.delete_obsolete_files_in_prefix?
+            @delete_obsolete_files_in_prefix = self.class.
+                delete_obsolete_files_in_prefix?
         end
 
         # (see CMake.delete_obsolete_files_in_prefix?)
@@ -111,9 +123,7 @@ def delete_obsolete_files_in_prefix?
         end
 
         # (see CMake.delete_obsolete_files_in_prefix=)
-        def delete_obsolete_files_in_prefix=(flag)
-            @delete_obsolete_files_in_prefix = flag
-        end
+        attr_writer :delete_obsolete_files_in_prefix
 
         @@defines = Hash.new
 
@@ -132,7 +142,6 @@ def self.define(name, value)
                 end
         end
 
-
         def define(name, value)
             @defines[name] =
                 if value.respond_to?(:to_str)
@@ -145,12 +154,12 @@ def define(name, value)
         end
 
         DOXYGEN_ACCEPTED_VARIABLES = {
-            '@CMAKE_SOURCE_DIR@' => lambda { |pkg| pkg.srcdir },
-            '@PROJECT_SOURCE_DIR@' => lambda { |pkg| pkg.srcdir },
-            '@CMAKE_BINARY_DIR@' => lambda { |pkg| pkg.builddir },
-            '@PROJECT_BINARY_DIR@' => lambda { |pkg| pkg.builddir },
-            '@PROJECT_NAME@' => lambda { |pkg| pkg.name }
-        }
+            '@CMAKE_SOURCE_DIR@' => ->(pkg) { pkg.srcdir },
+            '@PROJECT_SOURCE_DIR@' => ->(pkg) { pkg.srcdir },
+            '@CMAKE_BINARY_DIR@' => ->(pkg) { pkg.builddir },
+            '@PROJECT_BINARY_DIR@' => ->(pkg) { pkg.builddir },
+            '@PROJECT_NAME@' => ->(pkg) { pkg.name }
+        }.freeze
 
         class << self
             # Flag controlling whether autobuild should run doxygen itself or
@@ -197,7 +206,7 @@ def always_use_doc_target?
         # for a global control of that feature
         def always_use_doc_target?
             if @always_use_doc_target.nil?
-                return CMake.always_use_doc_target?
+                CMake.always_use_doc_target?
             else
                 @always_use_doc_target
             end
@@ -215,17 +224,14 @@ def always_use_doc_target?
         # This method returns true if the package can use the internal doxygen
         # mode and false otherwise
         def internal_doxygen_mode?
-            if always_use_doc_target?
-                return false
-            end
+            return false if always_use_doc_target?
 
             doxyfile_in = File.join(srcdir, "Doxyfile.in")
-            if !File.file?(doxyfile_in)
-                return false
-            end
+            return false unless File.file?(doxyfile_in)
+
             File.readlines(doxyfile_in).each do |line|
                 matches = line.scan(/@[^@]+@/)
-                if matches.any? { |str| !DOXYGEN_ACCEPTED_VARIABLES.has_key?(str) }
+                if matches.any? { |str| !DOXYGEN_ACCEPTED_VARIABLES.key?(str) }
                     return false
                 end
             end
@@ -245,11 +251,14 @@ def internal_doxygen_mode?
         # support cannot be used on this package
         def run_doxygen
             doxyfile_in = File.join(srcdir, "Doxyfile.in")
-            if !File.file?(doxyfile_in)
-                raise RuntimeError, "no Doxyfile.in in this package, cannot use the internal doxygen support"
+            unless File.file?(doxyfile_in)
+                raise "no Doxyfile.in in this package, "\
+                    "cannot use the internal doxygen support"
             end
             doxyfile_data = File.readlines(doxyfile_in).map do |line|
-                line.gsub(/@[^@]+@/) { |match| DOXYGEN_ACCEPTED_VARIABLES[match].call(self) }
+                line.gsub(/@[^@]+@/) do |match|
+                    DOXYGEN_ACCEPTED_VARIABLES[match].call(self)
+                end
             end
             doxyfile = File.join(builddir, "Doxyfile")
             File.open(doxyfile, 'w') do |io|
@@ -296,7 +305,7 @@ def with_tests(target = 'test', &block)
             'YES' => 'ON',
             'OFF' => 'OFF',
             'NO' => 'OFF'
-        }
+        }.freeze
         def equivalent_option_value?(old, new)
             if old == new
                 true
@@ -331,7 +340,7 @@ def prefix_path
             raw = (dependencies.map { |pkg_name| Autobuild::Package[pkg_name].prefix } +
                 CMake.prefix_path)
             raw.each do |path|
-                if !seen.include?(path)
+                unless seen.include?(path)
                     seen << path
                     result << path
                 end
@@ -348,17 +357,20 @@ def update_environment
 
         def defines_changed?(all_defines, cache_data)
             all_defines.any? do |name, value|
-                if match = /^#{name}:\w+=(.*)$/.match(cache_data)
+                if (match = /^#{name}:\w+=(.*)$/.match(cache_data))
                     old_value = match[1]
                 end
 
                 value = value.to_s
                 if !old_value || !equivalent_option_value?(old_value, value)
                     if Autobuild.debug
-                        message "%s: option '#{name}' changed value: '#{old_value}' => '#{value}'"
+                        message "%s: option '#{name}' changed value: "\
+                            "'#{old_value}' => '#{value}'"
                     end
+
                     if old_value
-                        message "%s: changed value of #{name} from #{old_value} to #{value}"
+                        message "%s: changed value of #{name} "\
+                            "from #{old_value} to #{value}"
                     else
                         message "%s: setting value of #{name} to #{value}"
                     end
@@ -373,8 +385,8 @@ def prepare
             # but no Makefile.
             #
             # Delete the CMakeCache to force reconfiguration
-            if !File.exist?( File.join(builddir, 'Makefile') )
-                FileUtils.rm_f cmake_cache
+            unless File.exist?(File.join(builddir, 'Makefile'))
+                FileUtils.rm_f(cmake_cache)
             end
 
             doc_utility.source_ref_dir = builddir
@@ -396,29 +408,27 @@ def prepare
         def configure
             super do
                 in_dir(builddir) do
-                    if !File.file?(File.join(srcdir, 'CMakeLists.txt'))
-                        raise ConfigException.new(self, 'configure'), "#{srcdir} contains no CMakeLists.txt file"
+                    unless File.file?(File.join(srcdir, 'CMakeLists.txt'))
+                        raise ConfigException.new(self, 'configure'),
+                            "#{srcdir} contains no CMakeLists.txt file"
                     end
 
-                    command = [ "cmake" ]
+                    command = ["cmake"]
 
                     if Autobuild.windows?
-                        command << '-G' 
+                        command << '-G'
                         command << "MSYS Makefiles"
                     end
 
                     all_defines.each do |name, value|
                         command << "-D#{name}=#{value}"
                     end
-                    if generator
-                        command << Array(generator).map { |g| "-G#{g}" }
-                    end
+                    command << Array(generator).map { |g| "-G#{g}" } if generator
                     command << srcdir
-                    
-                    progress_start "configuring CMake for %s", :done_message => "configured CMake for %s" do
-                        if full_reconfigures?
-                            FileUtils.rm_f cmake_cache
-                        end
+
+                    progress_start "configuring CMake for %s",
+                                   done_message: "configured CMake for %s" do
+                        FileUtils.rm_f cmake_cache if full_reconfigures?
                         run('configure', *command)
                     end
                 end
@@ -432,9 +442,7 @@ def show_make_messages?
             end
         end
 
-        def show_make_messages=(value)
-            @show_make_messages = value
-        end
+        attr_writer :show_make_messages
 
         def self.show_make_messages?
             @show_make_messages
@@ -446,7 +454,7 @@ def self.show_make_messages=(value)
 
         # Do the build in builddir
         def build
-            current_message = String.new
+            current_message = +""
             in_dir(builddir) do
                 progress_start "building %s" do
                     if always_reconfigure || !File.file?('Makefile')
@@ -459,9 +467,7 @@ def build
                         if line =~ /\[\s*(\d+)%\]/
                             progress "building %s (#{Integer($1)}%)"
                         elsif line !~ /^(?:Generating|Linking|Scanning|Building|Built)/
-                            if line =~ /warning/
-                                warning_count += 1
-                            end
+                            warning_count += 1 if line =~ /warning/
                             if show_make_messages?
                                 current_message += line + "\n"
                                 needs_display = true
@@ -478,7 +484,8 @@ def build
                         message "%s: #{l}", :magenta
                     end
                     if warning_count > 0
-                        progress_done "built %s #{Autoproj.color("(#{warning_count} warnings)", :bold)}"
+                        msg_warning = Autoproj.color("(#{warning_count} warnings)", :bold)
+                        progress_done "built %s #{msg_warning}"
                     else
                         progress_done "built %s"
                     end
@@ -498,13 +505,12 @@ def build
         # in the prefix but not in CMake's install manifest will be removed.
         def install
             in_dir(builddir) do
-                progress_start "installing %s", :done_message => 'installed %s' do
-                    run('install', Autobuild.tool(:make), "-j#{parallel_build_level}", 'install')
+                progress_start "installing %s", done_message: 'installed %s' do
+                    run('install', Autobuild.tool(:make),
+                        "-j#{parallel_build_level}", 'install')
                 end
 
-                if delete_obsolete_files_in_prefix?
-                    delete_obsolete_files
-                end
+                delete_obsolete_files if delete_obsolete_files_in_prefix?
             end
             super
         end
@@ -520,7 +526,8 @@ def install
         def delete_obsolete_files
             # The expand_path is required to sanitize the paths, which can
             # contain e.g. double //
-            manifest_contents = File.readlines(File.join(builddir, 'install_manifest.txt')).
+            cmake_install_manifest = File.join(builddir, 'install_manifest.txt')
+            manifest_contents = File.readlines(cmake_install_manifest).
                 map { |p| File.expand_path(p.chomp) }.to_set
             logdir = self.logdir
             counter = 0
@@ -535,6 +542,11 @@ def delete_obsolete_files
                 message "%s: removed #{counter} obsolete files from prefix (cmake)"
             end
         end
+
+        def self_fingerprint
+            return unless (base = super)
+            all_defines = self.class.defines.merge(self.defines).sort_by(&:first)
+            Digest::SHA1.hexdigest(base + all_defines.join(""))
+        end
     end
 end
-