shield-system 0.0.1

data/README.md

@@ -0,0 +1,114 @@
+# Generate Status Badge Images
+
+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)
+
+## Background
+
+I really like the travis,code climate and other services badges you can put on your github README and I wanted to make some I could use on
+my internal projects and also be able to change the colours and text easily to make badges with different information for different sets of
+tests and statuses.
+
+## Install
+
+     gem install shield-system
+
+## Usage
+
+### Create build status preset shields
+
+![Passing]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/passing.gif)
+
+![Failing]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/failing.gif)
+
+![Pending]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/pending.gif)
+
+![Unstable]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/unstable.gif)
+
+![Error]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/error.gif)
+
+![Unknown]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/unknown.gif)
+
+     require 'shield_system'
+     require 'shield_system/presets/github_build_status'
+
+     output_path = File.dirname(__FILE__)
+     build_status = GithubBuildStatus.new(output_path)
+     build_status.shield(BuildStatus.passing)
+
+### Create custom shields
+
+![Acceptance]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/acceptance.gif)
+
+![Functional]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/functional.gif)
+
+![EndtoEnd]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/end-to-end.gif)
+
+### using a custom shield
+
+     require 'shield_system'
+
+     output_path = File.dirname(__FILE__)
+     shield = ShieldSystem.new(output_path)
+     shield.github_shield('acceptance','Acceptance Tests',BuildStatus.passing.name,'#25B9E6',BuildStatus.passing.colour,'#0C0861','white')
+     shield.github_shield('functional','Functional Tests','108 Passing','#DCB9ED',BuildStatus.passing.colour,'#0C0861','white')
+     shield.github_shield('end-to-end','Number of End to End Tests:','500','#F08C4A','#F08C4A','#0C0861','#0C0861')
+
+### changing height and font
+
+![Height]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/height.gif)
+
+![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')
+
+### Creating Sparklines
+
+![BarLabel]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/build-history-label-bar.gif)
+![Bar]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/build-history-bar.gif)
+
+![PieLabel]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/build-history-label-pie.gif)
+![Pie]
+(https://raw.github.com/masterthought/shield-system/master/examples/images/build-history-pie.gif)
+
+### 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)
+     # 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])
+
+## 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)
+
+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.
+
+## Develop
+
+Interested in contributing? Great just let me know how you want to help.
+

data/src/presets/github_build_status.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../shield_system'
+require File.dirname(__FILE__) + '/../presets/helpers/build_status'
+
+class GithubBuildStatus
+
+  def initialize(output_path,background_colour='none')
+    @shield = ShieldSystem.new(output_path)
+    @background_colour = background_colour
+  end
+
+  def passing
+    shield(BuildStatus.passing)
+  end
+
+  def failing
+    shield(BuildStatus.failing)
+  end
+
+  def pending
+    shield(BuildStatus.pending)
+  end
+
+  def unstable
+    shield(BuildStatus.unstable)
+  end
+
+  def error
+    shield(BuildStatus.error)
+  end
+
+  def unknown
+    shield(BuildStatus.unknown)
+  end
+
+  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)
+  end
+
+end
+
+

data/src/presets/helpers/build_status.rb

@@ -0,0 +1,45 @@
+require 'ostruct'
+
+class BuildStatus
+
+  def self.passing
+   create('Passing','#3BB314')
+  end
+
+  def self.failing
+    create('Failing','#CC0000')
+  end
+
+  def self.pending
+    create('Pending','#E6B225')
+  end
+
+  def self.unstable
+    create('Unstable','#D6C61A')
+  end
+
+  def self.error
+    create('Error','#A8A7A5')
+  end
+
+  def self.unknown
+    create('Unknown','#A8A7A5')
+  end
+
+  def self.key
+    create('Build','#575354')
+  end
+
+  def self.value
+    create('value','white')
+  end
+
+  def self.filename
+    'build_status'
+  end
+
+  def self.create(name,colour)
+    OpenStruct.new(:name => name,:colour => colour)
+  end
+
+end

data/src/shield_system.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/systems/github_shield'
+require File.dirname(__FILE__) + '/systems/sparkline_shield'
+
+class ShieldSystem
+
+  def initialize(output_path)
+    @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
+  end
+
+  def sparkline_shield(shield_name,chart_type,data,options={})
+    SparklineShield.new(shield_name,chart_type,data,options,@output_path).generate
+  end
+
+
+end
+

data/src/systems/github_shield.rb

@@ -0,0 +1,109 @@
+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)
+    @shield_name = shield_name
+    @key_text = "   #{key_text}"
+    @status_text = "   #{status_text}"
+    @key_colour = key_colour
+    @status_colour = status_colour
+    @key_text_colour = key_text_colour
+    @status_text_colour = status_text_colour
+    $background_colour = background_colour
+    @output_path = output_path
+    @font_size = font_size.to_i
+    @font_family = font_family
+    @buffer = buffer.to_i
+    @key_width = get_text_width(@key_text)
+    @status_width = get_text_width(@status_text)
+    @width = @key_width + @status_width
+    @height = height.to_i
+    @canvas = Magick::Image.new(@width, @height){ self.background_color = $background_colour }
+    @canvas.alpha(Magick::ActivateAlphaChannel)
+    @draw = Magick::Draw.new
+    @corners = 3
+  end
+
+  def generate
+    key_rectangle
+    status_rectangle
+    bridge_rectangle
+    key_text
+    status_text
+    publish
+  end
+
+  private
+
+  def key_rectangle
+    @draw.fill(@key_colour)
+    @draw.stroke(@key_colour)
+    @draw.stroke_width(1)
+    @draw.roundrectangle(0, 0, @key_width, @height-1, @corners, @corners)
+  end
+
+  def status_rectangle
+    @draw.fill(@status_colour)
+    @draw.stroke('transparent')
+    @draw.stroke_width(1)
+    @draw.roundrectangle(@key_width, 0, @status_width+@key_width, @height-1, @corners, @corners)
+  end
+
+  def bridge_rectangle
+    @draw.fill(@key_colour)
+    @draw.stroke(@key_colour)
+    @draw.stroke_width(3)
+    @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)
+    @draw.text_antialias(true)
+    @draw.font_style(Magick::NormalStyle)
+    @draw.font_weight(Magick::BoldWeight)
+    @draw.gravity(Magick::WestGravity)
+    @draw.text(0, 0, @key_text)
+  end
+
+  def status_text
+    @draw.fill(@status_text_colour)
+    @draw.font_family(@font_family)
+    @draw.font_size(@font_size)
+    @draw.text_antialias(true)
+    @draw.font_style(Magick::NormalStyle)
+    @draw.font_weight(Magick::BoldWeight)
+    @draw.gravity(Magick::WestGravity)
+    @draw.text(@key_width, 0, @status_text)
+  end
+
+  def publish
+    @draw.draw(@canvas)
+    @canvas.write(@output_path + '/' + @shield_name + '.gif')
+  end
+
+  def get_text_width(text)
+    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)
+    label.text_antialias(true)
+    label.font_style(Magick::NormalStyle)
+    label.font_weight(Magick::BoldWeight)
+    label.gravity(Magick::WestGravity)
+    label.text(0, 0, text)
+    metrics = label.get_type_metrics(canvas, text)
+    metrics.width.to_i + @buffer
+  end
+
+end
+
+
+
+
+
+

data/src/systems/sparkline_shield.rb

@@ -0,0 +1,52 @@
+require 'sparklines'
+require 'RMagick'
+
+class SparklineShield
+
+  def initialize(shield_name, chart_type, data, options, output_path)
+    @shield_name = shield_name
+    @chart_type = chart_type.to_sym
+    @data = data
+    @options = options
+    @output_path = output_path
+    @shield_list = [:bar,:pie]
+  end
+
+  def generate
+    raise ArgumentError, "Chart type: #{@chart_type} not supported - please use one of: #{@shield_list}" unless @shield_list.include?(@chart_type)
+    send @chart_type
+  end
+
+  def bar
+    Sparklines.plot_to_file(@output_path + "/#{@shield_name}.gif",
+                            @data, bar_default_options.merge(@options))
+  end
+
+  def bar_default_options
+    {
+        :type => 'bar',
+        :below_color => 'blue',
+        :above_color => 'orange',
+        :upper => 0,
+        :step => 6,
+        :height => 30,
+    }
+  end
+
+  def pie
+    Sparklines.plot_to_file(@output_path + "/#{@shield_name}.gif",
+                            @data,
+                            pie_default_options.merge(@options))
+  end
+
+  def pie_default_options
+    {
+        :type => 'pie',
+        :share_color => '#3BB314',
+        :remain_color => '#C8EDFA',
+        :diameter => 30
+
+    }
+  end
+
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: shield-system
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kingsley Hendrickse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sparklines
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create status badge images for use on github pages etc
+email: kingsley@masterthought.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- src/shield_system.rb
+- src/systems/github_shield.rb
+- src/systems/sparkline_shield.rb
+- src/presets/helpers/build_status.rb
+- src/presets/github_build_status.rb
+- README.md
+homepage: https://github.com/masterthought/shield-system
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- src
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Create status badge images for use on github pages etc
+test_files: []