rake 0.9.0.beta.1 → 0.9.0.beta.2

data/CHANGES

@@ -2,6 +2,14 @@
 
 == Pre-Version 0.9.x
 
+* Rake now warns when the deprecated :needs syntax used.
+
+* 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)
+
+* Deprecated 'import'.  Use 'Rake.import' instead.
+
 * Rake history is now UTF-8 encoded.
 
 * Rake now uses case-insensitive comparisons to find the Rakefile on Windows.

data/Rakefile

@@ -328,8 +328,7 @@ task :noop
 #plugin "release_manager"
 
 desc "Make a new release"
-task :release, :rel, :reuse, :reltest,
-  :needs => [
+task :release, [:rel, :reuse, :reltest] => [
     :prerelease,
     :clobber,
     "test:all",
@@ -379,8 +378,7 @@ task :prerelease, :rel, :reuse, :reltest do |t, args|
   end
 end
 
-task :update_version, :rel, :reuse, :reltest,
-  :needs => [:prerelease] do |t, args|
+task :update_version, [:rel, :reuse, :reltest] => [:prerelease] do |t, args|
   if args.rel == CURRENT_VERSION
     announce "No version change ... skipping version update"
   else
@@ -406,8 +404,7 @@ task :update_version, :rel, :reuse, :reltest,
 end
 
 desc "Tag all the CVS files with the latest release number (REL=x.y.z)"
-task :tag, :rel, :reuse, :reltest,
-  :needs => [:prerelease] do |t, args|
+task :tag, [:rel, :reuse, :reltest] => [:prerelease] do |t, args|
   reltag = "REL_#{args.rel.gsub(/\./, '_')}"
   reltag << args.reuse.gsub(/\./, '_') if args.reuse
   announce "Tagging Repository with [#{reltag}]"

data/doc/rakefile.rdoc

@@ -358,12 +358,17 @@ invoked.  This make generated dependency files difficult to use.  By
 the time rake gets around to updating the dependencies file, it is too
 late to load it.
 
-The +import+ command addresses this by specifying a file to be loaded
-_after_ the main rakefile is loaded, but _before_ any targets on the
-command line are specified.  In addition, if the file name matches an
-explicit task, that task is invoked before loading the file.  This
-allows dependency files to be generated and used in a single rake
-command invocation.
+The +Rake.import+ command addresses this by specifying a file to be
+loaded _after_ the main rakefile is loaded, but _before_ any targets
+on the command line are invoked.  In addition, if the file name
+matches an explicit task, that task is invoked before loading the
+file.  This allows dependency files to be generated and used in a
+single rake command invocation.
+
+<b>NOTE:</b> Starting in Rake version 0.9.0, the top level +import+
+command is deprecated and we recommend using the scoped
+"+Rake.import+" command mentioned above.  Future versions of Rake will
+drop support for the top level +import+ command.
 
 === Example:
 
@@ -373,7 +378,7 @@ command invocation.
     sh "makedepend -f- -- #{CFLAGS} -- #{t.prerequisites} > #{t.name}"
   end
 
-  import ".depends.mf"
+  Rake.import ".depends.mf"
 
 If ".depends" does not exist, or is out of date w.r.t. the source
 files, a new ".depends" file is generated using +makedepend+ before

data/lib/rake/application.rb

@@ -153,6 +153,18 @@ module Rake
       $stderr.puts "(See full trace by running task with --trace)" unless options.trace
     end
 
+    # Warn about deprecated usage.
+    #
+    # Example:
+    #    Rake.application.deprecate("import", "Rake.import", caller.first)
+    #
+    def deprecate(old_usage, new_usage, call_site)
+      return if options.ignore_deprecate
+      $stderr.puts "WARNING: '#{old_usage}' is deprecated.  " +
+        "Please use '#{new_usage}' instead.\n" +
+        "    at #{call_site}"
+    end
+
     # Does the exception have a task invocation chain?
     def has_chain?(exception)
       exception.respond_to?(:chain) && exception.chain
@@ -370,16 +382,6 @@ module Rake
             Rake::TaskManager.record_task_metadata = true
           }
         ],
-        ['--no-top-level-dsl', '-X', "Do not put Rake DSL commands in the top level scope.",
-          lambda { |value|
-            options.top_level_dsl = ! value
-          }
-        ],
-        ['--top-level-dsl', "Put Rake DSL commands in the top level scope (default).",
-          lambda { |value|
-            options.top_level_dsl = value
-          }
-        ],
         ['--trace', '-t', "Turn on invoke/execute tracing, enable full backtrace.",
           lambda { |value|
             options.trace = true
@@ -402,13 +404,17 @@ module Rake
             Rake::TaskManager.record_task_metadata = true
           }
         ],
+        ['--no-deprecation-warnings', '-X', "Disable the deprecation warnings.",
+          lambda { |value|
+            options.ignore_deprecate = true
+          }
+        ],
       ]
     end
 
     # Read and handle the command line options.
     def handle_options
       options.rakelib = ['rakelib']
-      options.top_level_dsl = true
 
       OptionParser.new do |opts|
         opts.banner = "rake [-f rakefile] {options} targets..."
@@ -424,8 +430,6 @@ module Rake
         opts.environment('RAKEOPT')
       end.parse!
 
-      Rake::DSL.include_in_top_scope if options.top_level_dsl
-
       # If class namespaces are requested, set the global options
       # according to the values in the options structure.
       if options.classic_namespace

data/lib/rake/dsl_definition.rb

@@ -116,31 +116,35 @@ module Rake
       Rake.application.last_description = description
     end
 
-    # Import the partial Rakefiles +fn+.  Imported files are loaded
-    # _after_ the current file is completely loaded.  This allows the
-    # import statement to appear anywhere in the importing file, and yet
-    # allowing the imported files to depend on objects defined in the
-    # importing file.
-    #
-    # A common use of the import statement is to include files
-    # containing dependency declarations.
-    #
-    # See also the --rakelibdir command line option.
-    #
-    # Example:
-    #   import ".depend", "my_rules"
-    #
-    def import(*fns)
-      fns.each do |fn|
-        Rake.application.add_import(fn)
-      end
+    # The DSL level import command is now deprecated and moved the
+    # Rake.import.
+    def import(*fn)
+      Rake.application.deprecate("import", "Rake.import", caller.first)
+      Rake.import(*fn)
     end
+  end
 
-    # Include the Rake DSL commands in the top level Ruby scope.
-    def self.include_in_top_scope
-      Object.send(:include, Rake::DSL)
+  # Import the partial Rakefiles +fn+.  Imported files are loaded
+  # _after_ the current file is completely loaded.  This allows the
+  # import statement to appear anywhere in the importing file, and yet
+  # allowing the imported files to depend on objects defined in the
+  # importing file.
+  #
+  # A common use of the import statement is to include files
+  # containing dependency declarations.
+  #
+  # See also the --rakelibdir command line option.
+  #
+  # Example:
+  #   import ".depend", "my_rules"
+  #
+  def Rake.import(*fns)
+    fns.each do |fn|
+      Rake.application.add_import(fn)
     end
   end
 
   extend FileUtilsExt
 end
+
+self.extend Rake::DSL

data/lib/rake/environment.rb

@@ -16,16 +16,16 @@ module Rake
         load_string(rakefile, rakefile_path)
       end
 
+      # Run a block of code in the Rake DSL environment.
+      def run(&block)
+        block.call
+      end
+
       # Load a string of code in the Rake DSL environment.  If the
       # string comes from a file, include the file path so that proper
       # line numbers references may be retained.
       def load_string(code, file_name=nil)
-        module_eval(code, file_name || "(eval)")
-      end
-
-      # Run a block of code in the Rake DSL environment.
-      def run(&block)
-        module_eval(&block)
+        eval(code, binding, file_name)
       end
     end
   end

data/lib/rake/task_manager.rb

@@ -103,6 +103,10 @@ module Rake
         arg_names = []
         deps = value
       elsif key == :needs
+        Rake.application.deprecate(
+          "task :t, arg, :needs => [deps]",
+          "task :t, [args] => [deps]",
+          caller.detect { |c| c !~ /\blib\/rake\b/ })
         task_name = args.shift
         arg_names = args
         deps = value

data/lib/rake/version.rb

@@ -5,7 +5,7 @@ module Rake
       MINOR = 9,
       BUILD = 0,
       BETA  = 'beta',
-      BETANUM = 1,
+      BETANUM = 2,
     ]
   end
   VERSION = Version::NUMBERS.join('.')

data/test/data/access/Rakefile

@@ -0,0 +1,33 @@
+TOP_LEVEL_CONSTANT = 0
+
+def a_top_level_function
+end
+
+task :default => [:work, :obj, :const]
+
+task :work do
+  begin
+    a_top_level_function
+    puts "GOOD:M Top level methods can be called in tasks"
+  rescue NameError => ex
+    puts "BAD:M  Top level methods can not be called in tasks"
+  end
+end
+
+task :obj do
+  begin
+    Object.new.instance_eval { task :xyzzy }
+    puts "BAD:D  Rake DSL are polluting objects"
+  rescue StandardError => ex
+    puts "GOOD:D Rake DSL are not polluting objects"
+  end
+end
+
+task :const do
+  begin
+    TOP_LEVEL_CONSTANT
+    puts "GOOD:C Top level constants are available in tasks"
+  rescue StandardError => ex
+    puts "BAD:C  Top level constants are NOT available in tasks"
+  end
+end

data/test/data/deprecated_import/Rakefile

@@ -0,0 +1 @@
+import "a"

data/test/functional/session_based_tests.rb

@@ -91,6 +91,13 @@ class SessionBasedTests < Test::Unit::TestCase
     assert_no_match %r{^rake c\n}m, @out
   end
 
+  def test_proper_namespace_access
+    in_environment("PWD" => "test/data/access") do
+      rake
+    end
+    assert_not_match %r{^BAD:}, @out
+  end
+
   def test_rbext
     in_environment("PWD" => "test/data/rbext") do
       rake "-N"
@@ -247,6 +254,22 @@ class SessionBasedTests < Test::Unit::TestCase
     assert_status
   end
 
+  def test_deprecated_import
+    in_environment("PWD" => "test/data/deprecated_import") do
+      rake "imported"
+    end
+    assert_match(/deprecated/, @err)
+    assert_match(/imported!/, @out)
+  end
+
+  def test_suppressed_deprecated_message
+    in_environment("PWD" => "test/data/deprecated_import") do
+      rake "imported -X"
+    end
+    assert_not_match(/deprecated/, @err)
+    assert_match(/imported!/, @out)
+  end
+
   def test_imports
     open("test/data/imports/static_deps", "w") do |f|
       f.puts 'puts "STATIC"'

data/test/in_environment.rb

@@ -9,7 +9,7 @@ module InEnvironment
     original_settings = set_env(full_settings)
     yield
   ensure
-    set_env(original_settings)
+    set_env(original_settings) rescue nil
   end
 
   # Set the environment according to the settings hash.

data/test/lib/environment_test.rb

@@ -4,15 +4,27 @@ require 'test/test_helper'
 require 'rake/environment'
 
 class TestEnvironment < Test::Unit::TestCase
-  def test_load_string
+  def test_load_rakefile
     Rake::Task.clear
-    Rake::Environment.load_string("task :xyz")
-    assert Rake::Task[:xyz], "should have a task named xyz"
+    Rake::Environment.load_rakefile("test/data/default/Rakefile")
+    assert Rake::Task[:default], "Should have a default task"
   end
 
-  def test_load_rakefile
+  def test_run
     Rake::Task.clear
-    Rake::Environment.load_rakefile("test/data/default/Rakefile")
+    Rake::Environment.run do
+      desc "demo comment"
+      task :default
+    end
+    assert Rake::Task[:default], "Should have a default task"
+  end
+
+  def test_environment
+    Rake::Task.clear
+    Rake::DSL.environment do
+      desc "demo comment"
+      task :default
+    end
     assert Rake::Task[:default], "Should have a default task"
   end
 end

data/test/lib/task_manager_test.rb

@@ -151,6 +151,16 @@ class TestTaskManager < Test::Unit::TestCase
 end
 
 class TestTaskManagerArgumentResolution < Test::Unit::TestCase
+  def setup
+    super
+    Rake.application.options.ignore_deprecate = true
+  end
+
+  def teardown
+    Rake.application.options.ignore_deprecate = false
+    super
+  end
+
   def test_good_arg_patterns
     assert_equal [:t, [], []],       task(:t)
     assert_equal [:t, [], [:x]],     task(:t => :x)

data/test/lib/task_test.rb

@@ -37,7 +37,8 @@ class TestTask < Test::Unit::TestCase
   end
 
   def test_inspect
-    t = task(:foo, :needs => [:bar, :baz])
+#    t = task(:foo, :needs => [:bar, :baz])
+    t = task(:foo => [:bar, :baz])
     assert_equal "<Rake::Task foo => [bar, baz]>", t.inspect
   end
 
@@ -308,23 +309,20 @@ class TestTaskWithArguments < Test::Unit::TestCase
     assert_equal ["pre"], t.prerequisites
   end
 
-  def test_name_and_explicit_needs
-    t = task(:t, :needs => [:pre])
-    assert_equal "t", t.name
-    assert_equal [], t.arg_names
-    assert_equal ["pre"], t.prerequisites
-  end
-
   def test_name_args_and_explicit_needs
-    t = task(:t, :x, :y, :needs => [:pre])
-    assert_equal "t", t.name
-    assert_equal [:x, :y], t.arg_names
-    assert_equal ["pre"], t.prerequisites
+    ignore_deprecations do
+      t = task(:t, :x, :y, :needs => [:pre])
+      assert_equal "t", t.name
+      assert_equal [:x, :y], t.arg_names
+      assert_equal ["pre"], t.prerequisites
+    end
   end
 
   def test_illegal_keys_in_task_name_hash
-    assert_exception RuntimeError do
-      t = task(:t, :x, :y => 1, :needs => [:pre])
+    ignore_deprecations do
+      assert_exception RuntimeError do
+        t = task(:t, :x, :y => 1, :needs => [:pre])
+      end
     end
   end
 
@@ -415,7 +413,7 @@ class TestTaskWithArguments < Test::Unit::TestCase
   def test_named_args_are_passed_to_prereqs
     value = nil
     pre = task(:pre, :rev) { |t, args| value = args.rev }
-    t = task(:t, :name, :rev, :needs => [:pre])
+    t = task(:t, [:name, :rev] => [:pre])
     t.invoke("bill", "1.2")
     assert_equal "1.2", value
   end
@@ -425,7 +423,7 @@ class TestTaskWithArguments < Test::Unit::TestCase
       assert_equal({}, args.to_hash)
       assert_equal "bill", args.name
     }
-    t = task(:t, :name, :rev, :needs => [:pre])
+    t = task(:t, [:name, :rev] => [:pre])
     t.invoke("bill", "1.2")
   end
 
@@ -433,7 +431,7 @@ class TestTaskWithArguments < Test::Unit::TestCase
     pre = task(:pre, :rev) { |t, args|
       assert_equal({}, args.to_hash)
     }
-    t = task(:t, :needs => [:pre])
+    t = task(:t  => [:pre])
     t.invoke("bill", "1.2")
   end
 end

data/test/lib/top_level_functions_test.rb

@@ -20,6 +20,8 @@ class TestTopLevelFunctions < Test::Unit::TestCase
     super
     @app = Rake.application
     Rake.application = flexmock("app")
+    Rake.application.should_receive(:deprecate).
+      and_return { |old, new, call| @app.deprecate(old, new, call) }
   end
 
   def teardown
@@ -36,7 +38,7 @@ class TestTopLevelFunctions < Test::Unit::TestCase
     Rake.application.should_receive(:add_import).with("x").once.ordered
     Rake.application.should_receive(:add_import).with("y").once.ordered
     Rake.application.should_receive(:add_import).with("z").once.ordered
-    import('x', 'y', 'z')
+    Rake.import('x', 'y', 'z')
   end
 
   def test_when_writing

data/test/rake_test_setup.rb

@@ -10,6 +10,7 @@ end
 require 'flexmock/test_unit'
 require 'test/filecreation'
 require 'test/capture_stdout'
+require 'test/test_helper'
 
 module TestMethods
   # Shim method for compatibility

data/test/test_helper.rb

@@ -9,4 +9,11 @@ require 'rake'
 
 class Test::Unit::TestCase
   include Rake::DSL
+
+  def ignore_deprecations
+    Rake.application.options.ignore_deprecate = true
+    yield
+  ensure
+    Rake.application.options.ignore_deprecate = false
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: rake
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 0.9.0.beta.1
+  version: 0.9.0.beta.2
 platform: ruby
 authors: 
 - Jim Weirich
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-28 00:00:00 -05:00
+date: 2011-03-05 00:00:00 -05:00
 default_executable: rake
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -175,9 +175,11 @@ files:
 - test/test_helper.rb
 - test/data/imports/deps.mf
 - test/data/sample.mf
+- test/data/access/Rakefile
 - test/data/chains/Rakefile
 - test/data/comments/Rakefile
 - test/data/default/Rakefile
+- test/data/deprecated_import/Rakefile
 - test/data/dryrun/Rakefile
 - test/data/file_creation_task/Rakefile
 - test/data/imports/Rakefile