buildr 1.1.3 → 1.2.0

data/lib/buildr/cobertura.rb

@@ -1,4 +1,7 @@
 module Buildr
+
+  # Addes the <code>cobertura:html</code> and <code>cobertura:xml</code> tasks.
+  # Require explicitly using <code>require "buildr/cobertura"</code>.
   module Cobertura
 
     class << self
@@ -9,17 +12,12 @@ module Buildr
         @requires ||= Buildr.artifacts(REQUIRES).each(&:invoke).map(&:to_s)
       end
 
-      def ant_project()
-        @ant_project ||= Buildr::Ant.executable("cobertura") { |ant|
-          ant.taskdef(:classpath=>requires.join(File::PATH_SEPARATOR), :resource=>"tasks.properties" ) }
-      end
-
       def report_to(file = nil)
-        File.expand_path(File.join(*["cobertura", file.to_s].compact))
+        File.expand_path(File.join(*["reports/cobertura", file.to_s].compact))
       end
 
       def data_file()
-        File.expand_path("cobertura.ser")
+        File.expand_path("reports/cobertura.ser")
       end
 
     end
@@ -32,39 +30,48 @@ module Buildr
             # Instrumented bytecode goes in a different directory. This task creates before running the test
             # cases and monitors for changes in the generate bytecode.
             instrumented = project.file(project.path_to(:target, "instrumented")=>project.compile.target) do |task|
-              ant_project.send "cobertura-instrument", :todir=>task.to_s, :datafile=>data_file do
-                fileset(:dir=>project.compile.target.to_s) { include :name=>"**/*.class" }
+              Buildr.ant "cobertura" do |ant|
+                ant.taskdef :classpath=>requires.join(File::PATH_SEPARATOR), :resource=>"tasks.properties"
+                ant.send "cobertura-instrument", :todir=>task.to_s, :datafile=>data_file do
+                  ant.fileset(:dir=>project.compile.target.to_s) { ant.include :name=>"**/*.class" }
+                end
               end
               touch task.to_s, :verbose=>false
             end
             # We now have two target directories with bytecode. It would make sense to remove compile.target
             # and add instrumented instead, but apparently Cobertura only creates some of the classes, so
             # we need both directories and instrumented must come first.
-            project.test.junit.classpath.unshift file(instrumented)
-            project.test.junit.with requires
+            project.test.classpath.unshift file(instrumented)
+            project.test.with requires
             project.clean { rm_rf instrumented.to_s, :verbose=>false }
           end
         end
       end
 
       desc "Run the test cases and produce code coverage reports in #{report_to(:html)}"
-      task "html"=>["instrument", "build"] do
+      task "html"=>["instrument", "test:all"] do
         puts "Creating test coverage reports in #{report_to(:html)}"
         projects = Buildr.projects
-        ant_project.send "cobertura-report", :destdir=>report_to(:html), :format=>"html", :datafile=>data_file do
-          projects.map(&:compile).map(&:sources).flatten.each do |src|
-            fileset(:dir=>src.to_s) { include :name=>"**/*.java" } if File.exist?(src.to_s)
+        Buildr.ant "cobertura" do |ant|
+          ant.taskdef :classpath=>requires.join(File::PATH_SEPARATOR), :resource=>"tasks.properties"
+          ant.send "cobertura-report", :destdir=>report_to(:html), :format=>"html", :datafile=>data_file do
+            ant.projects.map(&:compile).map(&:sources).flatten.each do |src|
+              ant.fileset(:dir=>src.to_s) { ant.include :name=>"**/*.java" } if File.exist?(src.to_s)
+            end
           end
         end
       end
 
       desc "Run the test cases and produce code coverage reports in #{report_to(:xml)}"
-      task "xml"=>["instrument", "build"] do
+      task "xml"=>["instrument", "test:all"] do
         puts "Creating test coverage reports in #{report_to(:xml)}"
         projects = Buildr.projects
-        ant_project.send "cobertura-report", :destdir=>report_to(:xml), :format=>"xml", :datafile=>data_file do
-          projects.map(&:compile).map(&:sources).flatten.each do |src|
-            fileset :dir=>src.to_s if File.exist?(src.to_s)
+        Buildr.ant "cobertura" do |ant|
+          ant.taskdef :classpath=>requires.join(File::PATH_SEPARATOR), :resource=>"tasks.properties"
+          ant.send "cobertura-report", :destdir=>report_to(:xml), :format=>"xml", :datafile=>data_file do
+            ant.projects.map(&:compile).map(&:sources).flatten.each do |src|
+              ant.fileset :dir=>src.to_s if File.exist?(src.to_s)
+            end
           end
         end
       end

data/lib/buildr/hibernate.rb

@@ -2,6 +2,8 @@ require "java/java"
 require "java/ant"
 
 module Buildr
+
+  # Provides Hibernate Doclet and schema export tasks. Require explicitly using <code>require "buildr/hibernate"</code>.
   module Hibernate
 
     REQUIRES = Buildr.struct(
@@ -29,12 +31,12 @@ module Buildr
       #  doclet :sources=>compile.sources, :target=>compile.target, :excludedtags=>"@version,@author,@todo"
       def doclet(options)
         options[:sources].each { |src| file(src).invoke }
-        ant("hibernatedoclet") do |doclet|
-          doclet.taskdef :name=>"hibernatedoclet", :classname=>"xdoclet.modules.hibernate.HibernateDocletTask", :classpath=>requires
-          doclet.hibernatedoclet :destdir=>options[:target].to_s, :excludedtags=>options[:excludedtags], :force=>"true" do
-            hibernate :version=>"3.0"
+        ant "hibernatedoclet" do |ant|
+          ant.taskdef :name=>"hibernatedoclet", :classname=>"xdoclet.modules.hibernate.HibernateDocletTask", :classpath=>requires
+          ant.hibernatedoclet :destdir=>options[:target].to_s, :excludedtags=>options[:excludedtags], :force=>"true" do
+            ant.hibernate :version=>"3.0"
             options[:sources].map(&:to_s).each do |source|
-              fileset :dir=>source.to_s, :includes=>"**/*.java"
+              ant.fileset :dir=>source.to_s, :includes=>"**/*.java"
             end
           end
         end
@@ -49,7 +51,7 @@ module Buildr
       #     fileset :dir=>source.to_s, :includes=>"**/*.hbm.xml"
       #   end
       def schemaexport(options = nil, &block)
-        ant("schemaexport") do |ant|
+        ant "schemaexport" do |ant|
           ant.taskdef :name=>"schemaexport", :classname=>"org.hibernate.tool.hbm2ddl.SchemaExportTask", :classpath=>requires
           ant.schemaexport options, &block if options
         end

data/lib/buildr/javacc.rb

@@ -1,6 +1,7 @@
 require "java/java"
 
 module Buildr
+  # Provides JavaCC compile tasks. Require explicitly using <code>require "buildr/javacc"</code>.
   module JavaCC
 
     REQUIRES = [ "net.java.dev.javacc:javacc:jar:4.0", "net.java.dev.javacc:javacc:jar:4.0" ]

data/lib/buildr/jdepend.rb

@@ -1,13 +1,40 @@
 module Buildr
+
+  # Addes the <code>jdepend:swing</code>, <code>jdepend:text</code> and <code>jdepend:xml</code> tasks.
+  # Require explicitly using <code>require "buildr/jdepend"</code>.
   module Jdepend
 
     REQUIRES = ["jdepend:jdepend:jar:2.9.1"]
 
-    desc "Runs JDepend on all your projects"
-    task "jdepend" do
-      paths = Project.projects.map(&:compile).each(&:invoke).map(&:target).map(&:to_s).select { |path| File.exist?(path) }
-      Buildr.java "jdepend.swingui.JDepend", paths, :classpath=>REQUIRES
+    class << self
+
+      def requires()
+        @requires ||= Buildr.artifacts(REQUIRES).each(&:invoke).map(&:to_s)
+      end
+
+      def paths()
+        Project.projects.map(&:compile).each(&:invoke).map(&:target).map(&:to_s).select { |path| File.exist?(path) }
+      end
+
     end
 
+    namespace "jdepend" do
+
+      desc "Runs JDepend on all your projects (Swing UI)"
+      task "swing" do
+        Buildr.java "jdepend.swingui.JDepend", paths, :classpath=>requires, :name=>"JDepend"
+      end
+
+      desc "Runs JDepend on all your projects (Text UI)"
+      task "text" do
+        Buildr.java "jdepend.textui.JDepend", paths, :classpath=>requires, :name=>"JDepend"
+      end
+
+      desc "Runs JDepend on all your projects (XML output to jdepend.xml)"
+      task "xml" do
+        Buildr.java "jdepend.xmlui.JDepend", "-file", "jdepend.xml", paths, :classpath=>requires, :name=>"JDepend"
+        puts "Created jdepend.xml"
+      end
+    end
   end
 end

data/lib/buildr/jetty.rb

@@ -4,6 +4,7 @@ require "core/project"
 require "java/artifact"
 require "java/java"
 require "thread"
+#require "struct"
 
 module Buildr
 
@@ -16,9 +17,9 @@ module Buildr
   #
   # If you want to keep Jetty running across builds, and look at error messages, you can
   # start Jetty in a separate console with:
-  #   rake jetty:start
+  #   buildr jetty:start
   # To stop this instance of Jetty, simply kill the process (Ctrl-C) or run:
-  #   rake jetty:stop
+  #   buildr jetty:stop
   #
   # If you start Jetty separately from the build, the #use task will connect to that
   # existing server. Since you are using Jetty across several builds, you will want to
@@ -26,6 +27,17 @@ module Buildr
   # which are called when Jetty is first used in the build, and when the build ends.
   class Jetty
 
+    # Which version of Jetty we're using by default (change with options.jetty.version).
+    VERSION = "6.1.3"
+
+    # Libraries used by Jetty.
+    REQUIRES = [ "org.mortbay.jetty:jetty:jar:#{VERSION}", "org.mortbay.jetty:jetty-util:jar:#{VERSION}",
+      "org.mortbay.jetty:servlet-api-2.5:jar:#{VERSION}", "log4j:log4j:jar:1.2.13", "commons-logging:commons-logging:jar:1.1" ]
+    Java.rjb.onload { |rjb| rjb.classpath << REQUIRES << File.join(__DIR__, "jetty") }
+
+    # Default URL for Jetty (change with options.jetty.url).
+    URL = "http://localhost:8080"
+
     class << self
 
       # :call-seq:
@@ -33,24 +45,14 @@ module Buildr
       #
       # Returns an instance of Jetty.
       def instance()
-        @instance ||= Jetty.new
+        @instance ||= Jetty.new("jetty", URL)
       end
 
     end
 
-    # Artifacts required to run Jetty.
-    REQUIRES = [ "org.mortbay.jetty:jetty:jar:6.1.1", "org.mortbay.jetty:jetty-util:jar:6.1.1",
-                 "org.mortbay.jetty:servlet-api-2.5:jar:6.1.1", "log4j:log4j:jar:1.2.13",
-                 "commons-logging:commons-logging:jar:1.1" ]
-
-    Java.rjb.classpath << REQUIRES << File.join(__DIR__, "jetty")
-
-    # Default URL for Jetty.
-    URL = "http://localhost:8080"
-
-    def initialize() #:nodoc:
-      @url = URL
-      namespace "jetty" do
+    def initialize(name, url) #:nodoc:
+      @url = url
+      namespace name do
         @setup = task("setup")
         @teardown = task("teardown")
         @use = task("use") { fire }
@@ -214,17 +216,13 @@ module Buildr
     task("stop") { Jetty.instance.stop }
   end
 
-  class Project
-
-    # :call-seq:
-    #   jetty() => Jetty
-    #
-    # Returns a Jetty object. You can use this to discover the Jetty#use task,
-    # configure the Jetty#setup and Jetty#teardown tasks, deploy and undeploy to Jetty.
-    def jetty()
-      @jetty ||= Jetty.instance
-    end
-
+  # :call-seq:
+  #   jetty() => Jetty
+  #
+  # Returns a Jetty object. You can use this to discover the Jetty#use task,
+  # configure the Jetty#setup and Jetty#teardown tasks, deploy and undeploy to Jetty.
+  def jetty()
+    @jetty ||= Jetty.instance
   end
-  
+
 end

data/lib/buildr/openjpa.rb

@@ -1,6 +1,8 @@
 require "java/java"
 
 module Buildr
+
+  # Provides OpenJPA bytecode enhancement and Mapping tool task. Require explicitly using <code>require "buildr/openjpa"</code>.
   module OpenJPA
 
     VERSION = "0.9.7-incubating"
@@ -24,12 +26,12 @@ module Buildr
         artifacts = Buildr.artifacts(options[:classpath]).each { |a| a.invoke }.map(&:to_s) + [options[:output].to_s]
         properties = file(options[:properties]).tap { |task| task.invoke }.to_s
 
-        Ant.executable("openjpa") do |ant|
+        Buildr.ant "openjpa" do |ant|
           ant.taskdef :name=>"enhancer", :classname=>"org.apache.openjpa.ant.PCEnhancerTask",
             :classpath=>requires.join(File::PATH_SEPARATOR)
           ant.enhancer :directory=>options[:output].to_s do
-            config :propertiesFile=>properties
-            classpath :path=>artifacts.join(File::PATH_SEPARATOR)
+            ant.config :propertiesFile=>properties
+            ant.classpath :path=>artifacts.join(File::PATH_SEPARATOR)
           end
         end
       end
@@ -39,12 +41,12 @@ module Buildr
         artifacts = Buildr.artifacts(options[:classpath]).each{ |a| a.invoke }.map(&:to_s)
         properties = file(options[:properties].to_s).tap { |task| task.invoke }.to_s
 
-        Ant.executable("openjpa") do |ant|
+        Buildr.ant("openjpa") do |ant|
           ant.taskdef :name=>"mapping", :classname=>"org.apache.openjpa.jdbc.ant.MappingToolTask",
             :classpath=>requires.join(File::PATH_SEPARATOR)
           ant.mapping :schemaAction=>options[:action], :sqlFile=>options[:sql].to_s, :ignoreErrors=>"true" do
-            config :propertiesFile=>properties
-            classpath :path=>artifacts.join(File::PATH_SEPARATOR)
+            ant.config :propertiesFile=>properties
+            ant.classpath :path=>artifacts.join(File::PATH_SEPARATOR)
           end
         end
       end

data/lib/buildr/xmlbeans.rb

@@ -2,6 +2,8 @@ require "java/java"
 require "java/ant"
 
 module Buildr
+
+  # Provides XMLBeans schema compiler. Require explicitly using <code>require "buildr/xmlbeans"</code>.
   module XMLBeans
 
     REQUIRES = [ "xmlbeans:xbean:jar:2.2.0", "stax:stax-api:jar:1.0" ]
@@ -13,12 +15,12 @@ module Buildr
         options[:verbose] ||= Rake.application.options.trace || false
         rake_check_options options, :verbose, :noop, :javasource, :jar, :compile, :output, :xsb
         puts "Running XMLBeans schema compiler" if verbose
-        Ant.executable("xmlbeans") do |ant|
+        Buildr.ant "xmlbeans" do |ant|
           ant.taskdef :name=>"xmlbeans", :classname=>"org.apache.xmlbeans.impl.tool.XMLBean",
             :classpath=>requires.join(File::PATH_SEPARATOR)
           ant.xmlbeans :srconly=>"true", :srcgendir=>options[:output].to_s, :classgendir=>options[:output].to_s, 
             :javasource=>options[:javasource] do
-            args.flatten.each { |file| fileset File.directory?(file) ? { :dir=>file } : { :file=>file } }
+            args.flatten.each { |file| ant.fileset File.directory?(file) ? { :dir=>file } : { :file=>file } }
           end
         end
         # Touch paths to let other tasks know there's an update.
@@ -34,9 +36,12 @@ module Buildr
     end
 
     def compile_xml_beans(*args)
+      # Run whenever XSD file changes, but typically we're given an directory of XSD files, or even file patterns
+      # (the last FileList is there to deal with things like *.xsdconfig).
+      files = args.flatten.map { |file| File.directory?(file) ? FileList["#{file}/*.xsd"] : FileList[file] }.flatten
       # Generate sources and add them to the compile task.
-      generated = file(path_to(:target, "generated/xmlbeans")=>FileList[args.flatten]) do |task|
-        XMLBeans.compile task.prerequisites, :output=>task.name,
+      generated = file(path_to(:target, "generated/xmlbeans")=>files) do |task|
+        XMLBeans.compile args.flatten, :output=>task.name,
           :javasource=>compile.options.source, :xsb=>compile.target
       end
       compile.from(generated).with(JAVAX.stream, XMLBEANS)

data/lib/core/build.rb

@@ -1,4 +1,6 @@
 require "core/project"
+require "core/common"
+require "core/checks"
 
 module Buildr
 
@@ -12,47 +14,37 @@ module Buildr
   Project.local_task("install"=>"package") { |name| "Installing packages from #{name}" }
   desc "Remove previously installed packages"
   Project.local_task("uninstall") { |name| "Uninstalling packages from #{name}" }
-  desc "Deploy packages created by the project"
-  Project.local_task("deploy"=>"package") { |name| "Deploying packages from #{name}" }
+  desc "Upload packages created by the project"
+  Project.local_task("upload"=>"package") { |name| "Deploying packages from #{name}" }
 
-  [ :build, :clean, :package, :install, :uninstall, :deploy ].each do |name|
+  [ :build, :clean, :package, :install, :uninstall, :upload ].each do |name|
     Project.on_define { |project| project.recursive_task name }
   end
 
+  task("deploy"=>"upload") do
+    warn_deprecated "Please use the 'upload' task instead of 'deploy'."
+  end
+
 
-  # Collection of options for controlling Buildr. For example for running builds without running
-  # test cases, or running builds in parallel.
   class Options
 
     # Runs the build in parallel when true (defaults to false). You can force a parallel build by
     # setting this option directly, or by running the parallel task ahead of the build task.
     #
     # This option only affects recurvise tasks. For example:
-    #   rake parallel package
+    #   buildr parallel package
     # will run all package tasks (from the sub-projects) in parallel, but each sub-project's package
     # task runs its child tasks (prepare, compile, resources, etc) in sequence.
     attr_accessor :parallel
 
   end
 
-  class << self
-
-    # :call-seq:
-    #   options() => Options
-    #
-    # Returns the Buildr options. See Options.
-    def options()
-      @options ||= Options.new
-    end
-
-  end
-
   task("parallel") { Buildr.options.parallel = true }
 
 
   class Project
 
-    # The target directory. By default, it's the target directory inside the project. Various tasks
+    # The target directory. By default, it's the "target" directory inside the project. Various tasks
     # use it to determine where to place files, e.g. when compiling or packaging. The clean task
     # nukes it.
     def target()
@@ -63,6 +55,17 @@ module Buildr
       @target = _(dir)
     end
 
+    # The reports directory. By default, it's the "reports" directory inside the project. Various tasks
+    # use it to determine where to place reports, e.g. when running test cases or code analysis.
+    # The clean task nukes it.
+    def reports()
+      @reports ||= _("reports")
+    end
+
+    def reports=(dir)
+      @reports = _(dir)
+    end
+
     # :call-seq:
     #    build(*prereqs) => task
     #    build { |task| .. } => task
@@ -73,8 +76,8 @@ module Buildr
     end
 
     # :call-seq:
-    #    build(*prereqs) => task
-    #    build { |task| .. } => task
+    #    clean(*prereqs) => task
+    #    clean { |task| .. } => task
     #
     # Returns the project's clean task. With arguments or block, also enhances that task.
     def clean(*prereqs, &block)
@@ -83,8 +86,14 @@ module Buildr
 
   end
 
+
   Project.on_define do |project|
-    project.clean { verbose(false) { rm_rf project.path_to(:target) } }
+    project.clean do
+      verbose(true) do
+        rm_rf project.path_to(:target)
+        rm_rf project.path_to(:reports)
+      end
+    end
   end
 
   desc "The default task it build"
@@ -104,7 +113,7 @@ module Buildr
       # Make a release.
       def make()
         check
-        version = with_next_version { |filename, version| sh "rake clean deploy DEBUG=no --rakefile #{filename}" }
+        version = with_next_version { |filename, version| sh "buildr clean upload DEBUG=no --buildfile #{filename}" }
         tag version
         commit version + "-SNAPSHOT"
       end
@@ -129,9 +138,9 @@ module Buildr
       # Yields to block with upgraded version number, before committing to use it. Returns the *new*
       # current version number.
       #
-      # We need a Rakefile with upgraded version numbers to run the build, but we don't want the
-      # Rakefile modified unless the build succeeds. So this method updates the version numbers in
-      # a separate (Rakefile.next) file, yields to the block with that filename, and if successful
+      # We need a Buildfile with upgraded version numbers to run the build, but we don't want the
+      # Buildfile modified unless the build succeeds. So this method updates the version numbers in
+      # a separate (Buildfile.next) file, yields to the block with that filename, and if successful
       # copies the new file over the existing one.
       #
       # Version numbers are updated as follows. The next release version becomes the current one,
@@ -160,19 +169,19 @@ module Buildr
       end
 
       # :call-seq:
-      #   change_version() { |this, next| ... } => rakefile
+      #   change_version() { |this, next| ... } => buildfile
       #
-      # Change version numbers in the current Rakefile, but without writing a new file (yet).
-      # Returns the contents of the Rakefile with the modified version numbers.
+      # Change version numbers in the current Buildfile, but without writing a new file (yet).
+      # Returns the contents of the Buildfile with the modified version numbers.
       #
       # This method yields to the block with the current (this) and next version numbers and expects
       # an array with the new this and next version numbers.
       def change_version()
         rakefile = File.read(Rake.application.rakefile)
         this_version = rakefile.scan(THIS_VERSION_PATTERN)[0][1] or
-          fail "Looking for THIS_VERSION = \"...\" in your Rakefile, none found"
+          fail "Looking for THIS_VERSION = \"...\" in your Buildfile, none found"
         next_version = rakefile.scan(NEXT_VERSION_PATTERN)[0][1] or
-          fail "Looking for NEXT_VERSION = \"...\" in your Rakefile, none found"
+          fail "Looking for NEXT_VERSION = \"...\" in your Buildfile, none found"
         this_version, next_version = yield(this_version, next_version)
         if verbose
           puts "Upgrading version numbers:"
@@ -222,23 +231,4 @@ module Buildr
     Release.make
   end
 
-
-  namespace "buildr" do
-
-    desc "Freezes the Rakefile so it always uses Buildr version #{Buildr::VERSION}"
-    task "freeze" do
-      gem = %Q{gem "buildr", "#{Buildr::VERSION}"}
-      rakefile = read(Rake.application.rakefile)
-      puts "Freezing the Rakefile so it always uses Buildr version #{Buildr::VERSION}"
-      write Rake.application.rakefile, rakefile =~ /gem\s*(["'])buildr\1/ ?
-        rakefile.sub(/gem\s*(["'])buildr\1\s*,\s*(["']).*\2/, gem) : gem + "\n" + rakefile
-    end
-
-    desc "Unfreezes the Rakefile to use the latest version of Buildr"
-    task "unfreeze" do
-      puts "Unfreezing the Rakefile to use the latest version of Buildr from your Gems repository"
-      write Rake.application.rakefile, read(Rake.application.rakefile).sub(/^\s*gem\s*(["'])buildr\1.*\n/, "")
-    end
-
-  end
 end