Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Correct readme.md with correct mark down #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Correct readme.md with correct mark down #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
SonarQube Ruby Plugin
=================
##Description / Features
## Description / Features
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.

It relies on well-known 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/)

##Install
## Install
Download the plugin into the SONARQUBE_HOME/extensions/plugins directory

##Usage
## Usage
Make sure the property sonar.language is set to ruby: `sonar.language=ruby` in the sonar-project.properties file

#####Code Coverage
##### Code Coverage
In order for the plugin to report on code coverage, the ruby project needs to be using [simplecov-rcov](https://github.com/fguillen/simplecov-rcov)
to generate a coverage report when you run your tests/specs, please see the gem's homepage [here](https://github.com/fguillen/simplecov-rcov) for installation
and usage instructions.
**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
##### 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 [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/Cane and Hotspots metrics need to be ran for complexity to be reported.

##Future Plans
## Future Plans
* Code Duplication
* Code Violations

##Giving Credit
## 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.
We used that plugin as a starting point for basic stats, then, updated the references to their latest versions and added additional metrics like line-by-line code coverage and code complexity.

We referenced the [javascript sonar plugin](https://github.com/SonarCommunity/sonar-javascript) and the [php sonar plugin](https://github.com/SonarCommunity/sonar-php) for complexity and coverage implementation.
Our complexity sensor and code coverage sensor borrow heavily from the javascript plugin's equivalent sensors.

##Tool Versions
## Tool 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)
Expand Down