reap 6.0.2 → 9.2.0

data/lib/reap/utilities/netutils.rb

@@ -0,0 +1,221 @@
+# = TITLE:
+#
+#   Networking Utility Functions
+#
+# = COPYING:
+#
+#   Copyright (c) 2007,2008 Tiger Ops
+#
+#   This file is part of the Reap program.
+#
+#   Reap is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   Reap is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with Reap.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'net/smtp'
+require 'timeout'
+begin
+  require 'openssl'
+rescue LoadError
+end
+
+#
+module Reap
+module Utilities
+
+  module NetUtils
+
+    # Email function to easily send out an email.
+    #
+    # Settings:
+    #
+    #     subject      Subject of email message.
+    #     from         Message FROM address [email].
+    #     to           Email address to send announcemnt.
+    #     server       Email server to route message.
+    #     port         Email server's port.
+    #     port_secure  Email server's port.
+    #     domain       Email server's domain name.
+    #     account      Email account name if needed.
+    #     password     Password for login..
+    #     login        Login type: plain, cram_md5 or login [plain].
+    #     secure       Uses TLS security, true or false? [false]
+    #     message      Mesage to send -or-
+    #     file         File that contains message.
+
+    def email(message, settings)
+      settings ||= {}
+      settings.rekey
+
+      server    = settings[:server]
+      account   = settings[:account]  || ENV['EMAIL_ACCOUNT']
+      passwd    = settings[:password] || ENV['EMAIL_PASSWORD']
+      login     = settings[:login]
+      subject   = settings[:subject]
+      mail_to   = settings[:to]     || settings[:mail_to]
+      mail_from = settings[:from]   || settings[:mail_from]
+      secure    = settings[:secure]
+      domain    = settings[:domain] || server
+
+      port      = (settings[:port_secure] || 465) if secure
+      port      = (settings[:port] || 25) unless secure
+
+      account ||= mail_from
+      login   ||= :plain
+
+      login = login.to_sym
+
+      #mail_to = nil if mail_to.empty?
+
+      raise ArgumentError, "missing email field -- server"  unless server
+      raise ArgumentError, "missing email field -- account" unless account
+      raise ArgumentError, "missing email field -- subject" unless subject
+      raise ArgumentError, "missing email field -- to"      unless mail_to
+      raise ArgumentError, "missing email field -- from"    unless mail_from
+
+      passwd ||= password("#{account} password:")
+
+      mail_to = [mail_to].flatten.compact
+
+      msg = ""
+      msg << "From: #{mail_from}\n"
+      msg << "To: #{mail_to.join(';')}\n"
+      msg << "Subject: #{subject}\n"
+      msg << ""
+      msg << message
+
+      if secure
+        Net::SMTP.send(:include, Net::SMTP::TLS)
+        Net::SMTP.enable_tls #if secure #if Net::SMTP.respond_to?(:enable_tls) and secure
+      end
+
+      begin
+        Net::SMTP.start(server, port, domain, account, passwd, login) do |smtp|
+          smtp.send_message(msg, mail_from, mail_to)
+        end
+        puts "Email sent successfully to #{mail_to.join(';')}."
+        return true
+      rescue => e
+        if trace?
+          raise e
+        else
+          abort "Email delivery failed."
+        end
+      end
+    end
+
+  end
+
+end
+end
+
+
+module Net #:nodoc: all
+  class SMTP
+    module TLS
+
+      def self.included(base)
+        base.extend(ClassMethods)
+
+        @usetls = base.use_tls?
+      end
+
+      module ClassMethods
+        def self.extended(base)
+          base.disable_tls
+        end
+
+        def enable_tls()
+          @@usetls = true
+        end
+
+        def disable_tls()
+          @@usetls = false
+        end
+
+        def use_tls?()
+          @@usetls
+        end
+      end
+
+      def use_tls?()
+        @usetls
+      end
+
+      def enable_tls()
+        @usetls = true
+      end
+
+      def disable_tls()
+        @usetls = false
+      end
+
+      def use_tls?()
+        @usetls
+      end
+
+      private
+      def do_start(helodomain, user, secret, authtype)
+        raise IOError('SMTP session already started') if @started
+        check_auth_args user, secret, authtype if user or secret
+
+        sock = timeout(@open_timeout) {TCPSocket.open(@address, @port) }
+        @socket = Net::InternetMessageIO.new(sock)
+        @socket.read_timeout = @read_timeout
+        @socket.debug_output = STDERR
+
+        check_response(critical {recv_response() } )
+        do_helo(helodomain)
+
+        if @@usetls
+          raise 'openssl is not installed' unless defined?(OpenSSL)
+          ssl = OpenSSL::SSL::SSLSocket.new(sock)
+          starttls
+          ssl.sync_close = true
+          ssl.connect
+
+          @socket = Net::InternetMessageIO.new(ssl)
+          @socket.read_timeout = @read_timeout
+          @socket.debug_output = STDERR
+          do_helo(helodomain)
+        end
+
+        authenticate user, secret, authtype if user
+        @started = true
+      ensure
+        @socket.close if not @started and @socket and not @socket.closed?
+      end
+
+      def do_helo(helodomain)
+        begin
+          if @esmtp
+            ehlo helodomain
+          else
+            helo helodomain
+          end
+        rescue Net::ProtocolError
+          if @esmtp
+            @esmtp = false
+            @error_occured = false
+            retry
+          end
+          raise
+        end
+      end
+
+      def starttls
+        getok('STARTTLS')
+      end
+    end
+
+  end
+end

data/lib/reap/utilities/setuputils.rb

@@ -0,0 +1,124 @@
+# = TITLE:
+#
+#   Setup DSL
+#
+# = SYNOPSIS:
+#
+#   Mixen used to setup a package, eg. a manual install.
+#
+# = COPYING:
+#
+#   Copyright (c) 2007,2008 Tiger Ops
+#
+#   This file is part of the Reap program.
+#
+#   Reap is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   Reap is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with Reap.  If not, see <http://www.gnu.org/licenses/>.
+
+#
+module Reap
+module Utilities
+
+  # = Setup DSL
+  #
+  # Setup utilities provides a convenient way to install
+  # a ruby project via setup.rb.
+
+  module SetupUtils
+
+    # Installation to a prefix destination using setup.rb.
+    # Some package types may need this.
+
+    def prefix_install(prefix)
+      mkdir_p(prefix)
+
+      unless setup_rb
+        raise "Setup.rb is missing. Forced to abort."
+      end
+      # mock install
+      cmd = ''
+      cmd << 'ruby setup.rb '
+      cmd << '-q ' unless project.verbose?
+      cmd << 'config --installdirs=std ; '
+      cmd << 'ruby setup.rb '
+      cmd << '-q ' unless project.verbose?
+      cmd << "install --prefix=#{prefix}"
+      sh cmd
+    end
+
+    # If setup.rb is not found add a copy to the project.
+    # FIXME
+
+    def setup_rb
+      unless File.exist?('setup.rb')
+        f = File.join(libdir,'vendor','setup.rb')
+        if File.exist?(f)
+          cp(f,'.')
+        else
+          raise "setup.rb is not avaialble"
+        end
+      end
+      true
+    end
+
+    #     # Setup and install. This builds and installs a project
+    #     # using setup.rb or install.rb. If neither exist setup.rb
+    #     # will be created for the purpose.
+    #     #
+    #     #     options    Command line options to add to shell command.
+    #     #     script     Install script, default is install.rb or setup.rb
+    #     #--
+    #     #     source     Location of source. (Defaults to current directory)
+    #     #++
+    #
+    #     def setup(keys={})
+    #
+    #       options = keys['options']
+    #       script  = keys['script']
+    #       #source = keys.source || Dir.pwd
+    #
+    #       options = [options].flatten.compact
+    #
+    #       if script
+    #         exe = script + ' '
+    #         exe << options.join(' ')
+    #       elsif File.exist?('install.rb')
+    #         exe = 'ruby install.rb '
+    #         exe << options.join(' ')
+    #       elsif File.exist?('setup.rb') or setup_rb
+    #         exe = 'ruby setup.rb '
+    #         exe << '-q ' unless verbose?
+    #         exe << options.join(' ')
+    #         exe << ' all'
+    #       else
+    #         puts "Script setup.rb or install.rb is missing."
+    #         return nil
+    #       end
+    #
+    #       # SHELLS OUT!
+    #
+    #       #Dir.chdir(source) do
+    #         #begin
+    #           success = sh(exe)
+    #           puts "Installation complete!" if success
+    #         #rescue Errno::EACCES
+    #         #  puts "Permission denied"
+    #         #  exit -1
+    #         #end
+    #       #end
+    #     end
+
+  end
+
+end
+end

data/lib/reap/utilities/shellutils.rb

@@ -0,0 +1,175 @@
+# = TITLE:
+#
+#   ShellUtils
+#
+# = COPYING:
+#
+#   Copyright (c) 2007,2008 Tiger Ops
+#
+#   This file is part of the Reap program.
+#
+#   Reap is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   Reap is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with Reap.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'reap/extensions'
+
+module Reap
+module Utilities
+
+  module OptionUtils
+    attr_accessor :dryrun
+    attr_accessor :trace
+    attr_accessor :force
+    attr_accessor :verbose
+
+    def dryrun?  ; @dryrun  ; end
+    def trace?   ; @trace   ; end
+    def force?   ; @force   ; end
+    def verbose? ; @verbose ; end
+  end
+
+  #
+
+  module ShellUtils
+    include OptionUtils
+
+    # Internal status report.
+    # Only output if dryrun or trace mode.
+
+    def status(message)
+      puts message if dryrun? or trace?
+    end
+
+    # Shell runner.
+
+    def sh(cmd)
+      if dryrun?
+        puts cmd
+        true
+      else
+        puts "--> system call: #{cmd}" if trace?
+        system(cmd)
+      end
+    end
+
+    # Convenient method to get simple console reply.
+
+    def ask(question, answers=nil)
+      print "#{question}"
+      print " [#{answers}] " if answers
+      until inp = $stdin.gets ; sleep 1 ; end
+      inp.strip
+    end
+
+    # Ask for a password. (FIXME: only for unix so far)
+
+    def password(prompt=nil)
+      msg ||= "Enter Password: "
+      inp = ''
+
+      print "#{prompt} "
+
+      begin
+        #system "stty -echo"
+        #inp = gets.chomp
+        until inp = $stdin.gets
+          sleep 1
+        end
+      ensure
+        #system "stty echo"
+      end
+
+      return inp.chomp
+    end
+
+#     # No fuss access to ARGV. This shows up as #commandline in the reap api.
+#     #
+#     # Ratch uses '=' for parameterized flags b/c this make parsing stupid simple
+#     # and that's a good thing!!! However you can use value! if need be.
+#
+#     def commandline
+#       @commandline ||= ArgVector.new(ARGV)
+#     end
+#
+#     alias_method :argument_vector, :commandline
+#
+#     # Duplicate of ARGV.
+#
+#     def argv
+#       @argv ||= ARGV.dup
+#     end
+#
+#     # Convert command line argv to args.
+#     #
+#     # TODO Is this implmented as expected?
+#
+#     def command_parameters
+#       argv.to_params
+#     end
+
+#     # Debug mode.
+#
+#     def debug?
+#       @debug ||= %w{--debug}.any?{|a| argv.delete(a)}
+#     end
+#
+#     #
+#
+#     def verbose?
+#       @verbose ||= %w{--verbose}.any?{|a| argv.delete(a)}
+#     end
+#
+#     #
+#
+#     def verbose!
+#       @verbose = true
+#     end
+#
+#     #
+#
+#     def trace?
+#       @trace ||= %w{--trace}.any?{|a| argv.delete(a)}
+#     end
+#
+#     #
+#
+#     def trace!
+#       @trace = true
+#     end
+#
+#     #
+#
+#     def noharm?
+#       @noharm ||= %w{--dryrun --dry-run --noharm}.any?{|a| argv.delete(a)}
+#     end
+#     alias_method :dryrun?, :noharm? ; module_function :dryrun?
+#
+#    #
+#
+#     def noharm!
+#       @noharm = true
+#     end
+#     alias_method :dryrun!, :noharm! ; module_function :dryrun!
+#
+#     # Force mode.
+#
+#     def force?
+#       @force ||= %w{--force}.any?{|a| argv.delete(a)}
+#     end
+#
+#     def force! ; @force = true ; end
+
+  end
+
+end
+end

data/log/Changelog.txt

@@ -0,0 +1,107 @@
+= Subversion Changelog
+
+== 2008-02-06  transami
+
+* Added logs. (106)
+* Added some work/scrap for old extest script. (105)
+* Added reap-init which is used to create .reap and meta/project files. (104)
+* Added some scaffolding files. (103)
+* Move where load error is triggered if no .reap file found. (102)
+* Only remove old stage is alrady exists. (101)
+* Added default title attribute for rdoc. (100)
+* Announce now uses README as tempalte by default and subs "please see" clauses for files. (99)
+* Fixed scaffold.rb to be at least amrginally useful now. (98)
+* Fixed dryrun? mode for generating changelog xsl. (97)
+* Improved release task's ability to select the correct packages. (96)
+* reap-scaffold is used to fully scaffold a project AFTER .reap and project files are in place. (95)
+* Added data/reap/init for initial .reap and meta/project files. (94)
+* Added .roll file. (93)
+* Minor fix so that if .reap is an empty file configuration will be {}. (92)
+* Loadpath and libpath are no longer the same project attribute.
+* Rolls uses libpath to point directory to the directory that contains the library files. (eg. lib/foo)
+* Loadpath is the traditional location that is usually a directory about the libpath. (eg. lib) (91)
+* Updated manager.rb to reflect scaffold rather then prefab. (90)
+* out_of_date? return true if no comparison files are found. (89)
+* Moved reap-prefab binary to reap-scaffold. (88)
+* Renamed prefab to scaffold. (87)
+* Added ability for rdoc to generate for different target groups. (86)
+* Use shell out to testrb for normal unit testing. (85)
+* Update prefab.rb. (84)
+
+== 2008-02-05  transami
+
+* Removed meta/config.yaml, since .reap now takes its place. (83)
+* Added work/outdated. (82)
+* Finish organization of work directory. (81)
+* Additional organization of work directory. (80)
+* Orgainze work directory a bit. (79)
+
+== 2008-02-04  transami
+
+* VERSION 9.1.2 (78)
+* Improved changelog production (cont.) (77)
+* Fixed a reference to the package directory (pkg/). (76)
+* Reworked change log a bit, simplifying configuration. (75)
+* Package direcotory is now fixed as pkg/.
+* Reap offers a lot optional configuration, but project directories are (mostly) better as standards.
+* If there proves a real need for an excpetion to this, we can revisit it later.
+* The #package_directory field really did not belong in the Project class anyway. (74)
+* Added work/future direcotory to diff between old code being help for reference. (73)
+* SVN text-based changelog is not built from the XML (using REXML). (72)
+* Removed old crufy code from manager.rb. (71)
+* Project#package_name no longer supports template argument. (70)
+* Improved DEFAULT for a number of tools. (69)
+* Clean no longer confirms file removeals. (68)
+* Fixed misspelling of rubyopt in spec.rb. (67)
+* Improved DEFAULT settings for rdoc.rb. (66)
+* Make will create the Makefile if needed for all make commands. (65)
+* Limit check tools to ruby code. (Maybe add C support in future). (64)
+* Added ARGV to shell out of install/setup command. (63)
+
+== 2008-02-01  transami
+
+* VERSION 9.1.0 (62)
+* Stamp now puts parenthesis around date. (61)
+* Fixed release and made package direcorty setting part of Project info. (60)
+* Fixed reubyforge release so changelog and notelog were used. (59)
+* Created NOTES for release notes. (58)
+* Moved rubyforge.rb to systems directory. (57)
+* Added manifest generation when packaging. (56)
+* Continued improvments across the board. (55)
+* Move scrap utils libs to new work/lib directory. (54)
+* Added work/lib/reap/. (53)
+* Added work/lib directory. (52)
+* Added subversion system. (51)
+* Moved ads to ads directory. (50)
+
+== 2008-01-31  transami
+
+* Moved MANIFEST and VERSION to toplevel. (49)
+* Adjusted project file. (48)
+* Added premature exits for task that arn't quite ready yet. (47)
+* Moved setup.rb and install.rb to subdirectories. (46)
+* Fleshed out skeleton directories in data/. (45)
+* Require notes.rb changed to log.rb. (44)
+* Renamed notes.rb to log.rb. (43)
+* Update package and rdoc tasks to access configuration better. (42)
+* Added spec tasks. (41)
+* Update notes.rb for log tasks. Will rename. (40)
+* Clean up tasks. (39)
+* Update VERSION to 9.0.0 beta. (38)
+* Added remaining binaries. (37)
+* Okay, final naming organization of binaries. (36)
+* Added doc/ads directory. (35)
+* Fixed misspelling of syntax. (34)
+* Moved reap-load and reap-sytax to reap-check-load and reap-check-syntax. (33)
+* Renamed reap-gem to reap-install-gem (32)
+* Cleaned make.rb code a bit. (31)
+* Harmonized how options are merged. (30)
+
+== 2008-01-29  transami
+
+* Added make commands. (29)
+
+== 2008-01-27  transami
+
+* initial import (28)
+

data/log/FIXME.txt

@@ -0,0 +1,25 @@
+
+= FIXME
+
+file://lib/reap/manager/check.rb
+* FIXME: This isn't routing output to dev/null as expected. (60)
+
+file://lib/reap/manager/gem.rb
+* FIXME (156)
+
+file://lib/reap/manager/log.rb
+* FIXME Should each label of note be written to it's own file? (22)
+
+file://lib/reap/manager/pack.rb
+* FIXME: will type, name and version always be right? (155)
+* FIXME: will type, name and version always be right? (170)
+* FIXME: Not yet ready for use. (129)
+
+file://lib/reap/manager/prefab.rb
+* FIXME: RubyGems has a new way to do this. Use that instead and fix Rolls to use it too. (97)
+* FIXME: Make safer (currently this is not available) (66)
+* FIXME: This doesn't yet work b/c reap doesn't work unless
+a project file is already in place. (28)
+
+file://lib/reap/utilities/setuputils.rb
+* FIXME (60)