buildr 1.4.9 → 1.4.10

data/CHANGELOG

@@ -1,3 +1,49 @@
+1.4.10 (2013-02-10)
+* Added:  Support a single intermediate directory for each project hierarchy
+          through an addon 'buildr/single_intermediate_layout'.
+* Fixed:  BUILDR-660 possible build issue when using build.yaml and tasks/*.rake
+          (Félix Enrique Llorente Pastora)
+* Added:  Support the :dir option in the Java::Commands.java method.
+* Fixed:  Scala 2.10 support - compiler now uses additional/separate jars
+          introduced in 2.10 such as scala-reflect.jar and scala-actor.jar
+* Added:  Add an addon for NSIS.
+* Change: BUILDR-612 - Support the TestNG 6.x versions and default
+          to 6.8.
+* Added:  BUILDR-599 - Support the passing of arguments to testng
+          test runner.
+* Fixed:  Observer the per-project source version when generating
+          IDEA module files.
+* Change: Sort the components in IDEA project files in the same
+          order the idea sorts them.
+* Fixed:  Findbugs addon correctly handles String dependencies
+          (vs task dependencies)
+* Fixed:  Checkstyle addon correctly handles String dependencies
+          (vs task dependencies)
+* Added:  Created an addon 'buildr/wsgen' for generating wsdls from java
+          and java from wsdls using the underlying wsgen tool.
+* Change: Defer the expansion of generated poms by wrapping the generation
+          in a Proc.
+* Change: Rework Artifact.content(value) method to accept a Proc that
+          will be called before the artifact is written rather than
+          requiring a string.
+* Added:  Create a 'buildr/gpg' addon that signs and uploads signatures
+          when uploading artifacts. Inspired by a similar extension in
+          the Apache ODE project by Tammo van Lessen.
+* Change: Updated dependency versions;
+          - jruby-openssl (0.8.2)
+          - atoulme-Antwrap (0.7.4)
+* Change: Require 'bundler/setup' as part of buildr startup to ensure that
+          buildr always runs with up to date dependencies if a Gemfile is
+          present.
+* Added:  Add FrameworkDetectionExcludesConfiguration facet to Idea project
+          file creation by default.
+* Fixed:  In the IntelliJ extension, defer the materialization of the
+          default_components until expansion time to avoid loss of sub-
+          components added after an add_component call.
+* Fixed:  BUILDR-633 - Remove hardcoded shebang lines in all-in-one release.
+* Added:  Create a simple extension that modifies the project layout to place
+          generated files at the top level.
+
 1.4.9 (2012-11-08)
 * Fixed:  Fixed the interaction with the FileUtils classes. The last release
           introduced a non-deterministic bug that sometimes caused logging

data/addon/buildr/checkstyle.rb

@@ -34,7 +34,7 @@ module Buildr
 
       def checkstyle(configuration_file, format, output_file, source_paths, options = {})
         dependencies = (options[:dependencies] || []) + self.dependencies
-        cp = Buildr.artifacts(dependencies).each(&:invoke).map(&:to_s)
+        cp = Buildr.artifacts(dependencies).each { |a| a.invoke() if a.respond_to?(:invoke) }.map(&:to_s)
 
         args = []
         if options[:properties_file]
@@ -141,7 +141,7 @@ module Buildr
       end
 
       def extra_dependencies
-        @extra_dependencies ||= [self.project.compile.dependencies, self.project.test.compile.dependencies]
+        @extra_dependencies ||= [self.project.compile.dependencies, self.project.test.compile.dependencies].flatten
       end
 
       protected

data/addon/buildr/findbugs.rb

@@ -46,7 +46,7 @@ module Buildr
 
       def findbugs(output_file, source_paths, analyze_paths, options = { })
         dependencies = (options[:dependencies] || []) + self.dependencies
-        cp = Buildr.artifacts(dependencies).each(&:invoke).map(&:to_s).join(File::PATH_SEPARATOR)
+        cp = Buildr.artifacts(dependencies).each { |a| a.invoke() if a.respond_to?(:invoke) }.map(&:to_s).join(File::PATH_SEPARATOR)
 
         args = {
             :output => "xml:withMessages",
@@ -79,7 +79,7 @@ module Buildr
             end
             if options[:extra_dependencies]
               ant.auxClasspath do |aux|
-                Buildr.artifacts(options[:extra_dependencies]).each(&:invoke).each do |dep|
+                Buildr.artifacts(options[:extra_dependencies]).each { |a| a.invoke() if a.respond_to?(:invoke) }.each do |dep|
                   aux.pathelement :location => dep.to_s
                 end
               end

data/addon/buildr/gpg.rb

@@ -0,0 +1,77 @@
+# 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.
+
+module Buildr
+
+  # Signs the packages using gpg and uploads signatures as part of the upload process.
+  #
+  # Require explicitly using <code>require "buildr/apg"</code>. This will result in all
+  # packages being signed. The user must specify the GPG_USER environment key to identify
+  # the key to use and may specify GPG_PASS if the key needs a password to access. e.g.
+  #
+  #  $ GPG_USER=user@example.com GPG_PASSWD=secret buildr clean upload
+  #
+  module GPG
+    class << self
+
+      def sign_task(pkg)
+        raise "ENV['GPG_USER'] not specified" unless ENV['GPG_USER']
+        asc_filename = pkg.to_s + '.asc'
+        file(asc_filename => [pkg.to_s]) do
+          info "GPG signing #{pkg.to_spec}"
+
+          cmd = []
+          cmd << 'gpg'
+          cmd << '--local-user'
+          cmd << ENV['GPG_USER']
+          cmd << '--armor'
+          cmd << '--output'
+          cmd << pkg.to_s + '.asc'
+          if ENV['GPG_PASS']
+            cmd << '--passphrase'
+            cmd << ENV['GPG_PASS']
+          end
+          cmd << '--detach-sig'
+          cmd << pkg
+          trace(cmd.join(' '))
+          `#{cmd.join(' ')}`
+          raise "Unable to generate signature for #{pkg}" unless File.exist?(asc_filename)
+        end
+      end
+
+      def sign_and_upload(project, pkg)
+        project.task(:upload).enhance do
+          artifact = Buildr.artifact(pkg.to_spec_hash.merge(:type => "#{pkg.type}.asc"))
+          artifact.from(sign_task(pkg))
+          artifact.invoke
+          artifact.upload
+        end
+      end
+    end
+
+    module ProjectExtension
+      include Extension
+
+      after_define do |project|
+        project.packages.each { |pkg| Buildr::GPG.sign_and_upload(project, pkg) }
+        project.packages.map { |pkg| pkg.pom }.uniq.each { |pom| Buildr::GPG.sign_and_upload(project, pom) }
+      end
+    end
+  end
+end
+
+class Buildr::Project
+  include Buildr::GPG::ProjectExtension
+end

data/addon/buildr/package_as_nsis.rb

@@ -0,0 +1,80 @@
+# 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.
+
+module Buildr
+  module PackageAsNsis
+    include Extension
+
+    class NSISTask < Rake::FileTask
+      attr_accessor :nsi
+      attr_accessor :values
+      attr_accessor :nsis_executable
+      attr_accessor :nsis_major_version
+
+      def initialize(*args) #:nodoc:
+        self.nsis_executable = "makensis"
+        self.nsis_major_version = 3
+        self.values = {}
+        
+        super(*args)
+        
+        enhance do
+          info "Calling makensis"
+          # We make available one variable to the nsi script:
+          # Use it like this: OutFile "${OUTPUT}"
+          values = self.values.merge("OUTPUT" => to_s)
+
+          log_level_param = (self.nsis_major_version == 2 ? "/" : "-") + (verbose ? "V2" : "V0")
+          define_prefix = (self.nsis_major_version == 2) ? "/D" : "-D"
+
+          command = "#{self.nsis_executable} #{log_level_param} #{values.inject([]) { |array, (key, value)| array << "#{define_prefix}#{key}=#{value}"; array }.join(" ")} #{self.nsi}"
+          trace command
+          system(command) or fail "Error while executing makeNSIS"
+        end
+      end
+
+      # :call-seq:
+      #   with(options) => self
+      #
+      # Passes options to the task and returns self. Some tasks support additional options, for example,
+      # the WarTask supports options like :manifest, :libs and :classes.
+      #
+      # For example:
+      #   package(:jar).with(:manifest=>'MANIFEST_MF')
+      def with(options)
+        options.each do |key, value|
+          begin
+            send "#{key}=", value
+          rescue NoMethodError
+            raise ArgumentError, "#{self.class.name} does not support the option #{key}"
+          end
+        end
+        self
+      end
+    end
+
+    def package_as_nsis(file_name)
+      NSISTask.define_task(file_name)
+    end
+
+    def package_as_nsis_spec(spec)
+      spec.merge(:type=>:exe)
+    end
+  end
+end
+
+class Buildr::Project
+  include Buildr::PackageAsNsis
+end

data/addon/buildr/single_intermediate_layout.rb

@@ -0,0 +1,69 @@
+# 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.
+
+module Buildr #nodoc
+  class Project #nodoc
+    class << self
+
+      alias :original_define :define
+
+      # Monkey patch the built-in define so that there is a single root directory for
+      # all of the generated artifacts within a project hierarchy.
+      #
+      def define(name, properties = nil, &block) #:yields:project
+
+        properties = properties.nil? ? {} : properties.dup
+
+        parent_name = name.split(':')[0...-1]
+        parent = parent_name.empty? ? nil : Buildr.application.lookup(parent_name.join(':'))
+
+        # Follow the same algorithm as in project code
+        if properties[:base_dir]
+          base_dir = properties[:base_dir]
+        elsif parent
+          base_dir = File.expand_path(name.split(':').last, parent.base_dir)
+        else
+          base_dir = Dir.pwd
+        end
+
+        # The top directory is the base directory of the root project
+        top_dir = base_dir
+        while parent
+          top_dir = parent.base_dir
+          parent = parent.parent
+        end
+
+        target_dir = "#{top_dir}/target/#{name.gsub(':', '_')}"
+        reports_dir = "#{top_dir}/reports/#{name.gsub(':', '_')}"
+        target_dir = ::Buildr::Util.relative_path(target_dir, File.expand_path(base_dir))
+        reports_dir = ::Buildr::Util.relative_path(reports_dir, File.expand_path(base_dir))
+
+        properties[:layout] = Buildr::Layout::Default.new unless properties[:layout]
+        properties[:layout][:target] = target_dir
+        properties[:layout][:reports] = reports_dir
+        properties[:layout][:target, :main] = target_dir
+
+        Project.original_define(name, properties) do
+          project.instance_eval &block
+          if top_dir == base_dir && project.iml?
+            project.iml.excluded_directories << "#{base_dir}/target"
+            project.iml.excluded_directories << "#{base_dir}/reports"
+          end
+          project
+        end
+      end
+    end
+  end
+end

data/addon/buildr/top_level_generate_dir.rb

@@ -0,0 +1,37 @@
+# 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.
+
+module Buildr
+
+  # A simple extension that modifies the project layout to place generated files at the top level.
+  # Generated files are typically created below layout[:target, :generated], placing them at the top
+  # level makes it easy for IDEs to inspect source in the generated directory while ignoring the dir
+  # containing the intermediate artifacts.
+  #
+  module TopLevelGenerateDir
+    module ProjectExtension
+      include Extension
+
+      before_define do |project|
+        project.layout[:target, :generated] = "generated"
+        project.clean { rm_rf project._(:target, :generated) }
+      end
+    end
+  end
+end
+
+class Buildr::Project
+  include Buildr::TopLevelGenerateDir::ProjectExtension
+end

data/addon/buildr/wsgen.rb

@@ -0,0 +1,160 @@
+# 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.
+
+module Buildr
+  module Wsgen
+    class << self
+
+      # :call-seq:
+      #    java2wsdl(project, classnames, options) => String
+      #
+      # Uses wsgen to generate wsdl files form annotated, compiled classes. The parameters are
+      # * :project -- The project in which the classes are compiled.
+      # * :classnames -- Either an array of classnames to convert to wsdl or a map keyed on classnames and service
+      #                  specific customizations provided.
+      #
+      # Service options include:
+      # * :service_name -- The name of the service.
+      # * :namespace_url -- The namespace of the service.
+      #
+      # Method options include:
+      # * :output_dir -- The target directory.
+      # * :namespace_url -- The default namespace for the services.
+      #
+      # For example:
+      #  Buildr::Wsgen.java2wsdl(project, %w(com.example.MyService))
+      #  Buildr::Wsgen.java2wsdl(project, %w(com.example.MyService com.example.MyOtherService))
+      #  Buildr::Wsgen.java2wsdl(project, %w(com.example.MyService com.example.MyOtherService), :namespace_url => "http://example.com/services")
+      #  Buildr::Wsgen.java2wsdl(project, {"com.example.MyService" => {:service_name => 'MiaService', :namespace_url => "http://example.com/it/services"}))
+      def java2wsdl(project, classnames, options = {})
+        desc "Generate wsdl from java"
+        project.task("java2wsdl").enhance([project.compile.target])
+
+        base_wsdl_dir = File.expand_path(options[:output_dir] || project._(:target, :generated, :wsgen, :main, :wsdl))
+        project.iml.main_source_directories << base_wsdl_dir if project.iml?
+        project.file(base_wsdl_dir)
+        project.task("java2wsdl").enhance([base_wsdl_dir])
+
+        services = classnames.is_a?(Array) ? classnames.inject({}) {|result, element| result[element] = {}; result} : classnames
+
+        services.each_pair do |classname, config|
+
+          name_parts = classname.split('.')
+          service_name = config[:service_name] || name_parts.last
+          namespace_url = config[:namespace_url] || options[:namespace_url] || "http://#{name_parts[0...-1].reverse.join('.')}"
+          wsdl_file = File.expand_path("#{base_wsdl_dir}/META-INF/wsdl/#{service_name}.wsdl")
+
+          project.file(wsdl_file) do
+            mkdir_p File.dirname(wsdl_file)
+            cp = Buildr.artifacts(project.compile.dependencies + [project.compile.target]).map(&:to_s).join(File::PATH_SEPARATOR)
+
+            java_dir = project._(:target, :ignored, :wsgen, :main, :java)
+            intermediate_dir = project._(:target, :ignored, :wsgen, :main, :java)
+
+            rm_rf java_dir
+            rm_rf intermediate_dir
+            mkdir_p java_dir
+            mkdir_p intermediate_dir
+
+            args = []
+            args << "-keep"
+            args << "-inlineSchemas" if (options[:inlineSchemas] && ENV_JAVA['java.version'] >= '1.7')
+            args << "-wsdl"
+            args << "-servicename"
+            args << "{#{namespace_url}}#{service_name}"
+            args << "-portname"
+            args << "{#{namespace_url}}#{service_name}Port"
+            args << "-d "
+            args << intermediate_dir
+            args << "-r"
+            args << "#{base_wsdl_dir}/META-INF/wsdl"
+            args << "-keep"
+            args << "-s"
+            args << java_dir
+            args << "-cp"
+            args << cp
+            args << classname
+
+            command = "wsgen #{args.join(' ')}"
+            trace command
+            sh command
+            if $? != 0
+              raise "Problem building wsdl"
+            end
+
+            content = IO.read(wsdl_file).gsub('REPLACE_WITH_ACTUAL_URL', "http://example.com/#{service_name}")
+            File.open(wsdl_file, 'wb') { |f| f.write content }
+          end
+
+          project.file(base_wsdl_dir).enhance([wsdl_file])
+          project.task("java2wsdl").enhance([wsdl_file])
+        end
+
+        base_wsdl_dir
+      end
+
+      # :call-seq:
+      #    wsdl2java(project, wsdls, options) => String
+      #
+      # Uses wsgen to generate java files form wsdls. The parameters are
+      # * :project -- The project in which the classes are compiled.
+      # * :wsdls -- A hash of wsdl filenames to service configuration.
+      #
+      # Service options include:
+      # * :service_name -- The name of the service.
+      # * :package -- The package in which to generate the code.
+      #
+      # Method options include:
+      # * :output_dir -- The target directory.
+      # * :target -- The target version for generated source..
+      # * :package -- The default package in which to generate the code.
+      #
+      # For example:
+      #  Buildr::Wsgen.wsdl2java(project, {_('src/main/wsdl/MyService.wsdl') => {}})
+      #  Buildr::Wsgen.wsdl2java(project, {_('src/main/wsdl/MyService.wsdl') => {:package => 'com.example'}})
+      #  Buildr::Wsgen.wsdl2java(project, {_('src/main/wsdl/MyService.wsdl') => {:output_dir => _(:target, :wsdl, :java)}})
+      #  Buildr::Wsgen.wsdl2java(project, {_('src/main/wsdl/MyService.wsdl') => {}}, :package => 'com.example' )
+      def wsdl2java(project, wsdls, options = {})
+        desc "Generate java from wsdl"
+        project.task("wsdl2java")
+
+        ws_dir = File.expand_path(options[:output_dir] || project._(:target, :generated, "main/ws"))
+        project.file(ws_dir)
+        project.task('wsdl2java').enhance([ws_dir])
+
+        target = options[:target] || '2.1'
+
+        wsdls.each_pair do |wsdl_file, config|
+          pkg = config[:package] || options[:package]
+          service = config[:service] || File.basename(wsdl_file, '.wsdl')
+          java_file = "#{ws_dir}/#{pkg.gsub('.', '/')}/#{service}.java"
+          project.file(java_file) do
+            mkdir_p ws_dir
+            `wsimport -keep -Xnocompile -target #{target} -s #{ws_dir} -p #{pkg} -wsdllocation META-INF/wsdl/#{service}.wsdl #{wsdl_file}`
+            if $? != 0 || !File.exist?(java_file)
+              rm_rf java_file
+              raise "Problem building webservices"
+            end
+          end
+          project.file(ws_dir).enhance([java_file])
+        end
+
+        project.compile.from ws_dir
+        project.iml.main_source_directories << ws_dir if project.iml?
+        project.compile.enhance(['wsdl2java'])
+      end
+    end
+  end
+end