rake 0.8.3 → 0.8.4

data/doc/rakefile.rdoc

@@ -1,4 +1,4 @@
-= Rakefile Format (as of version 0.8.2)
+= Rakefile Format (as of version 0.8.3)
 
 First of all, there is no special format for a Rakefile.  A Rakefile
 contains executable Ruby code.  Anything legal in a ruby script is
@@ -225,8 +225,8 @@ where we specify default values for the first and last names:
 === Tasks that Expect Parameters and Have Prerequisites
 
 Tasks that use parameters have a slightly different format for
-prerequisites.  Use the <tt>:needs</tt> keyword to specify the
-prerequisites for tasks with arguments.  For example:
+prerequisites.  Use the arrow notation to indicate the prerequisites
+for tasks with arguments.  For example:
 
    task :name, [:first_name, :last_name] => [:pre_name] do |t, args|
      args.with_defaults(:first_name => "John", :last_name => "Dough")
@@ -237,7 +237,7 @@ prerequisites for tasks with arguments.  For example:
 === Deprecated Task Parameters Format
 
 There is an older format for declaring task parameters that omitted
-the task array and used the :needs keyword to introduce the
+the task argument array and used the :needs keyword to introduce the
 dependencies.  That format is still supported for compatibility, but
 is not recommended for use.
 

data/doc/release_notes/rake-0.8.4.rdoc

@@ -0,0 +1,137 @@
+= Rake 0.8.4 Released
+
+Rake version 0.8.4 is a bug-fix release of rake.
+
+NOTE: The version of Rake that comes with Ruby 1.9 has diverged
+      slightly from the core Rake code base.  Rake 0.8.4 will work
+      with Ruby 1.9, but is not a strict upgrade for the Rake that
+      comes with Ruby 1.9.  A (near) future release of Rake will unify
+      those two codebases.
+
+== Changes
+
+=== New Features / Enhancements in Version 0.8.4
+
+* Case is preserved on rakefile names. (patch from James
+  M. Lawrence/quix)
+
+* Improved Rakefile case insensitivity testing (patch from Luis
+  Lavena).
+
+* Windows system dir search order is now: HOME, HOMEDRIVE + HOMEPATH,
+  APPDATA, USERPROFILE (patch from Luis Lavena)
+
+* MingGW is now recognized as a windows platform.  (patch from Luis
+  Lavena)
+
+=== Bug Fixes in Version 0.8.4
+
+* Removed reference to manage_gem to fix the warning produced by the
+  gem package task.
+
+* Fixed stray ARGV option problem that was interfering with
+  Test::Unit::Runner. (patch from Pivotal Labs)
+
+=== Infrastructure Improvements in Version 0.8.4
+
+* Numerous fixes to the windows test suite (patch from Luis Lavena).
+
+* Improved Rakefile case insensitivity testing (patch from Luis
+  Lavena).
+
+* Better support for windows paths in the test task (patch from Simon
+  Chiang/bahuvrihi)
+
+== What is Rake
+
+Rake is a build tool similar to the make program in many ways. But
+instead of cryptic make recipes, Rake uses standard Ruby code to
+declare tasks and dependencies. You have the full power of a modern
+scripting language built right into your build tool.
+
+== Availability
+
+The easiest way to get and install rake is via RubyGems ...
+
+  gem install rake    (you may need root/admin privileges)
+
+Otherwise, you can get it from the more traditional places:
+
+Home Page:: http://rake.rubyforge.org/
+Download::  http://rubyforge.org/project/showfiles.php?group_id=50
+GitHub::    git://github.com/jimweirich/rake.git 
+
+== Task Argument Examples
+
+Prior to version 0.8.0, rake was only able to handle command line
+arguments of the form NAME=VALUE that were passed into Rake via the
+ENV hash.  Many folks had asked for some kind of simple command line
+arguments, perhaps using "--" to separate regular task names from
+argument values on the command line.  The problem is that there was no
+easy way to associate positional arguments on the command line with
+different tasks.  Suppose both tasks :a and :b expect a command line
+argument: does the first value go with :a?  What if :b is run first?
+Should it then get the first command line argument.
+
+Rake 0.8.0 solves this problem by explicitly passing values directly
+to the tasks that need them.  For example, if I had a release task
+that required a version number, I could say:
+
+   rake release[0.8.4]
+
+And the string "0.8.4" will be passed to the :release task.  Multiple
+arguments can be passed by separating them with a comma, for example:
+
+   rake name[john,doe]
+
+Just a few words of caution.  The rake task name and its arguments
+need to be a single command line argument to rake.  This generally
+means no spaces.  If spaces are needed, then the entire rake +
+argument string should be quoted.  Something like this:
+
+   rake "name[billy bob, smith]"
+
+(Quoting rules vary between operating systems and shells, so make sure
+you consult the proper docs for your OS/shell).
+
+=== Tasks that Expect Parameters
+
+Parameters are only given to tasks that are setup to expect them.  In
+order to handle named parameters, the task declaration syntax for
+tasks has been extended slightly.
+
+For example, a task that needs a first name and last name might be
+declared as:
+
+   task :name, :first_name, :last_name
+
+The first argument is still the name of the task (:name in this case).
+The next to argumements are the names of the parameters expected by
+:name (:first_name and :last_name in the example).
+
+To access the values of the paramters, the block defining the task
+behaviour can now accept a second parameter:
+
+   task :name, :first_name, :last_name do |t, args|
+     puts "First name is #{args.first_name}"
+     puts "Last  name is #{args.last_name}"
+   end
+
+The first argument of the block "t" is always bound to the current
+task object.  The second argument "args" is an open-struct like object
+that allows access to the task arguments.  Extra command line
+arguments to a task are ignored.  Missing command line arguments are
+given the nil value.
+
+== Thanks
+
+As usual, it was input from users that drove a alot of these changes. The
+following people either contributed patches, made suggestions or made
+otherwise helpful comments.  Thanks to ...
+
+* James M. Lawrence/quix
+* Luis Lavena
+* Pivotal Labs
+* Simon Chiang/bahuvrihi
+
+-- Jim Weirich

data/lib/rake.rb

@@ -2,7 +2,7 @@
 
 #--
 
-# Copyright (c) 2003, 2004, 2005, 2006, 2007  Jim Weirich
+# Copyright 2003, 2004, 2005, 2006, 2007, 2008 by Jim Weirich (jim@weirichhouse.org)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to
@@ -29,7 +29,7 @@
 # as a library via a require statement, but it can be distributed
 # independently as an application.
 
-RAKEVERSION = '0.8.3'
+RAKEVERSION = '0.8.4'
 
 require 'rbconfig'
 require 'fileutils'
@@ -74,7 +74,7 @@ end # module Module
 #
 class String
   rake_extension("ext") do
-    # Replace the file extension with +newext+.  If there is no extenson on
+    # Replace the file extension with +newext+.  If there is no extension on
     # the string, append the new extension to the end.  If the new extension
     # is not given, or is the empty string, remove any existing extension.
     #
@@ -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.
@@ -972,7 +970,7 @@ module FileUtils
       }
     end
     if RakeFileUtils.verbose_flag == :default
-      options[:verbose] = false
+      options[:verbose] = true
     else
       options[:verbose] ||= RakeFileUtils.verbose_flag
     end
@@ -1463,8 +1461,8 @@ module Rake
       collect { |fn| fn.pathmap(spec) }
     end
 
-    # Return a new array with <tt>String#ext</tt> method applied to each
-    # member of the array.
+    # Return a new file list with <tt>String#ext</tt> method applied
+    # to each member of the array.
     #
     # This method is a shortcut for:
     #
@@ -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
 
@@ -2042,7 +2050,7 @@ module Rake
         exit(1)
       rescue Exception => ex
         # Exit with error message
-        $stderr.puts "rake aborted!"
+        $stderr.puts "#{name} aborted!"
         $stderr.puts ex.message
         if options.trace
           $stderr.puts ex.backtrace.join("\n")
@@ -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
@@ -2081,14 +2092,14 @@ module Rake
       tty_output? || ENV['RAKE_COLUMNS']
     end
 
-    # Display the tasks and dependencies.
+    # Display the tasks and comments.
     def display_tasks_and_comments
       displayable_tasks = tasks.select { |t|
         t.comment && t.name =~ options.show_task_pattern
       }
       if options.full_description
         displayable_tasks.each do |t|
-          puts "rake #{t.name_with_args}"
+          puts "#{name} #{t.name_with_args}"
           t.full_comment.split("\n").each do |line|
             puts "    #{line}"
           end
@@ -2147,7 +2158,7 @@ module Rake
     # Display the tasks and prerequisites
     def display_prerequisites
       tasks.each do |t|
-        puts "rake #{t.name}"
+        puts "#{name} #{t.name}"
         t.prerequisites.each { |pre| puts "    #{pre}" }
       end
     end
@@ -2259,7 +2270,7 @@ module Rake
             verbose(true)
           }
         ],
-        ['--verbose', '-v', "Log message to standard output (default).",
+        ['--verbose', '-v', "Log message to standard output.",
           lambda { |value| verbose(true) }
         ],
         ['--version', '-V', "Display the program version.",
@@ -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/lib/rake/contrib/publisher.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright 2003, 2004 by Jim Weirich (jim@weirichhouse.org)
+# Copyright 2003, 2004, 2005, 2006, 2007, 2008 by Jim Weirich (jim@weirichhouse.org)
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,

data/lib/rake/contrib/sys.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #--
-# Copyright (c) 2003, 2004 Jim Weirich
+# Copyright 2003, 2004, 2005, 2006, 2007, 2008 by Jim Weirich (jim@weirichhouse.org)
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/rake/gempackagetask.rb

@@ -9,12 +9,6 @@ require 'rake/packagetask'
 require 'rubygems/user_interaction'
 require 'rubygems/builder'
 
-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

data/lib/rake/loaders/makefile.rb

@@ -4,11 +4,13 @@ module Rake
 
   # Makefile loader to be used with the import file loader.
   class MakefileLoader
+    SPACE_MARK = "__ __"
 
     # Load the makefile dependencies in +fn+.
     def load(fn)
       open(fn) do |mf|
         lines = mf.read
+        lines.gsub!(/\\ /, SPACE_MARK)
         lines.gsub!(/#[^\n]*\n/m, "")
         lines.gsub!(/\\\n/, ' ')
         lines.split("\n").each do |line|
@@ -23,11 +25,16 @@ module Rake
     def process_line(line)
       file_tasks, args = line.split(':')
       return if args.nil?
-      dependents = args.split
+      dependents = args.split.map { |d| respace(d) }
       file_tasks.strip.split.each do |file_task|
+        file_task = respace(file_task)
         file file_task => dependents
       end
     end
+    
+    def respace(str)
+      str.gsub(/#{SPACE_MARK}/, ' ')
+    end
   end
 
   # Install the handler

data/lib/rake/packagetask.rb

@@ -122,7 +122,6 @@ module Rake
           task :package => ["#{package_dir}/#{file}"]
           file "#{package_dir}/#{file}" => [package_dir_path] + package_files do
             chdir(package_dir) do
-              sh %{env}
               sh %{#{@tar_command} #{flag}cvf #{file} #{package_name}}
             end
           end

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