rant 0.3.4 → 0.3.6

data/lib/rant/rantsys.rb

@@ -1,4 +1,8 @@
 
+# rantsys.rb - Support for the +sys+ method/object.
+#
+# Copyright (C) 2005 Stefan Lang <langstefan@gmx.at>
+
 require 'fileutils'
 require 'rant/rantenv'
 
@@ -65,7 +69,7 @@ module Rant
 	    case other
 	    when Array
 		dup.files.concat(other)
-	    when self.class
+	    when FileList
 		c = other.dup
 		c.actions.concat(@actions)
 		c.files.concat(@files)
@@ -97,8 +101,9 @@ module Rant
 	    if @files.respond_to? sym
 		resolve if @pending
 		fh = @files.hash
-		@files.send(sym, *args, &block)
+		rv = @files.send(sym, *args, &block)
 		@pending = true unless @files.hash == fh
+		rv.equal?(@files) ? self : rv
 	    else
 		super
 	    end
@@ -118,7 +123,7 @@ module Rant
 	end
 
 	def include(*patterns)
-	    patterns.each { |pat|
+	    patterns.flatten.each { |pat|
 		@actions << [:apply_include, pat]
 	    }
 	    @pending = true
@@ -201,6 +206,17 @@ module Rant
 	end
 	private :mk_all_rx
 
+	def select &block
+	    d = dup
+	    d.actions << [:apply_select, block]
+	    d
+	end
+
+	def apply_select blk
+	    @files = @files.select &blk
+	end
+	private :apply_select
+
 	# Remove all entries which contain a directory with the
 	# given name.
 	# If no argument or +nil+ given, remove all directories.
@@ -307,8 +323,13 @@ module Rant
 
     class RacFileList < FileList
 
+	attr_reader :subdir
+	attr_reader :basedir
+
 	def initialize(rac, *patterns)
 	    @rac = rac
+	    @subdir = @rac.current_subdir
+	    @basedir = Dir.pwd
 	    super(*patterns)
 	    @ignore_hash = nil
 	    update_ignore_rx
@@ -321,6 +342,21 @@ module Rant
 	    @ignore_rx
 	end
 
+	alias filelist_resolve resolve
+	def resolve
+	    Dir.chdir(@basedir) { filelist_resolve }
+	end
+
+	def each &block
+	    old_pwd = Dir.pwd
+	    resolve if @pending
+	    Dir.chdir(@basedir)
+	    filelist_resolve
+	    @files.each(&block)
+	ensure
+	    Dir.chdir(old_pwd)
+	end
+
 	private
 	def update_ignore_rx
 	    ri = @rac.var[:ignore]
@@ -331,7 +367,44 @@ module Rant
 		@ignore_hash = rh
 	    end
 	end
-    end
+    end	# class RacFileList
+
+    class MultiFileList
+
+	attr_reader :cur_list
+	
+	def initialize(rac)
+	    @rac = rac
+	    @cur_list = RacFileList.new(@rac)
+	    @lists = [@cur_list]
+	end
+
+	def each_entry &block
+	    @lists.each { |list|
+		list.each &block
+	    }
+	end
+
+	def add(filelist)
+	    # TODO: validate filelist
+	    @cur_list = filelist
+	    @lists << filelist
+	    self
+	end
+
+	def method_missing(sym, *args, &block)
+	    if @cur_list && @cur_list.respond_to?(sym)
+		if @cur_list.subdir == @rac.current_subdir
+		    @cur_list.send(sym, *args, &block)
+		else
+		    add(RacFileList.new(@rac))
+		    @cur_list.send(sym, *args, &block)
+		end
+	    else
+		super
+	    end
+	end
+    end	# class MultiFileList
 
     class CommandError < StandardError
 	attr_reader :cmd
@@ -375,6 +448,13 @@ module Rant
 	    ::Rant.rac.cmd_msg msg if ::Rant.rac
 	end
 
+	# Run an external command. When given one argument, this is
+	# subject to shell interpretation. Otherwise the first
+	# argument is the program to run, following arguments are
+	# given as arguments to the program.
+	#
+	# Note: This method is called on +sys <some_string>+
+	# invocation in an Rantfile.
 	def sh(*cmd_args, &block)
 	    cmd_args.flatten!
 	    cmd = cmd_args.join(" ")
@@ -386,6 +466,8 @@ module Rant
 	    end
 	end
 
+	# Run a new Ruby interpreter with the given arguments:
+	#     sys.ruby "install.rb"
 	def ruby(*args, &block)
 	    if args.size > 1
 		sh([Env::RUBY] + args, &block)
@@ -427,6 +509,11 @@ module Rant
 
     end	# module Sys
 
+    # An instance of this class is returned from the +sys+ method in
+    # Rantfiles (when called without arguments).
+    #     sys.rm_rf "tmp"
+    # In this (Rantfile) example, the +rm_rf+ message is sent to an
+    # instance of this class.
     class SysObject
 	include Sys
 
@@ -449,6 +536,7 @@ module Rant
 	end
 
 	private
+	# Delegates FileUtils messages to +rac+.
 	def fu_output_message(cmd)
 	    @rac.cmd_msg cmd
 	end

data/lib/rant/rantvar.rb

@@ -10,8 +10,13 @@
 # This file provides support for the +var+ attribute of the Rant
 # application (Rant::RantApp#var).
 
+# Most constants (classes, modules etc.) of Rant live in this module,
+# thus it acts as a namespace.
+#
+# If you're looking for general info about Rant, read the
+# README[link:files/README.html].
 module Rant
-    VERSION	= '0.3.4'
+    VERSION	= '0.3.6'
 
     # Those are the filenames for rantfiles.
     # Case matters!
@@ -67,6 +72,20 @@ module Rant
 	    end
 	end
 
+	class NotAConstraintFactoryError < Error
+	    attr_reader :obj
+	    def initialize(obj, msg = nil)
+		@msg = msg
+		@obj = obj
+	    end
+	    def message
+		# TODO: handle @msg
+		obj_desc = @obj.inspect
+		obj_desc[7..-1] = "..." if obj_desc.length > 10
+		"#{obj_desc} is not a valid constraint factory"
+	    end
+	end
+
 	class InvalidVidError < Error
 	    def initialize(vid, msg = nil)
 		@msg = msg
@@ -95,6 +114,8 @@ module Rant
 		@store = {}
 		# holds constraints for values in @store
 		@constraints = {}
+		# set by default query
+		@current_var = nil
 	    end
 
 	    def query(*args, &block)
@@ -105,25 +126,57 @@ module Rant
 		when 1
 		    arg = args.first
 		    if Hash === arg
-			init_all arg
+			if arg.size == 1
+			    arg.each { |k,v|
+				@current_var = k
+				self[k] = v if self[k].nil?
+			    }
+			    self
+			else
+			    init_all arg
+			end
 		    else
 			self[arg]
 		    end
 		when 2..3
-		    vid, constraint, val = *args
+		    @current_var, cf, val = *args
+		    self.is cf
+		    self[@current_var] = val if val
+		else
+		    raise QueryError, "to many arguments"
+		end
+	    end
+
+	    def is ct, *ct_args
+		constrain @current_var,
+		    get_factory(ct).rant_constraint(*ct_args)
+		self
+	    end
+
+	    def restrict vid, ct, *ct_args
+		if vid.respond_to? :to_ary
+		    vid.to_ary.each { |v| restrict(v, ct, *ct_args) }
+		else
+		    constrain vid,
+			get_factory(ct).rant_constraint(*ct_args)
+		end
+		self
+	    end
+
+	    def get_factory id
+		if String === id || Symbol === id
 		    begin
-			constraint =
-			    Constraints.const_get(constraint).new
+			id = Constraints.const_get(id)
 		    rescue
-			raise QueryError,
-			    "no such constraint: #{constraint}", caller
+			raise NotAConstraintFactoryError.new(ct), caller
 		    end
-		    constrain vid, constraint
-		    self[vid] = val if val
-		else
-		    raise QueryError, "to many arguments"
 		end
+		unless id.respond_to? :rant_constraint
+		    raise NotAConstraintFactoryError.new(id), caller
+		end
+		id
 	    end
+	    private :get_factory
 
 	    # Get var with name +vid+.
 	    def [](vid)
@@ -198,6 +251,10 @@ module Rant
 		end
 	    end
 
+	    def has_var?(vid)
+		!self[vid].nil?
+	    end
+
 	end	# class Space
 
 	module Constraint
@@ -211,9 +268,65 @@ module Rant
 
 	module Constraints
 
+	    class String
+		include Constraint
+
+		class << self
+		    alias rant_constraint new
+		end
+
+		def filter(val)
+		    if val.respond_to? :to_str
+			val.to_str
+		    elsif Symbol === val
+			val.to_s
+		    else
+			raise ConstraintError.new(self, val)
+		    end
+		end
+		def default
+		    ""
+		end
+		def to_s
+		    "string"
+		end
+	    end
+
+	    class ToString < String
+		class << self
+		    alias rant_constraint new
+		end
+		def filter(val)
+		    val.to_s
+		end
+	    end
+
+	    class ::Range
+		def rant_constraint
+		    case first
+		    when ::Integer
+			IntegerInRange.new(self)
+		    when ::Float
+			FloatInRange.new(self)
+		    else
+			raise NotAConstraintFactoryError.new(self)
+		    end
+		end
+	    end
+
 	    class Integer
 		include Constraint
 
+		class << self
+		    def rant_constraint(range = nil)
+			if range
+			    IntegerInRange.new(range)
+			else
+			    self.new
+			end
+		    end
+		end
+
 		def filter(val)
 		    Kernel::Integer(val)
 		rescue
@@ -227,9 +340,79 @@ module Rant
 		end
 	    end
 
+	    class IntegerInRange < Integer
+		def initialize(range)
+		    @range = range
+		end
+		def filter(val)
+		    i = super
+		    if @range === i
+			i
+		    else
+			raise ConstraintError.new(self, val)
+		    end
+		end
+		def default
+		    @range.min
+		end
+		def to_s
+		    super + " #{@range}"
+		end
+	    end
+
+	    class Float
+		include Constraint
+
+		class << self
+		    def rant_constraint(range = nil)
+			if range
+			    FloatInRange.new(range)
+			else
+			    self.new
+			end
+		    end
+		end
+
+		def filter(val)
+		    Kernel::Float(val)
+		rescue
+		    raise ConstraintError.new(self, val)
+		end
+		def default
+		    0.0
+		end
+		def to_s
+		    "float"
+		end
+	    end
+
+	    class FloatInRange < Float
+		def initialize(range)
+		    @range = range
+		end
+		def filter(val)
+		    i = super
+		    if @range === i
+			i
+		    else
+			raise ConstraintError.new(self, val)
+		    end
+		end
+		def default
+		    @range.first
+		end
+		def to_s
+		    super + " #{@range}"
+		end
+	    end
+
 	    class AutoList
 		include Constraint
 
+		class << self
+		    alias rant_constraint new
+		end
+
 		def filter(val)
 		    if val.respond_to? :to_ary
 			val.to_ary
@@ -250,6 +433,10 @@ module Rant
 	    class List
 		include Constraint
 
+		class << self
+		    alias rant_constraint new
+		end
+
 		def filter(val)
 		    if val.respond_to? :to_ary
 			val.to_ary
@@ -267,6 +454,60 @@ module Rant
 
 	    Array = List
 
+	    class Bool
+		include Constraint
+		class << self
+		    alias rant_constraint new
+		end
+		def filter(val)
+		    if ::Symbol === val or ::Integer === val
+			val = val.to_s
+		    end
+		    if val == true
+			true
+		    elsif val == false || val == nil
+			false
+		    elsif val.respond_to? :to_str
+			case val.to_str
+			when /^\s*true\s*$/i:	true
+			when /^\s*false\s*$/i:	false
+			when /^\s*y(es)?\s*$/i:	true
+			when /^\s*n(o)?\s*$/:	false
+			when /^\s*on\s*$/i:	true
+			when /^\s*off\s*$/i:	false
+			when /^\s*1\s*$/:	true
+			when /^\s*0\s*$/:	false
+			else
+			    raise ConstraintError.new(self, val)
+			end
+		    else
+			raise ConstraintError.new(self, val)
+		    end
+		end
+		def default
+		    false
+		end
+		def to_s
+		    "bool"
+		end
+	    end
+
+	    class BoolTrue < Bool
+		def default
+		    true
+		end
+	    end
+
+	    #--
+	    # perhaps this should stay a secret ;)
+	    #++
+	    def true.rant_constraint
+		BoolTrue.rant_constraint
+	    end
+	    def false.rant_constraint
+		Bool.rant_constraint
+	    end
+
 	end	# module Constraints
 
 	# A +vid+ has to be a String to be valid.