simplecov-teamcity-summary 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f34f987c80b2378d7677c873c11eb4a32891964e
-  data.tar.gz: a1a1ab8d83aa9b5cc5cd35a3a0100bfc49ca3458
+  metadata.gz: 9066303545c68f6a7a00a64dc0dac9b34e5c33a2
+  data.tar.gz: 38de68c2f178c64c56c0d3144600fba81f8a750f
 SHA512:
-  metadata.gz: a8ab0d1f819851d352221bf6cc3b00427a98c199f37e0f4d83110b530548732c80474b2c66ee0d6e5522d0405cc8c7666442d9fcfffecb3f64cd0a436c749cdb
-  data.tar.gz: 77f15148363dab284946c72dbe339cd45a96524ba335e9ae0b6a8bf74b69c5271719d01258bc1125823162ef73cab737fa536ccf6413093f6008976bbc8d2358
+  metadata.gz: 80f9fdac78d1efb10a273c6dda97598107271cd65546323ecbec5b6a32689b868811356121f651e99933ad987f8500156c6eb2402eee31e8d78e16f27b6fc442
+  data.tar.gz: a58998adcbed63db175a6fb76bd8c18ff6a520705a80f605087d230cb9c19380ce4de0482147b9b89e1824fc1b98ed167cfe2bc48af9a530dffa0405c8f848eb

data/.gitignore

@@ -1 +1,29 @@
+*.gem
+*.rbc
+/.config
 /coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/README.md

@@ -1,22 +1,33 @@
-# Simplecov::TeamcitySummary
+# SimpleCov::TeamcitySummary
 
-SimpleCov formatter to present coverage results to TeamCity.
+By default, Teamcity [does not pick up coverage information for Simplecov reports](http://confluence.jetbrains.com/display/TCD8/Code+Coverage). This gem provides you with a quick and easy way to add these statistics to your Teamcity instance.
+
+Per build:
 
 ![See your coverage results in TeamCity](https://raw.github.com/benc/simplecov-teamcity-summary/master/img/coverage_results.png)
 
-## Installation
+Overall coverage statistics:
+
+![Get overall coverage statistics](https://raw.github.com/benc/simplecov-teamcity-summary/master/img/coverage_chart.png)
 
-Add this line to your application's Gemfile:
+With these statistics, you can trigger a build fail if coverage drops below a certain value:
 
-    gem 'simplecov-teamcity-summary'
+![Trigger build failure](https://raw.github.com/benc/simplecov-teamcity-summary/master/img/trigger_build_failure.png)
+
+## Installation
 
-And then execute:
+* Make sure you're depending on SimpleCov v0.8 or greater.
+* Add this line to your application's Gemfile:
 
-    $ bundle
+        gem 'simplecov-teamcity-summary'
+        
+  And then execute:
 
-Or install it yourself as:
+        $ bundle
 
-    $ gem install simplecov-teamcity-summary
+* Or install it yourself as:
+
+        $ gem install simplecov-teamcity-summary
 
 ## Configuration
 
@@ -26,7 +37,7 @@ Or install it yourself as:
   require 'simplecov'
   SimpleCov.start do
     at_exit do
-      Simplecov::Formatter::TeamcitySummaryFormatter.new.format(SimpleCov.result) if ENV['TEAMCITY_VERSION']
+      SimpleCov::Formatter::TeamcitySummaryFormatter.new.format(SimpleCov.result) if ENV['TEAMCITY_VERSION']
     end
   end
 ```
@@ -38,12 +49,12 @@ Create or edit a .simplecov file and include:
 ```ruby
   SimpleCov.profiles.define 'teamcity' do
     at_exit do
-      Simplecov::Formatter::TeamcitySummaryFormatter.new.format(SimpleCov.result) if ENV['TEAMCITY_VERSION']
+      SimpleCov::Formatter::TeamcitySummaryFormatter.new.format(SimpleCov.result) if ENV['TEAMCITY_VERSION']
     end
   end
 ```
 
-Then, start your Simplecov instance like this:
+Then, start your SimpleCov instance like this:
 
 ```ruby
   require 'simplecov'
@@ -52,4 +63,10 @@ Then, start your Simplecov instance like this:
 
 ## License
 
-This is free software, and may be redistributed under the terms of MIT license.
+Copyright (C) 2014 Ben Cochez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/img/CHANGELOG.md

@@ -0,0 +1,12 @@
+v0.1.1
+======
+
+Bugfixes:
+
+* Simplecov is actually spelled SimpleCov.
+* Make sure we're running against a recent SimpleCov installation.
+
+v0.1
+====
+
+Initial release.

data/lib/simplecov-teamcity-summary/formatter.rb

@@ -1,6 +1,9 @@
-require 'simplecov'
+# Ensure we are using a compatible version of SimpleCov
+if Gem::Version.new(SimpleCov::VERSION) < Gem::Version.new("0.8.0")
+  raise RuntimeError, 'The version of SimpleCov you are using is too old. Please update with `gem install simplecov` or `bundle update simplecov`'
+end
 
-module Simplecov::Formatter
+module SimpleCov::Formatter
   class TeamcitySummaryFormatter
     def format(simplecov_results)
       puts format_teamcity(simplecov_results)

data/lib/simplecov-teamcity-summary/version.rb

@@ -1,5 +1,5 @@
-module Simplecov
+module SimpleCov
   module  TeamcitySummary
-    VERSION="0.1.0"
+    VERSION="0.1.1"
   end
 end

data/simplecov-teamcity-summary.gemspec

@@ -5,7 +5,7 @@ require 'simplecov-teamcity-summary/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "simplecov-teamcity-summary"
-  gem.version       = Simplecov::TeamcitySummary::VERSION
+  gem.version       = SimpleCov::TeamcitySummary::VERSION
   gem.authors       = ["Ben Cochez"]
   gem.email         = ["ben@cochezconsult.be"]
   gem.description   = "Simplecov formatter that prints coverage summary information to display in TeamCity."

data/spec/lib/formatter_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Simplecov::Formatter::TeamcitySummaryFormatter do
+describe SimpleCov::Formatter::TeamcitySummaryFormatter do
   describe "#format" do
     before do 
       expect_any_instance_of(described_class).to receive(:format_teamcity).with(:arg).and_return(:return_value)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-teamcity-summary
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ben Cochez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-02 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- img/CHANGELOG.md
+- img/coverage_chart.png
 - img/coverage_results.png
+- img/trigger_build_failure.png
 - lib/simplecov-teamcity-summary.rb
 - lib/simplecov-teamcity-summary/formatter.rb
 - lib/simplecov-teamcity-summary/version.rb