reap 9.3.5 → 9.4.0

data/lib/reap/hosts/rubytalk.rb

@@ -0,0 +1,39 @@
+require 'reap/hosts/mailinglist'
+require 'reap/emailer'
+
+module Reap
+module Hosts
+
+  # = Rubytalk
+  #
+  # This is a Maklinglist host. It simply statically sets
+  # the ruby-talk@ruby-lang.org email address and passes
+  # on to it's superclass.
+
+  class RubyTalk < Mailinglist
+
+    register('ruby-talk', 'ruby-talk@ruby-lang.org')
+
+    EMAIL_ADDRESS = 'ruby-talk@ruby-lang.org'
+
+    # This sets the mailto address and passes on to the
+    # super class.
+    #
+    # See Mailinglist#announce.
+
+    def announce(options)
+      options = options.rekey(&:to_s)
+      options['mailto'] = EMAIL_ADDRESS
+      super(options)
+    end
+
+    def announce_confirm?(options={})
+      options = options.rekey(&:to_s)
+      options['mailto'] = EMAIL_ADDRESS
+      super(options)
+    end
+  end
+
+end
+end
+

data/lib/reap/iobject.rb

@@ -22,12 +22,14 @@
 #   along with Ratch.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'yaml'
-require 'facets/hash/rekey'
-
+require 'facets' #/hash/rekey
 
 module Reap
 
+  # = InfoObject
   #
+  # This a base class used by Metadata. It provides a more versitle 
+  # means of defining a data-oriented class.
 
   class InfoObject
 
@@ -107,7 +109,7 @@ module Reap
       instance_data.update(data.rekey(:to_s))
 
       data.each do |k,v|
-        send("#{k}=", v) rescue nil
+        send("#{k}=", v) if respond_to?("#{k}=")
       end
 
       # TODO Could add yield(self) via:

data/lib/reap/metadata.rb

@@ -22,6 +22,7 @@
 #   along with Ratch.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'facets/dir/multiglob'
+require 'facets/platform'
 require 'reap/iobject'
 
 module Reap
@@ -90,6 +91,9 @@ class Project
 
     def initialize(location, data={})
       @location = location
+
+      @autodoc = true
+
       super(data)
     end
 
@@ -128,7 +132,7 @@ class Project
     attr_accessor :description, :synopsis
 
     # "Unix" name of this project.
-    attr_accessor :project, :name
+    attr_accessor :project, :name, :unixname
 
     # Overrides Project#name.
     # TODO: Fit release name into name or package_name (?)
@@ -211,6 +215,12 @@ class Project
     end
 
 
+    # URI of host providers.
+    attr_accessor :hosts do
+      @hosts || {'rubyforge'=>{}, 'rubytalk'=>{} }
+    end
+
+
     # Version
     #------------------------------------------------------------------------
 
@@ -437,6 +447,15 @@ class Project
 
     attr_accessor :platform
 
+    def platform=(pl)
+      case pl.to_s.downcase
+      when 'current'
+        @platform = Platform.local.to_s
+      else
+        @platform = pl
+      end
+    end
+
     # Architecture(s) this package can be run on: any, i386, i686, ppc, etc.
     # This is strictly informational and is inteded to indicate the possiblities,
     # not the particular platform this package runs on.
@@ -451,7 +470,13 @@ class Project
     # Packages that are intended to compile on install may need this. It is a list
     # of "extension scripts" which generate Makefiles for use in compilation.
     attr_accessor :extensions do
-      [@extensions || Dir.glob(File.join(location, 'ext/**/extconf.rb'))].flatten.compact
+      @extensions ||= (
+        exts = []
+        Dir.chdir(location) do
+          exts = Dir.glob('ext/**/extconf.rb')
+        end
+        exts.flatten.compact
+      )
     end
 
     #
@@ -460,9 +485,11 @@ class Project
     #end
 
     # Generate documentation on installation?
-    attr_accessor :document, :has_rdoc
+    attr_accessor :autodoc, :has_rdoc
+
+    # Files to be documented.
+    attr_accessor :document
 
-    #
     #attr_accessor :package_directory, :package_store do
     #  @package_directory || 'pkg'
     #end

data/lib/reap/project.rb

@@ -2,6 +2,7 @@ module Reap
   require 'yaml'
   require 'rbconfig'
   require 'reap/utilities'
+  require 'reap/hosts'
 
   # = Project
   #
@@ -12,6 +13,8 @@ module Reap
   class Project
     require 'reap/metadata'
     require 'reap/settings'
+    require 'reap/defaults'
+    require 'reap/runmodes'
 
     # Load up the tools
     require "reap/project/announce.rb"
@@ -30,7 +33,6 @@ module Reap
     require "reap/project/spec.rb"
     require "reap/project/stats.rb"
     require "reap/project/scm.rb"
-    require "reap/project/svn.rb"
     require "reap/project/test.rb"
     require "reap/project/version.rb"
 
@@ -40,15 +42,15 @@ module Reap
 
     def initialize(options=nil)
       @options        = options || {}
-      begin
-        @location       = locate
-        raise LoadError, "no .reap configuration file" unless @location
 
-        @metadata = Metadata.read(location)
-        @settings = Settings.read(location, @metadata)
-      rescue LoadError => e
-        abort e.message.capitalize + '.'
-      end
+      @location       = locate
+
+      raise LoadError, "no .reap configuration file" unless @location
+
+      @metadata = Metadata.read(location)
+      @settings = Settings.read(location, @metadata)
+      @defaults = Defaults.new(@metadata)
+      @runmodes = RunModes.new(options)
     end
 
     # Location of project.
@@ -59,30 +61,35 @@ module Reap
 
     def metadata ; @metadata  ; end
 
-    # Configuration data.
+    # Task defaults.
+
+    def defaults ; @defaults ; end
+
+    # Task user settings.
 
     def settings ; @settings ; end
 
-    alias_method :configuration, :settings
+    # Run modes.
 
-    #alias_method :config, :configuration
+    def runmodes ; @runmodes ; end
 
     # Common options.
 
     def options  ; @options  ; end
+
     #alias_method :init_options, :options  # TODO: Improve me! (see stamp.rb)
 
-    def dryrun?     ; options['dryrun']  ; end
-    def trace?      ; options['trace']   ; end
-    def force?      ; options['force']   ; end
-    def verbose?    ; options['verbose'] ; end
-    def debug?      ; options['debug']   ; end
+    def dryrun?     ; runmodes.dryrun?  ; end
+    def trace?      ; runmodes.trace?   ; end
+    def force?      ; runmodes.force?   ; end
+    def verbose?    ; runmodes.verbose? ; end
+    def debug?      ; runmodes.debug?   ; end
 
-    def dryrun=(x)  ; options['dryrun']  = x ; end
-    def trace=(x)   ; options['trace']   = x ; end
-    def force=(x)   ; options['force']   = x ; end
-    def verbose=(x) ; options['verbose'] = x ; end
-    def debug=(x)   ; options['debug']   = x ; end
+    def dryrun=(x)  ; runmodes.dryrun  = x ; end
+    def trace=(x)   ; runmodes.trace   = x ; end
+    def force=(x)   ; runmodes.force   = x ; end
+    def verbose=(x) ; runmodes.verbose = x ; end
+    def debug=(x)   ; runmodes.debug   = x ; end
 
     alias_method :noharm?, :dryrun?
     alias_method :noharm=, :dryrun=
@@ -90,14 +97,22 @@ module Reap
     # Invoke a tool.
 
     def invoke(command, *args)
-      #display_location
-      meth = method(command)
-      chdir_to_project do
-        case meth.arity
-        when 0
-          meth.call
+      begin
+        #display_location
+        meth = method(command)
+        chdir_to_project do
+          case meth.arity
+          when 0
+            meth.call
+          else
+            meth.call(*args)
+          end
+        end
+      rescue LoadError => e
+        if trace?
+          raise e
         else
-          meth.call(*args)
+          abort e.message.capitalize + '.'
         end
       end
     end
@@ -137,10 +152,27 @@ module Reap
       args = options['arguments']
       if args
         args.each do |field|
-          puts metadata.send(field)
+          case field
+          when 'defaults'
+            y defaults
+          when 'settings'
+            y settings
+          when 'metadata'
+            y metadata
+          else
+            puts metadata.send(field)
+          end
         end
       else
-        y self
+        puts
+        puts "#{metadata.title} #{metadata.version}"
+        puts metadata.brief
+        puts metadata.homepage
+        puts
+        puts metadata.description
+        puts
+        puts metadata.copyright
+        puts
       end
     end
 
@@ -172,23 +204,51 @@ module Reap
       return loc
     end
 
-    #
+    # Tasks use this to automatically combine commandline options,
+    # user settings, defualts.
 
     def configure_options(options, *entries)
+      config = {}
+
+      entries.each do |entry|
+        config.update(defaults[entry] || {})
+      end
+
+      entries.each do |entry|
+        config.update(settings[entry] || {})
+      end
+
       options = (options || {}).rekey(&:to_s)
-      entries.inject(options) do |memo, entry|
-        (settings[entry] || {}).merge(memo)
+      config.update(options)
+
+      return config
+    end
+
+    # Access to selected hosts.
+
+    def hosts(select=nil)
+      @hosts ||= {}
+      select ||= metadata.hosts.keys
+      result = []
+      metadata.hosts.each do |key, options|
+        next unless select.include?(key)
+        host_class = options['type'] ? Hosts.registry[options['type']] : Hosts.registry[key]
+        next unless host_class
+        # cache hosts
+        @hosts[key] ||= host_class.from_project(self, options)
+        result |= [@hosts[key]]
       end
+      return result
     end
 
-    # Helper method for cleaning list options.
-    # This will split the option on ':' or ';'
-    # if it is a string, rather than an array.
-    # And it will make sure there are no nil elements.
+    # Access to project's scource control management system.
 
-    def list_option(option)
-      option = option.to_s.split(/[:;,]/) unless Array===option
-      [option].compact.flatten
+    def scm
+      @scm ||= (
+        if system = Systems.current
+          system.from_project(self, {}) #TODO: metadata.scm is a hash?
+        end
+      )
     end
 
   end

data/lib/reap/project/announce.rb

@@ -1,205 +1,75 @@
+require 'reap/announcement'
+
 module Reap
 
   class Project
-
-    # Make a release announcement. Generates and can email release
-    # announcements. The announcement if built from the README file
-    # unless another file is specified.
-    #
-    # This will subsititue the first line mathing /please see notes/i
+ 
+    # Generate and email a release announcement. The announcement
+    # text is read from ANNOUNCE{.txt} or another template file
+    # is specified, or if no template is given, the  announcemnet
+    # is automatically built from project metadata, ant the 
+    # CHANGES and NOTES files.
+    # 
+    # Templates support metadata substitutions using $name$ syntax.
+    # Also, it will subsititue the first line matching /please see notes/i
     # for the notelog. And /please see change/i for the changelog.
-    #
+    # 
     # The following settings apply:
-    #
-    #     title        Project title.
-    #     subtitle     Brief one-line description.
-    #     version      Project version.
-    #     description  Long description of project.
-    #     homepage     Project homepage web address.
-    #     slogan       Motto for you project.
-    #     memo         File that contains announcement message.
-    #     template     Announcement template file, rather then README.
-    #     mail_to      Email address(es) to send announcemnt.
-    #
-    # If <em>mail_to</em> is set then these also apply:
-    #
-    #     from         Message FROM address [email].
-    #     subject      Subject of email message ([ANN] title verison).
-    #     server       Email server to route message.
-    #     port         Email server's port.
-    #     domain       Email server's domain name.
-    #     account      Email account name [email].
-    #     login        Login type: plain, cram_md5 or login.
-    #     secure       Uses TLS security, true or false?
-    #
-    # A template file can be specified that uses "$setting" as
-    # substitutes for poject information.
+    # 
+    #    template     Announcement template file (ANNOUNCE.txt).
+    #    to           Email address(es) to send announcemnt.
+    # 
+    # If <em>mailto</em> is set then these also apply:
+    # 
+    #    from         Message FROM address [email].
+    #    subject      Subject of email message ([ANN] title verison).
+    #    server       Email server to route message.
+    #    port         Email server's port.
+    #    domain       Email server's domain name.
+    #    account      Email account name [email].
+    #    login        Login type: plain, cram_md5 or login.
+    #    secure       Uses TLS security, true or false?
+    # 
+    # The announcement will be printed to standard out before sending
+    # so it can be verified.
 
     def announce(options=nil)
-      options = configure_options(options, 'announce', 'mail')
-
-      message = announce_message(options)
-
-      options = options.to_ostruct
-
-      mail_to     = options.mail_to
-      mail_from   = options.mail_from
-      subject     = options.subject         # Subject line (default is "ANN: project version").
-      server      = options.server          # Email server
-      port        = options.port            # Emails server port (default is usually correct).
-      account     = options.account         # Email account name (defaults to mail_from).
-      domain      = options.domain          # User domain (not sure why SMTP requires this?)
-      login       = options.login           # Login type (plain, login)
-      secure      = options.secure          # Use TLS/SSL true or false?
-      password    = options.password || ENV['EMAIL_PASSWORD']
-
-      title       = options.title    || metadata.title
-      version     = options.versoin  || metadata.version
-
-      # defaults
-      subject ||= "%s, v%s release"
-      account ||= mail_from
-
-      subject = subject % [title, version]
+      options = configure_options(options, 'announce')
 
-      if dryrun?
-        puts "email '#{subject}'"
-        puts "\n#{message}\n\n" if verbose?
-      else
-        puts "\n#{message}\n\n"
-        if mail_to
-          ans = ask("Would you like to email this announcement?", "yN")
-          case ans.downcase
-          when 'y', 'yes'
-            email(message,
-              :to       => mail_to,
-              :from     => mail_from,
-              :subject  => subject,
-              :server   => server,
-              :port     => port,
-              :domain   => domain,
-              :account  => account,
-              :login    => login,
-              :secure   => secure,
-              :password => password
-            )
-          end
-        end
+      announcement = Announcement.new do |ann|
+        ann.cutoff   = options['cutoff']
+        ann.template = options['template']
+        ann.metadata = metadata
       end
-    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 announce_message(options={})
-      config  = settings['announce'] || {}
-      options = config.merge(options).to_ostruct
 
-      cutoff   = options.cutoff    || 30
-      template = options.template  || "{ANNOUNCE}{,.txt}"
-
-      #config['mail_to'] = nil if keys['mail_to'].empty?
-
-      # Build message
-
-      # template
-      template = Dir.glob(options.template.to_s, File::FNM_CASEFOLD).first
-
-      if template
-        readme = File.read(template)
-        readme = unfold_paragraphs(readme)
+      if dryrun?
+        puts "\n#{announcement.message}\n\n" if verbose?
       else
-        readme = ''
-        readme << "= #{metadata.title} v#{metadata.version}\n\n"
-        readme << "    #{metadata.homepage}\n\n"
-        readme << "#{metadata.description}\n\n"
-        readme << "Please see the NOTES file.\n\n"
-        readme << "== CHANGES\n\n"
-        readme << "Please see the CHANGES file.\n"
+        puts "\n#{announcement.message}\n\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")
-
-      # noteslog
-      file = Dir.glob('note{s,log}{,.txt}', File::FNM_CASEFOLD)[0]
-      notelog  = file ? File.read(file).strip : ''
-      notelog  = unfold_paragraphs(notelog)
-
-      # Strip tiny version zero.
-      #if keys['version'] =~ /[.].*?[.]/
-      #  keys['version'] = keys['version'].chomp('.0')
-      #end
-
-      # Make announcement message
-      message = readme.dup
+      options['message'] = announcement.message
+      options['version'] = metadata.version
 
-      #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
+      options['title']   ||= metadata.title
+      options['subject'] ||= "%s, v%s release"
+      options['subject'] = options['subject'] % [ options['title'], metadata.version ]
 
-      template = message.dup
+      actions = []
+      select  = options['hosts']
 
-      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 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!
-
-      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 + " ")
+      hosts(select).each do |host|
+        if host.respond_to?(:announce)
+          if host.announce_confirm?(options)
+            actions << lambda{ host.announce(options) }
           end
-          blank = false
         end
       end
-      return text
+
+      actions.each{ |a| a.call }
     end
 
   end
 
 end
 
-  #       keys = {}
-  #       keys['from'] = info.email
-  #       keys.update info.gather('mail')
-  #       keys.update info.gather('announce')
-  #       keys.update info.select(
-  #         :project, :version, :title, :subtitle, :description,
-  #         :homepage, :download, :slogan
-  #       )
-  #       keys.update override if override
-