rake 0.8.2 → 0.8.3

data/CHANGES

@@ -1,6 +1,16 @@
 
 = Rake Changelog
 
+== Version 0.8.3
+
+* Enhanced the system directory detection in windows. We now check
+  HOMEDRIVE/HOMEPATH and USERPROFILE if APPDATA isn't found. (Patch
+  supplied by James Tucker). Rake no long aborts if it can't find the
+  directory.
+
+* Added fix to handle ruby installations in directories with spaces in
+  their name.  
+
 == Version 0.8.2
 
 * Fixed bug in package task so that it will include the subdir

data/README

@@ -1,6 +1,6 @@
 = RAKE -- Ruby Make 
 
-Supporting Rake version: 0.8.3
+Supporting Rake version: 0.8.2
 
 This package contains Rake, a simple ruby build program with
 capabilities similar to make.

data/doc/release_notes/rake-0.8.3.rdoc

@@ -0,0 +1,112 @@
+= Rake 0.8.3 Released
+
+Rake version 0.8.3 is a bug-fix release of rake.
+
+== Changes
+
+=== Bug Fixes in Version 0.8.3
+
+* Enhanced the system directory detection in windows. We now check
+  HOMEDRIVE/HOMEPATH and USERPROFILE if APPDATA isn't found. (Patch
+  supplied by James Tucker). Rake no long aborts if it can't find the
+  directory.
+
+* Added fix to handle ruby installations in directories with spaces in
+  their name.  
+
+== 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
+
+== 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.3]
+
+And the string "0.8.3" 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 ...
+
+* Edwin Pratomo
+* Gavin Stark
+* Adam Q. Salter
+* Adam Majer
+* Emanuel Inderm�hle
+* Ittay Dror
+* Bheeshmar Redheendran (for spending an afternoon with me debugging
+  windows issues)
+
+-- Jim Weirich

data/lib/rake.rb

@@ -29,16 +29,17 @@
 # as a library via a require statement, but it can be distributed
 # independently as an application.
 
-RAKEVERSION = '0.8.2'
+RAKEVERSION = '0.8.3'
 
 require 'rbconfig'
-require 'getoptlong'
 require 'fileutils'
 require 'singleton'
 require 'monitor'
 require 'optparse'
 require 'ostruct'
 
+require 'rake/win32'
+
 ######################################################################
 # Rake extensions to Module.
 #
@@ -262,11 +263,6 @@ module Rake
     end
   end
 
-  # Error indicating a problem in locating the home directory on a
-  # Win32 system.
-  class Win32HomeError < RuntimeError
-  end
-
   # --------------------------------------------------------------------------
   # Rake module singleton methods.
   #
@@ -943,7 +939,8 @@ end
 # added to the FileUtils utility functions.
 #
 module FileUtils
-  RUBY = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+  RUBY = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name']).
+    sub(/.*\s.*/m, '"\&"')
 
   OPT_TABLE['sh']  = %w(noop verbose)
   OPT_TABLE['ruby'] = %w(noop verbose)
@@ -989,23 +986,14 @@ module FileUtils
   end
 
   def rake_system(*cmd)
-    if Rake.application.windows?
-      rake_win32_system(*cmd)
+    if Rake::Win32.windows?
+      Rake::Win32.rake_system(*cmd)
     else
       system(*cmd)
     end
   end
   private :rake_system
 
-  def rake_win32_system(*cmd)
-    if cmd.size == 1
-      system("call #{cmd}")
-    else
-      system(*cmd)
-    end
-  end
-  private :rake_win32_system
-
   # Run a Ruby interpreter with the given arguments.
   #
   # Example:
@@ -1587,7 +1575,7 @@ module Rake
   class << self
 
     # Yield each file or directory component.
-    def each_dir_parent(dir)
+    def each_dir_parent(dir)    # :nodoc:
       old_length = nil
       while dir != '.' && dir.length != old_length
         yield(dir)
@@ -2145,7 +2133,7 @@ module Rake
     end
     
     def windows?
-      Config::CONFIG['host_os'] =~ /mswin/
+      Win32.windows?
     end
 
     def truncate(string, width)
@@ -2346,7 +2334,7 @@ module Rake
       rakefile, location = find_rakefile_location
       if (! options.ignore_system) &&
           (options.load_system || rakefile.nil?) &&
-          directory?(system_dir)
+          system_dir && File.directory?(system_dir)
         puts "(in #{Dir.pwd})" unless options.silent
         glob("#{system_dir}/*.rake") do |name|
           add_import name
@@ -2375,38 +2363,24 @@ module Rake
 
     # The directory path containing the system wide rakefiles.
     def system_dir
-      if ENV['RAKE_SYSTEM']
-        ENV['RAKE_SYSTEM']
-      elsif windows?
-        win32_system_dir
-      else
-        standard_system_dir
-      end
+      @system_dir ||=
+        begin
+          if ENV['RAKE_SYSTEM']
+            ENV['RAKE_SYSTEM']
+          elsif Win32.windows?
+            Win32.win32_system_dir
+          else
+            standard_system_dir
+          end
+        end
     end
- 
+    
     # The standard directory containing system wide rake files.
     def standard_system_dir #:nodoc:
       File.join(File.expand_path('~'), '.rake')
     end
     private :standard_system_dir
 
-    # The standard directory containing system wide rake files on Win
-    # 32 systems.
-    def win32_system_dir #:nodoc:
-      win32home = File.join(ENV['APPDATA'], 'Rake')
-      unless directory?(win32home)
-        raise Win32HomeError, "Unable to determine home path environment variable."
-      else
-        win32home
-      end
-    end
-    private :win32_system_dir
-
-    def directory?(path)
-      File.directory?(path)
-    end
-    private :directory?
-
     # 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.

data/lib/rake/win32.rb

@@ -0,0 +1,54 @@
+module Rake
+  
+  # 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?
+        Config::CONFIG['host_os'] =~ /mswin/
+      end
+
+      # Run a command line on windows.
+      def rake_system(*cmd)
+        if cmd.size == 1
+          system("call #{cmd}")
+        else
+          system(*cmd)
+        end
+      end
+      
+      # The standard directory containing system wide rake files on
+      # Win 32 systems. Try the following environment variables (in
+      # order):
+      #
+      # * APPDATA
+      # * HOMEDRIVE + HOMEPATH
+      # * USERPROFILE
+      #
+      # If the above are not defined, the return nil.
+      def win32_system_dir #:nodoc:
+        win32_shared_path = ENV['APPDATA']
+        if win32_shared_path.nil? && ENV['HOMEDRIVE'] && ENV['HOMEPATH']
+          win32_shared_path = ENV['HOMEDRIVE'] + ENV['HOMEPATH']
+        end
+        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

data/test/rake_test_setup.rb

@@ -1,5 +1,10 @@
 # Common setup for all test files.
 
-require 'rubygems'
-gem 'flexmock'
+begin
+  require 'rubygems'
+  gem 'flexmock'
+rescue LoadError
+  # got no gems
+end
+
 require 'flexmock/test_unit'

data/test/test_application.rb

@@ -109,7 +109,7 @@ class TestApplication < Test::Unit::TestCase
   end
 
   def test_finding_rakefile
-    assert_equal "rakefile", @app.instance_eval { have_rakefile }
+    assert_match(/[Rr]akefile/, @app.instance_eval { have_rakefile })
   end
 
   def test_not_finding_rakefile
@@ -193,10 +193,10 @@ class TestApplication < Test::Unit::TestCase
   end
 
   def test_load_from_system_rakefile_on_windows
-    flexmock(@app, :windows? => true,
-      :standard_system_dir => "XX")
+    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 { |fn| puts "LOADING #{fn}" }
+    flexmock(@app).should_receive(:load).and_return(nil)
     in_environment('RAKE_SYSTEM' => nil, 'APPDATA' => '/AD') do
       @app.options.rakelib = []
       @app.instance_eval do
@@ -209,26 +209,6 @@ class TestApplication < Test::Unit::TestCase
     end
   end
 
-  def test_load_from_system_rakefile_on_windows_with_no_appdata
-    flexmock(@app, :windows? => true,
-      :standard_system_dir => "XX"
-      )
-    flexmock(File).should_receive(:exists?).with("/AD/Rake").and_return(false)
-    out = capture_stderr do
-      assert_raise(SystemExit) do
-        in_environment('RAKE_SYSTEM' => nil, 'APPDATA' => "/AD") do
-          @app.options.rakelib = []
-          @app.instance_eval do
-            handle_options
-            options.silent = true
-            options.load_system = true
-            load_rakefile
-          end
-        end
-      end
-    end
-  end
-
   def test_loading_imports
     mock = flexmock("loader")
     mock.should_receive(:load).with("x.dummy").once

data/test/test_win32.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'test/rake_test_setup'
+require 'test/in_environment'
+
+require 'rake'
+
+class TestWin32 < Test::Unit::TestCase
+  include InEnvironment
+
+  Win32 = Rake::Win32
+  
+  def test_win32_system_dir_uses_appdata_if_defined
+    in_environment('RAKE_SYSTEM' => nil, 'APPDATA' => '\\AD') do
+      assert_equal "/AD/Rake", Win32.win32_system_dir 
+    end
+  end
+
+  def test_win32_system_dir_uses_homedrive_otherwise
+    in_environment(
+      'RAKE_SYSTEM' => nil,
+      'APPDATA' => nil,
+      'HOMEDRIVE' => "C:",
+      "HOMEPATH" => "\\HP"
+      ) do
+      assert_equal "C:/HP/Rake", Win32.win32_system_dir
+    end
+  end
+
+  def test_win32_system_dir_uses_userprofile_otherwise
+    in_environment(
+      'RAKE_SYSTEM' => nil,
+      'APPDATA' => nil,
+      'HOMEDRIVE' => nil,
+      "HOMEPATH" => nil,
+      "USERPROFILE" => '\\UP'
+      ) do
+      assert_equal "/UP/Rake", Win32.win32_system_dir
+    end
+  end
+
+  def test_win32_system_dir_nil_of_no_env_vars
+    in_environment(
+      'RAKE_SYSTEM' => nil,
+      'APPDATA' => nil,
+      'HOMEDRIVE' => nil,
+      "HOMEPATH" => nil,
+      "USERPROFILE" => nil
+      ) do
+      assert_raise(Rake::Win32::Win32HomeError) do
+        Win32.win32_system_dir
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rake
 version: !ruby/object:Gem::Version 
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors: 
 - Jim Weirich
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-09 00:00:00 -04:00
+date: 2008-09-25 00:00:00 -04:00
 default_executable: rake
 dependencies: []
 
@@ -40,6 +40,7 @@ extra_rdoc_files:
 - doc/release_notes/rake-0.7.3.rdoc
 - doc/release_notes/rake-0.8.0.rdoc
 - doc/release_notes/rake-0.8.2.rdoc
+- doc/release_notes/rake-0.8.3.rdoc
 files: 
 - install.rb
 - CHANGES
@@ -65,6 +66,7 @@ files:
 - lib/rake/runtest.rb
 - lib/rake/tasklib.rb
 - lib/rake/testtask.rb
+- lib/rake/win32.rb
 - lib/rake.rb
 - test/capture_stdout.rb
 - test/check_expansion.rb
@@ -104,6 +106,7 @@ files:
 - test/test_tasks.rb
 - test/test_test_task.rb
 - test/test_top_level_functions.rb
+- test/test_win32.rb
 - test/data/imports/deps.mf
 - test/data/sample.mf
 - test/data/chains/Rakefile
@@ -141,6 +144,7 @@ files:
 - doc/release_notes/rake-0.7.3.rdoc
 - doc/release_notes/rake-0.8.0.rdoc
 - doc/release_notes/rake-0.8.2.rdoc
+- doc/release_notes/rake-0.8.3.rdoc
 has_rdoc: true
 homepage: http://rake.rubyforge.org
 post_install_message: