reap 4.3.4 → 4.4.0

data/lib/reap/task/doap.rb

@@ -1,6 +1,14 @@
 
 module Reap
 
+  # = Doap task
+  # 
+  # This task  simply generates an XML DOAP project file.
+  # This file can be useful for RSS and Atom feeds to 
+  # project tracking sites. The task utilizes as much
+  # information as it can from the ProjectInfo file.
+  #
+
   class Doap < Task
 
     task_desc %{Generate DOAP project file.}
@@ -16,17 +24,10 @@ module Reap
 
     }
 
-    task_attr :prj
-
-    # Setup doap data
-
-    def init
-
-    end
-
-    # Generate doap file
+    alias_method :prj, :task
 
     def run
+
       puts "Generating doap.xml file..."
 
       x = ''
@@ -60,8 +61,10 @@ module Reap
             }.margin
 
       File.open( "doap.xml", 'w' ) { |f| f << x }
+
     end
 
   end
 
 end
+

data/lib/reap/task/{testext.rb → extest.rb}

@@ -3,6 +3,8 @@
 require 'reap/task'
 require 'facet/string/margin'
 
+require 'facet/progressbar'
+
 #  _____       _     ___     _       _____        _
 # |_   _|__ __| |_  | __|_ _| |_    |_   _|_ _ __| |__
 #   | |/ -_|_-<  _| | _|\ \ /  _|_    | |/ _` (_-< / /
@@ -12,65 +14,69 @@ require 'facet/string/margin'
 # = Test Extraction Task
 #
 # The Reap extract test task scans every package script
-# looking for =begin testing ... =end sections.
+# looking for =begin test... =end sections.
 # With appropriat headers, it copies these sections
 # to files in the test dir, which then can be run
-# using the Reap test taks.
+# using the Reap test task.
 #
-class Reap::TestExt < Reap::Task
+class Reap::ExTest < Reap::Task
 
-  task_desc "Extract unit-tests from lib scripts."
+  task_desc "Extract embedded unit tests from scripts."
 
   task_help %{
 
-    reap testext
+    reap extest
 
     Extracts embedded tests from program files and places them
     in the test directory. The exact layout of files is reflected
     in the test directory. You can then use Reap's test task to
     run the tests.
 
-      dir        Specify the test directory.
-                 Default is 'test'.
-
-      files      Specify files to extract.
-                 Default is 'lib/**/*.rb'.
+      dir        Specify the test directory. Default is 'test'.
+      files      Specify files to extract. Default is 'lib/**/*.rb'.
 
   }
 
-  #attr_accessor :dir, :files, :options
+  alias_method :tst, :task
+
+  def run
 
-  task_attr :tst
+    # setup
 
-  def init
     tst.dir    ||= 'test'
     tst.files  ||= [ 'lib/**/*.rb' ]
-    #tst.options
-  end
+    tst.files = [ tst.files ].flatten
+    #tst.options ?
+
+    # text extract
 
-  def run
     #test_libs = tst.libs.join(':')
     files = FileList.new
     files.include(*tst.files)
     if files.empty?
-      puts "No script files found."
+      tell "No script files found."
       return
     end
-    print "Reap is scanning and copying embedded tests..."
+
+    tell "Reap is scanning and copying embedded tests..."
 
     if tst.dir.strip.empty?
-      puts "Test directory must be specified."
+      tell "Test directory must be specified."
       return
     end
 
     unless File.directory?(tst.dir)
-      puts "Test directory doesn't exist: #{File.expand_path( tst.dir )}"
+      tell "Test directory doesn't exist: #{File.expand_path( tst.dir )}"
       return
     end
 
+    pbar = Console::ProgressBar.new( 'Extracting', files.size )
+
     files.each { |file|
-      $stdout << '.'; $stdout.flush
+      pbar.inc
+
       testing = extract( file )
+
       unless testing.strip.empty?
         complete_test = create( testing, file )
         libpath = File.dirname( file )
@@ -82,7 +88,9 @@ class Reap::TestExt < Reap::Task
         File.open( fp, "w" ) { |fw| fw << complete_test }
       end
     }
-    puts "done."
+
+    pbar.finish
+
   end
 
 private

data/lib/reap/task/fileperm.rb

@@ -1,4 +1,9 @@
 
+# NOTE This task needs work!
+#      It needs to generalize more to give greater control
+#      over which files get what permissions.
+#      It also might be extended to do copyright tagging.
+
 require 'reap/task'
 
 #  ___               _       _               _____        _
@@ -13,7 +18,7 @@ class Reap::Perm < Reap::Task
 
   section_required true
 
-  task_desc "Normalize ownership and permissions of package files."
+  task_desc "Normalize ownership and permissions of files."
 
   task_help %{
 
@@ -26,17 +31,14 @@ class Reap::Perm < Reap::Task
 
   }
 
-  #attr_accessor :user, :group, :filemod, :dirmod
+  alias_method :perm, :task
 
-  task_attr :perm
+  def run
 
-  def init
     perm.group   ||= perm.user
     perm.filemod ||= 644
     perm.dirmod  ||= 755
-  end
 
-  def run
     puts "Reap is shelling out work to chmod..."
 
     # misc

data/lib/reap/task/info.rb

@@ -23,10 +23,6 @@ class Reap::Info < Reap::Task
 
   }
 
-  def init
-    # no initialization
-  end
-
   def run
     puts $PROJECT_INFO.info_stream
   end

data/lib/reap/task/install.rb

@@ -14,12 +14,19 @@ class Reap::Install < Reap::Task
 
   task_desc "Locally install package using built-in setup.rb."
 
-  def init
-    task.options ||= []
-    #@sudo   ||= true
-  end
+  task_help %{
+
+    reap install
+
+    This task manually installs a project using setup.rb.
+    If setup.rb doesn't exist it will be created.
+
+  }
 
   def run
+
+    task.options ||= []
+
     #exe = %w{ setup.rb install.rb }.find{ |f| File.exists?(f) }
     #raise "setup.rb or install.rb not found" if exe == nil
 

data/lib/reap/task/manifest.rb

@@ -0,0 +1,59 @@
+
+require 'reap/task'
+require 'digest/md5'
+
+#  __  __           _  __        _     _____        _
+# |  \/  |__ _ _ _ (_)/ _|___ __| |_  |_   _|_ _ __| |__
+# | |\/| / _` | ' \| |  _/ -_|_-<  _|   | |/ _` (_-< / /
+# |_|  |_\__,_|_||_|_|_| \___/__/\__|   |_|\__,_/__/_\_\
+#
+
+# = Manifest Task
+
+class Reap::Manifest < Reap::Task
+
+  MUST_EXCLUDE = [ 'InstalledFiles', '**/CVS/**/*', '**/*~', 'dist', 'pkg' ]
+
+  #section_required true
+
+  task_desc "Create a MANIFEST file for this package."
+
+  task_help %{
+
+    reap manifest
+
+    Creates a manifest file for the package.
+
+      include       user name to use
+      exclude       group name to use
+
+  }
+
+  alias_method :man, :task
+
+  def run
+
+    man.include      ||= ['**/*']
+
+    man.exclude      ||= []
+    man.exclude      |= MUST_EXCLUDE
+
+    package_files = FileList.new
+    package_files.include(*man.include)
+    package_files.exclude(*man.exclude) if man.exclude and not man.exclude.empty?
+
+    File.open('MANIFEST', 'w+') do |f|
+      package_files.each do |pf|
+        f << "#{salt(pf)} #{pf}\n" if File.file?(pf)
+      end
+    end
+
+  end
+
+  # support functions
+  def salt( file )
+    Digest::MD5.new( File.read( file ) ).hexdigest
+  end
+
+end
+

data/lib/reap/task/noop.rb

@@ -15,10 +15,9 @@ class Reap::Noop < Reap::Task
 
   task_desc "A no-op task to help debug reap itself."
 
-  def init( msg )
-  end
+  alias_method :msg, :task
 
-  def run( msg )
+  def run
     puts ( msg.message || 'No message field in noop section.' )
   end
 

data/lib/reap/task/package.rb

@@ -22,18 +22,18 @@ end
 class Reap::Package < Reap::Task
 
   MUST_EXCLUDE = [ 'InstalledFiles', '**/CVS/**/*', '**/*~', 'dist', 'pkg' ]
-  LOCATIONS = [ '../leaf', '../dist', '../pkg', 'dist', 'pkg' ]
+  LOCATIONS = [ 'dist', 'pkg', '../packages', '../dist', '../pkg' ]
 
   # Task line description
 
-  task_desc do
-    if master.package
-      disttypes = master.package.distribute || master.distribute || [ 'gem', 'tar.bz2', 'zip' ]
-    else
-      disttypes = master.distribute || [ 'gem', 'tar.bz2', 'zip' ]
-    end
-    "Build distribution packages (#{disttypes.join(', ')})."
-  end
+  task_desc "Create distribution packages."
+#     if master.package
+#       disttypes = master.package.distribute || master.distribute || [ 'gem', 'tar.bz2', 'zip' ]
+#     else
+#       disttypes = master.distribute || [ 'gem', 'tar.bz2', 'zip' ]
+#     end
+#     "Build distribution packages (#{disttypes.join(', ')})."
+#   end
 
   # Help information
 
@@ -78,18 +78,15 @@ class Reap::Package < Reap::Task
 
   # Alternate for task properties accessor.
 
-  task_attr :pkg
+  alias_method :pkg, :task
 
-  # Setup package task.
+  def run
 
-  def init
+    # setup package defaults
 
     # Do not look in master information for this
-
     pkg.dir = section.dir || LOCATIONS.find { |f| File.directory?(f)  } || 'dist'
 
-    # Set defaults
-
     pkg.status       ||= 'beta/stable'
     pkg.date         ||= Time.now.strftime("%Y-%m-%d")
     pkg.series       ||= '1'
@@ -145,11 +142,7 @@ class Reap::Package < Reap::Task
       #@autorequire
     end
 
-  end
-
-  # Run package task.
-
-  def run
+    # package it up
 
     group_dir_path = File.join( pkg.dir, pkg.package_name )
     package_dir_path = File.join( pkg.dir, pkg.package_name, pkg.package_name )
@@ -217,7 +210,7 @@ class Reap::Package < Reap::Task
       if defined?(::Gem)
         run_gem
       else
-        puts "Package .gem requested, but rubygems not found (skipped)."
+        tell "Package .gem requested, but rubygems not found (skipped)."
       end
     end
 
@@ -227,7 +220,7 @@ class Reap::Package < Reap::Task
       if true # TODO ensure required debian tools here
         run_deb
       else
-        puts "Package .deb requested, but debian tools not found (skipped)."
+        tell "Package .deb requested, but debian tools not found (skipped)."
       end
     end
 
@@ -237,7 +230,7 @@ class Reap::Package < Reap::Task
       if true # TODO ensure required tools here
         run_pacman
       else
-        puts "Pacman package requested, but required tools not found (skipped)."
+        tell "Pacman package requested, but required tools not found (skipped)."
       end
     end
 
@@ -291,14 +284,14 @@ private
       s.has_rdoc = true
     }
 
-    puts "Reap is shelling out work to the Gem Package Manager..."
+    tell "Reap is shelling out work to the Gem Package Manager..."
     Gem.manage_gems
     Gem::Builder.new(spec).build
     gems = Dir.glob( './*.gem' )
     gems.each{ |f|
       FileUtils.mv( f, File.join( pkg.dir, pkg.package_name ) )
     }
-    #sh %{mv ./*.gem #{@dir}/}
+    puts
   end
 
 
@@ -372,6 +365,7 @@ private
     File.open( File.join(debdir, 'DEBIAN', 'control'), 'w') { |f| f << ctrl }
 
     sh %{dpkg-deb -b #{debdir} #{debfile}}
+    puts
   end
 
   # This builds a pacman (archlinux) PKGBUILD script.
@@ -381,7 +375,7 @@ private
     use_subsection :pacman
 
     unless @source
-      puts "URL 'source' is require for proto package."
+      tell "URL 'source' is require for proto package."
       return nil
     end
 
@@ -430,13 +424,10 @@ private
     pacpacdir = File.join( pacdir, 'PACMAN' )
     pacfile = File.join( pacdir, 'PKGBUILD' )
 
-    puts "Reap is shelling out work to the pacman..."
+    tell "Reap is shelling out work to the pacman..."
     FileUtils.mkdir_p(pacdir)
-    #sh %{ruby setup.rb all --prefix=#{debdir}}
-    #FileUtils.mkdir_p(pacpacdir)
     File.open( pacfile, 'w') { |f| f << proto }
-    #sh %{}
-
+    puts
   end
 
 end

data/lib/reap/task/publish.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'reap/task'
+require 'shellwords'
 
 #  ___      _    _ _    _      _____        _
 # | _ \_  _| |__| (_)__| |_   |_   _|_ _ __| |__
@@ -14,60 +15,144 @@ class Reap::Publish < Reap::Task
 
   section_required true
 
-  task_desc "Publish documents to the web."
+  task_desc "Publish documents to the web or host."
 
   task_help %{
 
     reap publish
 
-    Publish documents to hosting service.
-    Currently only supports web publishing to Rubyforge.
-    Working on generalizing this more in future.
+    Publish documents to hosting service. Three means of
+    publishing are current supported, ftp uploading, scp,
+    and web convenience option that recognizes particular
+    hosts (only RubyForge is currently supported).
 
-      dir            Directory of files to publish.
-      exclude        Files not to include from directory.
-      project        Project name.
+      type           Type of publishing, 'web', 'scp' or 'ftp'.
+      host           Host server, default is 'rubyforge.org'
       username       Username for host.
+      dir            Directory of files to publish. Or,
+      copy           Files to publish using from and to.
+      project        Project name (used for Rubyforge)
+
+    If the type is 'scp' or 'ftp' you will also need to provide
+    the root directory parameter.
+
+      root           Document root directory at host.
+
+    The dir parameter allows you to simply specify a local
+    directory, the contents of which will be published to
+    host's document root location (directory tree intact).
+
+    If you need more control over which files to publish
+    where, you can use the copy parameter instead. Provide
+    an array of pattern strings in the form of "{from} {to}".
+    If the desitination is the host's document root you do
+    not need to specify the {to} part. For example:
+
+      copy: [ 'web/*', 'doc/api/* doc/api' ]
+
+    The first copies the files under your project's web directory
+    to the host's document root. The second copies your projects
+    doc/api files to the doc/api location on the host.
+
+    When using the 'scp' type the internal template used for
+    the outbound destination is 'username@host:root/'.
 
   }
 
   #attr_accessor :host, :type, :dir, :project, :username
   #attr_accessor :exclude  # not using yet
 
-  task_attr :pub
+  alias_method :pub, :task
 
-  # Setup the publishing task.
+  # Run the publishing task.
 
-  def init
-    pub.type     ||= 'www'
+  def run( target=nil, copy_from=nil, copy_to=nil )
+
+    return nil if target and target != pub.target
+
+    # setup
+
+    pub.type     ||= 'web'
     pub.host     ||= 'rubyforge.org'
+    pub.root     ||= 'var/www/gforge-projects/'
     pub.project  ||= master.rubyforge.project || master.name
     pub.username ||= master.rubyforge.username
-    pub.exclude  ||= []
-  end
+    pub.copy     ||= [ "#{pub.dir}/*" ]
 
-  # Run the publishing task.
+    if copy_from
+      pub.copy = [ "#{copy_from} #{copy_to}".strip ]
+    end
 
-  def run
-    cmd = ''; skip = false
+    # validate
 
-    case pub.host
-    when 'rubyforge', 'rubyforge.org'
-      case pub.type
-      when 'www', 'web'
-        cmd = %{scp -r #{pub.dir}/* #{pub.username}@rubyforge.org:/var/www/gforge-projects/#{pub.project}/}
+    unless pub.project
+      puts "Project not specified." ; return nil
+    end
+
+    unless pub.username
+      puts "Username not specified." ; return nil
+    end
+
+    # publish
+
+    puts "Reap is shelling out publishing work..."
+
+    case pub.type
+
+    when 'web', 'www'
+      case pub.host
+      when 'rubyforge', 'rubyforge.org'
+        pub.host = "rubyforge.org"
+        pub.root = "/var/www/gforge-projects/#{pub.project}"
+        run_scp
       else
-        puts %{Unrecognized publishing kind '#{pub.type}' for host '#{pub.host}'. Skipped.}
-        skip = true
+        puts %{Unrecognized publishing host '#{pub.host}'. Skipped.}
+        return nil
       end
+
+    when 'scp'
+      run_scp
+
+    when 'ftp'
+      run_ftp
+
     else
-      puts %{Unrecognized publishing host '#{pub.host}'. Skipped.}
-      skip = true
+      puts %{Unrecognized publishing type '#{pub.type}'. Skipped.}
+      return nil
     end
 
-    unless skip
-      puts "Reap is shelling out publishing work..."
-      sh(cmd) unless $PRETEND
+  end
+
+private
+
+  def run_scp
+    pub.copy.each { |c|
+      from, to = *Shellwords.shellwords(c)
+      to = '' if to.nil?
+      to = to[1..-1] if to[0,1] == '/'
+      cmd = "scp -r #{from} #{pub.username}@#{pub.host}:#{pub.root}/#{to}"
+      sh( cmd )
+    }
+  end
+
+  def run_ftp
+    require 'net/ftp'
+    return if $PRETEND
+    Net::FTP.open( pub.host ) do |ftp|
+      ftp.login( pub.username )
+      ftp.chdir( pub.root )
+
+      pub.copy.each { |c|
+        from, to = *Shellwords.shellwords(c)
+        to = '' if to.nil?
+        to = to[1..-1] if to[0,1] == '/'
+        from.sub('*', '**/*') unless from =~ /\*\*/
+        files = FileList.new( from )
+        files.each { |f|
+          t = File.join( to, f.basename )
+          ftp.putbinaryfile( f, t, 1024 )
+        }
+      }
     end
   end