simplecov-formatter-shield 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d9af30c1ea9d6f6a09b5032fc48eeb1cb576205
+  data.tar.gz: 870f33e6bd8bf7d9c8da56d7ab8439d41ad6b3a9
+SHA512:
+  metadata.gz: 7f541abcf220aa0509196efd70bf32094238309cf4df7f4951155d22317d256bdf229fe92cab3aabe1aafe936baef6481c1208d0462d4a991fa3ebb389c23e1f
+  data.tar.gz: 933f2243883dcbb09bdd97f77855d53419def70cfce19b09977ff35e8d0eaa07bbef1b9c32ef4c5a3d3f3794dd842ec4da773ae2439aa8829cb8413e8fc4ff65

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,66 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Max: 500
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Metrics/PerceivedComplexity:
+  Max: 13
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Metrics/ClassLength:
+  Max: 200
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/DefWithParentheses:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  IndentOneStep: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nicolas Pepin-Perreault
+
+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,40 @@
+# SimpleCov::Formatter::ShieldFormatter
+
+SimpleCov formatter to generate status shields for your reports. Although one already existed, the idea was to create one with as little dependencies as possible, and eventually more than one backend (i.e. not strictly dependent on shields.io).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplecov-formatter-shield'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simplecov-formatter-shield
+
+## Usage
+
+When initializing SimpleCov, simply add the formatter to your list of formatters.
+
+```ruby
+SimpleCov.formatter = [..., SimpleCov::Formatter::ShieldFormatter.new]
+```
+
+## Development
+
+Use rubocop for linting, default options until a .rubocop.yml is provided.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/npepinpe/simplecov-formatter-shield.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'simplecov-formatter-shield'
+require 'irb'
+IRB.start

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-formatter-shield/generators/error.rb

@@ -0,0 +1,10 @@
+module SimpleCov
+  module Formatter
+    class ShieldFormatter
+      module Generators
+        class Error < StandardError
+        end
+      end
+    end
+  end
+end

data/lib/simplecov-formatter-shield/generators/shields_io.rb

@@ -0,0 +1,43 @@
+require 'net/http' # I know this is terrible, but it avoids additional dependencies
+
+module SimpleCov
+  module Formatter
+    class ShieldFormatter
+      module Generators
+        # TODO: Make configurable
+        class ShieldsIO < StandardError
+          HOST = 'img.shields.io'.freeze
+          PATH = 'badge'.freeze
+          EXTENSION = 'png'.freeze
+          STYLE = 'flat'.freeze
+
+          def initialize(options)
+            @options = options
+            @image = nil
+          end
+
+          def generate
+            return @image ||= begin
+              generate!
+            end
+          end
+
+          def generate!
+            uri = build_uri
+            response = Net::HTTP.get_response(uri)
+            raise(Generators::Error, "Could not fetch image at #{uri} => #{response.msg} (#{response.code})") unless (200..399).cover?(response.code.to_i)
+
+            return response.body
+          end
+          private :generate!
+
+          def build_uri
+            parts = [@options.text, @options.status, @options.color].map { |part| CGI.encode(part.to_s) }
+            path = "/#{PATH}/#{parts.join('-')}.#{EXTENSION}"
+            return URI::HTTPS.build(host: HOST, path: path, query: "style=#{STYLE}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simplecov-formatter-shield/generators.rb

@@ -0,0 +1,11 @@
+require 'simplecov-formatter-shield/generators/error'
+require 'simplecov-formatter-shield/generators/shields_io'
+
+module SimpleCov
+  module Formatter
+    class ShieldFormatter
+      module Generators
+      end
+    end
+  end
+end

data/lib/simplecov-formatter-shield/version.rb

@@ -0,0 +1,7 @@
+module SimpleCov
+  module Formatter
+    class ShieldFormatter
+      VERSION = '0.0.2'.freeze
+    end
+  end
+end

data/lib/simplecov-formatter-shield.rb

@@ -0,0 +1,62 @@
+require 'simplecov-formatter-shield/generators'
+
+module SimpleCov
+  module Formatter
+    class ShieldFormatter
+      TEXT = 'coverage'.freeze
+      Options = Struct.new(:text, :color, :status)
+
+      def format(result)
+        percentage = result.covered_percent.to_f.round(2)
+        options = Options.new(TEXT, color(percentage), status(percentage))
+        puts "Created shield at #{output_path}" if write(image(options))
+      rescue Generators::Error => error
+        puts "Could not create shield: #{output_path} => #{error.message}"
+      rescue IOError => error
+        puts "Could not write file at #{output_path} => #{error.message}"
+      end
+
+      # Private API
+      def write(bytes)
+        File.open(output_path, 'wb') do |file|
+          file << bytes
+        end
+      end
+      private :write
+
+      def output_path
+        return File.join(SimpleCov.coverage_path, 'shield.png')
+      end
+      private :output_path
+
+      def color(percentage)
+        case percentage
+        when 95..100
+          :brightgreen
+        when 80..95
+          :green
+        when 70..80
+          :yellowgreen
+        when 60..70
+          :yellow
+        when 40..60
+          :orange
+        else
+          :red
+        end
+      end
+      private :color
+
+      def status(percentage)
+        return "#{percentage}%"
+      end
+      private :status
+
+      def image(options)
+        generator = Generators::ShieldsIO.new(options)
+        return generator.generate
+      end
+      private :image
+    end
+  end
+end

data/simplecov-formatter-shield.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simplecov-formatter-shield/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simplecov-formatter-shield'
+  spec.version       = SimpleCov::Formatter::ShieldFormatter::VERSION
+  spec.authors       = ['Nicolas Pepin-Perreault']
+  spec.email         = ['n.pepinpe@gmail.com']
+
+  spec.summary       = %(SimpleCov formatter to generate TravisCI like shields.)
+  spec.description   = %(SimpleCov formatter to generate TravisCI like shields with as little dependencies as possible.)
+  spec.homepage      = 'https://github.com/npepinpe/simplecov-formatter-shield'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'simplecov', '~> 0.11'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-formatter-shield
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Nicolas Pepin-Perreault
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: SimpleCov formatter to generate TravisCI like shields with as little
+  dependencies as possible.
+email:
+- n.pepinpe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simplecov-formatter-shield.rb
+- lib/simplecov-formatter-shield/generators.rb
+- lib/simplecov-formatter-shield/generators/error.rb
+- lib/simplecov-formatter-shield/generators/shields_io.rb
+- lib/simplecov-formatter-shield/version.rb
+- simplecov-formatter-shield.gemspec
+homepage: https://github.com/npepinpe/simplecov-formatter-shield
+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.6.3
+signing_key: 
+specification_version: 4
+summary: SimpleCov formatter to generate TravisCI like shields.
+test_files: []
+has_rdoc: