autoproj 1.3.4 → 1.4.0

data/lib/autoproj/manifest.rb

@@ -17,13 +17,26 @@ end
 
 module Autoproj
     @build_system_dependencies = Set.new
+
+    # Declare OS packages that are required to import and build the packages
+    #
+    # It is used by autoproj itself to install the importers and/or the build
+    # systems for the packages.
     def self.add_build_system_dependency(*names)
         @build_system_dependencies |= names.to_set
     end
     class << self
+        # Returns the set of OS packages that are needed to build and/or import
+        # the packages
+        #
+        # See Autoproj.add_build_system_dependency
         attr_reader :build_system_dependencies
     end
 
+    # Expand build options in +value+.
+    #
+    # The method will expand in +value+ patterns of the form $NAME, replacing
+    # them with the corresponding build option.
     def self.expand_environment(value)
         # Perform constant expansion on the defined environment variables,
         # including the option set
@@ -44,14 +57,22 @@ module Autoproj
     end
 
     @env_inherit = Set.new
+    # Returns true if the given environment variable must not be reset by the
+    # env.sh script, but that new values should simply be prepended to it.
+    #
+    # See Autoproj.env_inherit
     def self.env_inherit?(name)
         @env_inherit.include?(name)
     end
+    # Declare that the given environment variable must not be reset by the
+    # env.sh script, but that new values should simply be prepended to it.
+    #
+    # See Autoproj.env_inherit?
     def self.env_inherit(*names)
         @env_inherit |= names
     end
 
-    # Set a new environment variable
+    # Resets the value of the given environment variable to the given
     def self.env_set(name, *value)
         Autobuild.env_clear(name)
         env_add(name, *value)
@@ -375,7 +396,11 @@ module Autoproj
             end
 
             if !vcs_spec.empty?
-                expansions = Hash["PACKAGE" => package_name, "PACKAGE_BASENAME" => File.basename(package_name)]
+                expansions = Hash["PACKAGE" => package_name,
+                    "PACKAGE_BASENAME" => File.basename(package_name),
+                    "AUTOPROJ_ROOT" => Autoproj.root_dir,
+                    "AUTOPROJ_CONFIG" => Autoproj.config_dir,
+                    "AUTOPROJ_SOURCE_DIR" => local_dir]
 
                 vcs_spec = expand(vcs_spec, expansions)
                 vcs_spec = Autoproj.vcs_definition_to_hash(vcs_spec)

data/lib/autoproj/osdeps.rb

@@ -11,16 +11,36 @@ module Autoproj
 
             OSDependencies.new(data)
         end
+
+        class << self
+            attr_reader :aliases
+        end
+        @aliases = Hash.new
+
+        def self.alias(old_name, new_name)
+            @aliases[new_name] = old_name
+        end
+
+        def self.autodetect_ruby
+            ruby_package =
+                if RUBY_VERSION < "1.9.0" then "ruby18"
+                else "ruby19"
+                end
+            self.alias(ruby_package, "ruby")
+        end
+
         AUTOPROJ_OSDEPS = File.join(File.expand_path(File.dirname(__FILE__)), 'default.osdeps')
         def self.load_default
             @default_osdeps ||= OSDependencies.load(AUTOPROJ_OSDEPS)
         end
 
         attr_reader :definitions
-        attr_reader :gem_fetcher
+        def gem_fetcher
+            @gem_fetcher ||= Gem::SpecFetcher.fetcher
+        end
+
         def initialize(defs = Hash.new)
             @definitions = defs.to_hash
-            @gem_fetcher = Gem::SpecFetcher.fetcher
         end
 
         def merge(info)
@@ -49,6 +69,10 @@ module Autoproj
                         release_string =~ /^.*([^\s]+)$/
                             version = $1
                         ['gentoo', [version]]
+                    elsif File.exists?('/etc/arch-release')
+                        codename = "Unknown"
+                        puts "Found Arch"
+                        ['arch', [codename]]
                     else
                         raise ConfigError, "Unknown operating system"
                     end
@@ -83,7 +107,8 @@ module Autoproj
         OS_PACKAGE_INSTALL = {
             'debian' => 'apt-get install -y %s',
             'ubuntu' => 'apt-get install -y %s',
-            'gentoo' => 'emerge --noreplace %s'
+            'gentoo' => 'emerge --noreplace %s',
+            'arch' => 'pacman -Sy --noconfirm %s'
         }
 
         def generate_os_script(dependencies)
@@ -146,7 +171,10 @@ module Autoproj
         # call-seq:
         #   partition_packages(package_names) => os_packages, gem_packages
         def partition_packages(package_set, package_osdeps = Hash.new)
-            package_set = package_set.to_set
+            package_set = package_set.
+                map { |name| OSDependencies.aliases[name] || name }.
+                to_set
+
             osdeps, gems = [], []
             package_set.to_set.each do |name|
                 pkg_def = definitions[name]
@@ -184,6 +212,19 @@ module Autoproj
             return osdeps, gems
         end
 
+        def guess_gem_program
+            if Autobuild.programs['gem']
+                return Autobuild.programs['gem']
+            end
+
+            ruby_bin = Config::CONFIG['RUBY_INSTALL_NAME']
+            if ruby_bin =~ /^ruby(.+)$/
+                Autobuild.programs['gem'] = "gem#{$1}"
+            else
+                Autobuild.programs['gem'] = "gem"
+            end
+        end
+
         # Requests the installation of the given set of packages
         def install(packages, package_osdeps = Hash.new)
             osdeps, gems = partition_packages(packages, package_osdeps)
@@ -223,7 +264,7 @@ module Autoproj
                     if !installed.empty? && Autobuild.do_update
                         # Look if we can update the package ...
                         dep = Gem::Dependency.new(name, version_requirements)
-                        available = @gem_fetcher.find_matching(dep)
+                        available = gem_fetcher.find_matching(dep)
                         installed_version = installed.map(&:version).max
                         available_version = available.map { |(name, v), source| v }.max
                         needs_update = (available_version > installed_version)
@@ -236,12 +277,14 @@ module Autoproj
 
             # Now install what is left
             if !gems.empty?
+                guess_gem_program
+
                 if Autoproj.verbose
                     STDERR.puts "Installing rubygems dependencies with"
                     STDERR.puts "gem install #{gems.join(" ")}"
                 end
                 Autobuild.progress "installing/updating RubyGems dependencies: #{gems.join(", ")}"
-                Autobuild::Subprocess.run 'autoproj', 'osdeps', 'gem', 'install', *gems
+                Autobuild::Subprocess.run 'autoproj', 'osdeps', Autobuild.tool('gem'), 'install', *gems
                 did_something ||= true
             end
 

data/lib/autoproj/system.rb

@@ -1,8 +1,10 @@
 module Autoproj
-    BASE_DIR     = File.expand_path(File.join('..', '..'), File.dirname(__FILE__))
-
     class UserError < RuntimeError; end
 
+    # Returns the root directory of the current autoproj installation.
+    #
+    # If the current directory is not in an autoproj installation,
+    # raises UserError.
     def self.root_dir
         dir = Dir.pwd
         while dir != "/" && !File.directory?(File.join(dir, "autoproj"))
@@ -14,36 +16,69 @@ module Autoproj
         dir
     end
 
+    # Returns the configuration directory for this autoproj installation.
+    #
+    # If the current directory is not in an autoproj installation,
+    # raises UserError.
     def self.config_dir
         File.join(root_dir, "autoproj")
     end
+
+    # Returns the build directory (prefix) for this autoproj installation.
+    #
+    # If the current directory is not in an autoproj installation, raises
+    # UserError.
     def self.build_dir
 	File.join(root_dir, "build")
     end
 
+    # Returns the path to the provided configuration file.
+    #
+    # If the current directory is not in an autoproj installation, raises
+    # UserError.
     def self.config_file(file)
         File.join(config_dir, file)
     end
 
+    # Run the provided command as user
     def self.run_as_user(*args)
         if !system(*args)
             raise "failed to run #{args.join(" ")}"
         end
     end
 
+    # Run the provided command as root, using sudo to gain root access
     def self.run_as_root(*args)
         if !system('sudo', *args)
             raise "failed to run #{args.join(" ")} as root"
         end
     end
 
+    # Return the directory in which remote package set definition should be
+    # checked out
     def self.remotes_dir
         File.join(root_dir, ".remotes")
     end
+
+    # Return the directory in which RubyGems package should be installed
     def self.gem_home
         File.join(root_dir, ".gems")
     end
 
+    # Find the given program in PATH. It raises ArgumentError if the program
+    # can't be found
+    def self.find_in_path(name)
+        result = ENV['PATH'].split(':').find { |dir| File.file?(File.join(dir, name)) }
+        if !result
+            raise ArgumentError, "#{name} can not be found in PATH"
+        end
+        File.join(result, name)
+    end
+
+    # Initializes the environment variables to a "sane default"
+    #
+    # Use this in autoproj/init.rb to make sure that the environment will not
+    # get polluted during the build.
     def self.set_initial_env
         Autoproj.env_set 'RUBYOPT', "-rubygems"
         Autoproj.env_set 'GEM_HOME', Autoproj.gem_home
@@ -53,6 +88,7 @@ module Autoproj
         Autoproj.env_set 'LD_LIBRARY_PATH'
     end
 
+    # Create the env.sh script in +subdir+. In general, +subdir+ should be nil.
     def self.export_env_sh(subdir = nil)
         filename = if subdir
                        File.join(Autoproj.root_dir, subdir, "env.sh")
@@ -75,6 +111,12 @@ module Autoproj
         end
     end
 
+    # Load a definition file given at +path+. +source+ is the package set from
+    # which the file is taken.
+    #
+    # If any error is detected, the backtrace will be filtered so that it is
+    # easier to understand by the user. Moreover, if +source+ is non-nil, the
+    # package set name will be mentionned.
     def self.load(source, *path)
         path = File.join(*path)
         Kernel.load path
@@ -82,6 +124,7 @@ module Autoproj
         Autoproj.filter_load_exception(e, source, path)
     end
 
+    # Same as #load, but runs only if the file exists.
     def self.load_if_present(source, *path)
         path = File.join(*path)
         if File.file?(path)
@@ -89,6 +132,8 @@ module Autoproj
         end
     end
 
+    # Look into +dir+, searching for shared libraries. For each library, display
+    # a warning message if this library has undefined symbols.
     def self.validate_solib_dependencies(dir, exclude_paths = [])
         Find.find(File.expand_path(dir)) do |name|
             next unless name =~ /\.so$/

data/lib/autoproj/version.rb

@@ -1,3 +1,3 @@
 module Autoproj
-    VERSION = "1.3.4"
+    VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: autoproj
 version: !ruby/object:Gem::Version 
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors: 
 - Sylvain Joyeux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-14 00:00:00 +01:00
+date: 2010-02-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
 - !ruby/object:Gem::Dependency 
   name: webgen
   type: :development
@@ -90,7 +110,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.4.0
+        version: 2.5.0
     version: 
 description: |-
   What is Autoproj
@@ -137,7 +157,6 @@ files:
 - doc/guide/ext/init.rb
 - doc/guide/ext/previous_next.rb
 - doc/guide/ext/rdoc_links.rb
-- doc/guide/src/autobuild.page
 - doc/guide/src/autoproj_bootstrap
 - doc/guide/src/customization.page
 - doc/guide/src/default.css
@@ -151,7 +170,12 @@ files:
 - doc/guide/src/images/gradient1.png
 - doc/guide/src/images/gradient2.png
 - doc/guide/src/index.page
-- doc/guide/src/source_yml.page
+- doc/guide/src/manifest.xml
+- doc/guide/src/package_sets/autobuild.page
+- doc/guide/src/package_sets/importers.page
+- doc/guide/src/package_sets/index.page
+- doc/guide/src/package_sets/manifest-xml.page
+- doc/guide/src/package_sets/osdeps.page
 - doc/guide/src/structure.page
 - lib/autoproj.rb
 - lib/autoproj/autobuild.rb