rake 0.7.3 → 0.8.7

data/doc/release_notes/rake-0.8.7.rdoc

@@ -0,0 +1,55 @@
+= Rake 0.8.7 Released
+
+Rake version 0.8.5 introduced greatly improved support for executing
+commands on Windows.  The "sh" command now has the same semantics on
+Windows that it has on Unix based platforms.
+
+Rake version 0.8.6 includes minor fixes the the RDoc generation.
+Rake version 0.8.7 includes a minor fix for JRuby running on windows.
+
+== Changes
+
+=== New Features / Enhancements in Version 0.8.5
+
+* Improved implementation of the Rake system command for Windows.
+  (patch from James M. Lawrence/quix)
+
+* Support for Ruby 1.9's improved system command.  (patch from James
+  M. Lawrence/quix)
+
+* Rake now includes the configured extension when invoking an
+  executable (Config::CONFIG['EXEEXT])
+
+=== Bug Fixes in Version 0.8.5
+
+* Environment variable keys are now correctly cased (it matters in
+  some implementations).
+
+== 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 
+
+== 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 ...
+
+* Charles Nutter
+
+-- Jim Weirich

data/lib/rake/alt_system.rb

@@ -0,0 +1,108 @@
+#
+# Copyright (c) 2008 James M. Lawrence
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation files
+# (the "Software"), to deal in the Software without restriction,
+# including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software,
+# and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+require 'rbconfig'
+
+#
+# Alternate implementations of system() and backticks `` on Windows
+# for ruby-1.8 and earlier.
+# 
+module Rake::AltSystem
+  WINDOWS = Config::CONFIG["host_os"] =~ %r!(msdos|mswin|djgpp|mingw)!
+
+  class << self
+    def define_module_function(name, &block)
+      define_method(name, &block)
+      module_function(name)
+    end
+  end
+    
+  if WINDOWS and RUBY_VERSION < "1.9.0"
+    RUNNABLE_EXTS = %w[com exe bat cmd]
+    RUNNABLE_PATTERN = %r!\.(#{RUNNABLE_EXTS.join('|')})\Z!i
+
+    define_module_function :kernel_system, &Kernel.method(:system)
+    define_module_function :kernel_backticks, &Kernel.method(:'`')
+
+    module_function
+
+    def repair_command(cmd)
+      "call " + (
+        if cmd =~ %r!\A\s*\".*?\"!
+          # already quoted
+          cmd
+        elsif match = cmd.match(%r!\A\s*(\S+)!)
+          if match[1] =~ %r!/!
+            # avoid x/y.bat interpretation as x with option /y
+            %Q!"#{match[1]}"! + match.post_match
+          else
+            # a shell command will fail if quoted
+            cmd
+          end
+        else
+          # empty or whitespace
+          cmd
+        end
+      )
+    end
+
+    def find_runnable(file)
+      if file =~ RUNNABLE_PATTERN
+        file
+      else
+        RUNNABLE_EXTS.each { |ext|
+          if File.exist?(test = "#{file}.#{ext}")
+            return test
+          end
+        }
+        nil
+      end
+    end
+
+    def system(cmd, *args)
+      repaired = (
+        if args.empty?
+          [repair_command(cmd)]
+        elsif runnable = find_runnable(cmd)
+          [File.expand_path(runnable), *args]
+        else
+          # non-existent file
+          [cmd, *args]
+        end
+      )
+      kernel_system(*repaired)
+    end
+
+    def backticks(cmd)
+      kernel_backticks(repair_command(cmd))
+    end
+
+    define_module_function :'`', &method(:backticks)
+  else
+    # Non-Windows or ruby-1.9+: same as Kernel versions
+    define_module_function :system, &Kernel.method(:system)
+    define_module_function :backticks, &Kernel.method(:'`')
+    define_module_function :'`', &Kernel.method(:'`')
+  end
+end

data/lib/rake/contrib/ftptools.rb

@@ -6,7 +6,6 @@
 # use.
 
 require 'date'
-require 'parsedate'
 require 'net/ftp'
 
 module Rake # :nodoc:
@@ -20,6 +19,10 @@ module Rake # :nodoc:
       @date_class ||= Date
     end
 
+    def self.time
+      @time_class ||= Time
+    end
+
     def initialize(path, entry)
       @path = path
       @mode, line, @owner, @group, size, d1, d2, d3, @name = entry.split(' ')
@@ -54,17 +57,28 @@ module Rake # :nodoc:
     end
 
     def determine_time(d1, d2, d3)
-      elements = ParseDate.parsedate("#{d1} #{d2} #{d3}")
-      if elements[0].nil?
-        today = self.class.date.today
-        if elements[1] > today.month
-          elements[0] = today.year - 1
-        else
-          elements[0] = today.year
+      now = self.class.time.now
+      if /:/ =~ d3
+        h, m = d3.split(':')
+        result = Time.parse("#{d1} #{d2} #{now.year} #{d3}")
+        if result > now
+          result = Time.parse("#{d1} #{d2} #{now.year-1} #{d3}")
         end
+      else
+        result = Time.parse("#{d1} #{d2} #{d3}")
       end
-      elements = elements.collect { |el| el.nil? ? 0 : el }
-      Time.mktime(*elements[0,7])
+      result
+#       elements = ParseDate.parsedate("#{d1} #{d2} #{d3}")
+#       if elements[0].nil?
+#         today = self.class.date.today
+#         if elements[1] > today.month
+#           elements[0] = today.year - 1
+#         else
+#           elements[0] = today.year
+#         end
+#       end
+#       elements = elements.collect { |el| el.nil? ? 0 : el }
+#       Time.mktime(*elements[0,7])
     end
   end
 

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
@@ -23,7 +23,10 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 #
-require 'ftools'
+begin
+  require 'ftools'
+rescue LoadError
+end
 require 'rbconfig'
 
 ######################################################################

data/lib/rake/gempackagetask.rb

@@ -6,12 +6,8 @@
 require 'rubygems'
 require 'rake'
 require 'rake/packagetask'
-
-begin
-  Gem.manage_gems
-rescue NoMethodError => ex
-  # Using rubygems prior to 0.6.1
-end
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
 
 module Rake
 

data/lib/rake/loaders/makefile.rb

@@ -4,34 +4,36 @@ 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)
-      buffer = ''
       open(fn) do |mf|
-        mf.each do |line|
-          next if line =~ /^\s*#/
-          buffer << line
-          if buffer =~ /\\$/
-            buffer.sub!(/\\\n/, ' ')
-            state = :append
-          else
-            process_line(buffer)
-            buffer = ''
-          end
+        lines = mf.read
+        lines.gsub!(/\\ /, SPACE_MARK)
+        lines.gsub!(/#[^\n]*\n/m, "")
+        lines.gsub!(/\\\n/, ' ')
+        lines.split("\n").each do |line|
+          process_line(line)
         end
       end
-      process_line(buffer) if buffer != ''
     end
 
     private
 
     # Process one logical line of makefile data.
     def process_line(line)
-      file_task, args = line.split(':')
+      file_tasks, args = line.split(':')
       return if args.nil?
-      dependents = args.split
-      file file_task => dependents
+      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
 

data/lib/rake/rdoctask.rb

@@ -28,6 +28,11 @@ module Rake
   #     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,34 +63,45 @@ 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
     # RDoc. (default is none)
     attr_accessor :main
 
-    # Name of template to be used by rdoc. (default is 'html')
+    # Name of template to be used by rdoc. (defaults to rdoc's default)
     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 [])
+    # 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'
       @main = nil
       @title = nil
-      @template = 'html'
+      @template = nil
       @external = false
+      @inline_source = true
       @options = []
       yield self if block_given?
       define
@@ -83,31 +109,32 @@ 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 paste("re", name) => [paste("clobber_", name), name]
+      task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
       
       desc "Remove rdoc products" 
-      task paste("clobber_", name) do
+      task clobber_task_name do
         rm_r rdoc_dir rescue nil
       end
-
-      task :clobber => [paste("clobber_", name)]
+      
+      task :clobber => [clobber_task_name]
       
       directory @rdoc_dir
-      task name => [rdoc_target]
-      file rdoc_target => @rdoc_files + [$rakefile] do
+      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(' ')
-          sh %{ruby -Ivendor vender/rd #{argstring}}
+          sh %{ruby -Ivendor vendor/rd #{argstring}}
         else
           require 'rdoc/rdoc'
           RDoc::RDoc.new.document(args)
@@ -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/tasklib.rb

@@ -6,11 +6,16 @@ module Rake
 
   # Base class for Task Libraries.
   class TaskLib
-
     include Cloneable
 
-    # Make a symbol by pasting two strings together. 
-    def paste(a,b)
+    # Make a symbol by pasting two strings together.
+    #
+    # NOTE: DEPRECATED! This method is kinda stupid. I don't know why
+    # I didn't just use string interpolation. But now other task
+    # libraries depend on this so I can't remove it without breaking
+    # other people's code. So for now it stays for backwards
+    # compatibility. BUT DON'T USE IT.
+    def paste(a,b)              # :nodoc:
       (a.to_s + b.to_s).intern
     end
   end

data/lib/rake/testtask.rb

@@ -109,7 +109,7 @@ module Rake
             when :rake
               rake_loader
             end
-          @ruby_opts.unshift( "-I#{lib_path}" )
+          @ruby_opts.unshift( "-I\"#{lib_path}\"" )
           @ruby_opts.unshift( "-w" ) if @warning
           ruby @ruby_opts.join(" ") +
             " \"#{run_code}\" " +

data/lib/rake/win32.rb

@@ -0,0 +1,55 @@
+
+module Rake
+  require 'rake/alt_system'
+
+  # Win 32 interface methods for Rake. Windows specific functionality
+  # will be placed here to collect that knowledge in one spot.
+  module Win32
+    
+    # Error indicating a problem in locating the home directory on a
+    # Win32 system.
+    class Win32HomeError < RuntimeError
+    end
+    
+    class << self
+      # True if running on a windows system.
+      def windows?
+        AltSystem::WINDOWS
+      end
+
+      # Run a command line on windows.
+      def rake_system(*cmd)
+        AltSystem.system(*cmd)
+      end
+      
+      # The standard directory containing system wide rake files on
+      # Win 32 systems. Try the following environment variables (in
+      # order):
+      #
+      # * HOME
+      # * HOMEDRIVE + HOMEPATH
+      # * APPDATA
+      # * USERPROFILE
+      #
+      # If the above are not defined, the return nil.
+      def win32_system_dir #:nodoc:
+        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(/\\/, '/')
+      end
+      
+    end
+  end
+end