reap 9.3.5 → 9.4.0

data/bin/reap-scaffold

@@ -2,7 +2,21 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
 
-app.scaffold
+Reap scaffold will generate a conventional Ruby project
+layout of directories and files. It uses information from
+project metadata to improve upon the scaffolding if it
+is available (see reap-init). reap-scaffold will not 
+overwite pre-existing files of the same name unless the
+--force option is supplied.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.scaffold
+end
 

data/bin/reap-scm-branch

@@ -2,6 +2,17 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Branch the project via a supported source control manager
+(currently only SVN is supported).
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.scm_branch
+end
 
-app.scm_branch

data/bin/reap-scm-tag

@@ -2,6 +2,17 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Tag the project via a supported source control manager
+(currently only SVN is supported).
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.scm_tag
+end
 
-app.scm_tag

data/bin/reap-spec

@@ -2,6 +2,18 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Run specifications. This is a general specifications runner, which
+loads all specs into a single process and and then runs them
+consecutively. This shells out to the 'spec' command per RSpec.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.spec
+end
 
-app.spec

data/bin/reap-stats

@@ -2,6 +2,25 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Scan source code counting files, lines of code and comments
+and presents a report of it's findings.
+
+  loadpath   Path to include in analysis. The default
+             is the project's loadpath.
+
+  exclude    File globs to exclude from analysis. Default is
+             'ext' b/c this does not yet support C analysis.
+
+This command does not currently support C coded extensions.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.stats
+end
 
-app.stats

data/bin/reap-test

@@ -2,6 +2,18 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Run unit tests. This is a general unit test runner, which
+loads all tests into a single process and and then runs
+them consecutively.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.test_unit
+end
 
-app.test_unit

data/bin/reap-test-cross

@@ -2,6 +2,27 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+This command runs unit tests in pairs to make sure there is cross
+library compatibility. Each pair is run in a separate interpretor
+to prevent script clash. This makes for a more robust test
+facility and prevents potential conflicts between scripts.
+
+  tests     Test files (eg. test/tc_**/*.rb) [test/**/*]
+  loadpath  Directories to include in load path.
+  require   List of files to require prior to running tests.
+  live      Deactive use of local libs and test against install.
+
+This command is especially useful to large library collection type
+projects.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.test_cross
+end
 
-app.test_cross

data/bin/reap-test-load

@@ -4,6 +4,21 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Simple load testing. Each test is loaded to ensure their
+are no require issues in the tests themselves. This is
+largey redudant since any other test command will report
+these errors as well. The advantage here howver, is that
+this command isolates test load issues from actual test
+failures.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.test_load
+end
 
-app.test_load

data/bin/reap-test-solo

@@ -2,6 +2,23 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Run unit-tests independently. Each test is run in a separate
+interpretor to prevent script clash. This adds to a more robust
+test facility, and prevents potential conflicts between test scripts.
+
+  tests     Test files (eg. test/tc_**/*.rb) [test/**/*]
+  loadpath  Directories to include in load path [lib].
+  require   List of files to require prior to running tests.
+  live      Deactive use of local libs and test against install.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.test_solo
+end
 
-app.test_solo

data/bin/reap-uninstall

@@ -2,6 +2,18 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Uninstall previous installation to site_ruby via reap-install.
+This only works if the underlying install script (e.g. setup.rb)
+supports an uninstall subcommand.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.site_uninstall
+end
 
-app.site_uninstall

data/bin/reap-uninstall-gem

@@ -2,6 +2,21 @@
 
 require 'reap/application'
 
-app = Reap::Application.new
+HELP = <<-END
+Usage: #{File.basename($0)} [options]
+
+Remove previsously installed gem. This is equivalent to
+
+  $ gem uninstall {project name}
+
+The reap command is provided as a convenience when testing
+gem installation using reap-install-gem.
+END
+
+if ARGV.include?('--help')
+  puts HELP
+else
+  app = Reap::Application.new
+  app.gem_uninstall
+end
 
-app.gem_uninstall

data/bin/reap-version

@@ -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.stamp
+end
 
-app.stamp

data/lib/reap/announcement.rb

@@ -0,0 +1,136 @@
+#require 'erb'
+
+module Reap
+
+  # = Announcement 
+  #
+  # Announcment class is used to generate an announcement message.
+  # By default this is a Release Announcment.
+
+  class Announcement
+
+    # Project metadata
+
+    attr_accessor :metadata
+
+    attr_accessor :cutoff
+
+    attr_accessor :template
+
+    #
+
+    def initialize(options={}, &block)
+      populate(options, &block)
+
+      @cutoff   ||= 30
+      @template ||= "{ANNOUNCE}{,.txt}"
+    end
+
+    # Make a release announcement. Generates and can email a release
+    # announcements. These are nicely formated message and can
+    # email the message to the specified address(es).
+    #
+    # The following settings apply:
+    #
+    #     template     Announcement file/template.
+    #     cutoff       Max number of lines of changelog to show.
+    #
+    # A template file can be specified that uses "$setting" as
+    # substitutes for poject information.
+
+    def message
+      template = Dir.glob(template(), File::FNM_CASEFOLD).first
+
+      if template
+        readme = File.read(template)
+        readme = unfold_paragraphs(readme)
+      else
+        readme = ''
+        #readme << "= #{metadata.title} v#{metadata.version}\n\n"
+        readme << "#{metadata.description}\n\n"
+        readme << "#{metadata.homepage}\n\n"
+        readme << "Please see the NOTES file.\n\n"
+        readme << "Please see the CHANGES file.\n"
+      end
+
+      # changelog
+      file   = Dir.glob('change{s,log}{,.txt}', File::FNM_CASEFOLD)[0]
+      changelog = file ? File.read(file).strip : ''
+      #changelog = unfold_paragraphs(changelog)
+      changelog = changelog.split("\n")[0..cutoff].join("\n")
+      unless changelog =~ /^=/
+        changelog = "\n== Changes\n\n" + changelog
+      end
+
+      # noteslog
+      file = Dir.glob('note{s,log}{,.txt}', File::FNM_CASEFOLD)[0]
+      notelog  = file ? File.read(file).strip : ''
+      notelog  = unfold_paragraphs(notelog)
+      unless notelog =~ /^=/
+        notelog = "\n== Release Notes\n\n" + notelog
+      end
+
+      # Strip tiny version zero.
+      #if keys['version'] =~ /[.].*?[.]/
+      #  keys['version'] = keys['version'].chomp('.0')
+      #end
+
+      # Make announcement message
+      message = readme.dup
+
+      #message.gsub!('$readme$', readme || '')
+      message.sub!(/^\s*please\ see(\ the)?\ notes(.*?)$/i, "\n" + notelog) if notelog
+      message.sub!(/^\s*please\ see(\ the)?\ change(.*?)$/i, "\n" + changelog) if changelog
+
+      template = message.dup
+
+      template.scan(/\$(\w+?)\$/m) do |key|
+        #key   = key.strip
+        name  = $1.strip #key[1..-1]
+        if metadata.respond_to?(name.downcase)
+          value = metadata.send(name.downcase)
+          message.gsub!("$#{name}$", value.to_s.strip)
+        else
+          puts "Warning: Unknown project metadata field -- #{name}."
+        end
+      end
+
+      message.gsub!(/(^|[ ])[$].*?(?=[ ]|$)/,'') # remove unused vars
+      message.gsub!(/\n\s*\n\s*\n/m,"\n\n")      # remove any triple blank lines
+      message.rstrip!
+ 
+      message = "\n" + message
+
+      return message
+    end
+
+    #
+
+    def unfold_paragraphs(string)
+      blank = false
+      text  = ''
+      string.split(/\n/).each do |line|
+        if /\S/ !~ line
+          text << "\n\n"
+          blank = true
+        else
+          if /^(\s+|[*])/ =~ line 
+            text << (line.rstrip + "\n")
+          else
+            text << (line.rstrip + " ")
+          end
+          blank = false
+        end
+      end
+      return text
+    end
+
+
+    def to_s
+      message
+    end
+
+  end
+
+end
+

data/lib/reap/application.rb

@@ -3,7 +3,9 @@
 module Reap
   require 'reap/project'
 
-  # Application is the commandline interface.
+  # = Application
+  #
+  # Application is the commandline interface to Project.
 
   class Application
 

data/lib/reap/default.yaml

@@ -1,16 +1,16 @@
-
-  announce:
-    template: '{ANNOUNCE}{,.txt}'                           # Announcement template file glob.
-    mail_to: rubytalk@ruby-lange.org                        # Email address(es) to send announcemnt.
-    mail_from: #{metadata.email}                            # Message FROM address.
-    subject: "%s v%s released"                              # Subject of email message. Sprintf'd against name and version.
+  email:
+    server: nil                                             # Email server to route message.
     account: #{metadata.email}                              # Email account name [email].
-    domain: rubyforge.org                                   # Your domain. (Not sure why one needs this for an email.)
-    server: smtp.goolge.com                                 # Email server to route message.
     port: 25                                                # Email server's port, if not secure.
-    port_secure: 465                                        # Email server's port, if secure.
     secure: false                                           # Uses TLS security, true or false?
     login: plain                                            # Login type: plain, cram_md5 or login.
+    domain: rubyforge.org                                   # Your domain. (Not sure why one needs this for an email.)
+    from: #{metadata.email}                                 # Message FROM address.
+    to: #{metadata.email}                                   # Email address(es) to send announcemnt.
+
+  announce:
+    subject: "%s v%s released"                              # Subject of email message. Sprintf'd against name and version.
+    template: '{ANNOUNCE}{,.txt}'                           # Announcement template file glob.
     cutoff: 30                                              # How many lines of changelog to provide.
 
   check:
@@ -47,8 +47,8 @@
     exclude: [.svn, scrap]                                  # Used as defaults for creating .rsync-filter (after that edit .rsync-filter)
 
   rdoc:
-    template: html                                          # Template to use.
-    output: doc/#{metadata.project}/rdoc                    # Where to save rdoc files.
+    template: ~                                             # Template to use (defaults to ENV['RDOC_TEMPLATE'] or 'html'
+    output: doc/rdoc                                        # Where to save rdoc files.
     main: 'README{,.txt}'                                   # Main file (pattern).
     inline: true                                            # Inline source?
     merge: true                                             # Merge code?
@@ -58,7 +58,7 @@
     targets: ~                                              # If you need more then one rdoc set, use targets.
 
   ri:
-    output: ri                                              # Where to save ri files.
+    output: doc/ri                                          # Where to save ri files.
     include: ~                                              # Defaults to metadata.loadpath.
     exclude: []                                             # Paths to specifically exclude.