ratch 0.3.0 → 0.4.0

data/doc/rdoc/rdoc-style.css

@@ -1,208 +0,0 @@
-
-body {
-    font-family: Verdana,Arial,Helvetica,sans-serif;
-    font-size:   90%;
-    margin: 0;
-    margin-left: 40px;
-    padding: 0;
-    background: white;
-}
-
-h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
-h1 { font-size: 150%; }
-h2,h3,h4 { margin-top: 1em; }
-
-a { background: #eef; color: #039; text-decoration: none; }
-a:hover { background: #039; color: #eef; }
-
-/* Override the base stylesheet's Anchor inside a table cell */
-td > a {
-  background: transparent;
-  color: #039;
-  text-decoration: none;
-}
-
-/* and inside a section title */
-.section-title > a {
-  background: transparent;
-  color: #eee;
-  text-decoration: none;
-}
-
-/* === Structural elements =================================== */
-
-div#index {
-    margin: 0;
-    margin-left: -40px;
-    padding: 0;
-    font-size: 90%;
-}
-
-
-div#index a {
-    margin-left: 0.7em;
-}
-
-div#index .section-bar {
-   margin-left: 0px;
-   padding-left: 0.7em;
-   background: #ccc;
-   font-size: small;
-}
-
-
-div#classHeader, div#fileHeader {
-    width: auto;
-    color: white;
-    padding: 0.5em 1.5em 0.5em 1.5em;
-    margin: 0;
-    margin-left: -40px;
-    border-bottom: 3px solid #006;
-}
-
-div#classHeader a, div#fileHeader a {
-    background: inherit;
-    color: white;
-}
-
-div#classHeader td, div#fileHeader td {
-    background: inherit;
-    color: white;
-}
-
-
-div#fileHeader {
-    background: #057;
-}
-
-div#classHeader {
-    background: #048;
-}
-
-
-.class-name-in-header {
-  font-size:  180%;
-  font-weight: bold;
-}
-
-
-div#bodyContent {
-    padding: 0 1.5em 0 1.5em;
-}
-
-div#description {
-    padding: 0.5em 1.5em;
-    background: #efefef;
-    border: 1px dotted #999;
-}
-
-div#description h1,h2,h3,h4,h5,h6 {
-    color: #125;;
-    background: transparent;
-}
-
-div#validator-badges {
-    text-align: center;
-}
-div#validator-badges img { border: 0; }
-
-div#copyright {
-    color: #333;
-    background: #efefef;
-    font: 0.75em sans-serif;
-    margin-top: 5em;
-    margin-bottom: 0;
-    padding: 0.5em 2em;
-}
-
-
-/* === Classes =================================== */
-
-table.header-table {
-    color: white;
-    font-size: small;
-}
-
-.type-note {
-    font-size: small;
-    color: #DEDEDE;
-}
-
-.xxsection-bar {
-    background: #eee;
-    color: #333;
-    padding: 3px;
-}
-
-.section-bar {
-   color: #333;
-   border-bottom: 1px solid #999;
-    margin-left: -20px;
-}
-
-
-.section-title {
-    background: #79a;
-    color: #eee;
-    padding: 3px;
-    margin-top: 2em;
-    margin-left: -30px;
-    border: 1px solid #999;
-}
-
-.top-aligned-row {  vertical-align: top }
-.bottom-aligned-row { vertical-align: bottom }
-
-/* --- Context section classes ----------------------- */
-
-.context-row { }
-.context-item-name { font-family: monospace; font-weight: bold; color: black; }
-.context-item-value { font-size: small; color: #448; }
-.context-item-desc { color: #333; padding-left: 2em; }
-
-/* --- Method classes -------------------------- */
-.method-detail {
-    background: #efefef;
-    padding: 0;
-    margin-top: 0.5em;
-    margin-bottom: 1em;
-    border: 1px dotted #ccc;
-}
-.method-heading {
-  color: black;
-  background: #ccc;
-  border-bottom: 1px solid #666;
-  padding: 0.2em 0.5em 0 0.5em;
-}
-.method-signature { color: black; background: inherit; }
-.method-name { font-weight: bold; }
-.method-args { font-style: italic; }
-.method-description { padding: 0 0.5em 0 0.5em; }
-
-/* --- Source code sections -------------------- */
-
-a.source-toggle { font-size: 90%; }
-div.method-source-code {
-    background: #262626;
-    color: #ffdead;
-    margin: 1em;
-    padding: 0.5em;
-    border: 1px dashed #999;
-    overflow: hidden;
-}
-
-div.method-source-code pre { color: #ffdead; overflow: hidden; }
-
-/* --- Ruby keyword styles --------------------- */
-
-.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
-
-.ruby-constant  { color: #7fffd4; background: transparent; }
-.ruby-keyword { color: #00ffff; background: transparent; }
-.ruby-ivar    { color: #eedd82; background: transparent; }
-.ruby-operator  { color: #00ffee; background: transparent; }
-.ruby-identifier { color: #ffdead; background: transparent; }
-.ruby-node    { color: #ffa07a; background: transparent; }
-.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
-.ruby-regexp  { color: #ffa07a; background: transparent; }
-.ruby-value   { color: #7fffd4; background: transparent; }

data/doc/scrap/scrap.red

@@ -1,256 +0,0 @@
-h1. UNDER CONSTRUCTION
-
-h1. Interoperability
-
-h2. Ratch a la Rake
-
-Rake is the the popular choice for Ruby delvelopers. Since Ratch is alsow written Ruby it is possible
-to use Ratch tasks via one;s Rakefile. This can be approached in either of two ways.
-
-Since Ratch' project tools are designed as stand-alone reusable modules, one can
-access them directly. For instance let's define an RDoc task by calling directly on
-Ratcehts' <code>Doc.rdoc</code> module method.
-
-    <pre class="script">
-      require 'ratchets/doc'
-
-      desc 'rdoc the project'
-
-      task :rdoc do
-        Ratchets::Doc.rdoc do |r|
-          r.title    = "MyApplication"
-          r.main     = "README"
-          r.template = "html"
-          r.options  = ["--all", "--inline-source"]
-          r.include  = ["lib/**/*", "bin/*", "[A-Z]*"]
-          r.basedir  = "src"
-          r.output   = "rdoc"
-        end
-      end
-    </pre>
-
-This usage leaves everything up to the the Rake file. Although most of these fields have reasonable
-defaults. Nonetheless, no information is being provided to the tool via a project information file,
-becuase we are invoking Ratchet's underlying rdoc tool directly.
-
-Now let's do the same thing, but via the Project class.
-
-    <pre>
-      require 'ratchets/project'
-
-      project = Project.new do |info|
-        info.title   = "MyApplication"
-        info.basedir = "src"
-      end
-
-
-      desc 'rdoc the project'
-
-      task :rdoc do
-        project.rdoc do |r|
-          r.main     = "README"
-          r.template = "html"
-          r.options  = ["--all", "--inline-source"]
-          r.include  = ["lib/**/*", "bin/*", "[A-Z]*"]
-          r.output   = "rdoc"
-        end
-      end
-    </pre>
-
-Here we have created a new Project object and have invoked the rdoc tool <i>via</i> it's interface.
-This automatically incorporates general information about the project of use to the tool --in this case
-the project's title and it's basedir. The other fields are rdoc specific so they cannot be shared.
-But we can go a step further and define a set of <i>tool specific defaults</i> for any rdoc task.
-
-    <pre>
-      require 'ratchets/project'
-
-      project = Project.new(
-        :title   => "MyApplication"
-        :basedir => "src"
-        :rdoc    => {
-          :main     => 'README'
-          :template => "html"
-          :options  => ["--all", "--inline-source"]
-          :include  => ["lib/**/*", "bin/*", "[A-Z]*"]
-          :output   => "rdoc"
-        }
-      )
-
-      desc 'rdoc the project'
-
-      task :rdoc do
-        project.rdoc
-      end
-    </pre>
-
-You'll also notice that we are demonstrating Ratchet's versitility in accepting arguments.
-The <code>Project.new</code> method can take either a hash <u>or</u> a block. In fact, this is
-a widely used pattern throughout Ratchets.
-
-One final step. It's is likely we don't need to fuss with each and every tool Ratchets
-provides us. All-in-all we will probably want most, if not all, of them avaialble to us, and
-since Ratcehts generally provides reasonable defaults for most fields, we will rarely have
-to explicitly fill out each one. In fact, every field we gave thus far for rdoc, except
-title and basedir, are the default settings. So to facilitate this, the project class has an
-<code>autonew</code> method which automatically generates all the tasks for every project tool
-Ratchets offers.
-
-    <pre>
-      require 'ratchets/project'
-
-      project = Project.autonew(
-        :title   => "MyApplication"
-        :basedir => "src"
-      )
-    </pre>
-
-Now when you invoke <code>Rake -T</code> you will see a good sized list of available tasks.
-
-The techinque as discussed thus far is quite usable, and those heavily favoring pure Rake usage
-may wish to venture no further than right here. But there are is one final variation that has
-it's own benefits. Rather then store the project information as Ruby code within one's Rakefile,
-the information can be placed in a separate <i>ProjectInfo</i> file (something you are already
-familiar with if you read about Project Generation). To utilize this file, instead of using the
-<code>new</code> or <code>autonew</code> methods you instead use the <code>load</code> and
-<code>autoload</code> methods. The upshot is that your typical Rakefile may have little more
-than these two-lines:
-
-    <pre>
-      require 'ratchets/project'
-      Project.autoload
-    </pre>
-
-
-
-
-
-
-
-<!--Adding code to a rakefile or a sake-style script is fine for one-off tasks. But what if you
-need a more versitle and reusable tool --one you can add to your projectinfo file like Ratchets
-built-in tools? In that case you need to build a <i>custom tool</i>.
-
-If you have custom tools you'd like to use for all your projects you can place them
-either in you home directory under ~/.share/ratchets/tools/, or you could make them
-universally available to all users in the shared data directory, on Debian,
-/usr/share/ratchets/tools/. If, on the other hand, the tool is specific to a project,
-place it in a project tools/ folder.-->
-
-
-
-
-
-<!--h2. Task Versitility
-
-Ratchets is a very versitile application. Ratchets supports a number of techniques
-for utilizing it's built-in tools and defining new tasks. Depedending on the desired usage,
-Ratchets can be a build tool <i>library</i>, or taking advantage of it's own system, can
-be used as a build tool in its own right.
-
-One easily adopted usage of Ratchets is as a build library invoked from Rake.
-Rake is the prevalent build tool for Ruby, and an excellent one at that. Ratchets
-tools can be easily called from any application, so calling them from a Rake task
-is a natural endeavor. Ratchets goes a step further in its support of Rake however
-by allowing the built-in tools to be setup as Rake tasks automatically.
-If this is intended usage jump down to <a href="#ch4">Ratchets a la Rake</a>
-to learn more.
-
-On the other hand, forgoing a separate build tool, tasks can instead be defined
-as YAML descriptors and invoked via thae <code>project</code> command-line utility.
-This makes tasks extremely easy to read and write, and allows project information
-and task definitions to be jointly located but still universally accessible as
-pure data. We will cover this usage in <a href="#ch2">Describing Tasks
-via YAML</a>.
-
-The other alternative, which we will discuss last, is for tasks to be defined as
-stand-alone executables. This approach is in the spirit of Unix --it's favor of many
-small tools over single monolithic applications. Ratchets provides strong support
-for this mode of operation, which we have dubbed the <a href="#ch3">Sake Technique</a>.
-[ed- In fact, it is my prefered usage.]
-
-In any case, no matter which technique is used. The centralized data resource
-for project information is readily available. This <i>reapability</i> of
-information, probably more than any other feature, makes Ratchets so effective.-->
-
- <!--
-
-  <p>The conversion is almost seemless. The task class needs only conform to some simple conventions (in this case
-  for example you can see the package_file.include needs to be reduced to a single 'include' attribnute) which are farily
-  trivial to implement. This format has been a big hit with Reap's users. Of course it's optional, one can still do
-  everything through the Reapfile (but why?).</p>
-
-
-  <h2>Sake may have some nice built-in tasks, but we use Rake. So what good is it?</h2>
-
-  <p>Sake's unix style of many small scripts is fairly orthongonal to Rake's,
-  So you can still call upon Sake's built-in scripts in your Rakefile, if you so prefer.
-  Check it out:</p>
-
-    <pre>
-      require 'sake/project'
-
-      desc "Generate RDocs"
-
-      task :rdoc do
-        Automation.rdoc do |s|
-          s.template = 'jamis'
-          s.include = 'lib/**/*'
-        end
-      end
-    </pre>
-
-  <p>Of course, you don't have to use Reap's task system. You can still use Rake's for all your project tasks if
-  you prefer or for some reason must, and you can still get Reap's task functionality. Reap provides a simple interface
-  for doing this. Here's an example of a Rakefile using Reap.</p>
-
-    <pre>
-      require 'reap/reap'
-
-      task_package 'pack' do |pkg|
-        pkg.distribute = [ 'gem' ]
-        pkg.dependencies = [ facets ]
-      end
-    </pre>
-
-  <p>In the above, all information is provided directly via the Ruby task code. No information is coming from the
-  projectinfo file (same is tru for a Reapfile). But you can also use Rake while utilizing the projectinfo file if
-  you wish. In your Rakefile simple put:</p>
-
-    <pre>
-      require 'reap/rake'
-    </pre>
-
-  <p>Then all the tasks defined in the projectinfo file will be available via Rake. You can still add additional
-  Rake tasks, of course.</p>
-
-  <p>Reap can be used in the same fashion as Rake. Simply create a Reapfile and use the <code>reap</code>
-  command to utilize your tasks.</p>
-
-  <p>Adding a extra Reap task is pretty easy. Just define a task in a the special <i>meta/reapfile</i>.
-  If you have ever created a task in Rake's 'Rakefile' then you know how to do it here too. A simple
-  task would look like this:</p>
-
-    <pre>
-      desc "My special task"
-      task :hello do
-        puts "Hello, World!"
-      end
-    </pre>
-
-  <p>You may not like keeping a "monolithic" file of tasks and instead prefer to keep a collection of
-  individual task scripts. You can do this by placing your script in the <i>meta/tasks</i> folder and
-  encapsulating your task defintion in the Tasks module.</p>
-
-    <pre>
-      module Tasks
-
-        desc "My special task"
-        task :hello do
-          puts "Hello, World!"
-        end
-
-      end
-    </pre>
-
-  -->

data/doc/sitemap.yaml

@@ -1,10 +0,0 @@
----
-
-index.html:
-  main: siteparts/layout.rhtml
-  content: siteparts/index.red
-
-tutorial.html:
-  main: siteparts/layout.rhtml
-  content: siteparts/tutorial.red
-

data/doc/siteparts/index.red

@@ -1,100 +0,0 @@
-h1(top). Welcome
-
-Ratch is a Ruby-based build tool in the linage of Rake and Reap, but distinguishes
-itself in it's closer adherence to the UNIX-way in that Ratch "targets" are independent
-scripts. In fact, the name "ratch" derives from the phrase
-"<u>R</u>uby b<u>atch</u> file".
-
-Ratch is part of the ProUtils collection. In particular Ratch scripts might take
-advantage of the "Box":http://proutils.rubyforge.org/box system and can easily be
-copied and updated via "Mint":http://proutils.rubyforge.org/mint.
-
-h1. News
-
-h3(date). 2007-11-11
-
-h2. From Special to Main
-
-Ratch is really starting to come together. And I dare say that's no small statement.
-I started development many, many months ago with only a hunch that the basic
-design would be effective --was it even  possible to effectively bridge the gap
-between the shell and script? We may never have found out. Implementation has been
-challenge at times and more than once a little voice in the back of my head would
-say "just use Rake". But if I am anything, it is determined. I really believe
-in the underlying design of this project --as hard as it might have been get "right".
-
-But "right" is where I may finally be. Granted I'm still worried about tricky
-dependency loops, but that's a rare bird and I have yet to see it happen in practice.
-And, sure there's areas of the code that could just use some general spit-and-shine.
-But in practice, it's really starting to look good.
-
-For instance, this evening I transitioned from executing all ratch files in an
-instance of a special runner class (a subclass of Module), to executing
-in top-level 'main' space. This simplifies the start up code a fair bit and now allows
-@load()@ to  work for ratch files just as it does for ruby files --where as before
-I had to create a special #import method to load the ratch file into the special object.
-The benefit of this change is that one no longer _has_ to copy any of the pre-made tools
-distributed with ratch. Instead one can just depend on them like normal code.
-For instance, my projects tool/stats file looks like this:
-
-<pre>
-  #!/usr/bin/env ratch
-  # code stats
-  load('ratch/toolset/ruby/stats')
-</pre>
-
-Of course if you want to make project specific modifications you can still grab a copy
-and have at it.
-
-
-h1. Installation
-
-Via RubyGems:
-
-  $ gem install ratch
-
-With the source code:
-
-  $ tar -xzf ratch-x.y.z.tar.gz
-  $ cd ratch-x.y.z
-  $ sudo task/setup
-
-Microsoft Windows users, you'll have to use '@ruby task/setup@' instead.
-
-
-h1. Development
-
-Ratch is part of the "ProUtils":http://protuils.rubyforge.org project.
-
-h2. Anonymous Subversion Access
-
-This project's SVN repository can be checked out through anonymous access with the following command(s).
-
-  svn checkout svn://rubyforge.org/var/svn/proutils/ratch
-  svn checkout http://proutils.rubyforge.org/svn/ratch
-
-h2. Developer Subversion Access via SSH
-
-Only project developers can access the SVN tree via this method. SSH must be installed on your client machine. Substitute developername with the proper values. Enter your site password when prompted.
-
-  svn checkout svn+ssh://developername@rubyforge.org/var/svn/proutils/ratch
-
-
-h1. Copying
-
-Ratch -- Ruby-based Batch Files
-
-Copyright &copy; 2007 &Psi; &Tau; Corporation
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/doc/siteparts/layout.rhtml

@@ -1,56 +0,0 @@
-<html>
-<head>
-  <title>Ratch</title>
-  <link href="style.css" rel="stylesheet" type="text/css"/>
-    <LINK REL="SHORTCUT ICON" HREF="images/ratch1.png"/>
-</head>
-<body>
-
-<div class="promenu">
-  ProUtils :: <a href="http://proutils.rubyforge.org/">Home</a> &middot;
-  <a href="http://rubyforge.org/news/?group_id=4438">News</a> &middot;
-  <a href="http://rubyforge.org/frs/?group_id=4438">Download</a> &middot;
-  <a href="http://rubyforge.org/mail/?group_id=4438">Mail</a> &middot;
-  <a href="http://rubyforge.org/forum/?group_id=4438">Forum</a> &middot;
-  <a href="http://rubyforge.org/scm/?group_id=4438">Source</a> &middot;
-  <a href="http://rubyforge.org/tracker/?group_id=4438">Ticket</a>
-</div>
-
-<div class="container">
-
-  <div class="banner">
-    RATCH &nbsp;<img src="images/ruby-sm.png"/>
-  </div>
-
-  <div class="menu">
-    <a href="index.html">Welcome</a>
-    <a href="tutorial.html">Tutorial</a>
-    <a href="rdoc/index.html">Library</a>
-  </div>
-
-  <div class="ad">
-    <script type="text/javascript"><!--
-    google_ad_client = "pub-1126154564663472";
-    //RATCH 728x90, 11/8/07
-    google_ad_slot = "6500283279";
-    google_ad_width = 728;
-    google_ad_height = 90;
-    //--></script>
-    <script type="text/javascript"
-    src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
-    </script>
-  </div>
-
-  <div class="content">
-    <%= part :content %>
-  </div>
-
-  <div class="copyright">
-    Ratch, Copyright &copy; 2007 <a href="http://psytower.info">&Psi; &Tau; Corp.</a> <br/><br/>
-    Website design by <a href="http://psytower.info/transcode/">TransCrankItOut</a> using <a href="">Webrite</a>!
-  </div>
-
-</div>
-
-</body>
-</html>