autobuild 0.5.1 → 0.6

data/lib/autobuild/environment.rb

@@ -1,8 +1,9 @@
 module Autobuild
+    ## Adds an element to a path-like variable
     def self.pathvar(path, varname)
         if File.directory?(path)
             oldpath = ENV[varname]
-            if oldpath.empty?
+            if oldpath.nil? || oldpath.empty?
                 ENV[varname] = path
             else
                 ENV[varname] = "#{path}:#{oldpath}"
@@ -10,6 +11,8 @@ module Autobuild
         end
     end
 
+    ## Updates the environment when a new prefix has been added
+    # TODO: modularize that
     def self.update_environment(newprefix)
         pathvar("#{newprefix}/bin", 'PATH')
         pathvar("#{newprefix}/lib/pkgconfig", 'PKG_CONFIG_PATH')

data/lib/autobuild/exceptions.rb

@@ -1,26 +1,40 @@
 module Autobuild
+    ## Base class for all Autobuild exceptions
     class Exception < RuntimeError
+        ## If the error should be reported by mail
         def mail?;  false end
+        ## If the error is fatal
         def fatal?; true end
         attr_accessor :target, :phase
 
+        ## Creates a new exception which occured while doing *phase* 
+        # in *target*
         def initialize(target = nil, phase = nil)
-            @target = target
-            @phase = phase
+            @target, @phase = target, phase
         end
 
         alias :exception_message :to_s 
         def to_s
-            "#{target}: failed in #{phase} phase"
-            "   #{super}"
+            if target && phase
+                "#{target}: failed in #{phase} phase\n   #{super}"
+            elsif target
+                "#{target}: #{super}"
+            else
+                super
+            end
         end
     end
+
+    ## There is an error/inconsistency in the configuration
     class ConfigException  < Exception; end
+    ## An error occured in a package
     class PackageException < Exception
         def mail?; true end
     end
 
+    ## The subcommand is not found
     class CommandNotFound  < Exception; end
+    ## An error occured while running a subcommand
     class SubcommandFailed < Exception
         def mail?; true end
         attr_reader :command, :logfile, :status
@@ -39,7 +53,7 @@ module Autobuild
             super(target)
             @command = command
             @logfile = logfile
-            @status = status
+            @status  = status
         end
 
         def to_s

data/lib/autobuild/import/cvs.rb

@@ -1,15 +1,18 @@
+require 'autobuild/config'
 require 'autobuild/subcommand'
 require 'autobuild/importer'
 
 module Autobuild
     class CVSImporter < Importer
-        def initialize(root, name, options)
+        def initialize(root, name, options = {})
             @root = root
             @module = name
 
-            @program    = ($PROGRAMS[:cvs] || 'cvs')
-            @options_up = ( options[:cvsup] || '-dP' ).to_a
-            @options_co = ( options[:cvsco] || '-P' ).to_a
+            @program    = Autobuild.tool('cvs')
+            @options_up = options[:cvsup] || '-dP'
+            @options_up = Array[*@options_up]
+            @options_co = options[:cvsco] || '-P'
+            @options_co = Array[*@options_co]
             super(options)
         end
         
@@ -21,7 +24,7 @@ module Autobuild
 
         def update(package)
             Dir.chdir(package.srcdir) {
-                Subprocess.run(package.target, :import, @program, 'up', *@options_up)
+                Subprocess.run(package.name, :import, @program, 'up', *@options_up)
             }
         end
 
@@ -32,15 +35,13 @@ module Autobuild
             FileUtils.mkdir_p(head) if !File.directory?(head)
             Dir.chdir(head) {
                 options = [ @program, '-d', cvsroot, 'co', '-d', tail ] + @options_co + [ modulename ]
-                Subprocess.run(package.target, :import, *options)
+                Subprocess.run(package.name, :import, *options)
             }
         end
     end
 
-    module Import
-        def self.cvs(source, package_options)
-            CVSImporter.new(source[0], source[1], package_options)
-        end
+    def self.cvs(repo, name, package_options = {})
+        CVSImporter.new(repo, name, package_options)
     end
 end
 

data/lib/autobuild/import/darcs.rb

@@ -0,0 +1,32 @@
+require 'autobuild/config'
+require 'autobuild/subcommand'
+require 'autobuild/importer'
+
+module Autobuild
+    class DarcsImporter < Importer
+        def initialize(source, options = {})
+            @source   = source
+            @program  = Autobuild.tool('darcs')
+            super(options)
+	    @pull = [*options[:pull]]
+	    @get = [*options[:get]]
+        end
+        
+        private
+
+        def update(package)
+	    Subprocess.run(package.name, :import, @program, 
+	       'pull', '--all', "--repodir=#{package.srcdir}", '--set-scripts-executable', @source, *@pull)
+        end
+
+        def checkout(package)
+	    Subprocess.run(package.name, :import, @program, 
+	       'get', '--set-scripts-executable', @source, package.srcdir, *@get)
+        end
+    end
+
+    def self.darcs(source, options = {})
+        DarcsImporter.new(source, options)
+    end
+end
+

data/lib/autobuild/import/svn.rb

@@ -2,13 +2,12 @@ require 'autobuild/subcommand'
 require 'autobuild/importer'
 
 module Autobuild
-    class SVNImporter < Importer
-        def initialize(source, options)
-            @source = source.to_a.join("/")
-
-            @program = ($PROGRAMS[:svn] || 'svn')
-            @options_up = options[:svnup].to_a
-            @options_co = options[:svnco].to_a
+    class SVN < Importer
+        def initialize(source, options = {})
+            @source = [*source].join("/")
+            @program    = Autobuild.tool('svn')
+            @options_up = [*options[:svnup]]
+            @options_co = [*options[:svnco]]
             super(options)
         end
 
@@ -16,20 +15,18 @@ module Autobuild
 
         def update(package)
             Dir.chdir(package.srcdir) {
-                Subprocess.run(package.target, :import, @program, 'up', *@options_up)
+                Subprocess.run(package.name, :import, @program, 'up', *@options_up)
             }
         end
 
         def checkout(package)
             options = [ @program, 'co' ] + @options_co + [ @source, package.srcdir ]
-            Subprocess.run(package.target, :import, *options)
+            Subprocess.run(package.name, :import, *options)
         end
     end
 
-    module Import
-        def self.svn(source, options)
-            SVNImporter.new(source, options)
-        end
+    def self.svn(source, options = {})
+        SVN.new(source, options)
     end
 end
 

data/lib/autobuild/import/tar.rb

@@ -91,7 +91,7 @@ module Autobuild
         def update(package)
             checkout if update_cache
         rescue OpenURI::HTTPError
-            raise Autobuild::Exception.new(package.target, :import)
+            raise Autobuild::Exception.new(package.name, :import)
         end
 
         def checkout(package)
@@ -101,10 +101,10 @@ module Autobuild
             FileUtils.mkdir_p base_dir
             cmd = [ 'tar', "x#{TAR_OPTION[mode]}f", cachefile, '-C', base_dir ]
             
-            Subprocess.run(package.target, :import, *cmd)
+            Subprocess.run(package.name, :import, *cmd)
 
         rescue OpenURI::HTTPError
-            raise Autobuild::Exception.new(package.target, :import)
+            raise Autobuild::Exception.new(package.name, :import)
         rescue SubcommandFailed
             FileUtils.rm_f cachefile
             raise

data/lib/autobuild/importer.rb

@@ -1,3 +1,4 @@
+require 'autobuild/config'
 require 'autobuild/exceptions'
 
 class Autobuild::Importer
@@ -8,11 +9,11 @@ class Autobuild::Importer
     def import(package)
         srcdir = package.srcdir
         if File.directory?(srcdir)
-            if $UPDATE
+            if Autobuild.do_update
                 update(package)
                 patch(package)
             else
-                puts "Not updating #{package.target}"
+                puts "Not updating #{package.name}"
                 return
             end
 
@@ -38,9 +39,9 @@ class Autobuild::Importer
     end
 
     def call_patch(package, reverse, file)
-        patch = ($PROGRAMS['patch'] || 'patch')
+        patch = Autobuild.tool('patch')
         Dir.chdir(package.srcdir) {
-            Subprocess.run(package.target, :patch, patch, '-p0', (reverse ? '-R' : nil), "<#{file}")
+            Subprocess.run(package.name, :patch, patch, '-p0', (reverse ? '-R' : nil), "<#{file}")
         }
     end
 

data/lib/autobuild/package.rb

@@ -2,97 +2,137 @@ require 'autobuild/timestamps'
 require 'autobuild/environment'
 require 'autobuild/subcommand'
 
+module Autobuild
+    TARGETS = %w{import prepare build}
+end
+
+# Basic block for the autobuilder
+#
+# The build is done in three phases:
+#   - import
+#   - prepare
+#   - build & install
 class Autobuild::Package
     @@packages = {}
     @@provides = {}
 
+    # the package name
+    attr_reader     :name
+    # set the source directory. If a relative path is given,
+    # it is relative to Autobuild.srcdir. Defaults to #name
+    attr_writer     :srcdir
+    # set the installation directory. If a relative path is given,
+    # it is relative to Autobuild.prefix. Defaults to ''
+    attr_writer :prefix
+    
+    # The importer object for this package
+    attr_accessor :import
+
+    # The list of packages this one depends upon
     attr_reader :dependencies
-    attr_reader :target, :srcdir, :prefix
 
-    def installstamp; "#{prefix}/#{target}-#{STAMPFILE}" end
+    # Absolute path to the source directory. See #srcdir=
+    def srcdir; File.expand_path(@srcdir || name, Autobuild.srcdir) end
+    # Absolute path to the installation directory. See #prefix=
+    def prefix; File.expand_path(@prefix || '', Autobuild.prefix) end
 
-    def self.each(with_provides = false, &p)
-        @@packages.each(&p) 
-        @@provides.each(&p) if with_provides
-    end
-    def self.[](target)
-        @@packages[target] or @@provides[target]
-    end
-
-    ## Available options
-    #   srcdir: the source dir. If a relative path, it is based on $SRCDIR
-    #   prefix: the install dir. If a relative path, it is based on $PREFIX
-    #   import: the package importer object
-    #   depends: the list of package name we depend upon
-    #   provides: a list of aliases for this package
+    # The file which marks when the last sucessful install
+    # has finished. The path is absolute
     #
-    # $SRCDIR and $PREFIX are supposed to be valid absolute paths
-    def initialize(target, options)
-        @target = Package.name2target(target)
-        raise ConfigException, "package #{target} is already defined" if Package[target]
-            
-        @options = options
-        @dependencies = Array.new
-        @provides = Array.new
-
-        srcdir, prefix = 
-            (options[:srcdir] or target.to_s),
-            (options[:prefix] or "")
-
-        srcdir = File.expand_path(srcdir, $SRCDIR)
-        prefix = File.expand_path(prefix, $PREFIX)
-
-        @srcdir, @prefix = srcdir, prefix
-        @import = options[:import]
-        @import.import(self) if @import
+    # A package is sucessfully built when it is installed
+    def installstamp; "#{prefix}/#{name}-#{STAMPFILE}" end
+
+    def initialize(spec)
+        @dependencies   = Array.new
+        @provides       = Array.new
+
+        if Hash === spec
+            name, depends = spec.to_a.first
+        else
+            name, depends = spec, nil
+        end
+
+        name = name.to_s
+        @name = name
+        raise ConfigException, "package #{name} is already defined" if Package[name]
+        @@packages[name] = self
 
+        # Call the config block (if any)
+        yield(self) if block_given?
+        
+        # Declare the installation stampfile
         file installstamp
-        task @target => installstamp
+        task "#{name}-build" => installstamp
+        task :build => "#{name}-build"
 
-        @options[:depends].to_a.each { |p| depends_on(p) }
-        @options[:provides].to_a.each { |p| provides(p) }
-        @@packages[target] = self
-    end
+        # Add dependencies declared in spec
+        depends_on *depends if depends
 
-    @@factories = Hash.new
+        # Define the import task
+        task "#{name}-import" do import end
+        task :import => "#{name}-import"
 
-    def depends_on(p)
-        p = Package.name2target(p)
-        task target => p
-        puts "#{target} depends on #{p}"
+        # Define the prepare task
+        task "#{name}-prepare" do prepare end
+        task :prepare => "#{name}-prepare"
 
-        @dependencies << p
+        task(name) do
+            Rake::Task["#{name}-import"].invoke
+            Rake::Task["#{name}-prepare"].invoke
+            Rake::Task["#{name}-build"].invoke
+        end
+        task :default => name
     end
 
-    def provides(p)
-        p = Package.name2target(p)
-        @@provides[p] = self 
-        puts "Defining #{p} as an alias to #{target}"
-        task p => target
-
-        @provides << p
+    def import; @import.import(self) if @import end
+    def prepare; end
+
+    # This package depends on +packages+
+    def depends_on(*packages)
+        packages.each do |p|
+            p = p.to_s
+            next if p == name
+            unless Package[p]
+                raise ConfigException.new(name), "package #{p} not defined"
+            end
+            file installstamp => Package[p].installstamp
+	    task "#{name}-import" => "#{p}-import"
+	    task "#{name}-prepare" => "#{p}-prepare"
+            @dependencies << p
+        end
     end
 
-    def self.all; @@packages; end
-    def self.name2target(name)
-        if name.respond_to?(:to_str)
-            name.to_str.gsub(/-\//, '_').to_sym
-        elsif name.respond_to?(:to_sym)
-            name.to_sym
-        else
-            raise TypeError, "expected either a symbol or a string, got #{name.class}"
+    # Declare that this package provides +packages+
+    def provides(*packages)
+        packages.each do |p|
+            p = p.to_s
+            @@provides[p] = self 
+            task p => name
+            @provides << p
         end
     end
-    def self.factory(type, klass)
-        @@factories[type] = klass
+
+    # Iterates on all available packages
+    # if with_provides is true, includes the list
+    # of package aliases
+    def self.each(with_provides = false, &p)
+        @@packages.each(&p) 
+        @@provides.each(&p) if with_provides
+    end
+
+    # Gets a package from its name
+    def self.[](name)
+        @@packages[name.to_s] || @@provides[name.to_s]
     end
-    def self.build(type, name, options)
-        raise ConfigException, "#{type} is not a valide package type" if !@@factories.has_key?(type)
+end
 
-        target = name2target(name)
-        task :default => [ target ]
-        raise ConfigException, "there is already a package named #{target}" if Package[target]
-        return @@factories[type].new(target, options)
+module Autobuild
+    def self.package_set(spec)
+	spec.each do |name, packages|
+	    Autobuild::TARGETS.each do |target|
+		task "#{name}-#{target}" => packages.map { |dep| "#{dep}-#{target}" }
+	    end
+	end
     end
 end