mguymon-buildr 1.4.5-java

data/doc/preface.textile

@@ -0,0 +1,54 @@
+---
+layout: preface
+---
+
+p(title). !images/zbuildr.png!
+
+<ol class='toc'>
+  <li>"Quick Start":quick_start.html</li>
+  <li>"Installing and Running":installing.html</li>
+  <li>"Projects":projects.html</li>
+  <li>"Building":building.html</li>
+  <li>"Artifacts":artifacts.html</li>
+  <li>"Packaging":packaging.html</li>
+  <li>"Testing":testing.html</li>
+  <li>"Settings & Profiles":settings_profiles.html</li>
+  <li>"Languages":languages.html</li>
+  <li>"More Stuff":more_stuff.html</li>
+  <li>"Extending Buildr":extending.html</li>
+  <li>"Contributing":contributing.html</li>
+</ol>
+
+
+p(preface).  !images/asf-logo.png!
+
+Copyright 2007-2009 Apache Buildr
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+
+
+<div class='preface quotes'>
+"Daniel Spiewak":http://www.codecommit.com/blog:
+
+bq. If you think about it, the question isn’t “Why use Buildr?”, it’s really “Why use anything else?” The advantages afforded by Buildr are so substantial, I really can’t see myself going with any other tool, at least not when I have a choice.
+
+"Tristan Juricek":http://tristanhunt.com/:
+
+bq. That’s still the strongest sell: it builds everything I need, and as I’ve needed more, I just got things working without a lot of fuss.
+
+"Matthieu Riou":http://offthelip.org/:
+
+bq. We used to rely on Ant, with a fairly extensive set of scripts. It worked but was expensive to maintain. The biggest mistake afterward was to migrate to Maven2. I could write pages of rants explaining all the problems we ran into and we still ended up with thousands of lines of XML.
+
+"Martin Grotzke":http://www.javakaffee.de/blog/:
+
+bq. The positive side effect for me as a java user is that I learn a little ruby, and that’s easy but lots of fun… :-)
+</div>
+
+
+p(preface).  

data/doc/projects.textile

@@ -0,0 +1,276 @@
+---
+layout: default
+title: Projects
+---
+
+
+h2(#starting). Starting Out
+
+In Java, most projects are built the same way: compile source code, run test cases, package the code, release it.  Rinse, repeat.
+
+Feed it a project definition, and Buildr will set up all these tasks for you. The only thing you need to do is specify the parts that are specific to your project, like the classpath dependencies, whether you're packaging a JAR or a WAR, etc.
+
+The remainder of this guide deals with what it takes to build a project.  But first, let's pick up a sample project to work with.  We'll call it _killer-app_:
+
+{% highlight ruby %}
+require "buildr/openjpa"
+
+include Buildr::OpenJPA
+ 
+VERSION_NUMBER = '1.0'
+ 
+AXIS2 = 'org.apache.axis2:axis2:jar:1.2'
+AXIOM = group('axiom-api', 'axiom-impl', 'axiom-dom',
+  :under=>'org.apache.ws.commons.axiom', :version=>'1.2.4')
+AXIS_OF_WS = [AXIOM, AXIS2]
+OPENJPA = ['org.apache.openjpa:openjpa:jar:1.2.0',
+  'net.sourceforge.serp:serp:jar:1.12.0']
+ 
+repositories.remote << 'http://www.ibiblio.org/maven2/'
+ 
+desc 'Code. Build. ??? Profit!'
+define 'killer-app' do
+ 
+  project.version = VERSION_NUMBER
+  project.group = 'acme'
+  manifest['Copyright'] = 'Acme Inc (C) 2007'
+  compile.options.target = '1.5'
+
+  desc 'Abstract classes and interfaces'
+  define 'teh-api' do
+    package :jar
+  end
+
+  desc 'All those implementation details'
+  define 'teh-impl' do
+    compile.with AXIS_OF_WS, OPENJPA
+    compile { open_jpa_enhance }
+    package :jar
+  end
+
+  desc 'What our users see'
+  define 'la-web' do
+    test.with AXIS_OF_WS
+    package(:war).with :libs=>projects('teh-api', 'teh-impl')
+  end
+
+  javadoc projects
+  package :javadoc
+
+end
+{% endhighlight %}
+
+A project definition requires four pieces of information: the project name, group identifier, version number and base directory.  The project name ... do we need to explain why its necessary?  The group identifier and version number are used for packaging and deployment, we'll talk more about that in the "Packaging":packaging.html section.  The base directory lets you find files inside the project.
+
+Everything else depends on what that particular project is building.  And it all goes inside the project definition block, the piece of code that comes between @define <name> ..  do@ and @end@.
+
+
+h2(#dir_structure). The Directory Structure
+
+Buildr follows a convention we picked from years of working with Apache projects.
+
+Java projects are laid out so the source files are in the @src/main/java@ directory and compile into the @target/classes@ directory.  Resource files go in the @src/main/resources@ directory, and copied over to @target/resources@. Likewise, tests come from @src/test/java@ and @src/test/resources@, and end life in @target/test/classes@ and @target/test/resources@, respectively.
+
+WAR packages pick up additional files from the aptly named @src/main/webapp@. And most stuff, including generated source files are parked under the @target@ directory.  Test cases and such may generate reports in the, you guessed it, @reports@ directory.
+
+Other languages will use different directories, but following the same general conventions.  For example, Scala code compiles from the @src/main/scala@ directory, RSpec tests are found in the @src/test/rspec@ directory, and Flash will compile to @target/flash@.  Throughout this document we will show examples using mostly Java, but you can imagine how this pattern applies to other languages.
+
+When projects grow big, you split them into smaller projects by nesting projects inside each other.  Each sub-project has a sub-directory under the parent project and follows the same internal directory structure.  You can, of course, change all of that to suite your needs, but if you follow these conventions, Buildr will figure all the paths for you.
+
+Going back to the example above, the directory structure will look something like this:
+
+p=. !images/project-structure.png!
+
+Notice the @buildfile@ at the top.  That's your project build script, the one Buildr runs.
+
+When you run the @buildr@ command, it picks up the @buildfile@ (which here we'll just call _Buildfile_) from the current directory, or if not there, from the closest parent directory.  So you can run @buildr@ from any directory inside your project, and it will always pick up the same Buildfile.  That also happens to be the base directory for the top project.  If you have any sub-projects, Buildr assumes they reflect sub-directories under their parent.
+
+And yes, you can have two top projects in the same Buildfile.  For example, you can use that to have one project that groups all the application modules (JARs, WARs, etc) and another project that groups all the distribution packages (binary, sources, javadocs).
+
+When you start with a new project you won't see the @target@ or @reports@ directories.  Buildr creates these when it needs to.  Just know that they're there.
+
+
+h2(#naming). Naming And Finding Projects
+
+Each project has a given name, the first argument you pass when calling @define@.  The project name is just a string, but we advise to stay clear of colon (@:@) and slashes (@/@ and @\@), which could conflict with other task and file names.  Also, avoid using common Buildr task names, don't pick @compile@, @build@ or any existing task name for your project name.
+
+Since each project knows its parent project, child projects and siblings, you can reference them from within the project using just the given name.  In other cases, you'll need to use the full name.  The full name is just @parent:child@. So if you wanted to refer to _teh-impl_, you could do so with either @project('killer-app:teh-impl')@ or @project('killer-app').project('teh-impl')@.
+
+The @project@ method is convenient when you have a dependency from one project to another, e.g. using the other project in the classpath, or accessing one of its source files.  Call it with a project name and it will return that object or raise an error.  You can also call it with no arguments and it will return the project itself.  It's syntactic sugar that's useful when accessing project properties.
+
+The @projects@ method takes a list of names and returns a list of projects.  If you call it with no arguments on a project, it returns all its sub-projects.   If you call it with no argument in any other context, it returns all the projects defined so far.
+
+Let's illustrate this with a few examples:
+
+{% highlight ruby %}
+puts projects.inspect
+=> [project("killer-app"), project("killer-app:teh-api") ... ]
+
+puts project('killer-app').projects.inspect
+=> [project("killer-app:teh-api"), project("killer-app:teh-impl") ... ]
+
+puts project('teh-api')
+=> No such project teh-api
+
+puts project('killer-app:teh-api').inspect
+=> project("killer-app:teh-api")
+
+puts project('killer-app').project('teh-api').inspect
+=> project("killer-app:teh-api")
+{% endhighlight %}
+
+To see a list of all projects defined in your Buildfile run @buildr help:projects@.
+
+
+h2(#tasks). Running Project Tasks
+
+Most times, you run tasks like @build@ or @package@ that operate on the current project and recursively on its sub-projects.  The "current project" is the one that uses the current working directory.  So if you're in the @la-web/src@ directory looking at source files, _la-web_ is the current project.  For example: 
+
+{% highlight sh %}
+# build killer-app and all its sub-projects
+$ buildr build
+
+# switch to and test only teh-impl
+$ cd teh-impl
+$ buildr test
+
+# switch to and package only la-web
+$ cd ../la-web
+$ buildr package
+{% endhighlight %}
+
+You can use the project's full name to invoke one of its tasks directly, and it doesn't matter which directory you're in.  For example:
+
+{% highlight sh %}
+# build killer-app and all its sub-projects
+$ buildr killer-app:build
+
+# test only teh-impl
+$ buildr killer-app:teh-impl:test
+
+# package only la-web
+$ buildr killer-app:la-web:package
+{% endhighlight %}
+
+Buildr provides the following tasks that you can run on the current project, or on a specific project by prefixing them with the project's full name:
+
+{% highlight text %}
+clean     # Clean files generated during a build
+compile   # Compile all projects
+build     # Build the project
+upload    # Upload packages created by the project
+install   # Install packages created by the project
+javadoc   # Create the Javadocs for this project
+package   # Create packages
+test      # Run all test cases
+uninstall # Remove previously installed packages
+{% endhighlight %}
+
+To see a list of all the tasks provided by Buildr run @buildr help:tasks@.
+
+
+h2(#properties). Setting Project Properties
+
+We mentioned the group identifier, version number and base directory.  These are project properties.  There are a few more properties we'll cover later on.
+
+There are two ways to set project properties.  You can pass them as a hash when you call @define@, or use accessors to set them on the project directly.  For example:
+
+{% highlight ruby %}
+define 'silly', :version=>'1.0' do
+  project.group = 'acme'
+end
+
+puts project('silly').version
+=> 1.0
+puts project('silly').group
+=> acme
+{% endhighlight %}
+
+Project properties are inherited.  You can specify them once in the parent project, and they'll have the same value in all its sub-projects.  In the example, we only specify the version number once, for use in all sub-projects.
+
+
+h2(#paths). Resolving Paths
+
+You can run @buildr@ from any directory in your project.  To keep tasks consistent and happy, it switches over to the Buildfile directory and executes all the tasks from there, before returning back to your working directory. Your tasks can all rely on relative paths that start from the same directory as the Buildfile.
+
+But in practice, you'll want to use the @path_to@ method.  This method calculates a path relative to the project, a better way if you ever need to refactor your code, say turn a ad hoc task into a function you reuse.
+
+The @path_to@ method takes an array of strings and concatenates them into a path.  Absolute paths are returned as they are, relative paths are expanded relative to the project's base directory.  Slashes, if you don't already know, work very well on both Windows, Linux and OS X.  And as a shortcut, you can use @_@.
+
+For example:
+
+{% highlight ruby %}
+# Relative to the current project
+path_to('src', 'main', 'java')
+
+# the same using symbols
+path_to(:src, :main, :java)
+
+# Exactly the same thing
+_('src/main/java')
+
+# Relative to the teh-impl project
+project('teh-impl')._('src/main/java')
+{% endhighlight %}
+
+
+h2(#defining). Defining The Project
+
+The project definition itself gives you a lot of pre-canned tasks to start with, but that's not enough to build a project.  You need to specify what gets built and how, which dependencies to use, the packages you want to create and so forth.  You can configure existing tasks, extend them to do additional work, and create new tasks.  All that magic happens inside the project definition block.
+
+Since the project definition executes each time you run Buildr, you don't want to perform any work directly inside the project definition block.  Rather, you want to use it to specify how different build task work when you invoke them. Here's an example to illustrate the point:
+
+{% highlight ruby %}
+define 'silly' do
+  puts 'Running buildr'
+
+  build do
+    puts 'Building silly'
+  end
+end
+{% endhighlight %}
+
+Each time you run Buildr, it will execute the project definition and print out "Running buildr".  We also extend the @build@ task, and whenever we run it, it will print "Building silly".  Incidentally, @build@ is the default task, so if you run Buildr with no arguments, it will print both messages while executing the build.  If you run Buildr with a different task, say @clean@, it will only print the first message.
+
+The @define@ method gathers the project definition, but does not execute it immediately.  It executes the project definition the first time you reference that project, directly or indirectly, for example, by calling @project@ with that project's name, or calling @projects@ to return a list of all projects. Executing a project definition will also execute all its sub-projects' definitions.  And, of course, all project definitions are executed once the Buildfile loads, so Buildr can determine how to execute each of the build tasks.
+
+If this sounds a bit complex, don't worry.  In reality, it does the right thing.  A simple rule to remember is that each project definition is executed before you need it, lazy evaluation of sort.  The reason we do that?  So you can write projects that depend on each other without worrying about their order.
+
+In our example, the _la-web_ project depends on packages created by the _teh-api_ and _teh-impl_ projects, the later requiring _teh-api_ to compile. That example is simple enough that we ended up specifying the projects in order of dependency.  But you don't always want to do that.  For large projects, you may want to group sub-projects by logical units, or sort them alphabetically for easier editing.
+
+One project can reference another ahead of its definition.  If Buildr detects a cyclic dependency, it will let you know.
+
+In this example we define one project in terms of another, using the same dependencies, so we only need to specify them once:
+
+{% highlight ruby %}
+define 'bar' do
+  compile.with project('foo').compile.dependencies
+end
+
+define 'foo' do
+  compile.with ..lots of stuff..
+end
+{% endhighlight %}
+
+One last thing to remember.  Actually three, but they all go hand in hand.
+
+*Self is project* Each of these project definition blocks executes in the context of that project, just as if it was a method defined on the project.  So when you call the @compile@ method, you're essentially calling that method on the current project: @compile@, @self.compile@ and @project.compile@ are all the same.
+
+*Blocks are closures* The project definition is also a closure, which can reference variables from enclosing scopes.  You can use that, for example, to define constants, variables and even functions in your Buildfile, and reference them from your project definition.  As you'll see later on, in the "Artifacts":artifacts.html section, it will save you a lot of work.
+
+*Projects are namespaces* While executing the project definition, Buildr switches the namespace to the project name.  If you define the task "do-this" inside the _teh-impl_ project, the actual task name is "killer-app:teh-impl:do-this".  Likewise, the @compile@ task is actually "killer-app:teh-impl:compile".
+
+From outside the project you can reference a task by its full name, either @task('foo:do')@ or @project('foo').task('do')@.  If you need to reference a task defined outside the project from within the project, prefix it with "rake:", for example, @task('rake:globally-defined')@.
+
+
+h2(#your_own_tasks). Writing Your Own Tasks
+
+Of all the features Buildr provide, it doesn't have a task for making coffee. Yet.  If you need to write your own tasks, you get all the power of Rake: you can use regular tasks, file tasks, task rules and even write your own custom task classes.  Check out the "Rake documentation":http://docs.rubyrake.org/ for more information.
+
+We mentioned projects as namespaces before.  When you call @task@ on a project, it finds or defines the task using the project namespace.  So given a project object, @task('do-this')@ will return it's "do-this" task.  If you lookup the source code for the @compile@ method, you'll find that it's little more than a shortcut for @task('compile')@.
+
+Another shortcut is the @file@ method.  When you call @file@ on a project, Buildr uses the @path_to@ method to expand relative paths using the project's base directory.  If you call @file('src')@ on _teh-impl_, it will return you a file task that points at the @teh-impl/src@ directory.
+
+In the current implementation projects are also created as tasks, although you don't invoke these tasks directly.  That's the reason for not using a project name that conflicts with an existing task name.  If you do that, you'll find quick enough, as the task will execute each time you run Buildr.
+
+So now that you know everything about projects and tasks, let's go and "build some code":building.html.

data/doc/quick_start.textile

@@ -0,0 +1,210 @@
+---
+layout: default
+title: Quick Start
+---
+
+This quick start guide is meant to be a _very_ simple introduction to Buildr and its most basic concepts.  However, despite its basic level, we will still cover most of the concepts you will ever need to be productive with Buildr.  We will leave out some important things (like "sub-projects":projects.html), and we will over-simplify some other concepts (such as "artifacts":artifacts.html).  Nevertheless, most Buildr projects never need to go beyond the techniques contained within these pages.
+
+*No knowledge of Ruby is assumed.*  Buildr is designed to be a very intuitive, very easy-to-use tool.  You can create buildfiles which describe incredibly intricate projects, write custom tasks which do things far beyond Ant, and still never need to pick up more than a smattering of Ruby syntax.  With that said, if you do know Ruby, Buildr's DSL will seem very natural and welcoming.  We do assume that you have already "downloaded and installed":installing.html Buildr and are ready to put the tool to good use.
+
+
+h2(#first-project). Your First Project
+
+Much like Maven, Buildr is oriented around projects and tasks.  You define your project in a concise, declarative fashion and most common tasks (such as compilation and testing) will be made available to you "at no extra charge".  Most of the project definition is contained within the _buildfile_ -- or _Buildfile_, if you're really in love with the Make convention -- a single file sitting at the root of your project.  A project definition does not need to be any more complicated than the following:
+
+{% highlight ruby %}
+define 'killer-app'
+{% endhighlight %}
+
+h3. Compiling
+
+Of course, this isn't really giving Buildr much information.  What it can't learn from the buildfile, Buildr will figure out by inspecting your directory structure.  Java sources are expected to exist within the @src/main/java/@ directory.  If Buildr finds these sources, it will automatically configure the compilation to source that directory, depositing the results in the @target/classes/@ directory (all under the project directory of course).  We can run this compilation using the following command:
+
+{% highlight sh %}
+$ buildr compile
+{% endhighlight %}
+
+Information about the classpath and dependencies is described "later on":#dependencies.
+
+p(tip). By default, Buildr projects assume the Java language and the @src/main/java/@ source directory.  You can also have projects in the Scala or Groovy language (both languages support joint compilation with Java).  To use Scala, place your @.scala@ files in the @src/main/scala/@ directory and include the following invocation at the head of your buildfile: @require 'buildr/scala'@  Similarly, Groovy expects sources in the @src/main/groovy/@ directory and necessitates @require 'buildr/groovy'@ (see "languages":languages.html for more information).
+
+The @compile@ task will also detect _any_ files which exist under the @src/main/resources/@ directory.  These resources are copied verbatim to the @target/resources/@ directory as part of the compilation task.  Buildr also performs some basic change detection to minimize compilation.  If your source files haven't changed since the last compile, then they will not be recompiled.
+
+h3. Packaging
+
+At some point, we're going to want to wrap up our classes and produce a single JAR file for distribution.  Buildr can certainly help us with this, but we are going to need to provide it with a little bit more information.  Specifically, we need to say the type of package to produce (e.g. @:jar@, @:war@, etc) as well as the current version of our project.  This information is placed within the buildfile:
+
+{% highlight ruby %}
+define 'killer-app' do
+  project.version = '0.1.0'
+  package :jar
+end
+{% endhighlight %}
+
+The @project.version@ attribute can be any value you like.  Even non-numeric versions are perfectly acceptable (e.g. @'ikj-0.3.1-E'@).  This version -- coupled with the packaging information -- will be used to generate a JAR file: @killer-app-0.1.0.jar@.  As would be expected, this file is placed within the @target/@ directory when the following command is run:
+
+{% highlight sh %}
+$ buildr package
+{% endhighlight %}
+
+The @package@ task depends upon the @compile@ task, so if a rebuild is necessary prior to the creation of the JAR, Buildr will see to it.
+
+We can also chain tasks together in a single invocation.  For example, we may want to clean all of the old compilation results prior to recompiling and generating a packaged result:
+
+{% highlight sh %}
+$ buildr clean package
+{% endhighlight %}
+
+The @clean@ task simply removes the @target/@ directory, effectively wiping out any compilation results like class files or resources.
+
+h3. Directory Structure
+
+As you may have noticed, Buildr does have some default notions about what a project should look like and how it should be organized.  We think that these defaults are quite nice and make for a more navigable project.  However, we do understand that not all projects are exactly alike.  Buildr's "layouts":extending.html#layouts make it possible for any project to easily change these defaults.  For example, this would allow you to easily migrate a project that had been based on a different directory structure, such as the @src/@ and @bin/@ convention often used by Ant.
+
+
+h2(#dependencies). Dependencies
+
+So far, we have seen how Buildr can automatically infer what amounts to dozens of lines of @build.xml@ contents, all based on a buildfile and a directory structure.  However, the best is yet to come.  Buildr also provides Maven-style dependency management (but without the long loading times!).  In other words, you specify each dependent library using a string descriptor and Buildr figures out how to download and configure your classpath (the library descriptors are just a Ruby array, therefore they are separated by commas (@,@)).  You must specify at least one remote repository so that Buildr knows from where to download these libraries.  For example, we can configure our project to reference the "Apache Commons CLI":http://commons.apache.org/cli/ library and download libraries from the Ibiblio repository:
+
+{% highlight ruby %}
+repositories.remote << 'http://www.ibiblio.org/maven2'
+
+define 'killer-app' do
+  project.version = '0.1.0'
+  compile.with 'commons-cli:commons-cli:jar:1.2'
+  package :jar
+end
+{% endhighlight %}
+
+This sort of dependency declaration should look quite familiar if you are at all familiar with Maven.  The general format for an artifact descriptor is _groupId:artifactId:packageType:version_.  Any Maven artifacts included in this fashion will be retrieved from the "list of remote repositories":artifacts.html#repositories (in this case, Ibiblio) and installed in your local repository at @~/.m2/repository/@.
+
+p(tip). You can search the global repository of artifacts at sites like "MvnBrowser":http://www.mvnbrowser.com.  Simply enter the name of the library you are looking for, and the search should pull up the groupId, artifactId and a list of available versions.
+
+Unfortunately, not all libraries are quite as simple as Commons CLI.  Many libraries (such as Apache Wicket) have dependencies of their own.  While we may be able to _compile_ against Apache Wicket without these extra libraries on our classpath, we cannot actually _run_ our application without its transitive dependencies. To avoid tracking down each of these dependencies and adding them manually, we can simply use the @transitive@ directive (this is how Maven behaves by default):
+
+{% highlight ruby %}
+repositories.remote << 'http://www.ibiblio.org/maven2'
+
+define 'killer-app' do
+  project.version = '0.1.0'
+  compile.with transitive('org.apache.wicket:wicket:jar:1.4-rc6')
+  package :jar
+end
+{% endhighlight %}
+
+The @compile.with@ property accepts a full array of comma-separated artifacts, making it possible to specify any number of dependencies as necessary.  Of course, such a long list of verbose string descriptors could get very tiresome and messy.  For this reason, it is conventional to assign each dependency to a constant (e.g. @WICKET@) which is declared just above the project in the buildfile and passed to @compile.with@ in a clean, easy-to-read style:
+
+{% highlight ruby %}
+repositories.remote << 'http://www.ibiblio.org/maven2'
+
+WICKET = transitive('org.apache.wicket:wicket:jar:1.4-rc6')
+SLF4J = 'org.slf4j:slf4j-jdk14:jar:1.5.8'
+
+define 'killer-app' do
+  project.version = '0.1.0'
+  compile.with WICKET, SLF4J
+  package :jar
+end
+{% endhighlight %}
+
+Unfortunate as it may seem, not all libraries are available in Maven repositories.  While most of the major libraries (e.g. Hibernate, Spring, etc) are kept updated by intrepid volunteers, some of the more obscure frameworks are left out in the cold.  An example of one such framework is "DBPool":http://www.snaq.net/java/DBPool, a very fast connection pool designed to integrate with JDBC.  However, like most Java libraries, DBPool does provide a zip archive which contains the JAR file, as well as some documentation and perhaps a license or two.
+
+Almost magically, we can instruct Buildr to get the DBPool artifact from this URL.  Buildr will treat this download just like any other artifact, retrieving it when requried by the @compile@ task.  However, unlike a normal Maven artifact, Buildr will do some extra processing once the download is complete.  It will actually dig into the downloaded archive, detect and extract the JAR file, installing it into the local repository just like any other artifact:
+
+{% highlight ruby %}
+DBPOOL = 'net.snaq:dbpool:jar:4.8.3'
+download artifact(DBPOOL) => 'http://www.snaq.net/java/DBPool/DBPool_v4.8.3.zip'
+
+define 'killer-app' do
+  project.version '0.1.0'
+  compile.with DBPool
+  package :jar
+end
+{% endhighlight %}
+
+This is one area where Buildr's dependency management vastly excedes Maven's.  With Maven, you would have to install the DBPool dependency manually.  Buildr's auto-magical download and extraction keeps the dependency definitions centralized within the buildfile, available to your entire team and automatically resolved as needed by the compilation tasks.
+
+
+h2(#testing). Testing
+
+Buildr supports auto-magical integration with a number of mainstream testing frameworks.  For Java, this includes the ubiquitus JUnit4, as well as TestNG and a number of others.  Scala supports Specs and ScalaTest, while Groovy supports EasyB.  Configuration is as simple as placing your test sources in the appropriate directory.  In the case of JUnit or TestNG, this would be @src/test/java/@.  Once these tests are in place, we can run them using the @test@ task:
+
+{% highlight sh %}
+$ buildr test
+{% endhighlight %}
+
+When the @test@ task runs, it will ensure that your main sources are compiled, as well as the tests themselves.  In the case of JUnit4, test classes are auto-detected based on which base class they extend (@TestCase@).  These tests will be invoked using the special test classpath.  This classpath includes all of the dependencies passed to @compile.with@ along with the dependencies required for testing.  Thus, Buildr will actually go out and download JUnit 4.5 (if necessary) and place that JAR on the classpath in order to run your tests.  It is also possible to add artifacts specifically required for testing.  So, if your tests make use of the Commons Collections library, but your main sources do not, you can include that dependency only for the tests by using the @test.with@ property.  This functions identically to @compile.with@:
+
+{% highlight ruby %}
+define 'killer-app' do
+  project.version = '0.1.0'
+  compile.with 'commons-cli:commons-cli:jar:1.2'
+  test.with 'commons-collections:commons-collections:jar:3.2'
+  package :jar
+end
+{% endhighlight %}
+
+Of course, not everyone _likes_ JUnit4.  As mentioned previously, Buildr supports a number of test frameworks.  It is possible to use TestNG instead of JUnit4 by setting the @test.using@ property to @:testng@:
+
+{% highlight ruby %}
+define 'killer-app' do
+  project.version = '0.1.0'
+  compile.with 'commons-cli:commons-cli:jar:1.2'
+  test.with 'commons-collections:commons-collections:jar:3.2'
+  test.using :testng
+  package :jar
+end
+{% endhighlight %}
+
+Note that only one test framework per-project may be used.  This may seem like an obvious restriction given that both frameworks introduced so far have used the same directory, but other frameworks such as Specs and EasyB do not follow the same convention.  In cases of ambiguity (for example, when tests are present in both @src/test/java/@ _and_ @src/spec/scala/@), only one test framework will be chosen, but this choice is not well-defined.  When in doubt, explicitly specify the test framework with the @test.using@ property.  This overrides Buildr's auto-detection and ensures sane behavior.
+
+Other test frameworks are documented "here":testing.html and "here":languages.html.
+
+
+h2(#custom-tasks). Custom Tasks
+
+If there is one area in which Buildr excels, it is defining custom tasks.  This is something which is notoriously difficult in both Ant and Maven, often requiring separate Java plugins and mountains of code simply to perform basic tasks.  For example, let's imagine that we wanted to define a @run@ task which would compile and run our "killer-app" project.  This is a simple matter of invoking the @java@ command against our main class:
+
+{% highlight ruby %}
+define 'killer-app' do
+  project.version = '0.1.0'
+  package :jar
+
+  task :run => :compile do
+    system 'java -cp target/classes org.apache.killer.Main'
+  end
+end
+{% endhighlight %}
+
+This code defines a new task, @run@, which depends upon the @compile@ task.  This task only performs a single operation: it invokes the @system@ method, passing the relevant command as a string.  Note that the @system@ method documentation may be found "here":http://www.ruby-doc.org/core/classes/Kernel.html#M005971.  Tasks use real Ruby (actually, the entire buildfile is real Ruby too), so if you are familiar with that language, then you should be right at home writing custom tasks in Buildr.  We can invoke this task in the following way:
+
+{% highlight sh %}
+$ buildr killer-app:run
+{% endhighlight %}
+
+This works, but it's clumsy.  The reason we had to give the "@killer-app:@" prefix is because we defined the @run@ task _within_ our project, rather than outside of the @define@ block.  However, if we define @run@ outside of the project, then we don't really have access to the @compile@ task (which is project-specific).  The solution here is a bit of magic known as @local_task@.  This is how tasks like @compile@ and @test@, which are technically project-specific (think: instance methods) can be invoked without the fully-qualified project name:
+
+{% highlight ruby %}
+Project.local_task :run
+
+define 'killer-app' do
+  project.version '0.1.0'
+
+  package :jar
+
+  task :run => :compile do
+    system 'java -cp target/classes org.apache.killer.Main'
+  end
+end
+{% endhighlight %}
+
+Now, we can invoke @run@ exactly the way we want, with a minimum of wasted characters:
+
+{% highlight sh %}
+$ buildr run
+{% endhighlight %}
+
+
+h2(#summary). Summary
+
+As long as this guide was, we have barely even scratched the surface of Buildr's true power.  This was meant only to get you up and running as quickly as possible, exploiting some of Buildr's unique features to ease your build process.  For more comprehensive documentation, start reading about "projects in Buildr":projects.html and work your way from there.