rant 0.3.0 → 0.3.2

data/NEWS

@@ -0,0 +1,21 @@
+
+= Rant NEWS
+
+== Rant 0.3.2
+
+This version should be fully backwards compatible to 0.3.0.
+
+New features:
+* Support splitting your buildfiles up and placing them into multiple
+  directories with the +subdirs+ command. Please read
+  doc/rantfile.rdoc[link:files/doc/rantfile_rdoc.html] for usage.
+  This is especially usefull for bigger projects.
+
+== Rant 0.3.0
+
+First release of Rant on RubyForge.
+
+== See also
+
+Rant Overview::
+    README[link:files/README.html]

data/README

@@ -36,6 +36,11 @@ Running rant in the directory of this file:
 will ensure that the "data" file in the "backup" directory is up to
 date.
 
+This document was written for version 0.3.2 of Rant. Most things
+described here will work for older/newer versions of Rant, but look at
+the README file in the Rant distribution you've installed for exact
+documentation for your Rant version.
+
 == Support
 
 The newest version of this document can be found at
@@ -66,6 +71,9 @@ Using the Configure plugin::
     read doc/configure.rdoc[link:files/doc/configure_rdoc.html]
 Compiling C#::
     read doc/csharp.rdoc[link:files/doc/csharp_rdoc.html]
+Upgrading::
+    read the NEWS[link:files/NEWS.html] for new features, not
+    backwards compatible changes and other issues.
 
 == Installation
 

data/Rantfile

@@ -1,16 +1,13 @@
-#!/usr/bin/env ruby
 
 # Rantfile for Rant :)
 
-require 'rant'
-
 import %w(rubytest rubydoc rubypackage)
 
 task :default => :test
 
 lib_files = FileList["lib/**/*.rb"]
-dist_files = FileList["{bin,lib,test,doc}/**/*"].no_dir("html") +
-	FileList["*"].no_dir.no_file("InstalledFiles").no_file("Session.vim")
+dist_files = FileList["{bin,lib,test,doc}/**/*"].shun("html", "coverage") +
+	FileList["*"].no_dir.exclude("InstalledFiles", "Session.vim")
 
 gen RubyPackage, "rant" do |t|
     t.version = `#{Env::RUBY} run_rant --version`.split[1]
@@ -20,8 +17,8 @@ gen RubyPackage, "rant" do |t|
     t.executable %w(rant rant-import)
     t.author = "Stefan Lang"
     t.email = "langstefan@gmx.at"
-    t.gem_rubyforge_project = "make"
-    t.gem_extra_rdoc_files = FileList["**/README"].no_dir("pkg").no_dir("test") + FileList["doc/**/*.rdoc"]
+    t.rubyforge_project = "make"
+    t.gem_extra_rdoc_files = FileList["**/README", "NEWS"].no_dir("pkg").no_dir("test") + FileList["doc/**/*.rdoc"]
     t.homepage = "http://make.rubyforge.org"
     desc "Create packages for distribution."
     t.package_task
@@ -30,7 +27,7 @@ end
 desc "Generate documentation."
 gen RubyDoc do |g|
     g.dir = "doc/html"
-    g.files.concat FileList["**/README"].no_dir("pkg").no_dir("test")
+    g.files.concat FileList["NEWS", "**/README"].no_dir("pkg").no_dir("test")
     g.files.concat FileList["doc/**/*.rdoc"]
     g.opts = %w(-S -c UTF-8 --title Rant --main README)
 end
@@ -41,15 +38,13 @@ gen RubyTest do |g|
     g.pattern = 'test_*.rb'
 end
 
-desc "Run first test-project.",
-     "Warning: writes to disc."
+desc "Run first test-project."
 gen RubyTest, :testp1 do |g|
     g.libs << "test"
     g.test_files = ["test/project1/test_project.rb"]
 end
 
-desc "Run second test project.",
-     "Warning: writes to disc"
+desc "Run second test project."
 gen RubyTest, :testp2 do |g|
     g.libs << "test"
     g.test_files = ["test/project2/test_project.rb"]
@@ -75,6 +70,12 @@ task :cov do
     end
 end
 
+desc "Test project with subdirs."
+gen RubyTest, :tsubdirs do |t|
+    t.libs << "test"
+    t.test_files = FileList["test/subdirs/test_*.rb"]
+end
+
 desc "Run all tests."
 gen RubyTest, :tall do |g|
     g.libs << "test"
@@ -88,17 +89,30 @@ task :clean do
     sys.rm_rf %w(doc/html pkg test/coverage)
 end
 
+desc "Publish html docs on make.rubyfore.org.",
+     "Note: scp will prompt for rubyforge password."
+task "publish-docs" => :doc do
+    sys "scp -r doc/html/* langi@rubyforge.org:/var/www/gforge-projects/make/"
+end
+
 # Just for quick visual testing of rant...
 task :please_fail do |t|
     sys "mix_nix_gibts"
 end
 
+task "to-win" => :package do
+    win_dir = "/mnt/data_fat/stefan/Ruby"
+    Dir["pkg/*"].each { |f|
+	target = File.join(win_dir, File.basename(f))
+	sys.rm_rf target if test(?e, target)
+	sys.cp_r f, target
+    }
+end
+
 # for quich rant testing
 #plugin :Configure
 
 # mainly for rant testing
-source 'rantmethods.rb'
+#source 'rantmethods.rb'
 
-if $0 == __FILE__
-    Rant.run
-end
+# vim:ft=ruby:

data/TODO

@@ -1,6 +1,9 @@
 
 = TODO
 
+== Packaging
+Try minitar if tar is not available.
+
 == C# plugin
 Define the method +assembly+ for building a file with the C# compiler?
 Done.
@@ -10,10 +13,6 @@ Done.
 Add a 'distclean' task that removes all files and directories
 generatet by any file task.
 
-RDoc task.
-
-Gem task (+ one that interactively creates a gemspec).
-
 == Java plugin
 
 At least for the 1.0.0 release.

data/devel-notes

@@ -47,4 +47,20 @@ The unit tests contain many assertions of the form
 which are wrong, because the first argument should be the expected
 result!
 
+== <tt>FileList < Array</tt> problems
+There arise some severe problems. E.g. the Array#flatten method:
+    [FileList["*.rb"]].flatten
+The +flatten+ method doesn't call *any* method of our FileList but
+it recognizes that it is an Array and copies the elements directly.
+So there is *no* way to resolve the glob pattern and there will never
+any Ruby file be selected!
+
+== Subdirectories
+Rant would have to check and eventually +cd+ before doing one of the
+following:
+* Loading an Rantfile (even through +source+).
+* Worker#invoke
+* Worker#needed?
+* RantApp#run before returning.
+
 # vim:tw=70:

data/doc/csharp.rdoc

@@ -59,9 +59,8 @@ linked against, the +sources+ attribute should be clear and the
 assembly.
 
 Now let's see what is actually done by rant when we feed it this
-Rantfile. Because we have only one task defined, there is no need to
-specify a task on the commandline:
-    % rant
+Rantfile. We tell rant to build <tt>myprog.exe</tt>:
+    % rant myprog.exe
     cscc -o myprog.exe -Wall -O2 -l System.Drawing.dll -l System.Windows.Forms.dll -fresources=res/MyProg.legend.png src/MyProg.cs src/Util.cs
 This was on a Linux system, on Windows you'll probably see a command
 with csc.

data/doc/examples/myprog/README

@@ -0,0 +1,2 @@
+
+This is the README file for the myprog program.

data/doc/examples/myprog/Rantfile

@@ -0,0 +1,13 @@
+desc "Build myprog."
+file "myprog" => "src/myprog" do
+    sys.cp "src/myprog", "myprog"
+end
+
+desc "Remove compiler products."
+task :clean => "src/clean" do
+    sys.rm_f "myprog"
+end
+
+# Tell Rant to look in src for an Rantfile,
+# we could list more directories here.
+subdirs "src"

data/doc/examples/myprog/src/Rantfile

@@ -0,0 +1,15 @@
+file "lib.o" => %w(lib.c lib.h) do
+    sys "cc -c -o lib.o lib.c"
+end
+
+file "main.o" => "main.c" do
+    sys "cc -c -o main.o main.c"
+end
+
+file "myprog" => %w(lib.o main.o) do
+    sys "cc -o myprog main.o lib.o"
+end
+
+task :clean do
+    sys.rm_f Dir["*.o"] + %w(myprog)
+end

data/doc/examples/myprog/src/lib.c

@@ -0,0 +1,6 @@
+#include "lib.h"
+
+int nothing(void)
+{
+    return 0;
+}

data/doc/examples/myprog/src/lib.h

@@ -0,0 +1,4 @@
+#ifndef LIB_H
+#define LIB_H
+int nothing(void);
+#endif

data/doc/examples/myprog/src/main.c

@@ -0,0 +1,7 @@
+#include "lib.h"
+
+int main(int argc, char** argv)
+{
+    nothing();
+    return 0;
+}

data/doc/rantfile.rdoc

@@ -31,6 +31,8 @@ methods with the Rant application:
 		on it.
 +source+::	Takes a filename as argument and causes Rant to read
 		it in as Rantfile.
++subdirs+::	Takes a list of subdirectories in which Rant should
+		look for Rantfiles.
 
 === Defining a task
 
@@ -42,7 +44,7 @@ anything. To associate an action with the task, add a block:
     task :mytask do
 	puts "Hello, mytask running."
     end
-Put these 3 lines of code into an Rantfile and run rant:
+Put these 3 lines of code into a file called +Rantfile+ and run rant:
     % rant mytask
     Hello, mytask running.
 Note: you could have ommited the mytask argument to rant because it is
@@ -67,7 +69,7 @@ Add prerequisites to create relations between tasks:
     task :t2 do |t|
 	puts t.name
     end
-In the definition of the "first" task we told Rant that it +depends+
+In the definition of the "first" task we told Rant that it _depends_
 on task "t1" and task "t2". "t1" and "t2" are called prerequisites for
 "first". Try it out:
     % rant first
@@ -164,12 +166,19 @@ FileUtils module:
     sys.safe_ln "src", "dest"	 # create a hardlink or fall back to
 				 # copying
 If you're tired of typing <tt>sys.</tt> all the time, you can include
-the +Sys+ module in your Rantfile:
+the +Sys+ module in your Rantfile (though it is not recommended to do
+this):
     include Sys
     task :clean do
 	rm_f "myprog"
     end
 Then you can invoke these methods without the <tt>sys</tt> function.
+Note::	You are highly encouraged to not <tt>include Sys</tt> into
+	your Rantfile as this introduces many methods in the global
+	namespace, which can cause name clashes with other libraries.
+	Of course if you have just some tasks to remove backup files
+	in your home directory and do not use other Ruby libraries in
+	your Rantfile, it is no problem.
 
 === Generators
 
@@ -219,6 +228,102 @@ Currently the following are coming with Rant:
 		application/library.
 As these are all Ruby specific, please read the Ruby project howto.
 
+=== The +subdirs+ command
+
+The +subdirs+ command allows you to give Rant a list of subdirectories
+(relative to the Rantfile) where it should look for additional
+Rantfiles. The tasks defined in those subdirectories can be referenced
+from your main Rantfile and vice versa.
+
+A small example: We are assuming the following files:
+    myprog/
+	Rantfile	# the main Rantfile
+	README
+	src/
+	    Rantfile
+	    main.c
+	    lib.c
+	    lib.h
+Then the main Rantfile could look like:
+    desc "Build myprog."
+    file "myprog" => "src/myprog" do
+	sys.cp "src/myprog", "myprog"
+    end
+
+    desc "Remove compiler products."
+    task :clean => "src/clean" do
+	sys.rm_f "myprog"
+    end
+
+    # Tell Rant to look in src for an Rantfile,
+    # we could list more directories here.
+    subdirs "src"
+And src/Rantfile:
+    file "lib.o" => %w(lib.c lib.h) do
+	sys "cc -c -o lib.o lib.c"
+    end
+
+    file "main.o" => "main.c" do
+	sys "cc -c -o main.o main.c"
+    end
+
+    file "myprog" => %w(lib.o main.o) do
+	sys "cc -o myprog main.o lib.o"
+    end
+
+    task :clean do
+	sys.rm_f Dir["*.o"] + %w(myprog)
+    end
+Note that we refer to the task in subdirectory simply by prepending
+the directory name and a slash to the task name.
+    file "myprog" => "src/myprog" do
+This tells Rant that the "myprog" task depends on the "myprog" task
+defined in the Rantfile in the "src" directory. The same goes for the
+"clean" task.
+
+Let's examine what Rant thinks about our build specification:
+    myprog % rant -T
+    rant myprog   # Build myprog.
+    rant clean    # Remove compiler products.
+Since the "myprog" task is the first in our Rantfile, we don't need to
+specify a task to build myprog:
+    myprog % rant
+    cc -c -o lib.o lib.c
+    cc -c -o main.o main.c
+    cc -o myprog main.o lib.o
+    cp src/myprog myprog
+And to save disk space, remove generated files:
+    myprog % rant clean
+    rm -f lib.o main.o myprog
+    rm -f myprog
+The nice thing about our buildfiles is, that we can use the
+src/Rantfile independent from our main Rantfile. Consider you are
+working on <tt>lib.c</tt> and only want to check that it compiles
+correctly.
+You can specify the task explicitely:
+    myprog % rant src/lib.o
+    cc -c -o lib.o lib.c
+But if you are working a long time only in the src/ directory it is
+convinient to do:
+    myprog % cd src
+    myprog/src % rant lib.o
+    cc -c -o lib.o lib.c
+To clean only the src directory:
+    myprog/src % rant clean
+    rm -f lib.o main.o myprog
+You can find this example project in the doc/examples/myprog directory
+of the Rant distribution.
+
+Of course you can also have a subdirectory in src/ containing an
+Rantfile. Simply put a +subdirs+ command into the src/Rantfile. Rant
+integrates well into your file system :)
+
+If you want to refer to a task in the main Rantfile from a subdir
+Rantfile, put a # in front of the task name:
+    task "a" => "#b"
+But note that this Rantfile won't work as a standalone buildfile,
+because it refers to a main Rantfile.
+
 == See also
 
 Rant Overview::

data/lib/rant/cs_compiler.rb

@@ -6,7 +6,7 @@ module Rant
     # interface to a C# Compiler.
     class CsCompiler
 
-	LIB_SYSTEM_XML	= "System.Xml.dll"
+	LIB_SYSTEM_XML		= "System.Xml.dll"
 	LIB_SYSTEM_DRAWING	= "System.Drawing.dll"
 	LIB_SYSTEM_FORMS	= "System.Windows.Forms.dll"
 
@@ -123,12 +123,12 @@ module Rant
 	    @entry = nil
 	    @optimize = true
 	    @warnings = true
-	    @csc = nil
 	    @csc_bin = nil
 	end
 
 	# Command to invoke compiler.
 	def csc
+	    #puts "#@csc_bin, #@csc_name"
 	    @csc_bin || @csc_name
 	end
 
@@ -136,9 +136,10 @@ module Rant
 	# +cc_bin+, this also tries to determine which interface to
 	# use for this compiler. Finally it sets +cc_bin+.
 	def csc=(cmd)
-	    name = self.class.cs_compiler_name(cmd)
+	    @csc_bin = cmd.dup
+	    name = self.class.cs_compiler_name(@csc_bin)
 	    @csc_name = name if name
-	    @csc_bin = cmd
+	    #puts "csc=() setting csc_bin to " + @csc_bin
 	end
 
 	def csc_name= new_name
@@ -167,6 +168,7 @@ module Rant
 	    # This generates the compilation command
 	    # for cscc.
 	    cc_cmd = csc.dup
+	    #puts "creating exe command for #{cc_cmd}"
 	    cc_cmd << " -e#{entry}" if entry
 	    cc_cmd << cc_cmd_args
 	    cc_cmd