simplecov-formatter-shield 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5071624ee48fe8be44468878a0da3d42d44d9039
-  data.tar.gz: 11612faeb3d01b04c1c9b61360dc3b313004e3be
+  metadata.gz: 27e463f02332e752dc9821958206eae655dee1bf
+  data.tar.gz: b55fe4ddc507c4efcb3afa00440d551ece0395c9
 SHA512:
-  metadata.gz: 362314e8a22e0986faf820091891d29e49763b6792fcfbdcc284392f9723ff05b94438a9b861cf6cff34988b4146a8a5b4ed9deff81b56adb847d451f06be5f4
-  data.tar.gz: 1bf19b435634a33aad5aad83db6716d8480af6ce38577d773781f628c6202f6a07c9f8cf2242c9cd88de813dc1415b2f6c3d11e86d3d3b0fccbbe2ad6d7b1c67
+  metadata.gz: e9728c59982c40a1a79d2bee1da0f74af21671f39eca87fb8b781ae20bd314812377a15fc0bcee6c0c0448538e3ef45a18dc53d4e23e60ea7d6078de9a621a26
+  data.tar.gz: 9644d299bc01013164b3c4fb6db19d3cc16a2232e0745017b44d07d945c5c1d80b00858e2454c58f0d9c0f6ec55cfa8453ed7c80defd0afbecf3e24a5d907975

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in simplecov-formatter-shield.gemspec
 gemspec
+
+group :development do
+  gem 'pry'
+end

data/README.md

@@ -2,6 +2,21 @@
 
 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).
 
+## Dependencies
+
+If you're going to use the PNG generator, you'll need to install the following: ghostscript, librsvg, imagemagick
+
+If you're on OSX, you can use homebrew to install all dependencies:
+
+```
+brew install ghostscript
+brew install librsvg
+brew install imagemagick --with-librsvg
+```
+
+Ghostscript installs the required fonts, otherwise converting from SVG to PNG would generate errors. Using librsvg will
+convert SVGs to PNGs more accurately.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/bin/console

@@ -2,5 +2,5 @@
 
 require 'bundler/setup'
 require 'simplecov-formatter-shield'
-require 'irb'
-IRB.start
+require 'pry'
+Pry.start

data/lib/simplecov-formatter-shield.rb

@@ -1,5 +1,3 @@
-require 'simplecov-formatter-shield/generators'
-
 module SimpleCov
   module Formatter
     class ShieldFormatter
@@ -11,6 +9,29 @@ module SimpleCov
         def filename=(filename)
           @filename = filename
         end
+
+        def generator
+          self.generator = :shields_io if @generator.nil?
+          return @generator
+        end
+
+        def generator=(generator)
+          @generator = case generator
+          when :svg
+            require 'simplecov-formatter-shield/generators/svg'
+            SimpleCov::Formatter::ShieldFormatter::Generators::Svg
+          when :png
+            require 'simplecov-formatter-shield/generators/png'
+            SimpleCov::Formatter::ShieldFormatter::Generators::Png
+          when :shields_io
+            require 'simplecov-formatter-shield/generators/shield_io'
+            SimpleCov::Formatter::ShieldFormatter::Generators::ShieldsIO
+          else
+            Logger.warn("Unknown generator #{generator}; pick one of: :svg, :png, :shields_io")
+          end
+
+          return @generator
+        end
       end
 
       TEXT = 'coverage'.freeze
@@ -63,7 +84,7 @@ module SimpleCov
       private :status
 
       def image(options)
-        generator = Generators::ShieldsIO.new(options)
+        generator = self.class.generator.new(options)
         return generator.generate
       end
       private :image

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

@@ -0,0 +1,32 @@
+require 'simplecov-formatter-shield/generators/svg'
+require 'tempfile'
+require 'mini_magick'
+
+module SimpleCov
+  module Formatter
+    class ShieldFormatter
+      module Generators
+        class Png < Svg
+          def generate!
+            return svg2png(super)
+          end
+          private :generate!
+
+          def svg2png(svg)
+            image = MiniMagick::Image.create('.svg') do |tmpfile|
+              tmpfile.write(svg)
+            end
+
+            image.format('png') do |converter|
+              converter.resize "#{widths.reduce(&:+)}x20"
+              converter.background 'transparent'
+              converter.alpha 'on'
+            end
+
+            return image.to_blob
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module SimpleCov
     class ShieldFormatter
       module Generators
         # TODO: Make configurable
-        class ShieldsIO < StandardError
+        class ShieldsIO
           HOST = 'img.shields.io'.freeze
           PATH = 'badge'.freeze
           EXTENSION = 'png'.freeze

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

@@ -0,0 +1,64 @@
+require 'erb'
+require 'tempfile'
+require 'mini_magick'
+
+module SimpleCov
+  module Formatter
+    class ShieldFormatter
+      module Generators
+        class Svg
+          CHAR_WIDTH = 0.7 * 10
+          PADDING = 4
+          COLOR_MAP = {
+            brightgreen: [nil, '#4c1'],
+            green: [nil, '#97CA00'],
+            yellow: [nil, '#dfb317'],
+            yellowgreen: [nil, '#a4a61d'],
+            orange: [nil, '#fe7d37'],
+            red: [nil, '#e05d44']
+          }.freeze
+
+          def initialize(options)
+            @options = options
+            @template = ERB.new(File.read(File.expand_path('../svg/template.svg.erb', __FILE__)))
+            @image = nil
+          end
+
+          def generate
+            return @image ||= begin
+              generate!
+            end
+          end
+
+          def inspect
+            return "#{self.class.name}: options => <#{@options}>"
+          end
+
+          def generate!
+            texts = self.texts
+            widths = self.widths
+            colors = self.colors
+
+            return @template.result(binding)
+          end
+          private :generate!
+
+          def texts
+            return @texts ||= [@options.text, @options.status]
+          end
+          protected :texts
+
+          def widths
+            return @widths ||= texts.map { |str| (str.length * CHAR_WIDTH).ceil + PADDING + 1 }
+          end
+          protected :widths
+
+          def colors
+            return @colors ||= COLOR_MAP[@options.color]
+          end
+          protected :colors
+        end
+      end
+    end
+  end
+end

data/lib/simplecov-formatter-shield/generators/svg/template.svg.erb

@@ -0,0 +1,23 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="<%= widths[0]+ widths[1] %>" height="20">
+  <linearGradient id="smooth" x2="0" y2="100%">
+    <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+    <stop offset="1" stop-opacity=".1"/>
+  </linearGradient>
+
+  <mask id="round">
+    <rect width="<%= widths[0]+ widths[1] %>" height="20" rx="3" fill="#fff"/>
+  </mask>
+
+  <g mask="url(#round)">
+    <rect width="<%= widths[0] %>" height="20" fill="<%= colors[0] || "#555" %>"/>
+    <rect x="<%= widths[0] %>" width="<%= widths[1] %>" height="20" fill="<%= colors[1] || "#4c1" %>"/>
+    <rect width="<%= widths[0] + widths[1] %>" height="20" fill="url(#smooth)"/>
+  </g>
+
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans" font-size="10" font-weigth="lighter">
+    <text x="<%= widths[0]/2 %>" y="15" fill="#010101" fill-opacity=".3"><%= texts[0] %></text>
+    <text x="<%= widths[0]/2 %>" y="14"><%= texts[0] %></text>
+    <text x="<%= widths[0] + widths[1]/2 - 1 %>" y="15" fill="#010101" fill-opacity=".3"><%= texts[1] %></text>
+    <text x="<%= widths[0] + widths[1]/2 - 1 %>" y="14"><%= texts[1] %></text>
+  </g>
+</svg>

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

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

data/simplecov-formatter-shield.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'mini_magick', '~> 4.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-formatter-shield
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Nicolas Pepin-Perreault
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.1
 description: SimpleCov formatter to generate TravisCI like shields with as little
   dependencies as possible.
 email:
@@ -86,7 +100,10 @@ files:
 - lib/simplecov-formatter-shield.rb
 - lib/simplecov-formatter-shield/generators.rb
 - lib/simplecov-formatter-shield/generators/error.rb
+- lib/simplecov-formatter-shield/generators/png.rb
 - lib/simplecov-formatter-shield/generators/shields_io.rb
+- lib/simplecov-formatter-shield/generators/svg.rb
+- lib/simplecov-formatter-shield/generators/svg/template.svg.erb
 - lib/simplecov-formatter-shield/version.rb
 - simplecov-formatter-shield.gemspec
 homepage: https://github.com/npepinpe/simplecov-formatter-shield