RubyGems - reap - Versions diffs - 6.0.0 → 6.0.1 - Mend

reap 6.0.0 → 6.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (39) hide show

data/ProjectInfo +102 -0
data/data/reap/install.rb +62 -0
data/forge/ProjectInfo +38 -0
data/forge/ProjectInfo.rb +76 -0
data/forge/TODO +10 -0
data/forge/installer.rb +250 -0
data/forge/reference/Rakefile +124 -0
data/forge/reference/Rakefile.htm +69 -0
data/forge/reference/aRakefile +60 -0
data/forge/reference/compositepublisher.rb +24 -0
data/forge/reference/ftptools.rb +139 -0
data/forge/reference/installers/package.rb +629 -0
data/forge/reference/installers/setup.rb +1558 -0
data/forge/reference/license-each.rb +85 -0
data/forge/reference/publisher.rb +75 -0
data/forge/reference/rubyforge.rb +247 -0
data/forge/reference/rubyforgepublisher.rb +18 -0
data/forge/reference/sshpublisher.rb +47 -0
data/forge/reference/suby-cvs.rb +46 -0
data/forge/scaffold.rb +126 -0
data/forge/unit_runner/README +6 -0
data/forge/unit_runner/commentrunner.rb +62 -0
data/forge/unit_runner/cunit.rb +17 -0
data/forge/unit_runner/forkedrunner.rb +91 -0
data/forge/unit_runner/sample.rb +16 -0
data/lib/reap/class/extest.rb +2 -7
data/lib/reap/class/manifest.rb +7 -11
data/lib/reap/class/package.rb +120 -25
data/lib/reap/class/rdoc.rb +1 -9
data/lib/reap/class/test.rb +2 -7
data/lib/reap/tasks.rb +51 -58
data/note/LATEST +44 -0
data/note/doap.xml +28 -0
data/note/history/Rakefile-0.1 +308 -0
data/web/ProjectInfo.html +80 -0
data/web/images/grape.jpg +0 -0
data/web/index.html +312 -0
metadata +66 -27
data/lib/reap/class/installer.rb +0 -178

data/web/index.html ADDED Viewed

@@ -0,0 +1,312 @@
+<html>
+<head>
+  <title>Reap</title>
+  <style>
+    body { margin: 0; padding: 0; font-size: 10pt; font-size: 1em; }
+    p { font-family: sans-serif; text-align: justify;
+        font-size: 1em; line-height: 1.3em;
+      }
+    img { }
+    h2 { color: red; margin-top: 30px; }
+    td { margin: 0; padding: 0; vertical-align: top; }
+    b.p { color: white; }
+    b.b { color: black; }
+    b.r { color: red; }
+    pre { font-size: .9em; line-height: 1.2em;
+          margin: 0;
+          padding: 0; padding-bottom: 5px; padding-top: 15px;
+          background: #FFFBBF;
+        }
+    pre.white { background: white; }
+    span.m { font-family: monospace; }
+    div#title {
+      float: top;
+      background: black repeat-x;
+      border-bottom: 1px solid gray;
+    }
+    div#title table {}
+    td#meta { color: white; vertical-align: bottom;
+      font-size: 64pt; font-family: sans-serif; font-weight: bold; }
+    td#slogon {
+      width: 120px;
+      vertical-align: middle; text-align: left; font-family: monospace;
+      color: gray; font-size: 1.3em; padding-left: 10px; text-align: center;
+      white-space: nowrap;
+    }
+    div#menu { width: 100%; vertical-align: middle; padding-left: 30px;
+      font-family: sans-serif; font-size: .8em; line-height: 3em;
+      border-bottom: 1px solid black;
+      color: red; background: white; }
+    div#menu a { color: red; text-decoration: none; font-weight: bold; }
+    div#menu a:hover { color: pink; }
+    div#container { margin: 10px; padding: 10px; padding-top: 5px;
+      border: 0;
+    }
+    div#copy { font-size: 7pt; font-family: sans-serif; margin: 5px;
+      border-top: 1px solid #cccccc; color: gray;
+    }
+    div#eg { float: right; margin: 20px; margin-top: -110px;
+      padding: 0px; padding-top: 7px;
+      border: solid 1px lightgray;
+      text-align: center;
+      font-family: monospace; font-size: .8em;
+      color: green; background: #cccccc; }
+    iframe { width: 430px; height: 1000px; border: 0; border-left: solid 1px #DDDDDD;
+      margin: 0px; margin-top: 5px; padding-left: 5px;
+      background: #EEFFEE; }
+  </style>
+</head>
+<body>
+<div id="title">
+  <table width="100%" border="0" style="padding: 0;">
+  <tr>
+    <td id="slogon">
+      <b class="p">w h e n</b> <br/>
+      <b class="p">y o u r</b> <br/>
+      <b class="r">r u b y</b> <br/>
+      <b class="p">r u n s</b> <br/>
+      <b class="p">o v e r</b>&nbsp;
+    </td>
+    <td id="meta">
+      RE<b class="r">A</b>P
+    </td>
+  </tr>
+  <tr>
+  </tr>
+  </table>
+</div>
+<div id="menu" colspan="2">
+  <a href="http://rubyforge.org/frs/?group_id=811">Download</a> &middot;
+  <a href="doc/api/index.html">Documentation</a> &middot;
+  <a href="http://rubyforge.org/projects/reap/">Development</a>
+</div>
+<div id="eg">
+  <b>Example ProjectInfo File</b><br/>
+  <iframe src="ProjectInfo.html">Sorry, there are no iframes in your web world.</iframe>
+</div>
+<div id="container">
+  <p>Reap is a set of integrated tasks designed to simplify the life of
+  Ruby application developers and project managers. The tasks
+  cover the range of common nneds, from setting up a standard
+  project structure to distributing and announcments.
+  Because of the commonality between the tasks, Reap utilizes a
+  central YAML-format configuration file to harvest project
+  information, significantly simplifying usage.</p>
+  <p>Custom task can also be easily created to suit specific
+  project requirements. In this respect Reap is much like
+  Rake. In fact Reap can be used as a replacement for Rake.
+  On the other hand Reap tasks can also be used via Rake
+  just as if they were another set of avaiable Rake tasks.</p>
+  <h2> Usage </h2>
+  <p>To use Reap, you simply need to install it and add a ProjectInfo
+  to your projects main directory. By default, Reap supports the standard
+  project layout as promoted by setup.rb.</p>
+  <p>Once you ProjectInfo file is filled out you can see what tasks are ready to run
+  simply by typing 'reap' into the command line. For example you might see
+  something like:</p>
+  <pre>
+    ~/myproj$ reap
+      info           Display ProjectInfo file.
+      testext        Extract unit-tests from lib scripts.
+      test           Run unit-tests (each in a separate process).
+      rdoc           Generate API Documentation.
+      doap           Generate DOAP project file.
+      publish        Publish documents to the web.
+      perm           Normalize ownership and permissions of files.
+      package        Build distribution packages.
+      install        Locally install package using built-in setup.rb.
+      release        Release distribution files.
+      announce       Email project announcement.
+  </pre>
+  <p>To get started, it easiest to use a pre-existing ProjectInfo file and modifying
+  it to fit your project. Besides copying another project's ProjectInfo file
+  you can ask Reap for an empty one.</p>
+  <pre>
+    ~/myproj$ reap template
+  </pre>
+  <p>Each task section of the project information file can be used as a task name and
+  a YAML private type identifies the type of task it represents.
+  To find out what parameters each task accepts see Reap's RDoc API.</p>
+  <p>If you prefer using Rake for all your project tasks. Reap provides an
+  simple interface for doing so. Here's an example of a Rakefile.</p>
+  <pre>
+    require 'rake'
+    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.
+  You can also use Rake while utilizing the ProjectInfo file, if you prefer.
+  In that case it is very simple. In your Rake file simple put:</p>
+  <pre>
+    require 'rake'
+    require 'reap/rake'
+  </pre>
+  <p>Then all the tasks defined in the ProjectInfo file will be available via Rake.
+  You can add additional Rake tasks, of course.</p>
+  <h2> Creating Tasks </h2>
+  <p>Building a Reap task is pretty easy too. In fact if you ever used Rake
+  you already have a good idea about how to do it.</p>
+  <p>The first thing you need to know is where to put the tasks code.
+  With Reap each task typically has it's own file.
+  To create a custom task particular to a project add a task/ directory
+  to your project and place your custom task file in it.</p>
+  <!--
+  <p>If you have custom tasks you'd like to use for all your projects
+  you can place them either in you home  directory under ~/.config/reap/task/,
+  or you could make them universally available to all users in the
+  shared data directory, on Debian, /usr/share/reap/task/.</p>
+  -->
+  <p>Here's an "oh-so-simple" example:</p>
+  <pre>
+    module Tasks
+      def simple( name, data )
+        desc 'This is a custom reap task class.'
+        task name do
+          data.message ||= master.message
+          puts data.message + "\n\n" + data.signed
+        end
+      end
+    end
+  </pre>
+  <p>The corresponding settings in the ProjectInfo file will then be:</p>
+  <pre>
+     message: Hi, how are you?
+     simple: !!simple
+       signed: Your friend, Tom.
+  </pre>
+  <p>And to use it type:</p>
+  <pre>
+     % reap simple
+  </pre>
+  <p>Notice the reference to 'master'. This is an OpenCascade interface
+  (similar to OpenObject and OpenStruct) to the whole ProjectInfo dataset.</p>
+  <p>You might recognize the core methods of creating a task, 'desc' and 'task'.
+  These are used exactly as they are in Rake. We encapsulate them in a
+  task-definition method (eg. simple) so the task can be generated dyanmically
+  if such a section (!!simple) appears in the ProjectInfo file. Such
+  task-definition methods are recognized by reap b/c they are stored in the
+  special purpose Tasks module.</p>
+  <p>It's a good idea to take some time and learn all the standard
+  properties of a project's information file which you can draw on for
+  your own tasks. Looking at the RDoc API documentation will elucidate most these.
+  </p>
+  <p>The rest of building a task is a matter or writing the code to have it do
+  what you want it to, of course. If you develop any nice tasks, be sure to pass
+  them along!
+  </p>
+  <h2> Status </h2>
+  <p>Reap works fairly well at this point, although not all intended functionality is complete.
+  The primary tasks, like packaging, testing and rdocing are the most well developed.
+  Other tasks have some limitations. For instance, the publish task
+  is limited to uploading to RubyForge at the moment. And the announcment task can't
+  route email via TLS servers. But Reap is very usable and is used in a number of
+  projects including Facets and Nitro. Moreover, if you use it, contributions
+  to it's improvement are very welcome and will be sung many wonderous praises &nbsp;<span class="m">;)</span>
+  </p>
+  <p>IMPORTANT!!! Microsoft Windows support is weak at the moment. No doubt a few of
+  the built-in tasks will fail under Windoes. But fixing this issues is a high priority
+  for upcoming releases. So staty tuned --or heck, help out!</p>
+  <h2> Future </h2>
+  <p>The future of Reap looks very bright. Some of the plans for the future
+  include:</p>
+  <p>
+   1. Code audit to catch any overlooked bugs and potential gotchas.<br/>
+   2. Full Windows compatability, replacing most of the shell calls.<br/>
+   3. Switching from setup.rb to an improved package.rb install system.<br/>
+   4. SCM related tasks, starting with Darcs and later Subversion.<br/>
+  </p>
+  <h2> License </h2>
+  <p>Reap Copyright (c) 2004-2006 Thomas Sawyer, Ruby License</p>
+  <p>THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+    IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+    PURPOSE.
+  </p>
+  <br/><br/>
+</div>
+<div id="copy">Copyright (c) 2006 Thomas Sawyer, All Rights Reserved.</div>
+</body>
+</html>

metadata CHANGED Viewed

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: reap
 version: !ruby/object:Gem::Version
-  version: 6.0.0
-date: 2006-06-05 00:00:00 -04:00
+  version: 6.0.1
+date: 2006-06-06 00:00:00 -04:00
 summary: The Flexible Ruby Project Management Assistant
 require_paths:
 - lib
@@ -28,36 +28,27 @@ cert_chain:
 authors:
 - Thomas Sawyer
 files:
-- lib
-- data
 - bin
+- note
+- data
+- forge
+- lib
+- web
+- sample
 - COPYING
+- ProjectInfo
 - README
 - setup.rb
-- sample
-- lib/reap
-- lib/reap/projectinfo.rb
-- lib/reap/rake.rb
-- lib/reap/bin
-- lib/reap/reap.rb
-- lib/reap/class
-- lib/reap/taskutils.rb
-- lib/reap/tasks.rb
-- lib/reap/bin/reap.rb
-- lib/reap/bin/rubytest.rb
-- lib/reap/class/rdoc.rb
-- lib/reap/class/doap.rb
-- lib/reap/class/installer.rb
-- lib/reap/class/test.rb
-- lib/reap/class/announce.rb
-- lib/reap/class/extest.rb
-- lib/reap/class/manifest.rb
-- lib/reap/class/publish.rb
-- lib/reap/class/package.rb
-- lib/reap/class/filer.rb
+- bin/rubytest
+- bin/reap
+- note/history
+- note/doap.xml
+- note/LATEST
+- note/history/Rakefile-0.1
 - data/reap
 - data/reap/scaffold
 - data/reap/setup.rb
+- data/reap/install.rb
 - data/reap/scaffold/subversion
 - data/reap/scaffold/standard
 - data/reap/scaffold/subversion/branches
@@ -94,8 +85,56 @@ files:
 - data/reap/scaffold/standard/test
 - data/reap/scaffold/standard/doc/note
 - data/reap/scaffold/standard/doc/api
-- bin/rubytest
-- bin/reap
+- forge/installer.rb
+- forge/TODO
+- forge/ProjectInfo.rb
+- forge/scaffold.rb
+- forge/unit_runner
+- forge/ProjectInfo
+- forge/reference
+- forge/unit_runner/sample.rb
+- forge/unit_runner/README
+- forge/unit_runner/cunit.rb
+- forge/unit_runner/commentrunner.rb
+- forge/unit_runner/forkedrunner.rb
+- forge/reference/rubyforgepublisher.rb
+- forge/reference/sshpublisher.rb
+- forge/reference/compositepublisher.rb
+- forge/reference/rubyforge.rb
+- forge/reference/ftptools.rb
+- forge/reference/license-each.rb
+- forge/reference/suby-cvs.rb
+- forge/reference/publisher.rb
+- forge/reference/Rakefile.htm
+- forge/reference/aRakefile
+- forge/reference/Rakefile
+- forge/reference/installers
+- forge/reference/installers/package.rb
+- forge/reference/installers/setup.rb
+- lib/reap
+- lib/reap/projectinfo.rb
+- lib/reap/rake.rb
+- lib/reap/bin
+- lib/reap/reap.rb
+- lib/reap/class
+- lib/reap/taskutils.rb
+- lib/reap/tasks.rb
+- lib/reap/bin/reap.rb
+- lib/reap/bin/rubytest.rb
+- lib/reap/class/rdoc.rb
+- lib/reap/class/doap.rb
+- lib/reap/class/test.rb
+- lib/reap/class/announce.rb
+- lib/reap/class/extest.rb
+- lib/reap/class/manifest.rb
+- lib/reap/class/publish.rb
+- lib/reap/class/package.rb
+- lib/reap/class/filer.rb
+- web/doc
+- web/index.html
+- web/ProjectInfo.html
+- web/images
+- web/images/grape.jpg
 - sample/task
 - sample/Rakefile
 - sample/Reapfile

data/lib/reap/class/installer.rb DELETED Viewed

@@ -1,178 +0,0 @@
-require 'rbconfig'
-require 'fileutils'
-module Reap
-  # = Installer
-  #
-  # The Installer class generates a specialized install.rb
-  # script specifically for your project. It currently
-  # does not support c/c++ ext/ compilation.
-  class Installer
-    include TaskUtils
-    def self.config(name)
-      # XXX use pathname
-      prefix = Regexp.quote(Config::CONFIG["prefix"])
-      exec_prefix = Regexp.quote(Config::CONFIG["exec_prefix"])
-      Config::CONFIG[name].gsub(/\A\/?(#{prefix}|#{exec_prefix})\/?/, '')
-    end
-    KINDS = [
-      :bin, :lib, :ext, :data, :conf, :doc
-    ]
-    SITE_DIRS = {
-      :bin  => config("bindir"),
-      :lib  => config("sitelibdir"),
-      :ext  => config("sitearchdir"),
-      :data => config("datadir"),
-      :conf => config("sysconfdir"),
-      :doc  => File.join(config("datadir"), "doc"),
-    }
-    VEND_DIRS = {
-      :bin  => config("bindir"),
-      :lib  => config("rubylibdir"),
-      :ext  => config("archdir"),
-      :data => config("datadir"),
-      :conf => config("sysconfdir"),
-      :doc  => File.join(config("datadir"), "doc"),
-    }
-    MODES = {
-      :bin  => 0755,
-      :lib  => 0644,
-      :ext  => 0755,  # was: 0555,
-      :data => 0644,
-      :conf => 0644,
-      :doc  => 0644,
-    }
-    attr_accessor :trunk, :template, :options
-    def initialize( ins )
-      super
-      @trunk = '.' unless @trunk
-      @spec = parse( @template )
-      @transfer = Hash.new { |h,k| h[k] = [] }
-    end
-    #--
-    # TODO use shellwords
-    #++
-    def parse( spec )
-      lines = spec.strip.split("\n")
-      lines.each { |line|
-        words = line.strip.split(/\s+/)
-        send( *words )
-      }
-    end
-    # substitute variables
-    def vsub( str )
-      return nil if str.nil?
-      str = str.gsub( '$version', @options[:version].to_s )
-      str = str.gsub( '$name', @options[:name].to_s )
-      str
-    end
-    # Return the installation directory.
-    def dir( kind, mode=:site )
-      case mode
-      when :site
-        SITE_DIRS[ kind ]
-      when :vendor
-        VEND_DIRS[ kind ]
-      else
-        raise ArgumentError, "unknown mode -- #{mode}"
-      end
-    end
-    # Return installation prefix.
-    def prefix( kind )
-      Config::CONFIG["prefix"]
-    end
-    #--
-    # DSL methods for setting installation spec.
-    #++
-    # Setup a lib installation transfer.
-    def lib( from, glob, to )
-      to = '' if to == '.'
-      @transfer[:lib] << { :from=>vsub(from), :glob=>vsub(glob), :to=>vsub(to) }
-    end
-    # Setup a bin installation transfer.
-    def bin( from, glob, to )
-      to = '' if to == '.'
-      @transfer[:bin] << { :from=>vsub(from), :glob=>vsub(glob), :to=>vsub(to) }
-    end
-    # Compile script and write to install file (install.rb).
-    def compile_and_write
-      script = ""
-      script << "# INSTALL SCRIPT\n"
-      script << "# Generated by Reap\n"
-      script << "# #{Time.now}\n"
-      script << "\n"
-      script << compile
-      script << "\n"
-      script << "# END"
-      write( script )
-    end
-    alias_method :call, :compile_and_write
-  private
-    # Compile installation instructions.
-    def compile
-      mkdirp = []
-      script = ''
-      Dir.chdir( @trunk ) do
-        KINDS.each { |kind|
-          @transfer[kind].each { |trans|
-            next unless File.directory?( trans[:from] )
-            files = []
-            Dir.chdir( trans[:from] ) {
-              files = Dir.glob( trans[:glob] ).reject { |f| File.directory?( f ) }
-            }
-            files.each { |file|
-              f = File.join( trans[:from], file )
-              t = File.join( prefix(kind), dir(kind), trans[:to], file )
-              m = MODES[kind]
-              d = File.dirname(t)
-              unless mkdirp.include?(d)
-                script << "mkdir_p '%s'\n" % d
-                mkdirp << d
-              end
-              script << "install '%s', '%s', :mode=>%o\n" % [ f, t, m ]
-            }
-          }
-        }
-      end
-      script
-    end
-    def write( script )
-      install_file = File.join( @trunk, 'install.rb' )
-      if File.file?( install_file )
-        script_template = File.read( install_file )
-        script = script_template.gsub(/\# INSTALL SCRIPT.*\# END/, script)
-        end
-        File.open( install_file, 'w+' ) do |f|
-          f << script
-        end
-      end
-    end
-  end
-end #module Reap