autobuild 0.4 → 0.5

data/CHANGES

@@ -0,0 +1,57 @@
+= Autobuild changelog
+
+== Version 0.5
+
+Fixes the mail default behaviour. Added the 'tar' importer.
+
+* all the API is now in a separate module
+* genflags has been renamed back to genomflags. The convention is now to
+  have a <tool>flags option. For instance: genomflags, configureflags
+* added the --[no-]build option to do only import
+* changed behaviour for mail reports:
+    - set sensible default options for mail
+    - mail: true uses default options
+    - mail: <string> is equivalent to
+        mail:
+            to: <string>
+* if a value is undefined in the config file, parameter expansion tries to get
+  it from the program environment, and raises an error if it is not present in
+  the environment vars
+* changed the names of log files. All importers now uses <package>-<import>.log
+* added the 'tar' importer, which downloads and uncompress a tarball 
+
+
+== Version 0.4
+
+* added support to split import and build. For instance
+
+    whole_tree:
+        type: import
+        import: cvs
+        source: [ a, repository ]
+
+    package1:
+        type: autotools
+        srcdir: whole_tree/package1
+        depends: whole_tree
+        
+    package2:
+        type: autotools
+        srcdir: whole_tree/package2
+        depends: whole_tree
+        
+  Works as it should
+
+* the <tt>autotools</tt> package has now an <tt>autogen</tt> options, which gives a name for a script
+  which creates the autotools environment
+* renamed 'genomflags' -> 'genflags'
+* variable interpolation checks for environment variables
+* bugfixes
+
+== Version 0.3
+
+* added support for patching source code. Add patch: [ patches ] to the package configuration
+* renamed autobuild-config, common-config and clean-log to autobuild, common and clean_log. Autobuild
+  warns if it finds one the previous spelling but ignores it anyway
+
+

data/README

@@ -109,6 +109,7 @@ Autobuild uses three sections:
 *update*::    if false, do not update the packages that are already imported (default: true). You
               can also use the <tt>--no-update</tt> on the command line
 
+
 === Directories (<tt>autobuild/srcdir</tt>, <tt>autobuild/prefix</tt> and <tt>autobuild/logdir</tt>)
 *srcdir*::    the path where programs are to be imported. See <b>Packages configuration</b> for 
               more information on how this option is used.
@@ -144,30 +145,27 @@ sets
 
 
 === Mail (<tt>autobuild/mail</tt>)
-If you want to receive a mail when the build has finished (on success and failures), set
-at least the +to+ option, like this:
+Use this options if you want to receive a mail when the build has finished (on success and failures)
 
     autobuild:
-        mail:
-            from: autobuild@mymachine.rubyrules.org
-            to: myself+autobuild@rubyrules.org
-            smtp: localhost
+        mail: true
 
-Other options are:
-*from*:: what to set in the <tt>From:</tt> field, default is <tt>autobuild@hostname</tt>
+Valid options are:
+*to*::   the mail destination, default is <tt>user@hostname</tt> (for instance sylvain@localhost for a user 'sylvain')
+*from*:: the mail source, default is <tt>user@hostname</tt>
 *smtp*:: the stmp server to use. Default is +localhost+
+*port*:: the port the server is running on. Default is the smtp port (25)
 
 All log files relative to the current build are attached to the mail.
 
 
-
 == Configuring packages (<tt>packages/*</tt>)
 === The <tt>packages/config</tt> section
 If you want to add common options in each package, just set it them here. Note that the options
-are /merged/ in the package config. It neither replaces the values in the package nor be replaced
-by them. The merging strategy depends on the way the <tt>common</tt> is specified:
-* if it is an array, the package option is converted to an array and the common option is appended
-* if it is a string, the package option is converted to a string and the common option is appended
+are /merged/ in the package config. It neither replaces the values in the package nor the package 
+options replaces them. The merging strategy depends on the way the option is specified in this common section:
+* if it is an array, the package option is converted to an array and the common options are appended
+* if it is a string, the package option is converted to a string and the common option are appended
 with a space inserted between the two
 * if it is a boolean value, it is <em>overriden</em> by the package value
 * any other values are forbidden
@@ -231,6 +229,22 @@ source and the builder to build and install it.
 *svnup*::   options to add to svn up. Defaults to ''
 *svnco*::   options to add to svn co. Defaults to ''
 
+=== Tar (<tt>type: tar</tt>)
+This importer gets a tarball file, which may be on a remote server, and un-tars
+it. For now, it cannot determine itself what is the directory included in the tarball,
+so you should set the srcdir: appropriately.
+
+For instance, a tarball with one directory <tt>package-0.1</tt> in it will 
+need a <tt>srcdir</tt> option of <tt>package-0.1</tt>. If you do 
+not set +srcdir+, autobuild will untar the package in the global srcdir
+(as intended) but will search for <tt>$global_srcdir/package</tt>
+
+*source*::   the source URL. For now, http, ftp and file URLs are supported
+*cachedir*:: the directory where the local copy of the file should be saved 
+             (for http and ftp URLs only)
+
+
+
 == Available package types (<tt>packages/</tt><em>name</em><tt>/type</tt>)
 === Source only (<tt>type: import</tt>)
 Use +import+ if you need the package sources but don't need to build it. You just need
@@ -275,8 +289,8 @@ The only program used during the build phase is +make+. The make command can too
         make: gnumake
 
 ==== Other options
-*builddir*::    the directory where the build takes place. For now, it has to be a relative path, 
-                which is added to the import dir. The default value is "build"
+*builddir*::    the directory where the build takes place. For now, it has to be a relative path,
+                which will be considered relative to the source directory.
 *configureflags*::  array of options to add to the +configure+ command line
                         configureflags: [ --with-bar-source=$srcdir/$bar_srcdir ]
                         depends: bar
@@ -284,37 +298,6 @@ The only program used during the build phase is +make+. The make command can too
 = Running autobuild in daemon mode
 The <tt>--daemon</tt> command line options makes autobuild go into daemon mode.
  
-= Changes
-== 0.3 to 0.4
-* added support to split import and build. For instance
-
-    whole_tree:
-        type: import
-        import: cvs
-        source: [ a, repository ]
-
-    package1:
-        type: autotools
-        srcdir: whole_tree/package1
-        depends: whole_tree
-        
-    package2:
-        type: autotools
-        srcdir: whole_tree/package2
-        depends: whole_tree
-        
-  Now works well
-
-* the <tt>autotools</tt> package has now an <tt>autogen</tt> options, which gives a name for the script
-  to run to create the autoconf environment
-* renamed 'genomflags' -> 'genflags'
-* variable interpolation checks for environment variables
-* bugfixes
-== 0.2 to 0.3
-* added support for patching source code. Add patch: [ patches ] to the package configuration
-* renamed autobuild-config, common-config and clean-log to autobuild, common and clean_log. Autobuild
-  warns if it finds one the previous spelling but ignores it anyway
-
 = Copyright and license
 Author::    Sylvain Joyeux <sylvain.joyeux@m4x.org>
 Copyright:: Copyright (c) 2005 Sylvain Joyeux

data/Rakefile

@@ -0,0 +1,161 @@
+# Rakefile for Autobuild
+# Copyright 2005 by Sylvain Joyeux (sylvain.joyeux@m4x.org)
+
+# Based on the Rakefile for MetaProject
+# Copyright 2005 by Aslak Hellesoy (aslak.hellesoy@gmail.org)
+# All rights reserved.
+
+# This file is may be distributed under an MIT style license.  See
+# MIT-LICENSE for details.
+
+$:.unshift('lib')
+require 'meta_project'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/xforge'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+# Versioning scheme: MAJOR.MINOR.PATCH
+# MAJOR bumps when API is broken backwards
+# MINOR bumps when the API is broken backwards in a very slight/subtle (but not fatal) way
+# -OR when a new release is made and propaganda is sent out.
+# PATCH is bumped for every API addition and/or bugfix (ideally for every commit)
+# Later DamageControl can bump PATCH automatically.
+#
+# REMEMBER TO KEEP PKG_VERSION IN SYNC WITH THE CHANGES FILE!
+PKG_NAME = "autobuild"
+PKG_VERSION = "0.5"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_FILES = FileList[
+  '[A-Z]*',
+  'lib/**/*.rb', 
+  'doc/**/*'
+]
+
+task :default => [:gem]
+
+# Create a task to build the RDOC documentation tree.
+rd = Rake::RDocTask.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'html'
+#  rdoc.template = 'kilmer'
+#  rdoc.template = 'css2'
+#  rdoc.template = 'doc/jamis.rb'
+  rdoc.title    = "Autobuild"
+  rdoc.options << '--main' << 'README'
+  rdoc.rdoc_files.include('README', 'CHANGES')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+  rdoc.rdoc_files.exclude('doc/**/*_attrs.rdoc')
+end
+
+# ====================================================================
+# Create a task that will package the Rake software into distributable
+# tar, zip and gem files.
+
+spec = Gem::Specification.new do |s|
+  
+  #### Basic information.
+
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = 'Rake-based utility to build and install multiple packages with dependencies'
+  s.description = <<EOF
+Autobuild imports, configures, builds and installs various kinds of software packages.
+It can be used in software development to make sure that nothing is broken in the 
+build process of a set of packages, or can be used as an automated installation tool.
+EOF
+
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+
+  #### Documentation and testing.
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+  s.rdoc_options <<
+    '--title' <<  'Autobuild' <<
+    '--main' << 'README'
+
+  #### Author and project details.
+
+  s.author = "Sylvain Joyeux"
+  s.email = "sylvain.joyeux@m4x.org"
+  s.homepage = "http://autobuild.rubyforge.org"
+  s.rubyforge_project = "autobuild"
+end
+
+# Fix 1.8.4 - 1.8.3 issue
+class << spec
+    def to_yaml
+        out = super 
+        out = '--- ' + out unless out =~ /^---/ 
+        out 
+    end
+end
+
+desc "Build Gem"
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+# Support Tasks ------------------------------------------------------
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  Pathname.new(File.dirname(__FILE__)).egrep(/#.*(FIXME|TODO|TBD|DEPRECATED)/) do |match|
+    puts match
+  end
+end
+
+task :release => [:release_files, :publish_doc, :tag] # :publish_news, 
+
+task :verify_env_vars do
+  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
+  raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
+end
+
+task :publish_doc => :verify_env_vars do
+  publisher = Rake::RubyForgePublisher.new('autobuild', ENV['RUBYFORGE_USER'])
+  publisher.upload
+end
+
+desc "Release files on RubyForge"
+task :release_files => [:gem, :verify_env_vars] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+
+  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new('autobuild')) do |release|
+    # Never hardcode user name and password in the Rakefile!
+    release.user_name = ENV['RUBYFORGE_USER']
+    release.password = ENV['RUBYFORGE_PASSWORD']
+    release.files = release_files.to_a
+    release.release_name = "Autobuild #{PKG_VERSION}"
+    # The rest of the options are defaults (among others, release_notes and release_changes, parsed from CHANGES)
+  end
+end
+
+desc "Publish news on RubyForge"
+task :publish_news => [:gem, :verify_env_vars] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+
+  Rake::XForge::NewsPublisher.new(MetaProject::Project::XForge::RubyForge.new('autobuild')) do |news|
+    # Never hardcode user name and password in the Rakefile!
+    news.user_name = ENV['RUBYFORGE_USER']
+    news.password = ENV['RUBYFORGE_PASSWORD']
+  end
+end
+
+desc "Tag all the svn files with the latest release number (REL=x.y.z)"
+task :tag do
+  reltag = "RELEASE_#{PKG_VERSION.gsub(/\./, '_')}"
+  puts "Tagging svn with [#{reltag}]"
+  base_url = %{svn+ssh://#{RUBYFORGE_USER}@rubyforge.org/var/svn/autobuild}
+  sh %{svn cp #{base_url}/trunk/autobuild #{base_url}/tags/#{reltag}}
+end
+
+

data/lib/autobuild/config-interpolator.rb

@@ -1,117 +1,106 @@
 require 'autobuild/exceptions'
 
-class Regexp
-    def each_match(string)
-        string = string.to_str
-        while data = match(string)
-            yield(data)
-            string = data.post_match
+module Autobuild
+    class UndefinedVariable < ConfigException
+        attr_reader :name
+        attr_accessor :reference
+        def initialize(name, reference = [])
+            @name = name 
+            @reference = reference
         end
-    end
-end
 
-class UndefinedVariable < ConfigException
-    attr_reader :name
-    attr_accessor :reference
-    def initialize(name, reference = [])
-        @name = name 
-        @reference = reference
+        def to_s
+            "undefined variable '#{name}' in #{reference.join('/')}"
+        end
     end
 
-    def to_s
-        "undefined variable '#{name}' in #{reference.join('/')}"
-    end
-end
+    class Interpolator
+        VarDefKey = 'defines'
+        MatchExpr = '\$\{([^}]+)\}|\$(\w+)'
+        PartialMatch = Regexp.new(MatchExpr)
+        WholeMatch = Regexp.new("^(?:#{MatchExpr})$")
 
-class Interpolator
-    VarDefKey = 'defines'
-    MatchExpr = '\$\{([^}]+)\}|\$(\w+)'
-    PartialMatch = Regexp.new(MatchExpr)
-    WholeMatch = Regexp.new("^(?:#{MatchExpr})$")
+        def self.interpolate(config, parent = nil)
+            Interpolator.new(config, parent).interpolate
+        end
 
-    def self.interpolate(config, parent = nil)
-        Interpolator.new(config, parent).interpolate
-    end
+        def initialize(node, parent = nil, variables = {})
+            @node = node
+            @variables = {}
+            @defines = {}
+            @parent = parent
+        end
 
-    def initialize(node, parent = nil, variables = {})
-        @node = node
-        @variables = {}
-        @defines = {}
-        @parent = parent
-    end
+        def interpolate
+            case @node
+            when Hash
+                @defines = (@node[VarDefKey] || {})
+
+                interpolated = Hash.new
+                @node.each do |k, v|
+                    begin
+                        next if k == VarDefKey
+                        interpolated[k] = Interpolator.interpolate(v, self)
+                    rescue UndefinedVariable => e
+                        e.reference.unshift k
+                        raise e
+                    end
+                end
+
+                interpolated
 
-    def interpolate
-        case @node
-        when Hash
-            @defines = (@node[VarDefKey] || {})
+            when Array
+                @node.collect { |v| Interpolator.interpolate(v, self) }
 
-            interpolated = Hash.new
-            @node.each do |k, v|
+            else
                 begin
-                    next if k == VarDefKey
-                    interpolated[k] = Interpolator.interpolate(v, self)
+                    each_interpolation(@node) { |varname| value_of(varname) }
                 rescue UndefinedVariable => e
-                    e.reference.unshift k
+                    e.reference.unshift @node.to_str if @node.respond_to?(:to_str)
                     raise e
                 end
             end
-
-            interpolated
-
-        when Array
-            @node.collect { |v| Interpolator.interpolate(v, self) }
-
-        else
-            begin
-                each_interpolation(@node) { |varname| value_of(varname) }
-            rescue UndefinedVariable => e
-                e.reference.unshift @node.to_str if @node.respond_to?(:to_str)
-                raise e
-            end
         end
-    end
 
-    def value_of(name)
-        if @defines.has_key?(name)
-            value = @defines.delete(name)
-            @variables[name] = each_interpolation(value) { |varname|
-                begin
-                    value_of(varname)
-                rescue UndefinedVariable => e
-                    if e.varname == name
-                        raise ConfigException, "cyclic reference found in definition of '#{name}'"
-                    else
-                        raise
+        def value_of(name)
+            if @defines.has_key?(name)
+                value = @defines.delete(name)
+                @variables[name] = each_interpolation(value) { |varname|
+                    begin
+                        value_of(varname)
+                    rescue UndefinedVariable => e
+                        if e.varname == name
+                            raise ConfigException, "cyclic reference found in definition of '#{name}'"
+                        else
+                            raise
+                        end
                     end
-                end
-            }
-        elsif @variables.has_key?(name)
-            @variables[name]
-        elsif @parent
-            @parent.value_of(name)
-        elsif ENV[name.to_s]
-            ENV[name.to_s]
-        else
-            raise UndefinedVariable.new(name)
+                }
+            elsif @variables.has_key?(name)
+                @variables[name]
+            elsif @parent
+                @parent.value_of(name)
+            elsif ENV[name.to_s]
+                ENV[name.to_s]
+            else
+                raise UndefinedVariable.new(name)
+            end
         end
-    end
 
-    def each_interpolation(value)
-        return value if (!value.respond_to?(:to_str) || value.empty?)
-        
-        # Special case: if 'value' is *only* an interpolation, avoid
-        # conversion to string
-        WholeMatch.each_match(value) do |data|
-            return yield(data[1] || data[2])
-        end
+        def each_interpolation(value)
+            return value if (!value.respond_to?(:to_str) || value.empty?)
+            
+            # Special case: if 'value' is *only* an interpolation, avoid
+            # conversion to string
+            if match = WholeMatch.match(value)
+                return yield($1 || $2)
+            end
 
-        interpolated = ''
-        data = nil
-        PartialMatch.each_match(value) do |data|
-            varname = data[1] || data[2]
-            interpolated << data.pre_match << yield(varname)
+            return value.gsub(PartialMatch) { |match|
+                varname = $1 || $2
+                yield(varname)
+            }
         end
-        return data ? (interpolated << data.post_match) : value
     end
 end