jimweirich-rake 0.8.3.1 → 0.8.3.99

data/lib/rake/rdoctask.rb

@@ -10,7 +10,7 @@ module Rake
   #
   # The RDocTask will create the following targets:
   #
-  # [<b><em>rdoc</em></b>]
+  # [<b>:<em>rdoc</em></b>]
   #   Main task for this RDOC task.  
   #
   # [<b>:clobber_<em>rdoc</em></b>]
@@ -21,13 +21,18 @@ module Rake
   #   Rebuild the rdoc files from scratch, even if they are not out
   #   of date.
   #
-  # Simple Example:
+  # Simple example:
   #
   #   Rake::RDocTask.new do |rd|
   #     rd.main = "README.rdoc"
   #     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
   #   end
   #
+  # The +rd+ object passed to the block is an RDocTask object. See the
+  # attributes list for the RDocTask class for available customization options.
+  #
+  # == Specifying different task names
+  #
   # 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:
@@ -39,7 +44,17 @@ module Rake
   #   end
   #
   # The tasks would then be named :<em>rdoc_dev</em>, :clobber_<em>rdoc_dev</em>, and
-  # :re<em>rdoc_dev</em>.
+  # :re<em>rdoc_dev</em>. 
+  #
+  # If you wish to have completely different task names, then pass a Hash as
+  # first argument. With the <tt>:rdoc</tt>, <tt>:clobber_rdoc</tt> and
+  # <tt>:rerdoc</tt> options, you can customize the task names to your liking.
+  # For example:
+  #
+  #   Rake::RDocTask.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean", :rerdoc => "rdoc:force")
+  #
+  # This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc_clean</tt> and
+  # <tt>:rdoc:force</tt>.
   #
   class RDocTask < TaskLib
     # Name of the main, top level task.  (default is :rdoc)
@@ -48,7 +63,7 @@ module Rake
     # Name of directory to receive the html output files. (default is "html")
     attr_accessor :rdoc_dir
 
-    # Title of RDoc documentation. (default is none)
+    # Title of RDoc documentation. (defaults to rdoc's default)
     attr_accessor :title
 
     # Name of file to be used as the main, top level file of the
@@ -61,14 +76,24 @@ module Rake
     # 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 [])
+    # Additional list of options to be passed rdoc.  (default is [])
     attr_accessor :options
 
-    # Run the rdoc process as an external shell (default is false)
+    # Whether to run the rdoc process as an external shell (default is false)
     attr_accessor :external
-
-    # Create an RDoc task named <em>rdoc</em>.  Default task name is +rdoc+.
-    def initialize(name=:rdoc)  # :yield: self
+    
+    attr_accessor :inline_source
+
+    # Create an RDoc task with the given name. See the RDocTask class overview
+    # for documentation.
+    def initialize(name = :rdoc)  # :yield: self
+      if name.is_a?(Hash)
+        invalid_options = name.keys.map { |k| k.to_sym } - [:rdoc, :clobber_rdoc, :rerdoc]
+        if !invalid_options.empty?
+          raise ArgumentError, "Invalid option(s) passed to RDocTask.new: #{invalid_options.join(", ")}"
+        end
+      end
+      
       @name = name
       @rdoc_files = Rake::FileList.new
       @rdoc_dir = 'html'
@@ -76,6 +101,7 @@ module Rake
       @title = nil
       @template = nil
       @external = false
+      @inline_source = true
       @options = []
       yield self if block_given?
       define
@@ -83,27 +109,28 @@ module Rake
     
     # Create the tasks defined by this task lib.
     def define
-      if name.to_s != "rdoc"
+      if rdoc_task_name != "rdoc"
         desc "Build the RDOC HTML Files"
+      else
+        desc "Build the #{rdoc_task_name} HTML Files"
       end
-
-      desc "Build the #{name} HTML Files"
-      task name
+      task rdoc_task_name
       
       desc "Force a rebuild of the RDOC files"
-      task "re#{name}" => ["clobber_#{name}", name]
+      task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
       
       desc "Remove rdoc products" 
-      task "clobber_#{name}" do
+      task clobber_task_name do
         rm_r rdoc_dir rescue nil
       end
       
-      task :clobber => ["clobber_#{name}"]
+      task :clobber => [clobber_task_name]
       
       directory @rdoc_dir
-      task name => [rdoc_target]
+      task rdoc_task_name => [rdoc_target]
       file rdoc_target => @rdoc_files + [Rake.application.rakefile] do
         rm_r @rdoc_dir rescue nil
+        @before_running_rdoc.call if @before_running_rdoc
         args = option_list + @rdoc_files
         if @external
           argstring = args.join(' ')
@@ -122,6 +149,7 @@ module Rake
       result << "--main" << quote(main) if main
       result << "--title" << quote(title) if title
       result << "-T" << quote(template) if template
+      result << "--inline-source" if inline_source && !@options.include?("--inline-source") && !@options.include?("-S")
       result
     end
 
@@ -136,12 +164,46 @@ module Rake
     def option_string
       option_list.join(' ')
     end
+    
+    # The block passed to this method will be called just before running the
+    # RDoc generator. It is allowed to modify RDocTask attributes inside the
+    # block.
+    def before_running_rdoc(&block)
+      @before_running_rdoc = block
+    end
 
     private
-
+    
     def rdoc_target
       "#{rdoc_dir}/index.html"
     end
+    
+    def rdoc_task_name
+      case name
+      when Hash
+        (name[:rdoc] || "rdoc").to_s
+      else
+        name.to_s
+      end
+    end
+    
+    def clobber_task_name
+      case name
+      when Hash
+        (name[:clobber_rdoc] || "clobber_rdoc").to_s
+      else
+        "clobber_#{name}"
+      end
+    end
+    
+    def rerdoc_task_name
+      case name
+      when Hash
+        (name[:rerdoc] || "rerdoc").to_s
+      else
+        "re#{name}"
+      end
+    end
 
   end
 end

data/lib/rake/testtask.rb

@@ -95,7 +95,7 @@ module Rake
 
     # Create the tasks defined by this task lib.
     def define
-      lib_path = @libs.join(File::PATH_SEPARATOR)
+      lib_path = @libs.collect {|path| "-I\"#{File.expand_path(path)}\""}.join(' ')
       desc "Run tests" + (@name==:test ? "" : " for #{@name}")
       task @name do
         run_code = ''
@@ -109,7 +109,7 @@ module Rake
             when :rake
               rake_loader
             end
-          @ruby_opts.unshift( "-I#{lib_path}" )
+          @ruby_opts.unshift( lib_path )
           @ruby_opts.unshift( "-w" ) if @warning
           ruby @ruby_opts.join(" ") +
             " \"#{run_code}\" " +

data/lib/rake/win32.rb

@@ -12,7 +12,7 @@ module Rake
     class << self
       # True if running on a windows system.
       def windows?
-        Config::CONFIG['host_os'] =~ /mswin/
+        Config::CONFIG['host_os'] =~ /mswin|mingw/
       end
 
       # Run a command line on windows.
@@ -28,22 +28,25 @@ module Rake
       # Win 32 systems. Try the following environment variables (in
       # order):
       #
-      # * APPDATA
+      # * HOME
       # * HOMEDRIVE + HOMEPATH
+      # * APPDATA
       # * USERPROFILE
       #
       # If the above are not defined, the return nil.
       def win32_system_dir #:nodoc:
-        win32_shared_path = ENV['APPDATA']
+        win32_shared_path = ENV['HOME']
         if win32_shared_path.nil? && ENV['HOMEDRIVE'] && ENV['HOMEPATH']
           win32_shared_path = ENV['HOMEDRIVE'] + ENV['HOMEPATH']
         end
+
+        win32_shared_path ||= ENV['APPDATA']
         win32_shared_path ||= ENV['USERPROFILE']
         raise Win32HomeError, "Unable to determine home path environment variable." if
           win32_shared_path.nil? or win32_shared_path.empty?
         normalize(File.join(win32_shared_path, 'Rake'))
       end
-      
+
       # Normalize a win32 path so that the slashes are all forward slashes.
       def normalize(path)
         path.gsub(/\\/, '/')

data/lib/rake.rb

@@ -29,7 +29,7 @@
 # as a library via a require statement, but it can be distributed
 # independently as an application.
 
-RAKEVERSION = '0.8.3.1'
+RAKEVERSION = '0.8.3.99'
 
 require 'rbconfig'
 require 'fileutils'
@@ -749,9 +749,7 @@ module Rake
     # 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)
-      false
+      ! File.exist?(name) || out_of_date?(timestamp)
     end
 
     # Time stamp for file task.
@@ -1650,9 +1648,9 @@ module Rake
       @task_manager.lookup(name, @scope)
     end
 
-    # Return the list of tasks defined in this namespace.
+    # Return the list of tasks defined in this and nested namespaces.
     def tasks
-      @task_manager.tasks
+      @task_manager.tasks_in_scope(@scope)
     end
   end # NameSpace
 
@@ -1797,6 +1795,15 @@ module Rake
       @tasks.values.sort_by { |t| t.name }
     end
 
+    # List of all the tasks defined in the given scope (and its
+    # sub-scopes).
+    def tasks_in_scope(scope)
+      prefix = scope.join(":")
+      tasks.select { |t|
+        /^#{prefix}:/ =~ t.name
+      }
+    end
+
     # Clear all tasks in this application.
     def clear
       @tasks.clear
@@ -1975,7 +1982,8 @@ module Rake
     def init(app_name='rake')
       standard_exception_handling do
         @name = app_name
-        collect_tasks handle_options
+        handle_options
+        collect_tasks
       end
     end
 
@@ -2058,7 +2066,10 @@ module Rake
     # If a match is found, it is copied into @rakefile.
     def have_rakefile
       @rakefiles.each do |fn|
-        if File.exist?(fn) || fn == ''
+        if File.exist?(fn)
+          others = Dir.glob(fn, File::FNM_CASEFOLD)
+          return others.size == 1 ? others.first : fn
+        elsif fn == ''
           return fn
         end
       end
@@ -2275,18 +2286,18 @@ module Rake
     def handle_options
       options.rakelib = ['rakelib']
 
-      opts = OptionParser.new
-      opts.banner = "rake [-f rakefile] {options} targets..."
-      opts.separator ""
-      opts.separator "Options are ..."
-      
-      opts.on_tail("-h", "--help", "-H", "Display this help message.") do
-        puts opts
-        exit
-      end
-      
-      standard_rake_options.each { |args| opts.on(*args) }
-      parsed_argv = opts.parse(ARGV)
+      OptionParser.new do |opts|
+        opts.banner = "rake [-f rakefile] {options} targets..."
+        opts.separator ""
+        opts.separator "Options are ..."
+
+        opts.on_tail("-h", "--help", "-H", "Display this help message.") do
+          puts opts
+          exit
+        end
+
+        standard_rake_options.each { |args| opts.on(*args) }
+      end.parse!
 
       # If class namespaces are requested, set the global options
       # according to the values in the options structure.
@@ -2297,7 +2308,6 @@ module Rake
         $dryrun = options.dryrun
         $silent = options.silent
       end
-      parsed_argv
     end
 
     # Similar to the regular Ruby +require+ command, but will check
@@ -2384,9 +2394,9 @@ module Rake
     # Collect the list of tasks on the command line.  If no tasks are
     # given, return a list containing only the default task.
     # Environmental assignments are processed at this time as well.
-    def collect_tasks(argv)
+    def collect_tasks
       @top_level_tasks = []
-      argv.each do |arg|
+      ARGV.each do |arg|
         if arg =~ /^(\w+)=(.*)$/
           ENV[$1] = $2
         else

data/test/data/sample.mf

@@ -10,3 +10,5 @@ c: c1
 d: d1 d2 \
 
 e f : e1 f1
+
+g\ 0: g1 g\ 2 g\ 3 g4

data/test/rake_test_setup.rb

@@ -8,3 +8,17 @@ rescue LoadError
 end
 
 require 'flexmock/test_unit'
+
+if RUBY_VERSION >= "1.9.0"
+  class Test::Unit::TestCase
+#    def passed?
+#      true
+#    end
+  end
+end
+
+module TestMethods
+  def assert_exception(ex, msg=nil, &block)
+    assert_raise(ex, msg, &block)
+  end
+end

data/test/session_functional.rb

@@ -8,6 +8,7 @@ require 'test/unit'
 require 'fileutils'
 require 'session'
 require 'test/in_environment'
+require 'test/rake_test_setup'
 
 # Version 2.1.9 of session has a bug where the @debug instance
 # variable is not initialized, causing warning messages.  This snippet
@@ -24,6 +25,7 @@ end
 
 class FunctionalTest < Test::Unit::TestCase
   include InEnvironment
+  include TestMethods
 
   RUBY_COMMAND = 'ruby'
 

data/test/test_application.rb

@@ -18,6 +18,7 @@ TESTING_REQUIRE = [ ]
 class TestApplication < Test::Unit::TestCase
   include CaptureStdout
   include InEnvironment
+  include TestMethods
 
   def setup
     @app = Rake::Application.new
@@ -109,7 +110,7 @@ class TestApplication < Test::Unit::TestCase
   end
 
   def test_finding_rakefile
-    assert_match(/[Rr]akefile/, @app.instance_eval { have_rakefile })
+    assert_match(/Rakefile/i, @app.instance_eval { have_rakefile })
   end
 
   def test_not_finding_rakefile
@@ -148,7 +149,7 @@ class TestApplication < Test::Unit::TestCase
         handle_options
         options.silent = true
       end
-      ex = assert_raise(RuntimeError) do 
+      ex = assert_exception(RuntimeError) do 
         @app.instance_eval do raw_load_rakefile end 
       end
       assert_match(/no rakefile found/i, ex.message)
@@ -162,6 +163,7 @@ class TestApplication < Test::Unit::TestCase
         handle_options
         options.silent = true
         options.load_system = true
+        options.rakelib = []
         load_rakefile
       end
       assert_equal "test/data/sys", @app.system_dir
@@ -170,9 +172,9 @@ class TestApplication < Test::Unit::TestCase
   end
 
   def test_load_from_system_rakefile_on_unix
-    flexmock(@app, :windows? => false,
-      :win32_system_dir => nil,
-      :load => nil)
+    flexmock(Rake::Win32, :windows? => false,
+      :win32_system_dir => nil)
+    flexmock(@app, :load => nil)
     flexmock(File).should_receive(:expand_path).with("~").and_return("/HOME")
     flexmock(File).should_receive(:expand_path).and_return { |fn| fn }
     
@@ -182,6 +184,7 @@ class TestApplication < Test::Unit::TestCase
         handle_options
         options.silent = true
         options.load_system = true
+        options.rakelib = []
         load_rakefile
       end
       assert_equal "/HOME/.rake", @app.system_dir
@@ -195,17 +198,18 @@ class TestApplication < Test::Unit::TestCase
   def test_load_from_system_rakefile_on_windows
     flexmock(Rake::Win32, :windows? => true)
     flexmock(@app, :standard_system_dir => "XX")
-    flexmock(@app).should_receive(:directory?).with("/AD/Rake").and_return(true)
     flexmock(@app).should_receive(:load).and_return(nil)
-    in_environment('RAKE_SYSTEM' => nil, 'APPDATA' => '/AD') do
+    flexmock(File).should_receive(:directory?).with("D:/AD/Rake").and_return(true)
+    in_environment('RAKE_SYSTEM' => nil, 'HOME' => nil, 'HOMEDRIVE' => 'D:', 'HOMEPATH' => '\\AD') do
       @app.options.rakelib = []
       @app.instance_eval do
         handle_options
         options.silent = true
         options.load_system = true
+        options.rakelib = []
         load_rakefile
       end
-      assert_equal "/AD/Rake", @app.system_dir
+      assert_equal "D:/AD/Rake", @app.system_dir
     end
   end
 
@@ -231,6 +235,19 @@ class TestApplication < Test::Unit::TestCase
     end
   end
 
+  def test_handle_options__should_strip_options_from_ARGV
+    assert !@app.options.trace
+
+    valid_option = '--trace'
+    ARGV.clear
+    ARGV << valid_option
+
+    @app.handle_options
+
+    assert !ARGV.include?(valid_option)
+    assert @app.options.trace
+  end
+
   def test_good_run
     ran = false
     ARGV.clear
@@ -279,7 +296,7 @@ class TestApplication < Test::Unit::TestCase
     @app.intern(Rake::Task, "default").enhance { fail }
     ARGV.clear
     ARGV << '-f' << '-s' <<  '--rakelib=""'
-    assert_raise(SystemExit) {
+    assert_exception(SystemExit) {
       err = capture_stderr { @app.run }
       assert_match(/see full trace/, err)
     }
@@ -291,7 +308,7 @@ class TestApplication < Test::Unit::TestCase
     @app.intern(Rake::Task, "default").enhance { fail }
     ARGV.clear
     ARGV << '-f' << '-s' << '-t'
-    assert_raise(SystemExit) {
+    assert_exception(SystemExit) {
       err = capture_stderr { capture_stdout { @app.run } }
       assert_no_match(/see full trace/, err)
     }
@@ -303,7 +320,7 @@ class TestApplication < Test::Unit::TestCase
     @app.intern(Rake::Task, "default").enhance { fail }
     ARGV.clear
     ARGV << '-f' << '-s' << '--xyzzy'
-    assert_raise(SystemExit) {
+    assert_exception(SystemExit) {
       err = capture_stderr { capture_stdout { @app.run } }
     }
   ensure
@@ -315,6 +332,7 @@ end
 ######################################################################
 class TestApplicationOptions < Test::Unit::TestCase
   include CaptureStdout
+  include TestMethods
 
   def setup
     clear_argv
@@ -447,7 +465,7 @@ class TestApplicationOptions < Test::Unit::TestCase
   end
 
   def test_missing_require
-    ex = assert_raises(LoadError) do
+    ex = assert_exception(LoadError) do
       flags(['--require', 'test/missing']) do |opts|
       end
     end
@@ -546,7 +564,7 @@ class TestApplicationOptions < Test::Unit::TestCase
 
   def test_bad_option
     capture_stderr do
-      ex = assert_raise(OptionParser::InvalidOption) do
+      ex = assert_exception(OptionParser::InvalidOption) do
         flags('--bad-option') 
       end
       if ex.message =~ /^While/ # Ruby 1.9 error message
@@ -594,7 +612,8 @@ class TestApplicationOptions < Test::Unit::TestCase
       throw :system_exit, :exit
     end
     @app.instance_eval do
-      collect_tasks handle_options
+      handle_options
+      collect_tasks
     end
     @tasks = @app.top_level_tasks
     @app.options

data/test/test_definitions.rb

@@ -4,10 +4,13 @@ require 'test/unit'
 require 'fileutils'
 require 'rake'
 require 'test/filecreation'
+require 'test/rake_test_setup'
 
 ######################################################################
 class TestDefinitions < Test::Unit::TestCase
   include Rake
+  include TestMethods
+  
   EXISTINGFILE = "testdata/existing"
 
   def setup
@@ -58,7 +61,7 @@ class TestDefinitions < Test::Unit::TestCase
 
   def test_missing_dependencies
     task :x => ["testdata/missing"]
-    assert_raises(RuntimeError) { Task[:x].invoke }
+    assert_exception(RuntimeError) { Task[:x].invoke }
   end
 
   def test_implicit_file_dependencies

data/test/test_file_task.rb

@@ -4,11 +4,13 @@ require 'test/unit'
 require 'fileutils'
 require 'rake'
 require 'test/filecreation'
+require 'test/rake_test_setup'
 
 ######################################################################
 class TestFileTask < Test::Unit::TestCase
   include Rake
   include FileCreation
+  include TestMethods
 
   def setup
     Task.clear
@@ -118,22 +120,24 @@ class TestDirectoryTask < Test::Unit::TestCase
     assert ! File.exist?("testdata/a/b/c")
   end
 
-  def test_directory_win32
-    desc "WIN32 DESC"
-    FileUtils.mkdir_p("testdata")
-    Dir.chdir("testdata") do
-      directory 'c:/testdata/a/b/c'
-      assert_equal FileCreationTask, Task['c:/testdata'].class
-      assert_equal FileCreationTask, Task['c:/testdata/a'].class
-      assert_equal FileCreationTask, Task['c:/testdata/a/b/c'].class
-      assert_nil             Task['c:/testdata'].comment
-      assert_equal "WIN32 DESC",   Task['c:/testdata/a/b/c'].comment
-      assert_nil             Task['c:/testdata/a/b'].comment
-      verbose(false) {
-        Task['c:/testdata/a/b'].invoke
-      }
-      assert File.exist?('c:/testdata/a/b')
-      assert ! File.exist?('c:/testdata/a/b/c')
+  if Rake::Win32.windows?
+    def test_directory_win32
+      desc "WIN32 DESC"
+      FileUtils.mkdir_p("testdata")
+      Dir.chdir("testdata") do
+        directory 'c:/testdata/a/b/c'
+        assert_equal FileCreationTask, Task['c:/testdata'].class
+        assert_equal FileCreationTask, Task['c:/testdata/a'].class
+        assert_equal FileCreationTask, Task['c:/testdata/a/b/c'].class
+        assert_nil             Task['c:/testdata'].comment
+        assert_equal "WIN32 DESC",   Task['c:/testdata/a/b/c'].comment
+        assert_nil             Task['c:/testdata/a/b'].comment
+        verbose(false) {
+          Task['c:/testdata/a/b'].invoke
+        }
+        assert File.exist?('c:/testdata/a/b')
+        assert ! File.exist?('c:/testdata/a/b/c')
+      end
     end
   end
 end

data/test/test_filelist.rb

@@ -4,10 +4,12 @@ require 'test/unit'
 require 'rake'
 
 require 'test/capture_stdout'
+require 'test/rake_test_setup'
 
 class TestFileList < Test::Unit::TestCase
   FileList = Rake::FileList
   include CaptureStdout
+  include TestMethods
 
   def setup
     create_test_data
@@ -442,7 +444,7 @@ class TestFileList < Test::Unit::TestCase
     a = FileList['a', 'b', 'c']
     a.freeze
     c = a.clone
-    assert_raise(TypeError, RuntimeError) do
+    assert_exception(TypeError, RuntimeError) do
       c << 'more'
     end
   end