pmdtester 1.2.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db98cbb787ccaa595c939ddee83316347edbf0daf746ca38daea53d3dab3fb77
-  data.tar.gz: 158cc9f948c7e680725dc2596e4d65dabac35f9f06188c8c4670d060f9889dff
+  metadata.gz: 0002a7305089264a200552384fff3179d706c2a89b39ef28cec2f2c184e84331
+  data.tar.gz: b59758aa8ece040b8d90c3577fcdc05000615e5efb32504b6e96599686d0ee6a
 SHA512:
-  metadata.gz: 28ea491ac20cddb4b51f0c418c479ce7394d5839d05dfacd04cb5c128590b7d8100b232a60d4cfafc0110249ccbe001b1e9426632679df4dcf2f6dcdc9415121
-  data.tar.gz: 2f12577c68058fb20bbc10e64de84ce574d45e6d7c0c766907b4e4342054bc95f992a654b620ced49130379db66aa5b21425114d327a9332021f04b6544e094a
+  metadata.gz: d18602b80cad2306aba780a338c90831aeaff5b17ebce880384a2e1b94405c7e45ae40e9842f878fe3ee514e8651b1bb856bfea35bab130f0f67606690ac53a7
+  data.tar.gz: 36c0c70dada772cfe44d595eeefd2cf131925db7a884dbd092bc4490cbf2ea948df23449c2dcdc78f39b75c4863b4c41b84d73a0346874c78c8aa5dee03a5ad4

data/.ci/build.sh

@@ -9,8 +9,8 @@ source "$(dirname "$0")/inc/fetch_ci_scripts.bash" && fetch_ci_scripts
 
 function build() {
     pmd_ci_log_group_start "Install OpenJDK 8+11"
-        pmd_ci_openjdk_install_adoptopenjdk 11
-        pmd_ci_openjdk_install_adoptopenjdk 8
+        pmd_ci_openjdk_install_adoptium 11
+        pmd_ci_openjdk_install_adoptium 8
         pmd_ci_openjdk_setdefault 11
     pmd_ci_log_group_end
 

data/.ci/manual-integration-tests.sh

@@ -9,8 +9,8 @@ source "$(dirname "$0")/inc/fetch_ci_scripts.bash" && fetch_ci_scripts
 
 function build() {
     pmd_ci_log_group_start "Install OpenJDK 8+11"
-        pmd_ci_openjdk_install_adoptopenjdk 11
-        pmd_ci_openjdk_install_adoptopenjdk 8
+        pmd_ci_openjdk_install_adoptium 11
+        pmd_ci_openjdk_install_adoptium 8
         pmd_ci_openjdk_setdefault 11
     pmd_ci_log_group_end
 

data/.github/workflows/build.yml

@@ -27,9 +27,9 @@ jobs:
           ~/.cache
           vendor/bundle
           target/repositories
-        key: ${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
+        key: v1-${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
         restore-keys: |
-          ${{ runner.os }}-
+          v1-${{ runner.os }}-
     - name: Set up Ruby 2.7
       uses: ruby/setup-ruby@v1
       with:
@@ -39,7 +39,7 @@ jobs:
       run: |
         echo "LANG=en_US.UTF-8" >> $GITHUB_ENV
         echo "MAVEN_OPTS=-Dmaven.wagon.httpconnectionManager.ttlSeconds=180 -Dmaven.wagon.http.retryHandler.count=3" >> $GITHUB_ENV
-        echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/14/scripts" >> $GITHUB_ENV
+        echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/17/scripts" >> $GITHUB_ENV
     - name: Check Environment
       shell: bash
       run: |
@@ -53,3 +53,4 @@ jobs:
       shell: bash
       env:
         PMD_CI_SECRET_PASSPHRASE: ${{ secrets.PMD_CI_SECRET_PASSPHRASE }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/manual-integration-tests.yml

@@ -1,6 +1,10 @@
 name: manual-integration-tests
 
-on: workflow_dispatch
+on:
+  schedule:
+    # build it monthly: At 08:30 on day-of-month 1.
+    - cron:  '30 8 1 * *'
+  workflow_dispatch:
 
 jobs:
   build:
@@ -15,9 +19,9 @@ jobs:
           ~/.cache
           vendor/bundle
           target/repositories
-        key: ${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
+        key: v1-${{ runner.os }}-${{ hashFiles('pmdtester.gemspec') }}
         restore-keys: |
-          ${{ runner.os }}-
+          v1-${{ runner.os }}-
     - name: Set up Ruby 2.7
       uses: ruby/setup-ruby@v1
       with:
@@ -27,7 +31,7 @@ jobs:
       run: |
         echo "LANG=en_US.UTF-8" >> $GITHUB_ENV
         echo "MAVEN_OPTS=-Dmaven.wagon.httpconnectionManager.ttlSeconds=180 -Dmaven.wagon.http.retryHandler.count=3" >> $GITHUB_ENV
-        echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/14/scripts" >> $GITHUB_ENV
+        echo "PMD_CI_SCRIPTS_URL=https://raw.githubusercontent.com/pmd/build-tools/17/scripts" >> $GITHUB_ENV
     - name: Check Environment
       shell: bash
       run: |
@@ -41,3 +45,4 @@ jobs:
       shell: bash
       env:
         PMD_CI_SECRET_PASSPHRASE: ${{ secrets.PMD_CI_SECRET_PASSPHRASE }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/History.md

@@ -1,3 +1,28 @@
+# 1.4.1 / 2022-04-12
+
+## Fixed Issues
+
+* [#104](https://github.com/pmd/pmd-regression-tester/issues/104): Baseline filtering is not working anymore
+
+# 1.4.0 / 2022-03-24
+
+## Enhancements
+
+*   [#103](https://github.com/pmd/pmd-regression-tester/pull/103): Support other languages besides java
+
+# 1.3.0 / 2021-12-17
+
+## Enhancements
+
+*   [#94](https://github.com/pmd/pmd-regression-tester/issues/94): Improve code snippet preview
+*   [#95](https://github.com/pmd/pmd-regression-tester/issues/95): Add length menu for datatable to allow configurable page size
+
+## Fixed Issues
+
+*   [#86](https://github.com/pmd/pmd-regression-tester/issues/86): Uncaught TypeError: violation is undefined
+*   [#93](https://github.com/pmd/pmd-regression-tester/issues/93): Line numbers > 1000 are not displayed correctly
+*   [#96](https://github.com/pmd/pmd-regression-tester/issues/96): Fix failing integration tests
+
 # 1.2.0 / 2021-06-20
 
 ## New and Noteworthy

data/Manifest.txt

@@ -44,6 +44,7 @@ lib/pmdtester/project.rb
 lib/pmdtester/report_diff.rb
 lib/pmdtester/resource_locator.rb
 lib/pmdtester/runner.rb
+lib/pmdtester/semver.rb
 pmdtester.gemspec
 resources/_includes/diff_pill_row.html
 resources/css/bootstrap.min.css

data/README.rdoc

@@ -105,23 +105,22 @@ The tool creates the following folders:
 
 === Runtime dependency
 
-  nokogiri >= 1.11.0.rc4
+  nokogiri ~> 1.13
   slop ~> 4.6
   differ ~> 0.1
-  rufus-scheduler ~> 3.5
+  rufus-scheduler ~> 3.8
   logger-colors ~> 1.0
-  liquid >= 4.0
+  liquid ~> 5.2
 
 === Development dependency
 
-  hoe ~> 3.22
   hoe-bundler ~> 1.5
   hoe-git ~> 1.6
   minitest ~> 5.10
   mocha ~> 1.5
-  rdoc < 7, >= 4.0
-  rubocop ~> 0.81
-  test-unit ~> 3.2
+  rubocop ~> 0.93
+  test-unit ~> 3.5
+  rdoc ~> 6.4
 
 == INSTALL:
 

data/Rakefile

@@ -19,18 +19,23 @@ hoe = Hoe.spec 'pmdtester' do
   developer 'Clément Fournier', 'clement.fournier76@gmail.com'
 
   self.clean_globs = %w[target/reports/**/* target/test/**/* target/dynamic-config.xml Gemfile.lock]
-  self.extra_deps += [['nokogiri', '>= 1.11.0.rc4'], ['slop', '~> 4.6'], ['differ', '~> 0.1'],
-                      ['rufus-scheduler', '~> 3.5'], ['logger-colors', '~> 1.0'],
-                      ['liquid', '>= 4.0']]
+  self.extra_deps += [
+    ['nokogiri',        '~> 1.13'],
+    ['slop',            '~> 4.6'],
+    ['differ',          '~> 0.1'],
+    ['rufus-scheduler', '~> 3.8'],
+    ['logger-colors',   '~> 1.0'],
+    ['liquid',          '~> 5.2']
+  ]
   self.extra_dev_deps += [
     ['hoe-bundler',   '~> 1.5'],
     ['hoe-git',       '~> 1.6'],
     ['minitest',      '~> 5.10'],
     ['mocha',         '~> 1.5'],
     # use the same version of rubocop as codacy
-    ['rubocop',       '~> 0.81'],
-    ['test-unit',     '~> 3.2'],
-    ['rdoc',          ['>= 4.0', '< 7']]
+    ['rubocop',       '~> 0.93'],
+    ['test-unit',     '~> 3.5'],
+    ['rdoc',          '~> 6.4']
   ]
   spec_extras[:required_ruby_version] = '>= 2.7'
 

data/lib/pmdtester/builders/pmd_report_builder.rb

@@ -97,11 +97,12 @@ module PmdTester
     def generate_pmd_report(project)
       error_recovery_options = @error_recovery ? 'PMD_JAVA_OPTS="-Dpmd.error_recovery -ea" ' : ''
       run_path = "#{saved_distro_path(@pmd_branch_details.branch_last_sha)}/bin/run.sh"
+      fail_on_violation = should_use_long_cli_options ? '--fail-on-violation false' : '-failOnViolation false'
       pmd_cmd = "#{error_recovery_options}" \
                 "#{run_path} pmd -d #{project.local_source_path} -f xml " \
                 "-R #{project.get_config_path(@pmd_branch_name)} " \
                 "-r #{project.get_pmd_report_path(@pmd_branch_name)} " \
-                "-failOnViolation false -t #{@threads} " \
+                "#{fail_on_violation} -t #{@threads} " \
                 "#{project.auxclasspath}"
       start_time = Time.now
       if File.exist?(project.get_pmd_report_path(@pmd_branch_name))
@@ -194,5 +195,10 @@ module PmdTester
     def wd_has_dirty_git_changes
       !Cmd.execute('git status --porcelain').empty?
     end
+
+    def should_use_long_cli_options
+      logger.debug "PMD Version: #{@pmd_version}"
+      Semver.compare(@pmd_version, '6.41.0') >= 0
+    end
   end
 end

data/lib/pmdtester/builders/rule_set_builder.rb

@@ -9,73 +9,70 @@ module PmdTester
   # Attention: we only consider java rulesets now.
   class RuleSetBuilder
     include PmdTester
-    ALL_CATEGORIES = Set['bestpractices.xml', 'codestyle.xml', 'design.xml', 'documentation.xml',
-                         'errorprone.xml', 'multithreading.xml', 'performance.xml',
-                         'security.xml'].freeze
-    PATH_TO_PMD_JAVA_BASED_RULES =
-      'pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule'
-    PATH_TO_PMD_XPATH_BASED_RULES = 'pmd-java/src/main/resources/category/java'
-    PATH_TO_ALL_JAVA_RULES =
-      ResourceLocator.locate('config/all-java.xml')
     PATH_TO_DYNAMIC_CONFIG = 'target/dynamic-config.xml'
-    NO_JAVA_RULES_CHANGED_MESSAGE = 'No java rules have been changed!'
+    NO_RULES_CHANGED_MESSAGE = 'No regression tested rules have been changed!'
 
     def initialize(options)
       @options = options
     end
 
-    def build
-      filenames = diff_filenames
-      rule_refs = get_rule_refs(filenames)
-      output_filter_set(rule_refs)
-      build_config_file(rule_refs)
-      logger.debug "Dynamic configuration: #{[rule_refs]}"
-      rule_refs
+    #
+    # Creates a dynamic ruleset based on the changed sources.
+    # Returns true, when rules are affected by the changed sources.
+    # Returns false, when no rules are affected and regression tester can be skipped.
+    #
+    def build?
+      languages = determine_languages
+      filenames = diff_filenames(languages)
+      run_required, rule_refs = get_rule_refs(filenames)
+      if run_required
+        output_filter_set(rule_refs)
+        build_config_file(rule_refs)
+        logger.debug "Dynamic configuration: #{[rule_refs]}"
+      else
+        logger.info NO_RULES_CHANGED_MESSAGE
+      end
+      run_required
     end
 
     def calculate_filter_set
-      output_filter_set(ALL_CATEGORIES)
+      output_filter_set([])
     end
 
     def output_filter_set(rule_refs)
-      if rule_refs == ALL_CATEGORIES
-        if @options.mode == Options::ONLINE
+      if rule_refs.empty?
+        if @options.mode == Options::ONLINE && @options.filter_with_patch_config
           @options.filter_set = Set[]
           doc = File.open(@options.patch_config) { |f| Nokogiri::XML(f) }
           rules = doc.css('ruleset rule')
           rules.each do |r|
             ref = r.attributes['ref'].content
-            ref.delete_prefix!('category/java/')
+            ref.delete_prefix!('category/')
             @options.filter_set.add(ref)
           end
 
-          logger.debug "Using filter based on patch config #{@options.patch_config}: " \
+          logger.info "Using filter based on patch config #{@options.patch_config}: " \
                        "#{@options.filter_set}"
         else
-          # if `rule_refs` contains all categories, then no need to filter the baseline
-          logger.debug 'No filter when comparing patch to baseline'
+          # if `rule_refs` is empty, then no filter can be used when comparing to the baseline
+          logger.info 'No filter when comparing patch to baseline'
           @options.filter_set = nil
         end
       else
-        logger.debug "Filter is now #{rule_refs}"
+        logger.info "Filter is now #{rule_refs}"
         @options.filter_set = rule_refs
       end
     end
 
-    def diff_filenames
-      filenames = nil
-      Dir.chdir(@options.local_git_repo) do
-        base = @options.base_branch
-        patch = @options.patch_branch
-        # We only need to support git here, since PMD's repo is using git.
-        diff_cmd = "git diff --name-only #{base}..#{patch} -- pmd-core/src/main pmd-java/src/main"
-        filenames = Cmd.execute(diff_cmd)
-      end
-      filenames.split("\n")
-    end
-
+    #
+    # Determines the rules or category rulesets, that are potentially affected by the change.
+    # Returns an empty set, if all rules are affected and there is no
+    # filtering possible or if no rules are affected.
+    # Whether to run the regression test is returned as an additional boolean flag.
+    #
     def get_rule_refs(filenames)
-      categories, rules = determine_categories_rules(filenames)
+      run_required, categories, rules = determine_categories_rules(filenames)
+      logger.debug "Regression test required: #{run_required}"
       logger.debug "Categories: #{categories}"
       logger.debug "Rules: #{rules}"
 
@@ -87,48 +84,11 @@ module PmdTester
       refs = Set[]
       refs.merge(categories)
       refs.merge(rules)
-      refs
-    end
-
-    def determine_categories_rules(filenames)
-      categories = Set[]
-      rules = Set[]
-      filenames.each do |filename|
-        match_data = check_single_filename(filename)
-
-        unless match_data.nil?
-          if match_data.size == 2
-            categories.add("#{match_data[1]}.xml")
-          else
-            rules.add("#{match_data[1]}.xml/#{match_data[2]}")
-          end
-        end
-
-        next unless match_data.nil?
-
-        logger.debug "Change doesn't match specific rule/category - enable all rules"
-        categories = ALL_CATEGORIES
-        rules.clear
-        break
-      end
-      [categories, rules]
-    end
-
-    def check_single_filename(filename)
-      logger.debug "Checking #{filename}"
-      match_data = %r{#{PATH_TO_PMD_JAVA_BASED_RULES}/([^/]+)/([^/]+)Rule.java}.match(filename)
-      match_data = %r{#{PATH_TO_PMD_XPATH_BASED_RULES}/([^/]+).xml}.match(filename) if match_data.nil?
-      logger.debug "Matches: #{match_data.inspect}"
-      match_data
+      [run_required, refs]
     end
 
     def build_config_file(rule_refs)
       if rule_refs.empty?
-        logger.info NO_JAVA_RULES_CHANGED_MESSAGE
-        return
-      end
-
-      if rule_refs == ALL_CATEGORIES
         logger.debug 'All rules are used. Not generating a dynamic ruleset.'
         logger.debug "Using the configured/default ruleset base_config=#{@options.base_config} "\
                      "patch_config=#{@options.patch_config}"
@@ -147,7 +107,7 @@ module PmdTester
                     'name' => 'Dynamic PmdTester Ruleset') do
           xml.description 'The ruleset generated by PmdTester dynamically'
           rule_refs.each do |entry|
-            xml.rule('ref' => "category/java/#{entry}")
+            xml.rule('ref' => "category/#{entry}")
           end
         end
       end
@@ -158,5 +118,82 @@ module PmdTester
       @options.base_config = PATH_TO_DYNAMIC_CONFIG
       @options.patch_config = PATH_TO_DYNAMIC_CONFIG
     end
+
+    private
+
+    def determine_categories_rules(filenames)
+      regression_test_required = false
+      categories = Set[]
+      rules = Set[]
+      filenames.each do |filename|
+        matched = check_single_filename(filename, categories, rules)
+        regression_test_required = true if matched
+
+        next if matched
+
+        logger.info "Change in file #{filename} doesn't match specific rule/category - enable all rules"
+        regression_test_required = true
+        categories.clear
+        rules.clear
+        break
+      end
+      [regression_test_required, categories, rules]
+    end
+
+    def check_single_filename(filename, categories, rules)
+      logger.debug "Checking #{filename}"
+
+      # matches Java-based rule implementations
+      match_data = %r{.+/src/main/java/.+/lang/([^/]+)/rule/([^/]+)/([^/]+)Rule.java}.match(filename)
+      unless match_data.nil?
+        logger.debug "Matches: #{match_data.inspect}"
+        rules.add("#{match_data[1]}/#{match_data[2]}.xml/#{match_data[3]}")
+        return true
+      end
+
+      # matches xpath rules
+      match_data = %r{.+/src/main/resources/category/([^/]+)/([^/]+).xml}.match(filename)
+      unless match_data.nil?
+        logger.debug "Matches: #{match_data.inspect}"
+        categories.add("#{match_data[1]}/#{match_data[2]}.xml")
+        return true
+      end
+
+      false
+    end
+
+    def diff_filenames(languages)
+      filenames = nil
+      Dir.chdir(@options.local_git_repo) do
+        base = @options.base_branch
+        patch = @options.patch_branch
+
+        filepath_filter = ''
+        unless languages.empty?
+          filepath_filter = '-- pmd-core/src/main'
+          languages.each { |l| filepath_filter = "#{filepath_filter} pmd-#{l}/src/main" }
+        end
+
+        # We only need to support git here, since PMD's repo is using git.
+        diff_cmd = "git diff --name-only #{base}..#{patch} #{filepath_filter}"
+        filenames = Cmd.execute(diff_cmd)
+      end
+      filenames.split("\n")
+    end
+
+    #
+    # Determines all languages, that are part of the regression test.
+    # This is based on the configured rules/rulesets.
+    #
+    def determine_languages
+      languages = Set[]
+      doc = File.open(@options.patch_config) { |f| Nokogiri::XML(f) }
+      rules = doc.css('ruleset rule')
+      rules.each do |r|
+        ref = r.attributes['ref'].content
+        languages.add(ref.split('/')[1])
+      end
+      languages
+    end
   end
 end

data/lib/pmdtester/parsers/pmd_report_document.rb

@@ -89,11 +89,10 @@ module PmdTester
     def match_filter_set?(violation)
       return true if @filter_set.nil?
 
-      ruleset_attr = violation.ruleset_name.delete(' ').downcase! << '.xml'
-      return true if @filter_set.include?(ruleset_attr)
-
-      rule_ref = "#{ruleset_attr}/#{violation.rule_name}"
+      ruleset_filter = violation.language << '/' << violation.ruleset_name.delete(' ').downcase! << '.xml'
+      return true if @filter_set.include?(ruleset_filter)
 
+      rule_ref = "#{ruleset_filter}/#{violation.rule_name}"
       @filter_set.include?(rule_ref)
     end
 

data/lib/pmdtester/pmd_violation.rb

@@ -27,7 +27,7 @@ module PmdTester
     #   </xs:simpleContent>
     # </xs:complexType>
 
-    attr_reader :fname, :info_url, :line, :old_line, :old_message, :rule_name, :ruleset_name
+    attr_reader :fname, :info_url, :line, :old_line, :old_message, :rule_name, :ruleset_name, :language
     attr_accessor :message
 
     # rubocop:disable Metrics/ParameterLists
@@ -43,6 +43,8 @@ module PmdTester
 
       @ruleset_name = ruleset_name
 
+      @language = determine_language_from_info_url
+
       @changed = false
       @old_message = nil
       @old_line = nil
@@ -102,5 +104,13 @@ module PmdTester
         'changed' => changed?
       }
     end
+
+    private
+
+    def determine_language_from_info_url
+      # @info_url is e.g. http://pmd.sourceforge.net/snapshot/pmd_rules_java_codestyle.html#fielddeclarationsshouldbeatstartofclass
+      m = @info_url.match(/pmd_rules_(\w+)_/)
+      m[1]
+    end
   end
 end

data/lib/pmdtester/runner.rb

@@ -33,8 +33,11 @@ module PmdTester
     def run_local_mode
       logger.info "Mode: #{@options.mode}"
       get_projects(@options.project_list) unless @options.nil?
-      rule_sets = RuleSetBuilder.new(@options).build if @options.auto_config_flag
-      return if rule_sets&.empty?
+      if @options.auto_config_flag
+        run_required = RuleSetBuilder.new(@options).build?
+        logger.debug "Run required: #{run_required}"
+        return unless run_required
+      end
 
       base_branch_details = create_pmd_report(config: @options.base_config, branch: @options.base_branch)
       patch_branch_details = create_pmd_report(config: @options.patch_config, branch: @options.patch_branch)
@@ -51,7 +54,8 @@ module PmdTester
       get_projects(project_list)
 
       if @options.auto_config_flag
-        return if RuleSetBuilder.new(@options).build.empty?
+        logger.info 'Autogenerating a dynamic ruleset based on source changes'
+        return unless RuleSetBuilder.new(@options).build?
       elsif @options.patch_config == Options::DEFAULT_CONFIG_PATH
         # patch branch build pmd reports with same configuration as base branch
         # if not specified otherwise. This allows to use a different config (e.g. less rules)

data/lib/pmdtester/semver.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PmdTester
+  # Utility to deal with semantic versions
+  class Semver
+    def self.compare(version_a, version_b)
+      PmdTester.logger.debug "Comparing #{version_a} <=> #{version_b}"
+      m = /(\d+)\.(\d+)\.(\d+)(.*)/.match(version_a)
+      a_major = m[1].to_i
+      a_minor = m[2].to_i
+      a_patch = m[3].to_i
+      a_snapshot = m[4]
+      PmdTester.logger.debug "  a_major: #{a_major} a_minor: #{a_minor} a_patch: #{a_patch} a_snapshot: #{a_snapshot}"
+
+      m = /(\d+)\.(\d+)\.(\d+)(.*)/.match(version_b)
+      b_major = m[1].to_i
+      b_minor = m[2].to_i
+      b_patch = m[3].to_i
+      b_snapshot = m[4]
+      PmdTester.logger.debug "  b_major: #{b_major} b_minor: #{b_minor} b_patch: #{b_patch} b_snapshot: #{b_snapshot}"
+
+      return a_major <=> b_major if a_major != b_major
+      return a_minor <=> b_minor if a_minor != b_minor
+      return a_patch <=> b_patch if a_patch != b_patch
+
+      compare_snapshots(a_snapshot, b_snapshot)
+    end
+
+    private_class_method def self.compare_snapshots(a_snapshot, b_snapshot)
+      return -1 if a_snapshot == '-SNAPSHOT' && b_snapshot == ''
+      return 1 if a_snapshot == '' && b_snapshot == '-SNAPSHOT'
+
+      a_snapshot <=> b_snapshot
+    end
+  end
+end

data/lib/pmdtester.rb

@@ -15,6 +15,7 @@ require_relative 'pmdtester/project'
 require_relative 'pmdtester/report_diff'
 require_relative 'pmdtester/resource_locator'
 require_relative 'pmdtester/runner'
+require_relative 'pmdtester/semver'
 
 require_relative 'pmdtester/builders/simple_progress_logger'
 require_relative 'pmdtester/builders/project_builder'
@@ -32,7 +33,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.2.0'
+  VERSION = '1.4.1'
   BASE = 'base'
   PATCH = 'patch'
   PR_NUM_ENV_VAR = 'PMD_CI_PULL_REQUEST_NUMBER' # see PmdBranchDetail

data/pmdtester.gemspec

@@ -1,22 +1,22 @@
 # DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake hoe:spec`.
 
 # -*- encoding: utf-8 -*-
-# stub: pmdtester 1.2.0 ruby lib
+# stub: pmdtester 1.4.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pmdtester".freeze
-  s.version = "1.2.0"
+  s.version = "1.4.1"
 
   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-06-20"
+  s.date = "2022-04-12"
   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]
   s.extra_rdoc_files = ["History.md".freeze, "Manifest.txt".freeze, "README.rdoc".freeze]
-  s.files = [".ci/build.sh".freeze, ".ci/inc/fetch_ci_scripts.bash".freeze, ".ci/manual-integration-tests.sh".freeze, ".github/workflows/build.yml".freeze, ".github/workflows/manual-integration-tests.yml".freeze, ".gitignore".freeze, ".hoerc".freeze, ".rubocop.yml".freeze, ".rubocop_todo.yml".freeze, ".ruby-version".freeze, "Gemfile".freeze, "History.md".freeze, "LICENSE".freeze, "Manifest.txt".freeze, "README.rdoc".freeze, "Rakefile".freeze, "bin/pmdtester".freeze, "config/all-java.xml".freeze, "config/design.xml".freeze, "config/project-list.xml".freeze, "config/projectlist_1_0_0.xsd".freeze, "config/projectlist_1_1_0.xsd".freeze, "config/projectlist_1_2_0.xsd".freeze, "lib/pmdtester.rb".freeze, "lib/pmdtester/builders/liquid_renderer.rb".freeze, "lib/pmdtester/builders/pmd_report_builder.rb".freeze, "lib/pmdtester/builders/project_builder.rb".freeze, "lib/pmdtester/builders/project_hasher.rb".freeze, "lib/pmdtester/builders/rule_set_builder.rb".freeze, "lib/pmdtester/builders/simple_progress_logger.rb".freeze, "lib/pmdtester/builders/summary_report_builder.rb".freeze, "lib/pmdtester/cmd.rb".freeze, "lib/pmdtester/collection_by_file.rb".freeze, "lib/pmdtester/parsers/options.rb".freeze, "lib/pmdtester/parsers/pmd_report_document.rb".freeze, "lib/pmdtester/parsers/projects_parser.rb".freeze, "lib/pmdtester/pmd_branch_detail.rb".freeze, "lib/pmdtester/pmd_configerror.rb".freeze, "lib/pmdtester/pmd_error.rb".freeze, "lib/pmdtester/pmd_report_detail.rb".freeze, "lib/pmdtester/pmd_tester_utils.rb".freeze, "lib/pmdtester/pmd_violation.rb".freeze, "lib/pmdtester/project.rb".freeze, "lib/pmdtester/report_diff.rb".freeze, "lib/pmdtester/resource_locator.rb".freeze, "lib/pmdtester/runner.rb".freeze, "pmdtester.gemspec".freeze, "resources/_includes/diff_pill_row.html".freeze, "resources/css/bootstrap.min.css".freeze, "resources/css/datatables.min.css".freeze, "resources/css/pmd-tester.css".freeze, "resources/js/bootstrap.min.js".freeze, "resources/js/code-snippets.js".freeze, "resources/js/datatables.min.js".freeze, "resources/js/jquery-3.2.1.slim.min.js".freeze, "resources/js/jquery.min.js".freeze, "resources/js/popper.min.js".freeze, "resources/js/project-report.js".freeze, "resources/project_diff_report.html".freeze, "resources/project_index.html".freeze, "resources/project_pmd_report.html".freeze]
+  s.files = [".ci/build.sh".freeze, ".ci/inc/fetch_ci_scripts.bash".freeze, ".ci/manual-integration-tests.sh".freeze, ".github/workflows/build.yml".freeze, ".github/workflows/manual-integration-tests.yml".freeze, ".gitignore".freeze, ".hoerc".freeze, ".rubocop.yml".freeze, ".rubocop_todo.yml".freeze, ".ruby-version".freeze, "Gemfile".freeze, "History.md".freeze, "LICENSE".freeze, "Manifest.txt".freeze, "README.rdoc".freeze, "Rakefile".freeze, "bin/pmdtester".freeze, "config/all-java.xml".freeze, "config/design.xml".freeze, "config/project-list.xml".freeze, "config/projectlist_1_0_0.xsd".freeze, "config/projectlist_1_1_0.xsd".freeze, "config/projectlist_1_2_0.xsd".freeze, "lib/pmdtester.rb".freeze, "lib/pmdtester/builders/liquid_renderer.rb".freeze, "lib/pmdtester/builders/pmd_report_builder.rb".freeze, "lib/pmdtester/builders/project_builder.rb".freeze, "lib/pmdtester/builders/project_hasher.rb".freeze, "lib/pmdtester/builders/rule_set_builder.rb".freeze, "lib/pmdtester/builders/simple_progress_logger.rb".freeze, "lib/pmdtester/builders/summary_report_builder.rb".freeze, "lib/pmdtester/cmd.rb".freeze, "lib/pmdtester/collection_by_file.rb".freeze, "lib/pmdtester/parsers/options.rb".freeze, "lib/pmdtester/parsers/pmd_report_document.rb".freeze, "lib/pmdtester/parsers/projects_parser.rb".freeze, "lib/pmdtester/pmd_branch_detail.rb".freeze, "lib/pmdtester/pmd_configerror.rb".freeze, "lib/pmdtester/pmd_error.rb".freeze, "lib/pmdtester/pmd_report_detail.rb".freeze, "lib/pmdtester/pmd_tester_utils.rb".freeze, "lib/pmdtester/pmd_violation.rb".freeze, "lib/pmdtester/project.rb".freeze, "lib/pmdtester/report_diff.rb".freeze, "lib/pmdtester/resource_locator.rb".freeze, "lib/pmdtester/runner.rb".freeze, "lib/pmdtester/semver.rb".freeze, "pmdtester.gemspec".freeze, "resources/_includes/diff_pill_row.html".freeze, "resources/css/bootstrap.min.css".freeze, "resources/css/datatables.min.css".freeze, "resources/css/pmd-tester.css".freeze, "resources/js/bootstrap.min.js".freeze, "resources/js/code-snippets.js".freeze, "resources/js/datatables.min.js".freeze, "resources/js/jquery-3.2.1.slim.min.js".freeze, "resources/js/jquery.min.js".freeze, "resources/js/popper.min.js".freeze, "resources/js/project-report.js".freeze, "resources/project_diff_report.html".freeze, "resources/project_index.html".freeze, "resources/project_pmd_report.html".freeze]
   s.homepage = "https://pmd.github.io".freeze
   s.licenses = ["BSD-2-Clause".freeze]
   s.rdoc_options = ["--main".freeze, "README.rdoc".freeze]
@@ -29,35 +29,35 @@ Gem::Specification.new do |s|
   end
 
   if s.respond_to? :add_runtime_dependency then
-    s.add_runtime_dependency(%q<nokogiri>.freeze, [">= 1.11.0.rc4"])
+    s.add_runtime_dependency(%q<nokogiri>.freeze, ["~> 1.13"])
     s.add_runtime_dependency(%q<slop>.freeze, ["~> 4.6"])
     s.add_runtime_dependency(%q<differ>.freeze, ["~> 0.1"])
-    s.add_runtime_dependency(%q<rufus-scheduler>.freeze, ["~> 3.5"])
+    s.add_runtime_dependency(%q<rufus-scheduler>.freeze, ["~> 3.8"])
     s.add_runtime_dependency(%q<logger-colors>.freeze, ["~> 1.0"])
-    s.add_runtime_dependency(%q<liquid>.freeze, [">= 4.0"])
+    s.add_runtime_dependency(%q<liquid>.freeze, ["~> 5.2"])
     s.add_development_dependency(%q<hoe-bundler>.freeze, ["~> 1.5"])
     s.add_development_dependency(%q<hoe-git>.freeze, ["~> 1.6"])
     s.add_development_dependency(%q<minitest>.freeze, ["~> 5.10"])
     s.add_development_dependency(%q<mocha>.freeze, ["~> 1.5"])
-    s.add_development_dependency(%q<rubocop>.freeze, ["~> 0.81"])
-    s.add_development_dependency(%q<test-unit>.freeze, ["~> 3.2"])
-    s.add_development_dependency(%q<rdoc>.freeze, [">= 4.0", "< 7"])
-    s.add_development_dependency(%q<hoe>.freeze, ["~> 3.22"])
+    s.add_development_dependency(%q<rubocop>.freeze, ["~> 0.93"])
+    s.add_development_dependency(%q<test-unit>.freeze, ["~> 3.5"])
+    s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.4"])
+    s.add_development_dependency(%q<hoe>.freeze, ["~> 3.23"])
   else
-    s.add_dependency(%q<nokogiri>.freeze, [">= 1.11.0.rc4"])
+    s.add_dependency(%q<nokogiri>.freeze, ["~> 1.13"])
     s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
     s.add_dependency(%q<differ>.freeze, ["~> 0.1"])
-    s.add_dependency(%q<rufus-scheduler>.freeze, ["~> 3.5"])
+    s.add_dependency(%q<rufus-scheduler>.freeze, ["~> 3.8"])
     s.add_dependency(%q<logger-colors>.freeze, ["~> 1.0"])
-    s.add_dependency(%q<liquid>.freeze, [">= 4.0"])
+    s.add_dependency(%q<liquid>.freeze, ["~> 5.2"])
     s.add_dependency(%q<hoe-bundler>.freeze, ["~> 1.5"])
     s.add_dependency(%q<hoe-git>.freeze, ["~> 1.6"])
     s.add_dependency(%q<minitest>.freeze, ["~> 5.10"])
     s.add_dependency(%q<mocha>.freeze, ["~> 1.5"])
-    s.add_dependency(%q<rubocop>.freeze, ["~> 0.81"])
-    s.add_dependency(%q<test-unit>.freeze, ["~> 3.2"])
-    s.add_dependency(%q<rdoc>.freeze, [">= 4.0", "< 7"])
-    s.add_dependency(%q<hoe>.freeze, ["~> 3.22"])
+    s.add_dependency(%q<rubocop>.freeze, ["~> 0.93"])
+    s.add_dependency(%q<test-unit>.freeze, ["~> 3.5"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 6.4"])
+    s.add_dependency(%q<hoe>.freeze, ["~> 3.23"])
   end
 end
 

data/resources/css/pmd-tester.css

@@ -10,9 +10,25 @@ code {
   font-size: 13pt;
   white-space: pre;
 }
-code.highlight {
+code.highlight, tr.highlight {
   background-color: yellow;
 }
+table.code-snippet > tbody > tr > td {
+  padding: 0px;
+  border: none;
+}
+table.code-snippet > tbody > tr > td.line-number > code:before {
+  content: attr(data-line-number);
+}
+.btn-clipboard {
+  margin-top: 1rem;
+  display: block;
+  padding: .25rem .5rem;
+  color: #0d6efd;
+  background-color: #fff;
+  border: 1px solid;
+  border-radius: .25rem;
+}
 a {
   text-decoration: none;
 }

data/resources/js/code-snippets.js

@@ -15,18 +15,18 @@
 
     // returns text, not html
     function formatLineNumber(number) {
-        let prefix;
+        let prefix = '';
         if (number < 10) {
-            prefix =  nbsp.repeat(3);
+            prefix = nbsp.repeat(3);
         } else if (number < 100) {
-            prefix =  nbsp.repeat(2);
+            prefix = nbsp.repeat(2);
         } else if (number < 1000) {
             prefix = nbsp;
         }
         return prefix + number;
     }
 
-    function fetchSnippet(document, container, url, line, weburl) {
+    function fetchSnippet(document, container, url, violationLineNumber, weburl) {
         var weburl, requestUrl, oReq;
 
         requestUrl = url.replace(/github.com/, "raw.githubusercontent.com");
@@ -34,37 +34,70 @@
 
         oReq = new XMLHttpRequest();
         oReq.addEventListener("load", function() {
-            let lines, start, deleteCount;
+            let lines, start, deleteCount, lineSeparator;
 
             // we'll append stuff in the loop below
             container.innerHTML = '<p><a href="' + weburl + '" target="_blank" rel="noopener noreferrer">' + weburl + '</a></p>';
 
-            lines = this.responseText.split(/\r\n|\n/);
-            start = line - contextLines;
+            if (this.responseText.indexOf('\r\n') >= 0) {
+                lineSeparator = '\r\n';
+            } else {
+                lineSeparator = '\n';
+            }
+            lines = this.responseText.split(lineSeparator);
+            start = violationLineNumber - contextLines;
             if (start > 0) {
                 lines.splice(0, start); // remove lines before
             }
             deleteCount = lines.length - (2 * contextLines) + 1;
             lines.splice(2 * contextLines - 1, deleteCount); // delete lines after
 
+            let table = document.createElement('table');
+            table.classList.add('code-snippet');
+            let tableBody = document.createElement('tbody');
+            table.appendChild(tableBody);
             // now we have just the lines which will be displayed
             lines.forEach(line => {
                 start++;
-                let lineElt = document.createElement("code");
-                if (start === line) {
-                    lineElt.classList.add("highlight");
+                let tableRow = document.createElement('tr');
+                if (start === violationLineNumber) {
+                    tableRow.classList.add("highlight");
                 }
+
+                let lineNumberColumn = document.createElement('td');
+                lineNumberColumn.classList.add('line-number');
+                tableRow.appendChild(lineNumberColumn);
+                let lineNumberElement = document.createElement('code');
+                lineNumberColumn.appendChild(lineNumberElement);
+                lineNumberElement.setAttribute('data-line-number', formatLineNumber(start));
+
+                let codeColumn = document.createElement('td');
+                tableRow.appendChild(codeColumn);
+                let codeElement = document.createElement("code");
+                codeColumn.appendChild(codeElement);
                 // createTextNode escapes special chars
-                lineElt.appendChild(document.createTextNode(formatLineNumber(start) + nbsp + line));
-                lineElt.appendChild(document.createElement("br"));
+                codeElement.appendChild(document.createTextNode(line));
 
-                container.appendChild(lineElt); // append to the container
+                tableBody.appendChild(tableRow); // append row to the table
             });
+            container.appendChild(table);
+
+            if (navigator.clipboard) {
+                let copyButton = document.createElement('button');
+                copyButton.classList.add('btn-clipboard');
+                copyButton.setAttribute('title', 'Copy to clipboard');
+                copyButton.appendChild(document.createTextNode('copy'));
+                copyButton.onclick = function() {
+                    navigator.clipboard.writeText(lines.join(lineSeparator));
+                }
+                container.appendChild(copyButton);
+            }
         });
-        oReq.open("GET", requestUrl);
-        oReq.send();
 
         container.innerHTML = "<samp>fetching...</samp>";
+
+        oReq.open("GET", requestUrl);
+        oReq.send();
     }
 
     window.pmd_code_snippets = {

data/resources/js/project-report.js

@@ -52,7 +52,7 @@ $(document).ready(function () {
         ],
         deferRender: true,
         // scrollY: "6000px",
-        dom: 'Pfrtip', // Search Panes, filtering input, processing display element, table, table information summary, pagination control
+        dom: 'Pfrtipl', // Search Panes, filtering input, processing display element, table, table information summary, pagination control, length changing input control
         searchPanes: {
             viewTotal: true,
             cascadePanes: true,
@@ -113,12 +113,13 @@ $(document).ready(function () {
             },
         ],
         displayLength: 25,
+        lengthMenu: [ [10, 20, 25, 50, 100, -1], [10, 20, 25, 50, 100, "All"] ],
         rowCallback(row, data, index) {
             $(row).addClass(cssClass[data.t]);
         },
     });
 
-    $('#violationsTable tbody').on('click', 'tr', function() {
+    $('#violationsTable tbody').on('click', 'tr[role=row]', function() {
         var tr = $(this).closest('tr');
         var row = table.row( tr );
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pmdtester
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Andreas Dangel
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2022-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0.rc4
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0.rc4
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: logger-colors
   requirement: !ruby/object:Gem::Requirement
@@ -86,16 +86,16 @@ dependencies:
   name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: hoe-bundler
   requirement: !ruby/object:Gem::Requirement
@@ -158,62 +158,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.81'
+        version: '0.93'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.81'
+        version: '0.93'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '6.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.22'
+        version: '3.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.22'
+        version: '3.23'
 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.
@@ -275,6 +269,7 @@ files:
 - lib/pmdtester/report_diff.rb
 - lib/pmdtester/resource_locator.rb
 - lib/pmdtester/runner.rb
+- lib/pmdtester/semver.rb
 - pmdtester.gemspec
 - resources/_includes/diff_pill_row.html
 - resources/css/bootstrap.min.css