rake 0.9.0 → 0.9.1

data/CHANGES

@@ -1,12 +1,17 @@
 = Rake Changelog
 
+== Version 0.9.1
+
+* Added deprecation warnings to the Rake DSL methods.
+
 == Version 0.9.0
 
-* Rake now warns when the deprecated :needs syntax used.
+* *Incompatible* *change*: Rake DSL commands ('task', 'file', etc.)  are
+  no longer private methods in Object.  If you need to call 'task :xzy' inside
+  your class, include Rake::DSL into the class.  The DSL is still available at
+  the top level scope (via the top level object which extends Rake::DSL).
 
-* Moved Rake DSL commands to top level ruby object 'main'.  Rake DSL
-  commands are no longer private methods in Object. (Suggested by
-  James M. Lawrence/quix)
+* Rake now warns when the deprecated :needs syntax used.
 
 * Rake history is now UTF-8 encoded.
 
@@ -36,10 +41,6 @@
 
 * Rake no longer emits warnings for Config.  Patch by Santiago Pastorino.
 
-* Removed Rake's DSL methods from the top level scope.  If you need to
-  call 'task :xzy' in your code, include Rake::DSL into your class, or
-  put the code in a Rake::DSL.environment do ... end block.
-
 * Split rake.rb into individual files.
 
 * Support for the --where (-W) flag for showing where a task is defined.

data/RRR

@@ -0,0 +1,10 @@
+class Zippy
+  def initialize
+    task :a
+    task :b
+    file "x"
+    cp "x", "y"
+  end
+end
+
+Zippy.new

data/Rakefile

@@ -58,50 +58,15 @@ SRC_RB = FileList['lib/**/*.rb']
 # The default task is run if rake is given no explicit arguments.
 
 desc "Default Task"
-task :default => "test:all"
+task :default => :test
 
 # Test Tasks ---------------------------------------------------------
 
-# Common Abbreviations ...
-
-task :ta => "test:all"
-task :tf => "test:functional"
-task :tu => "test:units"
-task :tc => "test:contribs"
-task :test => "test:units"
-
-module TestFiles
-  UNIT = FileList['test/lib/*_test.rb']
-  FUNCTIONAL = FileList['test/functional/*_test.rb']
-  CONTRIB = FileList['test/contrib/test*.rb']
-  TOP = FileList['test/*_test.rb']
-  ALL = TOP + UNIT + FUNCTIONAL + CONTRIB
-end
-
-namespace :test do
-  Rake::TestTask.new(:all) do |t|
-    t.test_files = TestFiles::ALL
-    t.libs << "."
-    t.warning = true
-  end
-
-  Rake::TestTask.new(:units) do |t|
-    t.test_files = TestFiles::UNIT
-    t.libs << "."
-    t.warning = true
-  end
-
-  Rake::TestTask.new(:functional) do |t|
-    t.test_files = TestFiles::FUNCTIONAL
-    t.libs << "."
-    t.warning = true
-  end
-
-  Rake::TestTask.new(:contribs) do |t|
-    t.test_files = TestFiles::CONTRIB
-    t.libs << "."
-    t.warning = true
-  end
+Rake::TestTask.new do |t|
+  files = FileList['test/helper.rb', 'test/test_*.rb']
+  t.test_files = files
+  t.libs << "."
+  t.warning = true
 end
 
 begin
@@ -143,9 +108,7 @@ rescue LoadError
 end
 
 directory 'testdata'
-["test:all", :test_units, :test_contribs, :test_functional].each do |t|
-  task t => ['testdata']
-end
+task :test => ['testdata']
 
 # CVS Tasks ----------------------------------------------------------
 
@@ -217,6 +180,7 @@ else
     #### Dependencies and requirements.
 
     s.required_rubygems_version = '>= 1.3.2'
+    s.add_development_dependency 'minitest', '~> 2.1'
     s.add_development_dependency 'session', '~> 2.4'
     s.add_development_dependency 'flexmock', '~> 0.8.11'
 
@@ -342,7 +306,7 @@ desc "Make a new release"
 task :release, [:rel, :reuse, :reltest] => [
     :prerelease,
     :clobber,
-    "test:all",
+    :test,
     :update_version,
     :package,
     :tag

data/bin/rake

@@ -23,9 +23,10 @@
 #++
 
 begin
-  require 'rake'
-rescue LoadError
   require 'rubygems'
-  require 'rake'
+rescue LoadError
 end
+
+require 'rake'
+
 Rake.application.run

data/doc/release_notes/rake-0.9.1.rdoc

@@ -0,0 +1,52 @@
+= Rake 0.9.1 Released
+
+Rake version 0.9.1 has a number of bug fixes and enhancments (see
+below for more details).  Additionally, the internals have be slightly
+restructured and improved.
+
+== Changes
+
+Rake 0.9.1 adds back the global DSL methods, but with deprecation
+messages.  This allows Rake 0.9.1 to be used with older rakefiles with
+warning messages.
+
+== 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 ...
+
+* James M. Lawrence (quix)
+* Roger Pack
+* Cezary Baginski
+* Sean Scot August Moon
+* R.T. Lechow
+* Alex Chaffee
+* James Tucker
+* Matthias Lüdtke
+* Santiago Pastorino
+
+Also, bit thanks to Eric Hodel for assisting with getting this release
+out the door (where "assisting" includes, but is not by any means
+limited to, "pushing" me to get it done).
+
+-- Jim Weirich

data/lib/rake/dsl_definition.rb

@@ -12,6 +12,8 @@ module Rake
     private(*FileUtils.instance_methods(false))
     private(*FileUtilsExt.instance_methods(false))
 
+    private
+
     # Declare a basic task.
     #
     # Example:
@@ -137,7 +139,24 @@ module Rake
     end
   end
 
+  module DeprecatedObjectDSL
+    dsl = Object.new.extend DSL
+    DSL.private_instance_methods(false).each do |name|
+      define_method name do |*args, &block|
+        unless @rake_dsl_warning
+          $stderr.puts "WARNING: Global access to Rake DSL methods is deprecated.  Please Include"
+          $stderr.puts "    ...  Rake::DSL into classes and modules which use the Rake DSL methods."
+          @rake_dsl_warning = true
+        end
+        $stderr.puts "WARNING: DSL method #{self.class}##{name} called at #{caller.first}"
+        dsl.send(name, *args, &block)
+      end
+      private name
+    end
+  end
+
   extend FileUtilsExt
 end
 
 self.extend Rake::DSL
+include Rake::DeprecatedObjectDSL

data/lib/rake/version.rb

@@ -3,7 +3,7 @@ module Rake
     NUMBERS = [
       MAJOR = 0,
       MINOR = 9,
-      BUILD = 0,
+      BUILD = 1,
     ]
   end
   VERSION = Version::NUMBERS.join('.')

data/test/data/access/Rakefile

@@ -14,7 +14,9 @@ task :work do
   end
 end
 
-task :obj do
+# TODO: remove `disabled_' when DeprecatedObjectDSL removed
+task :obj
+task :disabled_obj do
   begin
     Object.new.instance_eval { task :xyzzy }
     puts "BAD:D  Rake DSL are polluting objects"

data/test/data/default/Rakefile

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 if ENV['TESTTOPSCOPE']
   puts "TOPSCOPE"
 end

data/test/data/file_creation_task/Rakefile

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 N = 2
 
 task :default => :run

data/test/data/multidesc/Rakefile

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 task :b
 
 desc "A"

data/test/data/namespace/Rakefile

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 desc "copy"
 task :copy do
   puts "COPY"

data/test/data/statusreturn/Rakefile

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 task :exit5 do
   exit(5)
 end

data/test/file_creation.rb

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 module FileCreation
   OLDFILE = "testdata/old"
   NEWFILE = "testdata/new"

data/test/helper.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'minitest/unit'
+require 'flexmock/test_unit_integration'
+require 'minitest/autorun'
+require 'rake'
+require File.expand_path('../file_creation', __FILE__)
+require File.expand_path('../in_environment', __FILE__)
+
+class Rake::TestCase < MiniTest::Unit::TestCase
+  include FlexMock::ArgumentTypes
+  include FlexMock::MockContainer
+
+  include InEnvironment
+  include FileCreation
+
+  include Rake::DSL
+
+  class TaskManager
+    include Rake::TaskManager
+  end
+
+  def setup
+    @orig_PWD = Dir.pwd
+  end
+
+  def teardown
+    flexmock_teardown
+
+    Dir.chdir @orig_PWD
+  end
+
+  def ignore_deprecations
+    Rake.application.options.ignore_deprecate = true
+    yield
+  ensure
+    Rake.application.options.ignore_deprecate = false
+  end
+
+end
+
+# workarounds for 1.8
+$" << 'test/helper.rb'
+Test::Unit.run = true if Test::Unit.respond_to? :run=
+

data/test/in_environment.rb

@@ -13,10 +13,12 @@ module InEnvironment
   end
 
   # Set the environment according to the settings hash.
-  def set_env(settings)         # :nodoc:
+  def set_env(settings) # :nodoc:
     result = {}
+
     settings.each do |k, v|
       result[k] = ENV[k]
+
       if k == 'PWD'
         result[k] = Dir.pwd
         Dir.chdir(v)
@@ -26,6 +28,7 @@ module InEnvironment
         ENV[k] = v
       end
     end
+
     result
   end
 

data/test/{lib/rake_test.rb → test_rake.rb}

@@ -1,9 +1,6 @@
-#!/usr/bin/env ruby
+require File.expand_path('../helper', __FILE__)
 
-require 'test/unit'
-require 'rake'
-
-class TestRake < Test::Unit::TestCase
+class TestRake < Rake::TestCase
   def test_each_dir_parent
     assert_equal ['a'], alldirs('a')
     assert_equal ['a/b', 'a'], alldirs('a/b')

data/test/test_rake_application.rb

@@ -0,0 +1,364 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestRakeApplication < Rake::TestCase
+  include InEnvironment
+
+  def setup
+    super
+
+    @app = Rake::Application.new
+    @app.options.rakelib = []
+    Rake::TaskManager.record_task_metadata = true
+  end
+
+  def teardown
+    Rake::TaskManager.record_task_metadata = false
+
+    super
+  end
+
+  def test_constant_warning
+    _, err = capture_io do @app.instance_eval { const_warning("Task") } end
+    assert_match(/warning/i, err)
+    assert_match(/deprecated/i, err)
+    assert_match(/Task/i, err)
+  end
+
+  def test_display_tasks
+    @app.options.show_tasks = :tasks
+    @app.options.show_task_pattern = //
+    @app.last_description = "COMMENT"
+    @app.define_task(Rake::Task, "t")
+    out, = capture_io do @app.instance_eval { display_tasks_and_comments } end
+    assert_match(/^rake t/, out)
+    assert_match(/# COMMENT/, out)
+  end
+
+  def test_display_tasks_with_long_comments
+    in_environment('RAKE_COLUMNS' => '80') do
+      @app.options.show_tasks = :tasks
+      @app.options.show_task_pattern = //
+      @app.last_description = "1234567890" * 8
+      @app.define_task(Rake::Task, "t")
+      out, = capture_io do @app.instance_eval { display_tasks_and_comments } end
+      assert_match(/^rake t/, out)
+      assert_match(/# 12345678901234567890123456789012345678901234567890123456789012345\.\.\./, out)
+    end
+  end
+
+  def test_display_tasks_with_task_name_wider_than_tty_display
+    in_environment('RAKE_COLUMNS' => '80') do
+      @app.options.show_tasks = :tasks
+      @app.options.show_task_pattern = //
+      task_name = "task name" * 80
+      @app.last_description = "something short"
+      @app.define_task(Rake::Task, task_name )
+      out, = capture_io do @app.instance_eval { display_tasks_and_comments } end
+      # Ensure the entire task name is output and we end up showing no description
+      assert_match(/rake #{task_name}  # .../, out)
+    end
+  end
+
+  def test_display_tasks_with_very_long_task_name_to_a_non_tty_shows_name_and_comment
+    @app.options.show_tasks = :tasks
+    @app.options.show_task_pattern = //
+    @app.tty_output = false
+    description = "something short"
+    task_name = "task name" * 80
+    @app.last_description = "something short"
+    @app.define_task(Rake::Task, task_name )
+    out, = capture_io do @app.instance_eval { display_tasks_and_comments } end
+    # Ensure the entire task name is output and we end up showing no description
+    assert_match(/rake #{task_name}  # #{description}/, out)
+  end
+
+  def test_display_tasks_with_long_comments_to_a_non_tty_shows_entire_comment
+    @app.options.show_tasks = :tasks
+    @app.options.show_task_pattern = //
+    @app.tty_output = false
+    @app.last_description = "1234567890" * 8
+    @app.define_task(Rake::Task, "t")
+    out, = capture_io do @app.instance_eval { display_tasks_and_comments } end
+    assert_match(/^rake t/, out)
+    assert_match(/# #{@app.last_description}/, out)
+  end
+
+  def test_display_tasks_with_long_comments_to_a_non_tty_with_columns_set_truncates_comments
+    in_environment("RAKE_COLUMNS" => '80') do
+      @app.options.show_tasks = :tasks
+      @app.options.show_task_pattern = //
+      @app.tty_output = false
+      @app.last_description = "1234567890" * 8
+      @app.define_task(Rake::Task, "t")
+      out, = capture_io do @app.instance_eval { display_tasks_and_comments } end
+      assert_match(/^rake t/, out)
+      assert_match(/# 12345678901234567890123456789012345678901234567890123456789012345\.\.\./, out)
+    end
+  end
+
+  def test_describe_tasks
+    @app.options.show_tasks = :describe
+    @app.options.show_task_pattern = //
+    @app.last_description = "COMMENT"
+    @app.define_task(Rake::Task, "t")
+    out, = capture_io do @app.instance_eval { display_tasks_and_comments } end
+    assert_match(/^rake t$/, out)
+    assert_match(/^ {4}COMMENT$/, out)
+  end
+
+  def test_show_lines
+    @app.options.show_tasks = :lines
+    @app.options.show_task_pattern = //
+    @app.last_description = "COMMENT"
+    @app.define_task(Rake::Task, "t")
+    @app['t'].locations << "HERE:1"
+    out, = capture_io do @app.instance_eval { display_tasks_and_comments } end
+    assert_match(/^rake t +[^:]+:\d+ *$/, out)
+  end
+
+  def test_finding_rakefile
+    assert_match(/Rakefile/i, @app.instance_eval { have_rakefile })
+  end
+
+  def test_not_finding_rakefile
+    @app.instance_eval { @rakefiles = ['NEVER_FOUND'] }
+    assert( ! @app.instance_eval do have_rakefile end )
+    assert_nil @app.rakefile
+  end
+
+  def test_load_rakefile
+    in_environment("PWD" => "test/data/unittest") do
+      @app.instance_eval do
+        handle_options
+        options.silent = true
+        load_rakefile
+      end
+      assert_equal "rakefile", @app.rakefile.downcase
+      assert_match(%r(unittest$), Dir.pwd)
+    end
+  end
+
+  def test_load_rakefile_doesnt_print_rakefile_directory_from_same_dir
+    in_environment("PWD" => "test/data/unittest") do
+      _, err = capture_io do
+        @app.instance_eval do
+          @original_dir = File.expand_path(".") # pretend we started from the unittest dir
+          raw_load_rakefile
+        end
+      end
+      _, location = @app.find_rakefile_location
+      refute_match(/\(in #{location}\)/, err)
+    end
+  end
+
+  def test_load_rakefile_from_subdir
+    in_environment("PWD" => "test/data/unittest/subdir") do
+      @app.instance_eval do
+        handle_options
+        options.silent = true
+        load_rakefile
+      end
+      assert_equal "rakefile", @app.rakefile.downcase
+      assert_match(%r(unittest$), Dir.pwd)
+    end
+  end
+
+  def test_load_rakefile_prints_rakefile_directory_from_subdir
+    in_environment("PWD" => "test/data/unittest/subdir") do
+      _, err = capture_io do
+        @app.instance_eval do
+          raw_load_rakefile
+        end
+      end
+      _, location = @app.find_rakefile_location
+      assert_match(/\(in #{location}\)/, err)
+    end
+  end
+
+  def test_load_rakefile_doesnt_print_rakefile_directory_from_subdir_if_silent
+    in_environment("PWD" => "test/data/unittest/subdir") do
+      _, err = capture_io do
+        @app.instance_eval do
+          handle_options
+          options.silent = true
+          raw_load_rakefile
+        end
+      end
+      _, location = @app.find_rakefile_location
+      refute_match(/\(in #{location}\)/, err)
+    end
+  end
+
+  def test_load_rakefile_not_found
+    in_environment("PWD" => "/", "RAKE_SYSTEM" => 'not_exist') do
+      @app.instance_eval do
+        handle_options
+        options.silent = true
+      end
+      ex = assert_raises(RuntimeError) do
+        @app.instance_eval do raw_load_rakefile end
+      end
+      assert_match(/no rakefile found/i, ex.message)
+    end
+  end
+
+  def test_load_from_system_rakefile
+    in_environment('RAKE_SYSTEM' => 'test/data/sys') do
+      @app.options.rakelib = []
+      @app.instance_eval do
+        handle_options
+        options.silent = true
+        options.load_system = true
+        options.rakelib = []
+        load_rakefile
+      end
+      assert_equal "test/data/sys", @app.system_dir
+      assert_nil @app.rakefile
+    end
+  end
+
+  def test_load_from_calculated_system_rakefile
+    flexmock(@app, :standard_system_dir => "__STD_SYS_DIR__")
+    in_environment('RAKE_SYSTEM' => nil) do
+      @app.options.rakelib = []
+      @app.instance_eval do
+        handle_options
+        options.silent = true
+        options.load_system = true
+        options.rakelib = []
+        load_rakefile
+      end
+      assert_equal "__STD_SYS_DIR__", @app.system_dir
+    end
+  end
+
+  def test_windows
+    assert ! (@app.windows? && @app.unix?)
+  end
+
+  def test_loading_imports
+    mock = flexmock("loader")
+    mock.should_receive(:load).with("x.dummy").once
+    @app.instance_eval do
+      add_loader("dummy", mock)
+      add_import("x.dummy")
+      load_imports
+    end
+  end
+
+  def test_building_imported_files_on_demand
+    mock = flexmock("loader")
+    mock.should_receive(:load).with("x.dummy").once
+    mock.should_receive(:make_dummy).with_no_args.once
+    @app.instance_eval do
+      intern(Rake::Task, "x.dummy").enhance do mock.make_dummy end
+        add_loader("dummy", mock)
+      add_import("x.dummy")
+      load_imports
+    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
+    ARGV << '--rakelib=""'
+    @app.options.silent = true
+    @app.instance_eval do
+      intern(Rake::Task, "default").enhance { ran = true }
+    end
+    in_environment("PWD" => "test/data/default") do
+      @app.run
+    end
+    assert ran
+  end
+
+  def test_display_task_run
+    ran = false
+    ARGV.clear
+    ARGV << '-f' << '-s' << '--tasks' << '--rakelib=""'
+    @app.last_description = "COMMENT"
+    @app.define_task(Rake::Task, "default")
+    out, = capture_io { @app.run }
+    assert @app.options.show_tasks
+    assert ! ran
+    assert_match(/rake default/, out)
+    assert_match(/# COMMENT/, out)
+  end
+
+  def test_display_prereqs
+    ran = false
+    ARGV.clear
+    ARGV << '-f' << '-s' << '--prereqs' << '--rakelib=""'
+    @app.last_description = "COMMENT"
+    t = @app.define_task(Rake::Task, "default")
+    t.enhance([:a, :b])
+    @app.define_task(Rake::Task, "a")
+    @app.define_task(Rake::Task, "b")
+    out, = capture_io { @app.run }
+    assert @app.options.show_prereqs
+    assert ! ran
+    assert_match(/rake a$/, out)
+    assert_match(/rake b$/, out)
+    assert_match(/rake default\n( *(a|b)\n){2}/m, out)
+  end
+
+  def test_bad_run
+    @app.intern(Rake::Task, "default").enhance { fail }
+    ARGV.clear
+    ARGV << '-f' << '-s' <<  '--rakelib=""'
+    assert_raises(SystemExit) {
+      _, err = capture_io { @app.run }
+      assert_match(/see full trace/, err)
+    }
+  ensure
+    ARGV.clear
+  end
+
+  def test_bad_run_with_trace
+    @app.intern(Rake::Task, "default").enhance { fail }
+    ARGV.clear
+    ARGV << '-f' << '-s' << '-t'
+    assert_raises(SystemExit) {
+      _, err = capture_io { @app.run }
+      refute_match(/see full trace/, err)
+    }
+  ensure
+    ARGV.clear
+  end
+
+  def test_run_with_bad_options
+    @app.intern(Rake::Task, "default").enhance { fail }
+    ARGV.clear
+    ARGV << '-f' << '-s' << '--xyzzy'
+    assert_raises(SystemExit) {
+      capture_io { @app.run }
+    }
+  ensure
+    ARGV.clear
+  end
+
+  def test_deprecation_message
+    in_environment do
+      _, err = capture_io do
+        @app.deprecate("a", "b", "c")
+      end
+      assert_match(/'a' is deprecated/i, err)
+      assert_match(/use 'b' instead/i, err)
+      assert_match(/at c$/i, err)
+    end
+  end
+end
+