simplecov-shields-badge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec4d6437f0c063c2a9f3ef8e70d250ced0e43a81
+  data.tar.gz: dc1bc6c5c9ab60be49c05603dc5f8900be94f005
+SHA512:
+  metadata.gz: 651751b119030417bf7164302e7db8ecd7e04e9953845446b6b5859b98e3f8cc9342c4007c6bc31751aa7f4691d901f5b487a20488442688d3a5563a4b0ff156
+  data.tar.gz: 1c7b5bf514e231f107fb648bf1d78ec0c8fbaa83bb25faa624466f7c81dcb25398137f7520943e031f9c3cf78562b9bbb4ce62ff5c98ce0c58448029dde4e8d1

data/lib/shields_badge.rb

@@ -0,0 +1,58 @@
+module SimpleCov
+  module Formatter
+    class ShieldsBadge
+      VERSION = "0.1.0"
+
+      def format(result)
+        coverage = result.covered_percent
+        generate_badge(coverage)
+        upload_to_gh_pages
+      end
+
+      private
+
+      def generate_badge(coverage)
+        %x(curl #{badge_url(coverage)} > badge.svg)
+      end
+
+      def badge_url(coverage)
+        color = coverage_color(coverage)
+        "https://img.shields.io/badge/coverage-#{coverage.round(2)}%25-#{color}.svg"
+      end
+
+      def coverage_color(coverage)
+        case coverage
+        when 0..20 then :red
+        when 20..40 then :orange
+        when 40..60 then :yellow
+        when 60..80 then :yellowgreen
+        when 80..90 then :green
+        else :brightgreen
+        end
+      end
+
+      def upload_to_gh_pages
+        github_user  = ENV["GITHUB_USER"]
+        github_mail  = ENV["GITHUB_MAIL"]
+        github_org   = ENV["GITHUB_ORG"]
+        github_repo  = ENV["GITHUB_REPO"]
+        github_token = ENV["GITHUB_ACCESS_TOKEN"]
+
+        return unless (github_user and github_mail and github_org and github_repo and github_token)
+
+        %x(mv badge.svg ../)
+        %x(git remote remove upstream)
+        %x(git remote add upstream 'https://#{github_token}@github.com/#{github_org}/#{github_repo}.git' > /dev/null 2> /dev/null)
+        %x(git config --global user.name #{github_user})
+        %x(git config --global user.email #{github_mail})
+        %x(git fetch upstream)
+        %x(git checkout gh-pages -f)
+        %x(git reset -- .)
+        %x(mv ../badge.svg .)
+        %x(git add badge.svg)
+        %x(git commit -a -m 'CI: Coverage for $COMMIT_ID')
+        %x(git push upstream gh-pages:gh-pages)
+      end
+    end
+  end
+end

data/test/test_shields_badge.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+class TestShieldsBadge < Minitest::Test
+  def test_defined
+    assert defined?(SimpleCov::Formatter::ShieldsBadge)
+    assert defined?(SimpleCov::Formatter::ShieldsBadge::VERSION)
+  end
+
+  def stub_file(filename, coverage)
+    lines = coverage.each_with_index.map do |cov, i|
+      skipped = false
+      if cov == :skipped
+        skipped = true
+        cov = 0
+      end
+      stub('SimpleCov::SourceFile::Line', skipped?: skipped, line_number: i+1, coverage: cov)
+    end
+    stub('SimpleCov::SourceFile', filename: filename, lines: lines)
+  end
+
+  def test_badge_svg_is_generated
+    formatter = SimpleCov::Formatter::ShieldsBadge.new
+
+    result = stub('SimpleCov::Result', covered_percent: 0)
+    formatter.format(result)
+    assert_equal(true, File.exist?('badge.svg'))
+  end
+
+  def test_right_badge_color
+    formatter = SimpleCov::Formatter::ShieldsBadge.new
+    assert_equal(:red, formatter.send(:coverage_color, 0))
+    assert_equal(:red, formatter.send(:coverage_color, 20))
+    assert_equal(:orange, formatter.send(:coverage_color, 21))
+    assert_equal(:orange, formatter.send(:coverage_color, 40))
+    assert_equal(:yellow, formatter.send(:coverage_color, 41))
+    assert_equal(:yellow, formatter.send(:coverage_color, 60))
+    assert_equal(:yellowgreen, formatter.send(:coverage_color, 61))
+    assert_equal(:yellowgreen, formatter.send(:coverage_color, 80))
+    assert_equal(:green, formatter.send(:coverage_color, 81))
+    assert_equal(:green, formatter.send(:coverage_color, 90))
+    assert_equal(:brightgreen, formatter.send(:coverage_color, 91))
+    assert_equal(:brightgreen, formatter.send(:coverage_color, 100))
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-shields-badge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nilton Vasques
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+description: Shields Badget Simplecov Formatter
+email:
+- nilton.vasques@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/shields_badge.rb
+- test/test_shields_badge.rb
+homepage: https://github.com/niltonvasques/simplecov-shields-badge
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A gem to generate a badge from simplecov coverage result, using shields.io
+  platform and publish the badge to gh-pages
+test_files:
+- test/test_shields_badge.rb