reap 9.3.5 → 9.4.0

data/bin/reap-install

@@ -2,7 +2,18 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
 
-app.site_install
+This command will install the project on your system as a local
+site-ruby package. It does this be searching for an install.rb
+or setup.rb script to run.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.site_install
+end
 

data/bin/reap-install-gem

@@ -2,7 +2,19 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+This command will install the project on your system as a gem
+package. It will create the gem package, via reap-package-gem,
+if it does not already exist.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.gem_install
+end
 
-app.gem_install
 

data/bin/reap-log

@@ -2,6 +2,19 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+This command invokes the sub-log commands: log-changes and log-notes.
+These commands update the automated note logs and changelog, stored
+in the conventional log/ directory. The changelog is dependent on a
+compataible SCM system.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.log
+end
 
-app.log

data/bin/reap-log-changes

@@ -2,7 +2,20 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
 
-app.log_changes
+This command generates a changelog and stores it in the log/
+directory. This command gathers it's information from the
+project's source control manager.
+
+Currently only SVN is supported, but GIT support is forth-coming.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.log_changes
+end
 

data/bin/reap-log-notes

@@ -2,7 +2,25 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+This command scans source code for developer notes and writes them 
+to well organized files. This tool can lookup and list TODO, FIXME
+and other labeled comments from source code.
+
+   files    Glob(s) of files to search.
+   labels   Labels to search for. Defaults to [ 'TODO', 'FIXME' ].
+   output   Output directory. Defaults to log/.
+
+This command is also executed when reap-log is executed.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.log_notes
+end
 
-app.log_notes
 

data/bin/reap-make

@@ -2,6 +2,20 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Compile extensions using make system. This command executes
+the reap-make-extconf command, which searches for extconf.rb
+scripts under the ext/ directory and runs them, which will
+generate Makefiles. Then the makes files are executed via the
+system make command, compiling any extensions.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.make
+end
 
-app.make

data/bin/reap-make-clean

@@ -2,6 +2,14 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.make_clean
+end
 
-app.make_clean

data/bin/reap-make-distclean

@@ -2,6 +2,22 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Reset ext/ contents to "pristine" state. This will
+remove and temporary products created by the compile
+process, via reap-make-clean, as well as remove all
+itermediate object files.
+
+Run this command if you wish to recompile from scratch.
+This command is also executed when running reap-clobber.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.make_distclean
+end
 
-app.make_distclean

data/bin/reap-make-extconf

@@ -2,6 +2,18 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+This command searches for extconf.rb scripts under the ext/
+directory and runs them, which if configured properly, will
+generate suitable Makefiles for compiling any extensions.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.make_config
+end
 
-app.make_extconf

data/bin/reap-make-static

@@ -2,7 +2,19 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Like reap-make but passes the static option, in order
+to build a static extension --one that has no external
+dependencies.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.make_static
+end
 
-app.make_static
 

data/bin/reap-package

@@ -2,7 +2,30 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
 
-app.package
+Generate packages. This command currently supports the
+following formats: zip, tgz and gem. Generated packages
+are stored in the conventional pkg/ directory.
+
+The types of packages generated can be specified via the
+format option. The defualt format setting includes all
+three types.
+
+  format    List of formats to generate.
+
+Almost any other piece of package metadata can be overridden
+via the command options.
+
+This command first runs the reap-prepare process, which
+includes reap-clean and reap-version.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.package
+end
 

data/bin/reap-package-gem

@@ -2,6 +2,18 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Generate a gem package. The generated package is stored in the
+conventional pkg/ directory. See reap-package for additional
+details about genreating packages.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.package_gem
+end
 
-app.package_gem

data/bin/reap-package-tgz

@@ -2,6 +2,18 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Generate a tgz package. The generated package is stored in the
+conventional pkg/ directory. See reap-package for additional
+details about genreating packages
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.package_tgz
+end
 
-app.package_tgz

data/bin/reap-package-zip

@@ -2,6 +2,18 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Generate a zip package. The generated package is stored in the
+conventional pkg/ directory. See reap-package for additional
+details about genreating packages
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.package_zip
+end
 
-app.package_zip

data/bin/reap-prepare

@@ -2,6 +2,25 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Prepare for packaging. This is "meta"-command which runs
+the following commands in order:
+
+  reap-clean
+  reap-make-distclean
+  reap-version
+
+The make-distclean command is not run if the project does
+not have any extensions, or is being prepared for a binary
+package. These commands prepare the project for packaging.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.prepare
+end
 
-app.prepare

data/bin/reap-publish

@@ -2,6 +2,29 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+This tool publishes website files from a source directory
+(deafult 'site') to a host provider (only Rubyforge for now).
+The host must support RSync, which is used to upload the
+files to the webserver.
+
+    project    Name of (Rubyforge) project
+    webdir     Relative directory on server to copy files (.)
+    source     Local directory to get files (site/)
+    username   Username (RUBYFORGE_USERNAME)
+
+If the source directory does not contain an '.rysnc-filter'
+file, a standard one will be genreated the first time the
+command is run. You can then edit this file to add any 
+upload exceptions you like.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.publish
+end
 
-app.publish

data/bin/reap-release

@@ -2,6 +2,26 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Release a package to Rubyforge for distribution. This command
+uses Reap's rubyforge subsystem to upload the package files
+to Rubyforge for redistribution.
+
+Two vital settings for this command are usernmae and password,
+in order to gain access to Rubyforge. The best way to supply
+this information is using the RUBYFORGE_USERNAME environment
+variable, and supplying the password on the command line via
+the --password option.
+
+Do not put your password in the .reap configuration file!!!
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.release
+end
 
-app.release

data/bin/reap-rollout

@@ -2,6 +2,36 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Rollout is a meta-command which can run the following commands
+in order:
+
+  reap-document*
+  reap-package
+  reap-publish*
+  reap-release
+  reap-scm-tag*
+  reap-announce*
+
+The commands with astrisks are optional. You will be prompted in
+each case if you wish to include those procedures in the rollout
+process. Since reap-package also runs reap-prepare, which in turn
+runs reap-clean and reap-version, reap-rollout automates a large
+section of project management, and it therefore the most useful
+command in Reap. A typical usage is:
+
+  $ reap-rollout --minor --password=foofoo
+
+The --minor option indicates a minor version bump (see reap-version),
+and the --password option is used by the rubyforge subsystem.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.rollout
+end
 
-app.rollout