rant 0.5.6 → 0.5.7

data/NEWS

@@ -1,6 +1,18 @@
 
 = Rant NEWS
 
+== Rant 0.5.7
+
+Fixes and minor improvements:
+* Fixed: Rules wouldn't work if the target file was specified by an
+  absolute path. (Reported by Brendan Boesen.)
+* Fixed: Script files use env ruby (Russel Windir)
+
+New features:
+* The method <tt>Rant::Sys.absolute_path?</tt>.
+  Read doc/sys.rdoc[link:files/doc/sys_rdoc.html] for documentation.
+* Added non-deprecated support for C#. Read doc/csharp.rdoc[link:files/doc/csharp_rdoc.html] for documentation.
+
 == Rant 0.5.6
 
 Fixes and minor improvements:

data/README

@@ -38,7 +38,7 @@ 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.5.4 of Rant. Most things
+This document was written for version 0.5.6 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 of your Rant version.
@@ -85,7 +85,7 @@ Tasks with command change recognition::
 Using the Configure plugin::
     read doc/configure.rdoc[link:files/doc/configure_rdoc.html] *deprecated*
 Compiling C#::
-    read doc/csharp.rdoc[link:files/doc/csharp_rdoc.html] *deprecated*
+    read doc/csharp.rdoc[link:files/doc/csharp_rdoc.html]
 Common file system operations::
     read doc/sys.rdoc[link:files/doc/sys_rdoc.html]
 Upgrading::
@@ -179,6 +179,7 @@ Rant was tested on:
 			1.9
     MacOS X		1.8.2
     Windows XP		1.8.2 (OneClick Installer)
+    Windows XP		1.8.4 (OneClick Installer)
     Windows 2000	1.8.2 (OneClick Installer)
 
 It *should* run on most platforms where Ruby runs, but you never
@@ -208,4 +209,3 @@ basic concept and syntax of Rake and of course I could have written
 code for Rake (e.g. with a so called _Tasklib_) to support portable C#
 compilation. But it was a bit quirky and because I like to work with
 Ruby, I decided to write my own build tool.
-

data/Rantfile

@@ -85,7 +85,13 @@ end
 desc "Run basic tests."
 gen RubyTest do |g|
     g.libs << "test"
-    g.pattern = 'test_*.rb'
+    g.test_files = sys["test/test_*.rb", "test/units/**/test_*.rb"]
+end
+
+desc "Run just unit tests."
+gen RubyTest, "test:units".to_sym do |g|
+    g.libs << "test"
+    g.test_files = sys["test/units/**/test_*.rb"]
 end
 
 desc "Run first test-project."

data/doc/Untitled-1~

@@ -0,0 +1,7 @@
+
+== Support for C#
+
+Rant contains a number of generators to support the building of C# projects -
+from compiling source files to resources to testing.
+
+= 

data/doc/command.rdoc

@@ -74,7 +74,7 @@ There is also a more concise syntax:
 
     gen Rule, ".o" => ".c" do |target, sources|
         gen Command, target, sources,
-            'cc -c -o $(<) $[CFLAGS] $(-)'
+            'cc -c -o $(>) $[CFLAGS] $(-)'
     end
 
 For the last syntax:

data/doc/csharp.rdoc

@@ -1,73 +1,50 @@
 
-== Compiling C# sources
-
-Support for C# is currently implemented as plugin. But expect that to
-change in the near future. Also note that support for C# wasn't
-heavily tested (but it works because I'm using it).
-
-It is convinient to use the C# plugin in combination with the
-Configure plugin. I'll show a short Rantfile first and explain it
-afterwards.
-
-    conf = plugin :Configure do |conf|
-	desc "Configure build."
-	conf.task
-	desc "Interactive configure."
-	conf.task "ask-config", [:interact]
-	conf.init_modes = [:guess, :interact]
-    end
-
-    plugin :Csharp do |cs|
-	cs.config = conf
-    end
-
-    gen Assembly, "myprog.exe" do |t|
-	t.libs = %w(System.Drawing.dll System.Windows.Forms.dll)
-	t.sources = Dir["src/*.cs"]
-	t.resources = Dir["res/*.*"]
-    end
-
-First we instantiate the Configure plugin and let it define two tasks
-for us:
-<tt>conf.task</tt>::	Creates a task with the name "configure" which
-			will first guess values and ask the user as
-			fallback if it can't guess the value.
-<tt>conf.task "ask-config", [:interact]</tt>::
-    This task interactively asks the user for all values.
-Afterwards we set the +init_modes+. Those decide what will be done on
-a regular rant startup if the +config+ file doesn't exist. We tell it
-to first guess configure values and to fall back to interactive mode
-if necessary.
-
-Then we instantiate the Csharp plugin and connect it with the
-Configure plugin. As a result of this operation, the Csharp plugin
-will define three configure _checks_:
-1. The command to invoke the C# compiler.
-2. If optimization should be turned on.
-3. If debug information should be generated.
-
-And last but not least we let generate a task to compile our program
-<tt>myprog.exe</tt>. The +Assembly+ generator takes the same argument
-as a normal task, meaning you could also add prerequisites:
-    gen Assembly, "myprog.exe" => :pre do |t|
-	.
-	.
-	.
-The +libs+ attribute is a list of libraries the assembly will be
-linked against, the +sources+ attribute should be clear and the
-+resources+ attribute is a list of resources to be embedded in the
-assembly.
-
-Now let's see what is actually done by rant when we feed it this
-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.
-
-== See also
-
-Rant Overview::
-    README[link:files/README.html]
-Writing an Rantfile::
-    doc/rantfile.rdoc[link:files/doc/rantfile_rdoc.html]
+== C# Compiling
+
+Compiling a basic C# application is as simple as passing the desired filename and a list of source files to the +CSharp+ generator (assuming a C# compiler is in your path).
+
+    import 'csharp'
+    gen CSharp, "example.dll", :sources => sys["**/*.cs"]
+    
+This creates a file task called "example.dll". Source files can be specified as a +FileList+, array, or string. The created task is dependent on all source files, so if any of them change the dll will be recompiled. You can specify library and resource files in the same manner
+
+    gen CSharp, "example.dll", :sources => sys["**/*.cs"],
+                               :libs    => ["mylib.dll", "mylib2.dll"]
+                               :res     => "myres.resource"
+                               
+The generator guesses what type of output you want by inspecting the file extension of the out file ("example.dll"). +exe+ will be compiled to +winexe+, +netmodule+ to +module+, and all others to +dll+. You can override this by providing a :target key in the parameter hash. Any other parameters you specify are passed through to the C# compiler.
+
+    gen CSharp, "example.exe", :sources     => sys["**/*.cs"],
+                               :target      => "exe",
+                               :warnaserror => true
+                               
+== Alternate Compilers
+
+The +CSharp+ generator searches your path for one of 3 known C# compilers - +csc+, +mcs+, and +gmcs+. You can specify a different compiler by providing a compiler adapter through the :compiler key. The existing compiler adapters provide a one parameter constructor that allows you to specify the path to that compiler. Or you can of course provide your own implementation.
+
+    csc11 = CscCompiler.new("/path/to/csc1.1")
+    gen CSharp, "example.dll", :sources  => sys["**/*.cs"],
+                               :compiler => csc11
+                               
+== Resource Generation
+
+A generator is provided to create a rule for compiling resource files with resgen. This is quite powerful as it allows you to simply reference the compiled resource files in you CSharp generator, and they will automatically be built as required.
+
+    import "resgen"
+    gen Resgen, :build_dir => "build/", :namespace => "Example"
+    
+    # properties/resource.resx => build/Example.Properties.Resource.resources
+    # MyRes.resx               => build/Example.MyRes.resources
+    
+== Running NUnit
+
+You can easily run an NUnit test suite using the +NUnitTest+ generator
+
+    import "nunittest"
+    gen NUnitTest, "test", :dlls => ["mytest1.dll", "mytest2.dll"]
+    
+By default, nunit-console is used, and it must exist in your path. You can specify a different test runner using the :bin key. Any other arguments are passed through to the test runner
+
+    gen NUnitTest, "test", :dlls => sys["test/*.dll"],
+                           :bin  => "my-test-runner",
+                           :xml  => "results.xml"

data/doc/csharp.rdoc~

@@ -0,0 +1,37 @@
+
+== C# Compiling
+
+Compiling a basic C# application is as simple as passing the desired filename and a list of source files to the +CSharp+ generator (assuming a C# compiler is in your path).
+
+    import 'csharp'
+    gen CSharp, "example.dll", :sources => sys["**/*.cs"]
+    
+This creates a file task called "example.dll". Source files can be specified as a +FileList+, array, or string. The created task is dependent on all source files, so if any of them change the dll will be recompiled. You can specify library and resource files in the same manner
+
+    gen CSharp, "example.dll", :sources => sys["**/*.cs"],
+                               :libs    => ["mylib.dll", "mylib2.dll"]
+                               :res     => "myres.resource"
+                               
+The generator guesses what type of output you want by inspecting the file extension of the out file ("example.dll"). +exe+ will be compiled to +winexe+, +netmodule+ to +module+, and all others to +dll+. You can override this by providing a :target key in the parameter hash. Any other parameters you specify are passed through to the C# compiler.
+
+    gen CSharp, "example.exe", :sources     => sys["**/*.cs"],
+                               :target      => "exe",
+                               :warnaserror => true
+                               
+== Alternate Compilers
+
+The +CSharp+ generator searches your path for one of 3 known C# compilers - +csc+, +mcs+, and +gmcs+. You can specify a different compiler by providing a compiler adapter through the :compiler key. The existing compiler adapters provide a one parameter constructor that allows you to specify the path to that compiler. Or you can of course provide your own implementation.
+
+    csc11 = CscCompiler.new("/path/to/csc1.1")
+    gen CSharp, "example.dll", :sources  => sys["**/*.cs"],
+                               :compiler => csc11
+                               
+== Resource Generation
+
+A generator is provided to create a rule for compiling resource files with resgen. This is quite powerful as it allows you to simply reference the compiled resource files in you CSharp generator, and they will automatically be built as required.
+
+    import "resgen"
+    gen Resgen, :build_dir => "build/", :namespace => "Example"
+    
+    # properties/resource.resx => build/Example.Properties.Resource.resources
+    # MyRes.resx               => build/Example.MyRes.resources

data/doc/csharp_deprecated.rdoc

@@ -0,0 +1,73 @@
+
+== Compiling C# sources
+
+Support for C# is currently implemented as plugin. But expect that to
+change in the near future. Also note that support for C# wasn't
+heavily tested (but it works because I'm using it).
+
+It is convinient to use the C# plugin in combination with the
+Configure plugin. I'll show a short Rantfile first and explain it
+afterwards.
+
+    conf = plugin :Configure do |conf|
+	desc "Configure build."
+	conf.task
+	desc "Interactive configure."
+	conf.task "ask-config", [:interact]
+	conf.init_modes = [:guess, :interact]
+    end
+
+    plugin :Csharp do |cs|
+	cs.config = conf
+    end
+
+    gen Assembly, "myprog.exe" do |t|
+	t.libs = %w(System.Drawing.dll System.Windows.Forms.dll)
+	t.sources = Dir["src/*.cs"]
+	t.resources = Dir["res/*.*"]
+    end
+
+First we instantiate the Configure plugin and let it define two tasks
+for us:
+<tt>conf.task</tt>::	Creates a task with the name "configure" which
+			will first guess values and ask the user as
+			fallback if it can't guess the value.
+<tt>conf.task "ask-config", [:interact]</tt>::
+    This task interactively asks the user for all values.
+Afterwards we set the +init_modes+. Those decide what will be done on
+a regular rant startup if the +config+ file doesn't exist. We tell it
+to first guess configure values and to fall back to interactive mode
+if necessary.
+
+Then we instantiate the Csharp plugin and connect it with the
+Configure plugin. As a result of this operation, the Csharp plugin
+will define three configure _checks_:
+1. The command to invoke the C# compiler.
+2. If optimization should be turned on.
+3. If debug information should be generated.
+
+And last but not least we let generate a task to compile our program
+<tt>myprog.exe</tt>. The +Assembly+ generator takes the same argument
+as a normal task, meaning you could also add prerequisites:
+    gen Assembly, "myprog.exe" => :pre do |t|
+	.
+	.
+	.
+The +libs+ attribute is a list of libraries the assembly will be
+linked against, the +sources+ attribute should be clear and the
++resources+ attribute is a list of resources to be embedded in the
+assembly.
+
+Now let's see what is actually done by rant when we feed it this
+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.
+
+== See also
+
+Rant Overview::
+    README[link:files/README.html]
+Writing an Rantfile::
+    doc/rantfile.rdoc[link:files/doc/rantfile_rdoc.html]

data/doc/homepage/index.html

@@ -89,9 +89,9 @@
             <a
                 href="http://rubyforge.org/tracker/?func=add&amp;group_id=615&amp;atid=2428">Report a bug</a><br/>
             <a title="Subversion repository for Rant development"
-                href="http://developer.berlios.de/svn/?group_id=5046">Repository</a><br/>
+                href="http://rubyforge.org/scm/?group_id=615">Repository</a><br/>
             <a title="Browse source code repository."
-                href="http://svn.berlios.de/wsvn/rant">WebSVN</a><br/>
+                href="http://rubyforge.org/cgi-bin/viewvc.cgi/?root=make">WebSVN</a><br/>
             </p>
         </div>
 
@@ -120,12 +120,9 @@
         <p>
         <a href="http://validator.w3.org/check?uri=referer"><img
             src="http://www.w3.org/Icons/valid-xhtml10"
-            alt="Valid XHTML 1.0!" height="31" width="88" /></a>
-        <a href="http://developer.berlios.de" title="BerliOS
-            Developer"> <img
-            src="http://developer.berlios.de/bslogo.php?group_id=5046"
-            width="124px" height="32px" alt="BerliOS
-            Developer Logo" /></a>
+            alt="Valid XHTML 1.0!" height="31" width="88" 
+            border="0"/></a>
+       
         </p>
 
         <!-- BlueRobot was here. -->

data/doc/homepage/index.html~

@@ -0,0 +1,134 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+<!--
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+    "http://www.w3.org/TR/html4/strict.dtd">
+
+<html>
+-->
+    <head>
+        <title>Rant</title>
+        <style type="text/css" media="screen">@import "rant_home.css";</style>
+    </head>
+
+    <body>
+
+        <div class="content">
+            <h1>Rant - Flexible, Ruby based make</h1>
+            <p>
+            Similar to make, the rant commandline tool reads a file called
+            Rantfile, which contains task definitions. Unlike make, however, an
+            Rantfile is just a valid script written in the Ruby programming
+            language.  Since Ruby comes with many useful libraries and is
+            portable across many different operating systems, it's very easy to
+            write portable Rantfiles.
+            </p>
+            <h2>Striking features:</h2>
+            <ul>
+                <li>Defining custom tasks.</li>
+                <li>Automated packaging, testing and RDoc generation for Ruby
+                applications and libraries.</li>
+                <li>Creation of a monolithic script tailored to the needs of a
+                specific project which can be used instead of an Rant
+                installation - users don't need to install Rant.</li>
+                <li>Creating gzipped tar and zip archives -- without installing
+                additional software.
+                </li>
+                <li>Optional recognition of file changes based on MD5
+                checksums instead of file modification times.
+                </li>
+                <li>Primitive support for compiling C# sources with csc, cscc
+                and mcs.</li>
+                <li>Dependency checking for C/C++ source files (integrated
+                makedepend replacement).</li>
+            </ul>
+        </div>
+
+        <div class="content">
+            <h2>Getting started</h2>
+            <dl>
+                <dt>1. Install Ruby</dt>
+                <dd>
+                Issue the command: <tt>% ruby --version</tt> <br/>
+                which prints the Ruby version number you've installed. If it
+                isn't equal or higher to 1.8.0, get a newer version from the <a
+                    href="http://www.ruby-lang.org/en/">Ruby homepage</a> or
+                the <a href="http://rubyforge.org/projects/rubyinstaller/">One-Click Installer for Windows</a>.
+                </dd>
+                <dt>2. Install Rant</dt>
+                <dd>
+                Issue the command: <tt>% gem install --remote rant</tt><br/>
+                which should download and install Rant. If you don't have the
+                gem command, download the package from <a
+                    href="http://rubyforge.org/frs/?group_id=615">RubyForge</a>,
+                unpack it and run <tt>% ruby install.rb</tt>.
+                </dd>
+                <dt>3. Read the <strong>documentation</strong></dt>
+                <dd>If you want to start with the basics, continue <a
+                    href="files/doc/rantfile_rdoc.html">here</a>.
+                </dd>
+                <dd>If you want to get an overview, continue <a
+                    href="files/README.html">here</a>.
+                </dd>
+            </dl>
+        </div>
+
+        <div id="navAlpha">
+            <h2>Links</h2>
+            <p>
+            <a href="files/NEWS.html">ChangeLog</a><br/>
+            <!--a href="api.html">API docs</a><br/-->
+            <a href="http://rubyforge.org/projects/make/">Project page</a><br/>
+            <a title="Subscribe to mailing list"
+                href="http://rubyforge.org/mailman/listinfo/make-cafe">Mailing list</a><br/>
+            <a title="Browse mailing list archives"
+                href="http://rubyforge.org/pipermail/make-cafe/">List archives</a><br/>
+            <a
+                href="http://rubyforge.org/tracker/?func=add&amp;group_id=615&amp;atid=2428">Report a bug</a><br/>
+            <a title="Subversion repository for Rant development"
+                href="http://developer.berlios.de/svn/?group_id=5046">Repository</a><br/>
+            <a title="Browse source code repository."
+                href="http://svn.berlios.de/wsvn/rant">WebSVN</a><br/>
+            </p>
+        </div>
+
+        <div id="navBeta">
+            <h2>Documentation</h2>
+            <a href="files/README.html">User Manual</a><br/>
+            <hr/>
+            <h2>Updating</h2>
+            <p>
+            Always read the <a href="files/NEWS.html">ChangeLog</a>
+            before installing a newer version of Rant. It describes
+            non-backwards compatible changes and new features.
+            </p>
+            <h2>Rant libraries</h2>
+            <p>
+            You can reuse code written for the Rant build tool as
+            &quot;normal&quot; Ruby library. Read <a
+                href="files/doc/rubylib_rdoc.html">Rant libraries</a>
+            </p>
+            <h2>Rant vs. Rake</h2>
+            <p>
+            <a href="files/doc/rant_vs_rake_rdoc.html">Read comparison</a>
+            </p>
+        </div>
+
+        <p>
+        <a href="http://validator.w3.org/check?uri=referer"><img
+            src="http://www.w3.org/Icons/valid-xhtml10"
+            alt="Valid XHTML 1.0!" height="31" width="88" /></a>
+        <a href="http://developer.berlios.de" title="BerliOS
+            Developer"> <img
+            src="http://developer.berlios.de/bslogo.php?group_id=5046"
+            width="124px" height="32px" alt="BerliOS
+            Developer Logo" /></a>
+        </p>
+
+        <!-- BlueRobot was here. -->
+
+    </body>
+</html>