pmdtester 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d0d2deb3eea885db1ea9fd273fc2330f93be694a4a7f804f6ffc03811b67280
-  data.tar.gz: 1cd1d39bdfd34a113a88275c9662a180c352b425d2ab06278fdd4530ce2bf8d5
+  metadata.gz: 4d45c31e2cf8ad4eaba391c13fa0523ade4a84394bc07a908e6a49806a12ebf6
+  data.tar.gz: fdf6c23a45dc0fd6738e272e564c3c29322dea2285269c1a869608bd77494d8a
 SHA512:
-  metadata.gz: 4fea894ba2fe827517f09a54cef4f729f7a2a3340318479422a3d4f5ca064d3ef7fefc7474a174b2b0a0de8644b8985d83da3663828ee2bb1e37b4b2f33faf39
-  data.tar.gz: d3057fde3a18df5ba4fcad91ed1159de018ae2b3732eb867fc546ac4e8f819547765bdbb3acb20787e126a09edc2b929f9dab6c9e2f5bf946e1acc58677a2c1e
+  metadata.gz: 249c6a07412a2b74405e84fe1780d5cdb8fe4173d32438c7c0fab4f78b5852ec1a63654e3a1219b4889c43e931d00451a361d27924dc0978061035abd7d03322
+  data.tar.gz: 3f4f7e4bf61f827ff475d9f302f1b73cf1e43c9807ac5b6aaf364d27bbb774db066f7a7af28586aa29ea2365e2664c915944afcedc2d0a112587f1e1cf0efb8a

data/History.md

@@ -1,3 +1,12 @@
+# 1.1.2 / 2021-04-20
+
+This is a bugfix release.
+
+## Fixed Issues
+
+*   [#85](https://github.com/pmd/pmd-regression-tester/issues/85): HTML is not escaped in snippet preview
+*   [#84](https://github.com/pmd/pmd-regression-tester/issues/84): Leading spaces are missing in code snippet preview
+
 # 1.1.1 / 2021-01-15
 
 This is a bugfix release.

data/lib/pmdtester.rb

@@ -32,7 +32,7 @@ require_relative 'pmdtester/parsers/projects_parser'
 # and unexpected behaviors will not be introduced to PMD project
 # after fixing an issue and new rules can work as expected.
 module PmdTester
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
   BASE = 'base'
   PATCH = 'patch'
   PR_NUM_ENV_VAR = 'PMD_CI_PULL_REQUEST_NUMBER' # see PmdBranchDetail

data/lib/pmdtester/builders/pmd_report_builder.rb

@@ -68,6 +68,7 @@ module PmdTester
                       ' -Dmaven.javadoc.skip=true' \
                       ' -Dmaven.source.skip=true' \
                       ' -Dcheckstyle.skip=true' \
+                      ' -Dpmd.skip=true' \
                       ' -T1C'
         Cmd.execute(package_cmd)
       end

data/pmdtester.gemspec

@@ -1,17 +1,17 @@
 # DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake hoe:spec`.
 
 # -*- encoding: utf-8 -*-
-# stub: pmdtester 1.1.1 ruby lib
+# stub: pmdtester 1.1.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pmdtester".freeze
-  s.version = "1.1.1"
+  s.version = "1.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.metadata = { "bug_tracker_uri" => "https://github.com/pmd/pmd-regression-tester/issues", "homepage_uri" => "https://pmd.github.io", "source_code_uri" => "https://github.com/pmd/pmd-regression-tester" } if s.respond_to? :metadata=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andreas Dangel".freeze, "Binguo Bao".freeze, "Cl\u00E9ment Fournier".freeze]
-  s.date = "2021-01-15"
+  s.date = "2021-04-20"
   s.description = "A regression testing tool ensure that new problems and unexpected behaviors will not be introduced to PMD project after fixing an issue , and new rules can work as expected.".freeze
   s.email = ["andreas.dangel@pmd-code.org".freeze, "djydewang@gmail.com".freeze, "clement.fournier76@gmail.com".freeze]
   s.executables = ["pmdtester".freeze]

data/resources/css/pmd-tester.css

@@ -8,6 +8,7 @@ body, td, select, input, li{
 code {
   font-family: Courier, monospace;
   font-size: 13pt;
+  white-space: pre;
 }
 code.highlight {
   background-color: yellow;

data/resources/js/code-snippets.js

@@ -1,7 +1,7 @@
 /**
  * Simple module to fetch code snippets via ajax.
  * Only supports github hosted code repos.
- * 
+ *
  * Usage:
  * var el = document.createElement('p');
  * var url = 'https://github.com/checkstyle/checkstyle/tree/checkstyle-8.0/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule4822variabledistance/InputVariableDeclarationUsageDistanceCheck.java'
@@ -11,20 +11,22 @@
  */
 (function() {
     const contextLines = 3;
+    const nbsp = "\u00a0";
 
+    // returns text, not html
     function formatLineNumber(number) {
-        var prefix = "";
+        let prefix;
         if (number < 10) {
-            prefix = "&nbsp;&nbsp;&nbsp;";
+            prefix =  nbsp.repeat(3);
         } else if (number < 100) {
-            prefix = "&nbsp;&nbsp;";
+            prefix =  nbsp.repeat(2);
         } else if (number < 1000) {
-            prefix = "&nbsp;";
+            prefix = nbsp;
         }
         return prefix + number;
     }
 
-    function fetchSnippet(el, url, line, weburl) {
+    function fetchSnippet(document, container, url, line, weburl) {
         var weburl, requestUrl, oReq;
 
         requestUrl = url.replace(/github.com/, "raw.githubusercontent.com");
@@ -32,32 +34,37 @@
 
         oReq = new XMLHttpRequest();
         oReq.addEventListener("load", function() {
-            var html, lines, start, deleteCount;
+            let lines, start, deleteCount;
+
+            // we'll append stuff in the loop below
+            container.innerHTML = '<p><a href="' + weburl + '" target="_blank" rel="noopener noreferrer">' + weburl + '</a></p>';
 
-            html = '<p><a href="' + weburl + '" target="_blank" rel="noopener noreferrer">' + weburl + '</a></p>';
             lines = this.responseText.split(/\r\n|\n/);
             start = line - contextLines;
             if (start > 0) {
-                lines.splice(0, start);
+                lines.splice(0, start); // remove lines before
             }
             deleteCount = lines.length - (2 * contextLines) + 1;
-            lines.splice(2 * contextLines - 1, deleteCount);
-            
-            lines.forEach(element => {
+            lines.splice(2 * contextLines - 1, deleteCount); // delete lines after
+
+            // now we have just the lines which will be displayed
+            lines.forEach(line => {
                 start++;
-                if (start == line) {
-                    html += "<code class=\"highlight\">";
-                } else {
-                    html += "<code>";
+                let lineElt = document.createElement("code");
+                if (start === line) {
+                    lineElt.classList.add("highlight");
                 }
-                html += formatLineNumber(start) + "&nbsp;" + element + "</code><br>";
+                // createTextNode escapes special chars
+                lineElt.appendChild(document.createTextNode(formatLineNumber(start) + nbsp + line));
+                lineElt.appendChild(document.createElement("br"));
+
+                container.appendChild(lineElt); // append to the container
             });
-            el.innerHTML = html;
         });
         oReq.open("GET", requestUrl);
         oReq.send();
 
-        el.innerHTML = "<tt>fetching...</tt>";
+        container.innerHTML = "<samp>fetching...</samp>";
     }
 
     window.pmd_code_snippets = {

data/resources/js/project-report.js

@@ -23,7 +23,7 @@ $(document).ready(function () {
     function renderCodeSnippet(violation) {
         var node = document.createElement('p');
         var url = project.source_link_base + '/' + project.file_index[violation.f];
-        window.pmd_code_snippets.fetch(node, url, violation.l, makeCodeLink(violation));
+        window.pmd_code_snippets.fetch(document, node, url, violation.l, makeCodeLink(violation));
         return node;
     }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pmdtester
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Andreas Dangel
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -313,7 +313,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A regression testing tool ensure that new problems and unexpected behaviors