buildr 1.2.10 → 1.3.0

data/lib/buildr/core/application_cli.rb

@@ -0,0 +1,134 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you 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.
+
+# Portion of this file derived from Rake.
+# Copyright (c) 2003, 2004 Jim Weirich
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+require 'getoptlong'
+
+
+module Buildr
+  module CommandLineInterface
+    
+    OPTIONS = [     # :nodoc:
+        ['--help',     '-h', GetoptLong::NO_ARGUMENT,
+          'Display this help message.'],
+        ['--nosearch', '-n', GetoptLong::NO_ARGUMENT,
+          'Do not search parent directories for the buildfile.'],
+        ['--quiet',    '-q', GetoptLong::NO_ARGUMENT,
+          'Do not log messages to standard output.'],
+        ['--buildfile', '-f', GetoptLong::REQUIRED_ARGUMENT,
+          'Use FILE as the buildfile.'],
+        ['--require',  '-r', GetoptLong::REQUIRED_ARGUMENT,
+          'Require MODULE before executing buildfile.'],
+        ['--trace',    '-t', GetoptLong::NO_ARGUMENT,
+          'Turn on invoke/execute tracing, enable full backtrace.'],
+        ['--version',  '-v', GetoptLong::NO_ARGUMENT,
+          'Display the program version.'],
+        ['--environment', '-e', GetoptLong::REQUIRED_ARGUMENT,
+          'Environment name (e.g. development, test, production).']
+      ]
+
+    def collect_tasks
+      top_level_tasks.clear
+      ARGV.each do |arg|
+        if arg =~ /^(\w+)=(.*)$/
+          ENV[$1.upcase] = $2
+        else
+          top_level_tasks << arg
+        end
+      end
+      top_level_tasks.push("default") if top_level_tasks.size == 0
+    end
+    
+    def parse_options
+      opts = GetoptLong.new(*command_line_options)
+      opts.each { |opt, value| do_option(opt, value) }
+    end
+
+    def do_option(opt, value)
+      case opt
+      when '--help'
+        help
+        exit
+      when '--buildfile'
+        rakefiles.clear
+        rakefiles << value
+      when '--version'
+        puts version
+        exit
+      when '--environment'
+        ENV['BUILDR_ENV'] = value
+      when '--require'
+        requires << value
+      when '--nosearch', '--quiet', '--trace'
+        super
+      end
+    end
+
+    def command_line_options
+      OPTIONS.collect { |lst| lst[0..-2] }
+    end
+
+    def version
+      "Buildr #{Buildr::VERSION} #{RUBY_PLATFORM[/java/] && '(JRuby '+JRUBY_VERSION+')'}"
+    end
+
+    def usage
+      puts version
+      puts
+      puts 'Usage:'
+      puts '  buildr [options] [tasks] [name=value]'
+    end
+    
+    def help
+      usage
+      puts
+      puts 'Options:'
+      OPTIONS.sort.each do |long, short, mode, desc|
+        if mode == GetoptLong::REQUIRED_ARGUMENT
+          if desc =~ /\b([A-Z]{2,})\b/
+            long = long + "=#{$1}"
+          end
+        end
+        printf "  %-20s (%s)\n", long, short
+        printf "      %s\n", desc
+      end
+      puts
+      puts 'For help with your buildfile:'
+      puts '  buildr help'
+    end
+    
+  end
+end

data/lib/{core → buildr/core}/build.rb

@@ -1,30 +1,26 @@
-require "core/project"
-require "core/common"
-require "core/checks"
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you 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.
+
+
+require 'buildr/core/project'
+require 'buildr/core/common'
+require 'buildr/core/checks'
+require 'buildr/core/environment'
 
-module Buildr
-
-  desc "Build the project"
-  Project.local_task("build") { |name| "Building #{name}" }
-  desc "Clean files generated during a build"
-  Project.local_task("clean") { |name| "Cleaning #{name}" }
-  desc "Create packages"
-  Project.local_task("package"=>"build") { |name| "Packaging #{name}" }
-  desc "Install packages created by the project"
-  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 "Upload packages created by the project"
-  Project.local_task("upload"=>"package") { |name| "Deploying packages from #{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
 
+module Buildr
 
   class Options
 
@@ -39,31 +35,57 @@ module Buildr
 
   end
 
-  task("parallel") { Buildr.options.parallel = true }
+  task('parallel') { Buildr.options.parallel = true }
+
+
+  module Build
+
+    include Extension
+
+    first_time do
+      desc 'Build the project'
+      Project.local_task('build') { |name| "Building #{name}" }
+      desc 'Clean files generated during a build'
+      Project.local_task('clean') { |name| "Cleaning #{name}" }
+
+      desc 'The default task it build'
+      task 'default'=>'build'
+    end
 
+    before_define do |project|
+      project.recursive_task 'build'
+      project.recursive_task 'clean'
+      project.clean do
+        verbose(true) do
+          rm_rf project.path_to(:target)
+          rm_rf project.path_to(:reports)
+        end
+      end
+    end
 
-  class Project
 
-    # 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()
-      @target ||= _("target")
+    # *Deprecated:* Use +path_to(:target)+ instead.
+    def target
+      Buildr.application.deprecated 'Use path_to(:target) instead'
+      layout.expand(:target)
     end
 
+    # *Deprecated:* Use Layout instead.
     def target=(dir)
-      @target = _(dir)
+      Buildr.application.deprecated 'Use Layout instead'
+      layout[: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.
+    # *Deprecated:* Use +path_to(:reports)+ instead.
     def reports()
-      @reports ||= _("reports")
+      Buildr.application.deprecated 'Use path_to(:reports) instead'
+      layout.expand(:reports)
     end
 
+    # *Deprecated:* Use Layout instead.
     def reports=(dir)
-      @reports = _(dir)
+      Buildr.application.deprecated 'Use Layout instead'
+      layout[:reports] = _(dir)
     end
 
     # :call-seq:
@@ -72,7 +94,7 @@ module Buildr
     #
     # Returns the project's build task. With arguments or block, also enhances that task.
     def build(*prereqs, &block)
-      task("build").enhance prereqs, &block
+      task('build').enhance prereqs, &block
     end
 
     # :call-seq:
@@ -81,25 +103,12 @@ module Buildr
     #
     # Returns the project's clean task. With arguments or block, also enhances that task.
     def clean(*prereqs, &block)
-      task("clean").enhance prereqs, &block
+      task('clean').enhance prereqs, &block
     end
 
   end
 
 
-  Project.on_define do |project|
-    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"
-  task "default"=>"build"
-
-
   class Release
 
     THIS_VERSION_PATTERN  = /THIS_VERSION|VERSION_NUMBER\s*=\s*(["'])(.*)\1/
@@ -119,13 +128,13 @@ module Buildr
           sh "#{command} clean upload #{options.join(' ')}"
         end
         tag version
-        commit version + "-SNAPSHOT"
+        commit version + '-SNAPSHOT'
       end
 
     protected
 
       def command() #:nodoc:
-        Config::CONFIG["arch"] =~ /dos|win32/i ? $PROGRAM_NAME.ext("cmd") : $PROGRAM_NAME
+        Config::CONFIG['arch'] =~ /dos|win32/i ? $PROGRAM_NAME.ext('cmd') : $PROGRAM_NAME
       end
 
       # :call-seq:
@@ -136,7 +145,7 @@ module Buildr
       def check()
         fail "SVN URL must end with 'trunk' or 'branches/...'" unless svn_url =~ /(trunk)|(branches.*)$/
         # Status check reveals modified file, but also SVN externals which we can safely ignore.
-        status = svn("status", "--ignore-externals").reject { |line| line =~ /^X\s/ }
+        status = svn('status', '--ignore-externals').reject { |line| line =~ /^X\s/ }
         fail "Uncommitted SVN files violate the First Principle Of Release!\n#{status}" unless
           status.empty?
       end
@@ -161,20 +170,20 @@ module Buildr
       #   NEXT_VERSION = 1.2.1
       # and the method will return 1.2.0.
       def with_next_version()
-        new_filename = Rake.application.rakefile + ".next"
+        new_filename = Buildr.application.buildfile + '.next'
         modified = change_version do |this_version, next_version|
-          one_after = next_version.split(".")
+          one_after = next_version.split('.')
           one_after[-1] = one_after[-1].to_i + 1
-          [ next_version, one_after.join(".") ]
+          [ next_version, one_after.join('.') ]
         end
-        File.open(new_filename, "w") { |file| file.write modified }
+        File.open(new_filename, 'w') { |file| file.write modified }
         begin
           yield new_filename
-          mv new_filename, Rake.application.rakefile
+          mv new_filename, Buildr.application.buildfile
         ensure
           rm new_filename rescue nil
         end
-        File.read(Rake.application.rakefile).scan(THIS_VERSION_PATTERN)[0][1]
+        File.read(Buildr.application.buildfile).scan(THIS_VERSION_PATTERN)[0][1]
       end
 
       # :call-seq:
@@ -186,18 +195,18 @@ module Buildr
       # 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
+        buildfile = File.read(Buildr.application.buildfile)
+        this_version = buildfile.scan(THIS_VERSION_PATTERN)[0][1] or
           fail "Looking for THIS_VERSION = \"...\" in your Buildfile, none found"
-        next_version = rakefile.scan(NEXT_VERSION_PATTERN)[0][1] or
+        next_version = buildfile.scan(NEXT_VERSION_PATTERN)[0][1] or
           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:"
+          puts 'Upgrading version numbers:'
           puts "  This:  #{this_version}"
           puts "  Next:  #{next_version}"
         end
-        rakefile.gsub(THIS_VERSION_PATTERN) { |ver| ver.sub(/(["']).*\1/, %Q{"#{this_version}"}) }.
+        buildfile.gsub(THIS_VERSION_PATTERN) { |ver| ver.sub(/(["']).*\1/, %Q{"#{this_version}"}) }.
           gsub(NEXT_VERSION_PATTERN) { |ver| ver.sub(/(["']).*\1/, %Q{"#{next_version}"}) }
       end
 
@@ -207,8 +216,8 @@ module Buildr
       # Tags the current working copy with the release version number.
       def tag(version)
         url = svn_url.sub(/(trunk$)|(branches.*)$/, "tags/#{version}")
-        svn "remove", url, "-m", "Removing old copy" rescue nil
-        svn "copy", Dir.pwd, url, "-m", "Release #{version}"
+        svn 'remove', url, '-m', 'Removing old copy' rescue nil
+        svn 'copy', Dir.pwd, url, '-m', "Release #{version}"
       end
 
       # :call-seq:
@@ -216,10 +225,10 @@ module Buildr
       #
       # Last, we commit what we currently have in the working copy.
       def commit(version)
-        rakefile = File.read(Rake.application.rakefile).
+        buildfile = File.read(Buildr.application.buildfile).
           gsub(THIS_VERSION_PATTERN) { |ver| ver.sub(/(["']).*\1/, %Q{"#{version}"}) }
-        File.open(Rake.application.rakefile, "w") { |file| file.write rakefile }
-        svn "commit", "-m", "Changed version number to #{version}", Rake.application.rakefile
+        File.open(Buildr.application.buildfile, 'w') { |file| file.write buildfile }
+        svn 'commit', '-m', "Changed version number to #{version}", Buildr.application.buildfile
       end
 
       # :call-seq:
@@ -227,22 +236,27 @@ module Buildr
       #
       # Executes SVN command and returns the output.
       def svn(*args)
-        cmd = "svn " + args.map { |arg| arg[" "] ? %Q{"#{arg}"} : arg }.join(" ")
+        cmd = 'svn ' + args.map { |arg| arg[' '] ? %Q{"#{arg}"} : arg }.join(' ')
         puts cmd if verbose
-        `#{cmd}`.tap { fail "SVN command failed" unless $?.exitstatus == 0 }
+        `#{cmd}`.tap { fail 'SVN command failed' unless $?.exitstatus == 0 }
       end
 
       # Return the current SVN URL
       def svn_url
-        url = svn("info").scan(/URL: (.*)/)[0][0]
+        url = svn('info').scan(/URL: (.*)/)[0][0]
       end
     end
 
   end
 
-  desc "Make a release"
-  task "release" do |task|
+  desc 'Make a release'
+  task 'release' do |task|
     Release.make
   end
 
 end
+
+
+class Buildr::Project
+  include Buildr::Build
+end

data/lib/{core → buildr/core}/checks.rb

@@ -1,12 +1,31 @@
-require "core/project"
-require "tasks/zip"
-require "spec"
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you 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.
+
+
+require 'buildr/core/project'
+require 'buildr/packaging/zip'
+require 'test/unit'
+require 'spec/matchers'
+require 'spec/expectations'
 
-module Buildr
 
-  module BuildChecks #:nodoc:
+module Buildr
+  # Methods added to Project to allow checking the build.
+  module Checks
 
-    module Matchers
+    module Matchers #:nodoc:
 
       class << self
 
@@ -111,7 +130,7 @@ module Buildr
         # Run the expectation. We only print the expectation name when tracing (to know they all ran),
         # or when we get a failure.
         begin
-          puts description if Rake.application.options.trace
+          puts description if Buildr.application.options.trace
           klass.new.instance_eval &@block
         rescue Exception=>error
           raise error.exception("#{description}\n#{error}").tap { |wrapped| wrapped.set_backtrace(error.backtrace) }
@@ -120,10 +139,31 @@ module Buildr
 
     end
 
-  end
 
+    include Extension
+
+    before_define do |project|
+      # The check task can do any sort of interesting things, but the most important is running expectations.
+      project.task("check") do |task|
+        project.expectations.inject(true) do |passed, expect|
+          begin
+            expect.run_against project
+            passed
+          rescue Exception=>error
+            if verbose
+              puts error.backtrace.detect { |line| line =~ /#{Buildr.application.buildfile}/ } || ""
+              puts error
+            end
+            false
+          end
+        end or fail "Checks failed for project #{project.name} (see errors above)."
+      end
+      project.task("package").enhance do |task|
+        # Run all actions before checks.
+        task.enhance { project.task("check").invoke }
+      end
+    end
 
-  class Project
 
     # :call-seq:
     #    check(description) { ... }
@@ -154,7 +194,7 @@ module Buildr
     # During development you can write placeholder expectations by omitting the block. This will simply report
     # the expectation as pending.
     def check(*args, &block)
-      expectations << BuildChecks::Expectation.new(*args, &block)
+      expectations << Checks::Expectation.new(*args, &block)
     end
 
     # :call-seq:
@@ -167,28 +207,6 @@ module Buildr
 
   end
 
-  Project.on_define do |project|
-    # The check task can do any sort of interesting things, but the most important is running expectations.
-    project.task("check") do |task|
-      project.expectations.inject(true) do |passed, expect|
-        begin
-          expect.run_against project
-          passed
-        rescue Exception=>error
-          if verbose
-            puts error.backtrace.detect { |line| line =~ /#{Rake.application.rakefile}/ } || ""
-            puts error
-          end
-          false
-        end
-      end or fail "Checks failed for project #{project.name} (see errors above)."
-    end
-    project.task("package").enhance do |task|
-      # Run all actions before checks.
-      task.enhance { project.task("check").invoke }
-    end
-  end
-
 end
 
 
@@ -268,94 +286,97 @@ module Zip #:nodoc:
 end
 
 
-module Buildr
-  class ArchiveTask
-
-    class Path
-
-      # :call-seq:
-      #   exist() => boolean
-      #
-      # Returns true if this path exists. This only works if the path has any entries in it,
-      # so exist on path happens to be the opposite of empty.
-      def exist?()
-        !entries.empty?
-      end
-
-      # :call-seq:
-      #   empty?() => boolean
-      #
-      # Returns true if this path is empty (has no other entries inside).
-      def empty?()
-        entries.all? { |entry| entry.empty? }
-      end
-
-      # :call-seq:
-      #   contain(file*) => boolean
-      #
-      # Returns true if this ZIP file path contains all the specified files. You can use relative
-      # file names and glob patterns (using *, **, etc).
-      def contain?(*files)
-        files.all? { |file| entries.detect { |entry| File.fnmatch(file, entry.to_s) } }
-      end
-
-      # :call-seq:
-      #   entry(name) => ZipEntry
-      #
-      # Returns a ZIP file entry. You can use this to check if the entry exists and its contents,
-      # for example:
-      #   package(:jar).path("META-INF").entry("LICENSE").should contain(/Apache Software License/)
-      def entry(name)
-        root.entry("#{@path}#{name}")
-      end
-
-    protected
+class Buildr::ArchiveTask
 
-      def entries() #:nodoc:
-        return root.entries unless @path
-        @entries ||= root.entries.inject([]) { |selected, entry|
-          selected << entry.name.sub(@path, "") if entry.name.starts_with?(@path)
-          selected
-        }
-      end
+  class Path #:nodoc:
 
+    # :call-seq:
+    #   exist() => boolean
+    #
+    # Returns true if this path exists. This only works if the path has any entries in it,
+    # so exist on path happens to be the opposite of empty.
+    def exist?()
+      !entries.empty?
     end
 
     # :call-seq:
     #   empty?() => boolean
     #
-    # Returns true if this ZIP file is empty (has no other entries inside).
+    # Returns true if this path is empty (has no other entries inside).
     def empty?()
-      path("").empty
+      entries.all? { |entry| entry.empty? }
     end
 
     # :call-seq:
     #   contain(file*) => boolean
     #
-    # Returns true if this ZIP file contains all the specified files. You can use absolute
+    # Returns true if this ZIP file path contains all the specified files. You can use relative
     # file names and glob patterns (using *, **, etc).
     def contain?(*files)
-      path("").contain?(*files)
+      files.all? { |file| entries.detect { |entry| File.fnmatch(file, entry.to_s, File::FNM_PATHNAME) } }
     end
 
-  end
-
-
-  class ZipTask
-
     # :call-seq:
-    #   entry(name) => Entry
+    #   entry(name) => ZipEntry
     #
     # Returns a ZIP file entry. You can use this to check if the entry exists and its contents,
     # for example:
-    #   package(:jar).entry("META-INF/LICENSE").should contain(/Apache Software License/)
-    def entry(entry_name)
-      ::Zip::ZipEntry.new(name, entry_name)
+    #   package(:jar).path("META-INF").entry("LICENSE").should contain(/Apache Software License/)
+    def entry(name)
+      root.entry("#{@path}#{name}")
     end
 
+  protected
+
     def entries() #:nodoc:
-      @entries ||= Zip::ZipFile.open(name) { |zip| zip.entries }
+      return root.entries unless @path
+      @entries ||= root.entries.inject([]) { |selected, entry|
+        selected << entry.name.sub(@path, "") if entry.name.index(@path) == 0
+        selected
+      }
     end
 
   end
+
+  # :call-seq:
+  #   empty?() => boolean
+  #
+  # Returns true if this ZIP file is empty (has no other entries inside).
+  def empty?()
+    path("").empty
+  end
+
+  # :call-seq:
+  #   contain(file*) => boolean
+  #
+  # Returns true if this ZIP file contains all the specified files. You can use absolute
+  # file names and glob patterns (using *, **, etc).
+  def contain?(*files)
+    path("").contain?(*files)
+  end
+
+end
+
+
+class Buildr::ZipTask #:nodoc:
+
+  # :call-seq:
+  #   entry(name) => Entry
+  #
+  # Returns a ZIP file entry. You can use this to check if the entry exists and its contents,
+  # for example:
+  #   package(:jar).entry("META-INF/LICENSE").should contain(/Apache Software License/)
+  def entry(entry_name)
+    ::Zip::ZipEntry.new(name, entry_name)
+  end
+
+  def entries() #:nodoc:
+    @entries ||= Zip::ZipFile.open(name) { |zip| zip.entries }
+  end
+
+end
+
+
+class Buildr::Project
+  include Buildr::Checks
 end