rake 0.4.8

data/lib/rake/gempackagetask.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+
+# Define a package task library to aid in the definition of GEM
+# packages.
+
+require 'rubygems'
+require 'rake'
+require 'rake/packagetask'
+
+begin
+  Gem.manage_gems
+rescue NoMethodError => ex
+  # Using rubygems prior to 0.6.1
+end
+
+module Rake
+
+  # Create a package based upon a Gem spec.  Gem packages, as well as
+  # zip files and tar/gzipped packages can be produced by this task.
+  #
+  # In addition to the Rake targets generated by PackageTask, a
+  # GemPackageTask will also generate the following tasks:
+  #
+  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.gem"</b>]
+  #   Create a Ruby GEM package with the given name and version.
+  #
+  # Example using a Ruby GEM spec:
+  #
+  #   require 'rubygems'
+  #
+  #   spec = Gem::Specification.new do |s|
+  #     s.platform = Gem::Platform::RUBY
+  #     s.summary = "Ruby based make-like utility."
+  #     s.name = 'rake'
+  #     s.version = PKG_VERSION
+  #     s.requirements << 'none'
+  #     s.require_path = 'lib'
+  #     s.autorequire = 'rake'
+  #     s.files = PKG_FILES
+  #     s.description = <<EOF
+  #   Rake is a Make-like program implemented in Ruby. Tasks
+  #   and dependencies are specified in standard Ruby syntax. 
+  #   EOF
+  #   end
+  #   
+  #   Rake::GemPackageTask.new(spec) do |pkg|
+  #     pkg.need_zip = true
+  #     pkg.need_tar = true
+  #   end
+  #
+  class GemPackageTask < PackageTask
+    # Ruby GEM spec containing the metadata for this package.  The
+    # name, version and package_files are automatically determined
+    # from the GEM spec and don't need to be explicitly provided.
+    attr_accessor :gem_spec
+
+    # Create a GEM Package task library.  Automatically define the gem
+    # if a block is given.  If no block is supplied, then +define+
+    # needs to be called to define the task.
+    def initialize(gem_spec)
+      init(gem_spec)
+      yield self if block_given?
+      define if block_given?
+    end
+
+    # Initialization tasks without the "yield self" or define
+    # operations.
+    def init(gem)
+      super(gem.name, gem.version)
+      @gem_spec = gem
+      @package_files += gem_spec.files if gem_spec.files
+    end
+
+    # Create the Rake tasks and actions specified by this
+    # GemPackageTask.  (+define+ is automatically called if a block is
+    # given to +new+).
+    def define
+      super
+      task :package => [:gem]
+      task :gem => ["#{package_dir}/#{gem_file}"]
+      file "#{package_dir}/#{gem_file}" => [package_dir] + @gem_spec.files do
+	when_writing("Creating GEM") {
+	  Gem::Builder.new(gem_spec).build
+	  verbose(true) {
+	    mv gem_file, "#{package_dir}/#{gem_file}"
+	  }
+	}
+      end
+    end
+    
+    private
+    
+    def gem_file
+      "#{package_name}.gem"
+    end
+    
+  end
+end

data/lib/rake/packagetask.rb

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+
+# Define a package task libarary to aid in the definition of
+# redistributable package files.
+
+require 'rake'
+require 'rake/tasklib'
+
+module Rake
+
+  # Create a packaging task that will package the project into
+  # distributable files (e.g zip archive or tar files).
+  #
+  # The PackageTask will create the following targets:
+  #
+  # [<b>:package</b>]
+  #   Create all the requested package files.
+  #
+  # [<b>:clobber_package</b>]
+  #   Delete all the package files.  This target is automatically
+  #   added to the main clobber target.
+  #
+  # [<b>:repackage</b>]
+  #   Rebuild the package files from scratch, even if they are not out
+  #   of date.
+  #
+  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tgz"</b>]
+  #   Create a gzipped tar package (if <em>need_tar</em> is true).  
+  #
+  # [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.zip"</b>]
+  #   Create a zip package archive (if <em>need_zip</em> is true).
+  #
+  # Example:
+  #
+  #   PackageTask.new("rake", "1.2.3") do |p|
+  #     p.need_tar = true
+  #     p.package_files.include("lib/**/*.rb")
+  #   end
+  #
+  class PackageTask < TaskLib
+    # Name of the package (from the GEM Spec).
+    attr_accessor :name
+
+    # Version of the package (e.g. '1.3.2').
+    attr_accessor :version
+
+    # Directory used to store the package files (default is 'pkg').
+    attr_accessor :package_dir
+
+    # True if a gzipped tar file should be produced (default is false).
+    attr_accessor :need_tar
+
+    # True if a zip file should be produced (default is false)
+    attr_accessor :need_zip
+
+    # List of files to be included in the package.
+    attr_accessor :package_files
+
+    # Create a Package Task with the given name and version. 
+    def initialize(name=nil, version=nil)
+      init(name, version)
+      yield self if block_given?
+      define unless name.nil?
+    end
+
+    # Initialization that bypasses the "yield self" and "define" step.
+    def init(name, version)
+      @name = name
+      @version = version
+      @package_files = Rake::FileList.new
+      @package_dir = 'pkg'
+      @need_tar = false
+      @need_zip = false
+    end
+
+    # Create the tasks defined by this task library.
+    def define
+      fail "Version required (or :noversion)" if @version.nil?
+      @version = nil if :noversion == @version
+
+      desc "Build all the packages"
+      task :package
+      
+      desc "Force a rebuild of the package files"
+      task :repackage => [:clobber_package, :package]
+      
+      desc "Remove package products" 
+      task :clobber_package do
+	rm_r package_dir rescue nil
+      end
+
+      task :clobber => [:clobber_package]
+
+      if need_tar
+	task :package => ["#{package_dir}/#{tgz_file}"]
+	file "#{package_dir}/#{tgz_file}" => [package_dir_path] + package_files do
+	  chdir(package_dir) do
+	    sh %{tar zcvf #{tgz_file} #{package_name}}
+	  end
+	end
+      end
+
+      if need_zip
+	task :package => ["#{package_dir}/#{zip_file}"]
+	file "#{package_dir}/#{zip_file}" => [package_dir_path] + package_files do
+	  chdir(package_dir) do
+	    sh %{zip -r #{zip_file} #{package_name}}
+	  end
+	end
+      end
+
+      directory package_dir
+
+      file package_dir_path => @package_files do
+	mkdir_p package_dir rescue nil
+	@package_files.each do |fn|
+	  f = File.join(package_dir_path, fn)
+	  fdir = File.dirname(f)
+	  mkdir_p(fdir) if !File.exist?(fdir)
+	  if File.directory?(fn)
+	    mkdir_p(f)
+	  else
+	    rm_f f
+	    safe_ln(fn, f)
+	  end
+	end
+      end
+      self
+    end
+
+    private
+
+    def package_name
+      @version ? "#{@name}-#{@version}" : @name
+    end
+      
+    def package_dir_path
+      "#{package_dir}/#{package_name}"
+    end
+
+    def tgz_file
+      "#{package_name}.tgz"
+    end
+
+    def zip_file
+      "#{package_name}.zip"
+    end
+  end
+
+end
+
+    

data/lib/rake/rdoctask.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+
+require 'rake'
+require 'rake/tasklib'
+
+module Rake
+
+  # Create a documentation task that will generate the RDoc files for
+  # a project.
+  #
+  # The PackageTask will create the following targets:
+  #
+  # [<b><em>rdoc</em></b>]
+  #   Main task for this RDOC task.  
+  #
+  # [<b>:clobber_<em>rdoc</em></b>]
+  #   Delete all the package files.  This target is automatically
+  #   added to the main clobber target.
+  #
+  # [<b>:re<em>rdoc</em></b>]
+  #   Rebuild the package files from scratch, even if they are not out
+  #   of date.
+  #
+  # Simple Example:
+  #
+  #   RDocTask.new do |rd|
+  #     rd.main = "README.rdoc"
+  #     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  #   end
+  #
+  # You may wish to give the task a different name, such as if you are
+  # generating two sets of documentation.  For instance, if you want to have a
+  # development set of documentation including private methods:
+  #
+  #   RDocTask.new(:rdoc_dev) do |rd|
+  #     rd.main = "README.doc"
+  #     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  #     rd.options << "--all"
+  #   end
+  #
+  # The tasks would then be named :<em>rdoc_dev</em>, :clobber_<em>rdoc_dev</em>, and
+  # :re<em>rdoc_dev</em>.
+  #
+  class RDocTask < TaskLib
+    # Name of the main, top level task.  (default is :rdoc)
+    attr_accessor :name
+
+    # Name of directory to receive the html output files. (default is "html")
+    attr_accessor :rdoc_dir
+
+    # Title of RDoc documentation. (default is none)
+    attr_accessor :title
+
+    # Name of file to be used as the main, top level file of the
+    # RDoc. (default is none)
+    attr_accessor :main
+
+    # Name of template to be used by rdoc. (default is 'html')
+    attr_accessor :template
+
+    # List of files to be included in the rdoc generation. (default is [])
+    attr_accessor :rdoc_files
+
+    # List of options to be passed rdoc.  (default is [])
+    attr_accessor :options
+
+    # Create an RDoc task named <em>rdoc</em>.  Default task name is +rdoc+.
+    def initialize(name=:rdoc)	# :yield: self
+      @name = name
+      @rdoc_files = Rake::FileList.new
+      @rdoc_dir = 'html'
+      @main = nil
+      @title = nil
+      @template = 'html'
+      @options = []
+      yield self if block_given?
+      define
+    end
+    
+    # Create the tasks defined by this task lib.
+    def define
+      if name.to_s != "rdoc"
+	desc "Build the RDOC HTML Files"
+      end
+
+      desc "Build the #{name} HTML Files"
+      task name
+      
+      desc "Force a rebuild of the RDOC files"
+      task paste("re", name) => [paste("clobber_", name), name]
+      
+      desc "Remove rdoc products" 
+      task paste("clobber_", name) do
+	rm_r rdoc_dir rescue nil
+      end
+
+      task :clobber => [paste("clobber_", name)]
+      
+      directory @rdoc_dir
+      task name => [rdoc_target]
+      file rdoc_target => @rdoc_files + ["Rakefile"] do
+	rm_r @rdoc_dir rescue nil
+	opts = option_list.join(' ')
+	sh %{rdoc -o #{@rdoc_dir} #{opts} #{@rdoc_files}}
+      end
+      self
+    end
+
+    def option_list
+      result = @options.dup
+      result << "--main" << "'#{main}'" if main
+      result << "--title" << "'#{title}'" if title
+      result << "-T" << "'#{template}'" if template
+      result
+    end
+
+    def option_string
+      option_list.join(' ')
+    end
+
+    private
+
+    def rdoc_target
+      "#{rdoc_dir}/index.html"
+    end
+
+  end
+end

data/lib/rake/runtest.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'test/unit/assertions'
+
+module Rake
+  include Test::Unit::Assertions
+
+  def run_tests(pattern='test/test*.rb', log_enabled=false)
+    Dir["#{pattern}"].each { |fn|
+      puts fn if log_enabled
+      begin
+	load fn
+      rescue Exception => ex
+	puts "Error in #{fn}: #{ex.message}"
+	puts ex.backtrace
+	assert false
+      end
+    }
+  end
+
+  extend self
+end

data/lib/rake/tasklib.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+module Rake
+
+  # Base class for Task Libraries.
+  class TaskLib
+
+    # Make a copy of a task.
+    def clone
+      sibling = self.class.new
+      instance_variables.each do |ivar|
+	value = self.instance_variable_get(ivar)
+	sibling.instance_variable_set(ivar, value.dup) if value
+      end
+      sibling
+    end
+
+    # Make a symbol by pasting two strings together. 
+    def paste(a,b)
+      (a.to_s + b.to_s).intern
+    end
+  end
+
+end

data/lib/rake/testtask.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+
+# Define a task library for running unit tests.
+
+require 'rake'
+require 'rake/tasklib'
+
+module Rake
+
+  # Create a task that runs a set of tests.
+  #
+  # Example:
+  #  
+  #   Rake::TestTask.new do |t|
+  #     t.libs << "test"
+  #     t.test_files = FileList['test/test*.rb']
+  #     t.verbose = true
+  #   end
+  #
+  # If rake is invoked with a "TEST=filename" command line option,
+  # then the list of test files will be overridden to include only the
+  # filename specified on the command line.  This provides an easy way
+  # to run just one test.
+  #
+  # If rake is invoked with a "TESTOPTS=options" command line option,
+  # then the given options are passed to the test process after a
+  # '--'.  This allows Test::Unit options to be passed to the test
+  # suite.
+  #
+  # Examples:
+  #
+  #   rake test                           # run tests normally
+  #   rake test TEST=just_one_file.rb     # run just one test file.
+  #   rake test TESTOPTS="-v"             # run in verbose mode
+  #   rake test TESTOPTS="--runner=fox"   # use the fox test runner
+  #
+  class TestTask < TaskLib
+
+    SEP = ''
+
+    # Name of test task. (default is :test)
+    attr_accessor :name
+
+    # List of directories to added to $LOAD_PATH before running the
+    # tests. (default is 'lib')
+    attr_accessor :libs
+
+    # True if verbose test output desired. (default is false)
+    attr_accessor :verbose
+
+    # Test options passed to the test suite. (default is NONE)
+    attr_accessor :options
+
+    # Glob pattern to match test files. (default is 'test/test*.rb')
+    attr_accessor :pattern
+
+    # Explicitly define the list of test files to be included in a
+    # test.  +list+ is expected to be an array of file names (a
+    # FileList is acceptable).  If both +pattern+ and +test_files+ are
+    # used, then the list of test files is the union of the two.
+    def test_files=(list)
+      @test_files = list
+    end
+
+    # Create a testing task.
+    def initialize(name=:test)
+      @name = name
+      @libs = ["lib"]
+      @pattern = nil
+      @test_files = nil
+      @verbose = false
+      yield self if block_given?
+      @pattern = 'test/test*.rb' if @pattern.nil? && @test_files.nil?
+      define
+    end
+
+    # Create the tasks defined by this task lib.
+    def define
+      lib_path = @libs.join(File::PATH_SEPARATOR)
+      desc "Run tests" + (@name==:test ? "" : " for #{@name}")
+      task @name do
+	RakeFileUtils.verbose(@verbose) do
+	  ruby %{-I#{lib_path} -e0 #{SEP}#{required_files}#{option_list}}
+	end
+      end
+      self
+    end
+
+    def required_files # :nodoc:
+      file_list.gsub(/^(.*)\.rb$/, ' -r\1').join(" #{SEP}")
+    end
+    
+    def option_list # :nodoc:
+      if get_options
+	testoptions = " #{SEP} -- #{get_options}"
+      else
+	testoptions = ''
+      end
+    end
+
+    def get_options # :nodoc:
+      ENV['TESTOPTS'] || @options
+    end
+
+    def file_list # :nodoc:
+      if ENV['TEST']
+	FileList[ ENV['TEST'] ]
+      else
+	result = []
+	result += @test_files.to_a if @test_files
+	result += FileList[ @pattern ].to_a if @pattern
+	FileList[result]
+      end
+    end
+
+  end
+end
+