RubyGems - reap - Versions diffs - 03.01 → 4.0 - Mend

reap 03.01 → 4.0

Files changed (231) hide show

data/web/rdoc/files/ProjectInfo.html ADDED

@@ -0,0 +1,190 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: ProjectInfo</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>ProjectInfo</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>ProjectInfo
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sat Oct 08 19:11:46 EDT 2005</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+&#8212; %YAML:1.0
+</p>
+<p>
+TITLE : <a href="../classes/Reap.html">Reap</a> NAME : reap DATE :
+&#8216;2005-10-06&#8217; SERIES : &#8216;4.0&#8217; STATUS :
+&#8216;beta/stable&#8216;
+</p>
+<p>
+AUTHOR : Thomas Sawyer EMAIL : transfire@gmail.com HOMEPAGE : &quot;<a
+href="http://reap.rubyforge.org">reap.rubyforge.org</a>&quot; SUMMARY :
+Tools for Ruby project testing, management and assistance.
+</p>
+<p>
+DESCRIPTION: &gt;
+</p>
+<pre>
+  Reap comprises a set of commonly needed tools for Ruby package
+  developers/deployers. Because of the commonality,
+  Reap utilizes a YAML configuration file to harvest project
+  information, significantly simplifying usage.
+</pre>
+<p>
+DISTRIBUTE : [ gem, tar.bz2, zip ] # tar.gz, tbz, tgz DEPENDENCIES : [
+facets ] EXECUTABLES : [ reap ]
+</p>
+<p>
+RUBYFORGE:
+</p>
+<pre>
+  PROJECT: reap
+  USERNAME: transami
+</pre>
+<p>
+PUBLISH:
+</p>
+<pre>
+  type     : web
+  host     : rubyforge.org
+  username : transami
+  dir      : web
+</pre>
+<p>
+RDOC:
+</p>
+<pre>
+  dir: 'web/rdoc'
+  include:
+    - 'A-Z*'
+    - 'lib/**/*'
+  exclude:
+    - 'lib/reap/data'
+</pre>
+<p>
+ANNOUNCE:
+</p>
+<pre>
+  to       : transfire@gmail.com  # ruby-talk@ruby-lang.org
+  from     : *email
+  domain   : unit.rubyforge.org
+  server   : smtp.gmail.com
+  port     : 587
+  account  : *email # transfire@gmail.com
+  authtype : login  # cram_md5, plain
+  sectype  : tls    # ~, tls, ssl (not working yet)
+  file     : ANN    # which file contains announcement
+  slogan   : REAP THE REWARDS!
+  links    :
+    - http://reap.rubyforge.org
+    - http://roll.rubyforge.org
+</pre>
+<p>
+PERM:
+</p>
+<pre>
+  filemod: 644
+  dirmod: 755
+  user: trans
+  group: users
+</pre>
+<p>
+NOOP:
+</p>
+<pre>
+  MESSAGE: Hello Dude!
+</pre>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/{pub/www → web}/rdoc/files/README.html RENAMED

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Sat Sep 03 09:48:37 EDT 2005</td>
+      <td>Sat Oct 08 18:13:35 EDT 2005</td>
     </tr>
     </table>
   </div>
@@ -76,10 +76,9 @@ User Friendly Project Assitant for Ruby
 <h2>What&#8217;s This?</h2>
 <p>
 <a href="../classes/Reap.html">Reap</a> is a user friendly project
-assistant for Ruby developers built on top of Rake. By organizing your
-project in a semi-formal manner (the same as setup.rb), <a
-href="../classes/Reap.html">Reap</a> makes it easy to do the following
-tasks:
+assistant for Ruby developers. By organizing your project in a conventional
+manner, as promoted by setup.rb, <a href="../classes/Reap.html">Reap</a>
+makes it easy to do the following tasks:
 </p>
 <ul>
 <li>Generate RDocs.
@@ -87,6 +86,9 @@ tasks:
 </li>
 <li>Run unit tests.
+</li>
+<li>Extract tests for scripts.
 </li>
 <li>Create Ruby Gem packages.
@@ -109,7 +111,7 @@ tasks:
 </ul>
 <p>
 If you have special needs that <a href="../classes/Reap.html">Reap</a>
-doesn&#8217;t accomodate, new task are farily easy to create. And we are
+doesn&#8217;t accomodate, new task are farily easy to create. And I am
 always happy to hear suggestions.
 </p>
 <h2>Installation</h2>
@@ -121,7 +123,7 @@ Install the ruby gem as you would any other:
   &lt;tt&gt;gem install reap&lt;/tt&gt;
 </pre>
 <p>
-<a href="../classes/Reap.html">Reap</a> requires Nano Methods.
+<a href="../classes/Reap.html">Reap</a> requires Ruby Facets.
 </p>
 <h3>Manual Install</h3>
 <p>
@@ -137,7 +139,7 @@ To install manually follow the usual setup.eb steps:
 <li>Change into the unpacked directory.
 </li>
-<li>run <tt>./setup.rb</tt>
+<li>run <tt>sudo ruby setup.rb</tt>
 </li>
 </ol>
@@ -148,26 +150,27 @@ You should be good to go.
 <h3>Using a <a href="../classes/Reap.html">Reap</a> Task</h3>
 <p>
 <a href="../classes/Reap.html">Reap</a> makes it pretty easy to use
-it&#8217;s built-in tasks. Not only will it grab common data from a <a
-href="../classes/ProjectInfo.html">ProjectInfo</a> YAML file if available,
-but it defines convenience methods to make writing Rakefiles easier. For
-instance, to create a &quot;package&quot; target all you generally need in
-your Rakefile is:
+it&#8217;s built-in tasks. Largely this is because it grabs common data
+from a <a href="../classes/ProjectInfo.html">ProjectInfo</a> (or Reapfile)
+as available. Some <a href="../classes/Reap.html">Reap</a> tasks are
+automatic b/c there are reasonable defaults, others <em>require</em>
+entries in the <a href="../classes/ProjectInfo.html">ProjectInfo</a> file.
+</p>
+<p>
+For instance, to create a &quot;package&quot; target you generally do not
+need an entry in the <a href="../classes/ProjectInfo.html">ProjectInfo</a>
+file. <a href="../classes/Reap.html">Reap</a> will package up everything in
+the typical directories and makes compressed versions in the common
+formats. It will then place those in either ../leaf/ (for those or you
+using trunk/ branches/ layouts) or pkg/ otherwise. The same holds for other
+tasks. <a href="../classes/Reap.html">Reap</a> will do it&#8217;s best to
+extrapolate the needed information from the <a
+href="../classes/ProjectInfo.html">ProjectInfo</a> file.
 </p>
-<pre>
-  require 'reap/tasks'
-  include ReapTask
-  package_task :package
-</pre>
 <p>
-The reaon this can be so simple, is b/c <a
-href="../classes/Reap.html">Reap</a> extrapolates the information it needs
-from a comon <a href="../classes/ProjectInfo.html">ProjectInfo</a> file.
-You will of course need to create this file in you projects main directory.
-A template is provided and a command line tool to copy it to your current
-directory. Simply type:
+Of course no matter the level of content, you will of course need to create
+this file in you projects main directory. A template is provided and a
+command line tool to copy it to your current directory. Simply type:
 </p>
 <pre>
   &gt; reap template
@@ -175,7 +178,7 @@ directory. Simply type:
 <p>
 Then edit the <a href="../classes/ProjectInfo.html">ProjectInfo</a> file.
 The fields are fairly self explanitiory. Apart from <a
-href="../classes/Reap.html">Reap</a> such a file is nice to have on
+href="../classes/Reap.html">Reap</a> such a file is nice to have just on
 it&#8217;s own merits too.
 </p>
 <h3>Building a <a href="../classes/Reap.html">Reap</a> Task</h3>
@@ -191,22 +194,20 @@ that into account (usually that means using ++||=++)
 Here&#8217;s an, oh so simple, example:
 </p>
 <pre>
-  class MyOhSoSimpleTask &lt; Reap::Task
-     # This creates the convenience method
-     register 'my_oh_so_simple'
+  class OhSoSimple &lt; Reap::Task
-     default_desc 'this is a custom reap task'
+     task_desc 'This is a custom reap task'
      attr_accessor :message
      def init
        @message ||= master['default'] || 'None Found!'
+       @another ||= section['another'] || 'Again!'
      end
      # run the target task
      def run
-       puts @message
+       puts @message + &quot;\n&quot; + @another
      end
    end
@@ -218,12 +219,14 @@ be:
 </p>
 <pre>
    default: Default text, if any.
+   ohsosimple:
+     another: Your other message here.
 </pre>
 <p>
-And to use it in your Rake file:
+And to use it
 </p>
 <pre>
-  ReapTask::my_oh_so_simple_task :mytarget
+  &gt; reap ohsosimple
 </pre>
 <h2>Status</h2>
 <p>

data/web/rdoc/files/Rakefile.html ADDED

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: Rakefile</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>Rakefile</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>Rakefile
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sat Oct 08 00:18:04 EDT 2005</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/web/rdoc/files/lib/reap/bin/reap_rb.html ADDED

@@ -0,0 +1,129 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: reap.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>reap.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/reap/bin/reap.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sat Oct 08 18:59:23 EDT 2005</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="requires-list">
+      <h3 class="section-bar">Required files</h3>
+      <div class="name-list">
+      facets&nbsp;&nbsp;
+      rbconfig&nbsp;&nbsp;
+      carat/shellcommand&nbsp;&nbsp;
+      reap/tasks&nbsp;&nbsp;
+      </div>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">INFO_FILES</td>
+          <td>=</td>
+          <td class="context-item-value">[ 'ProjectInfo', 'Reapfile', 'projectinfo', 'reapfile' ]</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">HELP</td>
+          <td>=</td>
+          <td class="context-item-value">&lt;&lt;-HERE    reap v#{::Reap::Version}    USAGE: reap [options...] &lt;command&gt; [arguments...]    COMMANDS:      scaffold         Copies a ProjectInfo template into the current         directory, if it doesn't already exist. If it does         exist will build the project directory based on it.         This will not destroy any structure already in place!      help         Displays this help information.    OPTIONS:      -v --version         Display the current version.      -V --verbose         Provides extra verbose processing information.      -D --debug         Provides extra verbose processing information.      -h --help         Display this help information.  HERE</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>