Merge pull request #78 from oowekyala:better-html-reports

Better html reports #78

Author: adangel

.rubocop.yml

@@ -14,7 +14,7 @@ AllCops:
     - 'vendor/**/*'
 
 Metrics/LineLength:
-  Max: 100
+  Max: 120
 
 Metrics/MethodLength:
   Exclude:

History.md

@@ -16,13 +16,20 @@ puts summary
 # {:errors=>{:new=>0, :removed=>0}, :violations=>{:new=>0, :removed=>0, :changed=>0}, :configerrors=>{:new=>0, :removed=>0}}
 ```
 
+* As part of [#73](https://github.com/pmd/pmd-regression-tester/issues/73) and [#78](https://github.com/pmd/pmd-regression-tester/pull/78)
+  a improved HTML report is now generated with the following features:
+  * searchable table for violations with filters by rule/file/kind (added, removed, changed)
+  * summary of changes by rule
+  * code snippets for the violations
+
 ## Fixed Issues
 
 *   [#48](https://github.com/pmd/pmd-regression-tester/issues/48): Support auxclasspath / typeresolution
 *   [#67](https://github.com/pmd/pmd-regression-tester/pull/67): Report contains errors having nil filename
 *   [#68](https://github.com/pmd/pmd-regression-tester/pull/68): Don't generate a dynamic ruleset if not needed
 *   [#69](https://github.com/pmd/pmd-regression-tester/pull/69): Detect single rules with auto-gen-config
 *   [#70](https://github.com/pmd/pmd-regression-tester/pull/70): Add link to PR on github in HTML report
+*   [#73](https://github.com/pmd/pmd-regression-tester/issues/73): Better HTML presentation for diff report
 *   [#74](https://github.com/pmd/pmd-regression-tester/pull/74): Merge violations that have just changed messages
 *   [#75](https://github.com/pmd/pmd-regression-tester/pull/75): Add new option "--error-recovery"
 *   [#76](https://github.com/pmd/pmd-regression-tester/pull/76): Speedup XML parsing

Manifest.txt

@@ -19,31 +19,39 @@ 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/branch_name_row.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
 lib/pmdtester/pmd_branch_detail.rb
 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

README.rdoc

@@ -66,20 +66,23 @@ The tool creates the following folders:
   │   ├── ......
   │   └── PROJECT_NAME_n
   ├── reports
-  │   ├── BASE_BRANCH_NAME      <- the base baseline is placed here
-  │   ├── PATCH_BRANCH_NAME      <- the patch baseline is placed here
+  │   ├── BASE_BRANCH_NAME        <- the base baseline is placed here
+  │   ├── PATCH_BRANCH_NAME       <- the patch baseline is placed here
   │   └── diff
-  │       ├── index.xml <- the summary report of diff reports
-  │       ├── base_config.xml  <- the resources of the summary report
-  │       ├── patch_config.xml  <- the resources fo the summary report
-  │       ├── css  <- css reources are placed here
+  │       ├── index.html          <- the summary report of diff reports
+  │       ├── base_config.xml     <- pmd config from the base branch
+  │       ├── patch_config.xml    <- pmd config from the patch branch
+  │       ├── css  <- css resources are placed here
+  │       ├── js   <- js resources
   │       ├── PROJECT_NAME_1
-  │       │   └── index.xml   <- the diff report of PROJECT_1
+  │       │   ├── project_data.js <- contains the violations as js/json
+  │       │   └── index.html      <- the diff report of PROJECT_1
   │       ├── .......
   │       └── PROJECT_NAME_n
-  │           └── index.xml   <- the diff report of PROJECT_N
+  │           ├── project_data.js <- contains the violations as js/json
+  │           └── index.xml       <- the diff report of PROJECT_N
   ├── pmd-bin-<version>-<branch_name>-<sha1>  <- cached pmd builds that are reused
-  └── ....
+  └── pmd-bin-....
 
 ==== The baseline format
   branch_name

Rakefile

@@ -16,10 +16,12 @@ hoe = Hoe.spec 'pmdtester' do
 
   developer 'Andreas Dangel', '[email protected]'
   developer 'Binguo Bao', '[email protected]'
+  developer 'Clément Fournier', '[email protected]'
 
   self.clean_globs = %w[target/reports/**/* target/test/**/* target/dynamic-config.xml Gemfile.lock]
   self.extra_deps += [['nokogiri', '~> 1.8'], ['slop', '~> 4.6'], ['differ', '~> 0.1'],
-                      ['rufus-scheduler', '~> 3.5'], ['logger-colors', '~> 1.0']]
+                      ['rufus-scheduler', '~> 3.5'], ['logger-colors', '~> 1.0'],
+                      ['liquid', '>= 4.0']]
   self.extra_dev_deps += [
     ['hoe-bundler',   '~> 1.5'],
     ['hoe-git',       '~> 1.6'],

lib/pmdtester.rb

@@ -4,27 +4,24 @@
 require 'logger/colors'
 
 require_relative 'pmdtester/cmd'
+require_relative 'pmdtester/collection_by_file'
 require_relative 'pmdtester/pmd_branch_detail'
 require_relative 'pmdtester/pmd_configerror'
 require_relative 'pmdtester/pmd_error'
 require_relative 'pmdtester/pmd_report_detail'
+require_relative 'pmdtester/pmd_tester_utils'
 require_relative 'pmdtester/pmd_violation'
 require_relative 'pmdtester/project'
 require_relative 'pmdtester/report_diff'
 require_relative 'pmdtester/resource_locator'
 require_relative 'pmdtester/runner'
 
 require_relative 'pmdtester/builders/simple_progress_logger'
-require_relative 'pmdtester/builders/html_report_builder'
-require_relative 'pmdtester/builders/diff_builder'
-require_relative 'pmdtester/builders/diff_report/violations'
-require_relative 'pmdtester/builders/diff_report/configerrors'
-require_relative 'pmdtester/builders/diff_report/errors'
-require_relative 'pmdtester/builders/diff_report_builder'
 require_relative 'pmdtester/builders/project_builder'
+require_relative 'pmdtester/builders/project_hasher'
 require_relative 'pmdtester/builders/pmd_report_builder'
+require_relative 'pmdtester/builders/liquid_renderer'
 require_relative 'pmdtester/builders/rule_set_builder'
-require_relative 'pmdtester/builders/summary_report/branch_name_row'
 require_relative 'pmdtester/builders/summary_report_builder'
 
 require_relative 'pmdtester/parsers/options'
@@ -38,6 +35,7 @@ module PmdTester
   VERSION = '1.1.0-SNAPSHOT'
   BASE = 'base'
   PATCH = 'patch'
+  PR_NUM_ENV_VAR = 'PMD_CI_PULL_REQUEST_NUMBER' # see PmdBranchDetail
 
   def logger
     PmdTester.logger