Skip to content

Commit

Permalink
Updated README after merging GoDaddy-Hosting#5
Browse files Browse the repository at this point in the history
  • Loading branch information
bsclifton committed Sep 17, 2015
1 parent a6169de commit 34b0e89
Showing 1 changed file with 9 additions and 17 deletions.
26 changes: 9 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[![Build Status](http://jenkins.notjomax.com/buildStatus/icon?job=ruby-sonar-plugin)](http://jenkins.notjomax.com/job/ruby-sonar-plugin/)
Sonar Ruby Plugin
SonarQube Ruby Plugin
=================
##Description / Features
The plugin enables analysis of Ruby projects within SonarQube
The plugin enables analysis of Ruby projects within SonarQube (most recently tested against version 4.5.5 LTS)

Currently the plugin captures basic metrics (Lines of Code, Number of classes and packages, Comment percentage),
complexity on each file, and a visual line-by-line code coverage report.
Expand All @@ -25,13 +24,11 @@ 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 [here](https://github.com/metricfu/metric_fu/) for installation and usage instructions.
**Important:** metric_fu reports on more than just code complexity, however we still recommend to use the metric_fu command: `metric_fu -r`
this will run all metrics. At the very least, Saikuro and Hotspots metrics need to be ran for complexity to be reported.
Also, do not change the output directory for the metric_fu report, leave it as default or code complexity will not be reported
this will run all metrics. At the very least, Saikuro/Cane and Hotspots metrics need to be ran for complexity to be reported.

##Future Plans
* Code Duplication
* Code Violations
* Configuration option to specify simplecov-rcov and metric_fu report directories

##Giving Credit
The github project [pica/ruby-sonar-plugin](https://github.com/pica/ruby-sonar-plugin), is where the ruby-sonar-plugin started, rather than reinvent the wheel, we thought it better to enhance it.
Expand All @@ -41,14 +38,9 @@ We referenced the [javascript sonar plugin](https://github.com/SonarCommunity/so
Our complexity sensor and code coverage sensor borrow heavily from the javascript plugin's equivalent sensors.

##Tool Versions
* We are using Sonar 3.5.1 along with the Sonar 3.5.1 api (You must be using at least sonar 3.5 for the plugin to work)
* We are using Sonar-Runner 2.2.2 to anaylze our projects
* metric_fu 4.2.1 (latest at time of edit)
* simplecov 0.7.1 (latest at time of edit)
* simplecov-rcov 0.2.3 (latest at time of edit)

##Updates from Constant Contact
* Updates were made for compatibility with Sonar 4.5.2 and it's api
* Added support for configuring report paths for SimpleCovRcov and MetricFu via Sonar properties. They are available in the Code Coverage category and are configurable per project.
* Added support to configure whether to use Saikuro or Cane for complexity metrics. May add support for obtaining complexity from flog as well
* Several dependencies were also updated to more recent versions.
This plugin has been tested with the following dependency versions
* [SonarQube](http://www.sonarqube.org/downloads/) 4.5.5 LTS
* SonarQube Runner 2.3 (or newer)
* metric_fu gem version 4.12.0 (latest at time of edit)
* simplecov 0.8.2
* simplecov-rcov 0.2.3

0 comments on commit 34b0e89

Please sign in to comment.