pmdtester 1.0.0 → 1.2.0

data/lib/pmdtester/builders/diff_report/configerrors.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-# Contains methods to write out html for the configuration errors.
-# This mixin is used by DiffReportBuilder.
-module DiffReportBuilderConfigErrors
-  def build_configerrors_section(doc, configerrors_diffs)
-    doc.div(class: 'section', id: 'configerrors') do
-      doc.h2 'Configuration Errors:'
-
-      doc.h3 PmdTester::HtmlReportBuilder::NO_DIFFERENCES_MESSAGE if configerrors_diffs.empty?
-      configerrors_diffs.each do |key, value|
-        doc.div(class: 'section') do
-          doc.h3 key
-          build_configerrors_table(doc, value)
-        end
-      end
-    end
-  end
-
-  def build_configerrors_table(doc, errors)
-    doc.table(class: 'bodyTable', border: '0') do
-      build_configerrors_table_head(doc)
-      build_configerrors_table_body(doc, errors)
-    end
-  end
-
-  def build_configerrors_table_head(doc)
-    build_table_head(doc, '', 'Rule', 'Message')
-  end
-
-  def build_configerrors_table_body(doc, errors)
-    doc.tbody do
-      errors.each { |pmd_configerror| build_configerrors_table_row(doc, pmd_configerror) }
-    end
-  end
-
-  def build_configerrors_table_row(doc, pmd_configerror)
-    doc.tr(class: pmd_configerror.branch == PmdTester::BASE ? 'b' : 'a') do
-      build_table_anchor_column(doc, 'C', increment_configerror_index)
-
-      doc.td pmd_configerror.rulename
-      doc.td pmd_configerror.msg
-    end
-  end
-
-  def increment_configerror_index
-    @configerror_index ||= 0 # init with 0
-    @configerror_index += 1
-  end
-end

data/lib/pmdtester/builders/diff_report/errors.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-# Contains methods to write out html for the errors.
-# This mixin is used by DiffReportBuilder.
-module DiffReportBuilderErrors
-  def build_errors_section(doc, error_diffs)
-    doc.div(class: 'section', id: 'Errors') do
-      doc.h2 'Errors:'
-
-      doc.h3 PmdTester::HtmlReportBuilder::NO_DIFFERENCES_MESSAGE if error_diffs.empty?
-      error_diffs.each do |key, value|
-        doc.div(class: 'section') do
-          build_filename_h3(doc, key)
-          build_errors_table(doc, value)
-        end
-      end
-    end
-  end
-
-  def build_errors_table(doc, errors)
-    doc.table(class: 'bodyTable', border: '0') do
-      build_errors_table_head(doc)
-      build_errors_table_body(doc, errors)
-    end
-  end
-
-  def build_errors_table_head(doc)
-    build_table_head(doc, '', 'Message', 'Details')
-  end
-
-  def build_errors_table_body(doc, errors)
-    if PmdTester::ReportDiff.comparable?(errors)
-      # we have only two errors and those are from base and patch, so we
-      # can compare them and display a nice diff
-      pmd_error_a = errors[0]
-      pmd_error_b = errors[1]
-      diff_a = Differ.diff_by_line(pmd_error_a.text, pmd_error_b.text).format_as(:html)
-      diff_b = Differ.diff_by_line(pmd_error_b.text, pmd_error_a.text).format_as(:html)
-      doc.tbody do
-        build_errors_table_row(doc, pmd_error_a, diff_a)
-        build_errors_table_row(doc, pmd_error_b, diff_b)
-      end
-    else
-      # many errors, just report them one by one
-      doc.tbody do
-        errors.each { |pmd_error| build_errors_table_row(doc, pmd_error) }
-      end
-    end
-  end
-
-  def build_errors_table_row(doc, pmd_error, text = nil)
-    doc.tr(class: pmd_error.branch == PmdTester::BASE ? 'b' : 'a') do
-      build_table_anchor_column(doc, 'B', increment_error_index)
-
-      text = pmd_error.text if text.nil?
-
-      # The error message
-      doc.td pmd_error.msg
-      doc.td do
-        doc.pre do
-          doc << text
-        end
-      end
-    end
-  end
-
-  def increment_error_index
-    @error_index ||= 0 # init with 0
-    @error_index += 1
-  end
-end

data/lib/pmdtester/builders/diff_report/violations.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-# Contains methods to write out html for the violations.
-# This mixin is used by DiffReportBuilder.
-module DiffReportBuilderViolations
-  def build_violations_section(doc, violation_diffs)
-    doc.div(class: 'section', id: 'Violations') do
-      doc.h2 'Violations:'
-
-      doc.h3 PmdTester::HtmlReportBuilder::NO_DIFFERENCES_MESSAGE if violation_diffs.empty?
-      violation_diffs.each do |key, value|
-        doc.div(class: 'section') do
-          build_filename_h3(doc, key)
-          build_violation_table(doc, key, value)
-        end
-      end
-    end
-  end
-
-  def build_violation_table(doc, key, value)
-    doc.table(class: 'bodyTable', border: '0') do
-      build_violation_table_head(doc)
-      build_violation_table_body(doc, key, value)
-    end
-  end
-
-  def build_violation_table_head(doc)
-    build_table_head(doc, '', 'Priority', 'Rule', 'Message', 'Line')
-  end
-
-  def build_violation_table_body(doc, key, value)
-    doc.tbody do
-      value.each do |pmd_violation|
-        build_violation_table_row(doc, key, pmd_violation)
-      end
-    end
-  end
-
-  def build_violation_table_row(doc, key, pmd_violation)
-    doc.tr(class: pmd_violation.branch == PmdTester::BASE ? 'b' : 'a') do
-      build_table_anchor_column(doc, 'A', increment_violation_index)
-
-      violation = pmd_violation.attrs
-
-      # The priority of the rule
-      doc.td violation['priority']
-
-      # The rule that trigger the violation
-      doc.td do
-        doc.a(href: (violation['externalInfoUrl']).to_s) { doc.text violation['rule'] }
-      end
-
-      # The violation message
-      doc.td pmd_violation.text
-
-      # The begin line of the violation
-      line = violation['beginline']
-
-      # The link to the source file
-      doc.td do
-        link = get_link_to_source(violation, key)
-        doc.a(href: link.to_s) { doc.text line }
-      end
-    end
-  end
-
-  def get_link_to_source(violation, key)
-    l_str = @project.type == 'git' ? 'L' : 'l'
-    line_str = "##{l_str}#{violation['beginline']}"
-    @project.get_webview_url(key) + line_str
-  end
-
-  def increment_violation_index
-    @violation_index ||= 0 # init with 0
-    @violation_index += 1
-  end
-end

data/lib/pmdtester/builders/diff_report_builder.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-require 'nokogiri'
-require 'differ'
-
-module PmdTester
-  # Building diff report for a single project
-  class DiffReportBuilder < HtmlReportBuilder
-    include PmdTester
-    include DiffReportBuilderViolations
-    include DiffReportBuilderErrors
-    include DiffReportBuilderConfigErrors
-
-    def build(project)
-      @project = project
-      @report_diff = project.report_diff
-
-      index = File.new(project.diff_report_index_path, 'w')
-
-      html_report = build_html_report('pmd xml difference report')
-      copy_css(project.target_diff_report_path)
-
-      index.puts html_report
-      index.close
-
-      logger.info "Built difference report of #{project.name} successfully!"
-    end
-
-    def build_body(doc)
-      violation_diffs = @report_diff.violation_diffs
-      error_diffs = @report_diff.error_diffs
-      configerrors_diffs = @report_diff.configerrors_diffs
-      doc.body(class: 'composite') do
-        doc.div(id: 'contentBox') do
-          build_summary_section(doc)
-          build_violations_section(doc, violation_diffs)
-          build_errors_section(doc, error_diffs)
-          build_configerrors_section(doc, configerrors_diffs)
-        end
-      end
-    end
-
-    def build_summary_section(doc)
-      doc.div(class: 'section', id: 'Summary') do
-        doc.h2 'Summary:'
-        build_summary_table(doc)
-      end
-    end
-
-    def build_summary_table(doc)
-      doc.table(class: 'bodyTable', border: '0') do
-        build_table_head(doc, 'Item', 'Base', 'Patch', 'Difference')
-        build_summary_table_body(doc)
-      end
-    end
-
-    def build_summary_table_body(doc)
-      doc.tbody do
-        build_summary_row(doc, 'number of errors', @report_diff.base_errors_size,
-                          @report_diff.patch_errors_size, @report_diff.removed_errors_size,
-                          @report_diff.new_errors_size)
-        build_summary_row(doc, 'number of violations', @report_diff.base_violations_size,
-                          @report_diff.patch_violations_size, @report_diff.removed_violations_size,
-                          @report_diff.new_violations_size)
-        build_summary_row(doc, 'number of config errors', @report_diff.base_configerrors_size,
-                          @report_diff.patch_configerrors_size,
-                          @report_diff.removed_configerrors_size,
-                          @report_diff.new_configerrors_size)
-        build_summary_row(doc, 'execution time', @report_diff.base_execution_time,
-                          @report_diff.patch_execution_time, @report_diff.diff_execution_time)
-        build_summary_row(doc, 'timestamp', @report_diff.base_timestamp,
-                          @report_diff.patch_timestamp, '')
-      end
-    end
-
-    def build_summary_row(doc, item, base, patch, *diff)
-      doc.tr do
-        doc.td(class: 'c') { doc.text item }
-        doc.td(class: 'b') { doc.text base }
-        doc.td(class: 'a') { doc.text patch }
-        doc.td(class: 'c') do
-          if diff.size == 1
-            doc.text diff[0]
-          else
-            build_table_content_for(doc, diff[0], diff[1])
-          end
-        end
-      end
-    end
-
-    def build_filename_h3(doc, filename)
-      doc.h3 do
-        doc.a(href: @project.get_webview_url(filename)) do
-          doc.text @project.get_path_inside_project(filename)
-        end
-      end
-    end
-  end
-end

data/lib/pmdtester/builders/html_report_builder.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module PmdTester
-  # This class is the parent of all classes which is used to build html report
-  class HtmlReportBuilder
-    CSS_SRC_DIR = ResourceLocator.locate('resources/css')
-    NO_DIFFERENCES_MESSAGE = 'No differences found!'
-
-    def build_html_report(title_name)
-      html_builder = Nokogiri::HTML::Builder.new do |doc|
-        doc.html do
-          build_head(doc, title_name)
-          build_body(doc)
-        end
-      end
-      html_builder.to_html
-    end
-
-    def build_head(doc, title_name)
-      doc.head do
-        doc.title title_name
-
-        doc.style(type: 'text/css', media: 'all') do
-          doc.text '@import url("./css/maven-base.css");@import url("./css/maven-theme.css");'
-        end
-      end
-    end
-
-    def build_table_head(doc, *columns)
-      doc.thead do
-        doc.tr do
-          columns.each do |column|
-            doc.th column
-          end
-        end
-      end
-    end
-
-    def build_table_anchor_column(doc, prefix, index)
-      doc.td do
-        doc.a(id: "#{prefix}#{index}", href: "##{prefix}#{index}") { doc.text '#' }
-      end
-    end
-
-    def copy_css(report_dir)
-      css_dest_dir = "#{report_dir}/css"
-      FileUtils.copy_entry(CSS_SRC_DIR, css_dest_dir)
-    end
-
-    def build_table_content_for(doc, removed_size, new_size)
-      doc.font(color: 'red') { doc.text "-#{removed_size}" }
-      doc.text ' | '
-      doc.font(color: 'green') { doc.text "+#{new_size}" }
-    end
-  end
-end

data/resources/css/maven-base.css

@@ -1,155 +0,0 @@
-body {
-  margin: 0px;
-  padding: 0px;
-}
-img {
-  border:none;
-}
-table {
-  padding:0px;
-  width: 100%;
-  margin-left: -2px;
-  margin-right: -2px;
-}
-acronym {
-  cursor: help;
-  border-bottom: 1px dotted #feb;
-}
-table.bodyTable th, table.bodyTable td {
-  padding: 2px 4px 2px 4px;
-  vertical-align: top;
-}
-div.clear{
-  clear:both;
-  visibility: hidden;
-}
-div.clear hr{
-  display: none;
-}
-#bannerLeft, #bannerRight {
-  font-size: xx-large;
-  font-weight: bold;
-}
-#bannerLeft img, #bannerRight img {
-  margin: 0px;
-}
-.xleft, #bannerLeft img {
-  float:left;
-}
-.xright, #bannerRight {
-  float:right;
-}
-#banner {
-  padding: 0px;
-}
-#banner img {
-  border: none;
-}
-#breadcrumbs {
-  padding: 3px 10px 3px 10px;
-}
-#leftColumn {
- width: 170px;
- float:left;
- overflow: auto;
-}
-#bodyColumn {
-  margin-right: 1.5em;
-  margin-left: 197px;
-}
-#legend {
-  padding: 8px 0 8px 0;
-}
-#navcolumn {
-  padding: 8px 4px 0 8px;
-}
-#navcolumn h5 {
-  margin: 0;
-  padding: 0;
-  font-size: small;
-}
-#navcolumn ul {
-  margin: 0;
-  padding: 0;
-  font-size: small;
-}
-#navcolumn li {
-  list-style-type: none;
-  background-image: none;
-  background-repeat: no-repeat;
-  background-position: 0 0.4em;
-  padding-left: 16px;
-  list-style-position: outside;
-  line-height: 1.2em;
-  font-size: smaller;
-}
-#navcolumn li.expanded {
-  background-image: url(../images/expanded.gif);
-}
-#navcolumn li.collapsed {
-  background-image: url(../images/collapsed.gif);
-}
-#navcolumn li.none {
-  text-indent: -1em;
-  margin-left: 1em;
-}
-#poweredBy {
-  text-align: center;
-}
-#navcolumn img {
-  margin-top: 10px;
-  margin-bottom: 3px;
-}
-#poweredBy img {
-  display:block;
-  margin: 20px 0 20px 17px;
-}
-#search img {
-    margin: 0px;
-    display: block;
-}
-#search #q, #search #btnG {
-    border: 1px solid #999;
-    margin-bottom:10px;
-}
-#search form {
-    margin: 0px;
-}
-#lastPublished {
-  font-size: x-small;
-}
-.navSection {
-  margin-bottom: 2px;
-  padding: 8px;
-}
-.navSectionHead {
-  font-weight: bold;
-  font-size: x-small;
-}
-.section {
-  padding: 4px;
-}
-#footer {
-  padding: 3px 10px 3px 10px;
-  font-size: x-small;
-}
-#breadcrumbs {
-  font-size: x-small;
-  margin: 0pt;
-}
-.source {
-  padding: 12px;
-  margin: 1em 7px 1em 7px;
-}
-.source pre {
-  margin: 0px;
-  padding: 0px;
-}
-#navcolumn img.imageLink, .imageLink {
-  padding-left: 0px;
-  padding-bottom: 0px;
-  padding-top: 0px;
-  padding-right: 2px;
-  border: 0px;
-  margin: 0px;
-}