simplecov_badger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4d774d270c5c09b19d0b976afa8891689ac77680a92212167dae59cf15d21da
+  data.tar.gz: 4b4e434b9b1cb2e831bafa3ff7d4368473472f22328eb508b7637569f203d3d3
+SHA512:
+  metadata.gz: 4209b850927d96d06f904c85da2ef3e5c50af3f65fd21332304853f4c76c07018719ec96b25012f660bd7bf264ae417315618bbfdc46320e291e88519b0b9196
+  data.tar.gz: eb998aa4886e38ed871f9f2e4ff513c6741e33ba21fd2804760df250b5af0336389890f9aa2b7480ba979453b2cbdb1ed2762b6ab8f734a241af44b13caa81f5

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simplecov_badger.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    simplecov_badger (0.0.1)
+      rest-client (~> 2.1.0)
+      simplecov (~> 0.18.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.3.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    m (1.5.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    minitest (5.14.0)
+    mocha (1.11.2)
+    netrc (0.11.0)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  m (~> 1.5.1)
+  minitest (~> 5.0)
+  mocha (~> 1.11.2)
+  rake (~> 12.0)
+  simplecov_badger!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Nicolai Bach Woller
+
+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,67 @@
+# SimplecovBadger
+This gem is a formatter for SimpleCov. It sends the total test coverage from SimpleCov to a url via a post request.
+It is heavily inspired by the formatter in MarcGrimme's simplecov-small-badge: https://github.com/MarcGrimme/simplecov-small-badge
+The gem is connected with our simplecov badge service for rendering badge .svgs. See more at: https://coverage.traels.it
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplecov_badger'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simplecov_badger
+
+## Usage
+
+There are very few things to do, before you can use the gem. The only necessary setup is to add the `SimplecovBadger::Formatter` to `SimpleCov`'s formatters in the same place you start `SimpleCov`:
+
+```ruby
+SimpleCov.start do
+  SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+    [
+      SimpleCov::Formatter::HTMLFormatter,
+      SimplecovBadger::Formatter # <-- this one
+    ]
+  )
+end
+```
+
+After running your test suite on your master branch, you can find a badge on the url https://coverage.traels.it/badges/[Base64.urlsafe_encode64(your_repo_url)]
+Subsequent runs will update the badge on the same url.
+
+The gem comes with a standard configuration. If you want to override any of these (three) settings, it can be done like this:
+
+```ruby
+# this is the standard configuration
+SimplecovBadger.configure do |config|
+  config.post_url = "coverage.traels.it/badges",
+  config.repo_url = `git remote -v`.split(" ")[1],
+  config.run_when = -> { `git rev-parse --abbrev-ref HEAD` == "master\n" }
+end
+```
+Changing the `post_url` changes where the gem posts the coverage to and as a result you will have to make a service for drawing badges yourself.
+The `repo_url` defaults to the git remote of the project you work on.
+The `run_when` defaults to a lambda, that returns true if your current branch is master. This means the badge is only updated, when the test suite is run on the master branch. If replaced, it should be with another lambda that returns true whenever you want the badge updated.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/traels-it/simplecov_badger
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simplecov/post/formatter"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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

data/lib/simplecov_badger.rb

@@ -0,0 +1,17 @@
+require "simplecov_badger/version"
+require "simplecov_badger/formatter"
+require "simplecov_badger/configuration"
+require "base64"
+require "rest-client"
+
+module SimplecovBadger
+  class Error < StandardError; end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/simplecov_badger/configuration.rb

@@ -0,0 +1,26 @@
+module SimplecovBadger
+  class Configuration
+    def self.options
+      {
+        post_url: "coverage.traels.it/badges",
+        repo_url: `git remote -v`.split(" ")[1],
+        run_when: -> { `git rev-parse --abbrev-ref HEAD` == "master\n" }
+      }
+    end
+
+    options.keys.each do |opt|
+      define_method(opt) { instance_variable_get "@#{opt}" }
+      define_method("#{opt}=") { |val| instance_variable_set("@#{opt}", val) }
+    end
+
+    def initialize(**opts)
+      SimplecovBadger::Configuration.options.merge(opts).each { |opt, v| send(:"#{opt}=", v) }
+    end
+
+    def encoded_repo_url
+      raise SimplecovBadger::Error, "repo_url is nil" if repo_url.nil?
+
+      Base64.urlsafe_encode64(repo_url)
+    end
+  end
+end

data/lib/simplecov_badger/formatter.rb

@@ -0,0 +1,19 @@
+module SimplecovBadger
+  class Formatter
+    attr_reader :config
+
+    def initialize(output = nil)
+      @output = output || STDOUT
+      @config = SimplecovBadger.configuration
+    end
+
+    def format(result)
+      if config.run_when.call
+        RestClient.post(
+          config.post_url,
+          { percentage: result.source_files.covered_percent.round(2), repo_url: config.encoded_repo_url }
+        )
+      end
+    end
+  end
+end

data/lib/simplecov_badger/version.rb

@@ -0,0 +1,3 @@
+module SimplecovBadger
+  VERSION = "0.0.1"
+end

data/simplecov_badger.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/simplecov_badger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplecov_badger"
+  spec.version       = SimplecovBadger::VERSION
+  spec.authors       = ["Nicolai Bach Woller"]
+  spec.email         = ["woller@traels.it"]
+
+  spec.summary       = %q{A small gem that posts simplecovs test coverage to a web service.}
+  spec.description   = %q{A small gem that posts simplecovs test coverage to a web service.}
+  spec.homepage      = "https://github.com/traels-it/simplecov_badger"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # dependencies
+  spec.add_dependency "simplecov", "~> 0.18.5"
+  spec.add_dependency "rest-client", "~> 2.1.0"
+
+  spec.add_development_dependency "m", "~> 1.5.1"
+  spec.add_development_dependency "mocha", "~> 1.11.2"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: simplecov_badger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicolai Bach Woller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+description: A small gem that posts simplecovs test coverage to a web service.
+email:
+- woller@traels.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simplecov_badger.rb
+- lib/simplecov_badger/configuration.rb
+- lib/simplecov_badger/formatter.rb
+- lib/simplecov_badger/version.rb
+- simplecov_badger.gemspec
+homepage: https://github.com/traels-it/simplecov_badger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/traels-it/simplecov_badger
+  source_code_uri: https://github.com/traels-it/simplecov_badger
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A small gem that posts simplecovs test coverage to a web service.
+test_files: []