pmdtester 1.0.1 → 1.1.0

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: pmdtester
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Andreas Dangel
 - Binguo Bao
+- Clément Fournier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -67,6 +68,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: logger-colors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: hoe-bundler
   requirement: !ruby/object:Gem::Requirement
@@ -155,22 +184,22 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +220,7 @@ description: A regression testing tool ensure that new problems and unexpected b
 email:
 - andreas.dangel@pmd-code.org
 - djydewang@gmail.com
+- clement.fournier76@gmail.com
 executables:
 - pmdtester
 extensions: []
@@ -199,10 +229,14 @@ extra_rdoc_files:
 - Manifest.txt
 - README.rdoc
 files:
+- ".ci/build.sh"
+- ".ci/files/env.gpg"
+- ".github/workflows/build.yml"
+- ".gitignore"
 - ".hoerc"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
+- ".ruby-version"
 - Gemfile
 - History.md
 - LICENSE
@@ -214,18 +248,17 @@ files:
 - config/design.xml
 - config/project-list.xml
 - config/projectlist_1_0_0.xsd
+- config/projectlist_1_1_0.xsd
 - lib/pmdtester.rb
-- lib/pmdtester/builders/diff_builder.rb
-- lib/pmdtester/builders/diff_report/configerrors.rb
-- lib/pmdtester/builders/diff_report/errors.rb
-- lib/pmdtester/builders/diff_report/violations.rb
-- lib/pmdtester/builders/diff_report_builder.rb
-- lib/pmdtester/builders/html_report_builder.rb
+- lib/pmdtester/builders/liquid_renderer.rb
 - lib/pmdtester/builders/pmd_report_builder.rb
+- lib/pmdtester/builders/project_builder.rb
+- lib/pmdtester/builders/project_hasher.rb
 - lib/pmdtester/builders/rule_set_builder.rb
 - lib/pmdtester/builders/simple_progress_logger.rb
 - lib/pmdtester/builders/summary_report_builder.rb
 - lib/pmdtester/cmd.rb
+- lib/pmdtester/collection_by_file.rb
 - lib/pmdtester/parsers/options.rb
 - lib/pmdtester/parsers/pmd_report_document.rb
 - lib/pmdtester/parsers/projects_parser.rb
@@ -233,14 +266,26 @@ files:
 - lib/pmdtester/pmd_configerror.rb
 - lib/pmdtester/pmd_error.rb
 - lib/pmdtester/pmd_report_detail.rb
+- lib/pmdtester/pmd_tester_utils.rb
 - lib/pmdtester/pmd_violation.rb
 - lib/pmdtester/project.rb
 - lib/pmdtester/report_diff.rb
 - lib/pmdtester/resource_locator.rb
 - lib/pmdtester/runner.rb
 - pmdtester.gemspec
-- resources/css/maven-base.css
-- resources/css/maven-theme.css
+- resources/_includes/diff_pill_row.html
+- resources/css/bootstrap.min.css
+- resources/css/datatables.min.css
+- resources/css/pmd-tester.css
+- resources/js/bootstrap.min.js
+- resources/js/code-snippets.js
+- resources/js/datatables.min.js
+- resources/js/jquery-3.2.1.slim.min.js
+- resources/js/jquery.min.js
+- resources/js/popper.min.js
+- resources/js/project-report.js
+- resources/project_diff_report.html
+- resources/project_index.html
 homepage: https://pmd.github.io
 licenses:
 - BSD-2-Clause
@@ -258,15 +303,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A regression testing tool ensure that new problems and unexpected behaviors

data/.travis.yml

@@ -1,40 +0,0 @@
-language: ruby
-before_install:
-- LOCAL_DIR=${HOME}/.cache/openjdk
-- TARGET_DIR=${HOME}/openjdk11
-- mkdir -p ${LOCAL_DIR}
-- mkdir -p ${TARGET_DIR}
-- DOWNLOAD_URL="https://pmd-code.org/openjdk/jdk-11.0.7%2B10/OpenJDK11U-jdk_x64_linux_hotspot_11.0.7_10.tar.gz"
-- OPENJDK_ARCHIVE=$(basename $DOWNLOAD_URL)
-- if [ ! -e ${LOCAL_DIR}/${OPENJDK_ARCHIVE} ]; then wget --directory-prefix ${LOCAL_DIR} --timestamping --continue ${DOWNLOAD_URL}; fi
-- tar --extract --file ${LOCAL_DIR}/${OPENJDK_ARCHIVE} -C ${TARGET_DIR} --strip-components=1
-- export JAVA_HOME="${TARGET_DIR}"
-- export PATH="${TARGET_DIR}/bin:${PATH}"
-- java -version
-script:
-- rake check_manifest
-- rake rubocop
-- rake clean test
-- rake clean integration-test
-- rake install_gem
-- pmdtester -h
-
-before_deploy:
-- git stash --all
-- rake hoe:spec
-
-deploy:
-  provider: rubygems
-  api_key:
-    secure: "PMohVxVpupi3qKmSWjny6ASPKiWpyZxMTluARs15tiRR4Pco3Ko+Z+Nk2F6XNZkY4q4zudS91JGtYeGzuBknI/tFB9S1LjR5RDe9cUbETlhpazBCaRvVFt0K8okb9JAWfVi+mnCG5saBn0Osxv/PKS2sVr/3dK9JFVncaYfRhIZfhB/LcdHMLpnlv94sr60SGPA8ITz3pj1dKe6E2wfqQjgD8RNOOLxtcTFeEZVHDuJn0gsKz+ou2Dyzth+2SksKKboosodWXNbAIx5xg+iVLZgGFluQknZ130G0PA6vJzMLWgLEjUtFDV1QtE80jP7LhuMOKXaXHa6NghHL7h3TiBO9/2SEdHSdIq5NeMm2f8qttLNqI15cgGolyUGd+K43tAdvNuJws+wbQsj53htGFLvSKPfwTxipn1Ppa1s6/bSeUQvtj/kXO6MnVdwTBNjlm791DaG8sC4WbvppLvrKPfpvqGoOfWj9h5PlB8SsaHyDtOB6oCYE354RxLJxaI6b4hcxleyz7mPmoPcKQjcPSM8i004lCCNAmPm0VMW/yTi1Z1iBq6+1OiW7fe6txJi9zCPhMzziz1EA0oQYBgu99Uy9wjHh8CkWXtZDx+WSYRxCZOJ6kFN72dgYQbIsn4kxzrjwCp+NN0woDPR0FXcuePNgAz2hBtAvbKdOC2OCQVw="
-  on:
-    tags: true
-  skip_cleanup: true
-  gem: pmdtester
-  gemspec: pmdtester.gemspec
-
-cache:
-  directories:
-  - vendor/bundle
-  - "$HOME/.rvm/"
-  - "$HOME/.cache/openjdk"

data/lib/pmdtester/builders/diff_builder.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'nokogiri'
-
-module PmdTester
-  # Building difference between two pmd xml files
-  class DiffBuilder
-    include PmdTester
-    # The schema of pmd xml report refers to
-    # http://pmd.sourceforge.net/report_2_0_0.xsd
-    def build(base_report_filename, patch_report_filename, base_info, patch_info, filter_set = nil)
-      report_diffs = ReportDiff.new
-      base_details, patch_details = report_diffs.calculate_details(base_info, patch_info)
-      base_report = parse_pmd_report(base_report_filename, BASE, base_details.working_dir,
-                                     filter_set)
-      patch_report = parse_pmd_report(patch_report_filename, PATCH, patch_details.working_dir)
-      report_diffs.calculate_violations(base_report.violations, patch_report.violations)
-      report_diffs.calculate_errors(base_report.errors, patch_report.errors)
-      report_diffs.calculate_configerrors(base_report.configerrors, patch_report.configerrors)
-
-      report_diffs
-    end
-
-    def parse_pmd_report(report_filename, branch, working_dir, filter_set = nil)
-      doc = PmdReportDocument.new(branch, working_dir, filter_set)
-      parser = Nokogiri::XML::SAX::Parser.new(doc)
-      parser.parse_file(report_filename) unless report_filename.nil?
-      doc
-    end
-  end
-end

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 "\n" + pmd_violation.text + "\n"
-
-      # 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