simplecov_badger 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4d774d270c5c09b19d0b976afa8891689ac77680a92212167dae59cf15d21da
-  data.tar.gz: 4b4e434b9b1cb2e831bafa3ff7d4368473472f22328eb508b7637569f203d3d3
+  metadata.gz: 9991e96e26dfbc1c6d14ff8de33827fbf1d7f883d07cdfce17f9b20fae6f0f60
+  data.tar.gz: a65339cc048c2d18b2c8c6242744fa34d359cbf9e6c8b27d3fd3a6b794653020
 SHA512:
-  metadata.gz: 4209b850927d96d06f904c85da2ef3e5c50af3f65fd21332304853f4c76c07018719ec96b25012f660bd7bf264ae417315618bbfdc46320e291e88519b0b9196
-  data.tar.gz: eb998aa4886e38ed871f9f2e4ff513c6741e33ba21fd2804760df250b5af0336389890f9aa2b7480ba979453b2cbdb1ed2762b6ab8f734a241af44b13caa81f5
+  metadata.gz: 873826e79fc30581b8dc9ab531a9776176ab7bd47f02c6c9a0da776f7c92e8620e2f094b27a5c1bfc96aaab6f4718ac29a5990d479838fd3ab531cd5d55ebe9d
+  data.tar.gz: 44bff7625e2704e2e4ef3981bc379a0467bef03c95332e45c89e386dd56cff21bc5c76bae7d87bd1fb4dced8efb12ca252282fec55eaffc1c07ded4368e67d96

data/README.md

@@ -1,4 +1,4 @@
-# SimplecovBadger
+# SimpleCov::Badger
 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
@@ -21,14 +21,14 @@ Or install it yourself as:
 
 ## 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`:
+There are very few things to do, before you can use the gem. The only necessary setup is to add the `SimpleCov::Badger::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
+      SimpleCov::Badger::Formatter # <-- this one
     ]
   )
 end
@@ -41,15 +41,15 @@ The gem comes with a standard configuration. If you want to override any of thes
 
 ```ruby
 # this is the standard configuration
-SimplecovBadger.configure do |config|
+SimpleCov::Badger.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" }
+  config.repo_url = `git config --get remote.origin.url`,
+  config.run_if = -> { `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.
+The `repo_url` defaults to the git repo's origin url.
+The `run_if` 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
 

data/lib/simplecov_badger.rb

@@ -4,14 +4,16 @@ require "simplecov_badger/configuration"
 require "base64"
 require "rest-client"
 
-module SimplecovBadger
-  class Error < StandardError; end
+module SimpleCov
+  module Badger
+    class Error < StandardError; end
 
-  def self.configure
-    yield configuration
-  end
+    def self.configure
+      yield configuration
+    end
 
-  def self.configuration
-    @configuration ||= Configuration.new
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
   end
 end

data/lib/simplecov_badger/configuration.rb

@@ -1,24 +1,19 @@
-module SimplecovBadger
-  class Configuration
+module SimpleCov::Badger
+  class Configuration < OpenStruct
     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" }
+        repo_url: `git config --get remote.origin.url`,
+        run_if: -> { `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) }
+    def initialize
+      super(self.class.options)
     end
 
     def encoded_repo_url
-      raise SimplecovBadger::Error, "repo_url is nil" if repo_url.nil?
+      raise SimpleCov::Badger::Error, "repo_url is nil" if repo_url.nil?
 
       Base64.urlsafe_encode64(repo_url)
     end

data/lib/simplecov_badger/formatter.rb

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

data/lib/simplecov_badger/version.rb

@@ -1,3 +1,5 @@
-module SimplecovBadger
-  VERSION = "0.0.1"
+module SimpleCov
+  module Badger
+    VERSION = "0.0.2"
+  end
 end

data/simplecov_badger.gemspec

@@ -2,12 +2,12 @@ require_relative 'lib/simplecov_badger/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "simplecov_badger"
-  spec.version       = SimplecovBadger::VERSION
+  spec.version       = SimpleCov::Badger::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.description   = %q{A small gem that posts simplecovs test coverage to a web service. We've built a web service for rendering coverage badge svgs too. You can find it at coverage.traels.it}
   spec.homepage      = "https://github.com/traels-it/simplecov_badger"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov_badger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nicolai Bach Woller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -66,7 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.11.2
-description: A small gem that posts simplecovs test coverage to a web service.
+description: A small gem that posts simplecovs test coverage to a web service. We've
+  built a web service for rendering coverage badge svgs too. You can find it at coverage.traels.it
 email:
 - woller@traels.it
 executables: []