Move utils into a separate module

Author: oowekyala

lib/pmdtester/pmd_tester_utils.rb

@@ -1,53 +1,58 @@
 # frozen_string_literal: true
 
-# Some functions that that don't belong in a specific class
 module PmdTester
-  # Parse the base and the patch report, compute their diff
-  # Returns a +ReportDiff+
-  def build_report_diff(base_report_file, patch_report_file, base_info, patch_info, filter_set = nil)
-    base_details = PmdReportDetail.load(base_info)
-    patch_details = PmdReportDetail.load(patch_info)
+  # Some functions that that don't belong in a specific class,
+  module PmdTesterUtils
+    include PmdTester
 
-    base_report = parse_pmd_report(base_report_file, BASE, base_details, filter_set)
-    patch_report = parse_pmd_report(patch_report_file, PATCH, patch_details)
+    # Parse the base and the patch report, compute their diff
+    # Returns a +ReportDiff+
+    def build_report_diff(base_report_file, patch_report_file, base_info, patch_info, filter_set = nil)
+      base_details = PmdReportDetail.load(base_info)
+      patch_details = PmdReportDetail.load(patch_info)
 
-    logger.info 'Calculating diffs'
-    ReportDiff.new(base_report: base_report, patch_report: patch_report)
-  end
+      base_report = parse_pmd_report(base_report_file, BASE, base_details, filter_set)
+      patch_report = parse_pmd_report(patch_report_file, PATCH, patch_details)
 
-  # Parse the +report_file+ to produce a +Report+.
-  # For the schema of xml reports, refer to http://pmd.sourceforge.net/report_2_0_0.xsd
-  def parse_pmd_report(report_file, branch, report_details, filter_set = nil)
-    require 'nokogiri'
-
-    logger.info "Parsing #{report_file}"
-    doc = PmdReportDocument.new(branch, report_details.working_dir, filter_set)
-    parser = Nokogiri::XML::SAX::Parser.new(doc)
-    parser.parse_file(report_file) if File.exist?(report_file)
-    Report.new(
-      violations_by_file: doc.violations,
-      errors_by_file: doc.errors,
-      infos_by_rule: doc.infos_by_rules,
-
-      timestamp: report_details.timestamp,
-      exec_time: report_details.execution_time
-    )
-  end
+      logger.info 'Calculating diffs'
+      ReportDiff.new(base_report: base_report, patch_report: patch_report)
+    end
 
-  # Fill the report_diff field of every project
-  def compute_project_diffs(projects, base_branch, patch_branch, filter_set = nil)
-    projects.each do |project|
-      logger.info "Preparing report for #{project.name}"
-      project.compute_report_diff(base_branch, patch_branch, filter_set)
+    # Parse the +report_file+ to produce a +Report+.
+    # For the schema of xml reports, refer to http://pmd.sourceforge.net/report_2_0_0.xsd
+    def parse_pmd_report(report_file, branch, report_details, filter_set = nil)
+      require 'nokogiri'
+
+      logger.info "Parsing #{report_file}"
+      doc = PmdReportDocument.new(branch, report_details.working_dir, filter_set)
+      parser = Nokogiri::XML::SAX::Parser.new(doc)
+      parser.parse_file(report_file) if File.exist?(report_file)
+      Report.new(
+        violations_by_file: doc.violations,
+        errors_by_file: doc.errors,
+        infos_by_rule: doc.infos_by_rules,
+
+        timestamp: report_details.timestamp,
+        exec_time: report_details.execution_time
+      )
     end
-  end
 
-  # Build the diff reports and write them all
-  def build_html_reports(projects, base_branch_details, patch_branch_details)
-    compute_project_diffs(projects, base_branch_details.branch_name, patch_branch_details.branch_name)
+    # Fill the report_diff field of every project
+    def compute_project_diffs(projects, base_branch, patch_branch, filter_set = nil)
+      projects.each do |project|
+        logger.info "Preparing report for #{project.name}"
+        project.compute_report_diff(base_branch, patch_branch, filter_set)
+      end
+    end
+
+    # Build the diff reports and write them all
+    def build_html_reports(projects, base_branch_details, patch_branch_details)
+      compute_project_diffs(projects, base_branch_details.branch_name, patch_branch_details.branch_name)
 
-    SummaryReportBuilder.new.write_all_projects(projects,
-                                                base_branch_details,
-                                                patch_branch_details)
+      SummaryReportBuilder.new.write_all_projects(projects,
+                                                  base_branch_details,
+                                                  patch_branch_details)
+    end
   end
 end
+

lib/pmdtester/project.rb

@@ -3,7 +3,7 @@
 module PmdTester
   # This class represents all the information about the project
   class Project
-    include PmdTester
+    include PmdTesterUtils
 
     REPOSITORIES_PATH = 'target/repositories'
 

lib/pmdtester/runner.rb

@@ -4,7 +4,7 @@ module PmdTester
   # The Runner is a class responsible of organizing all PmdTester modules
   # and running the PmdTester
   class Runner
-    include PmdTester
+    include PmdTesterUtils
 
     def initialize(argv)
       @options = Options.new(argv)

test/test_diff_builder.rb

@@ -4,7 +4,7 @@
 
 # Unit test class for PmdTester::DiffBuilder
 class TestDiffBuilder < Test::Unit::TestCase
-  include PmdTester
+  include PmdTester::PmdTesterUtils
   include ProjectHasher
   BASE_REPORT_INFO_PATH = 'test/resources/diff_builder/base_report_info.json'
   PATCH_REPORT_INFO_PATH = 'test/resources/diff_builder/patch_report_info.json'

test/test_project_diff_report.rb

@@ -4,7 +4,7 @@
 
 # Unit test class for PmdTester::DiffReportBuilder
 class TestProjectDiffReport < Test::Unit::TestCase
-  include PmdTester
+  include PmdTester::PmdTesterUtils
   include TestUtils
   BASE_PMD_REPORT_PATH =
     'test/resources/html_report_builder/test_html_report_builder_base.xml'