reap 5.10.10 → 6.0.0

data/lib/reap/class/doap.rb

@@ -0,0 +1,80 @@
+
+module Reap
+
+  # = Doap
+
+  class Doap
+
+    include TaskUtils
+
+    attr_accessor :dir
+
+    attr_accessor :title,
+                  :name,
+                  :created,
+                  :summary,
+                  :description,
+                  :maintainer,
+                  :email,
+                  :homepage,
+                  :wiki
+
+    def initalize( prj )
+      super
+
+      @dir ||= '.'
+    end
+
+    def call
+      write( generate )
+      puts "DOAP file created at '#{File.join( @dir, "doap.xml" )}'."
+    end
+
+    # Generate a doap file.
+
+    def generate
+      x = ''
+      x << %{
+            |<Project xmlns="http://usefulinc.com/ns/doap#"\n
+            |         xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"\n
+            |         xmlns:foaf="http://xmlns.com/foaf/0.1/">
+            |   <name>#{@title}</name>
+            |   <shortname>#{@name}</shortname>
+            |   <homepage rdf:resource="#{@homepage}" />
+            |   <wiki rdf:resource="#{@wiki}" />
+            |   <created>#{@created}</created>
+            |   <shortdesc xml:lang="en">
+            }.margin
+      x << "\n" << @summary.word_wrap(50).indent(6)
+      x << %{
+            |   </shortdesc>
+            |   <description xml:lang="en">
+            }.margin
+      x << "\n" << @description.word_wrap(50).indent(6)
+      x << %{
+            |   </description>
+            |   <maintainer>
+            |     <foaf:Person>
+            |       <foaf:name>#{@maintainer}</foaf:name>
+            |       <foaf:email>#{@email}</foaf:name>
+            |       <foaf:homepage rdf:resource="#{@homepage}" />
+            |     </foaf:Person>
+            |   </maintainer>
+            | </Project>
+            }.margin
+
+      return x
+    end
+
+  private
+
+    # Write the doap file.
+
+    def write( doap )
+      file = File.join( @dir, "doap.xml" )
+      File.open( file, 'w' ) { |f| f << doap }
+    end
+
+  end
+
+end #module Reap

data/lib/reap/class/extest.rb

@@ -0,0 +1,151 @@
+#--
+#  _____       _     ___     _
+# |_   _|__ __| |_  | __|_ _| |_
+#   | |/ -_|_-<  _| | _|\ \ /  _|_
+#   |_|\___/__/\__| |___/_\_\\__(_)
+#
+#++
+
+require 'facet/string/margin'
+require 'facet/progressbar'
+require 'facet/filelist.rb' unless defined?( FileList )
+
+module Reap
+
+  # = Test Extraction
+  #
+  # This task scans every package script looking for sections of the form:
+  #
+  #   =begin test
+  #     ...
+  #   =end
+  #
+  # With appropriate headers, it copies these sections to files in your
+  # project's test/ dir, which then can be run using the Reap test task.
+  # The exact directory layout of the files to be tested is reflected in
+  # the test directory. You can then use Reap's test task to run the tests.
+  #
+  # Specific Settings:
+  #
+  #      dir        Specify the test directory. Default is 'test'.
+  #      files      Specify files to extract. Default is 'lib/**/*.rb'.
+  #
+
+  class ExTest
+
+    include TaskUtils
+
+    attr_accessor :dir, :trunk, :files, :options
+
+    def initialize( tst )
+      @dir     = 'test'
+      #@trunk   = 'trunk' if File.directory?('trunk')
+      @files   = [ 'lib/**/*.rb' ]
+      @options = {}
+
+      super
+
+      @files = [ @files ].flatten
+    end
+
+    # Extract tests.
+
+    def extract
+      if @trunk
+        Dir.chdir( @trunk ) { extract_tests }
+      else
+        extract_tests
+      end
+    end
+
+    alias_method :call, :extract
+
+  private
+
+    def extract_tests
+      #test_libs = @libs.join(':')
+      filelist = FileList.new
+      filelist.include(*@files)
+      if filelist.empty?
+        tell "No script files found."
+        return
+      end
+      #tell "Reap is scanning and copying embedded tests..."
+      if @dir.strip.empty?
+        tell "Test directory must be specified. Aborting."
+        return # TODO use #abort or sepcial method to do a nice exit?
+      end
+      unless File.directory?( @dir )
+        tell "Test directory doesn't exist: #{File.expand_path( @dir )}"
+        return
+      end
+      pbar = Console::ProgressBar.new( 'Extracting', filelist.size )
+      filelist.each { |file|
+        pbar.inc
+        testing = extract_from_file( file )
+        unless testing.strip.empty?
+          complete_test = create( testing, file )
+          libpath = File.dirname( file )
+          testfile = "test_" + File.basename( file )
+          fp = File.join( dir, libpath, testfile )
+          unless File.directory?( File.dirname( fp ) )
+            FileUtils.mkdir_p( File.dirname(fp) )
+          end
+          File.open( fp, "w" ) { |fw| fw << complete_test }
+        end
+      }
+      pbar.finish
+    end
+
+  private
+
+    def extract_from_file( file )
+      return nil if ! File.file?( file )
+      tests = ""; inside = false
+      fstr = File.read( file )
+      fstr.split(/\n/).each do |l|
+        if l =~ /^=begin[ ]*test/i
+          tests << "\n"
+          inside = true
+          next
+        elsif inside and l =~ /^=[ ]*end/
+          inside = false
+          next
+        end
+        if inside
+          tests << l << "\n"
+        end
+      end
+      tests
+    end
+
+    def create( testing, file )
+      fp = file.split(/[\/]/)
+      if fp[0] == 'lib'
+        reqf = "require '#{fp[1..-1].join('/')}'"
+      else
+        reqf = ''
+      end
+      teststr = <<-HERE.margin
+        `#  _____         _
+        `# |_   _|__  ___| |_
+        `#   | |/ _ \\/ __| __|
+        `#   | |  __/\\__ \\ |_
+        `#   |_|\\___||___/\\__|
+        `#
+        `# for #{file}
+        `#
+        `# Extracted #{Time.now}
+        `# Unit Tools Reap Test Extractor
+        `#
+        `
+        `#{reqf}
+        `
+      HERE
+      teststr << testing << "\n"
+      teststr
+    end
+
+  end
+
+end #module Reap

data/lib/reap/class/filer.rb

@@ -0,0 +1,62 @@
+#--
+#++
+
+#require 'digest/md5'
+
+module Reap
+
+  # = Filer
+  #
+  #
+
+  class Filer
+
+    include TaskUtils
+
+    attr_accessor :source
+
+    def initialize( name, source, &build )
+      @name   = name
+      @source = [source].flatten
+      @build  = build
+    end
+
+    # Is this file task needed?  Yes if it doesn't exist, or if its time
+    # stamp is out of date.
+    def needed?
+      return true unless ::File.exist?( @name )
+      return true if out_of_date?( timestamp( @name ) )
+      false
+    end
+
+    # Check timestamp.
+    def timestamp( name )
+      if ::File.exist?( name.to_s )
+        ::File.mtime( name.to_s )
+      else
+        Time::EARLY  # TODO replace with Facets' -Infinity class (?)
+      end
+    end
+
+    # Are there any sources with a later time than the given timestamp?
+    def out_of_date?( stamp )
+      @source.any? { |n| timestamp(n) > stamp }
+    end
+
+    # Build file.
+
+    def build
+      @build.call if needed?
+    end
+
+    alias_method :call, :build
+
+  private
+
+    #def salt( file )
+    #  Digest::MD5.new( File.read( file ) ).hexdigest
+    #end
+
+  end
+
+end #module Reap

data/lib/reap/class/installer.rb

@@ -0,0 +1,178 @@
+require 'rbconfig'
+require 'fileutils'
+
+module Reap
+
+  # = Installer
+  #
+  # The Installer class generates a specialized install.rb
+  # script specifically for your project. It currently 
+  # does not support c/c++ ext/ compilation.
+
+  class Installer
+
+    include TaskUtils
+
+    def self.config(name)
+      # XXX use pathname
+      prefix = Regexp.quote(Config::CONFIG["prefix"])
+      exec_prefix = Regexp.quote(Config::CONFIG["exec_prefix"])
+      Config::CONFIG[name].gsub(/\A\/?(#{prefix}|#{exec_prefix})\/?/, '')
+    end
+
+    KINDS = [
+      :bin, :lib, :ext, :data, :conf, :doc
+    ]
+
+    SITE_DIRS = {
+      :bin  => config("bindir"),
+      :lib  => config("sitelibdir"),
+      :ext  => config("sitearchdir"),
+      :data => config("datadir"),
+      :conf => config("sysconfdir"),
+      :doc  => File.join(config("datadir"), "doc"),
+    }
+
+    VEND_DIRS = {
+      :bin  => config("bindir"),
+      :lib  => config("rubylibdir"),
+      :ext  => config("archdir"),
+      :data => config("datadir"),
+      :conf => config("sysconfdir"),
+      :doc  => File.join(config("datadir"), "doc"),
+    }
+
+    MODES = {
+      :bin  => 0755,
+      :lib  => 0644,
+      :ext  => 0755,  # was: 0555,
+      :data => 0644,
+      :conf => 0644,
+      :doc  => 0644,
+    }
+
+    attr_accessor :trunk, :template, :options
+
+    def initialize( ins )
+      super
+      @trunk = '.' unless @trunk
+      @spec = parse( @template )
+      @transfer = Hash.new { |h,k| h[k] = [] }
+    end
+
+    #--
+    # TODO use shellwords
+    #++
+    def parse( spec )
+      lines = spec.strip.split("\n")
+      lines.each { |line|
+        words = line.strip.split(/\s+/)
+        send( *words )
+      }
+    end
+
+    # substitute variables
+    def vsub( str )
+      return nil if str.nil?
+      str = str.gsub( '$version', @options[:version].to_s )
+      str = str.gsub( '$name', @options[:name].to_s )
+      str
+    end
+
+    # Return the installation directory.
+    def dir( kind, mode=:site )
+      case mode
+      when :site
+        SITE_DIRS[ kind ]
+      when :vendor
+        VEND_DIRS[ kind ]
+      else
+        raise ArgumentError, "unknown mode -- #{mode}"
+      end
+    end
+
+    # Return installation prefix.
+    def prefix( kind )
+      Config::CONFIG["prefix"]
+    end
+
+    #--
+    # DSL methods for setting installation spec.
+    #++
+
+    # Setup a lib installation transfer.
+    def lib( from, glob, to )
+      to = '' if to == '.'
+      @transfer[:lib] << { :from=>vsub(from), :glob=>vsub(glob), :to=>vsub(to) }
+    end
+
+    # Setup a bin installation transfer.
+    def bin( from, glob, to )
+      to = '' if to == '.'
+      @transfer[:bin] << { :from=>vsub(from), :glob=>vsub(glob), :to=>vsub(to) }
+    end
+
+    # Compile script and write to install file (install.rb).
+
+    def compile_and_write
+      script = ""
+      script << "# INSTALL SCRIPT\n"
+      script << "# Generated by Reap\n"
+      script << "# #{Time.now}\n"
+      script << "\n"
+      script << compile
+      script << "\n"
+      script << "# END"
+
+      write( script )
+    end
+
+    alias_method :call, :compile_and_write
+
+  private
+
+    # Compile installation instructions.
+
+    def compile
+      mkdirp = []
+      script = ''
+      Dir.chdir( @trunk ) do
+        KINDS.each { |kind|
+          @transfer[kind].each { |trans|
+            next unless File.directory?( trans[:from] )
+            files = []
+            Dir.chdir( trans[:from] ) {
+              files = Dir.glob( trans[:glob] ).reject { |f| File.directory?( f ) }
+            }
+            files.each { |file|
+              f = File.join( trans[:from], file )
+              t = File.join( prefix(kind), dir(kind), trans[:to], file )
+              m = MODES[kind]
+              d = File.dirname(t)
+              unless mkdirp.include?(d)
+                script << "mkdir_p '%s'\n" % d
+                mkdirp << d
+              end
+              script << "install '%s', '%s', :mode=>%o\n" % [ f, t, m ]
+            }
+          }
+        }
+      end
+      script
+    end
+
+    def write( script )
+      install_file = File.join( @trunk, 'install.rb' )
+      if File.file?( install_file )
+        script_template = File.read( install_file )
+        script = script_template.gsub(/\# INSTALL SCRIPT.*\# END/, script)
+        end
+        File.open( install_file, 'w+' ) do |f|
+          f << script
+        end
+      end
+    end
+
+  end
+
+end #module Reap