buildr 0.16.0 → 0.18.0

data/CHANGELOG

@@ -1,3 +1,48 @@
+0.18 (3/26/2007)
+* Added: manifest attribute on project, used by default when packaging JAR/WAR.
+* Added: default manifest includes build-by, build-jdk and implementation-title.
+* Added: compile.from(sources) in the same vein as compile.with(classpath)
+* Added: load all *.rake files form the tasks directory (if exists) for use in the
+  main Rakefile.
+* Added: Java.tools returns a reference to tools.jar on JDKs that include it. 
+* Added: brought back experimental test tasks.
+* Added: artifacts task to download all artifacts referenced by project (using
+  either artifact or artifacts method).
+* Changed: back to old behavior, compile task only executes if there are any files
+  to compile, and compile? method removed.
+* Changed: repositories.remote is now an array instead of a hash, and repositories
+  are searched in the order in which they appear.
+* Changed: release task is now a regular task, using the Release object instead
+  of being a ReleaseTask.
+* Changed: eclipse task executes artifacts task.
+* Fixed: inherited attributes now cache default value, useful when working with
+  arrays/hashes.
+* Fixed: manifest file generated even if manifest attribute is false.
+* Fixed: compile task now properly detects when not all files compiled.
+* Fixed: bug that caused project file tasks to execute twice.
+
+0.17 (3/14/2007)
+* Added: project.task acts like Rake's task but can also fetch a task from
+  a project using the project's namespace.
+* Added: project.file acts like Rake's file but resolve relative paths
+  based on the project base directory.
+* Added: Rake tasks execute in the directory in which they were defined.
+* Added: enhanced Rake with circular dependency, and you can find all circular
+  dependencies by running rake check.
+* Added: enhanced Rake in_namespace, if the namespace starts with colon,
+  creates a namespace relative to the root instead of the current namespace.
+* Changed: a project definition is now a task definition.
+* Changed: use enhance to extend the project definition instead of after_define.
+* Changed: LocalDirectoryTask replaced with Project.local_task.
+* Changed: projects method accepts multiple names, returning only these project
+  definitions, returns all of them with no arguments.
+* Changed: package only defines the essentials once, so you can call package
+  on a project to retrieve a specific package by type/id.
+* Changed: zip task (and jar/war) no longer resolve artifacts for you,
+  must call artifacts directly.
+* Changed: cannot access a project before it's defined, but can do that with
+  sub-projects to establish dependencies.
+
 0.16 (3/7/2007)
 * Added: zip.include :as=> to include file under specified name.
 * Added: zip.merge to include the (expanded) contents of one zip file in another.

data/README

@@ -0,0 +1,4 @@
+
+This is Buildr, the build system that doesn't suck.
+
+http://buildr.rubyforge.org/

data/lib/buildr.rb

@@ -1,20 +1,27 @@
-# returning(obj) and with(obj)
+# returning(obj)
 require "facet/kernel/with"
 # &:symbol goodness.
 require "facet/symbol/to_proc"
 # blank? on string and nil
 require "facet/string/blank"
 require "facet/nilclass/blank"
+# x.in?(y) is better than y.include?(x)
+require "facet/kernel/in"
 # What it says.
+require "facet/kernel/__DIR__"
+require "facet/kernel/instance_exec"
 require "facet/module/alias_method_chain"
+require "facet/module/memoize"
 require "facet/string/starts_with"
+require "facet/openobject"
+require "facets/core/kernel/tap"
 
 
 module Buildr
-  VERSION = "0.16.0"
+  VERSION = "0.18.0"
 end
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__))
+$LOAD_PATH.unshift File.join(__DIR__)
 require "core/core.rb"
 require "core/project.rb"
 require "core/artifact.rb"
@@ -26,7 +33,9 @@ require "tasks/filter"
 require "tasks/zip"
 
 require "java/java"
+require "java/jetty"
 require "java/compile"
+require "java/eclipse"
 require "java/test"
 require "java/javacc"
 require "java/openjpa"
@@ -46,3 +55,6 @@ end
 if File.exist?(File.join(Rake.application.original_dir, "buildr.rb"))
   load File.join(Rake.application.original_dir, "buildr.rb")
 end
+
+#Load local tasks that can be used in the Rakefile.
+Dir["#{Dir.pwd}/tasks/*.rake"].each { |ext| load ext }

data/lib/core/artifact.rb

@@ -1,5 +1,8 @@
 module Buildr
 
+  desc "Download all artifacts"
+  task "artifacts"
+
   # This module gives you a way to access the individual properties of an
   # artifact: id, group, type, classifier and version. It also provides other
   # methods commonly used on an artifact, specifically #to_hash and #to_spec.
@@ -183,32 +186,27 @@ module Buildr
       File.join(local, spec[:group].split("."), spec[:id], spec[:version], Artifact.hash_to_file_name(spec))
     end
 
-    # Returns a hash of all the remote repositories. The key is the repository
-    # identifier, and the value is the repository base URL.
+    # Returns an array of all the remote repositories. When downloading an artifact,
+    # the default behavior is to try repositories in the order in which they show in
+    # the array.
     def remote()
-      @remote ||= {}
+      @remote ||= []
     end
 
-    # Sets the remote repositories from a hash. See #remote.
-    def remote=(hash)
-      case hash
+    # With a string argument, sets the remote repository (only one) to this URL.
+    # With an array argument, sets the remote repository to that set of URLs.
+    # Passing nil is equivalent to an empty array.
+    def remote=(urls)
+      case urls
       when nil
-        @remote = {}
-      when Hash
-        @remote = hash.clone
+        @remote = nil
+      when Array
+        @remote = urls.dup
       else
-        raise ArgumentError, "Expecting a hash" unless Hash === hash
+        @remote = [urls.to_s]
       end
     end
 
-    # Adds more remote repositories from a hash. See #remote.
-    #
-    # For example:
-    #   repositories.remote.add :ibiblio=>"http://www.ibiblio.org/maven2"
-    def add(hash)
-      remote.merge!(hash)
-    end
-
     # Attempts to download the artifact from one of the remote repositories
     # and store it in the local repository. Returns the path if downloaded,
     # otherwise raises an exception.
@@ -217,7 +215,7 @@ module Buildr
       path = locate(spec)
       
       puts "Downloading #{Artifact.to_spec(spec)}" if Rake.application.options.trace
-      return path if remote.any? do |repo_id, repo_url|
+      return path if remote.any? do |repo_url|
         begin
           rel_path = spec[:group].gsub(".", "/") +
             "/#{spec[:id]}/#{spec[:version]}/#{Artifact.hash_to_file_name(spec)}"
@@ -235,7 +233,7 @@ module Buildr
           false
         end
       end
-      fail "Failed to download #{Artifact.to_spec(spec)}, tried the following repositories:\n#{repositories.remote.values.join("\n")}"
+      fail "Failed to download #{Artifact.to_spec(spec)}, tried the following repositories:\n#{repositories.remote.join("\n")}"
     end
 
     # Specifies the deployment repository. Accepts a hash with the different
@@ -293,6 +291,7 @@ module Buildr
     spec = Artifact.to_hash(spec)
     unless task = Artifact.lookup(spec)
       task = Artifact.define_task(repositories.locate(spec))
+      Rake::Task["rake:artifacts"].enhance [ task ]
       Artifact.register(task)
     end
     task.apply_spec spec
@@ -336,11 +335,11 @@ module Buildr
       when /:/
         set |= [artifact(spec)]
       when String
-        set |= [file(spec)]
-      when Rake::Task
-        set |= [spec]
+        set |= [File.expand_path(spec)]
       when Project
         set |= artifacts(spec.packages)
+      when Rake::Task
+        set |= [spec]
       when Array
         set |= artifacts(*spec)
       else

data/lib/core/build.rb

@@ -13,7 +13,7 @@ module Buildr
   }
 
   # Handles the build and clean tasks.
-  BUILD_TASKS.each { |name, comment| LocalDirectoryTask.define_task(name).add_comment(comment) }
+  BUILD_TASKS.each { |name, comment| Project.local_task(task(name)).add_comment(comment) }
 
   Project.on_define do |project|
     BUILD_TASKS.each { |name, comment| project.recursive_task name }
@@ -21,25 +21,22 @@ module Buildr
 
   class Project
     def build(*args, &block)
-      returning(@build_task ||= task("build")) do |task|
-        task.enhance args, &block
-      end
+      task("build").enhance args, &block
     end
 
     def clean(*args, &block)
-      returning(@clean_task ||= task("clean")) do |task|
-        task.enhance args, &block
-      end
+      task("clean").enhance args, &block
     end
   end
 
   Project.on_define do |project|
+    # Make sure these tasks are defined in the project.
     project.build
     project.clean
   end
 
 
-  class ReleaseTask < Rake::Task
+  class Release
 
     VERSION_NUMBER_PATTERN  = /VERSION_NUMBER\s*=\s*(["'])(.*)\1/
     NEXT_VERSION_PATTERN    = /NEXT_VERSION\s*=\s*(["'])(.*)\1/
@@ -50,27 +47,30 @@ module Buildr
       end
     end
 
-    def initialize(*args)
-      super
-      enhance do |task|
-        # Make sure we don't have anything uncommitted in SVN.
-        check_status
-        # Update current version to next version before deploying.
-        next_ver = update_version
-        # Run the deployment externally using the new version number
-        # (from the modified Rakefile).
-        sh "rake deploy"
-        # Update the next version as well to the next increment and commit.
-        update_next_version next_ver
-        # Tag the repository for this release.
-        tag_repository next_ver
-        # Update the next version to end with -SNAPSHOT.
-        update_version_to_snapshot next_ver
-      end
+    def initialize(rakefile = nil)
+      @rakefile = rakefile || File.read(Rake.application.rakefile)
+    end
+
+    attr_reader :rakefile
+
+    def invoke()
+      # Make sure we don't have anything uncommitted in SVN.
+      check_status
+      # Update current version to next version before deploying.
+      next_ver = update_version
+      # Run the deployment externally using the new version number
+      # (from the modified Rakefile).
+      sh "rake deploy"
+      # Update the next version as well to the next increment and commit.
+      update_next_version next_ver
+      # Tag the repository for this release.
+      tag_repository next_ver
+      # Update the next version to end with -SNAPSHOT.
+      update_version_to_snapshot next_ver
     end
 
     def check_status()
-      ignores = ReleaseTask.svn_ignores
+      ignores = Release.svn_ignores
       status = svn("status", "--ignore-externals", :verbose=>false).
         reject { |line| line =~ /^X\s/ || ignores.any? { |pat| line =~ pat } }
       fail "Uncommitted SVN files violate the First Principle Of Release!\n#{status}" unless
@@ -81,7 +81,7 @@ module Buildr
     # next version number (VERSION_NUMBER = NEXT_VERSION). We need this
     # before making a release with the next version. Return the next version.
     def update_version()
-      rakefile = File.read(Rake.application.rakefile)
+      rakefile = read_rakefile
       version = rakefile.scan(VERSION_NUMBER_PATTERN)[0][1] or
         fail "Looking for VERSION_NUMBER = \"...\" in your Rakefile, none found"
       next_ver = rakefile.scan(NEXT_VERSION_PATTERN)[0][1] or
@@ -90,11 +90,8 @@ module Buildr
         puts "Current version:  #{version}"
         puts "Next version:     #{next_ver}"
       end
-
       # Switch version numbers.
-      rakefile.gsub!(VERSION_NUMBER_PATTERN) { |ver| ver.sub(/(["']).*\1/, %Q{"#{next_ver}"}) }
-      File.open(Rake.application.rakefile, "w") { |file| file.write rakefile }
-
+      write_rakefile rakefile.gsub(VERSION_NUMBER_PATTERN) { |ver| ver.sub(/(["']).*\1/, %Q{"#{next_ver}"}) }
       next_ver
     end
 
@@ -106,12 +103,9 @@ module Buildr
       nums = version.split(".")
       nums[-1] = nums[-1].to_i + 1
       next_ver = nums.join(".")
-      rakefile = File.read(Rake.application.rakefile)
-      rakefile.gsub!(NEXT_VERSION_PATTERN) { |ver| ver.sub(/(["']).*\1/, %Q{"#{next_ver}"}) }
-      File.open(Rake.application.rakefile, "w") { |file| file.write rakefile }
-
+      write_rakefile read_rakefile.gsub(NEXT_VERSION_PATTERN) { |ver| ver.sub(/(["']).*\1/, %Q{"#{next_ver}"}) }
       # Commit new version number.
-      svn "commit", "-m", "Changed version number to #{version}", Rake.application.rakefile
+      svn "commit", "-m", "Changed version number to #{version}", rakefile
     end
 
     # Create a tag in the SVN repository.
@@ -125,11 +119,19 @@ module Buildr
 
     def update_version_to_snapshot(version)
       version += "-SNAPSHOT"
-      rakefile = File.read(Rake.application.rakefile)
-      rakefile.gsub!(VERSION_NUMBER_PATTERN) { |ver| ver.sub(/(["']).*\1/, %Q{"#{version}"}) }
-      File.open(Rake.application.rakefile, "w") { |file| file.write rakefile }
+      write_rakefile read_rakefile.gsub(VERSION_NUMBER_PATTERN) { |ver| ver.sub(/(["']).*\1/, %Q{"#{version}"}) }
       # Commit new version number.
-      svn "commit", "-m", "Changed version number to #{version}", Rake.application.rakefile
+      svn "commit", "-m", "Changed version number to #{version}", rakefile
+    end
+
+  protected
+
+    def read_rakefile()
+      File.read(rakefile)
+    end
+
+    def write_rakefile(contents)
+      File.open(rakefile, "w") { |file| file.write contents }
     end
 
     def svn(*args)
@@ -146,8 +148,17 @@ module Buildr
         returning(stdout.read) { |output| puts output if Rake.application.options.trace }
       end
     end
+
   end
 
+
   desc "Make a release"
-  ReleaseTask.define_task "release"
+  task("release").tap do |release|
+    class << release
+      def release()
+        @release ||= Release.new
+      end
+    end
+    release.enhance { release.invoke }
+  end
 end

data/lib/core/core.rb

@@ -28,13 +28,128 @@ module Buildr
     #   inherited_attr :java_src_dir do src_dir + "/main/java"
     def inherited_attr(symbol, default = nil, &block)
       block ||= proc { default }
-      define_method symbol do
-        instance_variable_get("@#{symbol}") || (parent ? parent.send(symbol) : self.instance_eval(&block))
+      attr_accessor symbol
+      define_method "#{symbol}_with_inheritence" do
+        unless value = send("#{symbol}_without_inheritence")
+          value = parent ? parent.send(symbol) : self.instance_eval(&block)
+          send "#{symbol}=", value
+        end
+        value
       end
-      define_method "#{symbol}=" do |value|
-        instance_variable_set("@#{symbol}", value)
+      alias_method_chain symbol, :inheritence
+    end
+  end
+
+end
+
+class Rake::Task
+  def invoke
+    tasks = (Thread.current[:tasks] || [])
+    if tasks.include?(name)
+      fail "Circular dependency " + (tasks + [name]).join("=>")
+    end
+    @lock.synchronize do
+      if application.options.trace
+        puts "** Invoke #{name} #{format_trace_flags}"
+      end
+      return if @already_invoked
+      begin
+        Thread.current[:tasks] = tasks + [name]
+        @already_invoked = true
+        invoke_prerequisites
+        execute if needed?
+      ensure
+        Thread.current[:tasks] = tasks
       end
     end
   end
+end
+
+class Rake::Task
 
+  # Access the base directory. The base directory is set when the class
+  # is defined from the current directory. The current directory is set
+  # to the base directory when the class is executed.
+  attr_accessor :base_dir
+
+  # :nodoc:
+  def invoke_with_base_dir()
+    Dir.chdir(@base_dir || Dir.pwd) { invoke_without_base_dir }
+  end
+  alias_method_chain :invoke, :base_dir
+
+  # :nodoc:
+  def initialize_with_base_dir(*args)
+    @base_dir = Dir.pwd
+    initialize_without_base_dir *args
+  end
+  alias_method_chain :initialize, :base_dir
+
+end
+
+
+class Rake::Application
+
+  def in_namespace_with_global_scope(name, &block)
+    if name =~ /^:/
+      begin
+        scope, @scope = @scope, name.split(":")[1...-1]
+        in_namespace_without_global_scope name.split(":").last, &block
+      ensure
+        @scope = scope
+      end
+    else
+      in_namespace_without_global_scope name, &block
+    end
+  end
+  alias_method_chain :in_namespace, :global_scope
+
+end
+
+
+class CheckTask < Rake::Task
+
+  def execute()
+    @warnings = []
+    super
+    report if verbose
+  end
+
+  def note(*msg)
+    @warnings += msg
+  end
+
+  def report()
+    if @warnings.empty?
+      puts HighLine.new.color("No warnings", :green)
+    else
+      warn "These are possible problems with your Rakefile"
+      @warnings.each { |msg| warn "  #{msg}" }
+    end
+  end
+
+end
+
+
+desc "Check your Rakefile for common errors"
+CheckTask.define_task "check"
+
+# Check for circular dependencies
+task "check" do
+  depends = {}
+  expand = lambda do |stack, checking|
+    if depends[checking]
+      if stack.include?(checking)
+        fail "Circular " + (stack + [checking]).join("=>")
+      end
+    else
+      depends[checking] = []
+      depends[checking] |= Rake.application[checking].prerequisites.
+        map { |prereq| expand[stack + [checking.to_s], prereq.to_s] }.flatten.map(&:to_s)
+    end
+    depends[checking]
+  end
+  Rake.application.tasks.each do |checking|
+    expand[ [], checking.to_s ]
+  end
 end