reap 5.0.0 → 5.10.10

data/doc/README

@@ -1,182 +0,0 @@
-= Reap
-
-Project Assistant for Ruby
-
-
-== What's This Then?
-
-Reap is an easy to use project assistant for Ruby developers.
-By organizing your project in a conventional manner, 
-(as promoted by setup.rb), Reap makes it easy to do the
-following tasks:
-
-* Generate RDoc API documentation.
-* Run unit tests (each in it's ruby process).
-* Extract embedded tests from source code.
-* Run embedded unit test directly.
-* Create source tar and/or zip packages.
-* Create Ruby Gem and/or Debian packages.
-* Publish documents to Rubyforge or other web sites.
-* Announce a release to Ruby-talk or other mailing list.
-* Prepare files for distribution (i.e. chmod, tag, etc.).
-* Release distributions on Rubyforge or other host.
-* Even generate a DOAP project file.
-
-If you have special needs that Reap doesn't accomodate,
-new tasks are farily easy to create. And I am always
-happy to engage suggestions.
-
-
-== Installation
-
-Note that Reap requires Ruby Facets.
-
-=== Gem Install
-
-Install the ruby gem as you would any other:
-
-  <tt>gem install reap</tt>
-
-Gems still suffers from the datadir problem, so we've had
-to create some work arounds, for the template and scaffold
-tasks in particular. If you have any trouble with the Gem
-install please let us know so we can correct.
-
-=== Manual Install
-
-To install manually follow the usual setup.eb steps:
-
-1. Download the compressed package.
-2. Unpack it.
-3. Change into the unpacked directory.
-4. run <tt>sudo ruby setup.rb</tt>
-
-You should be good to go.
-
-
-== Usage
-
-=== Using a Reap Task
-
-Reap makes it pretty easy to use it's built-in tasks.
-Largely this is because it grabs common data from the
-ProjectInfo file. Some tasks can operate automatically based
-on reasonable defaults, others require section entries 
-in the ProjectInfo file.
-
-For instance, to create a "package" target you generally do not need
-an entry in the ProjectInfo file. Reap will package up everything
-in the typical directories and makes compressed versions in the most
-common formats. It will then place those in either dist/, pkg/,
-../packages/, ../dist or ../pkg.  Depending on which of these exists.
-The reasonable assumtions exist for other tasks. Reap will do
-it's best to extrapolate the needed information waht's avaialbe
-in the ProjectInfo file.
-
-Of course, no matter the level of content, you will need to
-create this file in you projects main directory. A template is provided
-and a command to copy it to your current directory. Simply type:
-
-  > reap template
-
-Then edit the ProjectInfo file creted. The fields are fairly self
-explanitiory. Apart from Reap, such a file is nice to have just on
-it's own merits too.
-
-Reap can also build an entire new project directory with all the 
-standard components. Try:
-
-  > reap scaffold myproj
-
-A new directory will be created called 'myproj' with all the ususal
-directories like lib/, bin/, etc.  If you use subversion for
-version management, you can create a subversion layout easily
-as well.
-
-  > reap scaffold svn
-
-For more help, use
-
-  > reap help
-
-or
-
-  > reap help [task]
-
-Supplying the task name provides specific help for that particular task.
-
-
-=== Building a Reap Task
-
-Building a Reap task is pretty easy too, but is is quite different
-from building a Rake task. You are just defining a method, but a
-whole class.
-
-Here's an "oh so simple" example:
-
-  class MySimple < Reap::Task
-
-     task_desc 'This is a custom reap task class.'
-
-     task_help %{
-       This is help information for a custom reap task.
-     }
-
-     task_attr :simple
-
-     def run
-       simple.message ||= 'None Found!'
-       simple.another ||= 'Again!'
-
-       puts simple.message + "\n" + simple.another
-     end
-
-   end
-
-The corresponding settings in the ProjectInfo file (master) will then be:
-
-   message: Default text, if any.
-
-   simple: !!mysimple
-     another: Your other message here.
-
-And to use it
-
-  > reap simple
-
-While Reap had used instance varaibles for task properties in the past,
-this has changed as of version 4.3.3. Now it uses the 'task' object,
-which can be referenced by any name you like using task_attr to alias it.
-The nice thing about using this interface instead of instance
-variables is that reap will automatically search the
-ProjectInfo's root if the property is not found in the task
-specific section. This allows for a nice form of inheritance
-within the document.
-
-Sometimes you may need to override this inheritance behavor, though.
-In that case just set the task property directly equal to the
-section property in the run method. Eg.
-
-     def run
-       task.message = section.message
-       ...
-     end
-
-Notice we used 'task' here rather than 'simple'. This task object
-is always available. In the above, 'simple' is just being aliased
-to 'task' for readability convenience. Both refer to the same
-underlying object.
-
-
-== Status
-
-Reap is currently "Usable Beta". Most of the tasks
-work very well. Refinements are still common though.
-
-
-== Legal
-
-Reap
-Copyright(c)2004-2006 Thomas Sawyer
-Ruby License
-

data/doc/doap.xml

@@ -1,27 +0,0 @@
-<Project xmlns="http://usefulinc.com/ns/doap#"
-         xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-         xmlns:foaf="http://xmlns.com/foaf/0.1/">
-   <name>Reap</name>
-   <shortname>reap</shortname>
-   <homepage rdf:resource="http://reap.rubyforge.org" />
-   <wiki rdf:resource="" />
-   <created>2004-04-01</created>
-   <shortdesc xml:lang="en">
-      Tools for Ruby project testing, management and
-      assistance.
-   </shortdesc>
-   <description xml:lang="en">
-      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.
-   </description>
-   <maintainer>
-     <foaf:Person>
-       <foaf:name>Thomas Sawyer</foaf:name>
-       <foaf:email>transfire@gmail.com</foaf:name>
-       <foaf:homepage rdf:resource="http://reap.rubyforge.org" />
-     </foaf:Person>
-   </maintainer>
- </Project>

data/doc/note/ProjectInfo.rb

@@ -1,88 +0,0 @@
-#!/usr/bin/env ruby
-
-# NOTE This is here for expiremental reasons.
-#      It is a pure Ruby alternative to the
-#      YAML based project file. (It actually
-#      works if it's renamed w/o the '.rb'.)
-
-title   'Reap'
-name    'reap'
-version '4.3.4'
-date    '2006-04-07'
-created '2004-04-01'
-status  'beta/stable'
-
-author   'Thomas Sawyer'
-email    'transfire@gmail.com'
-homepage 'http://reap.rubyforge.org'
-summary  'Tools for Ruby project testing, management and assistance.'
-
-description %{
-  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.
-}
-
-distribute    [ 'gem', 'deb' ]  # zip, tar.gz, tbz, tgz, deb
-dependencies  [ 'facets' ]
-executables   [ 'reap' ]
-
-package {
-  dir         '../DISTRIBUTION'
-  distribute  [ 'deb' ]
-  exclude     [ 'dist', 'dev', 'scrap', 'web' ]
-}
-
-rubyforge {
-  project    'reap'
-  username   'transami'
-}
-
-release {
-  host       'rubyforge.org'
-  username   'transami'
-  project    'reap'
-  groupid    '811'
-  package    'Reap'
-  dir        '../DISTRIBUTION'
-}
-
-publish {
-  type       'web'
-  host       'rubyforge.org'
-  username   'transami'
-  dir        'web'
-}
-
-rdoc {
-  dir        'web/doc/api'
-  include    [ 'A-Z*', 'lib/**/*' ]
-  exclude    [ 'lib/reap/data' ]
-}
-
-anncounce {
-  to         'transfire@gmail.com'  # ruby-talk@ruby-lang.org
-  from       'transfire@gmail.com'
-  domain     'unit.rubyforge.org'
-  server     'smtp.gmail.com'
-  port       '587'
-  account    'transfire@gmail.com'
-  type       'login'  # cram_md5, plain
-  security   'tls'    # ~, tls, ssl (not working yet)
-  #file      'ANN'    # which file contains announcement
-  slogan     'REAP THE REWARDS!'
-  links      []
-}
-
-perm {
-  filemod    '644'
-  dirmod     '755'
-  user       'trans'
-  group      'users'
-}
-
-#noop {
-#  message 'Hello Dude!'
-#}
-

data/doc/note/Rakefile.0

@@ -1,118 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rake'
-require 'reap/reap'
-
-# Load the project information file from standard location.
-# (Note that this sets the global variable $PROJECT_INFO.)
-
-ProjectInfo.load
-
-# If one wished this could do the following
-# instead of using an exteranl file.
-
-=begin
-ProjectInfo.new do
-
-  title   'Reap'
-  name    'reap'
-  version '4.3.4'
-  date    '2006-04-07'
-  created '2004-04-01'
-  status  'beta/stable'
-
-  author   'Thomas Sawyer'
-  email    'transfire@gmail.com'
-  homepage 'http://reap.rubyforge.org'
-  summary  'Tools for Ruby project testing, management and assistance.'
-
-  description %{
-    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.
-  }
-
-  distribute    [ 'gem', 'deb', 'zip' ]  # zip, tar.gz, tbz, tgz, deb
-  dependencies  [ 'facets' ]
-  executables   [ 'reap' ]
-
-  package {
-    dir         '../DISTRIBUTION'
-    distribute  [ 'deb' ]
-    exclude     [ 'dist', 'dev', 'scrap', 'web' ]
-  }
-
-  rubyforge {
-    project    'reap'
-    username   'transami'
-  }
-
-  release {
-    host       'rubyforge.org'
-    username   'transami'
-    project    'reap'
-    groupid    '811'
-    package    'Reap'
-    dir        '../DISTRIBUTION'
-  }
-
-  publish {
-    type       'web'
-    host       'rubyforge.org'
-    username   'transami'
-    dir        'web'
-  }
-
-  rdoc {
-    dir        'web/doc/api'
-    include    [ 'A-Z*', 'lib/**/*' ]
-    exclude    [ 'lib/reap/data' ]
-  }
-
-  announce {
-    to         'transfire@gmail.com'  # ruby-talk@ruby-lang.org
-    from       'transfire@gmail.com'
-    domain     'unit.rubyforge.org'
-    server     'smtp.gmail.com'
-    port       '587'
-    account    'transfire@gmail.com'
-    type       'login'  # cram_md5, plain
-    security   'tls'    # ~, tls, ssl (not working yet)
-    #file      'ANN'    # which file contains announcement
-    slogan     'REAP THE REWARDS!'
-    links      []
-  }
-
-end
-=end
-
-# Here's an exmaple of a task where the parameters
-# are set progamatically, like a regular Rake task
-# --instead of being pulled from the project info data.
-# Even so, the task can still look to the project info's
-#  master (ie. root) level for any missing information.
-
-Rake::ReapPackage.new do |pkg|
-  pkg.dir = '../DISTRIBUTION'
-  pkg.distribute =  [ 'tar.bz2', 'gem', 'deb' ]
-  pkg.dependencies  [ 'facets' ]
-  pkg.executables   [ 'reap' ]
-  pkg.exclude = [ 'dist', 'dev', 'scrap', 'web' ]
-end
-
-# The easy way -- just setup the tasks to pull info
-# from the project information data/file.
-
-Rake::ReapAnnounce.new
-Rake::ReapExTest.new
-Rake::ReapTest.new
-Rake::ReapInstall.new
-Rake::ReapRelease.new
-Rake::ReapInfo.new
-Rake::ReapRDoc.new
-Rake::ReapDoap.new
-Rake::ReapPublish.new
-Rake::ReapManifest.new
-
-

data/doc/note/Rakefile.htm

@@ -1,69 +0,0 @@
-# Rakefile for xoxo-rb.  -*-ruby-*-
-require 'rake/rdoctask'
-require 'rake/testtask'
-
-
-desc "Run all the tests"
-task :default => [:test]
-
-desc "Do predistribution stuff"
-task :predist => [:chmod, :changelog, :doc]
-
-
-desc "Run all the tests"
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test_*.rb']
-  t.verbose = true
-end
-
-desc "Make an archive as .tar.gz"
-task :dist => :test do
-  system "export DARCS_REPO=#{File.expand_path "."}; " +
-         "darcs dist -d xoxo-rb#{get_darcs_tree_version}"
-end
-
-desc "Make binaries executable"
-task :chmod do
-  Dir["bin/*"].each { |binary| File.chmod(0775, binary) }
-end
-
-desc "Generate a ChangeLog"
-task :changelog do
-  system "darcs changes --repo=#{ENV["DARCS_REPO"] || "."} >ChangeLog"
-end
-
-desc "Generate RDoc documentation"
-Rake::RDocTask.new(:doc) do |rdoc|
-  rdoc.options << '--line-numbers --inline-source'
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.rdoc_files.include 'README'
-  rdoc.rdoc_files.include 'xoxo.rb'
-end 
-
-
-# Helper to retrieve the "revision number" of the darcs tree.
-def get_darcs_tree_version
-  return ""  unless File.directory? "_darcs"
-
-  changes = `darcs changes`
-  count = 0
-  tag = "0.0"
-  
-  changes.each("\n\n") { |change|
-    head, title, desc = change.split("\n", 3)
-    
-    if title =~ /^  \*/
-      # Normal change.
-      count += 1
-    elsif title =~ /tagged (.*)/
-      # Tag.  We look for these.
-      tag = $1
-      break
-    else
-      warn "Unparsable change: #{change}"
-    end
-  }
-
-  "-" + tag + "." + count.to_s
-end