rant 0.4.6 → 0.4.8

data/doc/rantfile.rdoc

@@ -182,10 +182,10 @@ explain it a little bit. The +sys+ command can be used in three ways:
 
    When the external program returns with an exit code other than 0,
    Rant will abort with an error message. Sometimes this is not
-   desirable. E.g. the +diff+, which compares two files, returns 0 if
-   the files are equal, 1 if have differences and something else if an
-   error occurs. Rant allows you to handle/ignore the exit code of a
-   program yourself. Example:
+   desirable. E.g. the +diff+ program, which compares two files,
+   returns 0 if the files are equal, 1 if they have differences and
+   something else if an error occurs. Rant allows you to handle/ignore
+   the exit code of a program yourself. Example:
 
         task :diff do |t|
             sys "diff -u a/util.c b/util.c > util.diff" do |ps|
@@ -310,20 +310,20 @@ last dot with the given string.
 === Importing additional generators
 
 The +import+ function lets you import additional generators.
-Currently the following are coming with Rant:
-Clean::		Remove selected files.
-AutoClean::	Remove all files generated by any file task (including
-		those generated by rules).
-DirectedRule::	A Rule which takes sources from one or more
-		directories and puts generated files into a specified
-		directory.
-SubFile::	Create file task and necessary directory tasks.
-RubyTest::	Run Test::Unit tests for your Ruby code.
-RubyDoc::	Run RDoc.
-RubyPackage::	Generate tar, zip and gem packages of your Ruby
-		application/library.
+Currently the following come with Rant:
+Clean::         Remove selected files.
+AutoClean::     Remove all files generated by any file task (including
+                those generated by rules).
+DirectedRule::  A Rule which takes sources from one or more
+                directories and puts generated files into a specified
+                directory.
+SubFile::       Create file task and necessary directory tasks.
+RubyTest::      Run Test::Unit tests for your Ruby code.
+RubyDoc::       Run RDoc.
+RubyPackage::   Generate tar, zip and gem packages of your Ruby
+                application/library.
 Win32::RubyCmdWrapper:: Create .cmd wrapper scripts for installation
-			of Ruby scripts on Windows.
+                        of Ruby scripts on Windows.
 
 Read doc/advanced.rdoc[link:files/doc/advanced_rdoc.html] and
 doc/rubyproject.rdoc[link:files/doc/rubyproject_rdoc.html] for

data/doc/rubyproject.rdoc

@@ -8,11 +8,11 @@ We are assuming a project with the following directories and files:
     Rantfile
     README
     bin/
-	wgrep
+        wgrep
     lib/
-	wgrep.rb
+        wgrep.rb
     test/
-	tc_wgrep.rb
+        tc_wgrep.rb
 You can find this little project in test/project_rb1 directory of the
 Rant package. You'll probably have more files in your project, but we
 will try to write our Rantfile as generic as possible:
@@ -20,27 +20,27 @@ will try to write our Rantfile as generic as possible:
     import %w(rubytest rubydoc rubypackage clean)
 
     lib_files = sys["lib/**/*.rb"]
-    dist_files = lib_files + %w(rantfile.rb README) + sys["{test,bin}/*"]
+    dist_files = lib_files + sys["README", "rantfile.rb", "{test,bin}/*"]
 
     desc "Run unit tests."
     gen RubyTest do |t|
-	t.test_dir = "test"
-	t.pattern = "tc_*.rb"
+        t.test_dir = "test"
+        t.pattern = "tc_*.rb"
     end
 
     desc "Generate html documentation."
     gen RubyDoc do |t|
-	t.opts = %w(--title wgrep --main README README)
+        t.opts = %w(--title wgrep --main README README)
     end
 
     desc "Create packages."
     gen RubyPackage, "wgrep" do |t|
-	t.version = "1.0.0"
-	t.summary = "Simple grep program."
-	t.files = dist_files
-	t.bindir = "bin"
-	t.executable = "wgrep"
-	t.package_task
+        t.version = "1.0.0"
+        t.summary = "Simple grep program."
+        t.files = dist_files
+        t.bindir = "bin"
+        t.executable = "wgrep"
+        t.package_task
     end
 
     desc "Remove autogenerated and backup files."
@@ -73,8 +73,8 @@ collect the testcases and then runs the _testrb_ command.
 To format the documentation:
     % rant doc
 
-				 README:
-			       wgrep.rb: mcc....
+                                 README:
+                               wgrep.rb: mcc....
     Generating HTML...
 
     Files:   2
@@ -150,9 +150,9 @@ you can set the +pkg_dir+ attribute:
 Perhaps you want to specify explicetely what packages you want to
 build. To accomplish this, each of the following methods listed takes
 an optional task name as argument:
-    t.tar_task		# create tar.gz archive, task name defaults to "tar"
-    t.zip_task		# create zip archive, task name defaults to "zip"
-    t.gem_task		# create gem, task name defaults to "gem"
+    t.tar_task          # create tar.gz archive, task name defaults to "tar"
+    t.zip_task          # create zip archive, task name defaults to "zip"
+    t.gem_task          # create gem, task name defaults to "gem"
 An example would be:
     desc "Create tar.gz package."
     t.tar_task :archive
@@ -166,28 +166,28 @@ An example would be:
 In our example we had only a few attributes for our package. Here are
 following two lists with the available attributes.
 * Attributes that take a single argument:
-	name
-	date
-	description
-	email
-	has_rdoc
-	homepage
-	platform
-	required_ruby_version
-	rubyforge_project
-	summary
-	version
+        name
+        date
+        description
+        email
+        has_rdoc
+        homepage
+        platform
+        required_ruby_version
+        rubyforge_project
+        summary
+        version
 * Attributes that take one or more values (if you give a single value
   it will automatically be converted to a list):
-	author
-	bindir
-	executable
-	extension
-	files
-	rdoc_options
-	requires
-	test_files
-	test_suite
+        author
+        bindir
+        executable
+        extension
+        files
+        rdoc_options
+        requires
+        test_files
+        test_suite
 The attributes can also be set without the assignment operator:
     t.executable "mybin"
 
@@ -202,11 +202,11 @@ task name.  The output directory for the html files defaults to +doc+.
 To change this set the +dir+ attribute:
     desc "Generate html documentation."
     gen RubyDoc, :html do |t|
-	t.dir = "doc/html"
+        t.dir = "doc/html"
 As rant invokes RDoc programmatically, no command is printed when the
 task is run. If you want to see one, set the verbose attribute to
 +true+:
-	t.verbose = true
+        t.verbose = true
 
 === Installation
 
@@ -224,14 +224,14 @@ lines to your Rantfile:
 
     desc "Install wgrep."
     task :install do
-	# Run setup.rb with the Ruby interpreter.
-	sys.ruby "setup.rb"
+        # Run setup.rb with the Ruby interpreter.
+        sys.ruby "setup.rb"
     end
 
     if Env.on_windows?
-	# Create .cmd files for all scripts in the bin/ directory and
-	# make the install task dependent on them.
-	enhance :install => (gen Win32::RubyCmdWrapper, sys["bin/*"])
+        # Create .cmd files for all scripts in the bin/ directory and
+        # make the install task dependent on them.
+        enhance :install => (gen Win32::RubyCmdWrapper, sys["bin/*"])
     end
 
 == See also

data/doc/subdirs.rdoc

@@ -123,7 +123,7 @@ To run the IO related tests from the test directory we type:
     testrb tc_reader.rb tc_writer.rb
     ... output of testrb ...
 
-To run the clobber task from the test directory:
+To run the clobber task from the toplevel directory:
 
     <test> $ rant @clobber
     (root is /home/stefan/Ruby/misc/rant/rbtest, in test)

data/lib/rant/coregen.rb

@@ -98,7 +98,7 @@ module Rant
                 }
             end
         end
-	class Rule < ::Proc
+	class Rule
 	    # Generate a rule by installing an at_resolve hook for
 	    # +rac+.
 	    def self.rant_gen(rac, ch, args, &block)
@@ -136,48 +136,88 @@ module Rant
 			"to be a string or regular expression")
 		end
 		src_proc = case src_arg
-                    when String
+                    when String, Array
                         unless String === target
                             rac.abort(ch, "rule target has to be " +
                                   "a string if source is a string")
                         end
-                        lambda { |name| name.sub(/#{esc_target}$/, src_arg) }
+                        if src_arg.kind_of? String
+                            lambda { |name|
+                                name.sub(/#{esc_target}$/, src_arg)
+                            }
+                        else
+                            lambda { |name|
+                                src_arg.collect { |s_src|
+                                    s_src = ".#{s_src}" if Symbol === s_src
+                                    name.sub(/#{esc_target}$/, s_src)
+                                }
+                            }
+                        end
                     when Proc: src_arg
                     when nil: lambda { |name| [] }
                     else
-                        rac.abort_at(ch, "rule source has to be " +
-                            "String or Proc")
+                        rac.abort_at(ch, "rule source has to be a " +
+                            "String, Array or Proc")
                     end
-		blk = self.new { |task_name, rel_project_dir|
-		    if target_rx =~ task_name
+                rac.resolve_hooks <<
+                    (block.arity == 2 ? Hook : FileHook).new(
+                           rac, ch, target_rx, src_proc, block)
+		nil
+	    end
+            class Hook
+                attr_accessor :target_rx
+                def initialize(rant, ch, target_rx, src_proc, block)
+                    @rant = rant
+                    @ch = ch
+                    @target_rx = target_rx
+                    @src_proc = src_proc
+                    @block = block
+                end
+                def call(target, rel_project_dir)
+		    if @target_rx =~ target
                         have_src = true
-                        src = src_proc[task_name]
+                        src = @src_proc[target]
                         if src.respond_to? :to_ary
                             src.each { |f|
-                                if rac.resolve(f).empty? && !test(?e, f)
+                                if @rant.resolve(f).empty? && !test(?e, f)
                                     have_src = false
                                     break
                                 end
                             }
                         else
-                            if rac.resolve(src).empty? && !test(?e, src)
+                            if @rant.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]
+                            create_nodes(rel_project_dir, target, src)
                         end
-		    end
-		}
-		blk.target_rx = target_rx
-		rac.resolve_hooks << blk
-		nil
-	    end
-	    attr_accessor :target_rx
-	end	# class Rule
+                    end
+                end
+                alias [] call
+                private
+                def create_nodes(rel_project_dir, target, deps)
+                    case nodes = @block[target, deps]
+                    when Array: nodes
+                    when Node: [nodes]
+                    else
+                        @rant.abort_at(@ch, "Block has to " +
+                            "return Node or array of Nodes.")
+                    end.each { |node|
+                        node.project_subdir = @rant.current_subdir
+                    }
+                end
+            end
+            class FileHook < Hook
+                private
+                def create_nodes(rel_project_dir, target, deps)
+                    t = @rant.file(:__caller__ => @ch,
+                            target => deps, &@block)
+                    t.project_subdir = @rant.current_subdir
+                    [t]
+                end
+            end
+	end # class Rule
 	class Action
 	    def self.rant_gen(rac, ch, args, &block)
 		unless args.empty?

data/lib/rant/import/archive.rb

@@ -9,6 +9,7 @@
 
 require 'rant/rantlib'
 require 'rant/import/subfile'
+require 'rant/metautils'
 #require 'rant/progress' #rant-import:uncomment
 #require 'rant/tempfile' #rant-import:uncomment
 

data/lib/rant/import/command.rb

@@ -0,0 +1,206 @@
+
+# command.rb - File tasks with command change recognition.
+#
+# Copyright (C) 2005 Stefan Lang <langstefan@gmx.at>
+
+#require 'rant/import/metadata' #rant-import:uncomment
+#require 'rant/import/signature/md5' #rant-import:uncomment
+
+module Rant
+    def self.init_import_command(rant, *rest)
+        rant.import "metadata" unless rant.var._get("__metadata__")
+        rant.import "signature/md5" unless rant.var._get("__signature__")
+    end
+    module Generators
+        class Command
+            def self.rant_gen(rant, ch, args, &block)
+                if args.size == 1 && block
+                    return \
+                    rant.prepare_task(args.first, nil, ch) { |n,pre,_|
+                        t = rant.node_factory.new_file(rant, n, pre, nil)
+                        t.receiver = CommandManager.new(nil, block)
+                        t
+                    }
+                elsif args.size < 2
+                    rant.abort_at(ch, "Command: At least two " +
+                        "arguments required: task name and command.")
+                elsif args.size > 3
+                    rant.abort_at(ch, "Command: Too many arguments.")
+                end
+                # determine task name
+                name = args.shift
+                if name.respond_to? :to_str
+                    name = name.to_str
+                else
+                    rant.abort_at(ch, "Command: task name (string) " +
+                        "as first argument required")
+                end
+                if args.size == 1 && args.first.respond_to?(:to_hash)
+                    parse_keyword_syntax(rant, ch,
+                        name, block, args[0].to_hash)
+                else
+                    parse_plain_syntax(rant, ch,
+                        name, block, args[0], args[1])
+                end
+            end
+            def self.parse_plain_syntax(rant, ch, name, block, pre, cmd)
+                # determine prerequisites
+                pre ||= []
+                # determine command
+                (cmd = pre; pre = []) unless cmd
+                if cmd.respond_to? :to_str
+                    cmd = cmd.to_str
+                else
+                    rant.abort_at(ch, "Command: command argument has " +
+                        "to be a string.")
+                end
+                rant.prepare_task({name => pre}, nil, ch) { |n,pre,_|
+                    t = rant.node_factory.new_file(rant, n, pre, nil)
+                    t.receiver = CommandManager.new(cmd, block)
+                    t
+                }
+            end
+            def self.parse_keyword_syntax(rant, ch, name, block, hash)
+                # TODO
+                rant.abort_at(ch, "Command: syntax error")
+            end
+        end # class Command
+    end # module Generators
+    module Node
+        def interp_vars!(str)
+            str.gsub!(/\$\((\w+)\)/) { |_|
+                val = val_for_interp_var($1)
+                unless val.respond_to?(:to_ary)
+                    val = val.to_s
+                    interp_vars!(val) 
+                end
+                Sys.sp(val)
+            }
+            str.gsub!(/\$\{(\w+)\}/) { |_|
+                val = val_for_interp_var($1)
+                unless val.respond_to?(:to_ary)
+                    val = val.to_s
+                    interp_vars!(val) 
+                end
+                Sys.escape(val)
+            }
+            str.gsub!(/\$\[(\w+)\]/) { |_|
+                val = val_for_interp_var($1)
+                if val.respond_to?(:to_ary)
+                    val.to_ary.join(' ')
+                else
+                    val = val.to_s
+                    interp_vars!(val)
+                end
+                val
+            }
+            str
+        end
+        def interp_symbolic_vars!(str)
+            str.gsub!(/\$\((-|<|>)\)/) { |_|
+                Sys.sp(val_for_interp_sym($1))
+            }
+            str.gsub!(/\$\{(-|<|>)\}/) { |_|
+                Sys.escape(val_for_interp_sym($1))
+            }
+            str.gsub!(/\$\[(-|<|>)\]/) { |_|
+                val = val_for_interp_sym($1)
+                val.respond_to?(:to_ary) ? val.to_ary.join(' ') : val.to_s
+            }
+            str
+        end
+        private
+        def val_for_interp_var(var)
+            case var
+            when "name": self.name
+            when "prerequisites": self.prerequisites
+            when "source": self.source
+            else
+                cx = rac.cx
+                val = cx.var._get(var) || (
+                    if cx.instance_eval("defined? @#{var}")
+                        cx.instance_variable_get "@#{var}"
+                    else
+                        rac.warn_msg(rac.pos_text(
+                            rantfile.path, line_number),
+                            "Command: undefined variable `#{var}'")
+                        ""
+                    end
+                )
+                if val.respond_to?(:call) && val.respond_to?(:arity)
+                    val.arity == 0 ? val.call : val.call(self)
+                elsif val.respond_to?(:to_hash)
+                    rac.warn_msg(
+                        "`#{var}' -- Avoid interpolation of hashes.\n" +
+                        "Behaviour is undecided.")
+                    ""
+                    #val.to_hash[full_name]
+                else
+                    val
+                end
+            end
+        end
+        def val_for_interp_sym(sym)
+            case sym
+            when ">": name
+            when "<": prerequisites
+            when "-": source
+            end
+        end
+    end
+    class CommandManager
+        def initialize(cmd_str, cmd_block)
+            @cmd_str = cmd_str
+            @cmd_block = cmd_block
+            @command = nil
+        end
+        def update?(node)
+            res_command(node)
+            @command_changed
+        end
+        def has_pre_action?
+            true
+        end
+        def pre_run(node)
+	    dir = File.dirname(node.name)
+            unless dir == "." || dir == "/"
+                node.rac.build dir, :type => :file 
+            end
+            @command.split(/\n/).each { |cmd| node.rac.sys cmd }
+            if @command_changed
+                node.goto_task_home
+                @md.path_set(@cmd_key, @new_sig, node.name)
+            end
+            @command_changed = @cmd_key = @new_sig = @md = nil
+        end
+        private
+        def res_command(node)
+            return if @command
+            @command =
+                if @cmd_block
+                    cmd = (@cmd_block.arity == 0 ?
+                        @cmd_block.call :
+                        @cmd_block[node])
+                    if cmd.respond_to? :to_str
+                        cmd.to_str.dup
+                    else
+                        node.rac.abort_at(node.ch,
+                            "Command: block has to return command string.")
+                    end
+                else
+                    node.interp_vars!(@cmd_str.to_str.dup)
+                end
+            var = node.rac.var
+            @md = var._get "__metadata__"
+            sigs = var._get "__signature__"
+            @cmd_key = "command_sig_#{sigs.name}"
+            old_sig = @md.path_fetch(@cmd_key, node.name)
+            sig_str = @command.gsub(/( |\t)+/, ' ')
+            sig_str.gsub!(/\[#.*?#\]/, '')
+            @command.gsub!(/\[#(.*?)#\]/) { |_| $1 }
+            node.interp_symbolic_vars!(@command)
+            @new_sig = sigs.signature_for_string(sig_str)
+            @command_changed = old_sig != @new_sig
+        end
+    end # class CommandManager
+end # module Rant

data/lib/rant/import/nodes/default.rb

@@ -33,6 +33,8 @@ module Rant
     class Task
 	include Node
 
+        attr_accessor :receiver
+
 	def initialize(rac, name, prerequisites = [], &block)
 	    super()
 	    @rac = rac or raise ArgumentError, "rac not given"
@@ -46,6 +48,7 @@ module Rant
 	    #	false	invoked, but fail
 	    #	true	invoked and run successfully
 	    @success = nil
+            @receiver = nil
 	end
 
 	# Get a list of the *names* of all prerequisites. The
@@ -64,7 +67,7 @@ module Rant
 	# True if this task has at least one action (block to be
 	# executed) associated.
 	def has_actions?
-	    !!@block
+            @block or @receiver && @receiver.has_pre_action?
 	end
 
 	# Add a prerequisite.
@@ -141,9 +144,13 @@ module Rant
 		    dep
 		end
 	    }
+            if @receiver
+                goto_task_home
+                update = true if @receiver.update?(self)
+            end
 	    # Never run a task block for a "needed?" query.
 	    return update if opt[:needed?]
-	    run if update
+            run if update
 	    @success = true
 	    # IMPORTANT: return update flag
 	    update
@@ -501,8 +508,7 @@ module Rant
 	    if File.exist?(@name)
 		@ts = File.mtime @name
 	    else
-		rac.abort(rac.pos_text(@rantfile, @line_number),
-		    "SourceNode: no such file -- #@name")
+		rac.abort_at(ch, "SourceNode: no such file -- #@name")
 	    end
 	    sd = project_subdir
 	    @pre.each { |f|
@@ -512,7 +518,7 @@ module Rant
 			mtime = File.mtime f
 			@ts = mtime if mtime > @ts
 		    else
-			rac.abort(rac.pos_text(@rantfile, @line_number),
+			rac.abort_at(ch, 
 			    "SourceNode: no such file -- #{f}")
 		    end
 		else
@@ -523,7 +529,7 @@ module Rant
                             goto_task_home
 			    @ts = node_ts if node_ts > @ts
 			else
-			    rac.abort(rac.pos_text(@rantfile, @line_number),
+			    rac.abort_at(ch, 
 				"SourceNode can't depend on #{node.name}")
 			end
 		    }

data/lib/rant/import/nodes/signed.rb

@@ -42,7 +42,7 @@ module Rant
                 if test(?f, @name)
                     @signature = sig.signature_for_file(@name)
                 else
-                    @rac.abort(rac.pos_text(@rantfile, @line_number),
+                    @rac.abort_at(ch,
                         "SourceNode: no such file -- #@name")
                 end
                 sd = project_subdir
@@ -55,7 +55,7 @@ module Rant
                         if test(?f, f)
                             sig_list << sig.signature_for_file(f)
                         else
-                            rac.abort(rac.pos_text(@rantfile, @line_number),
+                            rac.abort_at(ch,
                                 "SourceNode: no such file -- #{f}")
                         end
                     else
@@ -66,7 +66,7 @@ module Rant
                                 sig_list << node.signature
                                 goto_task_home
                             else
-                                rac.abort(rac.pos_text(@rantfile, @line_number),
+                                rac.abort_at(ch,
                                     "SourceNode can't depend on #{node.name}")
                             end
                         }