lib/buildr/java/custom_pom.rb

# 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
  class CustomPom
    Developer = Struct.new(:id, :name, :email, :roles)

    # Specify the name of the project
    attr_writer :name

    # Retrieve the name of the project, defaulting to the project description or the name if not specified
    def name
      @name || @buildr_project.comment || @buildr_project.name
    end

    # Specify a project description
    attr_writer :description

    # Retrieve the project description, defaulting to the name if not specified
    def description
      @description || name
    end

    # Property for the projects url
    attr_accessor :url

    # Return the map of licenses for project
    def licenses
      @licenses ||= {}
    end

    # Add Apache2 to the list of licenses
    def add_apache_v2_license
      self.licenses['The Apache Software License, Version 2.0'] = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
    end

    def add_bsd_2_license
      self.licenses['The BSD 2-Clause License'] = 'http://opensource.org/licenses/BSD-2-Clause'
    end

    def add_bsd_3_license
      self.licenses['The BSD 3-Clause License'] = 'http://opensource.org/licenses/BSD-3-Clause'
    end

    def add_cddl_v1_license
      self.licenses['Common Development and Distribution License (CDDL-1.0)'] = 'http://opensource.org/licenses/CDDL-1.0'
    end

    def add_epl_v1_license
      self.licenses['Eclipse Public License - v 1.0'] = 'http://www.eclipse.org/legal/epl-v10.html'
    end

    def add_gpl_v1_license
      self.licenses['GNU General Public License (GPL) version 1.0'] = 'http://www.gnu.org/licenses/gpl-1.0.html'
    end

    def add_gpl_v2_license
      self.licenses['GNU General Public License (GPL) version 2.0'] = 'http://www.gnu.org/licenses/gpl-2.0.html'
    end

    def add_gpl_v3_license
      self.licenses['GNU General Public License (GPL) version 3.0'] = 'http://www.gnu.org/licenses/gpl-3.0.html'
    end

    def add_lgpl_v2_license
      self.licenses['GNU General Lesser Public License (LGPL) version 2.1'] = 'http://www.gnu.org/licenses/lgpl-2.1.html'
    end

    def add_lgpl_v3_license
      self.licenses['GNU General Lesser Public License (LGPL) version 3.0'] = 'http://www.gnu.org/licenses/lgpl-3.0.html'
    end

    def add_mit_license
      self.licenses['The MIT License'] = 'http://opensource.org/licenses/MIT'
    end

    attr_accessor :scm_url
    attr_accessor :scm_connection
    attr_accessor :scm_developer_connection

    attr_accessor :issues_url
    attr_accessor :issues_system

    # Add a project like add_github_project('realityforge/gwt-appcache')
    def add_github_project(project_spec)
      git_url = "git@github.com:#{project_spec}.git"
      self.scm_connection = self.scm_developer_connection = "scm:git:#{git_url}"
      self.scm_url = git_url
      web_url = "https://github.com/#{project_spec}"
      self.url = web_url
      self.issues_url = "#{web_url}/issues"
      self.issues_system = 'GitHub Issues'
    end

    def developers
      @developers ||= []
    end

    def add_developer(id, name = nil, email = nil, roles = nil)
      self.developers << Developer.new(id, name, email, roles)
    end

    def provided_dependencies
      @provided_dependencies ||= []
    end

    def provided_dependencies=(provided_dependencies)
      @provided_dependencies = provided_dependencies
    end

    def runtime_dependencies
      @runtime_dependencies ||= []
    end

    def runtime_dependencies=(runtime_dependencies)
      @runtime_dependencies = runtime_dependencies
    end

    def additional_dependencies
      @additional_dependencies ||= []
    end

    def additional_dependencies=(additional_dependencies)
      @additional_dependencies = additional_dependencies
    end

    def include_transitive_dependencies
      @include_transitive_dependencies ||= []
    end

    def include_transitive_dependencies=(include_transitive_dependencies)
      @include_transitive_dependencies = include_transitive_dependencies
    end

    def optional_dependencies
      @optional_dependencies ||= []
    end

    def optional_dependencies=(optional_dependencies)
      @optional_dependencies = optional_dependencies
    end

    # Property that accepts a proc that accepts a dependency and returns a boolean to
    # determine whether dependency is included in pom or not.
    attr_accessor :dependency_filter

    protected

    def associate_project(buildr_project)
      @buildr_project = buildr_project
    end

    def self.pom_xml(project, package)
      Proc.new do
        xml = Builder::XmlMarkup.new(:indent => 2)
        xml.instruct!
        xml.project('xmlns' => 'http://maven.apache.org/POM/4.0.0',
                    'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
                    'xsi:schemaLocation' => 'http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd') do
          xml.modelVersion '4.0.0'
          xml.groupId project.group
          xml.artifactId project.id
          xml.version project.version
          candidates = project.packages.select{|p| p.classifier.nil? }.collect{|p|p.type.to_s}
          packaging = !candidates.empty? ? candidates[0] : (project.compile.packaging || :zip).to_s
          xml.packaging packaging

          xml.name project.pom.name if project.pom.name
          xml.description project.pom.description if project.pom.description
          xml.url project.pom.url if project.pom.url

          xml.licenses do
            project.pom.licenses.each_pair do |name, url|
              xml.license do
                xml.name name
                xml.url url
                xml.distribution 'repo'
              end
            end
          end unless project.pom.licenses.empty?

          if project.pom.scm_url || project.pom.scm_connection || project.pom.scm_developer_connection
            xml.scm do
              xml.connection project.pom.scm_connection if project.pom.scm_connection
              xml.developerConnection project.pom.scm_developer_connection if project.pom.scm_developer_connection
              xml.url project.pom.scm_url if project.pom.scm_url
            end
          end

          if project.pom.issues_url
            xml.issueManagement do
              xml.url project.pom.issues_url
              xml.system project.pom.issues_system if project.pom.issues_system
            end
          end

          xml.developers do
            project.pom.developers.each do |developer|
              xml.developer do
                xml.id developer.id
                xml.name developer.name if developer.name
                xml.email developer.email if developer.email
                if developer.roles
                  xml.roles do
                    developer.roles.each do |role|
                      xml.role role
                    end
                  end
                end
              end
            end
          end unless project.pom.developers.empty?

          provided_deps = Buildr.artifacts(project.pom.provided_dependencies)
          runtime_deps = Buildr.artifacts(project.pom.runtime_dependencies)
          additional_deps = Buildr.artifacts(project.pom.additional_dependencies)
          include_transitive_deps = Buildr.artifacts(project.pom.include_transitive_dependencies).collect {|dep| dep.to_s}
          optional_deps = Buildr.artifacts(project.pom.optional_dependencies).collect {|dep| dep.to_s}

          done = []

          deps = []
          deps += provided_deps.
            select {|d| d.is_a?(ActsAsArtifact)}.
            select {|d| !done.include?(d.to_s)}.
            collect {|dep| done << dep.to_s; dep.to_hash.merge(:scope => 'provided', :optional => optional_deps.include?(dep.to_s), :include_transitive => include_transitive_deps.include?(dep.to_s), :artifact => dep)}
          deps += runtime_deps.
            select {|d| d.is_a?(ActsAsArtifact)}.
            select {|d| !done.include?(d.to_s)}.
            collect {|dep| done << dep.to_s; dep.to_hash.merge(:scope => 'runtime', :optional => optional_deps.include?(dep.to_s), :include_transitive => include_transitive_deps.include?(dep.to_s), :artifact => dep)}
          deps += additional_deps.
            select {|d| d.is_a?(ActsAsArtifact)}.
            select {|d| !done.include?(d.to_s)}.
            collect {|dep| done << dep.to_s; dep.to_hash.merge(:scope => 'compile', :optional => optional_deps.include?(dep.to_s), :include_transitive => include_transitive_deps.include?(dep.to_s), :artifact => dep)}

          deps +=
            Buildr.artifacts(project.compile.dependencies).
              select {|d| d.is_a?(ActsAsArtifact)}.
              select {|d| !done.include?(d.to_s)}.
              collect {|d| done << d.to_s; d.to_hash.merge(:scope => 'compile', :optional => optional_deps.include?(d.to_s), :include_transitive => include_transitive_deps.include?(d.to_s), :artifact => d)}

          deps += Buildr.artifacts(project.test.compile.dependencies).
            select {|d| d.is_a?(ActsAsArtifact)}.
            select {|d| !done.include?(d.to_s)}.
            collect {|d| d.to_hash.merge(:scope => 'test', :include_transitive => include_transitive_deps.include?(d.to_s), :artifact => d)}

          xml.dependencies do
            deps.select {|dependency| project.pom.dependency_filter.nil? ? true : project.pom.dependency_filter.call(dependency)}.each do |dependency|
              xml.dependency do
                xml.groupId dependency[:group]
                xml.artifactId dependency[:id]
                xml.version dependency[:version]
                xml.classifier dependency[:classifier] if dependency[:classifier] && dependency[:classifier].to_s != 'jar'
                xml.scope dependency[:scope] unless dependency[:scope] == 'compile'
                xml.optional true if dependency[:optional]
                unless dependency[:include_transitive]
                  xml.exclusions do
                    xml.exclusion do
                      xml.groupId '*'
                      xml.artifactId '*'
                    end
                  end
                end
              end
            end
          end unless deps.empty?
        end
      end
    end
  end
  module CPom
    module ProjectExtension
      include Extension

      def pom
        unless @pom
          @pom = parent ? parent.pom.dup : Buildr::CustomPom.new
          @pom.send :associate_project, self
        end
        @pom
      end
    end
  end
end

class Buildr::Project
  include Buildr::CPom::ProjectExtension
end