autobuild 0.6.4 → 0.6.5

data/Changes.txt

@@ -1,3 +1,8 @@
+== Version 0.6.5
+
+* add Autobuild.default_packages
+* big rdoc update
+
 == Version 0.6.4
 
 This is a bugfix release

data/Rakefile

@@ -8,7 +8,7 @@ Hoe.new('autobuild', Autobuild::VERSION) do |p|
     p.summary = 'Rake-based utility to build and install multiple packages with dependencies'
     p.description = p.paragraphs_of('README.txt', 3..5).join("\n\n")
     p.url         = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
-    p.changes     = p.paragraphs_of('Changes.txt', 0..2).join("\n\n")
+    p.changes     = p.paragraphs_of('Changes.txt', 0..1).join("\n\n")
 
     p.extra_deps << ['rake', '>= 0.7.0']
     p.extra_deps << 'rmail'

data/bin/autobuild

@@ -9,6 +9,7 @@ DEFAULT_HTTP_PORT = 2000
 
 # Load the command line options
 conffile, *packages = Autobuild.commandline(ARGV)
+Autobuild.packages = packages
 
 # make conffile an absolute path since daemonize mode makes
 # / the current directory
@@ -30,6 +31,9 @@ begin
 	targets = ['import']
 	targets += ['prepare', 'build'] if Autobuild.do_build
         targets.each do |phase|
+	    packages = Autobuild.packages
+	    packages = Autobuild.default_packages if packages.empty?
+
             if packages.empty?
                 Rake::Task[phase].invoke
             else

data/lib/autobuild.rb

@@ -3,6 +3,6 @@ require 'autobuild/reporting'
 require 'autobuild/package'
 
 module Autobuild
-    VERSION = "0.6.4" unless defined? Autobuild::VERSION
+    VERSION = "0.6.5" unless defined? Autobuild::VERSION
 end
 

data/lib/autobuild/config.rb

@@ -2,25 +2,44 @@ require 'optparse'
 require 'rake'
 require 'singleton'
 
+# Evaluates +script+ in autobuild context
 def Autobuild(&script)
     Autobuild.send(:module_eval, &script)
 end
 
+# Main Autobuild module. This module includes the build configuration options
+# (see Autobuild::DEFAULT_OPTIONS) for the default values)
+# nice:: the nice value at which we should spawn subprocesses
+# srcdir:: the base source directory. If a package defines a relative srcdir, then
+#          it is defined relatively to Autobuild.srcdir
+# prefix:: the base install directory. If a package defines a relative prefix, then
+#          it is defined relatively to Autobuild.prefix.
+# verbose:: if true, displays all subprocesses output
+# debug:: more verbose than 'verbose': displays Rake's debugging output
+# do_update:: if we should update the packages
+# do_build:: if we should build the packages
+# daemonize:: if the build should go into daemon mode
+# 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.
+#                    It this array is empty too, build all defined packages.
 module Autobuild
     class << self
         %w{ nice srcdir prefix
             verbose debug do_update do_build
-            daemonize clean_log }.each do |name|
+            daemonize clean_log packages default_packages }.each do |name|
             attr_accessor name
         end
 
+	# Configure the programs used by different packages
         attr_reader :programs
+	# The directory in which logs are saved. Defaults to PREFIX/log.
         attr_writer :logdir
     end
     DEFAULT_OPTIONS = { :nice => 0,
         :srcdir => nil, :prefix => nil, :logdir => nil,
         :verbose => false, :debug => false, :do_build => true, :do_update => true, 
-        :daemonize => false }
+        :daemonize => false, :packages => [], :default_packages => [] }
 
     @programs = Hash.new
     DEFAULT_OPTIONS.each do |name, value|
@@ -29,29 +48,42 @@ module Autobuild
 
     @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.
+	# [: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
+
+	# The directory in which logs are saved
         def logdir; @logdir || "#{prefix}/log" end
 
+	# Removes all log files
         def clean_log!
             Reporting.each_log do |file|
                 FileUtils.rm_f file
             end
         end
 
-        # Get a given program, using its name as default value
+        # Get a given program, using its name as default value. For
+	# instance
+	#   tool('automake') 
+	# will return 'automake' unless the autobuild script defined
+	# another automake program in Autobuild.programs by doing
+	#   Autobuild.programs['automake'] = 'automake1.9'
         def tool(name)
             programs[name.to_sym] || programs[name.to_s] || name.to_s
         end
 
-        # Gets autobuild options from the command line
-        # and returns the remaining elements
+	# Gets autobuild options from the command line and returns the
+	# remaining elements
         def commandline(args)
             parser = OptionParser.new do |opts|
                 opts.separator "Path specification"
                 opts.on("--srcdir PATH", "sources are installed in PATH") do |@srcdir| end
-                opts.on("--prefix PATH", "built packages are installed in PATH") do |@prefix|
-                    logdir = "#{prefix}/autobuild"
-                end
+                opts.on("--prefix PATH", "built packages are installed in PATH") do |@prefix| end
                 opts.on("--logdir PATH", "logs are saved in PATH (default: <prefix>/autobuild)") do |@logdir| end
 
                 opts.separator ""
@@ -68,7 +100,7 @@ module Autobuild
                 opts.separator ""
                 opts.separator "Program output"
                 opts.on("--[no-]verbose", "display output of commands on stdout") do |@verbose| end
-                opts.on("--[no-]debug", "verbose information (for debugging purposes)") do |@debug| end
+                opts.on("--[no-]debug", "debug information (for debugging purposes)") do |@debug| end
 
                 opts.separator ""
 		opts.separator "Mail reports"

data/lib/autobuild/import/cvs.rb

@@ -4,6 +4,14 @@ require 'autobuild/importer'
 
 module Autobuild
     class CVSImporter < Importer
+	# Creates a new importer which gets the module +name+ from the
+	# repository in +root+. The following values are allowed in +options+:
+	# [:cvsup] options to give to 'cvs up'. Default: -dP.
+	# [:cvsco] options to give to 'cvs co'. Default: -P.
+	#
+	# This importer uses the 'cvs' tool to perform the import. It defaults
+	# to 'cvs' and can be configured by doing 
+	#   Autobuild.programs['cvs'] = 'my_cvs_tool'
         def initialize(root, name, options = {})
             @root = root
             @module = name
@@ -16,13 +24,12 @@ module Autobuild
             super(options)
         end
         
-        def modulename
-            @module
-        end
+	# Returns the module to get
+        def modulename; @module end
 
         private
 
-        def update(package)
+        def update(package) # :nodoc:
             Dir.chdir(package.srcdir) do
 		if !File.exists?("#{package.srcdir}/CVS/Root")
 		    raise ConfigException, "#{package.srcdir} is not a CVS working copy"
@@ -38,7 +45,7 @@ module Autobuild
 	    end
         end
 
-        def checkout(package)
+        def checkout(package) # :nodoc:
             head, tail = File.split(package.srcdir)
             cvsroot = @root
                
@@ -50,8 +57,10 @@ module Autobuild
         end
     end
 
-    def self.cvs(repo, name, package_options = {})
-        CVSImporter.new(repo, name, package_options)
+    # Returns the CVS importer which will get the +name+ module in repository
+    # +repo+. The allowed values in +options+ are described in CVSImporter.new.    
+    def self.cvs(repo, name, options = {})
+        CVSImporter.new(repo, name, options)
     end
 end
 

data/lib/autobuild/import/darcs.rb

@@ -4,17 +4,25 @@ require 'autobuild/importer'
 
 module Autobuild
     class DarcsImporter < Importer
+	# Creates a new importer which gets the source from the Darcs repository
+	# +source+ # The following values are allowed in +options+:
+	# [:get] options to give to 'darcs get'.
+	# [:pull] options to give to 'darcs pull'.
+	#
+	# This importer uses the 'darcs' tool to perform the import. It defaults
+	# to 'darcs' and can be configured by doing 
+	#   Autobuild.programs['darcs'] = 'my_darcs_tool'
         def initialize(source, options = {})
             @source   = source
             @program  = Autobuild.tool('darcs')
             super(options)
 	    @pull = [*options[:pull]]
-	    @get = [*options[:get]]
+	    @get  = [*options[:get]]
         end
         
         private
 
-        def update(package)
+        def update(package) # :nodoc:
 	    if !File.directory?( File.join(package.srcdir, '_darcs') )
 		raise ConfigException, "#{package.srcdir} is not a Darcs repository"
 	    end
@@ -23,12 +31,14 @@ module Autobuild
 	       'pull', '--all', "--repodir=#{package.srcdir}", '--set-scripts-executable', @source, *@pull)
         end
 
-        def checkout(package)
+        def checkout(package) # :nodoc:
 	    Subprocess.run(package.name, :import, @program, 
 	       'get', '--set-scripts-executable', @source, package.srcdir, *@get)
         end
     end
 
+    # Returns the Darcs importer which will get the source from the Darcs repository
+    # +source+. The allowed values in +options+ are described in DarcsImporter.new.
     def self.darcs(source, options = {})
         DarcsImporter.new(source, options)
     end

data/lib/autobuild/import/svn.rb

@@ -3,6 +3,14 @@ require 'autobuild/importer'
 
 module Autobuild
     class SVN < Importer
+	# Creates an importer which gets the source for the Subversion URL +source+.
+	# The following options are allowed:
+	# [:svnup] options to give to 'svn up'
+	# [:svnco] options to give to 'svn co'
+	#
+	# This importer uses the 'svn' tool to perform the import. It defaults
+	# to 'svn' and can be configured by doing 
+	#   Autobuild.programs['svn'] = 'my_svn_tool'
         def initialize(source, options = {})
             @source = [*source].join("/")
             @program    = Autobuild.tool('svn')
@@ -13,7 +21,7 @@ module Autobuild
 
         private
 
-        def update(package)
+        def update(package) # :nodoc:
             Dir.chdir(package.srcdir) {
 		old_lang, ENV['LC_ALL'] = ENV['LC_ALL'], 'C'
 		svninfo = IO.popen("svn info") { |io| io.readlines }
@@ -34,12 +42,14 @@ module Autobuild
             }
         end
 
-        def checkout(package)
+        def checkout(package) # :nodoc:
             options = [ @program, 'co' ] + @options_co + [ @source, package.srcdir ]
             Subprocess.run(package.name, :import, *options)
         end
     end
 
+    # Creates a subversion importer which import the source for the Subversion
+    # URL +source+. The allowed values in +options+ are described in SVN.new.
     def self.svn(source, options = {})
         SVN.new(source, options)
     end

data/lib/autobuild/import/tar.rb

@@ -2,8 +2,11 @@ require 'open-uri'
 
 module Autobuild
     class TarImporter < Importer
+	# The tarball is not compressed
         Plain = 0
+	# The tarball is compressed with gzip
         Gzip  = 1
+	# The tarball is compressed using bzip
         Bzip  = 2
 
         TAR_OPTION = {
@@ -12,22 +15,25 @@ module Autobuild
             Bzip => 'j'
         }
 
+	# Known URI schemes for +url+
         VALID_URI_SCHEMES = [ 'file', 'http', 'ftp' ]
 
+	# Returns the unpack mode from the file name
         def self.url_to_mode(url)
             ext = File.extname(url)
+            unless ext == '.tar'
+                raise "Invalid file type in #{url}" unless File.basename(url, ext) != '.tar'
+            end
             mode =  case ext
                         when '.tar'; Plain
                         when '.gz'; Gzip
                         when '.bz2'; Bzip
                     end
 
-            unless ext == '.tar'
-                raise "Invalid file type in #{url}" unless File.basename(url, ext) != '.tar'
-            end
             mode
         end
 
+	# Updates the downloaded file in cache only if it is needed
         def update_cache
             do_update = true
 
@@ -67,6 +73,7 @@ module Autobuild
             end
         end
 
+	# Sets the source URL and update +cachefile+ and +mode+ attributes accordingly.
         def url=(url)
             @url = URI.parse(url)
             raise ConfigException, "invalid URL #{url}" unless VALID_URI_SCHEMES.include?(@url.scheme)
@@ -79,22 +86,31 @@ module Autobuild
             end
         end
 
-        attr_reader :url, :cachefile, :mode
+	# The source URL
+        attr_reader :url
+	# The local file (either a downloaded file if +url+ is not local, or +url+ itself)
+	attr_reader :cachefile
+	# The unpack mode. One of Bzip, Gzip or Plain
+	attr_reader :mode
+	# The directory in which remote files are cached
         def cachedir; @options[:cachedir] end
 
+	# Creates a new importer which downloads +url+ in +cachedir+ and unpacks it. The following options
+	# are allowed:
+	# [:cachedir] the cache directory. Defaults to "#{Autobuild.prefix}/cache"
         def initialize(url, options)
             @options = options.dup
-            @options[:cachedir] ||= $CACHEDIR
+            @options[:cachedir] ||= "#{Autobuild.prefix}/cache"
             self.url = url
         end
 
-        def update(package)
+        def update(package) # :nodoc:
             checkout if update_cache
         rescue OpenURI::HTTPError
             raise Autobuild::Exception.new(package.name, :import)
         end
 
-        def checkout(package)
+        def checkout(package) # :nodoc:
             update_cache
 
             base_dir = File.dirname(package.srcdir)
@@ -111,10 +127,10 @@ module Autobuild
         end
     end
 
-    module Import
-        def self.tar(source, package_options)
-            TarImporter.new(source, package_options)
-        end
+    # Creates an importer which downloads a tarball from +source+ and unpacks
+    # it. The allowed values in +options+ are described in TarImporter.new.
+    def self.tar(source, options)
+	TarImporter.new(source, options)
     end
 end
 

data/lib/autobuild/importer.rb

@@ -1,11 +1,17 @@
 require 'autobuild/config'
 require 'autobuild/exceptions'
 
+# This class is the base class for objects that are used to get the source from
+# various RCS into the package source directory. A list of patches to apply
+# after the import can be given in the +:patches+ option.
 class Autobuild::Importer
-    def initialize(options)
-        @options = options
-    end
+    # Creates a new Importer object. The options known to Importer are:
+    # [:patches] a list of patch to apply after import
+    #
+    # More options are specific to each importer type.
+    def initialize(options); @options = options end
 
+    # Performs the import of +package+
     def import(package)
         srcdir = package.srcdir
         if File.directory?(srcdir)
@@ -32,8 +38,8 @@ class Autobuild::Importer
 
     private
     
-    # We assume that package.srcdir already exists (checkout 
-    # is supposed to have been called)
+    # We assume that package.srcdir already exists (checkout is supposed to
+    # have been called)
     def patchlist(package)
         "#{package.srcdir}/patches-autobuild-stamp"
     end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: autobuild
 version: !ruby/object:Gem::Version 
-  version: 0.6.4
-date: 2007-02-12 00:00:00 +01:00
+  version: 0.6.5
+date: 2007-02-14 00:00:00 +01:00
 summary: Rake-based utility to build and install multiple packages with dependencies
 require_paths: 
 - lib