simplecov_badger 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fa869a8744a6c7f94d5564afc859c6888cc42a3cf8a91bfba008ed12aaba7dc
-  data.tar.gz: 9d103c4beff16789532b79cd24f1a5f24ed2097ba8eb9cd3815be038579aab41
+  metadata.gz: 479b075da95d9e0caa5cbab73f912960d382942c62e4cc82ce379b2d12d552a7
+  data.tar.gz: fe331af0e9bbe7aabc3959bfdfee40d317bdca65195673b10822bb791d272c64
 SHA512:
-  metadata.gz: 6d82cf9b5d6ec555bab27369ad83e7711e7d3a6056820067d4f4bf1990b293fac1c70f49604ea4d5628e9090e3645f26cf0f897478352cfac30a8a0abdc5b14f
-  data.tar.gz: '05832ea232b03c07c7d82666665af8f3c6c6fb6bab36c8e8080afa0916693959894b7ac99095761a9fdd8a9751334fdca64f9fd811b1374dd709227237cc6df7'
+  metadata.gz: d0f3b631ae5eaf2fd85dfbf16cef1f5a56304048112467f6fdd4aad7c1858c8b955fbec07c0cb1310438176eff0b2578e3f119d318341118b7cce50f673cbc79
+  data.tar.gz: 62c4ff8422f7f36549ae2e18d4299f98d862d55ae748f03525cf6b747e3f5c7387926c9a353e396bf99845322080aadd9aa4f9003b767f57396660dd20929707

data/.semaphore/semaphore.yml

@@ -0,0 +1,45 @@
+version: v1.0
+name: build
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+auto_cancel:
+  running:
+    when: 'true'
+blocks:
+  - name: Tests
+    task:
+      jobs:
+      - name: Ruby 2.7
+        commands:
+          - checkout
+          - sem-version ruby 2.7
+          - cache restore
+          - bundle install --path vendor/bundle
+          - cache store
+          - bundle exec rake test
+      - name: Ruby 3.0
+        commands:
+          - checkout
+          - sem-version ruby 3.0
+          - cache restore
+          - bundle install --path vendor/bundle
+          - cache store
+          - bundle exec rake test
+      - name: Ruby 3.1
+        commands:
+          - checkout
+          - sem-version ruby 3.1
+          - cache restore
+          - bundle install --path vendor/bundle
+          - cache store
+          - bundle exec rake test
+      - name: Ruby 3.2
+        commands:
+          - checkout
+          - sem-version ruby 3.2
+          - cache restore
+          - bundle install --path vendor/bundle
+          - cache store
+          - bundle exec rake test

data/Gemfile

@@ -4,5 +4,5 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 12.0"
-gem "minitest", "~> 5.0"
-
+gem "minitest", "~> 5.18.0"
+gem "debug"

data/Gemfile.lock

@@ -1,49 +1,60 @@
 PATH
   remote: .
   specs:
-    simplecov_badger (0.0.3)
+    simplecov_badger (0.0.4)
       rest-client (~> 2.1.0)
-      simplecov (~> 0.18.5)
+      simplecov (>= 0.18.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    docile (1.3.2)
+    debug (1.7.2)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    docile (1.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     http-accept (1.7.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
+    io-console (0.6.0)
+    irb (1.6.4)
+      reline (>= 0.3.0)
     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 (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    minitest (5.14.0)
+    mime-types-data (3.2023.0218.1)
+    minitest (5.18.0)
     mocha (1.11.2)
     netrc (0.11.0)
     rake (12.3.3)
+    reline (0.3.3)
+      io-console (~> 0.5)
     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)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.7)
+    unf_ext (0.0.8.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  debug
   m (~> 1.5.1)
-  minitest (~> 5.0)
+  minitest (~> 5.18.0)
   mocha (~> 1.11.2)
   rake (~> 12.0)
   simplecov_badger!

data/README.md

@@ -1,14 +1,16 @@
 # 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
+The badge can then be used in your readme.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile in the test, development group:
 
 ```ruby
-gem 'simplecov_badger'
+group :development, :test do
+  gem 'simplecov_badger'
+end
 ```
 
 And then execute:
@@ -19,11 +21,18 @@ Or install it yourself as:
 
     $ gem install simplecov_badger
 
+Then run
+
+    $ bundle exec rake simplecov_badger:install
+
 ## Usage
 
 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
+require "simplecov"
+require "simplecov_badger"
+
 SimpleCov.start do
   SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
     [
@@ -34,22 +43,46 @@ SimpleCov.start do
 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)]
+And then setting the token you received from the install rake task in an env somewhere, for example by using the [dotenv](https://rubygems.org/gems/dotenv) gem:
+
+If you use rails we recommend setting the token in the [credentials](https://guides.rubyonrails.org/security.html#custom-credentials) instead and conf.
+```ruby
+# in config/initializers/simplecov_badger.rb
+if Module.const_defined? "SimpleCov"
+  SimpleCov::Badger.configure do |config|
+    config.token = Rails.application.credentials.simplecov_badger[:token]
+  end
+end
+```
+
+After running your test suite on your master branch, a url for your badge will be printed in the console.
 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:
+The gem comes with a standard configuration. If you want to override any of these settings, it can be done like this:
 
 ```ruby
 # this is the standard configuration
 SimpleCov::Badger.configure do |config|
   config.post_url = "coverage.traels.it/badges",
-  config.repo_url = `git config --get remote.origin.url`,
+  config.repo_url = `git config --get remote.origin.url`.strip,
   config.run_if = -> { `git rev-parse --abbrev-ref HEAD` == "master\n" }
+  config.token = ENV["SIMPLECOV_BADGER_TOKEN"]
 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 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.
+`token` is used when updating your badge with a new coverage. It defaults to reading from an env variable. When running the install rake task, a token is saved at your projects root in a file called `.simplecov_badger_auth_token`. It is recommended to set this token as an env variable, when not running Rails. If you do use Rails, set the token in your test credentials and configure to read from there instead. Should you lose your token, there is currently no recovery process, but you can configure your repo_url to something else and run the install task again to get a new token.
+
+Now every time your test suites is run on your master branch, a new badge is generated. A link to this badge can be found in the test output
+```shell
+  SimpleCov::Badger: Your badge can be found at: https://coverage.traels.it/badges/some_base_64_encoded_string
+```
+Using markdown, the badge can be inserted like this:
+```markdown
+  ![SimpleCov coverage](https://coverage.traels.it/badges/some_base_64_encoded_string)
+```
+
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,9 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/lib/simplecov_badger/*.rake").each { |f| import f }
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"

data/lib/simplecov_badger/configuration.rb

@@ -3,8 +3,9 @@ module SimpleCov::Badger
     def self.options
       {
         post_url: "https://coverage.traels.it/badges",
-        repo_url: `git config --get remote.origin.url`,
-        run_if: -> { `git rev-parse --abbrev-ref HEAD` == "master\n" }
+        repo_url: `git config --get remote.origin.url`.strip,
+        run_if: -> { `git rev-parse --abbrev-ref HEAD` == "master\n" },
+        token: ENV["SIMPLECOV_BADGER_TOKEN"]
       }
     end
 
@@ -17,5 +18,9 @@ module SimpleCov::Badger
 
       Base64.urlsafe_encode64(repo_url)
     end
+
+    def badge_url
+      "#{post_url}/#{encoded_repo_url}"
+    end
   end
 end

data/lib/simplecov_badger/formatter.rb

@@ -9,10 +9,12 @@ module SimpleCov::Badger
 
     def format(result)
       if config.run_if.call
-        RestClient.post(
-          config.post_url,
-          { percentage: result.source_files.covered_percent.round(2), repo_url: config.encoded_repo_url }
+        RestClient.patch(
+          config.badge_url,
+          { percentage: result.source_files.covered_percent.round(2), token: config.token }
         )
+
+        puts "SimpleCov::Badger: Your badge can be found at: #{config.badge_url}"
       end
     end
   end

data/lib/simplecov_badger/install.rake

@@ -0,0 +1,32 @@
+desc "Create the initial badge and save an authentication token in a file"
+namespace :simplecov_badger do
+  task install: :environment do
+    require "simplecov_badger"
+    require "json"
+
+    config = SimpleCov::Badger.configuration
+
+    begin
+      response = RestClient.post(
+        config.post_url,
+        { repo_url: config.encoded_repo_url }
+      )
+      File.write("#{project_root}/.simplecov_badger_auth_token", JSON.parse(response.body)["token"])
+    rescue => exception
+      puts exception.response
+      puts exception.response.body
+    end
+  end
+
+  def project_root
+    if defined?(Rails)
+      return Rails.root
+    end
+
+    if defined?(Bundler)
+      return Bundler.root
+    end
+
+    Dir.pwd
+  end
+end

data/lib/simplecov_badger/railtie.rb

@@ -0,0 +1,11 @@
+require "rails"
+require "simplecov_badger"
+require "pathname"
+
+class SimpleCov::Badger::Railtie < Rails::Railtie
+  railtie_name :simplecov_badger
+
+  rake_tasks do
+    load Pathname.new(__dir__).join("install.rake")
+  end
+end

data/lib/simplecov_badger/version.rb

@@ -1,5 +1,5 @@
 module SimpleCov
   module Badger
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
   end
 end

data/lib/simplecov_badger.rb

@@ -3,6 +3,7 @@ require "simplecov_badger/formatter"
 require "simplecov_badger/configuration"
 require "base64"
 require "rest-client"
+require "simplecov_badger/railtie" if defined?(Rails)
 
 module SimpleCov
   module Badger

data/simplecov_badger.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # dependencies
-  spec.add_dependency "simplecov", "~> 0.18.5"
+  spec.add_dependency "simplecov", ">= 0.18.5"
   spec.add_dependency "rest-client", "~> 2.1.0"
 
   spec.add_development_dependency "m", "~> 1.5.1"

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: simplecov_badger
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Nicolai Bach Woller
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2023-04-20 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
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".semaphore/semaphore.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -86,6 +87,8 @@ files:
 - lib/simplecov_badger.rb
 - lib/simplecov_badger/configuration.rb
 - lib/simplecov_badger/formatter.rb
+- lib/simplecov_badger/install.rake
+- lib/simplecov_badger/railtie.rb
 - lib/simplecov_badger/version.rb
 - simplecov_badger.gemspec
 homepage: https://github.com/traels-it/simplecov_badger
@@ -94,7 +97,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/traels-it/simplecov_badger
   source_code_uri: https://github.com/traels-it/simplecov_badger
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A small gem that posts simplecovs test coverage to a web service.
 test_files: []