rspec-sonarqube-formatter 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18abf270b6d19003f2e9930ebc83037e1f071b7ec451ab3fb41956ed83e3b8ea
-  data.tar.gz: 93979f9fc568b961dbaa8e1b5a96108e39db5a00f773091f9a3ccc8905268b7f
+  metadata.gz: 93972356452ed71c7faa406e7bbf606ecd50f3e132b0e069275b512b31f600b1
+  data.tar.gz: a93154e5011e94d1d0803600e8b3e1ebad2681e8546d8f75619c193ef11f900c
 SHA512:
-  metadata.gz: 06dde19cae5242ebf42bae5fc25373e30c68cc807b33cd2baf4fc58466ca0332209ca8890d0699417dbd9d2dc4c1cc93504d0f6451935c21623984cfb9d9ad2d
-  data.tar.gz: 76fb13fd00d7ab2f4b8fbaae33021b9bb1af930dceb868c4a7ffde2d30c85f61221b346cb5b88b7aecfbce43d083f8bcc177793b130ff63a97d649eb4e87c1c6
+  metadata.gz: 7615b6c9602c81f122a17ca9721eb4fe2ab25d1a36793cfa931d68dc8e99a0eed4b1e0e6c9bc1ed7203037e098fb875e9e7f3503490434e9ce5c208c665e1fa3
+  data.tar.gz: 0de1ff8fffa56043ee5145981cda0b56e2bf04bd8c319a24e1efcafe9316a62725423f8e44c02b4b7dd852b47df47a0924f505ccc1c9bef4d922c5785ed8ee5a

data/.gitignore

@@ -35,3 +35,4 @@ rubocop.json
 *.gem
 .bundle/
 cc-test-reporter
+pkg/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-sonarqube-formatter (1.0.1)
+    rspec-sonarqube-formatter (1.1.0)
       rspec (~> 3.0)
 
 GEM

data/README.md

@@ -1,6 +1,7 @@
 # RSpec SonarQube Formatter
 
-Rspec formatter to generates an xml file for SonarQube, using the generec-test-data format, 
+[RSpec 3](https://rspec.info/) formatter that generates an XML file for [SonarQube](https://www.sonarqube.org/) 6.2+, using 
+the [Generic Test Data](https://docs.sonarqube.org/latest/analysis/generic-test/) format.
 
 [![Gem Version](https://img.shields.io/gem/v/rspec-sonarqube-formatter)][rubygems]
 [![Downloads](https://img.shields.io/gem/dt/rspec-sonarqube-formatter)][rubygems]
@@ -19,12 +20,87 @@ Rspec formatter to generates an xml file for SonarQube, using the generec-test-d
 [sonarqube]: https://sonarcloud.io/dashboard?id=otherguy_rspec-sonarqube-formatter
 [license]: https://github.com/otherguy/rspec-sonarqube-formatter/blob/master/LICENSE.md
 
+## Features 🌈
 
-## Development
+This formatter generates an XML report that can be read by [SonarQube](https://www.sonarqube.org/) 6.2+. 
+Out of the box, SonarQube 6.2+ supports generic formats for test coverage and test execution import. Using the XML file 
+generated by this gem, you get an overview of test executions (`passed`, `skipped`, `failed`)
+and the time in milliseconds it took to execute these. 
 
+[![Sonarcloud.io](documentation/sonarcloud.png)][sonarqube]️
+
+## Installation 🚀
+
+Add the gem to your application's `Gemfile`:
+
+```ruby
+# RSpec formatters
+gem 'rspec-sonarqube-formatter', '~> 1.0', require: false
+```
+
+Then, update your bundle:
+
+    $ bundle install
+
+Or install it manually using:
+
+    $ gem install rspec-sonarqube-formatter
+
+
+## Usage 🛠
+
+Add the following code to your `spec_helper.rb`:
+
+```ruby
+RSpec.configure do |c|
+  c.formatter = 'documentation'
+  c.add_formatter('RspecSonarqubeFormatter', 'out/test-report.xml')
+  ...
+end
+```
+
+Alternatively, edit your `.rspec` file to define your formatters there:
+
+```bash
+# .rspec
+--require spec_helper
+--color
+--format RspecSonarqubeFormatter
+--out out/test-report.xml
+--format documentation
+```
+
+To make SonarQube read the test report, specify the path to the generated XML in your 
+[`sonar-project.properties`](sonar-project.properties) or configure it in the SonarQube GUI. 
+
+```bash
+# sonar-project.properties
+sonar.testExecutionReportPaths=out/test-report.xml
+```
+
+## Inspiration 💅
+
+The only [existing formatter](https://github.com/witjoh/rspec_sonar_formatter) does not work out of the box and is not
+published to [RubyGems.org](https://rubygems.org/gems/rspec-sonarqube-formatter), so I created my own.
+
+Thank you to [`@witjoh`](https://github.com/witjoh) for the original work ♥️!
+
+
+## Contributing 🚧
+
+Bug reports and pull requests are welcome on GitHub at [`otherguy/rspec-sonarqube-formatter`](https://github.com/otherguy/rspec-sonarqube-formatter).
+
+After checking out the repository, you need to install dependencies:
+
+```bash
 gem install bundler -v 2.0.2
 bundle install
+```
+
+Then, run `bundle exec rake spec` to run the test suite. 
+
+To install this gem on your local machine, run `bundle exec rake install`.
 
+Please check your contributions with RuboCop by running `bundle exec rubocop`. 
 
-Tests:
-bundle exec rake spec
+Releases are built from tags automatically on [Travis][travis] and pushed to [RubyGems.org][rubygems].

data/lib/rspec_sonarqube_formatter.rb

@@ -30,7 +30,7 @@ class RspecSonarqubeFormatter
   end
 
   def example_started(_notification)
-    @output.puts ''
+    # Do nothing
   end
 
   def example_passed(notification)

data/rspec-sonarqube-formatter.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'rspec-sonarqube-formatter'
 
   # rubocop:disable Gemspec/DuplicatedAssignment
-  spec.version       = '1.0.0-pre'
+  spec.version       = '1.0.0-local'
   spec.version       = ENV.fetch('TRAVIS_TAG') { spec.version }.to_s if ENV['TRAVIS']
   # rubocop:enable Gemspec/DuplicatedAssignment
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sonarqube-formatter
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexander Graf
@@ -132,6 +132,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- documentation/sonarcloud.png
 - lib/rspec_sonarqube_formatter.rb
 - rspec-sonarqube-formatter.gemspec
 - sonar-project.properties