rant 0.4.0 → 0.4.2

data/lib/rant/rantlib.rb

@@ -23,6 +23,38 @@ require 'rant/rantsys'
 # this object.
 Rant::MAIN_OBJECT = self
 
+unless Process::Status.method_defined?(:success?)
+    class Process::Status
+        def success?;  exitstatus == 0; end
+    end
+end
+if RUBY_VERSION < "1.8.2"
+    class Array
+        def flatten
+            cp = self.dup
+            cp.flatten!
+            cp
+        end
+        def flatten!
+            res = []
+            flattened = false
+            self.each { |e|
+                if e.respond_to? :to_ary
+                    res.concat(e.to_ary)
+                    flattened = true
+                else
+                    res << e
+                end
+            }
+            if flattened
+                replace(res)
+                flatten!
+                self
+            end
+        end
+    end
+end
+
 class Array
 
     # Concatenates all elements like #join(' ') but also puts quotes
@@ -63,6 +95,9 @@ class String
 	    self.sub(/(\.[^.]*$)|$/, ".#{ext}")
 	end
     end
+    def to_rant_target
+        self
+    end
 end
 
 module Rant::Lib
@@ -76,7 +111,7 @@ module Rant::Lib
     #
     # Note: This method splits on the pattern <tt>:(\d+)(:|$)</tt>,
     # assuming anything before is the filename.
-    def parse_caller_elem elem
+    def parse_caller_elem(elem)
 	return { :file => "", :ln => 0 } if elem.nil?
 	if elem =~ /^(.+):(\d+)(:|$)/
 	    { :file => $1, :ln => $2.to_i }
@@ -102,17 +137,17 @@ module RantContext
     FileList = Rant::FileList
 
     # Define a basic task.
-    def task targ, &block
+    def task(targ, &block)
 	rac.task(targ, &block)
     end
 
     # Define a file task.
-    def file targ, &block
+    def file(targ, &block)
 	rac.file(targ, &block)
     end
 
     # Add code and/or prerequisites to existing task.
-    def enhance targ, &block
+    def enhance(targ, &block)
 	rac.enhance(targ, &block)
     end
 
@@ -134,7 +169,7 @@ module RantContext
 
     # Look in the subdirectories, given by args,
     # for rantfiles.
-    def subdirs *args
+    def subdirs(*args)
 	rac.subdirs(*args)
     end
 
@@ -149,6 +184,10 @@ module RantContext
     def var(*args, &block)
 	rac.var(*args, &block)
     end
+
+    def make(*args, &block)
+        rac.make(*args, &block)
+    end
 end	# module RantContext
 
 class RantAppContext
@@ -225,12 +264,6 @@ module Rant
 	def rac=(app)
 	    @@rac = app
 	end
-
-	# "Clear" the current Rant application. After this call,
-	# Rant has the same state as immediately after startup.
-	def reset
-	    @@rac = nil
-	end
     end
 
 end	# module Rant
@@ -255,7 +288,7 @@ class Rant::RantApp
 	[ "--verbose",	"-v",	GetoptLong::NO_ARGUMENT,
 	    "Print more messages to stderr."			],
 	[ "--quiet",	"-q",	GetoptLong::NO_ARGUMENT,
-	    "Don't print commands."			],
+	    "Don't print commands."			        ],
 	[ "--err-commands",	GetoptLong::NO_ARGUMENT,
 	    "Print failed commands and their exit status."	],
 	[ "--directory","-C",	GetoptLong::REQUIRED_ARGUMENT,
@@ -264,7 +297,7 @@ class Rant::RantApp
 	    "Process RANTFILE instead of standard rantfiles.\n" +
 	    "Multiple files may be specified with this option"	],
 	[ "--force-run","-a",	GetoptLong::REQUIRED_ARGUMENT,
-	    "Force TARGET to be run, even if it isn't required.\n"],
+	    "Force rebuild of TARGET and all dependencies."     ],
 	[ "--tasks",	"-T",	GetoptLong::NO_ARGUMENT,
 	    "Show a list of all described tasks and exit."	],
 	
@@ -314,7 +347,7 @@ class Rant::RantApp
     # Note: Might change before 1.0
     attr_reader :resolve_hooks
 
-    def initialize *args
+    def initialize(*args)
 	unless args.empty?
 	    STDERR.puts caller[0]
 	    STDERR.puts "Warning: Giving arguments Rant::RantApp.new " +
@@ -444,7 +477,7 @@ class Rant::RantApp
     end
 
     # Returns 0 on success and 1 on failure.
-    def run *args
+    def run(*args)
 	@run = true
 	@args.concat(args.flatten)
 	# remind pwd
@@ -484,20 +517,16 @@ class Rant::RantApp
 	goto "#"
 	@plugins.each { |plugin| plugin.rant_done }
 	return 0
-    rescue Rant::RantError
-	ch = get_ch_from_backtrace($!.backtrace)
-	if ch
-	    err_msg(pos_text(ch[:file], ch[:ln]), $!.message)
-	else
-	    err_msg $!.message, $!.backtrace[0..4]
-	end
-	$stderr.puts "rant aborted!"
-	return 1
     rescue Rant::RantAbortException
 	$stderr.puts "rant aborted!"
 	return 1
-    rescue
-	err_msg $!.message, $!.backtrace
+    rescue Exception => e
+	ch = get_ch_from_backtrace(e.backtrace)
+	if ch && !@opts[:trace_abort]
+	    err_msg(pos_text(ch[:file], ch[:ln]), e.message)
+	else
+	    err_msg e.message, e.backtrace[0..4]
+	end
 	$stderr.puts "rant aborted!"
 	return 1
     ensure
@@ -511,7 +540,7 @@ class Rant::RantApp
 
     ###### methods accessible through RantContext ####################
 
-    def desc *args
+    def desc(*args)
 	if args.empty? || (args.size == 1 && args.first.nil?)
 	    @task_desc = nil
 	else
@@ -519,13 +548,13 @@ class Rant::RantApp
 	end
     end
 
-    def task targ, &block
+    def task(targ, &block)
 	prepare_task(targ, block) { |name,pre,blk|
 	    Rant::Task.new(self, name, pre, &blk)
 	}
     end
 
-    def file targ, &block
+    def file(targ, &block)
 	prepare_task(targ, block) { |name,pre,blk|
 	    Rant::FileTask.new(self, name, pre, &blk)
 	}
@@ -533,15 +562,12 @@ class Rant::RantApp
 
     def gen(*args, &block)
 	# retrieve caller info
-	clr = caller[1]
-	ch = Rant::Lib::parse_caller_elem(clr)
-	name = nil
-	pre = []
+	ch = Rant::Lib::parse_caller_elem(caller[1])
 	# validate args
 	generator = args.shift
 	unless generator.respond_to? :rant_gen
 	    abort_at(ch,
-		"First argument to `gen' has to be a task-generator.")
+		"gen: First argument to has to be a task-generator.")
 	end
 	# ask generator to produce a task for this application
 	generator.rant_gen(self, ch, args, &block)
@@ -556,8 +582,7 @@ class Rant::RantApp
 	end
 	args.flatten.each { |arg|
 	    unless String === arg
-		abort(pos_text(ch[:file], ch[:ln]),
-		    "import: only strings allowed as arguments")
+                abort_at(ch, "import: only strings allowed as arguments")
 	    end
 	    unless @imports.include? arg
 		unless Rant::CODE_IMPORTS.include? arg
@@ -565,8 +590,7 @@ class Rant::RantApp
 			msg 2, "import #{arg}"
 			require "rant/import/#{arg}"
 		    rescue LoadError => e
-			abort(pos_text(ch[:file], ch[:ln]),
-			    "No such import - #{arg}")
+			abort_at(ch, "No such import - #{arg}")
 		    end
 		    Rant::CODE_IMPORTS << arg.dup
 		end
@@ -623,7 +647,7 @@ class Rant::RantApp
     # name given as only key in targ.
     # If there is no task with the given name, generate a warning
     # and a new file task.
-    def enhance targ, &block
+    def enhance(targ, &block)
 	prepare_task(targ, block) { |name,pre,blk|
 	    t = resolve(name).last
 	    if t
@@ -659,17 +683,14 @@ class Rant::RantApp
     end
 
     # Search the given directories for Rantfiles.
-    def subdirs *args
+    def subdirs(*args)
 	args.flatten!
-	cinf = Rant::Lib::parse_caller_elem(caller[1])
-	ln = cinf[:ln] || 0
-	file = cinf[:file]
+	ch = Rant::Lib::parse_caller_elem(caller[1])
 	args.each { |arg|
 	    if arg.respond_to? :to_str
 		arg = arg.to_str
 	    else
-		abort(pos_text(file, ln),
-		    "subdirs: arguments must be strings")
+		abort_at(ch, "subdirs: arguments must be strings")
 	    end
 	    loaded = false
 	    prev_subdir = @current_subdir
@@ -690,12 +711,12 @@ class Rant::RantApp
 		goto_project_dir prev_subdir
 	    end
 	    unless loaded || @opts[:no_warn_subdir]
-		warn_msg(pos_text(file, ln),
+		warn_msg(pos_text(ch[:file], ch[:ln]),
 		    "subdirs: No Rantfile in subdir `#{arg}'.")
 	    end
 	}
     rescue SystemCallError => e
-	abort(pos_text(file, ln), "subdirs: " + e.message)
+	abort_at(ch, "subdirs: " + e.message)
     end
 
     def sys(*args, &block)
@@ -717,8 +738,8 @@ class Rant::RantApp
 	td
     end
 
-    # Prints msg as error message and raises a RantAbortException.
-    def abort *msg
+    # Prints msg as error message and raises an RantAbortException.
+    def abort(*msg)
 	err_msg(msg) unless msg.empty?
 	$stderr.puts caller if @opts[:trace_abort]
 	raise Rant::RantAbortException
@@ -731,7 +752,7 @@ class Rant::RantApp
     end
 
     def show_help
-	puts "rant [-f RANTFILE] [OPTIONS] tasks..."
+	puts "rant [-f Rantfile] [Options] [targets]"
 	puts
 	puts "Options are:"
 	print option_listing(OPTIONS)
@@ -766,7 +787,7 @@ class Rant::RantApp
 	tlist.each { |t|
 	    print(prefix + t.full_name.ljust(name_length) + infix)
 	    dt = t.description.sub(/\s+$/, "")
-	    puts dt.sub("\n", "\n" + ' ' * cmd_length + infix + "  ")
+	    puts dt.sub(/\n/, "\n" + ' ' * cmd_length + infix + "  ")
 	}
 	true
     end
@@ -799,15 +820,13 @@ class Rant::RantApp
 	@opts[:quiet]
     end
 
-    def pos_text file, ln
+    def pos_text(file, ln)
 	t = "in file `#{file}'"
-	if ln && ln > 0
-	    t << ", line #{ln}"
-	end
-	t + ": "
+        t << ", line #{ln}" if ln && ln > 0
+	t << ": "
     end
 
-    def msg *args
+    def msg(*args)
 	verbose_level = args[0]
 	if verbose_level.is_a? Integer
 	    super(args[1..-1]) if verbose_level <= verbose
@@ -818,7 +837,7 @@ class Rant::RantApp
 
     # Print a command message as would be done from a call to a
     # Sys method.
-    def cmd_msg cmd
+    def cmd_msg(cmd)
 	puts cmd unless quiet?
     end
 
@@ -853,7 +872,7 @@ class Rant::RantApp
 
     private
     def have_any_task?
-	not @rantfiles.all? { |f| f.tasks.empty? }
+        !@tasks.empty?
     end
 
     def target_list
@@ -890,15 +909,60 @@ class Rant::RantApp
 	matching_tasks = 0
 	target_list.each do |target|
 	    goto "#"
-	    if make(target) == 0
+	    if build(target) == 0
 		abort("Don't know how to make `#{target}'.")
 	    end
 	end
     end
 
+    def make(target, *args, &block)
+        ch = nil
+        if target.respond_to? :to_hash
+            targ = target.to_hash
+            ch = Rant::Lib.parse_caller_elem(caller[1])
+            abort_at(ch, "make: too many arguments") unless args.empty?
+            tn = nil
+            prepare_task(targ, block, ch) { |name,pre,blk|
+                tn = name
+                Rant::FileTask.new(self, name, pre, &blk)
+            }
+            build(tn)
+        elsif target.respond_to? :to_rant_target
+            rt = target.to_rant_target
+            opt = args.shift
+            unless args.empty?
+                ch ||= Rant::Lib.parse_caller_elem(caller[1])
+                abort_at(ch, "make: too many arguments")
+            end
+            if block
+                # create a file task
+                ch ||= Rant::Lib.parse_caller_elem(caller[1])
+                prepare_task(rt, block, ch) { |name,pre,blk|
+                    Rant::FileTask.new(self, name, pre, &blk)
+                }
+                build(rt)
+            else
+                build(rt, opt||{})
+            end
+        elsif target.respond_to? :rant_gen
+            ch = Rant::Lib.parse_caller_elem(caller[1])
+            rv = target.rant_gen(self, ch, args, &block)
+            unless rv.respond_to? :to_rant_target
+                abort_at(ch, "make: invalid generator return value")
+            end
+            build(rv.to_rant_target)
+            rv
+        else
+            ch = Rant::Lib.parse_caller_elem(caller[1])
+            abort_at(ch,
+                "make: generator or target as first argument required.")
+        end
+    end
+    public :make
+
     # Invoke all tasks necessary to build +target+. Returns the number
     # of tasks invoked.
-    def make target, opt = {}
+    def build(target, opt = {})
 	opt[:force] = true if @force_targets.delete(target)
 	matching_tasks = 0
 	old_subdir = @current_subdir
@@ -916,18 +980,24 @@ class Rant::RantApp
 	Dir.chdir old_pwd
 	matching_tasks
     end
-    public :make
-    alias build make
+    public :build
 
-    # Currently always returns an array (which might actually be a
-    # an empty array, but never nil).
-    def resolve task_name, rel_project_dir = @current_subdir
+    # Currently always returns an array (which might actually be an
+    # empty array, but never nil).
+    def resolve(task_name, rel_project_dir = @current_subdir)
 	s = @tasks[expand_path(rel_project_dir, task_name)]
 	case s
 	when nil
 	    @resolve_hooks.each { |s|
 		# Note: will probably change to get more params
 		s = s[task_name]
+                #if s
+                #    puts s.size
+                #    t = s.first
+                #    puts t.full_name
+                #    puts t.name
+                #    puts t.deps
+                #end
 		return s if s
 	    }
 	    []
@@ -942,7 +1012,7 @@ class Rant::RantApp
     # target. It may create one or more tasks for the target, which is
     # given as argument, on the fly and return an array of the created
     # tasks or nil.
-    def at_resolve &block
+    def at_resolve(&block)
 	@resolve_hooks << block if block
     end
     public :at_resolve
@@ -994,7 +1064,7 @@ class Rant::RantApp
 
     # Returns the value of the last expression executed in +rantfile+.
     # +rantfile+ has to be an Rant::Rantfile instance.
-    def load_file rantfile
+    def load_file(rantfile)
 	msg 1, "source #{rantfile}"
 	rv = nil
 	begin
@@ -1021,7 +1091,7 @@ class Rant::RantApp
     # If dir is nil, look in current directory.
     # Returns always an array with the pathes (not only the filenames)
     # to the rantfiles.
-    def rantfiles_in_dir dir=nil
+    def rantfiles_in_dir(dir=nil)
 	files = []
 	::Rant::RANTFILES.each { |rfn|
 	    path = dir ? File.join(dir, rfn) : rfn
@@ -1038,7 +1108,7 @@ class Rant::RantApp
     def process_args
 	# WARNING: we currently have to fool getoptlong,
 	# by temporory changing ARGV!
-	# This could cause problems.
+	# This could cause problems (e.g. multithreading).
 	old_argv = ARGV.dup
 	ARGV.replace(@args.dup)
 	cmd_opts = GetoptLong.new(*OPTIONS.collect { |lst| lst[0..-2] })
@@ -1089,14 +1159,15 @@ class Rant::RantApp
 	if targ.is_a? Hash
 	    targ.reject! { |k, v| clr = v if k == :__caller__ }
 	end
-	cinf = Hash === clr ? clr : Rant::Lib::parse_caller_elem(clr)
+	ch = Hash === clr ? clr : Rant::Lib::parse_caller_elem(clr)
 
-	name, pre, file, ln = normalize_task_arg(targ, cinf)
+	name, pre = normalize_task_arg(targ, ch)
 
-	file, is_new = rantfile_for_path(file)
+	file, is_new = rantfile_for_path(ch[:file])
 	nt = yield(name, pre, block)
 	nt.rantfile = file
-	nt.line_number = ln
+        nt.project_subdir = file.project_subdir
+	nt.line_number = ch[:ln]
 	nt.description = @task_desc
 	@task_desc = nil
 	file.tasks << nt
@@ -1105,7 +1176,7 @@ class Rant::RantApp
     end
     public :prepare_task
 
-    def hash_task task
+    def hash_task(task)
 	n = task.full_name
 	#STDERR.puts "hash_task: `#{n}'"
 	et = @tasks[n]
@@ -1122,69 +1193,58 @@ class Rant::RantApp
 
     # Tries to extract task name and prerequisites from the typical
     # argument to the +task+ command. +targ+ should be one of String,
-    # Symbol or Hash. clr is the caller and is used for error
-    # reporting and debugging.
+    # Symbol or Hash. ch is the caller (hash with the elements :file
+    # and :ln) and is used for error reporting and debugging.
     #
-    # Returns four values, the first is a string which is the task name
+    # Returns two values, the first is a string which is the task name
     # and the second is an array with the prerequisites.
-    # The third is the file name of +clr+, the fourth is the line number
-    # of +clr+.
     def normalize_task_arg(targ, ch)
-	# pre 0.3.7: ch in parameter list was clr
-	# TODO: check the code calling this method so that we can
-	# assume clr is already a hash
-	#ch = Hash === clr ? clr : Rant::Lib::parse_caller_elem(clr)
-
 	name = nil
 	pre = []
-	ln, file = ch[:ln], ch[:file]
 	
 	# process and validate targ
 	if targ.is_a? Hash
 	    if targ.empty?
-		abort(pos_text(file, ln),
-		    "Empty hash as task argument, " +
+		abort_at(ch, "Empty hash as task argument, " +
 		    "task name required.")
 	    end
 	    if targ.size > 1
-		abort(pos_text(file, ln),
-		    "Too many hash elements, " +
+		abort_at(ch, "Too many hash elements, " +
 		    "should only be one.")
 	    end
 	    targ.each_pair { |k,v|
-		name = normalize_task_name(k, file, ln)
+		name = normalize_task_name(k, ch)
 		pre = v
 	    }
 	    unless ::Rant::FileList === pre
 		if pre.respond_to? :to_ary
 		    pre = pre.to_ary.dup
 		    pre.map! { |elem|
-			normalize_task_name(elem, file, ln)
+			normalize_task_name(elem, ch)
 		    }
 		else
-		    pre = [normalize_task_name(pre, file, ln)]
+		    pre = [normalize_task_name(pre, ch)]
 		end
 	    end
 	else
-	    name = normalize_task_name(targ, file, ln)
+	    name = normalize_task_name(targ, ch)
 	end
 
-	[name, pre, file, ln]
+	[name, pre]
     end
     public :normalize_task_arg
 
     # Tries to make a task name out of arg and returns
     # the valid task name. If not possible, calls abort
     # with an appropriate error message using file and ln.
-    def normalize_task_name(arg, file, ln)
+    def normalize_task_name(arg, ch)
 	return arg if arg.is_a? String
 	if Symbol === arg
 	    arg.to_s
 	elsif arg.respond_to? :to_str
 	    arg.to_str
 	else
-	    abort(pos_text(file, ln),
-		"Task name has to be a string or symbol.")
+	    abort_at(ch, "Task name has to be a string or symbol.")
 	end
     end
 
@@ -1192,7 +1252,7 @@ class Rant::RantApp
     # and a boolean value as second. If the second is true,
     # the rantfile was created and added, otherwise the rantfile
     # already existed.
-    def rantfile_for_path path
+    def rantfile_for_path(path)
 	# all rantfiles have an absolute path as path attribute
 	abs_path = File.expand_path(path)
 	if @rantfiles.any? { |rf| rf.path == abs_path }
@@ -1237,20 +1297,13 @@ class Rant::RantApp
 	t_msg = ["Task `#{e.tname}' fail."]
 	orig = e
 	loop { orig = orig.orig; break unless Rant::TaskFail === orig }
-	unless orig == e
-	    if Rant::RantError === orig
-		ch = get_ch_from_backtrace(orig.backtrace)
-		if ch
-		    msg << pos_text(ch[:file], ch[:ln])
-		    msg << orig.message
-		else
-		    msg << orig.message << orig.backtrace[0..4]
-		end
-	    elsif Rant::CommandError === orig
-		msg << orig.message if @opts[:err_commands]
-	    elsif orig && !(Rant::RantAbortException === orig)
-		msg << orig.message << orig.backtrace[0..4]
-	    end
+	if orig && orig != e && !(Rant::RantAbortException === orig)
+            ch = get_ch_from_backtrace(orig.backtrace)
+            msg << pos_text(ch[:file], ch[:ln]) if ch
+            unless Rant::CommandError === orig && !@opts[:err_commands]
+                msg << orig.message
+                msg << orig.backtrace[0..4] unless ch
+            end
 	end
 	err_msg msg unless msg.empty?
 	err_msg t_msg