buildr 1.4.16 → 1.4.17

data/addon/buildr/css_lint.rake

@@ -0,0 +1,196 @@
+# 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
+  # Provides the <code>css_lint:html</code> and <code>css_lint:xml</code> tasks.
+  # Require explicitly using <code>require "buildr/css_lint"</code>.
+  module CssLint
+    class << self
+
+      def css_lint(output_file, source_paths, options = {})
+        args = []
+        args << 'csslint'
+        args << "--format=#{options[:format]}" if options[:format]
+        args << '--quiet'
+        [:errors, :warnings, :ignore].each do |severity|
+          if options[severity] && !options[severity].empty?
+            args << "--#{severity}=#{options[severity].join(',')}"
+          end
+        end
+        if options[:excludes] && !options[:excludes].empty?
+          args << "--exclude-list=#{options[:excludes].join(',')}"
+        end
+
+        source_paths.each do |source_path|
+          args << source_path.to_s
+        end
+
+        command = args.join(' ')
+        mkdir_p File.dirname(output_file)
+        File.open(output_file, 'wb') do |f|
+          f.write `#{command}`
+        end
+        if 0 != $?.exitstatus
+          error = IO.read(output_file)
+          rm_f output_file
+          raise "Problem running csslint: #{command}\n#{error}"
+        end
+      end
+    end
+
+    class Config
+      def enabled?
+        !self.source_paths.empty?
+      end
+
+      def html_enabled?
+        File.exist?(self.style_file)
+      end
+
+      attr_writer :config_directory
+
+      def config_directory
+        @config_directory || project._(:source, :main, :etc, :scss_lint)
+      end
+
+      attr_writer :report_dir
+
+      def report_dir
+        @report_dir || project._(:reports, :css_lint)
+      end
+
+      attr_writer :excludes
+
+      def excludes
+        @excludes ||= []
+      end
+
+      attr_writer :errors
+
+      def errors
+        @errors ||= []
+      end
+
+      attr_writer :warnings
+
+      def warnings
+        @warnings ||= []
+      end
+
+      attr_writer :ignore
+
+      def ignore
+        @ignore ||= []
+      end
+
+      attr_writer :format
+
+      def format
+        @format || 'csslint-xml'
+      end
+
+      attr_writer :xml_output_file
+
+      def xml_output_file
+        @xml_output_file || "#{self.report_dir}/css_lint.xml"
+      end
+
+      attr_writer :html_output_file
+
+      def html_output_file
+        @html_output_file || "#{self.report_dir}/css_lint.html"
+      end
+
+      attr_writer :style_file
+
+      def style_file
+        unless @style_file
+          project_xsl = "#{self.config_directory}/css_lint-report.xsl"
+          if File.exist?(project_xsl)
+            @style_file = project_xsl
+          else
+            @style_file = "#{File.dirname(__FILE__)}/css_lint-report.xsl"
+          end
+        end
+        @style_file
+      end
+
+      def source_paths
+        unless @source_paths
+          @source_paths = []
+          dir = self.project._(:source, :main, :webapp, :css)
+          @source_paths << dir if File.directory?(dir)
+        end
+        @source_paths
+      end
+
+      protected
+
+      def initialize(project)
+        @project = project
+      end
+
+      attr_reader :project
+
+    end
+
+    module ProjectExtension
+      include Extension
+
+      def css_lint
+        @css_lint ||= Buildr::CssLint::Config.new(project)
+      end
+
+      after_define do |project|
+        if project.css_lint.enabled?
+          desc 'Generate css-lint xml report.'
+          project.task('css_lint:xml') do
+            source_paths = project.css_lint.source_paths.flatten.compact
+            source_paths.each do |path|
+              path.respond_to?(:invoke) ? path.invoke : project.file(path).invoke
+            end
+
+            puts 'CssLint: Analyzing CSS...'
+            Buildr::CssLint.css_lint(project.css_lint.xml_output_file,
+                                     source_paths,
+                                     :format => project.css_lint.format,
+                                     :excludes => project.css_lint.excludes,
+                                     :ignore => project.css_lint.ignore,
+                                     :warnings => project.css_lint.warnings,
+                                     :errors => project.css_lint.errors)
+          end
+
+          if project.css_lint.html_enabled?
+            xml_task = project.task('css_lint:xml')
+            desc 'Generate css_lint html report.'
+            project.task('css_lint:html' => xml_task) do
+              puts "CssLint: Generating report"
+              mkdir_p File.dirname(project.css_lint.html_output_file)
+              Buildr.ant 'css_lint' do |ant|
+                ant.xslt :in => project.css_lint.xml_output_file,
+                         :out => project.css_lint.html_output_file,
+                         :style => project.css_lint.style_file
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+class Buildr::Project
+  include Buildr::CssLint::ProjectExtension
+end

data/addon/buildr/custom_pom.rb

@@ -0,0 +1,282 @@
+# 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 optional_dependencies
+      @optional_dependencies ||= []
+    end
+
+    def optional_dependencies=(optional_dependencies)
+      @optional_dependencies = optional_dependencies
+    end
+
+    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.parent do
+            xml.groupId 'org.sonatype.oss'
+            xml.artifactId 'oss-parent'
+            xml.version '7'
+          end
+          xml.groupId project.group
+          xml.artifactId project.id
+          xml.version project.version
+          xml.packaging package.type.to_s
+          xml.classifier package.classifier if package.classifier
+
+          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
+
+          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
+
+          xml.dependencies do
+            provided_deps = Buildr.artifacts(project.pom.provided_dependencies).collect { |d| d.to_s }
+            runtime_deps = Buildr.artifacts(project.pom.runtime_dependencies).collect { |d| d.to_s }
+            optional_deps = Buildr.artifacts(project.pom.optional_dependencies).collect { |d| d.to_s }
+            deps =
+              Buildr.artifacts(project.compile.dependencies).
+                select { |d| d.is_a?(Artifact) }.
+                collect do |d|
+                f = d.to_s
+                scope = provided_deps.include?(f) ? 'provided' :
+                  runtime_deps.include?(f) ? 'runtime' :
+                    'compile'
+                d.to_hash.merge(:scope => scope, :optional => optional_deps.include?(f))
+              end + Buildr.artifacts(project.test.compile.dependencies).
+                select { |d| d.is_a?(Artifact) && !project.compile.dependencies.include?(d) }.collect { |d| d.to_hash.merge(:scope => 'test') }
+            deps.each do |dependency|
+              xml.dependency do
+                xml.groupId dependency[:group]
+                xml.artifactId dependency[:id]
+                xml.version dependency[:version]
+                xml.scope dependency[:scope] unless dependency[:scope] == 'compile'
+                xml.optional true if dependency[:optional]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+module Buildr
+  class Project #:nodoc:
+    def pom
+      unless @pom
+        @pom = parent ? parent.pom.dup : Buildr::CustomPom.new
+        @pom.send :associate_project, self
+      end
+      @pom
+    end
+  end
+end
+
+module Buildr
+  module Package
+    alias :old_package :package
+
+    def package(*args)
+      package = old_package(*args)
+      class << package
+        def pom
+          unless @pom || classifier
+            pom_filename = Util.replace_extension(name, 'pom')
+            spec = {:group => group, :id => id, :version => version, :type => :pom}
+            @pom = Buildr.artifact(spec, pom_filename)
+            buildr_project = Buildr.project(self.scope.join(':'))
+            @pom.content Buildr::CustomPom.pom_xml(buildr_project, self)
+          end
+          @pom
+        end
+      end
+      package.instance_variable_set('@pom', nil)
+      package.enhance([package.pom.to_s]) if package.type.to_s == 'jar' && !package.classifier
+      package
+    end
+  end
+
+  module ActsAsArtifact
+    def pom_xml
+      self.pom.content
+    end
+  end
+end