RubyGems - rake - Versions diffs - 0.8.7 → 0.9.0.beta.0 - Mend

rake 0.8.7 → 0.9.0.beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (122) hide show

data/.gemtest +0 -0
data/CHANGES +77 -9
data/{README → README.rdoc} +14 -10
data/Rakefile +113 -110
data/TODO +1 -1
data/doc/command_line_usage.rdoc +18 -6
data/doc/glossary.rdoc +2 -2
data/doc/jamis.rb +2 -2
data/doc/proto_rake.rdoc +22 -22
data/doc/rake.1.gz +0 -0
data/doc/rakefile.rdoc +60 -28
data/doc/rational.rdoc +6 -6
data/doc/release_notes/rake-0.4.15.rdoc +1 -1
data/doc/release_notes/rake-0.5.0.rdoc +1 -1
data/doc/release_notes/rake-0.7.0.rdoc +1 -1
data/doc/release_notes/rake-0.7.2.rdoc +3 -3
data/doc/release_notes/rake-0.7.3.rdoc +2 -2
data/doc/release_notes/rake-0.8.0.rdoc +1 -1
data/doc/release_notes/rake-0.8.2.rdoc +3 -3
data/doc/release_notes/rake-0.8.3.rdoc +2 -2
data/doc/release_notes/rake-0.8.4.rdoc +1 -1
data/doc/release_notes/rake-0.8.5.rdoc +1 -1
data/doc/release_notes/rake-0.8.6.rdoc +1 -1
data/doc/release_notes/rake-0.8.7.rdoc +1 -1
data/install.rb +14 -12
data/lib/rake.rb +28 -2470
data/lib/rake/alt_system.rb +7 -6
data/lib/rake/application.rb +585 -0
data/lib/rake/classic_namespace.rb +1 -0
data/lib/rake/clean.rb +14 -14
data/lib/rake/cloneable.rb +25 -0
data/lib/rake/contrib/compositepublisher.rb +2 -5
data/lib/rake/contrib/ftptools.rb +5 -8
data/lib/rake/contrib/publisher.rb +2 -8
data/lib/rake/contrib/rubyforgepublisher.rb +2 -4
data/lib/rake/contrib/sshpublisher.rb +4 -6
data/lib/rake/contrib/sys.rb +7 -25
data/lib/rake/default_loader.rb +10 -0
data/lib/rake/dsl.rb +2 -0
data/lib/rake/dsl_definition.rb +146 -0
data/lib/rake/early_time.rb +18 -0
data/lib/rake/environment.rb +40 -0
data/lib/rake/ext/core.rb +27 -0
data/lib/rake/ext/module.rb +39 -0
data/lib/rake/ext/string.rb +167 -0
data/lib/rake/ext/time.rb +14 -0
data/lib/rake/file_creation_task.rb +24 -0
data/lib/rake/file_list.rb +403 -0
data/lib/rake/file_task.rb +47 -0
data/lib/rake/file_utils.rb +112 -0
data/lib/rake/file_utils_ext.rb +132 -0
data/lib/rake/gempackagetask.rb +6 -90
data/lib/rake/invocation_chain.rb +51 -0
data/lib/rake/invocation_exception_mixin.rb +16 -0
data/lib/rake/loaders/makefile.rb +13 -15
data/lib/rake/multi_task.rb +16 -0
data/lib/rake/name_space.rb +25 -0
data/lib/rake/packagetask.rb +13 -12
data/lib/rake/pathmap.rb +1 -0
data/lib/rake/pseudo_status.rb +24 -0
data/lib/rake/rake_module.rb +25 -0
data/lib/rake/rake_test_loader.rb +10 -2
data/lib/rake/rdoctask.rb +211 -190
data/lib/rake/ruby182_test_unit_fix.rb +9 -7
data/lib/rake/rule_recursion_overflow_error.rb +20 -0
data/lib/rake/runtest.rb +4 -6
data/lib/rake/task.rb +327 -0
data/lib/rake/task_argument_error.rb +7 -0
data/lib/rake/task_arguments.rb +74 -0
data/lib/rake/task_manager.rb +329 -0
data/lib/rake/tasklib.rb +1 -2
data/lib/rake/testtask.rb +51 -26
data/lib/rake/version.rb +12 -0
data/lib/rake/win32.rb +4 -4
data/test/contrib/test_sys.rb +7 -30
data/test/data/comments/Rakefile +18 -0
data/test/data/default/Rakefile +1 -1
data/test/data/dryrun/Rakefile +1 -1
data/test/data/file_creation_task/Rakefile +1 -1
data/test/data/namespace/Rakefile +9 -0
data/test/data/rakelib/test1.rb +4 -2
data/test/data/verbose/Rakefile +34 -0
data/test/functional/functional_test.rb +25 -0
data/test/{session_functional.rb → functional/session_based_tests.rb} +134 -23
data/test/in_environment.rb +6 -4
data/test/{test_application.rb → lib/application_test.rb} +277 -136
data/test/{test_clean.rb → lib/clean_test.rb} +1 -0
data/test/{test_definitions.rb → lib/definitions_test.rb} +2 -2
data/test/lib/dsl_test.rb +52 -0
data/test/{test_earlytime.rb → lib/earlytime_test.rb} +1 -2
data/test/lib/environment_test.rb +18 -0
data/test/{test_extension.rb → lib/extension_test.rb} +2 -2
data/test/{test_file_creation_task.rb → lib/file_creation_task_test.rb} +0 -0
data/test/{test_file_task.rb → lib/file_task_test.rb} +3 -3
data/test/{test_filelist.rb → lib/filelist_test.rb} +28 -24
data/test/{test_fileutils.rb → lib/fileutils_test.rb} +26 -21
data/test/{test_ftp.rb → lib/ftp_test.rb} +0 -0
data/test/{test_invocation_chain.rb → lib/invocation_chain_test.rb} +0 -0
data/test/{test_makefile_loader.rb → lib/makefile_loader_test.rb} +0 -0
data/test/{test_multitask.rb → lib/multitask_test.rb} +14 -6
data/test/{test_namespace.rb → lib/namespace_test.rb} +0 -0
data/test/lib/package_task_test.rb +82 -0
data/test/{test_pathmap.rb → lib/pathmap_test.rb} +3 -2
data/test/{test_pseudo_status.rb → lib/pseudo_status_test.rb} +0 -0
data/test/{test_rake.rb → lib/rake_test.rb} +1 -1
data/test/{test_rdoc_task.rb → lib/rdoc_task_test.rb} +19 -23
data/test/{test_require.rb → lib/require_test.rb} +8 -2
data/test/{test_rules.rb → lib/rules_test.rb} +1 -2
data/test/{test_task_arguments.rb → lib/task_arguments_test.rb} +5 -5
data/test/{test_task_manager.rb → lib/task_manager_test.rb} +5 -5
data/test/{test_tasks.rb → lib/task_test.rb} +69 -4
data/test/{test_tasklib.rb → lib/tasklib_test.rb} +0 -0
data/test/{test_test_task.rb → lib/test_task_test.rb} +3 -3
data/test/lib/testtask_test.rb +49 -0
data/test/{test_top_level_functions.rb → lib/top_level_functions_test.rb} +3 -3
data/test/{test_win32.rb → lib/win32_test.rb} +19 -0
data/test/rake_test_setup.rb +4 -9
data/test/ruby_version_test.rb +3 -0
data/test/test_helper.rb +12 -0
metadata +100 -44
data/test/functional.rb +0 -15
data/test/test_package_task.rb +0 -118

data/TODO CHANGED

@@ -6,7 +6,7 @@ the rake-devel@rubyforge.org mailing list.
 === To Do
 * Need a nice API for accessing tasks in namespaces, namespaces in an app, etc.
 * Provide a way to disable -w warning mode.
-* Define a set of default rules that work in the absense of any Rakefile
+* Define a set of default rules that work in the absence of any Rakefile
 * What about cyclic dependencies?
 * Java support utilities
 * Installation support utilities

data/doc/command_line_usage.rdoc CHANGED

@@ -9,7 +9,7 @@ Options are:
 [<tt><em>name</em>=<em>value</em></tt>]
     Set the environment variable <em>name</em> to <em>value</em>
     during the execution of the <b>rake</b> command.  You can access
-    the value by using ENV['<em>name</em>'].
+    the value by using ENV['<em>name</em>'].
 [<tt>--classic-namespace</tt> (-n)]
     Import the Task, FileTask, and FileCreateTask into the top-level
@@ -80,23 +80,35 @@ Options are:
     Use the project level Rakefile, ignoring the system-wide (global)
     rakefiles.
-[<tt>--tasks</tt> (-T)]
+[<tt>--tasks</tt> <em>pattern</em> (-T)]
     Display a list of the major tasks and their comments.  Comments
-    are defined using the "desc" command.
+    are defined using the "desc" command.  If a pattern is given, then
+    only tasks matching the pattern are displayed.
+[<tt>--no-top-level-dsl</tt> (-X)]
+    Do not put the Rake DSL commands into the top level scope.
+[<tt>--top-level-dsl</tt>]
+    Put the Rake DSL commands into the top level scope (default).
+    NOTE: Although currently Rake defaults to its DSL in the top level
+    scope, the plan is to deprecate this in the future and default ot
+    having the DSL commands *not* appear in the top level scope.
 [<tt>--trace</tt> (-t)]
     Turn on invoke/execute tracing. Also enable full backtrace on
     errors.
-[<tt>--usage</tt> (-h)]
-    Display a usage message and exit.
 [<tt>--verbose</tt> (-v)]
     Echo the Sys commands to standard output.
 [<tt>--version</tt> (-V)]
     Display the program version and exit.
+[<tt>--where</tt> <em>pattern</em> (-W)]
+    Display tasks that match <em>pattern</em> and the file and line
+    number where the task is defined.
 In addition, any command line option of the form
 <em>VAR</em>=<em>VALUE</em> will be added to the environment hash
 <tt>ENV</tt> and may be tested in the Rakefile.

data/doc/glossary.rdoc CHANGED

@@ -37,9 +37,9 @@
 	not needed.  This may change in the future.
 [<b>prerequisites</b>]
-	Every task has a set (possiblity empty) of prerequisites.  A
+	Every task has a set (possibly empty) of prerequisites.  A
 	prerequisite P to Task T is itself a task that must be invoked
-	before Task T.
+	before Task T.
 [<b>rule</b>]
 	A rule is a recipe for synthesizing a task when no task is

data/doc/jamis.rb CHANGED

@@ -183,7 +183,7 @@ h3, h4, h5, h6 {
 CSS
 XHTML_PREAMBLE = %{<?xml version="1.0" encoding="%charset%"?>
-<!DOCTYPE html
+<!DOCTYPE html
      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 }
@@ -510,7 +510,7 @@ FILE_INDEX = XHTML_PREAMBLE + <<HTML
 <!--
   body {
     background-color: #EEE;
-    font-family: #{FONTS};
+    font-family: #{FONTS};
     color: #000;
     margin: 0px;
   }

data/doc/proto_rake.rdoc CHANGED

@@ -4,54 +4,54 @@ This is the original 100 line prototype rake program.
 ---
  #!/usr/bin/env ruby
  require 'ftools'
  class Task
    TASKS = Hash.new
    attr_reader :prerequisites
    def initialize(task_name)
      @name = task_name
      @prerequisites = []
      @actions = []
    end
    def enhance(deps=nil, &block)
      @prerequisites |= deps if deps
      @actions << block if block_given?
      self
    end
    def name
      @name.to_s
    end
    def invoke
      @prerequisites.each { |n| Task[n].invoke }
      execute if needed?
    end
    def execute
      return if @triggered
      @triggered = true
      @actions.collect { |act| result = act.call(self) }.last
    end
    def needed?
      true
    end
    def timestamp
      Time.now
    end
    class << self
      def [](task_name)
        TASKS[intern(task_name)] or fail "Don't know how to rake #{task_name}"
      end
      def define_task(args, &block)
        case args
        when Hash
@@ -66,18 +66,18 @@ This is the original 100 line prototype rake program.
        deps = deps.collect {|d| intern(d) }
        get(task_name).enhance(deps, &block)
      end
      def get(task_name)
        name = intern(task_name)
        TASKS[name] ||= self.new(name)
      end
      def intern(task_name)
        (Symbol === task_name) ? task_name : task_name.intern
      end
    end
  end
  class FileTask < Task
    def needed?
      return true unless File.exist?(name)
@@ -85,25 +85,25 @@ This is the original 100 line prototype rake program.
      return false if latest_prereq.nil?
      timestamp < latest_prereq
    end
    def timestamp
      File.new(name.to_s).mtime
    end
  end
  def task(args, &block)
    Task.define_task(args, &block)
  end
  def file(args, &block)
    FileTask.define_task(args, &block)
  end
  def sys(cmd)
    puts cmd
    system(cmd) or fail "Command Failed: [#{cmd}]"
  end
  def rake
    begin
      here = Dir.pwd
@@ -119,9 +119,9 @@ This is the original 100 line prototype rake program.
    rescue Exception => ex
      puts "rake aborted ... #{ex.message}"
      puts ex.backtrace.find {|str| str =~ /Rakefile/ } || ""
-   end
+   end
  end
  if __FILE__ == $0 then
    rake
  end

data/doc/rake.1.gz CHANGED

Binary file

data/doc/rakefile.rdoc CHANGED

@@ -1,4 +1,4 @@
-= Rakefile Format (as of version 0.8.3)
+= Rakefile Format (as of version 0.8.7)
 First of all, there is no special format for a Rakefile.  A Rakefile
 contains executable Ruby code.  Anything legal in a ruby script is
@@ -27,7 +27,7 @@ parameter that is the name of the task.
 === Tasks with Prerequisites
-Any prerequisites are given as a list (inclosed in square brackets)
+Any prerequisites are given as a list (enclosed in square brackets)
 following the name and an arrow (=>).
   task :name => [:prereq1, :prereq2]
@@ -45,7 +45,7 @@ following ...
 Actions are defined by passing a block to the +task+ method.  Any Ruby
 code can be placed in the block.  The block may reference the task
-object via the block paramter..
+object via the block parameter.
   task :name => [:prereq1, :prereq2] do |t|
     # actions (may reference t)
@@ -119,14 +119,14 @@ Rake allows parallel execution of prerequisites using the following syntax:
   end
 In this example, +copy_files+ is a normal rake task.  Its actions are
-executed whereever all of its prerequisites are done.  The big
+executed whenever all of its prerequisites are done.  The big
 difference is that the prerequisites (+copy_src+, +copy_bin+ and
 +copy_doc+) are executed in parallel.  Each of the prerequisites are
 run in their own Ruby thread, possibly allowing faster overall runtime.
 === Secondary Prerequisites
-If any of the primary prerequites of a multitask have common secondary
+If any of the primary prerequisites of a multitask have common secondary
 prerequisites, all of the primary/parallel prerequisites will wait
 until the common prerequisites have been run.
@@ -183,6 +183,22 @@ argument string should be quoted.  Something like this:
 (Quoting rules vary between operating systems and shells, so make sure
 you consult the proper docs for your OS/shell).
+=== Tasks Arguments and the Environment
+Task argument values can also be picked up from the environment.  For
+example, if the "release" task expected a parameter named
+"release_version", then either
+   rake release[0.8.2]
+or
+   RELEASE_VERSION rake release
+will work.  Environment variable names must either match the task
+parameter exactly, or match an all-uppercase version of the task
+parameter.
 === Tasks that Expect Parameters
 Parameters are only given to tasks that are setup to expect them.  In
@@ -195,10 +211,10 @@ 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
+The next two arguments are the names of the parameters expected by
 :name in an array (:first_name and :last_name in the example).
-To access the values of the paramters, the block defining the task
+To access the values of the parameters, the block defining the task
 behaviour can now accept a second parameter:
    task :name, [:first_name, :last_name] do |t, args|
@@ -210,7 +226,8 @@ 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.
+picked up from matching environment variables.  If there are no
+matching environment variables, they are given the nil value.
 If you wish to specify default values for the arguments, you can use
 the with_defaults method in the task body.  Here is the above example
@@ -239,11 +256,12 @@ for tasks with arguments.  For example:
 There is an older format for declaring task parameters that omitted
 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.
+is not recommended for use.  The older format may be dropped in future
+versions of rake.
-== Accessing Task Programatically
+== Accessing Task Programmatically
-Sometimes it is useful to manipulate tasks programatically in a
+Sometimes it is useful to manipulate tasks programmatically in a
 Rakefile. To find a task object, use the <tt>:[]</tt> operator on the
 <tt>Rake::Task</tt>.
@@ -260,7 +278,7 @@ actions.
    task :dont do
      Rake::Task[:doit].clear
-   end
+   end
 Running this example:
@@ -269,7 +287,7 @@ Running this example:
   DONE
   $ rake dont doit
   (in /Users/jim/working/git/rake/x)
-  $
+  $
 The ability to programmatically manipulate tasks gives rake very
 powerful meta-programming capabilities w.r.t. task execution, but
@@ -294,7 +312,7 @@ Rake is able to find a file named "mycode.c", it will automatically
 create a task that builds "mycode.o" from "mycode.c".
 If the file "mycode.c" does not exist, rake will attempt
-to recursively synthesize a rule for it.
+to recursively synthesize a rule for it.
 When a task is synthesized from a rule, the +source+ attribute of the
 task is set to the matching source file.  This allows us to write
@@ -312,7 +330,7 @@ The following rule is equivalent to the example above.
     proc {|task_name| task_name.sub(/\.[^.]+$/, '.c') }
   ]) do |t|
     sh "cc #{t.source} -c -o #{t.name}"
-  end
+  end
 <b>NOTE:</b> Because of a _quirk_ in Ruby syntax, parenthesis are
 required on *rule* when the first argument is a regular expression.
@@ -322,7 +340,7 @@ The following rule might be used for Java files ...
   rule '.java' => [
     proc { |tn| tn.sub(/\.class$/, '.java').sub(/^classes\//, 'src/') }
   ] do |t|
-    java_compile(t.source, t.name)
+    java_compile(t.source, t.name)
   end
 <b>NOTE:</b> +java_compile+ is a hypothetical method that invokes the
@@ -365,18 +383,32 @@ loading.
 Standard Ruby comments (beginning with "#") can be used anywhere it is
 legal in Ruby source code, including comments for tasks and rules.
-However, if you wish a task to be described using the "-T" switch,
-then you need to use the +desc+ command to describe the task.
+A single-line comment immediately before a task (with no blank line
+between it and the task) will be used as that task's description, and
+the task and description will appear in the list displayed
+using the "-T" switch.
+=== Example:
+  # Create a distribution package
+  task :package => [ ... ] do ... end
+You can also use the +desc+ command before a task to set the
+description for the task. In this case, intervening blank lines
+are allowed
 === Example:
-  desc "Create a distribution package"
+  desc 'Create a distribution package'
   task :package => [ ... ] do ... end
+The +desc+ comment takes priority over the comment for of description.
 The "-T" switch (or "--tasks" if you like to spell things out) will
-display a list of tasks that have a defined comment.  If you use
-+desc+ to describe your major tasks, you have a semi-automatic way of
-generating a summary of your Rake file.
+display a list of tasks that have a description.  If you use
+comments or +desc+ to describe your major tasks, you have a
+semi-automatic way of generating a summary of your Rake file.
   traken$ rake -T
   (in /home/.../rake)
@@ -403,7 +435,7 @@ common for task names to begin to clash.  For example, if you might
 have a main program and a set of sample programs built by a single
 Rakefile.  By placing the tasks related to the main program in one
 namespace, and the tasks for building the sample programs in a
-different namespace, the task names will not will not interfer with
+different namespace, the task names will not will not interfere with
 each other.
 For example:
@@ -429,7 +461,7 @@ Nested namespaces are supported, so
 Note that the name given in the +task+ command is always the unadorned
 task name without any namespace prefixes.  The +task+ command always
-defines a task in the current namespace.
+defines a task in the current namespace.
 === FileTasks
@@ -499,17 +531,17 @@ Or give it a glob pattern:
 == Odds and Ends
-=== do/end verses { }
+=== do/end versus { }
 Blocks may be specified with either a +do+/+end+ pair, or with curly
 braces in Ruby.  We _strongly_ recommend using +do+/+end+ to specify the
 actions for tasks and rules.  Because the rakefile idiom tends to
-leave off parenthesis on the task/file/rule methods, unusual
+leave off parentheses on the task/file/rule methods, unusual
 ambiguities can arise when using curly braces.
 For example, suppose that the method +object_files+ returns a list of
 object files in a project.  Now we use +object_files+ as the
-prerequistes in a rule specified with actions in curly braces.
+prerequisites in a rule specified with actions in curly braces.
   # DON'T DO THIS!
   file "prog" => object_files {
@@ -531,4 +563,4 @@ This is the proper way to specify the task ...
 == See
-* README -- Main documentation for Rake.
+* README.rdoc -- Main documentation for Rake.

data/doc/rational.rdoc CHANGED

@@ -38,13 +38,13 @@ too much work.  And that was the end of that!
 ... Except I couldn't get the thought out of my head.  What exactly
 would be needed to make the about syntax work as a make file?  Hmmm, you
 would need to register the tasks, you need some way of specifying
-dependencies between tasks, and some way of kicking off the process.
+dependencies between tasks, and some way of kicking off the process.
 Hey!  What if we did ... and fifteen minutes later I had a working
 prototype of Ruby make, complete with dependencies and actions.
 I showed the code to my coworker and we had a good laugh.  It was just
 about a page worth of code that reproduced an amazing amount of the
-functionality of make.  We were both truely stunned with the power of
+functionality of make.  We were both truly stunned with the power of
 Ruby.
 But it didn't do everything make did.  In particular, it didn't have
@@ -53,7 +53,7 @@ prerequisite files have a later timestamp).  Obviously THAT would be a
 pain to add and so Ruby Make would remain an interesting experiment.
 ... Except as I walked back to my desk, I started thinking about what
-file based dependecies would really need.  Rats!  I was hooked again,
+file based dependencies would really need.  Rats!  I was hooked again,
 and by adding a new class and two new methods, file/timestamp
 dependencies were implemented.
@@ -97,7 +97,7 @@ Here's another task with dependencies ...
    end
 Task :clobber depends upon task :clean, so :clean will be run before
-:clobber is executed.
+:clobber is executed.
 Files are specified by using the "file" command.  It is similar to the
 task command, except that the task name represents a file, and the task
@@ -115,7 +115,7 @@ Here is a file based dependency that will compile "hello.cc" to
 I normally specify file tasks with string (rather than symbols).  Some
 file names can't be represented by symbols.  Plus it makes the
-distinction between them more clear to the casual reader.
+distinction between them more clear to the casual reader.
 Currently writing a task for each and every file in the project would be
 tedious at best.  I envision a set of libraries to make this job
@@ -133,7 +133,7 @@ created for rake.
 That's it.  There's no documentation (other than whats in this
 message).  Does this sound interesting to anyone?  If so, I'll continue
 to clean it up and write it up and publish it on RAA.  Otherwise, I'll
-leave it as an interesting excerise and a tribute to the power of Ruby.
+leave it as an interesting exercise and a tribute to the power of Ruby.
 Why /might/ rake be interesting to Ruby programmers.  I don't know,
 perhaps ...