rant 0.3.4 → 0.3.6

data/lib/rant/import/rubydoc.rb

@@ -55,6 +55,11 @@ module Rant
 	    # define task task with given name first, so that it takes
 	    # any previously set description
 	    t = app.task(:__caller__ => ch, @name => [])
+	    t.instance_variable_set(:@rdoc_op_dir, @op_dir)
+	    def t.each_target
+		super
+		yield @rdoc_op_dir if @rdoc_op_dir
+	    end
 	    # The task which will actually run rdoc.
 	    t << app.file(:__caller__ => ch, index => @pre) { |t|
 		# We delay the require of the RDoc code until it is

data/lib/rant/import/rubypackage.rb

@@ -437,4 +437,4 @@ class Rant::Generators::RubyPackage
 	}
     end
 
-end	# class Rant::RubyPackage
+end	# class Rant::Generators::RubyPackage

data/lib/rant/import/truth.rb

@@ -0,0 +1,24 @@
+
+#--
+# truth.rb - Import truth into rant ;)
+#
+# Copyright (C) 2005 Stefan Lang <langstefan@gmx.at>
+
+module Rant
+    module Worker
+	def %(desc)
+	    @description = case @description
+	    when nil: desc
+	    when /\n$/: @description + desc
+	    else "#@description\n#{desc}"
+	    end
+	    self
+	end
+    end
+end
+module RantContext
+    def drag(name, *args, &block)
+	import(name.to_s.downcase)
+	gen(::Rant::Generators.const_get(name), *args, &block)
+    end
+end

data/lib/rant/plugin/configure.rb

@@ -208,6 +208,7 @@ module Rant::Plugin
 		modes = [:guess]
 	    end
 	    @no_action = @no_action_list.include? @app.cmd_targets.first
+	    @no_action ||= @app[:tasks]
 	    unless @no_action
 		init_config modes
 		@configured = true

data/lib/rant/rantfile.rb

@@ -1,11 +1,16 @@
 
+# rantfile.rb - Define task core for rant.
+#
+# Copyright (C) 2005 Stefan Lang <langstefan@gmx.at>
+
 require 'rant/rantenv'
 
 module Rant
     class TaskFail < StandardError
 	def initialize(*args)
 	    @task = args.shift
-	    super(args.shift)
+	    #super(args.shift)
+	    @orig = args.shift
 	end
 	def task
 	    @task
@@ -13,6 +18,10 @@ module Rant
 	def tname
 	    @task ? @task.name : nil
 	end
+	# the exception which caused the task to fail
+	def orig
+	    @orig
+	end
     end
 
     class Rantfile < Path
@@ -29,6 +38,9 @@ module Rant
 
     # Any +object+ is considered a _task_ if
     # <tt>Rant::Worker === object</tt> is true.
+    #
+    # Most important classes including this module are the Rant::Task
+    # class and the Rant::FileTask class.
     module Worker
 
 	INVOKE_OPT = {}.freeze
@@ -57,15 +69,26 @@ module Rant
 	    full_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
 
+	# Basically project_subdir/name
+	#
+	# The Rant compiler (or application) references tasks by their
+	# full_name.
 	def full_name
 	    sd = project_subdir
 	    sd.empty? ? name : File.join(sd, name)
 	end
 
+	# Change current working directory to the directory this task
+	# was defined in.
+	#
+	# Important for subclasses: Call this method always before
+	# invoking code from Rantfiles (e.g. task action blocks).
 	def goto_task_home
 	    @app.goto_project_dir project_subdir
 	end
@@ -103,8 +126,17 @@ module Rant
 	    end
 	end
 
-	def fail msg = nil
-	    raise TaskFail.new(self), msg, caller
+	# Cause task to fail. Usually called from inside the block
+	# given to +act+.
+	def fail msg = nil, orig = nil
+	    raise TaskFail.new(self, orig), msg, caller
+	end
+
+	# Change pwd to task home directory and yield for each created
+	# file/directory.
+	#
+	# Override in subclasses if your task instances create files.
+	def each_target
 	end
 
 	def run
@@ -120,8 +152,9 @@ module Rant
 	end
 	private :circular_dep
 
+	# Tasks are hashed by their full_name.
 	def hash
-	    name.hash
+	    full_name.hash
 	end
 
 	def eql? other
@@ -129,7 +162,7 @@ module Rant
 	end
     end	# module Worker
 
-    # A list of tasks with an equal name.
+    # A list of tasks with an equal full_name.
     class MetaTask < Array
 	include Worker
 
@@ -196,6 +229,10 @@ module Rant
 	def app
 	    empty? ? nil : first.app
 	end
+
+	def each_target &block
+	    self.each { |t| t.each_target &block }
+	end
     end	# class MetaTask
 
     # A very lightweight task for special purposes.
@@ -246,12 +283,6 @@ module Rant
 	    @block = block
 	end
 
-	# Cause task to fail. Usually called from inside the block
-	# given to +act+.
-	def fail msg = nil
-	    raise TaskFail.new(self), msg, caller
-	end
-
 	def needed?
 	    return false if done?
 	    return true if @needed.nil?
@@ -279,10 +310,10 @@ module Rant
 		end
 	    rescue CommandError => e
 		err_msg e.message if app[:err_commands]
-		self.fail
+		self.fail(nil, e)
 	    rescue SystemCallError => e
 		err_msg e.message
-		self.fail
+		self.fail(nil, e)
 	    ensure
 		@run = false
 	    end
@@ -327,6 +358,7 @@ module Rant
 	def prerequisites
 	    @pre.collect { |pre| pre.to_s }
 	end
+	alias deps prerequisites
 
 	# First prerequisite.
 	def source
@@ -421,16 +453,7 @@ module Rant
 	    update
 	rescue StandardError => e
 	    @success = false
-	    case e
-	    when TaskFail: raise
-	    when CommandError
-		err_msg e.message if app[:err_commands]
-	    when SystemCallError
-		err_msg e.message
-	    else
-		err_msg e.message, e.backtrace
-	    end
-	    self.fail
+	    self.fail(nil, e)
 	end
 	private :internal_invoke
 
@@ -633,6 +656,11 @@ module Rant
 	    end
 	    [dep, dep.mtime > @ts]
 	end
+
+	def each_target
+	    goto_task_home
+	    yield name
+	end
     end	# class FileTask
 
     # An instance of this class is a task to create a _single_
@@ -741,17 +769,24 @@ module Rant
 	    @app.sys.mkdir @name unless @isdir
 	    if @block
 		@block.arity == 0 ? @block.call : @block[self]
+		goto_task_home
 		@app.sys.touch @name
 	    end
 	end
+
+	def each_target
+	    goto_task_home
+	    yield name
+	end
     end	# class DirTask
     module Generators
 	Task = ::Rant::Task
 	LightTask = ::Rant::LightTask
 	Directory = ::Rant::DirTask
 
-	class Rule
-	    # TODO
+	class Rule < ::Proc
+	    # Generate a rule by installing an at_resolve hook for
+	    # +rac+.
 	    def self.rant_generate(rac, ch, args, &block)
 		unless args.size == 1
 		    rac.abort_at(ch, "Rule takes only one argument.")
@@ -799,7 +834,7 @@ module Rant
 		    rac.abort_at(ch, "rule source has to be " +
 			"String or Proc")
 		end
-		rac.at_resolve { |task_name|
+		blk = self.new { |task_name|
 		    if target_rx =~ task_name
 			[rac.file(:__caller__ => ch,
 			    task_name => src_proc[task_name], &block)]
@@ -807,7 +842,23 @@ module Rant
 			nil
 		    end
 		}
+		blk.target_rx = target_rx
+		rac.at_resolve &blk
+		nil
 	    end
+	    attr_accessor :target_rx
 	end	# class Rule
+
+	class Action
+	    def self.rant_generate(rac, ch, args, &block)
+		unless args.empty?
+		    rac.warn_msg(rac.pos_text(ch[:file], ch[:ln]),
+			"Action doesn't take arguments.")
+		end
+		unless (rac[:tasks] || rac[:stop_after_load])
+		    yield
+		end
+	    end
+	end
     end	# module Generators
 end # module Rant

data/lib/rant/rantlib.rb

@@ -32,9 +32,10 @@ class Array
     end
 
     def shell_pathes
+	entry = nil
 	if ::Rant::Env.on_windows?
 	    self.collect { |entry|
-		entry = entry.tr("/", "\\")
+		entry = entry.to_s.tr("/", "\\")
 		if entry.include? ' '
 		    '"' + entry + '"'
 		else
@@ -43,6 +44,7 @@ class Array
 	    }
 	else
 	    self.collect { |entry|
+		entry = entry.to_s
 		if entry.include? ' '
 		    "'" + entry + "'"
 		else
@@ -71,9 +73,21 @@ module Rant::Lib
     #	p parse_caller_elem "/usr/local/lib/ruby/1.8/irb/workspace.rb:52:in `irb_binding'"
     # prints:
     #   {:ln=>52, :file=>"/usr/local/lib/ruby/1.8/irb/workspace.rb"} 
+    #
+    # Note: This method splits on the pattern <tt>:(\d+)(:|$)</tt>,
+    # assuming anything before is the filename.
     def parse_caller_elem elem
-	parts = elem.split(":")
-	{ :file => parts[0], :ln => parts[1].to_i }
+	return { :file => "", :ln => 0 } if elem.nil?
+	if elem =~ /^(.+):(\d+)(:|$)/
+	    { :file => $1, :ln => $2.to_i }
+	else
+	    # should never occur
+	    $stderr.puts "parse_caller_elem: #{elem.inspect}"
+	    { :file => elem, :ln => 0 }
+	end
+	
+	#parts = elem.split(":")
+	#{ :file => parts[0], :ln => parts[1].to_i }
     end
     module_function :parse_caller_elem
 
@@ -195,7 +209,7 @@ module Rant
 	def run(first_arg=nil, *other_args)
 	    other_args = other_args.flatten
 	    args = first_arg.nil? ? ARGV.dup : ([first_arg] + other_args)
-	    if @@rac && !@@rac.ran?
+	    if @@rac && !@@rac.run?
 		@@rac.args.replace(args.flatten)
 		@@rac.run
 	    else
@@ -293,6 +307,11 @@ class Rant::RantApp
     # Current subdirectory relative to project's root directory
     # (#rootdir).
     attr_reader :current_subdir
+    # List of proc objects used to automatically create required
+    # tasks. (Especially used for Rules.)
+    #
+    # Note: Might change before 1.0
+    attr_reader :resolve_hooks
 
     def initialize *args
 	@args = args.flatten
@@ -305,11 +324,12 @@ class Rant::RantApp
 	@opts = {
 	    :verbose	=> 0,
 	    :quiet	=> false,
+	    :directory	=> "",
 	}
 	@arg_rantfiles = []	# rantfiles given in args
 	@arg_targets = []	# targets given in args
 	@force_targets = []
-	@ran = false
+	@run = false
 	@done = false
 	@plugins = []
 	@var = Rant::RantVar::Space.new
@@ -338,19 +358,23 @@ class Rant::RantApp
     end
 
     def rootdir
-	od = @opts[:directory]
-	od ? od.dup : ""
+	#od = @opts[:directory]
+	#od ? od.dup : ""
+	@opts[:directory]
     end
 
     def rootdir=(newdir)
-	if @ran
+	if @run
 	    raise "rootdir of rant application can't " +
 		"be changed after calling `run'"
 	end
+	unless String === newdir
+	    raise "rootdir has to be a String"
+	end
 	@opts[:directory] = newdir.dup
     end
 
-    ### experimental support for subdirectories ######################
+    ### support for subdirectories ###################################
     def expand_project_path(path)
 	expand_path(@current_subdir, path)
     end
@@ -397,10 +421,18 @@ class Rant::RantApp
 	# TODO: optimize
 	goto "##{dir}"
     end
+    # Execute the give block in project directory dir.
+    def in_project_dir(dir)
+	prev_subdir = @current_subdir
+	goto_project_dir(dir)
+	yield
+    ensure
+	goto_project_dir(prev_subdir)
+    end
     ##################################################################
 
-    def ran?
-	@ran
+    def run?
+	@run
     end
 
     def done?
@@ -409,14 +441,14 @@ class Rant::RantApp
 
     # Returns 0 on success and 1 on failure.
     def run
-	@ran = true
+	@run = true
 	# remind pwd
 	@orig_pwd = Dir.pwd
 	# Process commandline.
 	process_args
 	# Set pwd.
 	opts_dir = @opts[:directory]
-	if opts_dir
+	if !(opts_dir.empty? || opts_dir.nil?)
 	    opts_dir = File.expand_path(opts_dir)
 	    unless test(?d, opts_dir)
 		abort("No such directory - #{opts_dir}")
@@ -433,7 +465,7 @@ class Rant::RantApp
 
 	# Notify plugins before running tasks
 	@plugins.each { |plugin| plugin.rant_start }
-	if @opts[:targets]
+	if @opts[:tasks]
 	    show_descriptions
 	    raise Rant::RantDoneException
 	end
@@ -444,6 +476,7 @@ class Rant::RantApp
     rescue Rant::RantDoneException
 	@done = true
 	# Notify plugins
+	goto "#"
 	@plugins.each { |plugin| plugin.rant_done }
 	return 0
     rescue Rant::RantfileException
@@ -451,7 +484,12 @@ class Rant::RantApp
 	$stderr.puts "rant aborted!"
 	return 1
     rescue Rant::RantError
-	err_msg $!.message, $!.backtrace[0..4]
+	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
@@ -528,6 +566,7 @@ class Rant::RantApp
 	    unless @imports.include? arg
 		unless Rant::CODE_IMPORTS.include? arg
 		    begin
+			msg 2, "import #{arg}"
 			require "rant/import/#{arg}"
 		    rescue LoadError => e
 			abort(pos_text(ch[:file], ch[:ln]),
@@ -704,12 +743,11 @@ class Rant::RantApp
 	raise Rant::RantAbortException
     end
 
-    def help
+    def show_help
 	puts "rant [-f RANTFILE] [OPTIONS] tasks..."
 	puts
 	puts "Options are:"
 	print option_listing(OPTIONS)
-	raise Rant::RantDoneException
     end
 
     def show_descriptions
@@ -888,17 +926,22 @@ class Rant::RantApp
     def build target, opt = {}
 	opt[:force] = true if @force_targets.delete(target)
 	matching_tasks = 0
+	old_subdir = @current_subdir
+	old_pwd = Dir.pwd
 	resolve(target).each { |t|
 	    matching_tasks += 1
 	    begin
 		t.invoke(opt)
 	    rescue Rant::TaskFail => e
-		# TODO: Report failed dependancy.
-		abort("Task `#{e.tname}' fail.")
+		err_task_fail(e)
+		abort
 	    end
 	}
+	@current_subdir = old_subdir
+	Dir.chdir old_pwd
 	matching_tasks
     end
+    public :build
 
     def resolve task_name, rel_project_dir = @current_subdir
 	#select_tasks_by_name task_name, rel_project_dir
@@ -1058,15 +1101,18 @@ class Rant::RantApp
 		$stdout.puts "rant #{Rant::VERSION}"
 		raise Rant::RantDoneException
 	    when "--help"
-		help
+		show_help
+		raise Rant::RantDoneException
 	    when "--directory"
+		# take care: we bypass the checks of self.rootdir=
+		# because @run is true
 		@opts[:directory] = value
 	    when "--rantfile"
 		@arg_rantfiles << value
 	    when "--force-run"
 		@force_targets << value
 	    when "--tasks"
-		@opts[:targets] = true
+		@opts[:tasks] = true
 	    when "--stop-after-load"
 		@opts[:stop_after_load] = true
 	    when "--trace-abort"
@@ -1224,6 +1270,55 @@ class Rant::RantApp
 	end
     end
 
+    # Returns the usual hash with :file and :ln as keys for the first
+    # element in backtrace which comes from an Rantfile, or nil if no
+    # Rantfile is involved.
+    #
+    # Note that this method is very time consuming!
+    def get_ch_from_backtrace(backtrace)
+	backtrace.each { |clr|
+	    ch = ::Rant::Lib.parse_caller_elem(clr)
+	    if ::Rant::Env.on_windows?
+		return ch if @rantfiles.any? { |rf|
+		    # sigh... a bit hackish: replace any backslash
+		    # with a slash and remove any leading drive (e.g.
+		    # C:) from the path
+		    rf.path.tr("\\", "/").sub(/^\w\:/, '') ==
+			ch[:file].tr("\\", "/").sub(/^\w\:/, '')
+		}
+	    else
+		return ch if @rantfiles.any? { |rf|
+		    rf.path == ch[:file]
+		}
+	    end
+	}
+	nil
+    end
+
+    def err_task_fail(e)
+	msg = []
+	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]
+	    else
+		msg << orig.message unless Rant::RantAbortException
+	    end
+	end
+	err_msg msg unless msg.empty?
+	err_msg t_msg
+    end
+
     # Just ensure that Rant.rac holds an RantApp after loading
     # this file. The code in initialize will register the new app with
     # Rant.rac= if necessary.