coverage-kit 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2c2fc78865b3c2b6ff3f0a8e89d8d09f567228a2
-  data.tar.gz: 3f3645c8bbeb601acbf45cdc0ada8489b2b5c580
+SHA256:
+  metadata.gz: a3766aefe8131b22cbf33155c807154ca1c7cf1553a93a2683e34b4a1b793fc3
+  data.tar.gz: 9cf28490a94fe2cc00d2f257413a23f71fb80d77d195695efe81cae8a9dfc8fb
 SHA512:
-  metadata.gz: 92817b8bb56598e7ef9911a8eeda5f059b9ad1f67093bbfd9becaa5e0ddee4e4259825d8427750f7720d41068a708d2cfb8e3f12d0bcb31cb0bdd80d0dc6d87e
-  data.tar.gz: 9cdc9791e84e951c781480bbde6b1469b7a7399678382a0591c688fb6031a1055c352176a28f4dea5d2b0a852ba3940269211eeb799040787834d890e1326d44
+  metadata.gz: 69ebb3c591a8c6934563266f98e807b915923833e28055605ce438b4a768f9087f3851ab25394cd89e3fe239255a7102d54d68678dd59dc9f51596741d853bac
+  data.tar.gz: 2aafb81120d0723a72dc15cd70b19ecb69037e050ea17f7e494842b7af58c442c6f544e564fb8a2696617bbdcd7a557cd24ed5b63b7a8d2e5c9354288f4740a9

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+All notable changes to this project will be documented in this file.  
+This project adheres to [Semantic Versioning](http://semver.org/).  
+This changelog adheres to [Keep a CHANGELOG](http://keepachangelog.com/).  
+
+## 0.3.0
+
+- [PLAT-172] Remove coveralls from the gem as its not longer required use simplecov-lcov instead.
+- [PLAT-176] Use the standardrb linter
+
+## 0.2.0
+
+- [TT-8639] Update to build with github actions / ruby 3.0
+- [TT-1392] Changelog file

data/README.md

@@ -1,15 +1,29 @@
-# Coverage::Kit
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/coverage-kit.svg)](http://badge.fury.io/rb/coverage-kit)
+[![Build Status](https://github.com/sealink/coverage-kit/workflows/Build%20and%20Test/badge.svg?branch=master)](https://github.com/sealink/coverage-kit/actions)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/coverage/kit`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Purpose
 
-TODO: Delete this and the text above, and describe your gem
+The purpose of this gem is to provide a common setup for simplecov when used
+for publicly released gems.
+
+By default it will generate lcov format in CI mode (useful for Coveralls) and
+a html based report in standard development mode.
+
+It also configures SimpleCov to enforce a minimum defined coverage percentage.
+It also adds an additional check to ensure the coverage has not crept up too much (0.5%)
+
+## Coveralls
+
+An coveralls compatible lcov file is generated in CI mode, this can be published
+with an github action (https://github.com/marketplace/actions/coveralls-github-action)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'coverage-kit'
+gem 'coverage-kit', require: false
 ```
 
 And then execute:
@@ -22,7 +36,12 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add to your `spec_helper.rb` file or equivalent
+```
+require 'coverage/kit'
+
+Coverage::Kit.setup(minimum_coverage: 69.95)
+```
 
 ## Development
 
@@ -38,4 +57,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/coverage-kit.gemspec

@@ -1,31 +1,28 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 # coding: utf-8
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'coverage/kit/version'
+require "coverage/kit/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "coverage-kit"
-  spec.version       = Coverage::Kit::VERSION
-  spec.authors       = ["Michael Noack"]
-  spec.email         = ["support@travellink.com.au"]
+  spec.name = "coverage-kit"
+  spec.version = Coverage::Kit::VERSION
+  spec.authors = ["Michael Noack"]
+  spec.email = ["support@travellink.com.au"]
 
-  spec.summary       = %q{Helper to setup good coverage for tests}
-  spec.description   = %q{Helper to setup good coverage for tests}
-  spec.homepage      = "https://github.com/sealink/coverage-kit"
-  spec.license       = "MIT"
+  spec.summary = "Helper to setup good coverage for tests"
+  spec.description = "Helper to setup good coverage for tests"
+  spec.homepage = "https://github.com/sealink/coverage-kit"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files = Dir["CHANGELOG.md", "README.md", "coverage-kit.gemspec", "lib/**/*"]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "simplecov"
+  spec.add_dependency "simplecov-lcov"
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov-rcov"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov-lcov"
+  spec.add_development_dependency "standard"
 end

data/lib/coverage/kit/version.rb

@@ -1,5 +1,5 @@
 module Coverage
   module Kit
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/coverage/kit.rb

@@ -1,31 +1,41 @@
 require "coverage/kit/version"
+require "simplecov"
+require "simplecov-lcov"
 
 module Coverage
   module Kit
-    def self.setup(minimum_coverage: )
-      return if ENV['COVERAGE'] == 'off'
+    def self.setup(minimum_coverage:)
+      return if ENV["COVERAGE"] == "off"
 
       @minimum_coverage = minimum_coverage
       @maximum_coverage = @minimum_coverage + 0.5
 
-      require 'simplecov'
-      Coveralls.wear! if defined?(Coveralls)
+      SimpleCov.start do
+        if ENV["CI"]
+          SimpleCov::Formatter::LcovFormatter.config do |c|
+            c.report_with_single_file = true
+            c.single_report_path = "coverage/lcov.info"
+          end
+          formatter SimpleCov::Formatter::LcovFormatter
+        else
+          formatter SimpleCov::Formatter::MultiFormatter.new([
+            SimpleCov::Formatter::SimpleFormatter,
+            SimpleCov::Formatter::HTMLFormatter
+          ])
+        end
 
-      formatters = []
-      formatters << SimpleCov::Formatter::RcovFormatter if defined?(SimpleCov::Formatter::RcovFormatter)
-      formatters << Coveralls::SimpleCov::Formatter if defined?(Coveralls)
-      SimpleCov.formatters = formatters
+        enable_coverage :branch
 
-      SimpleCov.start do
-        add_filter '/vendor/'
-        add_filter '/config/'
-        add_filter '/spec/'
-        add_group 'lib', 'lib'
+        add_filter "/vendor/"
+        add_filter "/config/"
+        add_filter "/spec/"
+        add_group "lib", "lib"
       end
+
       SimpleCov.at_exit do
         SimpleCov.result.format!
         percent = SimpleCov.result.covered_percent
-        puts "Coverage is #{'%.2f' % percent} (min: #{@minimum_coverage})"
+        puts "Coverage is #{"%.2f" % percent} (min: #{@minimum_coverage})"
         if percent < @minimum_coverage
           puts "Coverage must be above #{@minimum_coverage}"
           Kernel.exit(1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coverage-kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Noack
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -24,50 +24,64 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov-rcov
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,15 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
+- CHANGELOG.md
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - coverage-kit.gemspec
 - lib/coverage/kit.rb
 - lib/coverage/kit/version.rb
@@ -132,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.3.0.dev
 signing_key: 
 specification_version: 4
 summary: Helper to setup good coverage for tests

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.5
-before_install: gem install bundler -v 1.13.1

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in coverage-kit.gemspec
-gemspec

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Michael Noack
-
-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/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "coverage/kit"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here