simplecov-teamcity-summary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f34f987c80b2378d7677c873c11eb4a32891964e
+  data.tar.gz: a1a1ab8d83aa9b5cc5cd35a3a0100bfc49ca3458
+SHA512:
+  metadata.gz: a8ab0d1f819851d352221bf6cc3b00427a98c199f37e0f4d83110b530548732c80474b2c66ee0d6e5522d0405cc8c7666442d9fcfffecb3f64cd0a436c749cdb
+  data.tar.gz: 77f15148363dab284946c72dbe339cd45a96524ba335e9ae0b6a8bf74b69c5271719d01258bc1125823162ef73cab737fa536ccf6413093f6008976bbc8d2358

data/.gitignore

@@ -0,0 +1 @@
+/coverage/

data/.simplecov

@@ -0,0 +1,5 @@
+SimpleCov.profiles.define 'teamcity' do
+  at_exit do
+    Simplecov::Formatter::TeamcitySummaryFormatter.new.format(SimpleCov.result) if ENV['TEAMCITY_VERSION']
+  end
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    simplecov-teamcity-summary (0.1.0)
+      simplecov
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.2)
+    method_source (0.8.2)
+    multi_json (1.8.4)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  pry
+  rake
+  rspec
+  simplecov-teamcity-summary!

data/LICENSE

@@ -0,0 +1,7 @@
+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/README.md

@@ -0,0 +1,55 @@
+# Simplecov::TeamcitySummary
+
+SimpleCov formatter to present coverage results to TeamCity.
+
+![See your coverage results in TeamCity](https://raw.github.com/benc/simplecov-teamcity-summary/master/img/coverage_results.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simplecov-teamcity-summary'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simplecov-teamcity-summary
+
+## Configuration
+
+### When starting Simplecov
+
+```ruby
+  require 'simplecov'
+  SimpleCov.start do
+    at_exit do
+      Simplecov::Formatter::TeamcitySummaryFormatter.new.format(SimpleCov.result) if ENV['TEAMCITY_VERSION']
+    end
+  end
+```
+
+### Using a Simplecov profile
+
+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']
+    end
+  end
+```
+
+Then, start your Simplecov instance like this:
+
+```ruby
+  require 'simplecov'
+  SimpleCov.start 'teamcity'
+```
+
+## License
+
+This is free software, and may be redistributed under the terms of MIT license.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new(:spec)
+

data/lib/simplecov-teamcity-summary.rb

@@ -0,0 +1 @@
+require 'simplecov-teamcity-summary/formatter'

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

@@ -0,0 +1,20 @@
+require 'simplecov'
+
+module Simplecov::Formatter
+  class TeamcitySummaryFormatter
+    def format(simplecov_results)
+      puts format_teamcity(simplecov_results)
+    end
+
+    def format_teamcity(simplecov_results)
+      <<-eos
+
+##teamcity[blockOpened name='Code Coverage Summary']
+##teamcity[buildStatisticValue key='CodeCoverageL' value='#{simplecov_results.covered_percent}']
+##teamcity[buildStatisticValue key='CodeCoverageAbsLCovered' value='#{simplecov_results.covered_lines}']
+##teamcity[buildStatisticValue key='CodeCoverageAbsLTotal' value='#{simplecov_results.total_lines}']
+##teamcity[blockClosed name='Code Coverage Summary']
+      eos
+    end
+  end
+end

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

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

data/simplecov-teamcity-summary.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simplecov-teamcity-summary/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simplecov-teamcity-summary"
+  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."
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/benc/simplecov-teamcity-summary"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/).reject do |filename|
+    filename.match(/^vendor\/cache/) || filename.match(/^doc/) || filename.match(/^.yardoc/)
+  end
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'bundler', '~> 1.3'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_dependency 'simplecov'
+end

data/spec/lib/formatter_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+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)
+      expect_any_instance_of(described_class).to receive(:puts).with(:return_value)
+    end
+    subject { described_class.new.format(:arg) }
+    it { expect(subject).to be_nil }
+  end
+  
+  describe "#format_teamcity" do
+    let(:simplecov_result) { OpenStruct.new({covered_percent: '12.34567', covered_lines: '1234', total_lines: '5678' })}
+    let(:open_block) { "##teamcity[blockOpened name='Code Coverage Summary']" }
+    let(:coverage_percent) { "##teamcity[buildStatisticValue key='CodeCoverageL' value='12.34567']" }
+    let(:covered_lines) { "##teamcity[buildStatisticValue key='CodeCoverageAbsLCovered' value='1234']" }
+    let(:total_lines) { "##teamcity[buildStatisticValue key='CodeCoverageAbsLTotal' value='5678']" }
+    let(:close_block) { "##teamcity[blockClosed name='Code Coverage Summary']" }
+
+    subject { described_class.new.format_teamcity(simplecov_result) }
+
+    it { expect(subject).to include(open_block) }
+    it { expect(subject).to include(coverage_percent) }
+    it { expect(subject).to include(covered_lines) }
+    it { expect(subject).to include(total_lines) }
+    it { expect(subject).to include(close_block) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start 'teamcity'
+
+require 'simplecov-teamcity-summary'
+require 'pry'
+
+support_path = File.expand_path("spec/support")
+Dir["#{support_path}/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-teamcity-summary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Cochez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simplecov formatter that prints coverage summary information to display
+  in TeamCity.
+email:
+- ben@cochezconsult.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".simplecov"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- img/coverage_results.png
+- lib/simplecov-teamcity-summary.rb
+- lib/simplecov-teamcity-summary/formatter.rb
+- lib/simplecov-teamcity-summary/version.rb
+- simplecov-teamcity-summary.gemspec
+- spec/lib/formatter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/benc/simplecov-teamcity-summary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Simplecov formatter that prints coverage summary information to display in
+  TeamCity.
+test_files:
+- spec/lib/formatter_spec.rb
+- spec/spec_helper.rb