buildr 1.1.3 → 1.2.0

data/CHANGELOG

@@ -1,3 +1,51 @@
+1.2 (6/6/2007)
+* Added: Artifact.list returns specs for all registered artifacts (those created with artifact or package).
+* Added: Buildr.option.java_args are used when creating the RJB JVM, when running a Java process (unless you override directly), and when running JUnit tests (again, unless override).
+* Added: TestNG support (test.using :testng).
+* Added: You can run multiple tests from the command line, e.g. rake test:foo,bar.
+* Added: If you want to distribute source code and JavaDoc alongside your JARs (helpful when using IDE/debugging), you can now do so by calling package_with_sources and package_with_javadoc on the project (or the parent project to affect all its sub-projects).
+* Added: junit:report task generates XML and HTML reports in the reports/junit directory.
+* Added: test=all option runs all test cases ignoring failure.
+* Added: project generation for IntelliJ Idea. Imports dependencies properly from your local repository (the M2_REPO path variable must be defined), supports tests and resources.
+* Added: A check task for each project that runs after packaging and can be used to check the build itself, using RSpec matchers.
+* Added: The help task can be used to get basic information about your build. Right now it returns a list of described tasks, but you can extend it using the help method. Try it out: rake help.
+* Added: Integration tests that run after packaging (unless tests are disabled). There's only one integration tests task (duh) that you can access from anywhere. You can tell a project to run its tests during the integration phase with test.using :integration.
+* Added: package :sources and package :javadoc, used by package_with_sources and package_with_javadoc.
+* Added: Unzip paths now return root/target. (Nathan)
+* Added: buildr command line, replacing rake. Differs from rake in two ways: uses buildfile by default (but Rakefile also works) and offers to create buildfile if you don't already have one.
+* Added: options.proxy.http now set from the environment variable HTTP_PROXY (Anatol Pomozov).
+* Added: options.java_args now set from environment variable JAVA_OPTIONS.
+* Changed: Filter now complains if source directory or target directory not set, or if source directory does not exist.
+* Changed: Filter.run returns true if filter run, false otherwise, and can be run multiple times.
+* Changed: repositories.proxy returns a URI or nil; you can still set a proxy using a hash.
+* Changed: Transports went the way of the Dodo, instead we now use read/write/download/upload methods implemented on URI itself.
+* Changed: We now have a way to configure multiple proxies through the options.proxy method; use that instead of repositories.proxies.
+* Changed: Upgraded to Ant 1.7.0, JUnit 4.3, JMock 1.2.
+* Changed: TestTask now provides list of test classes and failed classes through test_classes and failed_tests attributes.
+* Changed: The jetty method is now available everywhere, so you can change the URL using jetty.url = at the top of the Rakefile. Also upgraded to 6.1.3.
+* Changed: Test classes are now identified as either starting with Test* or ending with *Test, before attempting any include/exclude patterns. Anything ending with *TestCase or *Suite ignored for now (but if you explain why, we can add it back).
+* Changed: What used to be the projects task is now help:projects task, anticipating more help: tasks to come.
+* Changed: We now have 3(!) JDepend tasks: jdepend:swing (with windows!), jdepend:text (console) and jdepend:xml (enterprisy).
+* Changed: Good news for packagers: package_as_ yield no longer required, just make sure to create the task once and return it each time.
+* Changed: JUnit tests now run using Ant, which makes them faster to run, and gives you text/XML reports (check out the reports/junit directory).
+* Changed: Cobertura now writes reports to reports/cobertura, in fact, if you're looking for a report of any kind, the reports directory is the place to find it.
+* Changed: Upgraded to AntWrap 0.6. Note that with AntWrap 0.6 we yield to the block instead of doing instance_eval, so any call to the ant project must be prefixed with an AntProject object. Code that relies on the old functionality (and that's pretty much any code with element-containing tasks) will break.
+* Changed: artifacts now accepts a struct.
+* Changed: The repositories.download method folded into Artifact, the repositories.deploy method renamed upload and folded into ActsAsArtifact.
+* Changed: The deploy task is now called upload, and repositories.deploy_to is now repositories.release_to.
+* Removed: The check task, which previously was a way to find some circular dependencies (multitask) but not others (dynamically defined).
+* Removed: JUnitTask, test.junit and Java.junit methods all deprecated; anything you need to affect the unit tests is right there in TestTask.
+* Removed: The package(:jar) and package(:war) options, such as :manifest, :include, :libs are all deprecated. Instead, use the package method to define the package, and the with method to enhance it, e.g. package(:war).with(:libs=>...) instead of package(:war, :libs=>...).
+* Removed: The []= method on ZipTask and anything derived from it is deprecated in favor of using attribute accessors.
+* Removed: Ant.executable and Ant.declarative are deprecated. Use Buildr.ant instead of Ant.executable. Use AntWrap directly if you need the Ant.declarative functionality.
+* Fixed: Filter now properly handles multiple keys on the same line.
+* Fixed: Tests teardown now properly executing.
+* Fixed: Cobertura tasks now run tests, even if test=no.
+* Fixed: XMLBeans compile task not detecting change to XSD file.
+* Fixed: URI.download and download task do not create directory path for downloaded file (Anders Bengtsson).
+* Fixed: Gets JVM version number from system property java.version instead of calling java -version.
+* Fixed: Artifact downloads POM first, such that you can download/create/fake it youself.
+
 1.1.3 (6/12/2007)
 * Added: Long awaited idea project files generation. Very early code, the iml seems to be generated okay but needs testing. The ipr is still missing but will come in due time (and it's not always necessary anyway).
 *Fixed: Doc bug: unzip doesn't have an into(dir) method.

data/README

@@ -19,7 +19,7 @@ http://buildr.rubyforge.org
 
 * http://groups.google.com/group/buildr-talk
 
-Create your own Rakefile and start living the life!
+Create your own Buildfile and start living the life!
 
 
 == Where's My Ruby?

data/Rakefile

@@ -0,0 +1,204 @@
+require "rubygems"
+Gem::manage_gems
+require "rake/gempackagetask"
+require "spec/rake/spectask"
+
+
+# Gem specification comes first, other tasks rely on it.
+spec = Gem::Specification.new do |spec|
+
+  spec.name         = "buildr"
+  spec.version      = File.read(__FILE__.pathmap("%d/lib/buildr.rb")).scan(/VERSION\s*=\s*(['"])(.*)\1/)[0][1]
+  spec.author       = "Assaf Arkin"
+  spec.email        = "arkin@intalio.com"
+  spec.homepage     = "http://#{spec.name}.rubyforge.org"
+  spec.summary      = "A build system that doesn't suck"
+  spec.files        = FileList["lib/**/*", "CHANGELOG", "README", "LICENSE", "Rakefile"].collect
+  spec.require_path = "lib"
+  spec.autorequire  = "buildr.rb"
+  spec.has_rdoc     = true
+  spec.extra_rdoc_files = ["README", "CHANGELOG", "LICENSE"]
+  spec.rdoc_options << "--title" << "Buildr -- #{spec.summary}" <<
+                       "--main" << "README" << "--line-numbers" << "-inline-source"
+  spec.rubyforge_project = "buildr"
+
+  spec.bindir = "bin"                               # Use these for applications.
+  spec.executables = ["buildr"]
+
+  # Tested against these dependencies.
+  spec.add_dependency "rake",     "= 0.7.3"
+  spec.add_dependency "facets",   "= 1.8.54"
+  spec.add_dependency "builder",  "= 2.1.2"
+  spec.add_dependency "net-ssh",  "= 1.1.2"
+  spec.add_dependency "net-sftp", "= 1.1.0"
+  spec.add_dependency "rubyzip",  "= 0.9.1"
+  spec.add_dependency "highline", "= 1.2.9"
+  spec.add_dependency "rjb",      "= 1.0.6"
+  spec.add_dependency "Antwrap",  "= 0.6.0"
+  spec.add_dependency "rspec",    "= 1.0.5"
+end
+
+
+# Testing is everything.
+desc "Run test cases"
+Spec::Rake::SpecTask.new(:test) do |task|
+  task.spec_files = FileList["test/**/*.rb"]
+  task.spec_opts = [ "--format", "specdoc", "--color", "--diff" ]
+end
+
+desc "Run test cases with rcov"
+Spec::Rake::SpecTask.new(:rcov) do |task|
+  task.spec_files = FileList["test/**/*.rb"]
+  task.spec_opts = [ "--format", "specdoc", "--color", "--diff" ]
+  task.rcov = true
+end
+
+
+# Packaging and local installation.
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Install the package locally"
+task :install=>:package do |task|
+  system "gem", "install", "pkg/#{spec.name}-#{spec.version}.gem"
+end
+
+desc "Uninstall previously installed packaged"
+task :uninstall do |task|
+  system "gem", "uninstall", spec.name, "-v", spec.version.to_s
+end
+
+
+# Documentation.
+begin
+  require "rake/rdoctask"
+  require "docter"
+  require "docter/server"
+  require "docter/ultraviolet"
+
+  desc "Generate RDoc documentation"
+  rdoc = Rake::RDocTask.new(:rdoc) do |rdoc|
+    rdoc.rdoc_dir = "html/rdoc"
+    rdoc.title    = spec.name
+    rdoc.options  = spec.rdoc_options
+    rdoc.rdoc_files.include("lib/**/*.rb")
+    rdoc.rdoc_files.include spec.extra_rdoc_files
+  end
+
+  web_collection = Docter.collection.using("doc/web.toc.textile").include("doc/pages", "CHANGELOG", "LICENSE")
+  web_template = Docter.template("doc/web.haml").include("doc/css", "doc/images")
+  print_collection = Docter.collection.using("doc/print.toc.textile").include("doc/pages")
+  print_template = Docter.template("doc/print.haml").include("doc/css", "doc/images")
+
+  Docter.filter_for(:footnote) do |html|
+    html.gsub(/<p id="fn(\d+)">(.*?)<\/p>/, %{<p id="fn\\1" class="footnote">\\2</p>})
+  end
+
+  desc "Produce PDF"
+  print = Docter::Rake.generate("print", print_collection, print_template, :one_page)
+  pdf_file = file("html/buildr.pdf"=>print) do |task|
+    mkpath "html"
+    sh *%W{prince #{print}/index.html -o #{task.name}} do |ok, res|
+      fail "Failed to create PDF, see errors above" unless ok
+    end
+  end
+  task("pdf"=>pdf_file) { |task| `kpdf #{File.expand_path(pdf_file.to_s)}` }
+
+  desc "Generate HTML documentation"
+  html = Docter::Rake.generate("html", web_collection, web_template)
+  desc "Run Docter server"
+  Docter::Rake.serve :docter, web_collection, web_template, :port=>3000
+
+  desc "Generate all documentation merged into the html directory"
+  task "docs"=>[html, rdoc.name, pdf_file]
+  task("clobber") { rm_rf [html, print].map(&:to_s) }
+
+rescue LoadError=>error
+  puts error
+  puts "To create the Buildr documentation you need to:"
+  puts "  gem install docter"
+  puts "  gem install ultraviolet"
+end
+
+
+
+# Commit to SVN, upload and do the release cycle.
+namespace :svn do
+  task :clean? do |task|
+    status = `svn status`.reject { |line| line =~ /\s(pkg|html)$/ }
+    fail "Cannot release unless all local changes are in SVN:\n#{status}" unless status.empty?
+  end
+  
+  task :tag do |task|
+    cur_url = `svn info`.scan(/URL: (.*)/)[0][0]
+    new_url = cur_url.sub(/trunk$/, "tags/#{spec.version.to_s}")
+    system "svn", "remove", new_url, "-m", "Removing old copy" rescue nil
+    system "svn", "copy", cur_url, new_url, "-m", "Release #{spec.version.to_s}"
+  end
+end
+
+namespace :upload do
+  task :docs=>"rake:docs" do |task|
+    `rsync -r --del --progress html/* rubyforge.org:/var/www/gforge-projects/#{spec.rubyforge_project.downcase}`
+  end
+
+  task :packages=>["rake:docs", "rake:package"] do |task|
+    # Read the changes for this release.
+    pattern = /(^(\d+\.\d+(?:\.\d+)?)\s+\(\d+\/\d+\/\d+\)\s*((:?^[^\n]+\n)*))/
+    changelog = File.read(__FILE__.pathmap("%d/CHANGELOG"))
+    changes = changelog.scan(pattern).inject({}) { |hash, set| hash[set[1]] = set[2] ; hash }
+    current = changes[spec.version.to_s]
+    if !current && spec.version.to_s =~ /\.0$/
+      current = changes[spec.version.to_s.split(".")[0..-2].join(".")] 
+    end
+    fail "No changeset found for version #{spec.version}" unless current
+
+    puts "Uploading #{spec.name} #{spec.version}"
+    files = ["gem", "tgz", "zip"].map { |ext| "pkg/#{spec.name}-#{spec.version}.#{ext}" }
+    system "rubyforge", "login"
+    files.each do |file|
+      system "rubyforge", "add_release", spec.rubyforge_project.downcase, spec.name.downcase,
+        spec.version.to_s, file, "-a", current
+    end
+    puts "Release #{spec.version} uploaded"
+  end
+end
+
+desc "Upload release to RubyForge including docs, tag SVN"
+task :release=>[ "clobber", "svn:clean?", "test", "upload:packages", "upload:docs", "svn:tag" ]
+
+
+
+# Misc, may not survive so don't rely on these.
+task :report do |task|
+  puts "#{spec.name} #{spec.version}"
+  puts spec.summary
+  sources = (spec.files + FileList["test/**/*.rb"]).reject { |f| File.directory?(f) }
+  sources.inject({}) do |lists, file|
+    File.readlines(file).each_with_index do |line, i|
+      if line =~ /(TODO|FIXME|NOTE):\s*(.*)/
+        list = lists[$1] ||= []
+        list << sprintf("%s (%d): %s", file, i, $2)
+      end
+    end
+    lists
+  end.each_pair do |type, list|
+    unless list.empty?
+      puts
+      puts "#{type}:"
+      list.each { |line| puts line }
+    end
+  end
+end
+
+namespace :setup do
+  task :jetty do
+    cp = ["jetty-6.1.1.jar", "jetty-util-6.1.1.jar", "servlet-api-2.5-6.1.1"].
+      map { |jar| `locate #{jar}`.split.first }.join(File::PATH_SEPARATOR)
+    Dir.chdir "lib/buildr/jetty" do
+      `javac -cp #{cp} JettyWrapper.java`
+    end
+  end
+end

data/bin/buildr

@@ -0,0 +1,7 @@
+begin
+  require "buildr"
+rescue LoadError
+  require "rubygems"
+  require "buildr"
+end
+Rake.application.run

data/lib/buildr.rb

@@ -1,4 +1,5 @@
 require "highline"
+require "highline/import"
 # &:symbol goodness.
 require "facet/symbol/to_proc"
 # blank? on string and nil
@@ -17,23 +18,159 @@ require "facet/array/head"
 require "facet/string/starts_with"
 require "facet/openobject"
 require "facets/core/kernel/tap"
-require "facets/core/kernel/with"
 # A different kind of buildr, one we use to create XML.
-require "builder"
 
 
-module Kernel #:nodoc:
-  def warn_with_color(message)
-    warn_without_color HighLine.new.color(message.to_s, :red)
-  end
-  alias_method_chain :warn, :color
+module Buildr
+  VERSION = "1.2.0".freeze
 end
 
 
-module Buildr
-  VERSION = "1.1.3"
+# When running from +rake+, we already have an Application setup and must plug into it,
+# since the top-level tasks come from there. When running from +buildr+, we get to load
+# Rake and set everything up, and we use our own Application full of cool Buildr features.
+unless defined?(Rake)
+  require "rake"
+
+  class Application < Rake::Application #:nodoc:
+
+    DEFAULT_BUILDFILES = ["buildfile", "Buildfile"] + DEFAULT_RAKEFILES
+
+    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::OPTIONAL_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."],
+      ['--verbose',  '-v', GetoptLong::NO_ARGUMENT,
+        "Log message to standard output (default)."],
+      ['--version',  '-V', GetoptLong::NO_ARGUMENT,
+        "Display the program version."],
+      ['--freeze',   "-F",  GetoptLong::NO_ARGUMENT,
+       "Freezes the Buildfile so it always uses Buildr version #{Buildr::VERSION}"],
+      ['--unfreeze', "-U",  GetoptLong::NO_ARGUMENT,
+       "Unfreezes the Buildfile to use the latest version of Buildr"]
+    ]
+
+    def initialize()
+      super
+      @rakefiles = DEFAULT_BUILDFILES
+    end
+
+    def run()
+      standard_exception_handling do
+        @name = "Buildr"
+        opts = GetoptLong.new(*command_line_options)
+        opts.each { |opt, value| do_option(opt, value) }
+        collect_tasks
+        load_buildfile
+        top_level
+      end
+    end
+
+    def do_option(opt, value)
+      case opt
+      when '--help'
+        help
+        exit
+      when "--buildfile"
+        @rakefiles.clear
+        @rakefiles << value
+      when '--version'
+        puts "Buildr, version #{Buildr::VERSION}"
+        exit
+      when "--freeze" 
+        find_buildfile
+        puts "Freezing the Buildfile so it always uses Buildr version #{Buildr::VERSION}"
+        gem = 
+        original = File.read(rakefile)
+        if original =~ /gem\s*(["'])buildr\1/
+          modified = original.sub(/gem\s*(["'])buildr\1\s*,\s*(["']).*\2/, %{gem "buildr", "#{Buildr::VERSION}"})
+        else
+          modified = %{gem "buildr", "#{Buildr::VERSION}"\n} + original
+        end
+        File.open(rakefile, "w") { |file| file.write modified }
+        exit
+      when "--unfreeze"
+        find_buildfile
+        puts "Unfreezing the Buildfile to use the latest version of Buildr from your Gems repository."
+        modified = File.read(rakefile).sub(/^\s*gem\s*(["'])buildr\1.*\n/, "")
+        File.open(rakefile, "w") { |file| file.write modified }
+        exit
+      when '--require', "--nosearch", "--quiet", "--trace", "--verbose"
+        super
+      end
+    end
+
+    def find_buildfile()
+      here = Dir.pwd
+      while ! have_rakefile
+        Dir.chdir("..")
+        if Dir.pwd == here || options.nosearch
+          error = "No Buildfile found (looking for: #{@rakefiles.join(', ')})"
+          if STDIN.isatty
+            if $terminal.agree("To use Buildr you need a buildfile. Do you want me to create one? (yes/no)")
+              chdir(original_dir) { task("generate").invoke }
+            end
+            exit 1
+          else
+            raise error
+          end
+        end
+        here = Dir.pwd
+      end
+    end
+
+    def load_buildfile()
+      find_buildfile
+      puts "(in #{Dir.pwd})"
+      load File.expand_path(@rakefile) if @rakefile != ''
+      load_imports
+    end
+
+    def usage()
+      puts "Buildr #{Buildr::VERSION}"
+      puts
+      puts "Usage:"
+      puts "  buildr [-f buildfile] {options} targets..."
+    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
+
+    def command_line_options
+      OPTIONS.collect { |lst| lst[0..-2] }
+    end
+
+  end
+
+  Rake.application = Application.new
 end
 
+
+# Now it's safe to load Buildr, after we set up the Rake Application.
 $LOAD_PATH.unshift __DIR__
 ["core", "tasks", "java"].each do |dir|
   Dir[File.join(__DIR__, dir, "*.rb")].map { |file| File.basename(file) }.each { |file| require "#{dir}/#{file}" }
@@ -43,9 +180,11 @@ end
 # Methods defined in Buildr are both instance methods (e.g. when included in Project)
 # and class methods when invoked like Buildr.artifacts().
 module Buildr ; extend self ; end
-# The Rakefile object (self) has access to all the Buildr methods and constants.
+# The Buildfile object (self) has access to all the Buildr methods and constants.
 class << self ; include Buildr ; end
-class Object ; Buildr.constants.each { |c| const_set c, Buildr.const_get(c) unless const_defined?(c) } ; end
+class Object #:nodoc:
+  Buildr.constants.each { |c| const_set c, Buildr.const_get(c) unless const_defined?(c) }
+end
 # Project has visibility to everything in the Buildr namespace. (See above for constants)
 class Project ; include Buildr ; end
 
@@ -55,15 +194,15 @@ module Buildr
 end
 
 # Load the settings files.
-[ File.expand_path("buildr.rake", Gem::user_home), File.expand_path("buildr.rake") ].each { |file| load file if File.exist?(file) }
-[ File.expand_path("buildr.rb", Gem::user_home), File.expand_path("buildr.rb") ].each do |file|
+[ File.expand_path("buildr.rb", Gem::user_home), "buildr.rb" ].each { |file| load file if File.exist?(file) }
+[ File.expand_path("buildr.rake", Gem::user_home), File.expand_path("buildr.rake") ].each do |file|
   if File.exist?(file)
-    warn "Please use #{file.ext('rake')} instead of #{file}"
-    require file
+    warn "Please use '#{file.ext('rb')}' instead of '#{file}'"
+    load file
   end
 end
 
-#Load local tasks that can be used in the Rakefile.
+#Load local tasks that can be used in the Buildfile.
 Dir["#{Dir.pwd}/tasks/*.rake"].each do |file|
   unless $LOADED_FEATURES.include?(file)
     load file