Merge branch 'pr-28'

adangel · adangel · commit caf7016aeb20 · 2018-07-26T21:53:34.000+02:00
diff --git a/Manifest.txt b/Manifest.txt
@@ -11,7 +11,7 @@ config/all-java.xml
 config/design.xml
 config/project-list.xml
 config/projectlist_1_0_0.xsd
-lib/pmdtester/pmdtester.rb
+lib/pmdtester.rb
 lib/pmdtester/builders/diff_builder.rb
 lib/pmdtester/builders/diff_report_builder.rb
 lib/pmdtester/builders/html_report_builder.rb
diff --git a/Rakefile b/Rakefile
@@ -3,7 +3,7 @@
 # -*- ruby -*-
 require 'rake/testtask'
 require 'rubocop/rake_task'
-require_relative './lib/pmdtester/parsers/options.rb'
+require_relative 'lib/pmdtester'
 
 gem 'hoe'
 require 'hoe'
@@ -12,7 +12,7 @@ Hoe.plugin :gemspec
 Hoe.plugin :git
 
 hoe = Hoe.spec 'pmdtester' do
-  self.version = PmdTester::Options::VERSION
+  self.version = PmdTester::VERSION
 
   developer 'Andreas Dangel', 'andreas.dangel@adangel.org'
   developer 'Binguo Bao', 'djydewang@gmail.com'
diff --git a/bin/pmdtester b/bin/pmdtester
@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/pmdtester/runner'
+require_relative '../lib/pmdtester'
 
 runner = PmdTester::Runner.new(ARGV)
 runner.run
diff --git a/lib/pmdtester.rb b/lib/pmdtester.rb
@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+require_relative 'pmdtester/cmd'
+require_relative 'pmdtester/pmd_branch_detail'
+require_relative 'pmdtester/pmd_error'
+require_relative 'pmdtester/pmd_report_detail'
+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/html_report_builder'
+require_relative 'pmdtester/builders/diff_builder'
+require_relative 'pmdtester/builders/diff_report_builder'
+require_relative 'pmdtester/builders/pmd_report_builder'
+require_relative 'pmdtester/builders/rule_set_builder'
+require_relative 'pmdtester/builders/summary_report_builder'
+
+require_relative 'pmdtester/parsers/options'
+require_relative 'pmdtester/parsers/pmd_report_document'
+require_relative 'pmdtester/parsers/projects_parser'
+
+# PmdTester is 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.
+module PmdTester
+  VERSION = '1.0.0-SNAPSHOT'
+
+  def logger
+    PmdTester.logger
+  end
+
+  # Global, memoized, lazy initialized instance of a logger
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end
diff --git a/lib/pmdtester/builders/diff_builder.rb b/lib/pmdtester/builders/diff_builder.rb
@@ -1,11 +1,6 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require_relative '../pmd_error'
-require_relative '../pmd_violation'
-require_relative '../pmd_report_detail'
-require_relative '../parsers/pmd_report_document'
-require_relative '../report_diff'
 
 module PmdTester
   # Building difference between two pmd xml files
diff --git a/lib/pmdtester/builders/diff_report_builder.rb b/lib/pmdtester/builders/diff_report_builder.rb
@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require_relative './html_report_builder'
 
 module PmdTester
   # Building diff report for a single project
diff --git a/lib/pmdtester/builders/html_report_builder.rb b/lib/pmdtester/builders/html_report_builder.rb
@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../resource_locator'
 module PmdTester
   # This class is the parent of all classes which is used to build html report
   class HtmlReportBuilder
diff --git a/lib/pmdtester/builders/pmd_report_builder.rb b/lib/pmdtester/builders/pmd_report_builder.rb
@@ -1,10 +1,6 @@
 # frozen_string_literal: true
 
 require 'fileutils'
-require_relative '../cmd'
-require_relative '../project'
-require_relative '../pmd_branch_detail'
-require_relative '../pmd_report_detail'
 
 module PmdTester
   # Building pmd xml reports according to a list of standard
diff --git a/lib/pmdtester/builders/rule_set_builder.rb b/lib/pmdtester/builders/rule_set_builder.rb
@@ -2,8 +2,6 @@
 
 require 'nokogiri'
 require 'set'
-require_relative '../cmd'
-require_relative '../resource_locator'
 
 module PmdTester
   # This class is responsible for generation dynamic configuration
diff --git a/lib/pmdtester/builders/summary_report_builder.rb b/lib/pmdtester/builders/summary_report_builder.rb
@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './html_report_builder'
-require_relative '../pmd_branch_detail'
-
 module PmdTester
   # Building summary report to show the details about projects and pmd branchs
   class SummaryReportBuilder < HtmlReportBuilder
diff --git a/lib/pmdtester/parsers/options.rb b/lib/pmdtester/parsers/options.rb
@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'slop'
-require_relative '../pmdtester'
 
 module PmdTester
   class MissRequiredOptionError < StandardError; end
@@ -15,7 +14,6 @@ class Options
     LOCAL = 'local'
     ONLINE = 'online'
     SINGLE = 'single'
-    VERSION = '1.0.0-SNAPSHOT'
 
     attr_reader :local_git_repo
     attr_reader :base_branch
diff --git a/lib/pmdtester/parsers/pmd_report_document.rb b/lib/pmdtester/parsers/pmd_report_document.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require_relative '../pmd_violation'
-require_relative '../pmd_error'
 module PmdTester
   # This class is used for registering types of events you are interested in handling.
   # Also see: https://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/SAX/Document
diff --git a/lib/pmdtester/parsers/projects_parser.rb b/lib/pmdtester/parsers/projects_parser.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require_relative '../project'
-require_relative '../resource_locator'
 
 module PmdTester
   # The ProjectsParser is a class responsible of parsing
diff --git a/lib/pmdtester/pmd_branch_detail.rb b/lib/pmdtester/pmd_branch_detail.rb
@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'json'
-require_relative './pmd_report_detail'
 
 module PmdTester
   # This class represents all details about branch of pmd
diff --git a/lib/pmdtester/pmdtester.rb b/lib/pmdtester/pmdtester.rb
diff --git a/lib/pmdtester/project.rb b/lib/pmdtester/project.rb
@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './pmd_branch_detail'
-
 module PmdTester
   # This class represents all the information about the project
   class Project
diff --git a/lib/pmdtester/runner.rb b/lib/pmdtester/runner.rb
@@ -1,15 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './builders/diff_builder.rb'
-require_relative './builders/diff_report_builder.rb'
-require_relative './builders/rule_set_builder'
-require_relative './builders/summary_report_builder.rb'
-require_relative './builders/pmd_report_builder.rb'
-require_relative './parsers/options'
-require_relative './parsers/projects_parser'
-require_relative './pmdtester'
-require_relative './pmd_branch_detail'
-
 module PmdTester
   # The Runner is a class responsible of organizing all PmdTester modules
   # and running the PmdTester
diff --git a/test/integration_test_pmd_report_builder.rb b/test/integration_test_pmd_report_builder.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require_relative '../lib/pmdtester/builders/pmd_report_builder'
-require_relative '../lib/pmdtester/parsers/projects_parser'
+require 'test_helper'
 
 # Integration test for PmdTester::PmdReportBuilder
 class IntegrationTestPmdReportBuilder < Test::Unit::TestCase
diff --git a/test/integration_test_runner.rb b/test/integration_test_runner.rb
@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require_relative '../lib/pmdtester/runner'
-require_relative '../lib/pmdtester/cmd'
+require 'test_helper'
+
 class IntegrationTestRunner < Test::Unit::TestCase
   def setup
     `rake clean`
diff --git a/test/test_cmd.rb b/test/test_cmd.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require_relative '../lib/pmdtester/runner'
-require_relative '../lib/pmdtester/cmd'
+require 'test_helper'
 
 # Unit test class for PmdTester::Cmd
 class TestCmd < Test::Unit::TestCase
diff --git a/test/test_diff_builder.rb b/test/test_diff_builder.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require_relative '../lib/pmdtester/builders/diff_builder'
-require_relative '../lib/pmdtester/builders/diff_report_builder'
+require 'test_helper'
 
 # Unit test class for PmdTester::DiffBuilder
 class TestDiffBuilder < Test::Unit::TestCase
diff --git a/test/test_diff_report_builder.rb b/test/test_diff_report_builder.rb
@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require_relative '../lib/pmdtester/builders/diff_builder'
-require_relative '../lib/pmdtester/builders/diff_report_builder'
-require_relative '../lib/pmdtester/parsers/projects_parser'
+require 'test_helper'
 
 # Unit test class for PmdTester::DiffReportBuilder
 class TestDiffReportBuilder < Test::Unit::TestCase
diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'test/unit'
+require 'mocha/test_unit'
+
+require_relative '../lib/pmdtester'
diff --git a/test/test_options.rb b/test/test_options.rb
@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require_relative '../lib/pmdtester/parsers/options'
+require 'test_helper'
 
 # Unit test for PmdTester::Options
 class TestOptions < Test::Unit::TestCase
diff --git a/test/test_pmd_branch_detail.rb b/test/test_pmd_branch_detail.rb
@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require_relative '../lib/pmdtester/pmd_branch_detail'
+require 'test_helper'
 
 # Unit test class for PmdTester::PmdBranchDetail
 class TestPmdBranchDetail < Test::Unit::TestCase
diff --git a/test/test_pmd_report_detail.rb b/test/test_pmd_report_detail.rb
@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require_relative '../lib/pmdtester/pmd_report_detail'
+require 'test_helper'
 
 # Unit test class for PmdTester::PmdReportDetail
 class TestPmdReportDetail < Test::Unit::TestCase
diff --git a/test/test_pmd_report_document.rb b/test/test_pmd_report_document.rb
@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require_relative '../lib/pmdtester/pmd_violation'
-require_relative '../lib/pmdtester/pmd_error'
-require_relative '../lib/pmdtester/parsers/pmd_report_document'
+require 'test_helper'
 
 class TestPmdReportDocument < Test::Unit::TestCase
   include PmdTester
diff --git a/test/test_projects_parser.rb b/test/test_projects_parser.rb
@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require_relative '../lib/pmdtester/parsers/projects_parser'
+require 'test_helper'
 
 # Unit test for PmdTester::ProjectsParser
 class TestProjectsParser < Test::Unit::TestCase
diff --git a/test/test_rule_set_builder.rb b/test/test_rule_set_builder.rb
@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require 'mocha/test_unit'
-require 'set'
-require_relative '../lib/pmdtester/builders/rule_set_builder'
+require 'test_helper'
+
 # The unit test class for RuleSetBuilder
 class TestRuleSetBuilder < Test::Unit::TestCase
   PATH_TO_TEST_RESOURCES = 'test/resources/rule_set_builder'
diff --git a/test/test_runner.rb b/test/test_runner.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require 'mocha/test_unit'
-require_relative '../lib/pmdtester/runner'
+require 'test_helper'
 
 # Unit test class for PmdTester::Runner
 class TestRunner < Test::Unit::TestCase
diff --git a/test/test_summary_report_builder.rb b/test/test_summary_report_builder.rb
@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require 'test/unit'
-require 'mocha/test_unit'
-require_relative '../lib/pmdtester/builders/summary_report_builder'
-require_relative '../lib/pmdtester/parsers/projects_parser'
+require 'test_helper'
 
 # Unit test class for PmdTester::SummaryReportBuilder
 class TestSummaryReportBuilder < Test::Unit::TestCase
