simplecov-badge 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f48429e4d889d1ff70ee5f5005886a7b72bd8d26
+  data.tar.gz: dbc14c945f52b4c70229fa27e7be7c59f0481891
+SHA512:
+  metadata.gz: 1de96fe3b56ae991834842362ba979a13e1a43f2cbf5ce24981a1ecbf7539f4d128155f9e36b4c60f13ebd25e84a9150635c72dc0c5ae46cc7ce45ca28d7f221
+  data.tar.gz: 222bb81ce5c55af0a213a4e815f4c206f83c6f05c493e3134d028f37f99fad4cb7217c7a0e599eb1b6ecf4da0d03c1b72d59aff0976ba333d037a8b523118ed8

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,26 @@
+.rvmrc
+.bundle
+Gemfile.lock
+
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.sass-cache
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  # Use local copy of simplecov in development when checked out, fetch from git otherwise
+  if File.directory?(File.dirname(__FILE__) + '/../simplecov')
+    gem 'simplecov', :path => File.dirname(__FILE__) + '/../simplecov'
+  else
+    gem 'simplecov', :git => 'https://github.com/colszowka/simplecov'
+  end
+
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Matt Hale
+
+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,20 @@
+# Badge formatter for SimpleCov
+====================================
+[ ![Codeship Status for matthew342/simplecov-badge](https://www.codeship.io/projects/c46ee0e0-9da1-0130-7a9e-0e0ae47480c0/status?branch=master)](https://www.codeship.io/projects/3367)
+[ ![Code Coverage for matthew342/simplecov-badge](http://http://matthew342.github.io/simplecov-badge/coverage/coverage-badge.png)](http://matthew342.github.io/simplecov-badge/coverage/index.html)
+***Note: To learn more about SimpleCov, check out the main repo at https://github.com/colszowka/simplecov***
+
+Generates coverage badges from SimpleCov using ImageMagick.
+
+
+Note on Patches/Pull Requests
+-----------------------------
+
+\[to come\]
+
+
+Copyright
+---------
+Adapted from [simplecov-html](https://github.com/colszowka/simplecov-html).  
+Thanks to [Christoph Olszowka](https://github.com/colszowka).
+Copyright (c) 2013 Matt Hale. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# See https://github.com/colszowka/simplecov/issues/171
+desc "Set permissions on all files so they are compatible with both user-local and system-wide installs"
+task :fix_permissions do
+  system 'bash -c "find . -type f -exec chmod 644 {} \; && find . -type d -exec chmod 755 {} \;"'
+end
+# Enforce proper permissions on each build
+Rake::Task[:build].prerequisites.unshift :fix_permissions
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/lib/simplecov-badge.rb

@@ -0,0 +1,210 @@
+# Ensure we are using a compatible version of SimpleCov
+if Gem::Version.new(SimpleCov::VERSION) < Gem::Version.new("0.7.1")
+  raise RuntimeError, "The version of SimpleCov you are using is too old. Please update with `gem install simplecov` or `bundle update simplecov`"
+end
+
+ImageMagickError = Class.new(StandardError)
+  
+class SimpleCov::Formatter::BadgeFormatter  
+  # Set up config variables.
+  options = {:generate_groups => true, :timestamp => false, :green => '#4fb151',
+            :yellow => '#ded443', :red => '#a23e3f', :number_font => 'Helvetica-Narrow-Bold',
+            :number_font_size => 20, :name_font => 'Helvetica', :name_font_size => 17,
+            :badge_height => 25, :use_strength_color => true, :strength_foreground => false,
+            :group_number_font => 'Helvetica-Narrow-Bold', :group_number_font_size => 20,
+            :group_name_font => 'Helvetica-Bold', :group_name_font_size => 17,
+            :group_badge_height => 25, :use_strength_color_for_group_name => true, 
+            :group_strength_foreground => true}
+    
+  # set up class variables and getters/setters
+  options.each do |opt,v|
+    set = "@@#{opt} = v"
+    getter = "def self.#{opt};  @@#{opt}; end;"
+    setter = "def self.#{opt}=(value);  @@#{opt} = value; end;"
+    eval(set)
+    eval(getter)
+    eval(setter)
+  end
+  
+  def format(result)
+    begin
+      check_imagemagick
+      generate_header_badge(result)
+      generate_group_badges(result) if @@generate_groups
+      puts output_message(result)
+    rescue ImageMagickError => e
+     puts e
+     puts "Simplecov-Badge was unable to generate a badge for #{result.command_name}."
+    end
+  end
+
+  private
+  
+  def generate_header_badge(result)
+    overall_cov = result.source_files.covered_percent.round(0)
+    overall_strength = result.covered_strength.round(0)
+    command = []
+    command[0] = """
+      convert -size 52x#{@@badge_height} xc:'#{coverage_color(overall_cov)}' -pointsize #{@@number_font_size} -font '#{@@number_font}' \
+      -gravity east -fill white -draw \"kerning 2 text +2,+2 '#{overall_cov}%'\" \
+      -alpha set -bordercolor none -border 3 \
+      -gravity North -chop 0x3 \
+      -gravity South -chop 0x3 \
+      -gravity West -chop 3x0 \
+      #{output_path}/tmp.png
+      """
+    command[1] = """
+      convert #{output_path}/tmp.png \\( -size 237x#{@@badge_height} xc:'#{strength_background(overall_strength, @@strength_foreground)}' \
+      -pointsize #{@@name_font_size} -fill '#{strength_foreground(overall_strength, @@strength_foreground)}' -font '#{@@name_font}' \
+      -draw \"kerning 1 text 4,19 'OVERALL STRENGTH'\" \
+      -gravity West \
+      -background white -splice 1x0  -background black -splice 1x0 \
+      -trim  +repage -gravity West -chop 1x0 -gravity East \
+      -background '#{strength_background(overall_strength, @@strength_foreground)}' -splice 2x0 \\) \
+      -background none +append #{output_path}/tmp.png
+      """
+    command[2] = """
+      convert #{output_path}/tmp.png -format 'roundrectangle 1,1 %[fx:w+4],%[fx:h+#{@@badge_height}] 10,10' \
+      -write info:#{output_path}/tmp.mvg \
+      -alpha set -bordercolor none -border 3 \
+      \\( +clone -alpha transparent -background none \
+      -fill white -stroke none -strokewidth 0 -draw @#{output_path}/tmp.mvg \\) \
+      -compose DstIn -composite \
+      -gravity South -chop 0x3 #{output_path}/tmp.png
+      """
+    command[3] = """
+      convert #{output_path}/tmp.png \\( +clone -alpha extract \
+      \\( -size 5x2 xc:black -draw 'fill white circle 8,8 8,0' -write mpr:arc +delete \\) \
+      \\( mpr:arc -rotate 180 \\) -gravity southeast -composite \\) \
+      -alpha off -compose CopyOpacity -composite #{output_path}/coverage-badge.png
+      """
+    begin
+      command.each do |cmd|
+        output = `#{cmd}`
+        check_status(output)
+      end
+    ensure
+      system("rm #{output_path}/tmp.mvg")
+      system("rm #{output_path}/tmp.png")
+    end
+  end
+  
+  def generate_group_badges(result)
+    result.groups.each do |name, files|
+      cov = files.covered_percent.round(0)
+      strength = files.covered_strength.round(0)
+      command = []
+      command[0] = """
+        convert -size 52x#{@@group_badge_height} xc:'#{coverage_color(cov)}' -pointsize #{@@group_number_font_size} -font '#{@@group_number_font}' \
+        -gravity east -fill white -draw \"kerning 2 text +2,+2 '#{cov}%'\" \
+        -alpha set -bordercolor none -border 3 \
+        -gravity North -chop 0x3 \
+        -gravity South -chop 0x3 \
+        -gravity East -chop 3x0 #{output_path}/tmp.png
+      """
+      command[1] = """
+        convert #{output_path}/tmp.png \\( -size 300x#{@@group_badge_height} xc:#{strength_background(strength, @@group_strength_foreground)} \
+        -pointsize #{@@group_name_font_size} -fill '#{strength_foreground(strength, @@group_strength_foreground)}' -font '#{@@group_name_font}' \
+        -draw \"kerning 0.5 text 4,19 '#{name.upcase}'\" \
+        -gravity West -background white -splice 1x0 -background black -splice 1x0 \
+        -trim  +repage -gravity West -chop 1x0 -gravity East \
+        -background '#{strength_background(strength, @@group_strength_foreground)}' -splice 2x0 \
+        -alpha set -bordercolor none -border 3 \
+        -gravity North -chop 0x3 -gravity South -chop 0x3 \
+        -strokewidth 2 -format 'stroke white line 1,1 %[fx:w],3' \\) \
+        -background none +append #{output_path}/tmp.png
+      """
+      command[2] = """
+        convert #{output_path}/tmp.png \\( +clone -alpha extract \
+        \\( -size 5x2 xc:black -draw 'fill white circle 8,8 8,0' -write mpr:arc +delete \\) \
+        \\( mpr:arc -flip \\) -gravity southwest -composite \
+        \\( mpr:arc -rotate 180 \\) -gravity southeast -composite \\) \
+        -alpha off -compose CopyOpacity -composite \
+        #{output_path}/tmp.png
+      """
+      command[3] = """
+        convert #{output_path}/coverage-badge.png #{output_path}/tmp.png -gravity West -background none -append #{output_path}/coverage-badge.png
+      """
+      begin
+        command.each_with_index do |cmd, y|
+          next cmd if y == 2 #and i != result.groups.count
+          output = `#{cmd}`
+          check_status(output)
+        end
+      ensure
+        system("rm #{output_path}/tmp.png")
+      end
+    end
+    if @@timestamp
+      timestamp_cmd = """
+        convert #{output_path}/coverage-badge.png -alpha set -bordercolor none -border 3 \
+        -gravity North -chop 0x3 \
+        -gravity East -chop 3x0 \
+        -gravity West -chop 3x0 \\( -background none -font 'Helvetica' label:'Generated #{Time.current.strftime('%m-%d-%y %H:%M UTC')}' \\) -background none -gravity center -append #{output_path}/coverage-badge.png
+      """
+      output = `#{timestamp_cmd}`
+      check_status(output)
+    end
+  end
+
+  # checks if imagemagick is installed and working
+  def check_imagemagick
+    output = `convert`
+    raise ImageMagickError, "ImageMagick doesn't appear to be installed." unless $?.to_i == 0
+  end
+  
+  def check_status(output)
+    raise ImageMagickError, "ImageMagick exited with an error. It said:\n #{output}" unless $?.to_i == 0
+  end
+  
+  def output_message(result)
+    "Coverage badge generated for #{result.command_name} to #{output_path}."
+  end
+  
+  def output_path
+    SimpleCov.coverage_path
+  end
+
+  def strength_background(strength, foreground)
+    if foreground
+      'transparent'
+    else
+      strength_color(strength, @@use_strength_color)
+    end
+  end
+  
+  def strength_foreground(strength, foreground)
+    unless foreground
+      'white'
+    else
+      strength_color(strength, @@use_strength_color)
+    end
+  end
+  
+  def coverage_color(covered_percent)
+    if covered_percent > 90
+      @@green
+    elsif covered_percent > 80
+      @@yellow
+    else
+      @@red
+    end
+  end
+
+  def strength_color(covered_strength, use)
+    if use
+      if covered_strength > 1
+        @@green
+      elsif covered_strength == 1
+        @@yellow
+      else
+        @@red
+      end
+    else
+      'silver'
+    end
+  end
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
+require 'simplecov-badge/version'

data/lib/simplecov-badge/version.rb

@@ -0,0 +1,7 @@
+module SimpleCov
+  module Formatter
+    class BadgeFormatter
+      VERSION = "1.0.0"
+    end
+  end
+end

data/simplecov-badge.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'simplecov-badge/version'
+
+Gem::Specification.new do |s|
+  s.name        = "simplecov-badge"
+  s.version     = SimpleCov::Formatter::BadgeFormatter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matt Hale"]
+  s.email       = ["matt.hale.0 at gmail dot com"]
+  s.homepage    = "https://github.com/matthew342/simplecov-badge"
+  s.summary     = %Q{Badge generator for SimpleCov code coverage tool for ruby 1.9+}
+  s.description = %Q{Badge generator for SimpleCov code coverage tool for ruby 1.9+}
+
+  s.rubyforge_project = "simplecov-badge"
+  
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'sprockets'
+  s.add_development_dependency 'sass'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/simplecov-badge_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe SimpleCov::Formatter::BadgeFormatter do
+  before(:all) do
+    @obj = SimpleCov::Formatter::BadgeFormatter.new
+  end
+
+  describe 'format' do    
+    it "handles a StandardError" do
+      result = double("result")
+      result.stub(:command_name) {'test'}
+      @obj.stub(:check_imagemagick).and_raise(ImageMagickError, "test phrase")
+      @obj.should_not_receive(:generate_header_badge)
+      @obj.should_not_receive(:generate_group_badges)
+      $stdout.should_receive(:write).at_least(:once)
+      @obj.format(result)
+    end
+  end
+
+  describe "options" do  
+    it 'generates option getter/setters' do
+      SimpleCov::Formatter::BadgeFormatter.generate_groups.should eq(true)
+      SimpleCov::Formatter::BadgeFormatter.generate_groups = false
+      SimpleCov::Formatter::BadgeFormatter.generate_groups.should eq(false)
+    end
+  end
+  
+  describe "badge generation" do
+    it 'should generate header badge' do
+      @obj.stub(:check_imagemagick).and_return(0)
+      @obj.stub(:generate_group_badges).and_return(0)
+      @obj.stub(:coverage_color).and_return('green')
+      @obj.stub(:strength_color).and_return('green')
+      @obj.stub(:strength_foreground).and_return('green')
+      @obj.stub(:strength_background).and_return('transparent')
+      @obj.stub(:output_path).and_return('.')
+      result = double('Result')
+      result.stub_chain('source_files.covered_percent').and_return(50)
+      result.stub('covered_strength').and_return(90)
+      result.stub(:command_name) {'test'}
+      @obj.format(result)
+      $?.success?.should eq(true)
+      File.size('coverage-badge.png')
+    end
+ 
+    it 'should generate group badges' do
+          SimpleCov::Formatter::BadgeFormatter.generate_groups = true
+          result = double('Result')
+          result.stub(:command_name) {'test'}
+          files = double("files")
+          files.stub('covered_percent').and_return(50)
+          files.stub('covered_strength').and_return(90)
+          groups = {'group1' => files, 'group2' => files}
+          result.stub_chain('groups').and_return(groups)
+          @obj.stub(:check_imagemagick).and_return(0)
+          @obj.stub(:generate_header_badge).and_return(0)
+          @obj.stub(:coverage_color).and_return('green')
+          @obj.stub(:strength_color).and_return('green')
+          @obj.stub(:strength_foreground).and_return('green')
+          @obj.stub(:strength_background).and_return('transparent')
+          @obj.stub(:output_path).and_return('.')
+          expect{ @obj.format(result) }.to change{File.size('coverage-badge.png')}
+          $?.success?.should eq(true)
+        end
+
+    describe 'generation helpers' do
+      # Calling all these private methods here is a little ugly; but it seemed like the
+      # right thing in this case - testing these through public methods (format) just
+      # isn't possible
+      
+      describe 'strength_background' do
+        it 'returns transparent if foreground and strength_color if not' do
+          @obj.instance_eval{strength_background(60, true)}.should eq('transparent')
+          @obj.class.any_instance.should_receive(:strength_color)
+          @obj.instance_eval{strength_background(60, false)}
+        end
+      end
+
+      describe 'strength_foreground' do
+        it 'returns strength color if foreground and white if not' do
+          @obj.instance_eval{strength_foreground(60,false)}.should eq('white')
+          @obj.class.any_instance.should_receive(:strength_color)
+          @obj.instance_eval{strength_foreground(60,true)}
+        end
+      end
+
+      describe 'coverage_color' do
+        it 'returns the correct colors' do
+          @obj.instance_eval{coverage_color(91)}.should eq(@obj.class.green)
+          @obj.instance_eval{coverage_color(81)}.should eq(@obj.class.yellow)
+          @obj.instance_eval{coverage_color(60)}.should eq(@obj.class.red)
+        end
+      end
+
+      describe 'strength_color' do
+        it 'returns the correct colors' do
+          @obj.instance_eval{strength_color(1.1, true)}.should eq(@obj.class.green)
+          @obj.instance_eval{strength_color(1, true)}.should eq(@obj.class.yellow)
+          @obj.instance_eval{strength_color(0.9, true)}.should eq(@obj.class.red)
+          @obj.instance_eval{strength_color(0.9, false)}.should eq('silver')
+        end
+      end
+    end
+    
+    after(:all) do
+      `rm coverage-badge.png`
+    end
+  end
+  
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+SimpleCov.start do
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+       SimpleCov::Formatter::HTMLFormatter,
+       SimpleCov::Formatter::BadgeFormatter,
+     ]
+end
+require 'simplecov-badge'
+
+RSpec.configure do |config|
+  # some (optional) config here
+  
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-badge
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Hale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Badge generator for SimpleCov code coverage tool for ruby 1.9+
+email:
+- matt.hale.0 at gmail dot com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simplecov-badge.rb
+- lib/simplecov-badge/version.rb
+- simplecov-badge.gemspec
+- spec/simplecov-badge_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/matthew342/simplecov-badge
+licenses: []
+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: simplecov-badge
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Badge generator for SimpleCov code coverage tool for ruby 1.9+
+test_files:
+- spec/simplecov-badge_spec.rb
+- spec/spec_helper.rb