rant 0.4.8 → 0.5.0

data/NEWS

@@ -1,6 +1,37 @@
 
 = Rant NEWS
 
+== Rant 0.5.0
+
+Incompatible changes:
+* The undocumented filelist methods +no_file+, +no_suffix+ and
+  +no_prefix+ require <tt>import "filelist/more"</tt> now.
+
+Deprecated:
+* The undocumented <tt>var.is</tt> method. It won't be in release
+  0.5.4 and later.
+* To use a (numeric) range as variable constraint, you should
+  explicitely <tt>import "var/numbers"</tt> now. Also explicitely
+  <tt>import "var/strings"</tt> to use the <tt>:String</tt>
+  constraint and <tt>import "var/booleans"</tt> to use the
+  <tt>:Bool</tt> constraint. Read <em>Constraining variables</em> in
+  doc/advanced.rdoc[link:files/doc/advanced_rdoc.html].
+
+Fixes and minor improvements:
+* Fix a few warnings from ruby 1.8.0/1.8.1.
+* Prevent infinite rule recursion.
+* Documentation for common file system operations and path
+  manipulation methods. Read
+  doc/sys.rdoc[link:files/doc/sys_rdoc.html]. 
+
+New features:
+* The <tt>--dry-run</tt> (<tt>-n</tt>) option for +rant+. Read
+  doc/rant.rdoc[link:files/doc/rant_rdoc.html]. 
+* +Action+ takes a regular expression now. When rant looks for a
+  task/file that matches the regular expression, the action block will
+  get executed once.  Read <em>More selective actions</em> in
+  doc/advanced.rdoc[link:files/doc/advanced_rdoc.html]. 
+
 == Rant 0.4.8
 
 Incompatible changes:

data/README

@@ -42,7 +42,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.8 of Rant. Most things
+This document was written for version 0.5.0 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.
@@ -90,6 +90,8 @@ 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]
+Common file system operations::
+    read doc/sys.rdoc[link:files/doc/sys_rdoc.html]
 Upgrading::
     read the NEWS[link:files/NEWS.html] for new features, not
     backwards compatible changes and other issues.

data/Rantfile

@@ -35,6 +35,10 @@ gen RubyPackage, "rant#{var :pkg_ext}" do |t|
     t.package_task
 end
 
+task "dist-files" do
+    puts dist_files
+end
+
 desc "Generate documentation."
 gen RubyDoc do |g|
     g.verbose = true
@@ -140,7 +144,7 @@ task :t180 do |t|
     # my installed testrb version doesn't work with ruby-1.8.0
     sys.cd "test"
     if var[:TEST]
-        sys "ruby180", "-rtest/unit", "-I", sys.expand_path("@lib"),
+        sys "ruby180", "-w", "-rtest/unit", "-I", sys.expand_path("@lib"),
             "-I", sys.expand_path("."), var[:TEST].sub(/^test\//, '')
     else
         sys "ruby180 ts_all.rb"
@@ -213,11 +217,58 @@ task "fetch-svn-dump" do
     require 'uri'
     url = URI.parse("http://svn.berlios.de/svndumps/rant-repos.gz")
     req = Net::HTTP::Get.new(url.path)
+    ds = Time.now.strftime("%Y-%m-%d")
     puts "Starting download from: #{url}"
     res = Net::HTTP.start(url.host, url.port) { |http|
         http.request(req)
     }
-    sys.write_to_file "../rant-repos.gz", res.body
+    sys.write_to_file "../rant-repos_#{ds}.gz", res.body
+end
+
+task "rb-stats" do
+    files = sys["lib/**/*.rb"]
+    lines = 0
+    code_lines = 0
+    files.each { |fn|
+        l, c =  count_rb_lines(fn)
+        lines += l
+        code_lines += c
+    }
+    puts "Number of Ruby files under lib/: #{files.size}"
+    puts "  #{lines} total lines"
+    puts "  #{code_lines} LOC"
+
+    files.exclude(%r{^lib/rant/archive})
+
+    lines = 0
+    code_lines = 0
+    files.each { |fn|
+        l, c =  count_rb_lines(fn)
+        lines += l
+        code_lines += c
+    }
+    puts "  without lib/rant/archive/: #{files.size}"
+    puts "    #{lines} total lines"
+    puts "    #{code_lines} LOC"
+end
+
+def count_rb_lines(fn)
+    lines = 0
+    code_lines = 0
+    in_multiline_comment = false
+    File.readlines(fn).each { |line|
+        lines += 1
+        case line
+        when /=end(\s|$)/:
+            in_multiline_comment = false
+            next
+        when /^\s*$/, /^\s*#/: next
+        when /^=begin(\s|$)/
+            in_multiline_comment = true
+        end
+        code_lines += 1 unless in_multiline_comment
+    }
+    [lines, code_lines]
 end
 
 # vim:ft=ruby

data/doc/advanced.rdoc

@@ -47,7 +47,7 @@ any directory/file named "CVS" or ending in ~. Examples would be:
     xy~
     src/util.c~
 
-=== More on selecting files with the glob operator
+=== Selecting files with filelists
 
 The sys[] operator actually returns a _filelist_ object, which behaves
 similar to an array. There are many methods for filelist objects, here
@@ -195,6 +195,7 @@ tasks and adds them as prerequisites to the final file task.
 Rant allows you to constrain variables which are managed by the +var+
 command (and thus can be set from the commandline):
 
+    import "var/numbers"
     var :count, 0..10
 
 This initializes the variable +count+ to 0 and restricts it to the
@@ -221,9 +222,11 @@ And now try to set the count variable from the commandline:
 
 Other available constraints:
 
+    import "var/strings"
     # variable str is ensured to be a string
     var :str, :String
 
+    import "var/booleans"
     # variable b is a bool (always true or false)
     # can be set to "yes", "no", "1", "0", "true", "false"
     var :b, :Bool
@@ -284,6 +287,88 @@ it plain in the Rantfile.
 An Action block also won't be run when our Rantfile is read by
 rant-import.
 
+=== More selective actions
+
+If a regular expression is given as argument to the Action generator,
+the block will be executed the first time Rant searches for a task
+matching this regular expression.
+
+An artifical example:
+
+    import "sys/more"
+
+    gen Action, /\.t$/ do
+        puts "executing action for files/tasks ending in `.t'"
+        source "t.rant"
+    end
+
+    file "t.rant" do |t|
+        sys.write_to_file t.name, <<-EOF
+            task "a.t" do
+                puts "making a.t"
+            end
+            task "b.t" do
+                puts "making b.t"
+            end
+        EOF
+    end
+
+    task :a do
+        puts "making a"
+    end
+
+    task :default => ["a", "a.t", "b.t"]
+
+Running rant:
+
+    % rant
+    making a
+    executing action for files/tasks ending in `.t'
+    writing 128 bytes to file `t.rant'
+    making a.t
+    making b.t
+
+rant performed the following steps:
+
+1. Invoke task +default+
+
+2. Invoke first prerequisite of +default+, which happens to be +a+.
+
+3. Execute action block of task +a+.
+
+   Output: "making a"
+
+4. Search for a task for the second prerequisite of +default+, which
+   happens to be <tt>a.t</tt>.
+
+5. Since no task with the name <tt>a.t</tt> exists, it checks for a
+   matching action/rule. The only defined action matches, so the
+   action block is executed.
+
+   Output: "executing action for files/tasks ending in `.t'"
+
+6. The action block contains a +source+ statement, which will first
+   cause a build of <tt>t.rant</tt>.
+
+   Output: "writing 128 bytes to file `t.rant'"
+
+   After the build, <tt>t.rant</tt> will be read as Rantfile.
+
+7. The action block is done, the action is "deleted".
+
+8. Now, Rant finds a task with the name <tt>a.t</tt>, invokes it and
+   executes the associated ruby block.
+
+   Output: "making a.t"
+
+9. Invoke last prerequisite of +default+, which happens to be
+   <tt>b.t</tt> and execute the associated ruby block.
+
+   Output: "making b.t"
+
+Generally, an action is usable to autogenerate a (bigger) set of tasks
+that are needed by a subset of other tasks.
+
 == See also
 
 Rantfile basics::

data/doc/c.rdoc

@@ -50,6 +50,14 @@ And a good habit would be to wrap the +source+ expression in an
     # invoked.
     gen Action do source "c_dependencies" end
 
+or more selective:
+
+    gen C::Dependencies
+
+    # Do dependency checking when Rant looks at the first file
+    # ending in ".h" or ".c"
+    gen Action, /\.(h|c)$/ do source "c_dependencies" end
+
 For a little example project using the C::Dependency generator look
 into the doc/examples/c_dependencies[link:../examples/c_dependencies]
 directory of the Rant distribution.

data/doc/homepage/index.html

@@ -90,6 +90,8 @@
                 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>
 

data/doc/rant.1

@@ -115,6 +115,10 @@ target.
 .TP
   --force-run TARGET               -a TARGET
       Force rebuild of TARGET and all dependencies.
+.TP
+  --dry-run                        -n
+      Print the names of the tasks that would be executed instead
+      of actually executing task actions.
 .TP
   --tasks                          -T
       Show a list of all described tasks and exit.

data/doc/rant.rdoc

@@ -40,6 +40,44 @@ steps (roughly):
    invoked. If the "default" task doesn't exist, the first task will
    be invoked.
 
+=== Dry-Run
+
+If you run rant in dry-run mode, it will print the actions it would
+execute instead of actually executing them. This can be useful in
+debugging your Rantfiles. To enable it, give the <tt>--dry-run</tt>,
+option or its short form, <tt>-n</tt>, on the commandline.
+
+Example Rantfile:
+
+    import "command"
+
+    task :install => "foo" do
+      sys.install "foo", "/usr/local/bin", :mode => 0755
+    end
+
+    gen Command, "foo", "foo.c", "cc -o $(>) $(<)"
+
+Running rant in dry-run mode:
+
+    % rant -n
+    Executing "foo"
+    - SHELL
+      cc -o foo foo.c
+    Executing "install"
+    - Ruby Proc at Rantfile:3
+
+Running rant in "normal" mode:
+
+    % rant
+    cc -o foo foo.c
+    install -c -m 0755 foo /usr/local/bin
+
+Running rant in dry-run mode again:
+
+    % rant -n
+    Executing "install"
+    - Ruby Proc at Rantfile:3
+
 == See also
 
 Rant Overview::

data/doc/rant_vs_rake.rdoc

@@ -83,6 +83,19 @@ Rake:
   3. The command (most probably +CFLAGS+) changed since the last build
      of +foo+.
 
+* Dependency checking for C/C++ source files
+
+    import "c/dependencies"
+
+    # save dependencies between source/header files in the file
+    # "cdeps"; search for include files in "." and "include" dirs
+    gen C::Dependencies, "cdeps"
+        :search => [".", "include"]
+
+
+    # load dependency information when Rant looks at a C file
+    gen Action, /\.(c|h)/ do source "cdeps" end
+
 Some other goodies: The +make+ method, the SubFile and AutoClean
 tasks, special variables and more. Most of this is documented in
 doc/advanced.rdoc[link:files/doc/advanced_rdoc.html]