rant 0.4.4 → 0.4.6

data/NEWS

@@ -1,6 +1,44 @@
 
 = Rant NEWS
 
+== Rant 0.4.6
+
+Incompatible changes:
+* *Important*: The notation <tt>"#foo"</tt> to reference a task
+  defined in the project's root directory changed to <tt>"@foo"</tt>.
+* Previous Rant versions loaded both, +Rantfile+ and
+  <tt>Rantfile.rb</tt>, if present. This version will only load one of
+  them (preferably +Rantfile+).
+* +RubyTest+ tasks no longer honour TESTOPTS variable.
+
+Deprecated:
+* The filenames <tt>Rantfile.rb</tt> and <tt>rantfile.rb</tt> are
+  deprecated for rantfiles and won't be recognized by future Rant
+  versions. Use +Rantfile+, +rantfile+ or <tt>root.rant</tt> instead.
+
+Fixes and minor improvements:
+* Fix an issue where a file was unnecessary rebuilt when rant was
+  started from different directories, the file task was created from a
+  rule and md5 signatures were used.
+* Concise output from Package::Tgz and Package::Zip tasks.
+* A manpage will be installed on Linux/Unix systems by the install.rb
+  script.
+* A fix for a FileUtils::Verbose bug in Ruby 1.8.3 which affects some
+  <tt>sys</tt> methods.
+
+New features:
+* The --cd-parent (-c) option to search for an Rantfile in parent
+  directories.
+* The --look-up (-u) option to search for the root Rantfile in parent
+  directories.
+* Recognition of rantfiles with the names <tt>root.rant</tt> and
+  <tt>sub.rant</tt>, where a <tt>sub.rant</tt> file is meant for a
+  project subdirectory and is treated special.
+  Read doc/subdirs.rdoc[link:files/doc/subdirs_rdoc.html]
+* The +sys+ and <tt>sys.ruby</tt> methods take an optional block for
+  custom process exit status handling (per default, Rant aborts if a
+  subprocess started with +sys+ exits with another status than 0).
+
 == Rant 0.4.4
 
 Besides internal changes, this release is backwards compatible to

data/README

@@ -41,7 +41,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.4.4 of Rant. Most things
+This document was written for version 0.4.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.
@@ -81,6 +81,8 @@ Using MD5 checksums instead of file modification times::
     read doc/md5.rdoc[link:files/doc/md5_rdoc.html]
 Compiling C/C++::
     read doc/c.rdoc[link:files/doc/c_rdoc.html]
+Buildfiles in subdirectories::
+    read doc/subdirs.rdoc[link:files/doc/subdirs_rdoc.html]
 Using the Configure plugin::
     read doc/configure.rdoc[link:files/doc/configure_rdoc.html]
 Compiling C#::
@@ -212,7 +214,7 @@ Rant was tested on:
     Linux		1.8.0
                         1.8.1
                         1.8.2
-			1.8.3 preview 1
+			1.8.3
 			1.9
     MacOS X		1.8.2
     Windows XP		1.8.2 (OneClick Installer)

data/Rantfile

@@ -2,20 +2,24 @@
 # Rantfile for Rant :)
 
 import "md5"
-import %w(rubytest rubydoc rubypackage autoclean win32/rubycmdwrapper)
+import %w(rubytest rubydoc rubypackage autoclean win32/rubycmdwrapper sys/more)
 
 task :default => :test
 
 dist_files = sys["{bin,lib,test,doc,misc}/**/*"]
 dist_files.shun("html", "coverage")
 dist_files += sys["*"].no_dir.exclude("InstalledFiles", "Session.vim")
+dist_files.exclude("bench-*")
+hp_files = sys["doc/homepage/*"]
+extra_rdoc_files = sys["**/README", "NEWS", "doc/**/*.rdoc"]
+extra_rdoc_files.no_dir("pkg").no_dir("test")
 
 # remove when compiler stuff is getting useful...
 dist_files.exclude "lib/rant/compiler*", "lib/rant/import/c/program.rb"
 
 rdoc_opts = %w(-S -c UTF-8 --title Rant --main README)
 
-gen RubyPackage, "rant" do |t|
+gen RubyPackage, "rant#{var :pkg_ext}" do |t|
     t.version = `#{Env::RUBY} run_rant --version`.split[1]
     t.summary = "Rant is a Ruby based build tool."
     t.files = dist_files
@@ -25,7 +29,7 @@ gen RubyPackage, "rant" do |t|
     t.email = "langstefan@gmx.at"
     t.rubyforge_project = "make"
     t.homepage = "http://make.rubyforge.org"
-    t.gem_extra_rdoc_files = sys["**/README", "NEWS"].no_dir("pkg").no_dir("test") + sys["doc/**/*.rdoc"]
+    t.gem_extra_rdoc_files = extra_rdoc_files
     t.gem_rdoc_options = rdoc_opts
     desc "Create packages for distribution."
     t.package_task
@@ -35,11 +39,35 @@ desc "Generate documentation."
 gen RubyDoc do |g|
     g.verbose = true
     g.dir = "doc/html"
-    g.files.concat sys["NEWS", "**/README"].no_dir("pkg").no_dir("test")
-    g.files.concat sys["doc/**/*.rdoc"]
+    g.files.concat extra_rdoc_files
     g.opts = rdoc_opts + %w(-T doc/jamis.rb)
 end
 
+html_index = "doc/html/index.html"
+api_index = html_index.sub("index", "api")
+
+enhance "doc/html/index.html" do
+    sys.rm_f api_index # remove old RDoc index page
+    make "hp2doc"
+end
+
+task "hp2doc" do
+    if test(?f, html_index) && !test(?f, api_index)
+        sys.mv html_index, api_index
+    end
+    sys.cp hp_files, "doc/html"
+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
+
+task "publish-hp" do
+    sys "scp -r doc/homepage/* langi@rubyforge.org:/var/www/gforge-projects/make/"
+end
+
 desc "Run basic tests."
 gen RubyTest do |g|
     g.libs << "test"
@@ -74,7 +102,7 @@ desc "Run all tests and generate coverage with rcov."
 task :cov do
     lp = File.expand_path "lib"
     sys.cd "test" do
-	sys %W(rcov -xtutil.rb,*.t,ts_*,tc_*,test_* -I#{lp} ts_all.rb)
+	sys %W(rcov -xtutil.rb,ts_*,tc_*,test_* -I#{lp} ts_all.rb)
     end
 end
 
@@ -120,12 +148,6 @@ var[:clean].include %w(
     InstalledFiles .config bench-rant bench-depsearch test/coverage
 )
 
-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"
@@ -145,10 +167,26 @@ end
 desc "Install Rant."
 task :install do
     sys.ruby "setup.rb"
+    # try to install man page
+    man_path = ENV["MANPATH"]
+    if man_path
+        puts "trying to install rant(1) manpage..."
+        require 'rbconfig'
+        prefix = Config::CONFIG["prefix"]
+        dirs = sys.split_path man_path
+        man_dir = dirs.find{|d| d == "#{prefix}/man" } || dirs.first
+        sys.install "doc/rant.1", "#{man_dir}/man1", :mode => 0644 if man_dir
+    end
 end
 
 if Env.on_windows?
     enhance :install => (gen Win32::RubyCmdWrapper, sys["bin/*"])
 end
 
+task "svn-clean" do
+    `svn stat`.split(/\n/).each { |line|
+        sys.clean line[7..-1] if line[0] == ??
+    }
+end
+
 # vim:ft=ruby

data/doc/examples/c_cpp/c++/problem_1_1/another_test.cpp

@@ -0,0 +1,6 @@
+
+#include "another_test.h"
+
+void another_test()
+{
+}

data/doc/examples/c_cpp/c++/problem_1_1/another_test.h

@@ -0,0 +1,5 @@
+
+#ifndef ANOTHER_TEST_H
+#define ANOTHER_TEST_H
+
+#endif

data/doc/examples/c_cpp/c++/problem_1_1/main.cpp

@@ -0,0 +1,12 @@
+
+#include <iostream>
+#include "test.h"
+#include "another_test.h"
+
+using namespace std;
+
+int main(char argc, char** argv)
+{
+    cout << "Hello, world!" << endl;
+    return 0;
+}

data/doc/examples/c_cpp/c++/problem_1_1/test.cpp

@@ -0,0 +1,6 @@
+
+#include "test.h"
+
+void test()
+{
+}

data/doc/examples/c_cpp/c++/problem_1_1/test.h

@@ -0,0 +1,5 @@
+
+#ifndef TEST_H
+#define TEST_H
+
+#endif

data/doc/examples/c_cpp/c++/template.rf

@@ -0,0 +1,15 @@
+# Autogenerated. Do not modify!
+# Create additional tasks and make other modifications in custom.rf.
+
+task :run => "test" do
+  sys "./test"
+end
+
+gen C::Dependencies
+gen Action do source "c_dependencies" end
+
+file "test" => sys["*.cpp"].sub_ext("o") do |t|
+  sys "g++ -o #{t.name} #{t.prerequisites}"
+end
+
+source "custom.rf" if File.exist? "custom.rf"

data/doc/examples/c_cpp/c/problem_1_1/another_test.c

@@ -0,0 +1,6 @@
+
+#include "another_test.h"
+
+void another_test()
+{
+}

data/doc/examples/c_cpp/c/problem_1_1/another_test.h

@@ -0,0 +1,7 @@
+
+#ifndef ANOTHER_TEST_H
+#define ANOTHER_TEST_H
+
+void another_test(void);
+
+#endif

data/doc/examples/c_cpp/c/problem_1_1/main.c

@@ -0,0 +1,12 @@
+
+#include <stdio.h>
+#include "test.h"
+#include "another_test.h"
+
+int main(char argc, char** argv)
+{
+    test();
+    another_test();
+    printf("Hello, world!\n");
+    return 0;
+}

data/doc/examples/c_cpp/c/problem_1_1/test.c

@@ -0,0 +1,6 @@
+
+#include "test.h"
+
+void test()
+{
+}

data/doc/examples/c_cpp/c/problem_1_1/test.h

@@ -0,0 +1,7 @@
+
+#ifndef TEST_H
+#define TEST_H
+
+void test(void);
+
+#endif

data/doc/examples/c_cpp/c/template.rf

@@ -0,0 +1,15 @@
+# Autogenerated. Do not modify!
+# Create additional tasks and make other modifications in custom.rf.
+
+task :run => "test" do
+  sys "./test"
+end
+
+gen C::Dependencies
+gen Action do source "c_dependencies" end
+
+file "test" => sys["*.c"].sub_ext("o") do |t|
+  sys "gcc -o #{t.name} #{t.prerequisites}"
+end
+
+source "custom.rf" if File.exist? "custom.rf"

data/doc/examples/c_cpp/root.rant

@@ -0,0 +1,46 @@
+
+import "md5"
+import "autoclean", "package/tgz", "c/dependencies"
+
+cpp_dirs = sys["c++/problem_*"]
+c_dirs = sys["c/problem_*"]
+all_dirs = cpp_dirs + c_dirs
+
+cpp_rf_template = "c++/template.rf"
+c_rf_template = "c/template.rf"
+
+desc "Run all C and C++ tests."
+task :run => all_dirs.map{ |f| "#{f}/run" }
+desc "Build all."
+task :build => all_dirs.map{ |f| "#{f}/test" }
+
+desc "Remove all autogenerated files."
+gen AutoClean
+
+gen Rule, '.o' => '.cpp' do |t|
+  sys "g++ -c -o #{t.name} #{t.source}"
+end
+
+gen Rule, '.o' => '.c' do |t|
+  sys "gcc -c -o #{t.name} #{t.source}"
+end
+
+desc "Create source package."
+gen Package::Tgz, "pkg/c_cpp",
+    :files => sys["root.rant", "**/*.{c,cpp,h,rf}"]
+
+gen Action do
+    cpp_dirs.each { |dir|
+        make "#{dir}/sub.rant" => cpp_rf_template do |t|
+            sys.cp t.source, t.name
+        end
+    }
+    c_dirs.each { |dir|
+        make "#{dir}/sub.rant" => c_rf_template do |t|
+            sys.cp t.source, t.name
+        end
+    }
+    subdirs cpp_dirs, c_dirs
+end
+
+# vim:ft=ruby

data/doc/homepage/index.html

@@ -0,0 +1,115 @@
+<?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/>
+            </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>
+        </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>
+        </p>
+
+        <!-- BlueRobot was here. -->
+
+    </body>
+</html>