shield-system 0.0.1 → 0.0.2

data/README.md

@@ -2,7 +2,7 @@
 
 Shield-System lets you generate github style status images for use anywhere e.g. custom badges with tests results.
 
-[![Build Status](https://travis-ci.org/masterthought/thundercat.png?branch=master)](https://travis-ci.org/masterthought/thundercat)
+[![Build Status](https://travis-ci.org/masterthought/shield-system.png?branch=master)](https://travis-ci.org/masterthought/shield-system)
 
 ## Background
 
@@ -14,6 +14,12 @@ tests and statuses.
 
      gem install shield-system
 
+Requires RMagick so imagemagick needs to be installed. on a mac with brew:
+
+     brew install git (if you don't have git)
+     brew install ghostscript
+     brew install imagemagick
+
 ## Usage
 
 ### Create build status preset shields
@@ -37,7 +43,7 @@ tests and statuses.
 (https://raw.github.com/masterthought/shield-system/master/examples/images/unknown.gif)
 
      require 'shield_system'
-     require 'shield_system/presets/github_build_status'
+     require 'presets/github_build_status.rb'
 
      output_path = File.dirname(__FILE__)
      build_status = GithubBuildStatus.new(output_path)
@@ -72,8 +78,8 @@ tests and statuses.
 ![Font]
 (https://raw.github.com/masterthought/shield-system/master/examples/images/font.gif)
 
-     shield.github_shield('height','Dependencies','up-to-date',BuildStatus.key.colour,BuildStatus.passing.colour,BuildStatus.value.colour,'white','none',30,15,'arial',50)
-     shield.github_shield('font','GPA','4.0','#25B9E6',BuildStatus.passing.colour,'#0C0861','white','none',20,13,'times')
+     shield.github_shield('height','Dependencies','up-to-date',BuildStatus.key.colour,BuildStatus.passing.colour,BuildStatus.value.colour,'white',TRANSPARENT_BACKGROUND,FONT_EAGLE,30,15,'arial')
+     shield.github_shield('font','GPA','4.0','#25B9E6',BuildStatus.passing.colour,'#0C0861','white',TRANSPARENT_BACKGROUND,FONT_EAGLE,20,13,'times')
 
 ### Creating Sparklines
 
@@ -90,23 +96,24 @@ tests and statuses.
 ### sparklines bar and pie
 
      # labels
-     shield.github_shield('build-history-label-bar','Build History','','#A8A7A5','#A8A7A5','white','white','none',28,13)
-     shield.github_shield('build-history-label-pie','Passing Tests','','#A8A7A5','#A8A7A5','white','white','none',28,13)
+     shield.label('build-history-label-bar', 'Build History', '#A8A7A5', 'white', TRANSPARENT_BACKGROUND, FONT_EAGLE, 28, 13)
+     shield.label('build-history-label-pie', 'Passing Tests', '#A8A7A5', 'white', TRANSPARENT_BACKGROUND, FONT_EAGLE, 28, 13)
      # sparklines
-     shield.sparkline_shield('build-history-bar',:bar,[100,100,90,80,90,90,100,120,120,90,80,70,100,120])
-     shield.sparkline_shield('build-history-pie',:pie,[70])
+     shield.sparkline_shield('build-history-bar', :bar, [100, 100, 90, 80, 90, 90, 100, 120, 120, 90, 80, 70, 100, 120])
+     shield.sparkline_shield('build-history-pie', :pie, [70])
 
 ## Additional Info
 
 github_shield takes several configuration parameters:
 
-   github_shield(shield_name, key_text, status_text, key_colour, status_colour, key_text_colour, status_text_colour, background_colour='none', height=18, font_size=11, font_family='arial', buffer=5)
+   github_shield(shield_name, key_text, status_text, key_colour, status_colour, key_text_colour, status_text_colour, background_colour=TRANSPARENT_BACKGROUND, custom_font=FONT_EAGLE, height=18, font_size=11, font_family='arial', buffer=5)
 
 most are self explanatory but here's some clarification on the last ones:
 
-  * background_colour = by default is 'none' but you can use this to set a specific colour
-  * buffer = by default is 5 - this is width added to the text width for the key and value you supply. The calculation for text width doesn't seem to take into account the font used so
-    when changing the font size the text doesn't line up correctly - you can increase the buffer to fix this if that happens.
+  * background_colour = by default is TRANSPARENT_BACKGROUND but you can use this to set a specific colour
+  * buffer = by default is 5 - this is width added to the text width for the key and value you supply. you can increase the buffer to make more background space to the right of the text.
+  * custom_font = this is set to FONT_EAGLE by default. When custom_font is set it ignores font_family. You can turn off custom_font by setting it to NO_CUSTOM_FONT then the font_family will work.
+    (custom font is better cross platform otherwise the tests were failing as different OS's render the system fonts differently)
 
 ## Develop
 

data/src/presets/github_build_status.rb

@@ -3,9 +3,10 @@ require File.dirname(__FILE__) + '/../presets/helpers/build_status'
 
 class GithubBuildStatus
 
-  def initialize(output_path,background_colour='none')
+  def initialize(output_path,background_colour=TRANSPARENT_BACKGROUND,custom_font=NO_CUSTOM_FONT)
     @shield = ShieldSystem.new(output_path)
     @background_colour = background_colour
+    @custom_font = custom_font
   end
 
   def passing
@@ -34,7 +35,7 @@ class GithubBuildStatus
 
   def shield(status, override_filename=false)
     @shield.github_shield(override_filename ? status.name.downcase : BuildStatus.filename, BuildStatus.key.name, status.name,
-                          BuildStatus.key.colour, status.colour, BuildStatus.value.colour, BuildStatus.value.colour, @background_colour)
+                          BuildStatus.key.colour, status.colour, BuildStatus.value.colour, BuildStatus.value.colour, @background_colour, @custom_font)
   end
 
 end

data/src/shield_system.rb

@@ -1,5 +1,7 @@
 require File.dirname(__FILE__) + '/systems/github_shield'
+require File.dirname(__FILE__) + '/systems/label'
 require File.dirname(__FILE__) + '/systems/sparkline_shield'
+require File.dirname(__FILE__) + '/constants'
 
 class ShieldSystem
 
@@ -7,12 +9,16 @@ class ShieldSystem
     @output_path = output_path
   end
 
-  def github_shield(shield_name, key_text, status_text, key_colour, status_colour, key_text_colour, status_text_colour, background_colour='none', height=18, font_size=11, font_family='arial', buffer=5)
-    GithubShield.new(shield_name, key_text, status_text, key_colour, status_colour, key_text_colour, status_text_colour, background_colour, @output_path, height, font_size, font_family, buffer).generate
+  def github_shield(shield_name, key_text, status_text, key_colour, status_colour, key_text_colour, status_text_colour, background_colour=TRANSPARENT_BACKGROUND, custom_font=FONT_EAGLE, height=18, font_size=11, font_family='arial', buffer=5)
+    GithubShield.new(shield_name, key_text, status_text, key_colour, status_colour, key_text_colour, status_text_colour, background_colour, @output_path, custom_font, height, font_size, font_family, buffer).generate
   end
 
-  def sparkline_shield(shield_name,chart_type,data,options={})
-    SparklineShield.new(shield_name,chart_type,data,options,@output_path).generate
+  def label(label_name, label_text, label_colour, label_text_colour, background_colour=TRANSPARENT_BACKGROUND, custom_font=FONT_EAGLE, height=18, font_size=11, font_family='arial', buffer=5)
+    Label.new(label_name, label_text, label_colour, label_text_colour, background_colour, @output_path, custom_font, height, font_size, font_family, buffer).generate
+  end
+
+  def sparkline_shield(shield_name, chart_type, data, options={})
+    SparklineShield.new(shield_name, chart_type, data, options, @output_path).generate
   end
 
 

data/src/systems/github_shield.rb

@@ -2,7 +2,7 @@ require 'RMagick'
 
 class GithubShield
 
-  def initialize(shield_name, key_text, status_text, key_colour, status_colour, key_text_colour, status_text_colour, background_colour, output_path, height, font_size, font_family, buffer)
+  def initialize(shield_name, key_text, status_text, key_colour, status_colour, key_text_colour, status_text_colour, background_colour, output_path, custom_font, height, font_size, font_family, buffer)
     @shield_name = shield_name
     @key_text = "   #{key_text}"
     @status_text = "   #{status_text}"
@@ -14,6 +14,7 @@ class GithubShield
     @output_path = output_path
     @font_size = font_size.to_i
     @font_family = font_family
+    @custom_font = custom_font
     @buffer = buffer.to_i
     @key_width = get_text_width(@key_text)
     @status_width = get_text_width(@status_text)
@@ -53,15 +54,15 @@ class GithubShield
   def bridge_rectangle
     @draw.fill(@key_colour)
     @draw.stroke(@key_colour)
-    @draw.stroke_width(3)
+    @draw.stroke_width(2)
     @draw.rectangle(@key_width, 0, @key_width+1, @height-1)
     @draw.stroke('transparent')
   end
 
   def key_text
     @draw.fill(@key_text_colour)
-    @draw.font_family(@font_family)
-    @draw.font_size(@font_size)
+    set_font(@draw)
+    @draw.pointsize=@font_size
     @draw.text_antialias(true)
     @draw.font_style(Magick::NormalStyle)
     @draw.font_weight(Magick::BoldWeight)
@@ -71,8 +72,8 @@ class GithubShield
 
   def status_text
     @draw.fill(@status_text_colour)
-    @draw.font_family(@font_family)
-    @draw.font_size(@font_size)
+    set_font(@draw)
+    @draw.pointsize=@font_size
     @draw.text_antialias(true)
     @draw.font_style(Magick::NormalStyle)
     @draw.font_weight(Magick::BoldWeight)
@@ -89,8 +90,8 @@ class GithubShield
     canvas = Magick::Image.new(100, 100){ self.background_color = 'transparent' }
     canvas.alpha(Magick::ActivateAlphaChannel)
     label = Magick::Draw.new
-    label.font_family(@font_family)
-    label.font_size(@font_size)
+    set_font(label)
+    label.pointsize=@font_size
     label.text_antialias(true)
     label.font_style(Magick::NormalStyle)
     label.font_weight(Magick::BoldWeight)
@@ -100,6 +101,14 @@ class GithubShield
     metrics.width.to_i + @buffer
   end
 
+  def set_font(parent)
+    if @custom_font.nil?
+      parent.font_family(@font_family)
+    else
+      parent.font = @custom_font
+    end
+  end
+
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shield-system
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: