reap 5.10.10 → 6.0.0

data/lib/reap/bin/reap.rb

@@ -1,18 +1,20 @@
 
-require 'facets'
 require 'rbconfig'
-require 'carat/shellcommand'
-require 'reap/tasks'
+require 'fileutils'
 
-INFO_FILES = [ 'ProjectInfo', 'Reapfile', 'projectinfo', 'reapfile' ]
+require 'facets'      # Next two may be moved in the future to:
+require 'consoleapp'  #  'console/command'
+require 'ansicode'    #  'console/ansicode'
+require 'string/tabto'
+require 'gem/self/gempath'
 
-Reap.register
+require 'reap/reap'
 
-module Reap
-  Version = "2005-10-06"
-end
+# ReapCommand is the CLI interface to Reap.
+
+class ReapCommand < Console::Command
 
-class ReapCommand < ShellCommand
+  INFO_FILES = [ 'ProjectInfo', 'projectinfo' ]
 
   # Options
 
@@ -20,15 +22,28 @@ class ReapCommand < ShellCommand
   def __verbose ; $VERBOSE = true ; end
   alias_method :_V, :__verbose
 
-  # debug mode (under construction)
-  def __debug; $DEBUG = true ; end
-  alias_method :_D, :__debug
+  # force mode
+  def __force ; $FORCE = true ; end
+  alias_method :_f, :__force
 
   # pretend mode (under construction)
+  #--
+  # A few tasks have some support for pretending
+  # but this has to be developed much more
+  # before it can be commonly avaialble.
+  # Notice it is not mentioned in the Help.
+  #++
   def __pretend; $PRETEND = true ; end
   alias_method :_P, :__pretend
 
-  # option to display version
+  # debug mode (under construction)
+  def __debug; $DEBUG = true ; end
+  alias_method :_D, :__debug
+
+  def __password( pass ); $PASSWORD =  pass ; end
+  alias_method :_p, :__password
+
+  # display reap version
   def __version ; version ; end
   alias_method :_v, :__version
 
@@ -39,96 +54,177 @@ class ReapCommand < ShellCommand
   # option to display tasks
   def __tasks; tasks ; end
   alias_method :_t, :__tasks
+  alias_method :_T, :__tasks
 
-  # option for require
-  #def __require(r); @require = r ; end
-  #alias_method :_r, :__require
+  #option for build version (only for package task)
+  def _b ; $BUILD_VERSION = true ; end
 
-  # Commands
+  #def _f( pif ) ; $PROJECT_FILE = pif ; end
+  #alias_method :_f, :__file
+
+  # Default subcommand is to display tasks.
 
-  # default action
   def default
     tasks
   end
 
-  # display version
+  # Display version.
+
   def version
-    puts "Reap  v.#{Reap::Version}"
-    exit 0
+    puts "Reap v#{Reap::Version}"
+    exit 0  # shortcuts execution when called via the --version option.
   end
 
-  # display help
+  # Display help.
+
   def help
     puts HELP
-    exit 0
+    exit 0 # shortcuts execution when called via the --help option.
   end
 
   # list available tasks
+
   def tasks
-    Reap.initialize #_all
-    puts
-    Reap.tasks.each do |name,task|
-      puts "  #{name}".ljust(20) + "#{task.task_desc}"
+    # TODO How to deal with windows or other ansi not support?
+    hi = Console::ANSICode.bold #+ Console::ANSICode.yellow
+    lo = Console::ANSICode.reset #+ Console::ANSICode.blue
+    re = Console::ANSICode.reset
+
+    tasklist = TaskSpace.visible_tasks
+    if tasklist.empty?
+      puts "No tasks available."
+    else
+      sorted = tasklist.collect{ |e| e.to_s }.sort
+      outlist = []
+      margin = sorted.collect{ |t| t.size }.max + 2
+      sorted.each do |name|
+        outlist << hi + " #{name}".ljust(margin) + lo + " #{TaskSpace.instance_task(name).description}" + re
+      end
+      puts "[from #{Dir.pwd}]"
+      #puts
+      puts outlist.join("\n")
+      #puts
     end
-    puts
-    exit 0
   end
-  alias_method :ls, :tasks
 
-  # copy the file from lib/data to the current dir.
-  def template
-    if INFO_FILES.any?{ |f| File.exists?(f) }
-      puts "Project file already exists."
-      exit 0
-    end
-    filename = 'ProjectInfo'
-    dir = File.join( ::Config::CONFIG['datadir'], 'reap', 'scaffold' )
-    f = File.join( dir, filename )
-    raise "ProjectInfo template file #{f} is missing." unless File.file?( f )
-    # copy
-    FileUtils.cp( f, filename )
-    puts "#{filename} created. You'll need to fill it out."
-    exit 0
-  end
+  # Command shows task dependencies.
 
-  Reap.registry.each do |sym,taskclass|
-    define_method(sym) do |*args|
-      taskclass.new.run(*args)
-    end
+  def prerequisite
+    Reap.tasks.each { |name, t|
+      print name
+      print " => "
+      puts TaskSpace.instance_task(name.to_sym).prerequisite.inspect
+    }
   end
 
-end
-
-
-HELP = <<-HERE
-
-  reap v#{::Reap::Version}
-
-  USAGE: reap [options...] <command> [arguments...]
-
-  COMMANDS:
+  # Define a CLI callable method for each described tasks.
+  #
+  # NOTE The use of the launcher class seems a touch hackish,
+  # and indicates to me that there might be a better
+  # way to organize the tasks, but as long as it works!
 
-    scaffold
-        Copies a ProjectInfo template into the current
-        directory, if it doesn't already exist. If it does
-        exist will build the project directory based on it.
-        This will not destroy any structure already in place!
+  launcher = Class.new{ include TaskSpace }.new()
 
-    help
-        Displays this help information.
-
-  OPTIONS:
-
-    -v --version
-        Display the current version.
-
-    -V --verbose
-        Provides extra verbose processing information.
-
-    -D --debug
-        Provides extra verbose processing information.
+  TaskSpace.visible_tasks.each do |t|
+    define_method(t) do |*args|
+      launcher.send(t, *args)
+    end
+  end
 
-    -h --help
-        Display this help information.
+  # Help text
+
+  HELP = <<-HERE.tabto(2)
+
+    reap [options...] <command> [arguments...]
+
+    COMMANDS:
+
+      tasks
+        List all the current tasks with descriptions.
+        (This is the default if no command is given.)
+
+      help [type]
+        Displays this help information. If a task type is given, it
+        will provide help information specific to that kind of task.
+
+    OPTIONS:
+
+      -h --help      Display this help information.
+      -v --version   Display the current version.
+      -V --verbose   Provides extra verbose processing information.
+      -f --force     Forces certain operations to be performed.
+      -D --debug     Provides extra verbose processing information.
+      -f --file      Specify alternate project file.
+
+  HERE
+
+#--
+#
+#   HELP = <<-HERE.tabto(2)
+#
+#     reap [options...] <command> [arguments...]
+#
+#     COMMANDS:
+#
+#       tasks
+#         List all the current tasks with descriptions.
+#         (This is the default if no command is given.)
+#
+#       scaffold [type]
+#         Generates a project directory layout within the current
+#         directory. For more details type 'reap help scaffold'.
+#
+#       template | projectinfo
+#         Create a ProjectInfo template file in the current directory
+#         Unlike 'scaffold', this is especially useful for pre-existing
+#         projects.
+#
+#       help [type]
+#         Displays this help information. If a task type is given, it
+#         will provide help information specific to that kind of task.
+#
+#     OPTIONS:
+#
+#       -h --help      Display this help information.
+#       -v --version   Display the current version.
+#       -V --verbose   Provides extra verbose processing information.
+#       -f --force     Forces certain operations to be performed.
+#       -D --debug     Provides extra verbose processing information.
+#       -f --file      Specify alternate project file.
+#
+#   HERE
+#
+#   HELP_SCAFFOLD = <<-HERE.tabto(2)
+#
+#     reap scaffold [type]
+#
+#     Generates a project directory layout within the current
+#     directory. The scaffolding includes all the standard
+#     features such as directories lib/ bin/ doc/ and files
+#     like README.
+#
+#     To use this task you should first create an empty
+#     directory and than change into it. This command will
+#     not create a new project directory. As a safegaurd, this
+#     command will not generate scaffolding in a directory with
+#     files already present, unless you use the -f (force) option.
+#
+#     There are currently two types of supported scaffoldings:
+#     'standard', which is the default if no type is given,
+#     and 'subversion' which creates a "trunk" hierarchy.
+#
+#   HERE
+#
+#   HELP_TEMPLATE = <<-HERE.tabto(2)
+#
+#     reap template | reap projectinfo
+#
+#     Create a ProjectInfo template file in the current directory
+#     Unlike 'scaffold', this is especially useful for pre-existing
+#     projects.
+#
+#   HERE
+#
+#++
 
-HERE
+end

data/lib/reap/bin/rubytest.rb

@@ -0,0 +1,53 @@
+
+require 'test/unit'
+require 'facet/consoleapp'
+
+# Run commented tests.
+#
+#--
+# One wonders if this should be built as a Test::Unit::CommentAutoRunner
+#++
+
+class RubyCommentTester < Console::Application
+
+  RETEST = /^=begin\s+test.*?\n(.*)\n=end/mi
+
+  # option to display help
+  def __verbose ; $VERBOSE = true ; end
+  alias_method :_v, :__verbose
+
+  # option to display help
+  def __help
+    puts HELP
+    exit 0
+  end
+  alias_method :_h, :__help
+
+  def main( *filepaths )
+    filepaths.each { |fp|
+      run_comment_test( fp )
+    }
+  end
+
+private
+
+  def run_comment_test( filepath )
+    code = File.read( filepath )
+    test_code = nil
+    md = RETEST.match( code )
+    test_code = md[1] if md
+    unless test_code
+      puts "No test found for #{filepath}."
+      return nil
+    end
+    offset = code.split(/\n/).size - test_code.split(/\n/).size - 1
+
+    require filepath
+    eval test_code, TOPLEVEL_BINDING, File.basename(filepath), offset
+  end
+
+end
+
+HELP = <<-EOS
+  rubytest filename [filename ...]
+EOS

data/lib/reap/class/announce.rb

@@ -0,0 +1,220 @@
+#--
+#    _
+#   /_\  _ _  _ _  ___ _  _ _ _  __ ___
+#  / _ \| ' \| ' \/ _ \ || | ' \/ _/ -_)
+# /_/ \_\_||_|_||_\___/\_,_|_||_\__\___|
+#
+#++
+
+require 'net/smtp'
+
+require 'facet/string/margin'
+require 'facet/string/tab'
+require 'facet/string/align_center'
+require 'facet/string/fold'
+require 'facet/string/word_wrap'
+
+module Reap
+
+  # = Announce
+  #
+  # The announce task is intended for sending out a nice
+  # formated email message to a mailing address, especially
+  # mailing-lists.
+  #
+  # Announcement specific settings:
+  #
+  #     server       Email server to route message.
+  #     port         Email server's port.
+  #     domain       Email server's domain name.
+  #     account      Email account name.
+  #     type         Login type, either plain, cram_md5 or login.
+  #     secure       Uses TLS security, true or false?
+  #     to           Email address to send announcemnt.
+  #     from         Email address sent from.
+  #     subject      Subject of email message.
+  #     links        Array of http links to related sites.
+  #     file         File that contains announcement message.
+  #     memo         Embedded announcement message.
+  #     slogan       Motto for you project.
+  #
+  # Inherited settings:
+  #
+  #     title        Project title.
+  #     summary      Brief one-line description.
+  #     description  Long description of project.
+  #     homepage     Project homepage web address.
+  #
+
+  class Announce
+
+    include TaskUtils
+
+    attr :anc
+
+    def initialize( anc )
+      @anc = anc.to_openobject
+
+      anc.to       = (anc.to || 'ruby-talk@ruby-lang.org').to_s.strip
+      anc.from     = anc.from.to_s.strip
+      anc.server   = anc.server.to_s.strip
+      anc.port     = (anc.port || 25).to_i
+      anc.domain   = anc.domain.to_s.strip if anc.domain
+      anc.account  = anc.account.to_s.strip
+      anc.type     = (anc.type || 'plain').to_s.strip  #cram_md5 #plain #login
+
+      #anc.title    ||= master.title
+      #anc.version  ||= master.version || master.date
+      anc.links    ||= []
+      anc.subject  ||= "[ANN] #{anc.title}, v#{anc.version}"
+
+      anc.address = anc.to  # TODO
+    end
+
+    # Validate data.
+
+    def valid?
+      return false, "server is a require announce field" if anc.server.empty?
+      return false, "account is a require announce field" if anc.account.empty?
+      #return false, "DOMAIN is a required field" if anc.domain.empty?
+      true
+    end
+
+    def call ; write_and_email ; end
+
+    # Generate announcement and email it.
+
+    def write_and_email
+
+      message = build_message
+
+      puts "\n#{message}\n\n"
+      print "Send? [y/N] "
+      until inp = $stdin.gets[0,1] ; sleep 1 ; end
+
+      unless inp.downcase == 'y'
+        puts "Reap announce task canceled."
+        return nil
+      end
+
+      # ask for password
+      print "Password for #{anc.account}: "
+      until passwd = $stdin.gets.strip ; sleep 1 ; end
+
+      mail = %Q{
+        |From: #{anc.from}
+        |To: #{anc.address}
+        |Subject: #{anc.subject}
+        |
+        |#{message}
+        }.margin
+      begin
+        # --- Send using SMTP object and an adaptor
+        Net::SMTP.enable_tls if Net::SMTP.respond_to?(:enable_tls) and anc.secure # == :tls
+        Net::SMTP.start(anc.server, anc.port, anc.domain, anc.account, passwd, anc.type) do |s|
+          s.send_message mail, anc.from, anc.address
+        end
+        puts "Email sent successfully to #{anc.address}."
+      rescue => e
+        puts "Email delivery failed."
+        puts e
+      end
+
+    end
+
+  private
+
+    def build_message
+
+      ver = anc.version.chomp('.0').chomp('.0')
+
+      # header
+      announce = %Q{
+        |
+        |A N N O U N C I N G
+        |
+        |#{anc.title} #{ver}
+        |
+        |#{anc.summary}
+        |
+        |#{anc.homepage}
+        }.margin.align_center(66)
+
+      # abstract
+      abstract = ''
+      if anc.description
+        abstract << "\n\n"
+        abstract << "ABSTRACT\n--------\n\n#{anc.description}"
+        abstract << "\n"
+      end
+
+      # more info
+      info = ''
+      unless anc.links.empty?
+        info << "\n\n"
+        info << "\nRELATED LINKS\n-------------\n\n" #.center(67)
+        anc.links.each{ |mi| info << "#{mi}" << "\n" } #.center(67) << "\n" }
+        info << "\n"
+      end
+
+      # slogan
+      slogan = ''
+      if anc.slogan
+        slogan << "\n\n"
+        slogan << anc.slogan.center(67)
+        slogan << "\n\n"
+      end
+
+      # memo
+      memo = ''
+      if anc.memo
+        memo = ''
+        #memo << "\n---\n" #<< ('-' * 72) << "\n"
+        memo << "\nRELEASE MEMO\n------------\n\n"
+        memo << anc.memo.strip.fold(true) #.word_wrap(67)
+        #memo << "\n"
+      end
+
+      # msg file
+      msg = ''
+      if anc.file and File.file?( anc.file )
+        msg << "\nRELEASE MEMO\n------------\n\n"
+        #msg << "\n---\n" #<< ("-" * 68) << "\n"
+        #msg << "(from #{anc.file})\n\n"
+        mg = File.read( anc.file )
+        msg << mg.strip.fold(true) #.word_wrap(67)
+      end
+
+      # stamp
+      stamp = "\n\n\n"
+      #stamp << "\n\n---\n" #<< ("-" * 68) << "\n"
+      stamp << %q{
+        !               Generated by
+        !            ___
+        !           | _ \___ __ _ _ __
+        !           |   ) -_) _` | '_ \
+        !           |_|_\___\__,_| .__)
+        !                        |_|
+        !
+        !       The Ruby Project Assistant
+        !
+        ! Do you Ruby? (http://www.ruby-lang.org)
+        }.margin(12) #.indent(12)
+      stamp << "\n"
+
+      message = ''
+      message << announce
+      message << slogan
+      message << abstract
+      message << memo
+      message << msg
+      message << info
+      message << stamp
+
+      message
+    end
+
+  end
+
+end #module Reap
+