reap 03.01 → 4.0

data/ChangeLog

@@ -1,6 +1,11 @@
 
 = Reap ChangeLog
 
+== 04
+
+* Killed the Rake idea. Now a fully independent project,
+  and better than before.
+
 == 03
 
 * Major overhaul. Reap is no longer an independent project.

data/ProjectInfo

@@ -1,25 +1,65 @@
 --- %YAML:1.0
 
-TITLE    : &title Reap
-NAME     : &pkg reap
-VERSION  : '03.01'
+TITLE    : Reap
+NAME     : reap
+DATE     : '2005-10-06'
+SERIES   : '4.0'
+STATUS   : 'beta/stable'
+
 AUTHOR   : Thomas Sawyer 
-EMAIL    : &email transfire@gmail.com
+EMAIL    : transfire@gmail.com
 HOMEPAGE : "http://reap.rubyforge.org"
-SUMMARY  : Rake extensions for project management assitance.
+SUMMARY  : Tools for Ruby project testing, management and assistance.
 
 DESCRIPTION: >
-  The Reap extensions for Rake comprise a set of commonly
-  needed tasks for Ruby package developers/deployers.
-  Because of the commonality, Reap utilizes a YAML
-  configuration file to harvest project information,
-  significantly simplifying Rake usage. In fact,
-  when using Reap, it will not be uncommon to see a
-  Rakefile containinf nothing but require 'reap-all'.
+  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.
 
-DEPENDENCIES : &dep [ nano ]
-EXECUTABLES  : &exe []
+DISTRIBUTE   : [ gem, tar.bz2, zip ]  # tar.gz, tbz, tgz
+DEPENDENCIES : [ facets ]
+EXECUTABLES  : [ reap ]
 
 RUBYFORGE:
   PROJECT: reap
-  USERNAME: reap
+  USERNAME: transami
+
+PUBLISH:
+  type     : web
+  host     : rubyforge.org
+  username : transami
+  dir      : web
+
+RDOC:
+  dir: 'web/rdoc'
+  include:
+    - 'A-Z*'
+    - 'lib/**/*'
+  exclude:
+    - 'lib/reap/data'
+
+ANNOUNCE:
+  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
+
+PERM:
+  filemod: 644
+  dirmod: 755
+  user: trans
+  group: users
+
+NOOP:
+  MESSAGE: Hello Dude!
+

data/README

@@ -4,13 +4,14 @@ User Friendly Project Assitant for Ruby
 
 == What's This?
 
-Reap 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), Reap makes it easy to do the
+Reap is a user friendly 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 RDocs.
 * Run unit tests.
+* Extract tests for scripts.
 * Create Ruby Gem packages.
 * Create standard .tgz, tbz (bzip2) and/or .zip packages.
 * Publish documents to Rubyforge or other web sites.
@@ -19,7 +20,7 @@ following tasks:
 * Upload packages (coming soon!).
 
 If you have special needs that Reap doesn't accomodate,
-new task are farily easy to create. And we are always
+new task are farily easy to create. And I am always
 happy to hear suggestions.
 
 == Installation
@@ -30,7 +31,7 @@ Install the ruby gem as you would any other:
 
   <tt>gem install reap</tt>
 
-Reap requires Nano Methods.
+Reap requires Ruby Facets.
 
 === Manual Install
 
@@ -39,7 +40,7 @@ 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>./setup.rb</tt>
+4. run <tt>sudo ruby setup.rb</tt>
 
 You should be good to go.
 
@@ -48,27 +49,27 @@ You should be good to go.
 === Using a Reap Task
 
 Reap makes it pretty easy to use it's built-in tasks.
-Not only will it grab common data from a ProjectInfo
-YAML file if available, but it defines convenience methods
-to make writing Rakefiles easier. For instance, to create
-a "package" target all you generally need in your Rakefile is:
-
-  require 'reap/tasks'
-
-  include ReapTask
-
-  package_task :package
-
-The reaon this can be so simple, is b/c Reap extrapolates the
-information it needs from a comon ProjectInfo 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:
+Largely this is because it grabs common data from a ProjectInfo
+(or Reapfile) as available. Some Reap tasks are
+automatic b/c there are reasonable defaults, others
+_require_ 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
+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. Reap will do it's best to extrapolate
+the needed information from the ProjectInfo file.
+
+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:
 
   > reap template
 
 Then edit the ProjectInfo file. The fields are fairly self
-explanitiory. Apart from Reap such a file is nice to have on
+explanitiory. Apart from Reap such a file is nice to have just on
 it's own merits too.
 
 === Building a Reap Task
@@ -83,22 +84,20 @@ means using ++||=++)
 
 Here's an, oh so simple, example:
 
-  class MyOhSoSimpleTask < Reap::Task
-
-     # This creates the convenience method
-     register 'my_oh_so_simple'
+  class OhSoSimple < 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 + "\n" + @another
      end
 
    end
@@ -106,10 +105,12 @@ Here's an, oh so simple, example:
 The corresponding settings in the ProjectInfo file (master) will then be:
 
    default: Default text, if any.
+   ohsosimple:
+     another: Your other message here.
 
-And to use it in your Rake file:
+And to use it
 
-  ReapTask::my_oh_so_simple_task :mytarget
+  > reap ohsosimple
 
 == Status
 

data/Rakefile

@@ -1,141 +0,0 @@
-
-require 'reap/tasks'
-
-# Traditionally, a prebuilt rake task is utilized like this:
-#
-#   Reap::PublishTask.new :mypublisher do |s|
-#     s.type = 'web'
-#     s.host = 'rubyforge.org'
-#     s.username = 'transami'
-#     s.dir = 'pub/www'
-#   end
-#
-# Reap provides a way to use YAML and specilize methods to make
-# this even cleaner.
-#
-#   publish_task( :mypublisher ) {"
-#     type     : web
-#     host     : rubyforge.org
-#     username : transami
-#     dir      : pub/www
-#   "}
-#
-# Of course, one can still use a traditional block with the
-# special methods.
-#
-#   publish_task :mypublisher do |s|
-#     s.type = 'web'
-#     s.host = 'rubyforge.org'
-#     s.username = 'transami'
-#     s.dir = 'pub/www'
-#   end
-#
-# But there is an additional advantage to the YAML approach. Reap prepends
-# the task YAML with the YAML in the ProjectInfo file. This way it is easy
-# to reuse master information in indivial tasks. For exmaple you might have
-# an# &author anchor defined in ProjectInfo.
-#
-#   publish_task( :mypublisher ) {"
-#     type     : web
-#     host     : rubyforge.org
-#     username : *author
-#     dir      : pub/www
-#   "}
-#
-# This special method notation actually works for some prebuilt rake tasks too.
-# But do not expect the YAML to work /w them.
-#
-
-# template_task
-
-include ReapTask
-
-info_task( :info )
-
-publish_task :publish do"
-  type     : web
-  host     : rubyforge.org
-  username : transami
-  dir      : www
-"end
-
-announce_task :announce do"
-  to       : transfire@gmail.com  # ruby-talk@ruby-lang.org
-  from     : *email
-  domain   : reap.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://rake.rubyforge.org
-"end
-
-filemod_task :filemod do"
-  filemod: 644
-  dirmod: 755
-  user: trans
-  group: users
-"end
-
-test_task :test do"
-  files:
-    - 'test/**/tc*.rb'
-    - 'test/**/test*.rb'
-    - 'test/**/*test.rb'
-  options: ~  # not used yet
-"end
-
-rdoc_task :rdoc do"
-  title: *title
-  dir: 'pub/www/rdoc'
-  template: html
-  options: ['--merge', '--all']
-  main: README
-  include:
-    - 'README*'
-    - 'LICEN*'
-    - 'COPY*'
-    - 'lib/**/*.rb'
-    - 'bin/**/*.rb'
-  exclude: []
-"end
-
-package_task :package do"
-  dir: pkg
-  include:
-    - 'lib/**/*'
-    - 'data/**/*'
-    - 'ext/**/*'
-    - 'bin/**/*'
-    - 'bench/**/*'
-    - 'test/**/*'
-    - 'doc/**/*'
-    - 'rdoc/**/*'
-    - 'pub/**/*'
-    - 'www/**/*'
-    - 'demo/**/*'
-    - 'samples/**/*'
-    - 'examples/**/*'
-    - 'bench/**/*'
-    - 'setup.rb'
-    - '[A-Z]*'
-  exclude:
-    - InstalledFiles
-  autorequire: ~
-  requirements: []
-  dependencies: *dep #[]
-  executables: *exe #[]
-  gem: true
-  zip: true
-  gzip: true
-  bzip2: true
-"end
-
-noop_task :noop do"
-  message: 'Hello, World!'
-"end

data/bin/reap

@@ -1,161 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'getoptlong'
-require 'rbconfig'
-require 'reap/tasks'
+require 'reap/bin/reap'
 
-HELP1 = <<-HERE
-
-  reap v#{::Reap::VERSION}
-
-  USAGE: reap [options...] <command> [arguments...]
-
-  COMMANDS:
-
-    help
-        Displays this help information.
-
-    template
-        Copies the ProjectInfo template into the current
-        directory, if it doesn't already exist.
-
-HERE
-
-HELP2 = <<-HERE
-  OPTIONS:
-
-    -v  --verbose
-        Provides extra verbose processing information.
-
-    -u  --use <file>
-        Use the specified configuration file rather than
-        the default 'ProjectInfo'.
-
-    -p  --pretend  (NOT YET IMPLEMENTED)
-        Pretend, just to see what would happen, but don't
-        actually do anything.
-
-    --version
-        Display the current version.
-
-    --help
-        Display this help information.
-HERE
-
-
-module Commands
-  extend self
-
-  DATA_DIR = 'site_ruby/reap'
-  FILE_NAME = 'ProjectInfo'
-
-  def version
-    d = Reap::VERSION.to_i
-    f = Reap::VERSION - d
-    puts "%02d.%02d" % [ d, f ]
-  end
-
-  def help
-    puts HELP1
-
-    #Reap::Task.registry.each do |t|
-    #  puts "    #{t.task_name}"
-    #  puts "        #{t.task_desc}\n\n"
-    #end
-
-    puts HELP2
-  end
-
-  def tasks
-    puts
-    #Reap::Task.registry.each do |t|
-    #  puts "  #{t.task_name}".ljust(20) + "#{t.task_desc}"
-    #end
-    puts
-  end
-
-  def template( file_name = ProjectInfo )
-    #dir = File.dirname(File.dirname(__FILE__))
-    dir = File.join( ::Config::CONFIG['datadir'], DATA_DIR )
-
-    tmpf = File.join( dir, 'template.yaml' )
-    unless File.file?( tmpf )
-      puts tmpf
-      raise "Tempfile is missing."
-    end
-
-    if File.directory?(filename)
-      puts "#{filename} a directory. Cannot comply."
-      return
-    elsif File.file?(filename)
-      puts "#{filename} already exists."
-      return
-    end
-    # copy tmpf to Reapfile
-    FileUtils.cp( tmpf, filename )
-    puts "#{filename} created. You'll need to fill it out."
-  end
-
-end
-
-
-# main
-
-cmd = nil
-
-opts = GetoptLong.new(    
-  [ "-v", "--verbose", GetoptLong::NO_ARGUMENT ],
-  [ "-p", "--pretend", GetoptLong::NO_ARGUMENT ],
-  [ "-d", "--debug", GetoptLong::NO_ARGUMENT ],
-  [ "-u", "--use", GetoptLong::REQUIRED_ARGUMENT ],
-  [ "--version", GetoptLong::NO_ARGUMENT ],
-  [ "--help", GetoptLong::NO_ARGUMENT ]
-)
-
-opts.each do |o, a|
-  case o
-    when '-v'
-      $VERBOSE = true
-    when '-p'
-      $PRETEND = true
-    when '-u'
-      config = a
-    when '-d'
-      $DEBUG = true
-    when '--help'
-      cmd = 'help'
-    when '--version'
-      cmd = 'version'
-  end
-end
-
-cmd = cmd || ARGV[0]
-args = ARGV[1..-1]
-config = nil
-
-cmd = cmd.downcase if cmd
-
-case cmd
-when nil,'help'
-  Commands.help
-  exit 0
-when 'tasks'
-  Commands.tasks
-  exit 0
-when 'version'
-  Commands.version
-  exit 0
-when 'template'
-  Commands.template
-end
-
-# Quick-build and run a task.
-
-c = cmd.downcase.to_s
-if ReapTask.respond_to?( "#{c}_task" )
-  rt = ReapTask.send("#{c}_task") { ARGV.slice(1..-1).join(' ') }
-  rt.run
-else
- puts "Unknown command. Try 'reap help' for assitance."
- exit 0
-end
+ReapCommand.new.go