Merge branch 'pr-23'

Author: adangel

.gitignore

@@ -1,3 +1,8 @@
+pkg/
+doc/
+Gemfile.lock
 .project
 .idea
+.bundle
 target/
+vendor/

.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 jdk: oraclejdk9
 script:
-  - bundle exec rake rubocop
-  - bundle exec rake clean test
-  - bundle exec rake clean integration-test
+  - rake rubocop
+  - rake clean test
+  - rake clean integration-test
+  - rake install_gem
+  - pmdtester -h

Gemfile

@@ -1,8 +1,20 @@
-source 'https://rubygems.org'
-gem 'hoe', '3.17.0'
-gem 'minitest', '5.10.1'
-gem 'mocha'
-gem 'nokogiri', '1.8.2'
-gem 'rubocop', '~>0.56.0', require: false
-gem 'slop', '4.6.2'
-gem 'test-unit', '3.2.3'
+# -*- ruby -*-
+
+# DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake bundler:gemfile`.
+
+source "https://rubygems.org/"
+
+gem "nokogiri", "~>1.8.2"
+gem "slop", "~>4.6.2"
+
+gem "hoe-bundler", "~>1.2", :group => [:development, :test]
+gem "hoe-gemspec", "~>1.0", :group => [:development, :test]
+gem "hoe-git", "~>1.6", :group => [:development, :test]
+gem "minitest", "~>5.10.1", :group => [:development, :test]
+gem "mocha", "~>1.5.0", :group => [:development, :test]
+gem "rubocop", "~>0.56.0", :group => [:development, :test]
+gem "test-unit", "~>3.2.3", :group => [:development, :test]
+gem "rdoc", ">=4.0", "<6", :group => [:development, :test]
+gem "hoe", "~>3.17", :group => [:development, :test]
+
+# vim: syntax=ruby

Gemfile.lock

@@ -27,3 +27,4 @@
 *   [#20](https://github.com/pmd/pmd-regression-tester/pull/20): Change the way of parsing xml file from DOM to SAX - [BBG](https://github.com/djydewang)
 *   [#21](https://github.com/pmd/pmd-regression-tester/pull/21): Add auto-gen-config option for PmdTester - [BBG](https://github.com/djydewang)
 *   [#22](https://github.com/pmd/pmd-regression-tester/pull/22): Add 'introduce new errors' table head for html summary report - [BBG](https://github.com/djydewang)
+*   [#23](https://github.com/pmd/pmd-regression-tester/pull/23): Preparing for the release of PmdTester - [BBG](https://github.com/djydewang)

History.md

@@ -1,8 +1,35 @@
+.rubocop.yml
+.rubocop_todo.yml
+.travis.yml
+Gemfile
 History.md
 LICENSE
 Manifest.txt
-README.md
+README.rdoc
 Rakefile
 bin/pmdtester
+config/all-java.xml
+config/design.xml
+config/project-list.xml
+config/project_list.txt
+config/projectlist_1_0_0.xsd
+lib/pmdtester/builders/diff_builder.rb
+lib/pmdtester/builders/diff_report_builder.rb
+lib/pmdtester/builders/html_report_builder.rb
+lib/pmdtester/builders/pmd_report_builder.rb
+lib/pmdtester/builders/rule_set_builder.rb
+lib/pmdtester/builders/summary_report_builder.rb
+lib/pmdtester/cmd.rb
 lib/pmdtester/parsers/options.rb
-test/test_options.rb
+lib/pmdtester/parsers/pmd_report_document.rb
+lib/pmdtester/parsers/projects_parser.rb
+lib/pmdtester/pmd_branch_detail.rb
+lib/pmdtester/pmd_error.rb
+lib/pmdtester/pmd_report_detail.rb
+lib/pmdtester/pmd_violation.rb
+lib/pmdtester/project.rb
+lib/pmdtester/report_diff.rb
+lib/pmdtester/resource_locator.rb
+lib/pmdtester/runner.rb
+resources/css/maven-base.css
+resources/css/maven-theme.css

Manifest.txt

@@ -1,30 +1,32 @@
-# pmdtester
+= pmdtester
 
-code  :: https://github.com/pmd/pmd-regression-tester  
-bugs  :: https://github.com/pmd/pmd-regression-tester/issues  
+code  :: https://github.com/pmd/pmd-regression-tester
+bugs  :: https://github.com/pmd/pmd-regression-tester/issues
 
-## DESCRIPTION:
+build-status :: {<img src="https://travis-ci.com/pmd/pmd-regression-tester.svg?branch=master" alt="Build Status" />}[https://travis-ci.com/pmd/pmd-regression-tester]
+
+== 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.
 
-## FEATURES/PROBLEMS:
+== FEATURES/PROBLEMS:
 
 The diff report can be generated according to the base and patch branch of PMD
 on a list of standard projects(Spring Framework, Hibernate, Solr, etc.)
 
-## SYNOPSIS:
+== SYNOPSIS:
 
-  FIX (code sample of usage)
+* FIX (code sample of usage)
 
-## REQUIREMENTS:
+== REQUIREMENTS:
 
 * FIX (list of requirements)
 
-## INSTALL:
+== INSTALL:
 
 * FIX (sudo gem install, anything else)
 
-## DEVELOPERS:
+== DEVELOPERS:
 
 You can list all tasks by running `rake -T`.
 

README.md renamed to README.rdoc

@@ -1,17 +1,30 @@
 # -*- ruby -*-
-
-require 'hoe'
 require 'rake/testtask'
 require 'rubocop/rake_task'
-require './lib/pmdtester/cmd.rb'
-require './lib/pmdtester/parsers/options.rb'
+require_relative './lib/pmdtester/parsers/options.rb'
+
+gem 'hoe'
+require 'hoe'
+Hoe.plugin :bundler
+Hoe.plugin :gemspec
+Hoe.plugin :git
 
 Hoe.spec 'pmdtester' do
   self.version = PmdTester::Options::VERSION
 
   self.author  = 'Binguo Bao'
   self.email   = '[email protected]'
-  self.clean_globs = %w[target/reports/**/* target/test**/*]
+  self.clean_globs = %w[target/reports/**/* target/test/**/*]
+  self.extra_deps += [['nokogiri', '~> 1.8.2'], ['slop', '~> 4.6.2']]
+  self.extra_dev_deps  += [
+    ['hoe-bundler',   '~> 1.2'],
+    ['hoe-gemspec',   '~> 1.0'],
+    ['hoe-git',       '~> 1.6'],
+    ['minitest',      '~> 5.10.1'],
+    ['mocha',         '~> 1.5.0'],
+    ['rubocop',       '~> 0.56.0'],
+    ['test-unit',     '~> 3.2.3']
+  ]
 
   license 'BSD-2-Clause'
 end
@@ -29,3 +42,5 @@ Rake::TestTask.new('integration-test') do |task|
   task.pattern = 'test/**/integration_test_*.rb'
   task.verbose = true
 end
+
+# vim: syntax=ruby

Rakefile

@@ -1,9 +1,10 @@
 # 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
-    CSS_SRC_DIR = 'resources/css'
+    CSS_SRC_DIR = ResourceLocator.locate('resources/css')
 
     def build_html_report(title_name)
       html_builder = Nokogiri::HTML::Builder.new do |doc|

lib/pmdtester/builders/html_report_builder.rb

@@ -3,6 +3,7 @@
 require 'nokogiri'
 require 'set'
 require_relative '../cmd'
+require_relative '../resource_locator'
 module PmdTester
   # This class is responsible for generation dynamic configuration
   # according to the difference between base and patch branch of Pmd.
@@ -13,7 +14,8 @@ class RuleSetBuilder
     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 = 'config/all-java.xml'
+    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!'