6.7 dev (#9)

* Added l10n properties from 6.2 sonar

* Fixed about page locales for sonar v6.2

* Adjusted deps and eliminated original locales file

Once I've removed sonar-batch artifact I do not longer need
`core.properties` to get locales work when use this plugin in SQ 6.2

* Testing branch against SonarQube v6.1

* Begin work to update plugin for SonarQube 6.7

- Updated dependencies to work with SonarQube 6.7
- Removed Colorizer because it relies upon libraries that have been removed.

* Fix RubyFile and its tests for SonarQube 6.7

- Update Qualifiers to use current idenfiers
- Remove use of deprecated Project class
- Use TestInputFileBuilder to build files for testing
- Remove commented code

* Fix RubyPackage and its tests for SonarQube 6.7

- Update Qualifiers to use the updated identifier.

* Update SimpleCovRcovSensor and its tests for SonarQube 6.7

- Remove unused code
- Correctly implement 6.7 interface
- Update tests to use new libraries
- Update tests to test the updated interface implementation

* Update tests to use new libraries for SonarQube 6.7

* Update RubySensor and tests for SonarQube 6.7

- Use new libaries and interfaces for 6.7
- Update test with new libraries
- Needed to remove the test for execute() because EasyMock does not work with the return type by default
  - Information on how to fix the test here:
    - https://stackoverflow.com/q/2667172
    - https://stackoverflow.com/q/7204829

* Update RubySensor and tests for SonarQube 6.7

- Use new libaries and interfaces for 6.7
- Update test with new libraries
- Needed to change the test for execute() because the underlying library for
  saving metrics has changed.

* Update RubocopSensorTest for SonarQube 6.7

    - Update test with new libraries

* Updated the compose version and added a semaphore delay to the sonarqube instance (#11)

* Update README.md

* Fixed version

By semantic versioning 2.0, minor and patch digits should be reset after major update

* Update README.md

* Address review comments

- Remove commented code
- Add docstring
- Remove development debug statement

Author: lyrch

.travis.yml

@@ -8,7 +8,7 @@ jdk:
 
 # install docker compose
 env:
-  COMPOSE_VERSION: 1.11.2
+  COMPOSE_VERSION: 1.19.0
 before_install:
   - curl -L https://github.com/docker/compose/releases/download/${COMPOSE_VERSION}/docker-compose-`uname -s`-`uname -m` > docker-compose
   - chmod +x docker-compose
@@ -22,6 +22,7 @@ before_script:
 
 # run unit tests and integration tests
 script:
+  - while [[ "$(docker-compose logs sonarqube | grep -c 'SonarQube is up')" -ne 1 ]]; do sleep 1; done
   - mvn test
   - ./run_test.sh
 

README.md

@@ -2,7 +2,7 @@ SonarQube Ruby Plugin [![Build Status](https://travis-ci.org/shakedlokits/ruby-s
 =================
 
 ## Description
-This plugin enables publishing static and dynamic analysis reports of Ruby projects onto SonarQube 5.6.3+  
+This plugin enables publishing static and dynamic analysis reports of Ruby projects onto SonarQube 6.7+  
 
 The plugin currently supports the following services:
 * Lines of code, Number of classes, Comment precentage
@@ -11,7 +11,7 @@ The plugin currently supports the following services:
 * Code Coverage (line coverage)
 * Coding Style Violations
 
-It relies on standardized external tools: [SimpleCov](https://github.com/colszowka/simplecov), [SimpleCov-RCov](https://github.com/fguillen/simplecov-rcov) and [Metric_Fu](https://github.com/metricfu/metric_fu/) in order to make the analysis and report the metrics which are then in turn published to SonarQube.
+It relies on standardized external tools: [SimpleCov](https://github.com/colszowka/simplecov), [SimpleCov-RCov](https://github.com/fguillen/simplecov-rcov), [Metric_Fu](https://github.com/metricfu/metric_fu/) and [Rubocop](https://github.com/bbatsov/rubocop) in order to make the analysis and report the metrics which are then in turn published to SonarQube.
 
 ## Install
 1. Run `mvn install` to produce the `target/sonar-ruby-plugin-VERSION.jar` plugin file
@@ -45,8 +45,7 @@ end
 **Important:** Do not change the output directory for the simplecov-rcov report, leave it as default, or code coverage will not be reported.
 
 ##### Code Complexity
-In order for the plugin to report on code complexity, [metric_fu](https://github.com/metricfu/metric_fu/) needs to be ran against the ruby project,
-which will generate a metric report. Please see the [gem's homepage](https://github.com/metricfu/metric_fu/) for installation and usage instructions.  
+In order for the plugin to report on code complexity, [metric_fu](https://github.com/metricfu/metric_fu/) needs to be ran against the ruby project, which will generate a metric report. Please see the [gem's homepage](https://github.com/metricfu/metric_fu/) for installation and usage instructions.  
 
 **Important:**  We recommend using metric_fu by running `metric_fu -r --no-flog --no-flay --no-roodi --no-open` which would analyze and report all of the metrics supported by the plugin. Such as Saikuro/Cane coverage, Cane issues, Hostpots, Code smells and more..
 
@@ -87,7 +86,7 @@ Use the `sonar.ruby.coverage.testSuites` property to set the correct tests aggre
 
 **Important:** We recommend run rubocop as such `rubocop -f json -o tmp/rubocop/report.json`.
 
-##Future Plans
+## Future Plans
 * Code Duplication
 * Structural Analysis
 * Code Debt
@@ -101,7 +100,7 @@ We referenced the [Java Sonar Plugin](https://github.com/SonarSource/sonar-java)
 
 ## Tool Versions
 This plugin has been tested with the following dependency versions:
-* [SonarQube](http://www.sonarqube.org/downloads/) 5.6.3 LTS
+* [SonarQube](http://www.sonarqube.org/downloads/) 6.7
 * SonarQube Runner 2.7 (or newer)
 * metric_fu gem version 4.12.0 (latest at time of edit)
 * simplecov 0.12.0
@@ -111,6 +110,7 @@ This plugin has been tested with the following dependency versions:
 ## Authors
 * [Brian Clifton](https://github.com/bsclifton)
 * [Shaked Lokits](https://github.com/shakedlokits) - *Maintainer*
+* [Jared Wilkerson](https://github.com/lyrch)
 * [Serge Gernyak](https://github.com/sergio1990)
 * [Will Greenway](https://api.github.com/users/wpgreenway)
 * [Greg Allen](https://api.github.com/users/ggallen)

docker-compose.yaml

@@ -1,5 +1,5 @@
 sonarqube:
-  image: sonarqube:5.6.3
+  image: sonarqube:6.7
   volumes:
     - ./target:/opt/sonarqube/extensions/plugins
   ports:

pom.xml

@@ -6,14 +6,14 @@
 	<groupId>com.godaddy.sonar</groupId>
 	<artifactId>sonar-ruby-plugin</artifactId>
 	<packaging>sonar-plugin</packaging>
-	<version>1.4.2</version>
+	<version>2.0.0</version>
 
 	<name>Sonar Ruby Plugin</name>
 	<description>Plugin to report ruby code coverage into sonar</description>
 
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-		<sonar.buildVersion>5.5</sonar.buildVersion>
+		<sonar.buildVersion>6.7</sonar.buildVersion>
         <!--FIXME: update batch version to build version once available-->
         <sonar.sonarBatchVersion>5.4</sonar.sonarBatchVersion>
 		<jdk.min.version>1.6</jdk.min.version>
@@ -33,31 +33,16 @@
 			<version>${sonar.buildVersion}</version>
 			<scope>provided</scope>
 		</dependency>
-		<dependency>
-			<groupId>org.sonarsource.sonarqube</groupId>
-			<artifactId>sonar-batch</artifactId>
-			<version>${sonar.sonarBatchVersion}</version>
-            <!--FIXME:HACK: using exclusion pattens to resolve this https://groups.google.com/forum/#!msg/sonarqube/R8jk9MK9bGI/gOn5uhk9GgAJ-->
-            <exclusions>
-                <exclusion>
-                    <groupId>com.google.guava</groupId>
-                    <artifactId>guava</artifactId>
-                </exclusion>
-                <exclusion>
-                    <groupId>commons-lang</groupId>
-                    <artifactId>commons-lang</artifactId>
-                </exclusion>
-                <exclusion>
-                    <groupId>commons-io</groupId>
-                    <artifactId>commons-io</artifactId>
-                </exclusion>
-            </exclusions>
-		</dependency>
 		<dependency>
 			<groupId>org.jruby</groupId>
 			<artifactId>jruby-complete</artifactId>
 			<version>1.7.20</version>
 		</dependency>
+		<dependency>
+			<groupId>com.google.code.gson</groupId>
+			<artifactId>gson</artifactId>
+			<version>2.8.0</version>
+		</dependency>
         <dependency>
             <groupId>org.sonarsource.sslr-squid-bridge</groupId>
             <artifactId>sslr-squid-bridge</artifactId>

run_test.sh

@@ -1,7 +1,6 @@
 package com.godaddy.sonar.ruby;
 
 import com.godaddy.sonar.ruby.core.Ruby;
-import com.godaddy.sonar.ruby.core.RubySourceCodeColorizer;
 import com.godaddy.sonar.ruby.core.profiles.SonarWayProfile;
 import com.godaddy.sonar.ruby.metricfu.*;
 
@@ -59,7 +58,6 @@ public List<Object> getExtensions() {
         extensions.add(MetricfuYamlParser.class);
         extensions.add(RubocopSensor.class);
         extensions.add(DefaultReportJsonParser.class);
-        extensions.add(RubySourceCodeColorizer.class);
         extensions.add(RubySensor.class);
         extensions.add(MetricfuComplexitySensor.class);
         // extensions.add(MetricfuDuplicationSensor.class);

src/main/java/com/godaddy/sonar/ruby/RubyPlugin.java

@@ -4,12 +4,14 @@
 import com.godaddy.sonar.ruby.core.RubyRecognizer;
 import com.godaddy.sonar.ruby.parsers.CommentCountParser;
 import com.google.common.collect.Lists;
+import jnr.ffi.annotations.In;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.IOUtils;
-import org.sonar.api.batch.Sensor;
-import org.sonar.api.batch.SensorContext;
+import org.sonar.api.batch.sensor.Sensor;
+import org.sonar.api.batch.sensor.SensorContext;
 import org.sonar.api.batch.fs.FileSystem;
 import org.sonar.api.batch.fs.InputFile;
+import org.sonar.api.batch.sensor.SensorDescriptor;
 import org.sonar.api.config.Settings;
 import org.sonar.api.measures.CoreMetrics;
 import org.sonar.api.resources.Project;
@@ -27,30 +29,39 @@ public RubySensor(Settings settings, FileSystem fileSystem) {
         this.fileSystem = fileSystem;
     }
 
-    @Override
     public boolean shouldExecuteOnProject(Project project) {
         // This sensor is executed only when there are Ruby files
         return fileSystem.hasFiles(fileSystem.predicates().hasLanguage(Ruby.KEY));
     }
 
-    public void analyse(Project project, SensorContext context) {
-        computeBaseMetrics(context, project);
+    public void describe(SensorDescriptor descriptor){
+        descriptor.onlyOnLanguage(Ruby.KEY).name("Ruby Sensor").onlyOnFileType(InputFile.Type.MAIN);
+    }
+
+    public void execute(SensorContext context) {
+        computeBaseMetrics(context);
     }
 
-    protected void computeBaseMetrics(SensorContext sensorContext, Project project) {
+    /**
+     * Analysis helper function used on a Ruby project compute and save the folloing metrics
+     * into the SonarQube system: NCLOC, COMMENT_LINES, FILES, CLASSES
+     *
+     * @param sensorContext  the project sensor context
+     */
+    protected void computeBaseMetrics(SensorContext sensorContext) {
         Reader reader = null;
         List<InputFile> inputFiles = Lists.newArrayList(fileSystem.inputFiles(fileSystem.predicates().hasLanguage(Ruby.KEY)));
-
         for (InputFile inputFile : inputFiles) {
             try {
                 reader = new StringReader(FileUtils.readFileToString(inputFile.file(), fileSystem.encoding().name()));
                 Source source = new Source(reader, new RubyRecognizer());
-                sensorContext.saveMeasure(inputFile, CoreMetrics.NCLOC, (double) source.getMeasure(Metric.LINES_OF_CODE));
+
+                sensorContext.<Integer>newMeasure().on(inputFile).forMetric(CoreMetrics.NCLOC).withValue(source.getMeasure((Metric.LINES_OF_CODE))).save();
 
                 int numCommentLines = CommentCountParser.countLinesOfComment(inputFile.file());
-                sensorContext.saveMeasure(inputFile, CoreMetrics.COMMENT_LINES, (double) numCommentLines);
-                sensorContext.saveMeasure(inputFile, CoreMetrics.FILES, 1.0);
-                sensorContext.saveMeasure(inputFile, CoreMetrics.CLASSES, 1.0);
+                sensorContext.<Integer>newMeasure().on(inputFile).forMetric(CoreMetrics.COMMENT_LINES).withValue(numCommentLines).save();
+                sensorContext.<Integer>newMeasure().on(inputFile).forMetric(CoreMetrics.FILES).withValue(1).save();
+                sensorContext.<Integer>newMeasure().on(inputFile).forMetric(CoreMetrics.CLASSES).withValue(1).save();
             } catch (Exception e) {
                 throw new IllegalStateException("Error computing base metrics for project.", e);
             } finally {

src/main/java/com/godaddy/sonar/ruby/RubySensor.java

@@ -88,7 +88,7 @@ public String getScope() {
     }
 
     public String getQualifier() {
-        return Qualifiers.CLASS;
+        return Qualifiers.FILE;
     }
 
     public boolean matchFilePattern(String antPattern) {
@@ -113,11 +113,4 @@ public String toString() {
                 + ", getKey()=" + getKey() + ", getId()=" + getId() + ", getPath()=" + getPath() + ", getEffectiveKey()="
                 + getEffectiveKey() + ", isExcluded()=" + isExcluded() + "]\n";
     }
-
-//    @Override
-//    public String toString()
-//    {
-//        return new ToStringBuilder(this).append("key", getKey()).append("package", packageKey).append("longName", longName).toString();
-//    }
-
 }

src/main/java/com/godaddy/sonar/ruby/core/RubyFile.java

@@ -56,6 +56,6 @@ public String getScope() {
 
     @Override
     public String getQualifier() {
-        return Qualifiers.PACKAGE;
+        return Qualifiers.PROJECT;
     }
 }