buildr 1.3.3 → 1.3.4

data/bin/buildr

@@ -14,15 +14,6 @@
 # License for the specific language governing permissions and limitations under
 # the License.
 
-start = Time.now
 require 'rubygems'
 require 'buildr'
 Buildr.application.run
-if verbose
-  elapsed = Time.now - start
-  real = []
-  real << ("%ih" % (elapsed / 3600)) if elapsed >= 3600
-  real << ("%im" % ((elapsed / 60) % 60)) if elapsed >= 60
-  real << ("%.3fs" % (elapsed % 60))
-  puts $terminal.color("Completed in #{real.join}", :green)
-end

data/buildr.buildfile

@@ -31,15 +31,15 @@ define 'buildr' do
   define 'extra', :version=>'1.0' do
     compile.using(:javac).from(FileList['addon/buildr/**/*.java']).into('addon/buildr').with(Buildr::Jetty::REQUIRES, Buildr::Nailgun::ARTIFACT_SPEC)
     # Legals included in source code and show in RDoc.
-    legal = 'LICENSE', 'DISCLAIMER', 'NOTICE'
+    legal = 'LICENSE', 'NOTICE'
     package(:gem).include(legal).path('lib').include('addon/buildr')
     package(:gem).spec do |spec|
       spec.author             = 'Apache Buildr'
-      spec.email              = 'buildr-user@incubator.apache.org'
-      spec.homepage           = "http://incubator.apache.org/buildr"
+      spec.email              = 'users@buildr.apache.org'
+      spec.homepage           = "http://buildr.apache.org"
       spec.rubyforge_project  = 'buildr'
       spec.extra_rdoc_files   = legal
-      spec.rdoc_options << '--webcvs' << 'http://svn.apache.org/repos/asf/incubator/buildr/trunk/'
+      spec.rdoc_options << '--webcvs' << 'http://svn.apache.org/repos/asf/buildr/trunk/'
       spec.add_dependency 'buildr', '~> 1.3'
     end
 

data/buildr.gemspec

@@ -16,43 +16,49 @@
 
 Gem::Specification.new do |spec|
   spec.name           = 'buildr'
-  spec.version        = '1.3.3'
+  spec.version        = '1.3.4'
   spec.author         = 'Apache Buildr'
-  spec.email          = "buildr-user@incubator.apache.org"
-  spec.homepage       = "http://incubator.apache.org/buildr"
-  spec.summary        = 'A build system that doesn\'t suck'
+  spec.email          = "users@buildr.apache.org"
+  spec.homepage       = "http://buildr.apache.org/"
+  spec.summary        = "A build system that doesn't suck"
+  spec.description    = <<-TEXT
+Apache Buildr is a build system for Java-based applications, including support
+for Scala, Groovy and a growing number of JVM languages and tools.  We wanted
+something that's simple and intuitive to use, so we only need to tell it what
+to do, and it takes care of the rest.  But also something we can easily extend
+for those one-off tasks, with a language that's a joy to use.
+  TEXT
   spec.rubyforge_project  = 'buildr'
 
   # Rakefile needs to create spec for both platforms (ruby and java), using the
   # $platform global variable.  In all other cases, we figure it out from RUBY_PLATFORM.
   spec.platform       = $platform || RUBY_PLATFORM[/java/] || 'ruby'
   
-  spec.files          = Dir['lib/**/*', 'bin/**/*', 'addon/**/*', 'doc/**/*', 'spec/**/*',
-                            'README.rdoc', 'LICENSE', 'NOTICE', 'DISCLAIMER', 'CHANGELOG',
-                            'buildr.*', 'Rakefile', 'rakelib/**/*', '_buildr', 'etc/**/*']
-  spec.require_paths  = ['lib', 'addon']
+  spec.files          = Dir['{addon,bin,doc,etc,lib,rakelib,spec}/**/*', '*.{gemspec,buildfile}'] +
+                        ['LICENSE', 'NOTICE', 'CHANGELOG', 'README.rdoc', 'Rakefile', '_buildr', '_jbuildr']
+  spec.require_paths  = 'lib', 'addon'
   spec.bindir         = 'bin'                               # Use these for applications.
   spec.executable     = 'buildr'
 
   spec.has_rdoc         = true
-  spec.extra_rdoc_files = ['README.rdoc', 'CHANGELOG', 'LICENSE', 'NOTICE', 'DISCLAIMER']
-  spec.rdoc_options     << '--title' << "Buildr" << '--main' << 'README.rdoc' <<
-                           '--line-numbers' << '--inline-source' << '-p' <<
-                           '--webcvs' << 'http://svn.apache.org/repos/asf/incubator/buildr/trunk/'
+  spec.extra_rdoc_files = 'README.rdoc', 'CHANGELOG', 'LICENSE', 'NOTICE'
+  spec.rdoc_options     = '--title', 'Buildr', '--main', 'README.rdoc',
+                          '--webcvs', 'http://svn.apache.org/repos/asf/buildr/trunk/'
+  spec.post_install_message = "To get started run buildr --help"
 
   # Tested against these dependencies.
-  spec.add_dependency 'rake',                 '0.8.1'
+  spec.add_dependency 'rake',                 '0.8.4'
   spec.add_dependency 'builder',              '2.1.2'
-  spec.add_dependency 'net-ssh',              '2.0.4'
-  spec.add_dependency 'net-sftp',             '2.0.1'
+  spec.add_dependency 'net-ssh',              '2.0.11'
+  spec.add_dependency 'net-sftp',             '2.0.2'
   spec.add_dependency 'rubyzip',              '0.9.1'
-  spec.add_dependency 'highline',             '1.4.0'
-  spec.add_dependency 'rubyforge',            '1.0.0'
-  spec.add_dependency 'hoe',                  '1.7.0'
+  spec.add_dependency 'highline',             '1.5.0'
+  spec.add_dependency 'rubyforge',            '1.0.3'
+  spec.add_dependency 'hoe',                  '1.11.0'
   spec.add_dependency 'rjb',                  '1.1.6' if spec.platform.to_s == 'ruby' 
   spec.add_dependency 'Antwrap',              '0.7.0'
-  spec.add_dependency 'rspec',                '1.1.5'
-  spec.add_dependency 'xml-simple',           '1.0.11'
+  spec.add_dependency 'rspec',                '1.2.2'
+  spec.add_dependency 'xml-simple',           '1.0.12'
   spec.add_dependency 'archive-tar-minitar',  '0.5.2'
-  spec.add_dependency 'jruby-openssl',        '0.2'   if spec.platform.to_s == 'java'
+  spec.add_dependency 'jruby-openssl',        '0.3'   if spec.platform.to_s == 'java'
 end

data/doc/_layouts/default.html

@@ -0,0 +1,82 @@
+<html>
+  <head>
+    <meta content='text/html;charset=UTF-8' http-equiv='Content-Type' />
+    <title>buildr &mdash; {{ page.title }}</title>
+    <style type='text/css'>
+      @import 'css/default.css';
+      @import 'css/syntax.css';
+    </style>
+    <style media='print' type='text/css'>
+      @import 'css/print.css';
+    </style>
+    <meta content='Official Buildr documentation from the people in the know' name='subject' />
+    <link href='images/favicon.png' rel='shortcut icon' />
+  </head>
+  <body>
+    <div id='wrap'>
+      <div id='header'>
+        <a href='http://buildr.apache.org/'>
+          <img alt='buildr' src='images/buildr.png' />
+        </a>
+        <div class='tagline'></div>
+      </div>
+      <div id='pages'>
+        <ol class='toc'>
+          <li>Start Here
+            <ol class="toc">
+              <li><a href='index.html'>Welcome</a></li>
+              <li><a href='download.html'>Download</a></li>
+              <li><a href='buildr.pdf'>User Guide (PDF)</a></li>
+              <li><a href='http://cwiki.apache.org/confluence/display/BUILDR/Index'>Community Wiki</a></li>
+            </ol>
+          </li>
+          <li>Using Buildr
+            <ol class="toc">
+              <li><a href='getting_started.html'>Getting Started</a></li>
+              <li><a href='projects.html'>Projects</a></li>
+              <li><a href='building.html'>Building</a></li>
+              <li><a href='artifacts.html'>Artifacts</a></li>
+              <li><a href='packaging.html'>Packaging</a></li>
+              <li><a href='testing.html'>Testing</a></li>
+              <li><a href='settings_profiles.html'>Settings/Profiles</a></li>
+              <li><a href='languages.html'>Languages</a></li>
+              <li><a href='more_stuff.html'>More Stuff</a></li>
+              <li><a href='extending.html'>Extending Buildr</a></li>
+              <li><a href='http://cwiki.apache.org/confluence/display/BUILDR/Buildr+HowTos'>How-Tos</a></li>
+            </ol>
+          </li>
+          <li>Reference
+            <ol  class="toc">
+              <li><a href='rdoc'>API</a></li>
+              <li><a href='http://docs.rubyrake.org'>Rake</a></li>
+              <li><a href='http://antwrap.rubyforge.org'>Antwrap</a></li>
+              <li><a href='http://cwiki.apache.org/confluence/display/BUILDR/Common+Problems+and+Solutions'>Troubleshooting</a></li>
+            </ol>
+          </li>
+          <li>Get Involved
+            <ol  class="toc">
+              <li><a href='mailing_lists.html'>Mailing Lists</a></li>
+              <li><a href='http://issues.apache.org/jira/browse/Buildr'>Issues/Bugs</a></li>
+              <li><a href='contributing.html'>Contributing</a></li>
+              <li><a href='specs.html'>Specs</a></li>
+              <li><a href='coverage/index.html'>Coverage</a></li>
+            </ol>
+          </li>
+        </ol>
+        <form action='http://www.google.com/cse' id='searchbox_003673095760649043902:ogcgrzu0l2y'>
+          <input name='cx' type='hidden' value='003673095760649043902:ogcgrzu0l2y' />
+          <input name='cof' type='hidden' value='FORID:0' />
+          <input name='q' size='20' type='text' />
+          <input name='sa' type='submit' value='Search' />
+          <img alt='Google Custom Search' src='http://www.google.com/coop/images/google_custom_search_smnar.gif' />
+        </form>
+      </div>
+      <div id='content'>
+        <h1 id='{{ page.title | downcase | replace(' ', '_') }}'>{{ page.title }}</h1>
+        {{ content | toc }}
+        {{ content }}
+      </div>
+      <div id='footer'>Copyright &copy; 2007-2009 The Apache Software Foundation</div>
+    </div>
+  </body>
+</html>

data/doc/_layouts/preface.html

@@ -0,0 +1,22 @@
+<html>
+  <head>
+    <meta content='text/html;charset=UTF-8' http-equiv='Content-Type' />
+    <title>buildr</title>
+    <style type='text/css'>
+      @import 'css/default.css';
+      @import 'css/syntax.css';
+    </style>
+    <style media='print' type='text/css'>
+      @import 'css/print.css';
+    </style>
+    <meta content='Official Buildr documentation from the people in the know' name='subject' />
+    <link href='images/favicon.png' rel='shortcut icon' />
+  </head>
+  <body>
+    <div id='wrap'>
+      <div id='content'>
+        {{ content }}
+      </div>
+    </div>
+  </body>
+</html>

data/doc/{pages/artifacts.textile → artifacts.textile}

@@ -1,4 +1,8 @@
-h1. Artifacts
+---
+layout: default
+title: Artifacts
+---
+
 
 In Buildr, almost everything is a file or a file task. You compile source files that come from the file system using dependencies found on the file system, generating even more files. But how do you get these dependencies to start with, and how do you share them with others?
 
@@ -6,58 +10,69 @@ Artifacts. We designed Buildr to work as a drop-in replacement for Maven 2.0, an
 
 We'll get into all of that in a second, but first, let's introduce the artifact specification. It's a simple string that takes one of two forms:
 
-{{{
+<notextile>
+{% highlight text %}
 group:id:type:version
 group:id:type:classifier:version
-}}}
+{% endhighlight %}
+</notextile>
 
 For example, @'org.apache.axis2:axis2:jar:1.2'@ refers to an artifact with group identifier org.apache.axis2, artifact identifier axis2, a JAR file with version 1.2.  Classifiers are typically used to distinguish between similar file types, for example, a source distribution and a binary distribution that otherwise have the same identifier and are both ZIP files.
 
 
-h2. Specifying Artifacts
+h2(#specifying). Specifying Artifacts
 
 If your Buildfile spells out @'org.apache.axis2:axis2:jar:1.2'@ more than once, you're doing something wrong.  Repeating the same string over and over will make your code harder to maintain.  You'll know that when you upgrade to a new version in one place, forget to do it in another, and end up with a mismatch.
 
 You can use Ruby's syntax to do simple string substitution, for example:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 AXIS_VERSION = '1.2'
 
 compile.with "org.apache.axis2:axis2:jar:#{AXIS_VERSION}"
-}}}
+{% endhighlight %}
+</notextile>
 
 Better yet, you can define all your artifacts at the top of the Buildfile and use constants to reference them in your project definition.  For example:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 AXIS2 = 'org.apache.axis2:axis2:jar:1.2'
 
 compile.with AXIS2
-}}}
+{% endhighlight %}
+</notextile>
 
 Note that we're not using a separate constant for the version number.  In our experience, it's unnecessary.  The version number intentionally appears at the end of the string, where it stands out easily.
 
 If you have a set of artifacts that belong to the same group and version, and that's quite common, you can use the @group@ shortcut:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 AXIOM  = group('axiom-api', 'axiom-impl', 'axiom-dom',
   :under=>'org.apache.ws.commons.axiom', :version=>'1.2.4')
-}}}
+{% endhighlight %}
+</notextile>
 
 p(note). Buildr projects also define a @group@ attribute which can lead to some confusion.  If you want to define an artifact group within a project definition, you should use the explicit qualifier @Buildr::group@.
 
 If you have several artifacts you always use together, consider placing them in an array.  Methods that accept lists of artifacts also accept arrays.  For example:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 OPENJPA = ['org.apache.openjpa:openjpa-all:jar:0.9.7',
   'net.sourceforge.serp:serp:jar:1.12.0']
 AXIS_OF_WS = [AXIS2, AXIOM]
 
 compile.with OPENJPA, AXIS_OF_WS
-}}}
+{% endhighlight %}
+</notextile>
 
 Another way to group related artifacts together and access them individually is using the @struct@ shortcut.  For example:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 JAVAX = struct(
   :activation  =>'javax.activation:activation:jar:1.1',
   :persistence =>'javax.persistence:persistence-api:jar:1.0',
@@ -65,79 +80,96 @@ JAVAX = struct(
 )
 
 compile.with JAVAX.persistence, OPENJPA
-}}}
+{% endhighlight %}
+</notextile>
 
 In our experience, using constants in this manner makes your Buildfile much easier to write and maintain.
 
 And, of course, you can always place your artifact specifications in a separate file and require it into your Buildfile.  For example, if you're working on several different projects that all share the same artifacts:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 require '../shared/artifacts'
-}}}
+{% endhighlight %}
+</notextile>
 
 When you use @require@, Ruby always looks for a filename with the @.rb@ extension, so in this case it expects to find @artifacts.rb@ in the @shared@ directory.
 
 One last thing.  You can also treat artifact specifications as hashes.  For example:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 AXIS = { :group=>'org.apache.axis2', :id=>'axis2', :version=>'1.2' }
 compile.with AXIS
 puts compile.dependencies.first.to_hash
 => { :group=>'org.apache.axis2', :id=>'axis2',
      :version=>'1.2', :type=>:jar }
-}}}
+{% endhighlight %}
+</notextile>
 
 
-h2. Specifying Repositories
+h2(#repositories). Specifying Repositories
 
 Buildr can download artifacts for you, but only if you tell it where to find them.  You need to specify at least one remote repository, from which to download these artifacts.
 
 When you call @repositories.remote@, you get an array of URLs for the various remote repositories.  Initially, it's an empty array, to which you can add new repositories.  For example:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 repositories.remote << 'http://www.ibiblio.org/maven2/'
-}}}
+{% endhighlight %}
+</notextile>
 
-If you need to use a proxy server to access remote repositories, you can set the environment variable @HTTP_PROXY@ to the proxy server URL.  You can also work without a proxy for certain hosts by specifying the @NO_PROXY@ environment variable.  For example:
+If you need to use a proxy server to access remote repositories, you can set the environment variable @HTTP_PROXY@ to the proxy server URL (use @HTTPS_PROXY@ for proxying HTTPS connections).  You can also work without a proxy for certain hosts by specifying the @NO_PROXY@ environment variable.  For example:
 
-{{{!sh
+<notextile>
+{% highlight sh %}
 $ export HTTP_PROXY = 'http://myproxy:8080'
 $ export NO_PROXY = '*.mycompany.com,localhost,special:800'
-}}}
+{% endhighlight %}
+</notextile>
 
 Alternatively you can use the Buildr options @proxy.http@ and @proxy.exclude@:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 options.proxy.http = 'http://myproxy:8080'
 options.proxy.exclude << '*.mycompany.com'
 options.proxy.exclude << 'localhost'
-}}}
+{% endhighlight %}
+</notextile>
 
 All the artifacts download into the local repository.  Since all your projects share the same local repository, you only need to download each artifact once. Buildr was designed to be used alongside Maven 2.0, for example, when migrating projects from Maven 2.0 over to Buildr.  By default it will share the same local repository, expecting the repository to be the @.m2/repository@ directory inside your home directory.
 
 You can choose to relocate the local repository by giving it a different path, for example:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 repositories.local = '/usr/local/maven/repository'
-}}}
+{% endhighlight %}
+</notextile>
 
 That's one change you don't want to commit into the Buildfile, so the best place to do it is in your home directory's @buildr.rb@ file.
 
 Buildr downloads artifacts when it needs to use them, for example, to compile a project.  You don't need to download artifacts directly.  Except when you do, for example, if you want to download all the latest artifacts and then go off-line.  It's as simple as:
 
-{{{!sh
+<notextile>
+{% highlight sh %}
 $ buildr artifacts
-}}}
+{% endhighlight %}
+</notextile>
 
 
-h2. Downloading Artifacts
+h2(#downloading). Downloading Artifacts
 
 Within your buildfile you can download artifacts directly by invoking them, for example:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 artifact('org.apache.openjpa:openjpa-all:jar:0.9.7').invoke
 artifacts(OPENJPA).each(&:invoke)
-}}}
+{% endhighlight %}
+</notextile>
 
 When you let Buildr download artifacts for you, or by invoking the artifact task yourself, it scans through the remote repositories assuming each repository follows the Maven 2 structure.  Starting from the root repository URL, it will look for each artifact using the path @group/id/version/id-version.type@ (or ...@/id-version-classifier.type@).  The group identifier becomes a path by turning periods (@.@) into slashes (@/@). So to find @org.apache.axis2:axis2:jar:1.2@, we're going to look for @org/apache/axis2/axis2/1.2/axis2-1.2.jar@.
 
@@ -147,12 +179,14 @@ But there are exceptions to the rule.  Say we want to download the Dojo widget l
 
 We can still treat Dojo as an artifact, by telling Buildr where to download it from:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 DOJO = '0.2.2'
 
 url = "http://download.dojotoolkit.org/release-#{DOJO}/dojo-#{DOJO}-widget.zip"
 download(artifact("dojo:dojo:zip:widget:#{DOJO}")=>url)
-}}}
+{% endhighlight %}
+</notextile>
 
 Explaining how it works is tricky, skip if you don't care for the details.  On the other hand, it will give you a better understanding of Buildr/Rake, so if not now, come back and read it later.
 
@@ -169,7 +203,7 @@ Since we ordered the calls to @artifact@ first and @download@ second, we know th
 Magic.
 
 
-h2. Install and Upload
+h2(#install_upload). Install and Upload
 
 Generally you use artifacts that download from remote repositories into the local repository, or artifacts packaged by the project itself (see "Packaging":packaging.html), which are then installed into the local repository and uploaded to the release server.
 
@@ -177,18 +211,22 @@ Some artifacts do not fall into either category.  In this example we're going to
 
 So let's start by creating a task that downloads the ZIP, and another one to extract it and create the JAR file:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 app_zip = download('target/app.zip'=>url)
 bean_jar = file('target/app/bean.jar'=>unzip('target/app'=>app_zip))
-}}}
+{% endhighlight %}
+</notextile>
 
 When you call @artifact@, it returns an @Artifact@ task that points to the artifact file in the local repository, downloading the file if it doesn't already exist.  You can override this behavior by enhancing the task and creating the file yourself (you may also want to create a POM file).  Or much simpler, call the @from@ method on the artifact and tell it where to find the source file.
 
 So the next step is to specify the artifact and tell it to use the extracted JAR file:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 bean = artifact('example.com:beans:jar:1.0').from(bean_jar)
-}}}
+{% endhighlight %}
+</notextile>
 
 The artifact still points to the local repository, but when we invoke the task it copies the source file over to the local repository, instead of attempting a download.
 
@@ -196,10 +234,12 @@ Use the @install@ method if you want the artifact and its POM installed in the l
 
 Our example ends by including the artifact in the @install@ and @upload@ tasks:
 
-{{{!ruby
+<notextile>
+{% highlight ruby %}
 install bean
 upload bean
-}}}
+{% endhighlight %}
+</notextile>
 
 p(tip).  Calling the @install@ (and likewise @upload@) method on an artifact run @buildr install@.  If you need to download and install an artifact, invoke the task directly with @install(<artifact>).invoke@.