vic-buildr 1.3.3 → 1.3.4

data/lib/buildr/core/test.rb

@@ -191,7 +191,7 @@ module Buildr
       @forced_need = false
       parent_task = Project.parent_task(name)
       if parent_task.respond_to?(:options)
-        @options = OpenObject.new { |hash, key| parent_task.options[key].clone rescue parent_task.options[key] }
+        @options = OpenObject.new { |hash, key| hash[key] = parent_task.options[key].clone rescue hash[key] = parent_task.options[key] }
       else
         @options = OpenObject.new(default_options)
       end
@@ -629,9 +629,9 @@ module Buildr
     # Use this method to return the integration tests task, or enhance it with a block to execute.
     #
     # There is one integration tests task you can execute directly, or as a result of running the package
-    # task (or tasks that depend on it, like install and deploy). It contains all the tests marked with
+    # task (or tasks that depend on it, like install and upload). It contains all the tests marked with
     # :integration=>true, all other tests are considered unit tests and run by the test task before packaging.
-    # So essentially: build=>test=>packaging=>integration=>install/deploy.
+    # So essentially: build=>test=>packaging=>integration=>install/upload.
     #
     # You add new tests from projects that define integration tests using the regular test task,
     # but with the following addition:
@@ -658,7 +658,7 @@ module Buildr
   class Options
 
     # Runs tests after the build when true (default). This forces tests to execute
-    # after the build, including when running build related tasks like install, deploy and release.
+    # after the build, including when running build related tasks like install, upload and release.
     #
     # Set to false to not run any tests. Set to :all to run all tests, ignoring failures.
     #

data/lib/buildr/core/transports.rb

@@ -14,37 +14,20 @@
 # the License.
 
 
-require 'cgi'
+require 'uri'
 require 'net/http'
-require 'net/https'
+Net.autoload :HTTPS, 'net/https'
 # PATCH:  On Windows, Net::SSH 2.0.2 attempts to load the Pageant DLLs which break on JRuby.
-$LOADED_FEATURES.unshift 'net/ssh/authentication/pageant' if RUBY_PLATFORM =~ /java/
-require 'net/ssh'
-require 'net/sftp'
-require 'uri'
-require 'digest/md5'
-require 'digest/sha1'
-require 'stringio'
-require 'tempfile'
-require 'buildr/core/progressbar'
-
-
-# Monkeypatching: SFTP never defines the mkdir method on its session or the underlying
-# driver, it just redirect calls through method_missing. Rake, on the other hand, decides
-# to define mkdir on Object, and so routes our calls to FileUtils.
-module Net #:nodoc:all
-  class Session
-    def mkdir(path, attrs = {})
-      method_missing :mkdir, path, attrs
-    end
-  end
-
-  class SFTP::Protocol::Driver
-    def mkdir(first, path, attrs = {})
-      method_missing :mkdir, first, path, attrs
-    end
-  end
+$LOADED_FEATURES << 'net/ssh/authentication/pageant.rb' if RUBY_PLATFORM =~ /java/
+gem 'net-ssh' ; Net.autoload :SSH, 'net/ssh'
+gem 'net-sftp' ; Net.autoload :SFTP, 'net/sftp'
+autoload :CGI, 'cgi'
+module Digest
+  autoload :MD5, 'digest/md5'
+  autoload :SHA1, 'digest/sha1'
 end
+require 'stringio'
+autoload :ProgressBar, 'buildr/core/progressbar'
 
 
 # Not quite open-uri, but similar. Provides read and write methods for the resource represented by the URI.
@@ -173,7 +156,7 @@ module URI
           read({:progress=>verbose}.merge(options || {}).merge(:modified=>modified)) { |chunk| temp.write chunk }
         end
         mkpath File.dirname(target)
-        File.move temp.path, target
+        FileUtils.mv temp.path, target
       when File
         read({:progress=>verbose}.merge(options || {}).merge(:modified=>target.mtime)) { |chunk| target.write chunk }
         target.flush
@@ -566,7 +549,7 @@ module URI
       end
       real_path.tap do |path|
         mkpath File.dirname(path)
-        File.move temp.path, path
+        FileUtils.mv temp.path, path
       end
     end
 

data/lib/buildr/core/util.rb

@@ -16,7 +16,12 @@
 
 require 'rbconfig'
 require 'pathname'
-require 'builder' # A different kind of buildr, one we use to create XML.
+autoload :Tempfile, 'tempfile'
+autoload :YAML, 'yaml'
+autoload :REXML, 'rexml/document'
+gem 'xml-simple' ; autoload :XmlSimple, 'xmlsimple'
+gem 'builder' ; autoload :Builder, 'builder' # A different kind of buildr, one we use to create XML.
+require 'highline/import'
 
 
 module Buildr
@@ -31,7 +36,7 @@ module Buildr
     # In order to determine if we are running on a windows OS,
     # prefer this function instead of using Gem.win_platform?.
     #
-    # Gem.win_platform? only checks the RUBY_PLATFORM global,
+    # Gem.win_platform? only checks these RUBY_PLATFORM global,
     # that in some cases like when running on JRuby is not 
     # succifient for our purpose:
     #
@@ -286,4 +291,4 @@ class Hash
     }.join("\n")
   end
 
-end
+end

data/lib/buildr/groovy/bdd.rb

@@ -13,6 +13,7 @@
 # License for the specific language governing permissions and limitations under
 # the License.
 
+
 module Buildr::Groovy
 
   # EasyB is a Groovy based BDD framework.

data/lib/buildr/groovy/compiler.rb

@@ -19,7 +19,7 @@ module Buildr::Groovy
   # Groovyc compiler:
   #  compile.using(:groovyc)
   #
-  # You need to require 'buildr/java/groovyc' if you need to use this compiler.
+  # You need to require 'buildr/groovy/compiler' if you need to use this compiler.
   #
   # Used by default if .groovy files are found in the src/main/groovy directory (or src/test/groovy)
   # and sets the target directory to target/classes (or target/test/classes).

data/lib/buildr/ide/eclipse.rb

@@ -25,16 +25,16 @@ module Buildr
 
     first_time do
       # Global task "eclipse" generates artifacts for all projects.
-      desc "Generate Eclipse artifacts for all projects"
-      Project.local_task "eclipse"=>"artifacts"
+      desc 'Generate Eclipse artifacts for all projects'
+      Project.local_task 'eclipse'=>'artifacts'
     end
 
     before_define do |project|
-      project.recursive_task("eclipse")
+      project.recursive_task('eclipse')
     end
 
     after_define do |project|
-      eclipse = project.task("eclipse")
+      eclipse = project.task('eclipse')
 
       # Check if project has scala facet
       scala = project.compile.language == :scala
@@ -42,17 +42,18 @@ module Buildr
       # Only for projects that we support
       supported_languages = [:java, :scala]
       supported_packaging = %w(jar war rar mar aar)
-      if (supported_languages.include? project.compile.language || 
+      if (supported_languages.include?(project.compile.language) ||
+          supported_languages.include?(project.test.compile.language) ||
           project.packages.detect { |pkg| supported_packaging.include?(pkg.type.to_s) })
-        eclipse.enhance [ file(project.path_to(".classpath")), file(project.path_to(".project")) ]
+        eclipse.enhance [ file(project.path_to('.classpath')), file(project.path_to('.project')) ]
 
         # The only thing we need to look for is a change in the Buildfile.
-        file(project.path_to(".classpath")=>Buildr.application.buildfile) do |task|
+        file(project.path_to('.classpath')=>Buildr.application.buildfile) do |task|
           info "Writing #{task.name}"
 
           m2repo = Buildr::Repositories.instance.local
 
-          File.open(task.name, "w") do |file|
+          File.open(task.name, 'w') do |file|
             classpathentry = ClasspathEntryWriter.new project, file
             classpathentry.write do
               # Note: Use the test classpath since Eclipse compiles both "main" and "test" classes using the same classpath
@@ -82,7 +83,7 @@ module Buildr
               # Classpath elements from other projects
               classpathentry.src_projects project_libs
 
-              classpathentry.output project.compile.target
+              classpathentry.output project.compile.target if project.compile.target
               classpathentry.lib libs
               classpathentry.var m2_libs, 'M2_REPO', m2repo
 
@@ -93,9 +94,9 @@ module Buildr
         end
 
         # The only thing we need to look for is a change in the Buildfile.
-        file(project.path_to(".project")=>Buildr.application.buildfile) do |task|
+        file(project.path_to('.project')=>Buildr.application.buildfile) do |task|
           info "Writing #{task.name}"
-          File.open(task.name, "w") do |file|
+          File.open(task.name, 'w') do |file|
             xml = Builder::XmlMarkup.new(:target=>file, :indent=>2)
             xml.projectDescription do
               xml.name project.id
@@ -103,17 +104,17 @@ module Buildr
               xml.buildSpec do
                 if scala
                   xml.buildCommand do
-                    xml.name "ch.epfl.lamp.sdt.core.scalabuilder"
+                    xml.name 'ch.epfl.lamp.sdt.core.scalabuilder'
                   end
                 else
                   xml.buildCommand do
-                    xml.name "org.eclipse.jdt.core.javabuilder"
+                    xml.name 'org.eclipse.jdt.core.javabuilder'
                   end
                 end
               end
               xml.natures do
-                xml.nature "ch.epfl.lamp.sdt.core.scalanature" if scala
-                xml.nature "org.eclipse.jdt.core.javanature"
+                xml.nature 'ch.epfl.lamp.sdt.core.scalanature' if scala
+                xml.nature 'org.eclipse.jdt.core.javanature'
               end
             end
           end
@@ -149,7 +150,7 @@ module Buildr
       end
 
       # Write a classpathentry of kind 'src'.
-      # Accepts an array of absolute paths or a task.
+      # Accept an array of absolute paths or a task.
       def src arg
         if [:sources, :target].all? { |message| arg.respond_to?(message) }
           src_from_task arg
@@ -159,10 +160,10 @@ module Buildr
       end
 
       # Write a classpathentry of kind 'src' for dependent projects.
-      # Accepts an array of projects.
+      # Accept an array of projects.
       def src_projects project_libs
         project_libs.map(&:id).sort.uniq.each do |project_id|
-          @xml.classpathentry :kind=>'src', :combineaccessrules=>"false", :path=>"/#{project_id}"
+          @xml.classpathentry :kind=>'src', :combineaccessrules=>'false', :path=>"/#{project_id}"
         end
       end
       
@@ -170,9 +171,18 @@ module Buildr
         @xml.classpathentry :kind=>'output', :path=>relative(target)
       end
 
+      # Write a classpathentry of kind 'var' (variable) for a library in a local repo.
+      # * +libs+ is an array of library paths.
+      # * +var_name+ is a variable name as defined in Eclipse (e.g., 'M2_REPO').
+      # * +var_value+ is the value of this variable (e.g., '/home/me/.m2').
+      # E.g., <tt>var([lib1, lib2], 'M2_REPO', '/home/me/.m2/repo')</tt>
       def var libs, var_name, var_value
-        libs.map { |lib| lib.to_s.sub(var_value, var_name) }.sort.uniq.each do |path|
-          @xml.classpathentry :kind=>'var', :path=>path
+        libs.each do |lib_path|
+          lib_artifact = file(lib_path)
+          source_path = lib_artifact.sources_artifact.to_s
+          relative_lib_path = lib_path.sub(var_value, var_name)
+          relative_source_path = source_path.sub(var_value, var_name)
+          @xml.classpathentry :kind=>'var', :path=>relative_lib_path, :sourcepath=>relative_source_path
         end
       end
               

data/lib/buildr/ide/idea.rb

@@ -17,7 +17,6 @@
 require 'buildr/core/project'
 require 'buildr/packaging'
 require 'stringio'
-require 'rexml/document'
 
 
 module Buildr
@@ -130,7 +129,9 @@ module Buildr
                         xml.root :url=>"jar://#{path}!/"
                       end
                       xml.JAVADOC
-                      xml.SOURCES
+                      xml.SOURCES do
+                        xml.root :url=>"jar://#{path.sub(/\.jar$/, "-sources.jar")}!/"
+                      end
                     end
                   end
                 end

data/lib/buildr/ide/idea7x.rb

@@ -17,7 +17,7 @@
 require 'buildr/core/project'
 require 'buildr/packaging'
 require 'stringio'
-require 'rexml/document'
+
 
 module Buildr
   module Idea7x #:nodoc:
@@ -160,7 +160,9 @@ module Buildr
                 xml.root :url=> path
               end
               xml.JAVADOC
-              xml.SOURCES
+              xml.SOURCES do
+                xml.root :url=>"jar://#{path.sub(/\.jar$/, "-sources.jar")}!/"
+              end
             end
           end
         end

data/lib/buildr/java/ant.rb

@@ -14,7 +14,7 @@
 # the License.
 
 
-require 'antwrap'
+gem 'Antwrap' ; autoload :Antwrap, 'antwrap'
 require 'buildr/core/project'
 require 'buildr/core/help'
 

data/lib/buildr/java/bdd.rb

@@ -13,9 +13,11 @@
 # License for the specific language governing permissions and limitations under
 # the License.
 
+
 require 'buildr/java/tests'
 require 'buildr/java/test_result'
 
+
 module Buildr
 
   # Mixin for test frameworks using src/spec/{lang}
@@ -46,7 +48,7 @@ module Buildr
   module TestFramework::JRubyBased
     extend self
 
-    VERSION = '1.1.4'
+    VERSION = '1.1.3'
 
     class << self
       def version
@@ -269,8 +271,9 @@ module Buildr
         Buildr::TestFramework::TestResult::Error.guard('<%= runner.file %>') do
           ::Spec::Runner::CommandLine.run($rspec_options)
         end
+        exit 0 # let buildr figure the result from the yaml file
       }
-      Filter::Mapper.new(:erb, binding).result(runner_erb)
+      Filter::Mapper.new(:erb, binding).transform(runner_erb)
     end
 
   end
@@ -365,14 +368,15 @@ module Buildr
 
     def runner_config
       runner = super
-      runner.gems.update 'rspec' => '>0'
-      runner.requires.unshift 'spec', 'jtestr'
+      # JtestR 0.3.1 comes with rspec 1.1.4 (and any other jtestr dependency) included, 
+      # so the rspec version used depends on the jtestr jar.
+      runner.requires.unshift 'jtestr'
       runner
     end
 
     def runner_content(binding)
       runner_erb = File.join(File.dirname(__FILE__), 'jtestr_runner.rb.erb')
-      Filter::Mapper.new(:erb, binding).result(File.read(runner_erb), runner_erb)
+      Filter::Mapper.new(:erb, binding).transform(File.read(runner_erb), runner_erb)
     end
     
   end

data/lib/buildr/java/cobertura.rb

@@ -0,0 +1,236 @@
+# 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/java'
+
+
+module Buildr
+
+  # Provides the <code>cobertura:html</code> and <code>cobertura:xml</code> tasks.
+  # Require explicitly using <code>require "buildr/cobertura"</code>.
+  #
+  # You can generate cobertura reports for a single project 
+  # using the project name as prefix:
+  #
+  #   project_name:cobertura:html
+  #
+  # You can also specify which classes to include/exclude from instrumentation by 
+  # passing a class name regexp to the <code>cobertura.include</code> or 
+  # <code>cobertura.exclude</code> methods. 
+  # 
+  #   define 'someModule' do 
+  #      cobertura.include 'some.package.*'
+  #      cobertura.include /some.(foo|bar).*/
+  #      cobertura.exclude 'some.foo.util.SimpleUtil'
+  #      cobertura.exclude /*.Const(ants)?/i
+  #   end
+  module Cobertura
+
+    class << self
+
+      REQUIRES = ["net.sourceforge.cobertura:cobertura:jar:1.9", "log4j:log4j:jar:1.2.9",
+        "asm:asm:jar:2.2.1", "asm:asm-tree:jar:2.2.1", "oro:oro:jar:2.0.8"] unless const_defined?('REQUIRES')
+
+      def requires()
+        @requires ||= Buildr.artifacts(REQUIRES).each(&:invoke).map(&:to_s)
+      end
+
+      def report_to(file = nil)
+        File.expand_path(File.join(*["reports/cobertura", file.to_s].compact))
+      end
+
+      def data_file()
+        File.expand_path("reports/cobertura.ser")
+      end
+
+    end
+    
+    class CoberturaConfig # :nodoc:
+      
+      def initialize(project)
+        @project = project
+      end
+      
+      attr_reader :project
+      private :project
+
+      attr_writer :data_file, :instrumented_dir, :report_dir
+      
+      def data_file
+        @data_file ||= project.path_to(:reports, 'cobertura.ser')
+      end
+
+      def instrumented_dir
+        @instrumented_dir ||= project.path_to(:target, :instrumented, :classes)
+      end
+
+      def report_dir
+        @report_dir ||= project.path_to(:reports, :cobertura)
+      end
+
+      def report_to(file = nil)
+        File.expand_path(File.join(*[report_dir, file.to_s].compact))
+      end
+
+      # :call-seq:
+      #   project.cobertura.include(*classPatterns)
+      #
+      def include(*classPatterns)
+        includes.push(*classPatterns.map { |p| String === p ? Regexp.new(p) : p })
+        self
+      end
+      
+      def includes
+        @includeClasses ||= []
+      end
+
+      # :call-seq:
+      #   project.cobertura.exclude(*classPatterns)
+      #
+      def exclude(*classPatterns)
+        excludes.push(*classPatterns.map { |p| String === p ? Regexp.new(p) : p })
+        self
+      end
+
+      def excludes
+        @excludeClasses ||= []
+      end
+
+      def sources
+        project.compile.sources
+      end
+    end
+
+    module CoberturaExtension # :nodoc:
+      include Buildr::Extension
+
+      def cobertura
+        @cobertura_config ||= CoberturaConfig.new(self)
+      end
+
+      after_define do |project|
+        cobertura = project.cobertura
+        
+        namespace 'cobertura' do
+          unless project.compile.target.nil?
+            # Instrumented bytecode goes in a different directory. This task creates before running the test
+            # cases and monitors for changes in the generate bytecode.
+            instrumented = project.file(cobertura.instrumented_dir => project.compile.target) do |task|
+              mkdir_p task.to_s, :verbose => false
+              unless project.compile.sources.empty?
+                info "Instrumenting classes with cobertura data file #{cobertura.data_file}"
+                Buildr.ant "cobertura" do |ant|
+                  ant.taskdef :classpath=>Cobertura.requires.join(File::PATH_SEPARATOR), :resource=>"tasks.properties"
+                  ant.send "cobertura-instrument", :todir=>task.to_s, :datafile=>cobertura.data_file do
+                    includes, excludes = cobertura.includes, cobertura.excludes
+                    
+                    classes_dir = project.compile.target.to_s
+                    if includes.empty? && excludes.empty? 
+                      ant.fileset :dir => classes_dir do 
+                        ant.include :name => "**/*.class"
+                      end
+                    else
+                      includes = [//] if includes.empty?
+                      Dir.glob(File.join(classes_dir, "**/*.class")) do |cls|
+                        cls_name = cls.gsub(/#{classes_dir}\/?|\.class$/, '').gsub('/', '.')
+                        if includes.any? { |p| p === cls_name } && !excludes.any? { |p| p === cls_name }
+                          ant.fileset :file => cls
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+              touch task.to_s, :verbose=>false
+            end
+            
+            task 'instrument' => instrumented
+            
+            # We now have two target directories with bytecode. It would make sense to remove compile.target
+            # and add instrumented instead, but apparently Cobertura only creates some of the classes, so
+            # we need both directories and instrumented must come first.
+            project.test.dependencies.unshift cobertura.instrumented_dir
+            project.test.with Cobertura.requires
+            project.test.options[:properties]["net.sourceforge.cobertura.datafile"] = cobertura.data_file
+            
+            [:xml, :html].each do |format|
+              task format => ['instrument', 'test'] do 
+                info "Creating test coverage reports in #{cobertura.report_to(format)}"
+                Buildr.ant "cobertura" do |ant|
+                  ant.taskdef :classpath=>Cobertura.requires.join(File::PATH_SEPARATOR), :resource=>"tasks.properties"
+                  ant.send "cobertura-report", :format=>format, 
+                    :destdir=>cobertura.report_to(format), :datafile=>cobertura.data_file do
+                    cobertura.sources.flatten.each do |src|
+                      ant.fileset(:dir=>src.to_s) if File.exist?(src.to_s)
+                    end
+                  end
+                end
+              end
+            end
+          end
+          
+        end
+
+        project.clean do
+          rm_rf [cobertura.report_to, cobertura.data_file, cobertura.instrumented_dir], :verbose=>false
+        end
+        
+      end
+      
+    end
+
+    class Buildr::Project
+      include CoberturaExtension
+    end
+
+    namespace "cobertura" do
+
+      task "instrument" do
+        Buildr.projects.each do |project|
+          project.cobertura.data_file = data_file
+          project.test.options[:properties]["net.sourceforge.cobertura.datafile"] = data_file
+          instrument_task ="#{project.name}:cobertura:instrument"
+          task(instrument_task).invoke if Rake::Task.task_defined?(instrument_task)
+        end
+      end
+      
+      [:xml, :html].each do |format|
+        report_target = report_to(format)
+        desc "Run the test cases and produce code coverage reports in #{report_target}"
+        task format => ["instrument", "test"] do
+          info "Creating test coverage reports in #{report_target}"
+          Buildr.ant "cobertura" do |ant|
+            ant.taskdef :classpath=>requires.join(File::PATH_SEPARATOR), :resource=>"tasks.properties"
+            ant.send "cobertura-report", :destdir=>report_target, :format=>format, :datafile=>data_file do
+              Buildr.projects.map(&:cobertura).map(&:sources).flatten.each do |src|
+                ant.fileset :dir=>src.to_s if File.exist?(src.to_s)
+              end
+            end
+          end
+        end
+      end
+      
+      task "clean" do
+        rm_rf [report_to, data_file], :verbose=>false
+      end
+    end
+
+    task "clean" do
+      task("cobertura:clean").invoke if Dir.pwd == Rake.application.original_dir
+    end
+
+  end
+end