rant 0.4.0 → 0.4.2

data/NEWS

@@ -1,6 +1,22 @@
 
 = Rant NEWS
 
+== Rant 0.4.2
+
+This is mainly a bugfix release and thus fully backwards compatible to
+0.4.0.
+
+Fixes and minor improvements:
+* Fixes for Ruby 1.8.1 compatibility.
+* Fixes for Rules and multiple buildfiles per project.
+* rant-import created scripts append inlined files to
+  $LOADED_FEATURES.
+
+New features:
+* The +make+ command.
+* New method +sub_ext+ for filelists.
+Read doc/advanced.rdoc[link:files/doc/advanced_rdoc.html].
+
 == Rant 0.4.0
 
 Unless you extended Rant with a custom generator, you can upgrade from

data/README

@@ -39,7 +39,7 @@ Running rant in the directory of this file:
 will ensure that the "data" file in the "backup" directory is up to
 date.
 
-This document was written for version 0.4.0 of Rant. Most things
+This document was written for version 0.4.2 of Rant. Most things
 described here will work for older/newer versions of Rant, but look at
 the README file in the Rant distribution you've installed for exact
 documentation of your Rant version.
@@ -204,7 +204,8 @@ Rant was tested on:
 
     System		Ruby version
     =======================================================
-    Linux		1.8.2
+    Linux		1.8.1
+                        1.8.2
 			1.8.3 preview 1
 			1.9
     MacOS X		1.8.2

data/Rantfile

@@ -124,11 +124,10 @@ task "to-win" => :package do
     win_dir = "/mnt/data_fat/stefan/Ruby"
     Dir["pkg/*"].each { |f|
 	target = File.join(win_dir, File.basename(f))
-	file target => f do |t|
-	    sys.rm_rf target if test(?e, target)
-	    sys.cp_r f, t.name
+	make target => f do |t|
+            sys.rm_rf target if test(?e, target)
+            sys.cp_r f, t.name
 	end
-        rac.make target
     }
 end
 

data/doc/advanced.rdoc

@@ -77,6 +77,10 @@ is a brief overview:
     # create a manifest file
     open("MANIFEST", "w") { |f| f.puts fl }
 
+    sources = sys["*.c"]
+    # substitute all filename extensions with .o
+    objs = sources.sub_ext "o"
+
 Additionally, you can use all methods available for an array. Lookup
 docs with ri for array methods:
     % ri Array
@@ -231,7 +235,7 @@ define the project version, e.g.:
     #define VERSION 2.3
 Many of your tools use this version number, so you have decided to
 duplicate it in a file called +version+, which contains just a line
-with the program version. On solution to automate the +version+ file
+with the program version. One solution to automate the +version+ file
 creation would be to write a file task:
     file "version" => "config.h" do |t|
 	puts "updating version file"
@@ -240,12 +244,15 @@ creation would be to write a file task:
 and make all other tasks that need this version dependent on it. But
 this can get very tedious if you have many tasks that need this
 version file. Another solution is to just run the task every time the
-Rantfile is sourced. This can be achieved by placing the following
-statement after the "version" task:
-    rac.build "version"
-This tells rant to immediately invoke all tasks that are required to
-build the version file. But imagine your users just want to see the
-list of available tasks:
+Rantfile is sourced. This can be achieved by replacing the +file+
+command with the +make+ command:
+    make "version" => "config.h" do |t|
+	puts "updating version file"
+	open("w", t.name) { |f| f.puts(extract_config_version()) }
+    end
+This creates a file task like before and tells rant to immediately
+invoke all tasks that are required to build the version file. But
+imagine your users just want to see the list of available tasks:
     % rant --tasks
     updating version file
     rant foo		# build foo program
@@ -253,13 +260,11 @@ list of available tasks:
     rant clean		# remove generated files
 Hmm, we really didn't need the version to show our users the available
 tasks. To avoid this, wrap such code in an Action:
-    file "version" => "config.h" do |t|
-	puts "updating version file"
-	open("w", t.name) { |f| f.puts(extract_config_version()) }
-    end
-
     gen Action do
-	rac.build "version"
+        make "version" => "config.h" do |t|
+            puts "updating version file"
+            open("w", t.name) { |f| f.puts(extract_config_version()) }
+        end
     end
 And now on a clean source base:
     % rant --tasks

data/doc/examples/c_cpp_examples/Rantfile

@@ -0,0 +1,37 @@
+
+import "autoclean", "package/tgz"
+
+cpp_dirs = sys["c++/problem_*"]
+c_dirs = sys["c/problem_*"]
+all_dirs = cpp_dirs + c_dirs
+
+cpp_rf_template = "c++/template.rf"
+c_rf_template = "c/template.rf"
+
+desc "Run all C and C++ tests."
+task :run => all_dirs.map{ |f| "#{f}/run" }
+desc "Build all."
+task :build => all_dirs.map{ |f| "#{f}/test" }
+
+desc "Remove all autogenerated files."
+gen AutoClean
+
+source "rule.rf"
+
+desc "Create source package."
+gen Package::Tgz, "pkg/c_cpp_exercises",
+    :files => sys["Rantfile", "**/*.{c,cpp,h,rf}"]
+
+gen Action do
+    cpp_dirs.each { |dir|
+        make "#{dir}/Rantfile" => cpp_rf_template do |t|
+            sys.cp t.source, t.name
+        end
+    }
+    c_dirs.each { |dir|
+        make "#{dir}/Rantfile" => c_rf_template do |t|
+            sys.cp t.source, t.name
+        end
+    }
+    subdirs cpp_dirs, c_dirs
+end

data/doc/examples/c_cpp_examples/c/problem_1_1/another_test.c

@@ -0,0 +1,6 @@
+
+#include "another_test.h"
+
+void another_test()
+{
+}

data/doc/examples/c_cpp_examples/c/problem_1_1/another_test.h

@@ -0,0 +1,7 @@
+
+#ifndef ANOTHER_TEST_H
+#define ANOTHER_TEST_H
+
+void another_test(void);
+
+#endif

data/doc/examples/c_cpp_examples/c/problem_1_1/main.c

@@ -0,0 +1,12 @@
+
+#include <stdio.h>
+#include "test.h"
+#include "another_test.h"
+
+int main(char argc, char** argv)
+{
+    test();
+    another_test();
+    printf("Hello, world!\n");
+    return 0;
+}

data/doc/examples/c_cpp_examples/c/problem_1_1/test.c

@@ -0,0 +1,6 @@
+
+#include "test.h"
+
+void test()
+{
+}

data/doc/examples/c_cpp_examples/c/problem_1_1/test.h

@@ -0,0 +1,7 @@
+
+#ifndef TEST_H
+#define TEST_H
+
+void test(void);
+
+#endif

data/doc/examples/c_cpp_examples/c/template.rf

@@ -0,0 +1,21 @@
+# Autogenerated. Do not modify!
+# Create additional tasks and make other modifications in custom.rf.
+
+import "c/dependencies", "autoclean"
+
+task :run => "test" do
+  sys "./test"
+end
+
+gen C::Dependencies
+gen Action do source "c_dependencies" end
+
+file "test" => sys["*.c"].sub_ext("o") do |t|
+  sys "gcc -o #{t.name} #{t.prerequisites}"
+end
+
+gen AutoClean
+
+source "../../rule.rf"
+
+source "custom.rf" if File.exist? "custom.rf"

data/doc/examples/c_cpp_examples/c++/problem_1_1/another_test.cpp

@@ -0,0 +1,6 @@
+
+#include "another_test.h"
+
+void another_test()
+{
+}

data/doc/examples/c_cpp_examples/c++/problem_1_1/another_test.h

@@ -0,0 +1,5 @@
+
+#ifndef ANOTHER_TEST_H
+#define ANOTHER_TEST_H
+
+#endif

data/doc/examples/c_cpp_examples/c++/problem_1_1/main.cpp

@@ -0,0 +1,12 @@
+
+#include <iostream>
+#include "test.h"
+#include "another_test.h"
+
+using namespace std;
+
+int main(char argc, char** argv)
+{
+    cout << "Hello, world!" << endl;
+    return 0;
+}

data/doc/examples/c_cpp_examples/c++/problem_1_1/test.cpp

@@ -0,0 +1,6 @@
+
+#include "test.h"
+
+void test()
+{
+}

data/doc/examples/c_cpp_examples/c++/problem_1_1/test.h

@@ -0,0 +1,5 @@
+
+#ifndef TEST_H
+#define TEST_H
+
+#endif

data/doc/examples/c_cpp_examples/c++/template.rf

@@ -0,0 +1,21 @@
+# Autogenerated. Do not modify!
+# Create additional tasks and make other modifications in custom.rf.
+
+import "c/dependencies", "autoclean"
+
+task :run => "test" do
+  sys "./test"
+end
+
+gen C::Dependencies
+gen Action do source "c_dependencies" end
+
+file "test" => sys["*.cpp"].sub_ext("o") do |t|
+  sys "g++ -o #{t.name} #{t.prerequisites}"
+end
+
+gen AutoClean
+
+source "../../rule.rf"
+
+source "custom.rf" if File.exist? "custom.rf"

data/doc/examples/c_cpp_examples/rule.rf

@@ -0,0 +1,7 @@
+gen Rule, '.o' => '.cpp' do |t|
+  sys "g++ -c -o #{t.name} #{t.source}"
+end
+
+gen Rule, '.o' => '.c' do |t|
+  sys "gcc -c -o #{t.name} #{t.source}"
+end

data/doc/rantfile.rdoc

@@ -36,6 +36,7 @@ methods with the Rant application:
 +var+::		Provides access to variables accessible in Rantfiles
 		and from the commandline.
 +rac+::		The "Rant compiler" which is compiling the Rantfiles.
++make+::        Immediately build a target.
 
 === Defining a task
 

data/lib/rant/archive/rubyzip/tempfile_bugfixed.rb

@@ -7,6 +7,7 @@
 require 'delegate'
 require 'tmpdir'
 
+module Rant
 module BugFix  #:nodoc:all
 
 # A class for managing temporary files.  This library is written to be
@@ -184,12 +185,13 @@ class Tempfile < DelegateClass(File)
 end
 
 end # module BugFix
-if __FILE__ == $0
+end # module Rant
+#if __FILE__ == $0
 #  $DEBUG = true
-  f = Tempfile.new("foo")
-  f.print("foo\n")
-  f.close
-  f.open
-  p f.gets # => "foo\n"
-  f.close!
-end
+#  f = Tempfile.new("foo")
+#  f.print("foo\n")
+#  f.close
+#  f.open
+#  p f.gets # => "foo\n"
+#  f.close!
+#end

data/lib/rant/archive/rubyzip.rb

@@ -29,16 +29,11 @@
 
 require 'delegate'
 require 'singleton'
-require 'tempfile'
 require 'ftools'
 require 'zlib'
 require 'rant/archive/rubyzip/stdrubyext'
 require 'rant/archive/rubyzip/ioextras'
-
-if Tempfile.superclass == SimpleDelegator
-  require 'rant/archive/rubyzip/tempfile_bugfixed'
-  Tempfile = BugFix::Tempfile
-end
+require 'rant/tempfile'
 
 module Zlib  #:nodoc:all
   if ! const_defined? :MAX_WBITS
@@ -1270,7 +1265,7 @@ module Rant::Archive::Rubyzip
     end
     
     def get_tempfile
-      tempFile = Tempfile.new(File.basename(name), File.dirname(name))
+      tempFile = Rant::Tempfile.new(File.basename(name), File.dirname(name))
       tempFile.binmode
       tempFile
     end
@@ -1320,7 +1315,7 @@ module Rant::Archive::Rubyzip
   class ZipStreamableStream < DelegateClass(ZipEntry) #nodoc:all
     def initialize(entry)
       super(entry)
-      @tempFile = Tempfile.new(File.basename(name), File.dirname(zipfile))
+      @tempFile = Rant::Tempfile.new(File.basename(name), File.dirname(zipfile))
       @tempFile.binmode
     end
 

data/lib/rant/import/archive.rb

@@ -9,6 +9,7 @@
 
 require 'rant/rantlib'
 require 'rant/import/subfile'
+#require 'rant/tempfile' #rant-import:uncomment
 
 module Rant::Generators::Archive
     # A subclass has to provide a +define_task+ method to act as a
@@ -131,6 +132,7 @@ module Rant::Generators::Archive
 		get_archive_path
 	    end
 	end
+        alias to_rant_target path
 
 	# Path to archive without basedir.
 	def get_archive_path
@@ -156,7 +158,9 @@ module Rant::Generators::Archive
             else
                 fl = Rant::RacFileList.filelist(@rac, fl)
 	    end
-            @res_files = fl.lazy_uniq!.lazy_sort!
+            # remove leading `./' relicts
+            @res_files = fl.lazy_map! { |fn| fn.sub(/^\.\/(?=.)/,'') }
+            @res_files.lazy_uniq!.lazy_sort!
 	end
 
 	# Creates an (eventually) temporary manifest file and yields
@@ -164,11 +168,11 @@ module Rant::Generators::Archive
 	def with_manifest
 	    fl = get_files
 	    if @manifest
-		rac.make @manifest
+		rac.build @manifest
 		yield @manifest
 	    else
-		require 'tempfile'
-		tf = Tempfile.new "rant"
+                require 'rant/tempfile' #rant-import:remove
+		tf = Rant::Tempfile.new "rant"
 		begin
 		    fl.each { |path| tf.puts path }
 		    tf.close

data/lib/rant/import/rubydoc.rb

@@ -10,7 +10,7 @@ module Rant
 		if !args || args.empty?
 		    self.new(app, ch, &block)
 		elsif args.size == 1
-		    name, pre, file, ln = app.normalize_task_arg(args.first, ch)
+		    name, pre = app.normalize_task_arg(args.first, ch)
 		    self.new(app, ch, name, pre, &block)
 		else
 		    app.abort(app.pos_text(file, ln),

data/lib/rant/import/rubytest.rb

@@ -3,23 +3,18 @@ require 'rant/rantlib'
 
 module Rant
     class Generators::RubyTest
-
-	class << self
-
-	    def rant_gen(app, ch, args, &block)
-		if !args || args.empty?
-		    self.new(app, ch, &block)
-		elsif args.size == 1
-		    name, pre, file, ln =
-		    app.normalize_task_arg(args.first, ch)
-		    self.new(app, ch, name, pre, &block)
-		else
-		    app.abort(app.pos_text(file, ln),
-			"RubyTest takes only one additional argument, " +
-			"which should be like one given to the `task' command.")
-		end
-	    end
-	end
+        def self.rant_gen(app, ch, args, &block)
+            if !args || args.empty?
+                self.new(app, ch, &block)
+            elsif args.size == 1
+                name, pre = app.normalize_task_arg(args.first, ch)
+                self.new(app, ch, name, pre, &block)
+            else
+                app.abort_at(ch,
+                    "RubyTest takes only one additional argument, " +
+                    "which should be like one given to the `task' command.")
+            end
+        end
 
 	attr_accessor :verbose
 	attr_accessor :libs

data/lib/rant/import.rb

@@ -125,6 +125,7 @@ EOH
 		mf << mono_plugins
 		mf << <<EOF
 
+$".concat([#{@included_files.map{ |f| "'" + f + ".rb'" }.join(", ")}])
 Rant::CODE_IMPORTS.concat %w(#{@included_imports.join(' ')}
     #{(@included_plugins.map do |i| "plugin/" + i end).join(' ')})
 
@@ -142,7 +143,7 @@ def require libf
     end
 end
 
-Rant.run
+exit Rant.run
 EOF
 	    }
 	    msg "Done.",
@@ -213,7 +214,7 @@ EOF
 	    done
 	end
 
-	def msg *args
+	def msg(*args)
 	    super unless @quiet
 	end
 

data/lib/rant/rantenv.rb

@@ -1,4 +1,7 @@
-#!/usr/bin/ruby
+
+# rantenv.rb - Environment interface.
+#
+# Copyright (C) 2005 Stefan Lang <langstefan@gmx.at>
 
 require 'rbconfig'
 
@@ -106,17 +109,17 @@ module Rant::Console
 	    RANT_PREFIX
 	end
     end
-    def msg *text
+    def msg(*text)
         pre = msg_prefix
         text = text.join("\n" + ' ' * pre.length)
         $stderr.puts(pre + text)
     end
-    def err_msg *text
+    def err_msg(*text)
         pre = msg_prefix + ERROR_PREFIX
         text = text.join("\n" + ' ' * pre.length)
         $stderr.puts(pre + text)
     end
-    def warn_msg *text
+    def warn_msg(*text)
         pre = msg_prefix + WARN_PREFIX
         text = text.join("\n" + ' ' * pre.length)
         $stderr.puts(pre + text)

data/lib/rant/rantfile.rb

@@ -59,24 +59,26 @@ module Rant
 	attr_accessor :rantfile
 	# The linenumber in rantfile where this task was defined.
 	attr_accessor :line_number
+	# The directory in which this task was defined, relative to
+	# the projects root directory.
+        attr_accessor :project_subdir
 	
 	def initialize
 	    @description = nil
 	    @rantfile = nil
 	    @line_number = nil
 	    @run = false
+            @project_subdir = ""
 	end
 
-	# Returns the full name of this task.
+	# Returns the name of this task.
 	def to_s
-	    full_name
+	    name
 	end
 
-	# The directory in which this task was defined, relative to
-	# the projects root directory.
-	def project_subdir
-	    @rantfile.nil? ? "" : @rantfile.project_subdir
-	end
+        def to_rant_target
+            name
+        end
 
 	# Basically project_subdir/name
 	#
@@ -132,6 +134,7 @@ module Rant
 	# Cause task to fail. Usually called from inside the block
 	# given to +act+.
 	def fail msg = nil, orig = nil
+            msg ||= ""
 	    raise TaskFail.new(self, orig), msg, caller
 	end
 
@@ -197,11 +200,11 @@ module Rant
 	    @rac
 	end
 
-	def needed &block
+	def needed(&block)
 	    @needed = block
 	end
 
-	def act &block
+	def act(&block)
 	    @block = block
 	end
 
@@ -481,11 +484,11 @@ module Rant
 	    yield self if block_given?
 	end
 
-	def act &block
+	def act(&block)
 	    @block = block
 	end
 
-	def needed &block
+	def needed(&block)
 	    @needed = block
 	end
 	
@@ -515,7 +518,7 @@ module Rant
 
     class FileTask < Task
 
-	def initialize *args
+	def initialize(*args)
 	    super
 	    @ts = T0
 	end
@@ -554,6 +557,7 @@ module Rant
 	end
 
 	def handle_non_node(dep, opt)
+            goto_task_home # !!??
 	    unless File.exist? dep
 		err_msg @rac.pos_text(rantfile.path, line_number),
 		    "in prerequisites: no such file or task: `#{dep}'"
@@ -597,7 +601,7 @@ module Rant
 	    def rant_gen(rac, ch, args, &block)
 		case args.size
 		when 1
-		    name, pre, file, ln = rac.normalize_task_arg(args.first, ch)
+		    name, pre = rac.normalize_task_arg(args.first, ch)
 		    self.task(rac, ch, name, pre, &block)
 		when 2
 		    basedir = args.shift
@@ -607,11 +611,10 @@ module Rant
 			rac.abort_at(ch,
 			    "Directory: basedir argument has to be a string.")
 		    end
-		    name, pre, file, ln = rac.normalize_task_arg(args.first, ch)
+		    name, pre = rac.normalize_task_arg(args.first, ch)
 		    self.task(rac, ch, name, pre, basedir, &block)
 		else
-		    rac.abort(rac.pos_text(ch[:file], ch[:ln]),
-			"Directory takes one argument, " +
+		    rac.abort_at(ch, "Directory takes one argument, " +
 			"which should be like one given to the `task' command.")
 		end
 	    end
@@ -647,7 +650,7 @@ module Rant
 	    end
 	end
 
-	def initialize *args
+	def initialize(*args)
 	    super
 	    @ts = T0
 	    @isdir = nil
@@ -678,6 +681,7 @@ module Rant
 	end
 
 	def handle_non_node(dep, opt)
+            goto_task_home
 	    unless File.exist? dep
 		err_msg @rac.pos_text(rantfile.path, line_number),
 		    "in prerequisites: no such file or task: `#{dep}'"
@@ -849,10 +853,26 @@ module Rant
 		end
 		blk = self.new { |task_name|
 		    if target_rx =~ task_name
-			[rac.file(:__caller__ => ch,
-			    task_name => src_proc[task_name], &block)]
-		    else
-			nil
+                        have_src = true
+                        src = src_proc[task_name]
+                        if src.respond_to? :to_ary
+                            src.each { |f|
+                                if rac.resolve(f).empty? && !test(?e, f)
+                                    have_src = false
+                                    break
+                                end
+                            }
+                        else
+                            if rac.resolve(src).empty? && !test(?e, src)
+                                have_src = false
+                            end
+                        end
+                        if have_src
+                            t = rac.file(:__caller__ => ch,
+                                    task_name => src_proc[task_name], &block)
+                            t.project_subdir = rac.current_subdir
+                            [t]
+                        end
 		    end
 		}
 		blk.target_rx = target_rx