reap 4.5.2 → 5.0.0

data/ProjectInfo

@@ -2,14 +2,14 @@
 
 title    : Reap
 name     : reap
-version  : '4.5.2'
-created  : '2004-04-01'
+version  : '5.0.0'
 status   : 'beta/stable'
+created  : '2004-04-01'
 
 author   : Thomas Sawyer
 email    : &email transfire@gmail.com
 homepage : "http://reap.rubyforge.org"
-summary  : The Bountiful Ruby Project Management Assistant
+summary  : The Flexible Ruby Project Management Assistant
 
 description: >
   Reap comprises a set of tasks commonly need ber Ruby package
@@ -18,7 +18,13 @@ description: >
   Reap utilizes a YAML configuration file to harvest project
   information, significantly simplifying these chores.
 
-package:
+rubyforge:
+  project  : reap
+  username : transami
+
+install: !!install
+
+package: !!package
   distribute   : [ gem, tar.bz2 ]  # zip, tar.gz, tbz, tgz, gem, deb
   dependencies : [ facets ]
   executables  : [ reap, rubytest ]
@@ -29,11 +35,7 @@ package:
     - scrap
     - web
 
-rubyforge:
-  project  : reap
-  username : transami
-
-release:
+release: !!release
   host       : rubyforge.org
   username   : transami
   project    : reap
@@ -41,22 +43,21 @@ release:
   package    : Reap
   dir        : '../DISTRIBUTION'
 
-publish:
+publish: !!publish
   target   : rubyforge
   type     : web
   host     : rubyforge.org
   username : transami
   dir      : web
 
-rdoc:
+rdoc: !!rdoc
   dir: 'web/doc/api'
-  include:
-    - 'A-Z*'
-    - 'lib/**/*'
-  exclude:
-    - 'lib/reap/data'
+  main: 'doc/README'
+#  include:
+#    - 'A-Z*'
+#    - 'lib/**/*'
 
-announce:
+announce: !!announce
   to       : transfire@gmail.com  # ruby-talk@ruby-lang.org
   from     : *email
   domain   : unit.rubyforge.org
@@ -69,12 +70,21 @@ announce:
   slogan   : REAP THE REWARDS!
   links    : []
 
-perm:
-  filemod: 644
-  dirmod: 755
-  user: trans
-  group: users
+# perm: !!perm
+#   filemod: 644
+#   dirmod: 755
+#   user: trans
+#   group: users
 
-noop:
-  message: Hello Dude!
+# noop1: !!noop
+#   message: Hello Dude!
+#
+# noop2: !!noop
+#   desc: Alternate description for a task
+#   message: Hello Baby!
+#
+# mytask: !!custom
+#   desc: This is a test of a cutom task.
+#   task:
+#     puts "Hello Moto!"
 

data/Rakefile

@@ -1,118 +1,10 @@
-#!/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' ]
-  }
+require 'reap/rake'
 
-  rubyforge {
-    project    'reap'
-    username   'transami'
-  }
+task :default => [:tasks]
 
-  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' ]
+task :tasks do
+  Rake.application.options.show_task_pattern = //
+  Rake.application.display_tasks_and_comments
 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/ChangeLog

@@ -1 +1,18 @@
 = Reap ChangeLog
+
+5.0.0:
+  - New task mechinism uses YAML types to define the type
+    of task. This also allows for basic custom tasks
+    to be added directly to the ProjectInfo file.
+  - The new system also elgantly interfaces with Rake.
+    So if you are a dedicated Rake user, you only need
+    to use 'require reap/rake' in your Rakefile and
+    all the tasks entries in the ProjectInfo file
+    will be available via rake.
+  - New task mechinism now allows for custom named tasks.
+    While this has the downside lack of name standardization
+    for task types, we will strongly promote the convention
+    of standard names to minimize this.
+  - Reinstated use of task_attr for definin alternate name
+    for accessing inheritable task properties.
+

data/doc/LATEST

@@ -1,8 +1,28 @@
 
-Sailed right through the 4.4.x series. Now were onto the next with a whole new level of irony ;)
-This release features both Rake interoperability and CUSTOM TASKS! Ain't it a woot! Just when it
-becomes possible to actually use Reap in place of Rake altogether, you can now use Reap via
-Rake as just another set of availble Rake tasks. This baby is blooming!
+And just like that *snap* we arrive at version 5.0. Why a major version change? Becuase Reap tasks now have new "formulary". They are defined as true blue YAML types. This means you can even name a Reap task anything you like (although we strongly encourage sticking to the conventional names unless
+otherwise neccessary). Here's an example from Facets' own ProjecInfo file:
+
+  rdoc-core: !!rdoc
+    dir: web/doc/api/core
+    template: jamis
+    options: ['--all', '--inline-source']
+    include:
+      - 'lib/facets/core/**/*'
+      - '[A-Z]*'
+
+  rdoc-more: !!rdoc
+    dir: web/doc/api/more
+    template: jamis
+    options: ['--all', '--inline-source']
+    include:
+      - 'lib/facets/more/**/*'
+      - '[A-Z]*'
+
+With this release we have also tightened Rake inter-operability. Simply place
+
+  require 'reap/rake'
+
+in you Rakefile and all tasks defined in the ProjectInfo file will be available via the rake command.
 
 Enjoy,
 T.

data/{README → doc/README}

@@ -1,6 +1,6 @@
 = Reap
 
-Project Assitant for Ruby
+Project Assistant for Ruby
 
 
 == What's This Then?
@@ -37,12 +37,10 @@ Install the ruby gem as you would any other:
 
   <tt>gem install reap</tt>
 
-Gems still suffers from the datadir problem,
-so the template and scaffold commands
-may report missing files if you use this
-installation method. A fix is in the works,
-but for the moment it is better to use the 
-manual install.
+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
 
@@ -116,25 +114,21 @@ whole class.
 
 Here's an "oh so simple" example:
 
-  class OhSoSimple < Reap::Task
+  class MySimple < Reap::Task
 
-     task_desc 'This is a custom reap task'
+     task_desc 'This is a custom reap task class.'
 
      task_help %{
-
-       reap ohsosimple
-
        This is help information for a custom reap task.
-
      }
 
-     alias_method :ohso, :task
+     task_attr :simple
 
      def run
-       ohso.message ||= 'None Found!'
-       ohso.another ||= 'Again!'
+       simple.message ||= 'None Found!'
+       simple.another ||= 'Again!'
 
-       puts ohso.message + "\n" + ohso.another
+       puts simple.message + "\n" + simple.another
      end
 
    end
@@ -143,16 +137,16 @@ The corresponding settings in the ProjectInfo file (master) will then be:
 
    message: Default text, if any.
 
-   ohsosimple:
+   simple: !!mysimple
      another: Your other message here.
 
 And to use it
 
-  > reap ohsosimple
+  > reap simple
 
 While Reap had used instance varaibles for task properties in the past,
-But has changed as of version 4.3.3. Now it uses the 'task' object,
-which can be referenced by any name you like is you alias it.
+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
@@ -168,8 +162,8 @@ section property in the run method. Eg.
        ...
      end
 
-Notice we used 'task' here rather than 'osho'. This task object
-is always available. In the above, 'osho' is just being aliased
+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.
 

data/doc/note/Rakefile.0

@@ -0,0 +1,118 @@
+#!/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
+
+