reap 0.6.1 → 3.01

data/ChangeLog

@@ -1,9 +1,20 @@
 
-v0.5:
-  - Improved testing. Output is summarized and in YAML!
-  - Improved configuration loading a bit.
-  - Worte some basic docs on how to write a Reap task.
-  - Adjusted for Nano upgrade (was Facets).
-
-v0.4:
-  - Initial Toasting
+= Reap ChangeLog
+
+== 03
+
+* Major overhaul. Reap is no longer an independent project.
+  Rather, it is now an extension of Rake. All Reap tasks are
+  now a subclass of Rake::TaskLib.
+
+== 02
+
+* Improved test task. Each test now runs in its own process.
+  Output is summarized and in YAML.
+* Improved configuration loading a bit.
+* Wrote some basic docs on how to write a Reap task.
+* Adjusted for Nano upgrade (was Facets).
+
+== 01
+
+* Alpha Development

data/ProjectInfo

@@ -0,0 +1,25 @@
+--- %YAML:1.0
+
+TITLE    : &title Reap
+NAME     : &pkg reap
+VERSION  : '3.01'
+AUTHOR   : Thomas Sawyer 
+EMAIL    : &email transfire@gmail.com
+HOMEPAGE : "http://reap.rubyforge.org"
+SUMMARY  : Rake extensions for project management assitance.
+
+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'.
+
+DEPENDENCIES : &dep [ nano ]
+EXECUTABLES  : &exe []
+
+RUBYFORGE:
+  PROJECT: reap
+  USERNAME: reap

data/README

@@ -4,16 +4,16 @@ User Friendly Project Assitant for Ruby
 
 == What's This?
 
-Reap is a user friendly project assistant for Ruby developers.
-By organizing your project in a semi-formal manner (the same as setup.rb),
-Reap makes it easy to do the following tasks:
+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
+following tasks:
 
 * Generate RDocs.
 * Run unit tests.
 * Create Ruby Gem packages.
-* Create standard .tar.gz, tar.bzip2 and/or .zip packages.
+* Create standard .tgz, tbz (bzip2) and/or .zip packages.
 * Publish documents to Rubyforge or other web sites.
-* Preform a traditional install (calls setup.rb).
 * Announce a release to Ruby-talk or other mailing list.
 * Prepare files for distribution (i.e. chmod, tag, etc.).
 * Upload packages (coming soon!).
@@ -30,13 +30,11 @@ Install the ruby gem as you would any other:
 
   <tt>gem install reap</tt>
 
-Reap is part of the Ruby clibre project and requires 
-supporting calibre libraries, Facets and Carats, so
-they will also be installed.
+Reap requires Nano Methods.
 
 === Manual Install
 
-To install manually follw the usiusl setup.eb steps:
+To install manually follow the usual setup.eb steps:
 
 1. Download the compressed package.
 2. Unpack it.
@@ -45,10 +43,78 @@ To install manually follw the usiusl setup.eb steps:
 
 You should be good to go.
 
+== Usage
+
+=== 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:
+
+  > reap template
+
+Then edit the ProjectInfo file. The fields are fairly self
+explanitiory. Apart from Reap such a file is nice to have on
+it's own merits too.
+
+=== Building a Reap Task
+
+Building a Reap task differs from building a Rake task
+by two important factors. First there is only one target
+per task (this may change) Second, task blocks are yeilded
+_prior_ to the #init routine being exectuted. So your #init
+routine should expect data to already be present in
+the tasks attribute and take that into account (usually that
+means using ++||=++)
+
+Here's an, oh so simple, example:
+
+  class MyOhSoSimpleTask < Reap::Task
+
+     # This creates the convenience method
+     register 'my_oh_so_simple'
+
+     default_desc 'this is a custom reap task'
+
+     attr_accessor :message
+
+     def init
+       @message ||= master['default'] || 'None Found!'
+     end
+
+     # run the target task
+     def run
+       puts @message
+     end
+
+   end
+
+The corresponding settings in the ProjectInfo file (master) will then be:
+
+   default: Default text, if any.
+
+And to use it in your Rake file:
+
+  ReapTask::my_oh_so_simple_task :mytarget
+
 == Status
 
 Reap is currently Usable Beta. Most of the tasks
-work very well. Refinement are still coomon though,
+work very well. Refinements are still common though,
 and a few important tasks are still being planned.
 
 == Legal
@@ -56,4 +122,3 @@ and a few important tasks are still being planned.
 Reap
 Copyright(c)2004-2005 Thomas Sawyer
 Ruby License
-

data/Rakefile

@@ -1,19 +1,141 @@
 
-require 'reap/reap-all'
-
-#require 'reap/template-task'
-#require 'reap/chmod-task'
-#require 'reap/test-task'
-#require 'reap/rdoc-task'
-#require 'reap/announce-task'
-#require 'reap/publish-task'
-#require 'reap/package-task'
-
-#Reap::TemplateTask.new
-#Reap::ChmodTask.new
-#Reap::TestTask.new
-#Reap::RDocTask.new
-#Reap::AnnounceTask.new
-#Reap::PublishTask.new
-#Reap::PackageTask.new
+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

@@ -0,0 +1,159 @@
+#!/usr/bin/env ruby
+
+require 'getoptlong'
+require 'rbconfig'
+require 'reap/tasks'
+
+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
+    puts "%.2f" % [ Reap::Version ]
+  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