buildr 1.3.5-java → 1.4.0-java

data/doc/more_stuff.textile

@@ -280,7 +280,7 @@ Buildr.application.on_failure do |title, message, ex|
 end
 {% endhighlight %}
 
-You can place this code inside @buildr.rb@ in your home directory.
+You can place this code inside @buildr.rb@ in the @.buildr@ directory under your home directory.
 
 h2(#eclipse). Eclipse
 
@@ -390,7 +390,7 @@ require 'buildr/java/emma'
 require 'buildr/jdepend'
 {% endhighlight %}
 
-You may want to add those to the Buildfile.  Alternatively, you can use these tasks for all your projects without modifying the Buildfile.  One convenient method is to add these lines to the @buildr.rb@ file in your home directory.
+You may want to add those to the Buildfile.  Alternatively, you can use these tasks for all your projects without modifying the Buildfile.  One convenient method is to add these lines to the @buildr.rb@ file in the @.buildr@ directory under your home directory.
 
 Another option is to require it from the command line (@--require@ or @-r@), for example:
 

data/doc/packaging.textile

@@ -101,22 +101,21 @@ The @include@ method accepts files, directories and file tasks.  You can also us
 And the same way you @include@, you can also @exclude@ specific files you don't want showing up in the ZIP.  For example, to exclude @.draft@ and @.raw@ files:
 
 {% highlight ruby %}
-package(:zip).include('target/docs').
-  exclude('target/docs/**/*.{draft,raw}')
+package(:zip).include(_('target/docs')).exclude('*.draft', '*.raw')
 {% endhighlight %}
 
 So far we've included files under the root of the ZIP.  Let's include some files under a given path using the @:path@ option:
 
 {% highlight ruby %}
-package(:zip).include 'target/docs', :path=>"#{id}-#{version}"
+package(:zip).include _('target/docs'), :path=>"#{id}-#{version}"
 {% endhighlight %}
 
 If you need to use the @:path@ option repeatedly, consider using the @tap@ method instead.  For example:
 
 {% highlight ruby %}
 package(:zip).path("#{id}-#{version}").tap do |path|
-  path.include 'target/docs'
-  path.include 'README'
+  path.include _('target/docs')
+  path.include _('README')
 end
 {% endhighlight %}
 
@@ -127,33 +126,33 @@ p(note). To allow you to spread files across different paths, the include/exclud
 If you need to include a file or directory under a different name, use the @:as@ option.  For example:
 
 {% highlight ruby %}
-package(:zip).include('corporate-logo-350x240.png', :as=>'logo.png')
+package(:zip).include(_('corporate-logo-350x240.png'), :as=>'logo.png')
 {% endhighlight %}
 
 You can also use @:as=>'.'@ to include all files from the given directory.  For example:
 
 {% highlight ruby %}
-package(:zip).include 'target/docs/*'
-package(:zip).include 'target/docs', :as=>'.'
+package(:zip).include _('target/docs/*')
+package(:zip).include _('target/docs'), :as=>'.'
 {% endhighlight %}
 
-These two are almost identical.  They both include all the files from the @target/docs@ directory, but not the directory itself.  But they operate differently.  The first line expands to include all the files in @target/docs@. If you don't already have files in @target/docs@, well, then it won't do anything interesting.  Your ZIP will come up empty.  The second file includes the directory itself, but strips the path during inclusion.  You can define it now, create these files later, and then ZIP them all up.
+These two perform identically.  They both include all the files from the @target/docs@ directory, but not the directory itself, and they are both lazy, meaning that the files can be created later and they will still get packaged into the zip package.
 
-For example, when @package :jar@ decides to include all the files from @target/classes@, it's still working on the project definition, and has yet to compile anything.  Since @target/classes@ may be empty, may not even exist, it uses @:as=>'.'@.
+For example, when you use @package :jar@, under the hood it specifies to include all the files from @target/classes@ with @:as=>'.'@.  Even though this happens during project definition and nothing has been compiled yet (and in fact @target/classes@ may not even exist yet), the .class files generated during compilation are still packaged in the .jar file, as expected.
 
 If you need to get rid of all the included files, call the @clean@ method. Some packaging types default to adding various files and directories, for example, JAR packaging will include all the compiled classes and resources.
 
 You can also merge two ZIP files together, expanding the content of one ZIP into the other.  For example:
 
 {% highlight ruby %}
-package(:zip).merge 'part1.zip', 'part2.zip'
+package(:zip).merge _('part1.zip'), _('part2.zip')
 {% endhighlight %}
 
 If you need to be more selective, you can apply the include/exclude pattern to the expanded ZIP.  For example:
 
 {% highlight ruby %}
 # Everything but the libs
-package(:zip).merge('bigbad.war').exclude('libs/**/*')
+package(:zip).merge(_('bigbad.war')).exclude('libs/**/*')
 {% endhighlight %}
 
 
@@ -257,7 +256,7 @@ If you already have WSDL files in the @src/main/axis2@ directory but would like
 {% highlight ruby %}
 # Host name depends on environment.
 host = ENV['ENV'] == 'test' ? 'test.host' : 'ws.example.com'
-filter.from('src/main/axis2').into('target').
+filter.from(_('src/main/axis2')).into(_(:target)).
   include('services.xml', '==*==.wsdl').using('http_port'=>'8080', 'http_host'=>host)
 package(:aar).wsdls.clear
 package(:aar).with(:services_xml=>_('target/services.xml'), :wsdls=>_('target/==*==.wsdl'))
@@ -404,11 +403,11 @@ package :sources
 
 This one creates a ZIP package with the classifier "sources" that will contain all the source directories in that project, typically @src/main/java@, but also other sources generated from Apt, JavaCC, XMLBeans and friends.
 
-You can also generate a ZIP package with the classifier "javadoc" that contains the JavaDoc documentation for the project.  It uses the same set of documentation files generated by the project's @javadoc@ task, so you can use it in combination with the @javadoc@ method.  For example:
+You can also generate a ZIP package with the classifier "javadoc" that contains the JavaDoc documentation for the project.  It uses the same set of documentation files generated by the project's @doc@ task, so you can use it in combination with the @doc@ method.  For example:
 
 {% highlight ruby %}
 package :javadoc
-javadoc :windowtitle=>'Buggy but Works'
+doc :windowtitle=>'Buggy but Works'
 {% endhighlight %}
 
 By default Buildr picks the project's description for the window title.

data/doc/projects.textile

@@ -13,7 +13,9 @@ Feed it a project definition, and Buildr will set up all these tasks for you. Th
 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'
+require "buildr/openjpa"
+
+include Buildr::OpenJPA
  
 VERSION_NUMBER = '1.0'
  
@@ -90,7 +92,7 @@ When you start with a new project you won't see the @target@ or @reports@ direct
 
 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@ or @build@ for your project name.
+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')@.
 
@@ -201,6 +203,9 @@ For example:
 # 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')
 

data/doc/quick_start.textile

@@ -169,7 +169,7 @@ If there is one area in which Buildr excels, it is defining custom tasks.  This
 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
@@ -185,13 +185,13 @@ $ buildr killer-app:run
 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 %}
-local_task :run
+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

data/doc/scripts/buildr-git.rb

@@ -29,7 +29,7 @@
 #    git apache setup svn --help
 #    git apache sync --help
 #
-# To configure your local repo for svn synchronization, 
+# To configure your local repo for svn synchronization,
 #
 #    git apache update-authors
 #    git remote add upstream git@github.com:buildr/buildr.git
@@ -77,11 +77,11 @@ module BuildrGit
     def options(opts)
       opts.url = @@url
       opts.file = self.class.authors_file
-      [['-u', '--url URL', 
+      [['-u', '--url URL',
         "From URL. defaults to: #{opts.url}", lambda { |url|
           opts.url = url
        }],
-       ['-f', '--file FILE', 
+       ['-f', '--file FILE',
         "Write to FILE, defaults to #{opts.file}", lambda { |path|
           opts.file = path
         }]
@@ -97,7 +97,7 @@ module BuildrGit
 
   class CloneCommand < GitFlow/:clone
     @help = "Create a clone from github.com/buildr repository."
-    
+
     def options(opts)
       opts.origin = 'git://github.com/buildr/buildr.git'
       opts.svn_prefix = 'apache'
@@ -113,7 +113,7 @@ module BuildrGit
 
     def execute(opts, argv)
       git 'clone', opts.origin, opts.local
-      Dir.chdir(opts.local) do 
+      Dir.chdir(opts.local) do
         run 'update-users'
         run 'setup'
       end
@@ -125,7 +125,7 @@ module BuildrGit
     def options(opt)
       []
     end
-    
+
     def execute(opt, argv)
       run 'setup', 'alias'
       run 'setup', 'svn'
@@ -146,10 +146,10 @@ module BuildrGit
       opt.svn_prefix = 'apache'
       opt.svn_path = 'buildr'
       opt.townhall = 'origin'
-      [['--username SVN_USER', 'Use Apache svn username for this svn remote', 
+      [['--username SVN_USER', 'Use Apache svn username for this svn remote',
         lambda { |e| opt.apache_login = e  }],
        ['--svn-prefix PREFIX', 'The name of svn remote to use for project.',
-        "Defaults to #{opt.svn_prefix}", 
+        "Defaults to #{opt.svn_prefix}",
         lambda{|p| opt.svn_prefix = p }],
        ['--svn-uri URI', lambda {|p| opt.svn_uri = p  }],
        ['--svn-rev REVISION', lambda {|p| opt.svn_rev = p  }],
@@ -166,21 +166,21 @@ module BuildrGit
       git 'config', 'svn.authorsfile', authors_file
       git 'config', 'apache.svn', opt.svn_prefix
       git 'config', 'apache.git', opt.townhall
-      
+
       if opt.apache_login
         user, email = UpdateUsersCommand.user_email(opt.apache_login, authors_file)
         puts "You claim to be #{user} <#{email}> with apache login: #{opt.apache_login}"
         git('config', 'user.name', user)
         git('config', 'user.email', email)
       end
-      
+
       if opt.svn_rev
         revision = opt.svn_rev
       else
         location, revision = svn_loc_rev
         revision = opt.svn_rev || revision
       end
-      
+
       if opt.svn_uri
         repo = opt.svn_uri
       else
@@ -189,13 +189,13 @@ module BuildrGit
         repo = $`
       end
 
-      # Tell git where the svn repository is 
+      # Tell git where the svn repository is
       git('config', "svn-remote.#{opt.svn_prefix}.url", repo)
       git('config', "svn-remote.#{opt.svn_prefix}.fetch",
           "#{opt.svn_path}/trunk:refs/remotes/#{opt.svn_prefix}/trunk")
-      git('config', "svn-remote.#{opt.svn_prefix}.branches", 
+      git('config', "svn-remote.#{opt.svn_prefix}.branches",
           "#{opt.svn_path}/branches/*:refs/remotes/#{opt.svn_prefix}/*")
-      git('config', "svn-remote.#{opt.svn_prefix}.tags", 
+      git('config', "svn-remote.#{opt.svn_prefix}.tags",
           "#{opt.svn_path}/tags/*:refs/remotes/#{opt.svn_prefix}/tags/*")
 
       # Store the user for svn dcommit
@@ -214,9 +214,9 @@ module BuildrGit
       # update svn metadata
       mkdir_p(expand_path('.git/svn'))
       svn_meta = expand_path('.git/svn/.metadata')
-      git('config', '--file', svn_meta, 
+      git('config', '--file', svn_meta,
           "svn-remote.#{opt.svn_prefix}.branches-maxRev", revision)
-      git('config', '--file', svn_meta, 
+      git('config', '--file', svn_meta,
           "svn-remote.#{opt.svn_prefix}.tags-maxRev", revision)
     end
 
@@ -255,18 +255,18 @@ apache.svn  - The svn remote using to get changes from Apache SVN.
   class SyncCommand < GitFlow/:sync
     @help = "Synchronizes between Apache svn and git townhall."
     @documentation = <<-DOC
-This command will perform the following actions: 
+This command will perform the following actions:
   * fetch changes from apache svn.
   * rebase them on the current branch or on the one specified with --onto
   * dcommit (this will push your changes to Apache trunk)
 
 GIT CONFIG VALUES:
 
-apache.svn  
+apache.svn
   The svn remote using to get changes from Apache SVN.
   Set by setup-svn --svn-prefix.
 
-apache.git 
+apache.git
   The git remote used as townhall repository.
   Set by setup-svn --townhall.
 
@@ -281,7 +281,7 @@ DOC
       opt.git_branch = 'master'
       opt.apache_git = git('config', '--get', 'apache.git').chomp rescue nil
       opt.apache_svn = git('config', '--get', 'apache.svn').chomp rescue nil
-      opt.svn_username = git('config', '--get', 
+      opt.svn_username = git('config', '--get',
                              "svn-remote.#{opt.apache_svn}.username").chomp rescue nil
       [['--apache-svn SVN_REMOTE', 'The SVN remote used to get changes from Apache',
         "Current value: #{opt.apache_svn}",
@@ -289,15 +289,15 @@ DOC
        ['--apache-git REMOTE', 'The git remote used as town-hall repository.',
         "Current value: #{opt.apache_git}",
         lambda { |r| opt.apache_git = r }],
-       ['--username SVN_USER', 
+       ['--username SVN_USER',
         'Specify the SVN username for dcommit',
         "Defaults to: #{opt.svn_username}",
         lambda { |b| opt.svn_username = b }],
        ['--svn-branch SVN_BRANCH',
-        'Specify the SVN branch to rebase changes from, and where to dcommit', 
+        'Specify the SVN branch to rebase changes from, and where to dcommit',
         "Defaults to: #{opt.svn_branch}",
         lambda { |b| opt.svn_branch = b }],
-       ['--git-branch REMOTE_BRANCH', 
+       ['--git-branch REMOTE_BRANCH',
         'Specify the remote town-hall branch (on apache.git) to update',
         "Defaults to: #{opt.git_branch}",
         lambda { |b| opt.git_branch = b }],
@@ -318,29 +318,29 @@ DOC
       # obtain latest changes from svn
       git('svn', 'fetch', '--svn-remote', opt.apache_svn)
       # obtain latest changes from git
-      git('fetch', opt.apache_git, 
+      git('fetch', opt.apache_git,
           "#{opt.git_branch}:refs/remotes/#{opt.apache_git}/#{opt.git_branch}")
 
       # rebase svn changes in the desired branch
       git('rebase', "#{opt.apache_svn}/#{opt.svn_branch}", opt.branch)
       git('rebase', "#{opt.apache_git}/#{opt.git_branch}", opt.branch)
-      
+
       # dcommit to the specific svn branch
-      ['svn', 'dcommit', 
+      ['svn', 'dcommit',
        '--svn-remote', opt.apache_svn, '--commit-url', commit_url].tap do |cmd|
         if opt.svn_username
           cmd << '--username' << opt.svn_username
         end
         git(*cmd)
       end
-      
+
       # update townhall remote ref
-      git('update-ref', 
+      git('update-ref',
           "refs/remotes/#{opt.apache_git}/#{opt.git_branch}",
           "refs/remotes/#{opt.apache_svn}/#{opt.svn_branch}")
 
       # forward the remote townhall/master to apache/trunk
-      git('push', opt.apache_git, 
+      git('push', opt.apache_git,
           "refs/remotes/#{opt.apache_git}/#{opt.git_branch}:#{opt.git_branch}")
 
       # get back to the original branch
@@ -349,7 +349,7 @@ DOC
   end
 
 
-  # This one is displayed when the user executes this script using 
+  # This one is displayed when the user executes this script using
   # open-uri -e
   HEADER = <<HEADER
 
@@ -364,8 +364,8 @@ and recommended workflow, or any other option.
 
 Ctrl+D or an invalid option to abort
 HEADER
-  
-  # When fork is completed, we display the following notice on a 
+
+  # When fork is completed, we display the following notice on a
   # pager, giving the user a brief overview of git aliases used
   # to keep the mirror in sync.
   NOTICE = <<NOTICE
@@ -381,27 +381,27 @@ ALIASES:
 
     git apache merge    # Merge already fetched changes on the current branch
                         # Use this command to get up to date with trunk changes
-                        # you can always cherry-pick from the apache/trunk 
+                        # you can always cherry-pick from the apache/trunk
                         # branch.
 
     git apache pull     # get apache-fetch && git apache-merge
-   
-    git apache push     # Push to Apache's SVN. Only staged changes (those 
-                        # recorded using `git commit`) will be sent to SVN. 
+
+    git apache push     # Push to Apache's SVN. Only staged changes (those
+                        # recorded using `git commit`) will be sent to SVN.
                         # You need not to be on the master branch.
                         # Actually you can work on a tiny-feature branch and
-                        # commit directly from it. 
+                        # commit directly from it.
                         #
-                        # VERY IMPORTANT: 
+                        # VERY IMPORTANT:
                         #
                         # Missing commits on Apache's SVN will be sent using
                         # your apache svn account. This means that you can
                         # make some commits on behalf of others (like patches
                         # comming from JIRA issues or casual contributors)
-                        # Review the apache-push alias on .git/config if you 
+                        # Review the apache-push alias on .git/config if you
                         # want to change login-name used for commit to SVN.
-                        # 
-                        # See the recommended workflow to avoid commiting 
+                        #
+                        # See the recommended workflow to avoid commiting
                         # other developers' changes and the following section.
 
 THE GITHUB MIRROR:
@@ -410,11 +410,11 @@ THE GITHUB MIRROR:
 
      http://github.com/buildr/buildr
 
-   This mirror DOES NOT replace Apache's SVN repository. We really care about 
-   using Apache infrastructure and following Apache project guidelines for 
+   This mirror DOES NOT replace Apache's SVN repository. We really care about
+   using Apache infrastructure and following Apache project guidelines for
    contributions. This git mirror is provided only for developers convenience,
    allowing them to easily create experimental branches or review code from
-   other committers. 
+   other committers.
 
    All code that wants to make it to the official Apache Buildr repository needs
    to be committed to the Apache SVN repository by using the command:
@@ -423,39 +423,39 @@ THE GITHUB MIRROR:
 
    This command will synchronize both ways svn<->git to keep trunk upto date.
    You need to be an Apache committer and have permissions on the SVN repo.
-   
+
    It's VERY IMPORTANT for Buildr committers to remember that contributions from
    external entities wanting to be accepted will require them to sign the Apache ICLA.
-   We provide the git mirror to make it easier for people to experiment and 
+   We provide the git mirror to make it easier for people to experiment and
    contribute back to Buildr, before merging their code in, please remember they
-   have to create create a JIRA issue granting ASF permission to include their code, 
+   have to create create a JIRA issue granting ASF permission to include their code,
    just like any other contribution following Apache's guidelines.
 
-   So, it's very important - if you care about meritocracy - to follow or at 
+   So, it's very important - if you care about meritocracy - to follow or at
    least that you get an idea of the recommended workflow.
 
 RECOMMENDED WORKFLOW:
-   
-   So now that you have your local buildr copy you can create topic branches 
-   to work on independent features, and still merge easily with head changes. 
+
+   So now that you have your local buildr copy you can create topic branches
+   to work on independent features, and still merge easily with head changes.
 
    They may seem lots of things to consider, but it's all for Buildr's healt.
    As all things git, you can always follow your own workflow and even create
    aliases on you .git/config file to avoid typing much. So, here they are:
 
-   1) get your gitflow configured 
+   1) get your gitflow configured
      (you have already do so, this was the most difficult part)
 
    2) create a topic branch to work on, say.. you want to add cool-feature:
 
-        git checkout -b cool-feature master 
+        git checkout -b cool-feature master
         # now on branch cool-feature
 
    3) hack hack hack.. use the source luke.
-      every time you feel you have something important like added failing 
+      every time you feel you have something important like added failing
       spec, added part of feature, or resolved some conflict from merges,
-      you can commit your current progress. If you want to be selective, use: 
-      
+      you can commit your current progress. If you want to be selective, use:
+
         git commit --interactive
 
    3) review your changes, get ALL specs passing, repeat step 3 as needed
@@ -465,12 +465,12 @@ RECOMMENDED WORKFLOW:
         git apache-fetch
         # You can inspect the upstream changes without having to merge them
         git log apache/trunk # what are they doing!!
-      
+
    5) integrate mainstream changes to your cool-feature branch, you can always
       use `git cherry-pick` to select only some commits.
 
         git merge apache/trunk cool-feature
-   
+
    6) Go to 3 unless ALL specs are passing.
 
    7.a) (Skip to 7.b you have commit bit on Apache's SVN)
@@ -481,19 +481,19 @@ RECOMMENDED WORKFLOW:
         https://issues.apache.org/jira/browse/BUILDR
         dev@buildr.apache.org
 
-   7.b) Now you have everyhing on staging area and merged important changes 
+   7.b) Now you have everyhing on staging area and merged important changes
       from apache/trunk, it's time to commit them to Apache's SVN.
 
-        git apache-push 
+        git apache-push
 
    8) Optional. If you are a buildr committer you may want to synchronize
-     the github mirror for helping others to get changes without having to 
+     the github mirror for helping others to get changes without having to
      wait on Victor's cronjob to run every hour (useful for urgent changes).
 
         git synchronize
 
    9) Pull changes from origin frequently.
-        
+
         git fetch origin
         git rebase --onto origin/master master master
 
@@ -508,5 +508,5 @@ RESOURCES:
 
 NOTICE
   #' for emacs
-  
+
 end