buildr 1.4.16 → 1.4.17

data/addon/buildr/checkstyle.rb

@@ -1,205 +1,213 @@
-# 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>checkstyle:html</code> and <code>checkstyle:xml</code> tasks.
-  # Require explicitly using <code>require "buildr/checkstyle"</code>.
-  module Checkstyle
-
-    class << self
-
-      # The specs for requirements
-      def dependencies
-        [
-          'com.puppycrawl.tools:checkstyle:jar:5.7',
-          'commons-cli:commons-cli:jar:1.2',
-          'antlr:antlr:jar:2.7.7',
-          'com.google.guava:guava-jdk5:jar:16.0',
-          'com.google.guava:guava-bootstrap-jdk5:jar:16.0',
-          'com.google.collections:google-collections:jar:1.0',
-          'commons-beanutils:commons-beanutils-core:jar:1.8.3',
-          'commons-logging:commons-logging:jar:1.1.1'
-        ]
-      end
-
-      def checkstyle(configuration_file, format, output_file, source_paths, options = {})
-        dependencies = (options[:dependencies] || []) + self.dependencies
-        cp = Buildr.artifacts(dependencies).each { |a| a.invoke() if a.respond_to?(:invoke) }.map(&:to_s)
-
-        args = []
-        if options[:properties_file]
-          args << "-p"
-          args << options[:properties_file]
-        end
-        args << "-c"
-        args << configuration_file
-        args << "-f"
-        args << format
-        args << "-o"
-        args << output_file
-        source_paths.each do |source_path|
-          args << "-r"
-          args << source_path
-        end
-
-        begin
-          Java::Commands.java 'com.puppycrawl.tools.checkstyle.Main', *(args + [{:classpath => cp, :properties => options[:properties], :java_args => options[:java_args]}])
-        rescue => e
-          raise e if options[:fail_on_error]
-        end
-      end
-    end
-
-    class Config
-      def enabled?
-        File.exist?(self.configuration_file)
-      end
-
-      def html_enabled?
-        File.exist?(self.style_file)
-      end
-
-      attr_writer :config_directory
-
-      def config_directory
-        @config_directory || project._(:source, :main, :etc, :checkstyle)
-      end
-
-      attr_writer :report_dir
-
-      def report_dir
-        @report_dir || project._(:reports, :checkstyle)
-      end
-
-      attr_writer :configuration_file
-
-      def configuration_file
-        @configuration_file || "#{self.config_directory}/checks.xml"
-      end
-
-      attr_writer :fail_on_error
-
-      def fail_on_error?
-        @fail_on_error.nil? ? false : @fail_on_error
-      end
-
-      attr_writer :format
-
-      def format
-        @format || 'xml'
-      end
-
-      attr_writer :xml_output_file
-
-      def xml_output_file
-        @xml_output_file || "#{self.report_dir}/checkstyle.xml"
-      end
-
-      attr_writer :html_output_file
-
-      def html_output_file
-        @html_output_file || "#{self.report_dir}/checkstyle.html"
-      end
-
-      attr_writer :style_file
-
-      def style_file
-        @style_file || "#{self.config_directory}/checkstyle-report.xsl"
-      end
-
-      attr_writer :suppressions_file
-
-      def suppressions_file
-        @suppressions_file || "#{self.config_directory}/suppressions.xml"
-      end
-
-      attr_writer :import_control_file
-
-      def import_control_file
-        @import_control_file || "#{self.config_directory}/import-control.xml"
-      end
-
-      def properties
-        unless @properties
-          @properties = {:basedir => self.project.base_dir}
-          @properties['checkstyle.suppressions.file'] = self.suppressions_file if File.exist?(self.suppressions_file)
-          @properties['checkstyle.import-control.file'] = self.import_control_file if File.exist?(self.import_control_file)
-        end
-        @properties
-      end
-
-      def source_paths
-        @source_paths ||= [self.project.compile.sources, self.project.test.compile.sources]
-      end
-
-      def extra_dependencies
-        @extra_dependencies ||= []
-      end
-
-      protected
-
-      def initialize(project)
-        @project = project
-      end
-
-      attr_reader :project
-
-    end
-
-    module ProjectExtension
-      include Extension
-
-      def checkstyle
-        @checkstyle ||= Buildr::Checkstyle::Config.new(project)
-      end
-
-      after_define do |project|
-        if project.checkstyle.enabled?
-          desc "Generate checkstyle xml report."
-          project.task("checkstyle:xml") do
-            puts "Checkstyle: Analyzing source code..."
-            mkdir_p File.dirname(project.checkstyle.xml_output_file)
-            Buildr::Checkstyle.checkstyle(project.checkstyle.configuration_file,
-                                          project.checkstyle.format,
-                                          project.checkstyle.xml_output_file,
-                                          project.checkstyle.source_paths.flatten.compact,
-                                          :properties => project.checkstyle.properties,
-                                          :fail_on_error => project.checkstyle.fail_on_error?,
-                                          :dependencies => project.checkstyle.extra_dependencies)
-          end
-
-          if project.checkstyle.html_enabled?
-            xml_task = project.task("checkstyle:xml")
-            desc "Generate checkstyle html report."
-            project.task("checkstyle:html" => xml_task) do
-              puts "Checkstyle: Generating report"
-              mkdir_p File.dirname(project.checkstyle.html_output_file)
-              Buildr.ant "checkstyle" do |ant|
-                ant.xslt :in => project.checkstyle.xml_output_file,
-                         :out => project.checkstyle.html_output_file,
-                         :style => project.checkstyle.style_file
-              end
-            end
-
-          end
-        end
-      end
-    end
-  end
-end
-
-class Buildr::Project
-  include Buildr::Checkstyle::ProjectExtension
-end
+# 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>checkstyle:html</code> and <code>checkstyle:xml</code> tasks.
+  # Require explicitly using <code>require "buildr/checkstyle"</code>.
+  module Checkstyle
+
+    class << self
+
+      # The specs for requirements
+      def dependencies
+        [
+          'com.puppycrawl.tools:checkstyle:jar:5.7',
+          'commons-cli:commons-cli:jar:1.2',
+          'antlr:antlr:jar:2.7.7',
+          'com.google.guava:guava-jdk5:jar:16.0',
+          'com.google.guava:guava-bootstrap-jdk5:jar:16.0',
+          'com.google.collections:google-collections:jar:1.0',
+          'commons-beanutils:commons-beanutils-core:jar:1.8.3',
+          'commons-logging:commons-logging:jar:1.1.1'
+        ]
+      end
+
+      def checkstyle(configuration_file, format, output_file, source_paths, options = {})
+        dependencies = (options[:dependencies] || []) + self.dependencies
+        cp = Buildr.artifacts(dependencies).each { |a| a.invoke() if a.respond_to?(:invoke) }.map(&:to_s)
+
+        args = []
+        if options[:properties_file]
+          args << "-p"
+          args << options[:properties_file]
+        end
+        args << "-c"
+        args << configuration_file
+        args << "-f"
+        args << format
+        args << "-o"
+        args << output_file
+        source_paths.each do |source_path|
+          args << "-r"
+          args << source_path
+        end
+
+        begin
+          Java::Commands.java 'com.puppycrawl.tools.checkstyle.Main', *(args + [{:classpath => cp, :properties => options[:properties], :java_args => options[:java_args]}])
+        rescue => e
+          raise e if options[:fail_on_error]
+        end
+      end
+    end
+
+    class Config
+      def enabled?
+        File.exist?(self.configuration_file)
+      end
+
+      def html_enabled?
+        File.exist?(self.style_file)
+      end
+
+      attr_writer :config_directory
+
+      def config_directory
+        @config_directory || project._(:source, :main, :etc, :checkstyle)
+      end
+
+      attr_writer :report_dir
+
+      def report_dir
+        @report_dir || project._(:reports, :checkstyle)
+      end
+
+      attr_writer :configuration_file
+
+      def configuration_file
+        @configuration_file || "#{self.config_directory}/checks.xml"
+      end
+
+      attr_writer :fail_on_error
+
+      def fail_on_error?
+        @fail_on_error.nil? ? false : @fail_on_error
+      end
+
+      attr_writer :format
+
+      def format
+        @format || 'xml'
+      end
+
+      attr_writer :xml_output_file
+
+      def xml_output_file
+        @xml_output_file || "#{self.report_dir}/checkstyle.xml"
+      end
+
+      attr_writer :html_output_file
+
+      def html_output_file
+        @html_output_file || "#{self.report_dir}/checkstyle.html"
+      end
+
+      attr_writer :style_file
+
+      def style_file
+        unless @style_file
+          project_xsl = "#{self.config_directory}/checkstyle-report.xsl"
+          if File.exist?(project_xsl)
+            @style_file = project_xsl
+          else
+            @style_file = "#{File.dirname(__FILE__)}/checkstyle-report.xsl"
+          end
+        end
+        @style_file
+      end
+
+      attr_writer :suppressions_file
+
+      def suppressions_file
+        @suppressions_file || "#{self.config_directory}/suppressions.xml"
+      end
+
+      attr_writer :import_control_file
+
+      def import_control_file
+        @import_control_file || "#{self.config_directory}/import-control.xml"
+      end
+
+      def properties
+        unless @properties
+          @properties = {:basedir => self.project.base_dir}
+          @properties['checkstyle.suppressions.file'] = self.suppressions_file if File.exist?(self.suppressions_file)
+          @properties['checkstyle.import-control.file'] = self.import_control_file if File.exist?(self.import_control_file)
+        end
+        @properties
+      end
+
+      def source_paths
+        @source_paths ||= [self.project.compile.sources, self.project.test.compile.sources]
+      end
+
+      def extra_dependencies
+        @extra_dependencies ||= []
+      end
+
+      protected
+
+      def initialize(project)
+        @project = project
+      end
+
+      attr_reader :project
+
+    end
+
+    module ProjectExtension
+      include Extension
+
+      def checkstyle
+        @checkstyle ||= Buildr::Checkstyle::Config.new(project)
+      end
+
+      after_define do |project|
+        if project.checkstyle.enabled?
+          desc "Generate checkstyle xml report."
+          project.task("checkstyle:xml") do
+            puts "Checkstyle: Analyzing source code..."
+            mkdir_p File.dirname(project.checkstyle.xml_output_file)
+            Buildr::Checkstyle.checkstyle(project.checkstyle.configuration_file,
+                                          project.checkstyle.format,
+                                          project.checkstyle.xml_output_file,
+                                          project.checkstyle.source_paths.flatten.compact,
+                                          :properties => project.checkstyle.properties,
+                                          :fail_on_error => project.checkstyle.fail_on_error?,
+                                          :dependencies => project.checkstyle.extra_dependencies)
+          end
+
+          if project.checkstyle.html_enabled?
+            xml_task = project.task("checkstyle:xml")
+            desc "Generate checkstyle html report."
+            project.task("checkstyle:html" => xml_task) do
+              puts "Checkstyle: Generating report"
+              mkdir_p File.dirname(project.checkstyle.html_output_file)
+              Buildr.ant "checkstyle" do |ant|
+                ant.xslt :in => project.checkstyle.xml_output_file,
+                         :out => project.checkstyle.html_output_file,
+                         :style => project.checkstyle.style_file
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end
+
+class Buildr::Project
+  include Buildr::Checkstyle::ProjectExtension
+end

data/addon/buildr/css_lint-report.xsl

@@ -0,0 +1,83 @@
+<?xml version="1.0"?>
+
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+
+  <xsl:template match="/">
+    <html>
+      <head>
+        <title>CssLint Violations</title>
+      </head>
+      <body bgcolor="#FFFFEF">
+        <p>
+          <b>Coding Style Check Results</b>
+        </p>
+        <table border="1" cellspacing="0" cellpadding="2">
+          <tr bgcolor="#CC9966">
+            <th colspan="2">
+              <b>Summary</b>
+            </th>
+          </tr>
+          <tr bgcolor="#F3F3E1">
+            <td>Files with errors</td>
+            <td>
+              <xsl:number level="any" value="count(descendant::file)"/>
+            </td>
+          </tr>
+          <tr bgcolor="#CCF3D0">
+            <td>Total errors</td>
+            <td>
+              <xsl:number level="any" value="count(descendant::issue)"/>
+            </td>
+          </tr>
+        </table>
+        <hr align="left" width="95%" size="1"/>
+        <p>The following are violations of the ScssLint Rules:</p>
+        <p/>
+        <xsl:apply-templates/>
+      </body>
+    </html>
+  </xsl:template>
+
+  <xsl:template match="file[issue]">
+    <table bgcolor="#AFFFFF" width="95%" border="1" cellspacing="0" cellpadding="2">
+      <tr>
+        <th>File:</th>
+        <td>
+          <xsl:value-of select="@name"/>
+        </td>
+      </tr>
+    </table>
+    <table bgcolor="#DFFFFF" width="95%" border="1" cellspacing="0" cellpadding="2">
+      <tr>
+        <th style="width: 4em; padding: 0; margin: 0;">Line</th>
+        <th style="width: 4em; padding: 0; margin: 0;">Column</th>
+        <th style="width: 7em; padding: 0; margin: 0;">Severity</th>
+        <th>Reason</th>
+        <th>Evidence</th>
+      </tr>
+      <xsl:apply-templates select="issue"/>
+    </table>
+    <p/>
+  </xsl:template>
+
+  <xsl:template match="issue">
+    <tr>
+      <td>
+        <xsl:value-of select="@line"/>
+      </td>
+      <td>
+        <xsl:value-of select="@char"/>
+      </td>
+      <td>
+        <xsl:value-of select="@severity"/>
+      </td>
+      <td>
+        <xsl:value-of select="@reason"/>
+      </td>
+      <td>
+        <xsl:value-of select="@evidence"/>
+      </td>
+    </tr>
+  </xsl:template>
+
+</xsl:stylesheet>