rant 0.3.2 → 0.3.4

data/lib/rant/rantlib.rb

@@ -13,38 +13,6 @@ require 'rant/rantenv'
 require 'rant/rantfile'
 require 'rant/rantsys'
 
-module Rant
-    VERSION	= '0.3.2'
-
-    # Those are the filenames for rantfiles.
-    # Case matters!
-    RANTFILES	= [	"Rantfile",
-			"rantfile",
-			"Rantfile.rb",
-			"rantfile.rb",
-		  ]
-    
-    # Names of plugins and imports for which code was loaded.
-    # Files that where loaded with the `import' commant are directly
-    # added; files loaded with the `plugin' command are prefixed with
-    # "plugin/".
-    CODE_IMPORTS = []
-    
-    class RantAbortException < StandardError
-    end
-
-    class RantDoneException < StandardError
-    end
-
-    class RantfileException < StandardError
-    end
-
-    # This module is a namespace for generator classes.
-    module Generators
-    end
-
-end
-
 # There is one problem with executing Rantfiles in a special context:
 # In the top-level execution environment, there are some methods
 # available which are not available to all objects. One example is the
@@ -56,6 +24,9 @@ end
 Rant::MAIN_OBJECT = self
 
 class Array
+
+    # Concatenates all elements like #join(' ') but also puts quotes
+    # around strings that contain a space.
     def arglist
 	self.shell_pathes.join(' ')
     end
@@ -82,6 +53,16 @@ class Array
     end
 end
 
+class String
+    def sub_ext(ext, new_ext = nil)
+	if new_ext
+	    self.sub(/#{Regexp.escape ext}$/, new_ext)
+	else
+	    self.sub(/\.[^.]+$/, ".#{ext}")
+	end
+    end
+end
+
 module Rant::Lib
 
     # Parses one string (elem) as it occurs in the array
@@ -89,51 +70,13 @@ module Rant::Lib
     # E.g.:
     #	p parse_caller_elem "/usr/local/lib/ruby/1.8/irb/workspace.rb:52:in `irb_binding'"
     # prints:
-    #   {:method=>"irb_binding", :ln=>52, :file=>"/usr/local/lib/ruby/1.8/irb/workspace.rb"} 
+    #   {:ln=>52, :file=>"/usr/local/lib/ruby/1.8/irb/workspace.rb"} 
     def parse_caller_elem elem
 	parts = elem.split(":")
-	rh = {	:file => parts[0],
-		:ln => parts[1].to_i
-	     }
-=begin
-	# commented for better performance
-	meth = parts[2]
-	if meth && meth =~ /\`(\w+)'/
-	    meth = $1
-	end
-	rh[:method] = meth
-=end
-	rh
+	{ :file => parts[0], :ln => parts[1].to_i }
     end
-
     module_function :parse_caller_elem
 
-    # currently unused
-    class Caller
-	def self.[](i)
-	    new(caller[i+1])
-	end
-	def initialize(clr)
-	    @clr = clr
-	    @file = @ln = nil
-	end
-	def file
-	    unless @file
-		ca = Lib.parse_caller_elem(clr)
-		@file = ca[:file]
-		@ln = ca[:ln]
-	    end
-	    @file
-	end
-	def ln
-	    unless @ln
-		ca = Lib.parse_caller_elem(clr)
-		@file = ca[:file]
-		@ln = ca[:ln]
-	    end
-	    @ln
-	end
-    end
 end
 
 # The methods in this module are the public interface to Rant that can
@@ -141,62 +84,69 @@ end
 module RantContext
     include Rant::Generators
 
+    Env = Rant::Env
+    FileList = Rant::FileList
+
     # Define a basic task.
     def task targ, &block
-	rantapp.task(targ, &block)
+	rac.task(targ, &block)
     end
 
     # Define a file task.
     def file targ, &block
-	rantapp.file(targ, &block)
+	rac.file(targ, &block)
     end
 
     # Add code and/or prerequisites to existing task.
     def enhance targ, &block
-	rantapp.enhance(targ, &block)
+	rac.enhance(targ, &block)
     end
 
     def desc(*args)
-	rantapp.desc(*args)
+	rac.desc(*args)
     end
 
     def gen(*args, &block)
-	rantapp.gen(*args, &block)
+	rac.gen(*args, &block)
     end
 
     def import(*args, &block)
-	rantapp.import(*args, &block)
+	rac.import(*args, &block)
     end
 
     def plugin(*args, &block)
-	rantapp.plugin(*args, &block)
+	rac.plugin(*args, &block)
     end
 
     # Look in the subdirectories, given by args,
     # for rantfiles.
     def subdirs *args
-	rantapp.subdirs(*args)
+	rac.subdirs(*args)
     end
 
     def source rantfile
-	rantapp.source(rantfile)
+	rac.source(rantfile)
+    end
+
+    def sys(*args, &block)
+	rac.sys(*args)
     end
 
-    def sys *args
-	rantapp.sys(*args)
+    def var(*args, &block)
+	rac.var(*args, &block)
     end
 end	# module RantContext
 
 class RantAppContext
-    include Rant
     include RantContext
 
     def initialize(app)
-	@rantapp = app
+	@rac = app
     end
 
-    def rantapp
-	@rantapp
+    # +rac+ stands for "rant compiler"
+    def rac
+	@rac
     end
 
     def method_missing(sym, *args)
@@ -212,11 +162,10 @@ class RantAppContext
 end
 
 module Rant
-    include RantContext
 
     # In the class definition of Rant::RantApp, this will be set to a
     # new application object.
-    @@rantapp = nil
+    @@rac = nil
 
     class << self
 
@@ -246,42 +195,30 @@ 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 @@rantapp && !@@rantapp.ran?
-		@@rantapp.args.replace(args.flatten)
-		@@rantapp.run
+	    if @@rac && !@@rac.ran?
+		@@rac.args.replace(args.flatten)
+		@@rac.run
 	    else
-		@@rantapp = Rant::RantApp.new(args)
-		@@rantapp.run
+		@@rac = Rant::RantApp.new(args)
+		@@rac.run
 	    end
 	end
 
-	def rantapp
-	    @@rantapp
+	def rac
+	    @@rac
 	end
 
-	def rantapp=(app)
-	    @@rantapp = app
+	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
-	    @@rantapp = nil
+	    @@rac = nil
 	end
     end
 
-    def rantapp
-	@@rantapp
-    end
-
-    # Pre 0.2.7: Manually making necessary methods module
-    # functions. Note that it caused problems with caller
-    # parsing when the Rantfile did a `require "rant"' (irb!).
-    #module_function :task, :file, :desc, :subdirs,
-    #	:gen, :source, :enhance, :sys, :plugin
-
-    extend self
-
 end	# module Rant
 
 class Rant::RantApp
@@ -290,6 +227,9 @@ class Rant::RantApp
     # Important: We try to synchronize all tasks referenced indirectly
     # by @rantfiles with the task hash @tasks. The task hash is
     # intended for fast task lookup per task name.
+    #
+    # All tasks are registered to the system by the +prepare_task+
+    # method.
 
     # The RantApp class has no own state.
 
@@ -323,6 +263,8 @@ class Rant::RantApp
 	[ "--trace-abort",	GetoptLong::NO_ARGUMENT, nil	],
     ]
 
+    # Reference project's root directory in task names by preceding
+    # them with this character.
     ROOT_DIR_ID = "#"
     ESCAPE_ID = "\\"
 
@@ -342,16 +284,14 @@ class Rant::RantApp
     # may be called through an instance_eval on this object (e.g. from
     # plugins).
     attr_reader :context
-    # The [] and []= operators may be used to set/get values from this
-    # object (like a hash). It is intended to let the different
-    # modules, plugins and tasks to communicate to each other.
-    attr_reader :var
+    alias cx context
     # A hash with all tasks. For fast task lookup use this hash with
     # the taskname as key.
     attr_reader :tasks
-    # A list with of all imports (code loaded with +import+).
+    # A list of all imports (code loaded with +import+).
     attr_reader :imports
-
+    # Current subdirectory relative to project's root directory
+    # (#rootdir).
     attr_reader :current_subdir
 
     def initialize *args
@@ -359,7 +299,7 @@ class Rant::RantApp
 	# Rantfiles will be loaded in the context of this object.
 	@context = RantAppContext.new(self)
 	@sys = ::Rant::SysObject.new(self)
-	Rant.rantapp ||= self
+	Rant.rac ||= self
 	@rantfiles = []
 	@tasks = {}
 	@opts = {
@@ -373,6 +313,7 @@ class Rant::RantApp
 	@done = false
 	@plugins = []
 	@var = Rant::RantVar::Space.new
+	@var.query :ignore, :AutoList, []
 	@imports = []
 
 	@task_show = nil
@@ -380,7 +321,7 @@ class Rant::RantApp
 
 	@orig_pwd = nil
 	@current_subdir = ""
-
+	@resolve_hooks = []
     end
 
     def [](opt)
@@ -412,22 +353,6 @@ class Rant::RantApp
     ### experimental support for subdirectories ######################
     def expand_project_path(path)
 	expand_path(@current_subdir, path)
-=begin
-	case path
-	when nil:	@current_subdir.dup
-	when "":	@current_subdir.dup
-	when /^#/:	path.sub(/^#/, '')
-	when /^\\#/:	path.sub(/^\\/, '')
-	else
-	    #puts "epp: current_subdir: #@current_subdir"
-	    if @current_subdir.empty?
-		# we are in project's root directory
-		path
-	    else
-		File.join(@current_subdir, path)
-	    end
-	end
-=end
     end
     def expand_path(subdir, path)
 	case path
@@ -456,7 +381,8 @@ class Rant::RantApp
     def goto(dir)
 	# TODO: optimize
 	p_dir = expand_project_path(dir)
-	abs_path = project_to_fs_path(dir)
+	base = rootdir.empty? ? Dir.pwd : rootdir
+	abs_path = p_dir.empty? ? base : File.join(base, p_dir)
 	@current_subdir = p_dir
 	unless Dir.pwd == abs_path
 	    #puts "pwd: #{Dir.pwd}; abs_path: #{abs_path}"
@@ -466,6 +392,7 @@ class Rant::RantApp
 	    #STDERR.puts "rant: in #{p_dir}"
 	end
     end
+    # +dir+ is a path relative to +rootdir+
     def goto_project_dir(dir)
 	# TODO: optimize
 	goto "##{dir}"
@@ -512,6 +439,7 @@ class Rant::RantApp
 	end
 	# run tasks
 	run_tasks
+	goto "#"
 	raise Rant::RantDoneException
     rescue Rant::RantDoneException
 	@done = true
@@ -522,6 +450,10 @@ class Rant::RantApp
 	err_msg "Invalid Rantfile: " + $!.message
 	$stderr.puts "rant aborted!"
 	return 1
+    rescue Rant::RantError
+	err_msg $!.message, $!.backtrace[0..4]
+	$stderr.puts "rant aborted!"
+	return 1
     rescue Rant::RantAbortException
 	$stderr.puts "rant aborted!"
 	return 1
@@ -535,7 +467,7 @@ class Rant::RantApp
 	@plugins.each { |plugin| plugin.rant_quit }
 	# restore pwd
 	Dir.pwd != @orig_pwd && Dir.chdir(@orig_pwd)
-	Rant.rantapp = self.class.new
+	Rant.rac = self.class.new
     end
 
     ###### methods accessible through RantContext ####################
@@ -573,14 +505,6 @@ class Rant::RantApp
 	file = ch[:file]
 	# validate args
 	generator = args.shift
-	# Let modules/classes from the Generator namespace override
-	# other generators.
-	begin
-	    if generator.is_a? Module
-		generator = ::Rant::Generators.const_get(generator.to_s)
-	    end
-	rescue NameError, ArgumentError
-	end
 	unless generator.respond_to? :rant_generate
 	    abort(pos_text(file, ln),
 		"First argument to `gen' has to be a task-generator.")
@@ -591,20 +515,23 @@ class Rant::RantApp
 
     # Currently ignores block.
     def import(*args, &block)
+	ch = Rant::Lib::parse_caller_elem(caller[1])
 	if block
-	    warn_msg "import: currently ignoring block"
+	    warn_msg pos_text(ch[:file], ch[:ln]),
+		"import: ignoring block"
 	end
 	args.flatten.each { |arg|
 	    unless String === arg
-		abort("import: currently " + 
-		    "only strings are allowed as arguments")
+		abort(pos_text(ch[:file], ch[:ln]),
+		    "import: only strings allowed as arguments")
 	    end
 	    unless @imports.include? arg
 		unless Rant::CODE_IMPORTS.include? arg
 		    begin
 			require "rant/import/#{arg}"
 		    rescue LoadError => e
-			abort("No such import - #{arg}")
+			abort(pos_text(ch[:file], ch[:ln]),
+			    "No such import - #{arg}")
 		    end
 		    Rant::CODE_IMPORTS << arg.dup
 		end
@@ -683,9 +610,11 @@ class Rant::RantApp
     def source rantfile
 	rf, is_new = rantfile_for_path(rantfile)
 	return false unless is_new
+	build rantfile
 	unless rf.exist?
-	    abort("source: No such file to load - #{rantfile}")
+	    abort("source: No such file - #{rantfile}")
 	end
+
 	load_file rf
 	true
     end
@@ -704,7 +633,7 @@ class Rant::RantApp
 	    end
 	    unless arg.is_a? String
 		abort(pos_text(file, ln),
-		    "in `subdirs' command: arguments must be strings")
+		    "subdirs: arguments must be strings")
 	    end
 	    loaded = false
 	    prev_subdir = @current_subdir
@@ -727,22 +656,32 @@ class Rant::RantApp
 		goto_project_dir prev_subdir
 	    end
 	    unless loaded || quiet?
-		warn_msg(pos_text(file, ln) + "; in `subdirs' command:",
-		    "No Rantfile in subdir `#{arg}'.")
+		warn_msg(pos_text(file, ln),
+		    "subdirs: No Rantfile in subdir `#{arg}'.")
 	    end
 	}
     rescue SystemCallError => e
-	abort(pos_text(file, ln),
-	    "in `subdirs' command: " + e.message)
+	abort(pos_text(file, ln), "subdirs: " + e.message)
     end
 
-    def sys(*args)
+    def sys(*args, &block)
 	if args.empty?
 	    @sys
 	else
 	    @sys.sh(*args)
 	end
     end
+
+    # The [] and []= operators may be used to set/get values from this
+    # object (like a hash). It is intended to let the different
+    # modules, plugins and tasks to communicate with each other.
+    def var(*args, &block)
+	if args.empty?
+	    @var
+	else
+	    @var.query(*args, &block)
+	end
+    end
     ##################################################################
 
     # Pop (remove and return) current pending task description.
@@ -759,6 +698,12 @@ class Rant::RantApp
 	raise Rant::RantAbortException
     end
 
+    def abort_at(ch, *msg)
+	err_msg(pos_text(ch[:file], ch[:ln]), msg)
+	$stderr.puts caller if @opts[:trace_abort]
+	raise Rant::RantAbortException
+    end
+
     def help
 	puts "rant [-f RANTFILE] [OPTIONS] tasks..."
 	puts
@@ -769,27 +714,56 @@ class Rant::RantApp
 
     def show_descriptions
 	tlist = select_tasks { |t| t.description }
+	# +target_list+ aborts if no task defined, so we can be sure
+	# that +default+ is not nil
+	def_target = target_list.first
 	if tlist.empty?
-	    msg "No described targets."
+	    puts "rant         # => " + list_task_names(
+		resolve(def_target)).join(', ')
+	    msg "No described tasks."
 	    return
 	end
 	prefix = "rant "
 	infix = "  # "
 	name_length = 0
 	tlist.each { |t|
-	    if t.name.length > name_length
-		name_length = t.name.length
+	    if t.full_name.length > name_length
+		name_length = t.full_name.length
 	    end
 	}
 	name_length < 7 && name_length = 7
 	cmd_length = prefix.length + name_length
+	# TODO: show what's done if rant is invoked without argument
+	unless tlist.first.full_name == def_target
+	    defaults = list_task_names(
+		resolve(def_target)).join(', ')
+	    puts "#{prefix}#{' ' * name_length}#{infix}=> #{defaults}"
+	end
 	tlist.each { |t|
-	    print(prefix + t.name.ljust(name_length) + infix)
+	    print(prefix + t.full_name.ljust(name_length) + infix)
 	    dt = t.description.sub(/\s+$/, "")
 	    puts dt.sub("\n", "\n" + ' ' * cmd_length + infix + "  ")
 	}
 	true
     end
+    def list_task_names(*tasks)
+	rsl = []
+	tasks.flatten.each { |t|
+	    if t.respond_to?(:has_actions?) && t.has_actions?
+		rsl << t
+	    elsif t.respond_to? :prerequisites
+		if t.prerequisites.empty?
+		    rsl << t
+		else
+		    rsl.concat(list_task_names(t.prerequisites))
+		end
+	    else
+		rsl << t
+	    end
+	}
+	rsl
+    end
+    private :list_task_names
 		
     # Increase verbosity.
     def more_verbose
@@ -864,8 +838,8 @@ class Rant::RantApp
 	not @rantfiles.all? { |f| f.tasks.empty? }
     end
 
-    def run_tasks
-	unless have_any_task?
+    def target_list
+	if !have_any_task? && @resolve_hooks.empty?
 	    abort("No tasks defined for this rant application!")
 	end
 
@@ -876,49 +850,81 @@ class Rant::RantApp
 	target_list = @force_targets + @arg_targets
 	# The target list is a list of strings, not Task objects!
 	if target_list.empty?
-	    have_default = @rantfiles.any? { |f|
-		f.tasks.any? { |t| t.name == "default" }
-	    }
-	    if have_default
+	    def_tasks = resolve "default"
+	    #have_default = @rantfiles.any? { |f|
+	    #	f.tasks.any? { |t| t.name == "default" }
+	    #}
+	    unless def_tasks.empty?
 		target_list << "default"
 	    else
 		first = nil
 		@rantfiles.each { |f|
 		    unless f.tasks.empty?
-			first = f.tasks.first.name
+			first = f.tasks.first.full_name
 			break
 		    end
 		}
 		target_list << first
 	    end
 	end
+	target_list
+    end
+
+    def run_tasks
 	# Now, run all specified tasks in all rantfiles,
 	# rantfiles in reverse order.
 	opt = {}
 	matching_tasks = 0
 	target_list.each do |target|
-	    matching_tasks = 0
-	    if @force_targets.include?(target)
-		opt[:force] = true
-		@force_targets.delete(target)
-	    end
-	    ### pre 0.3.1 ###
-	    #(select_tasks { |t| t.name == target }).each { |t|
-	    select_tasks_by_name(target).each { |t|
-		matching_tasks += 1
-		begin
-		    t.invoke(opt)
-		rescue Rant::TaskFail => e
-		    # TODO: Report failed dependancy.
-		    abort("Task `#{e.tname}' fail.")
-		end
-	    }
-	    if matching_tasks == 0
+	    goto "#"
+	    if build(target) == 0
 		abort("Don't know how to build `#{target}'.")
 	    end
 	end
     end
 
+    # Invoke all tasks necessary to build +target+. Returns the number
+    # of tasks invoked.
+    def build target, opt = {}
+	opt[:force] = true if @force_targets.delete(target)
+	matching_tasks = 0
+	resolve(target).each { |t|
+	    matching_tasks += 1
+	    begin
+		t.invoke(opt)
+	    rescue Rant::TaskFail => e
+		# TODO: Report failed dependancy.
+		abort("Task `#{e.tname}' fail.")
+	    end
+	}
+	matching_tasks
+    end
+
+    def resolve task_name, rel_project_dir = @current_subdir
+	#select_tasks_by_name task_name, rel_project_dir
+	# Note: first lines copied from +select_tasks_by_name+
+	# for efficiency reasons
+	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]
+		return s if s
+	    }
+	    []
+	when Rant::Worker: [s]
+	else # assuming MetaTask
+	    s
+	end
+    end
+    public :resolve
+
+    def at_resolve &block
+	@resolve_hooks << block if block
+    end
+    public :at_resolve
+
     # Returns a list with all tasks for which yield
     # returns true.
     def select_tasks
@@ -1074,8 +1080,8 @@ class Rant::RantApp
 	ARGV.replace(old_argv)
 	rem_args.each { |ra|
 	    if ra =~ /(^[^=]+)=([^=]+)$/
-		msg 2, "Environment: #$1=#$2"
-		ENV[$1] = $2
+		msg 2, "var: #$1=#$2"
+		@var[$1] = $2
 	    else
 		@arg_targets << ra
 	    end
@@ -1165,13 +1171,15 @@ class Rant::RantApp
 		name = normalize_task_name(k, file, ln)
 		pre = v
 	    }
-	    if pre.respond_to? :to_ary
-		pre = pre.to_ary.dup
-		pre.map! { |elem|
-		    normalize_task_name(elem, file, ln)
-		}
-	    else
-		pre = [normalize_task_name(pre, file, ln)]
+	    unless ::Rant::FileList === pre
+		if pre.respond_to? :to_ary
+		    pre = pre.to_ary.dup
+		    pre.map! { |elem|
+			normalize_task_name(elem, file, ln)
+		    }
+		else
+		    pre = [normalize_task_name(pre, file, ln)]
+		end
 	    end
 	else
 	    name = normalize_task_name(targ, file, ln)
@@ -1216,9 +1224,9 @@ class Rant::RantApp
 	end
     end
 
-    # Just ensure that Rant.rantapp holds an RantApp after loading
+    # Just ensure that Rant.rac holds an RantApp after loading
     # this file. The code in initialize will register the new app with
-    # Rant.rantapp= if necessary.
+    # Rant.rac= if necessary.
     self.new
 
 end	# class Rant::RantApp