lingohub_shield 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 606c2b83d7cd7310b1de2ea8171dc144cc0cbc62
+  data.tar.gz: f1d81c7074e780ffc3da0f25c7fc2f462d677ac6
+SHA512:
+  metadata.gz: 69e45726e9bf906b5719404ca42190a2feab45dcc01d7458fcd305ffbc144f780b2e37c06cf438daf9c145e67d5bf66cfae880bcd247dd4f678e06719bdda173
+  data.tar.gz: 13cd8256be1d8b051ad17a34a69f9cf2f77b4f675e4cbc102eae07ca3d31858711719e0e1a4e6d0937659bf83546f1c0cecaa18ed06a30ec9240b45b4da19d5d

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+/.idea/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    lingohub_shield (0.0.1)
+      rmagick (~> 2.13.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rake (10.1.0)
+    rmagick (2.13.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  lingohub_shield!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 lingohub
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 lingohub GmbH
+
+MIT License
+
+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,4 @@
+lingohub-shield
+===============
+
+Dynamic generator of Lingohub shields

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/lingohub_shield/shield_system.rb

@@ -0,0 +1,15 @@
+require 'lingohub_shield/systems/github_shield'
+
+class ShieldSystem
+
+  def initialize(output_path, name, locales)
+    @output_path = output_path
+    @name = name
+    @locales = locales
+  end
+
+  def github_shield
+    Systems::GithubShield.new(@output_path, @name, @locales).generate
+  end
+
+end

data/lib/lingohub_shield/systems/entry.rb

@@ -0,0 +1,78 @@
+require 'RMagick'
+
+module Systems
+  class Entry
+    include Comparable
+
+    LH = '#575757'
+    GREEN = '#45cb14'
+    YELLOW = '#c0cc14'
+    RED = '#cc2114'
+    GREEN_THRESHOLD = 95
+    YELLOW_THRESHOLD = 90
+
+    attr_reader :label, :percentage, :font_size, :font_family, :font_style, :font_gravity, :font_weight, :stroke, :stroke_width, :color, :width
+
+    # Initializes the shield entry
+    # @param [Symbol] label, the text that should be written within the entries container in the shield
+    # @param [Integer] percentage, value that determines the container background color
+    # @param [Integer] padding, space from the container's left and right edges to the label
+    def initialize(label, percentage, padding = 18)
+      @label = label
+      @percentage = percentage
+      @padding = padding
+
+      @font_size = 15
+      @font_family = 'helvetica'
+      @font_style = Magick::NormalStyle
+      @font_gravity = Magick::WestGravity
+      @stroke = 'transparent'
+      @stroke_width = 1
+      @color = 'white'
+      @width = get_text_width
+
+      if percentage
+        @font_weight = Magick::NormalWeight
+      else
+        @font_weight = Magick::BoldWeight
+      end
+    end
+
+    # returns the appropriate background color depending on the percentage
+    def background_color
+      if percentage.nil?
+        LH
+      elsif percentage > GREEN_THRESHOLD
+        GREEN
+      elsif percentage > YELLOW_THRESHOLD
+        YELLOW
+      else
+        RED
+      end
+    end
+
+    # enables sorting of entries alphabetically by label
+    def <=>(another)
+      label <=> another.label
+    end
+
+
+    private
+
+    def get_text_width
+      canvas = Magick::Image.new(100, 100) { self.background_color = 'transparent' }
+      canvas.alpha(Magick::ActivateAlphaChannel)
+      label = Magick::Draw.new
+      label.font_family(@font_family)
+      label.pointsize = @font_size
+      label.text_antialias(true)
+      label.font_style(@font_style)
+      label.font_weight(@font_weight)
+      label.gravity(@font_gravity)
+      label.text(0, 0, @label)
+      metrics = label.get_type_metrics(canvas, @label)
+      metrics.width.to_i + @padding
+    end
+
+  end
+end

data/lib/lingohub_shield/systems/github_shield.rb

@@ -0,0 +1,98 @@
+require 'lingohub_shield/systems/entry'
+
+module Systems
+  class GithubShield
+
+    # Initializes the github shield
+    # @param [String] output_path
+    # @param [String] name
+    # @param [Array<Hash>] locales
+    def initialize(output_path, name, locales)
+      @name = name
+      @output_path = output_path
+
+      # number of pixels from both ends of the label to the edge of the container
+      @padding = 18
+
+      # width of the left and right strip that contains the rounded edges
+      @corner_width = 2
+
+      lh_entry = Entry.new('LH', nil, @padding)
+      @entries = [lh_entry]
+
+
+      @shield_height = 25
+      @shield_width = lh_entry.width
+
+      @label_keys = [:lh]
+
+      locales.each do |locale|
+        entry = Entry.new(locale[:iso_code], locale[:percentage], @padding)
+        @entries << entry
+        @shield_width += entry.width
+      end
+
+      @label_keys[1..-1].sort!
+      @shield_width += @corner_width*2
+
+      @canvas = Magick::Image.new(@shield_width, @shield_height) { self.background_color = 'transparent' }
+      @canvas.alpha(Magick::ActivateAlphaChannel)
+      @draw = Magick::Draw.new
+    end
+
+    # Generates the shield with previously initialized parameters
+    def generate
+      draw_right_corners(@entries.last) unless @entries.empty?
+      draw_left_corners(@entries.first)
+
+      offset = @corner_width
+
+      @entries.each do |entry|
+        draw_rectangle entry, offset
+        draw_label entry, offset
+
+        offset += entry.width
+      end
+
+      publish
+    end
+
+    private
+
+    def draw_right_corners(entry)
+      @draw.fill(entry.background_color)
+      @draw.roundrectangle(@shield_width/2+1, 0, @corner_width, @shield_height-1, @corner_width, @corner_width)
+    end
+
+    # only purpose is to draw corners
+    def draw_left_corners(lh_entry)
+      @draw.fill(lh_entry.background_color)
+      @draw.roundrectangle(0, 0, @shield_width-@corner_width, @shield_height-1, @corner_width, @corner_width)
+    end
+
+    def draw_rectangle(entry, offset)
+      @draw.fill(entry.background_color)
+      @draw.stroke(entry.stroke)
+      @draw.stroke_width(entry.stroke_width)
+      @draw.rectangle(offset, 0, entry.width + offset, @shield_height)
+    end
+
+    def draw_label(entry, offset)
+      @draw.fill(entry.color)
+      @draw.font_family(entry.font_family)
+      @draw.pointsize = entry.font_size
+      @draw.text_antialias(true)
+      @draw.font_style(entry.font_style)
+      @draw.font_weight(entry.font_weight)
+      @draw.gravity(entry.font_gravity)
+      @draw.stroke = entry.stroke
+      @draw.text(offset + @padding/2, 2, entry.label)
+    end
+
+    def publish
+      @draw.draw(@canvas)
+      @canvas.write(@output_path + '/' + @name + '.png')
+    end
+
+  end
+end

data/lib/lingohub_shield/version.rb

@@ -0,0 +1,3 @@
+module LingohubShield
+  VERSION = "0.0.1"
+end

data/lib/lingohub_shield.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'lingohub_shield/version'
+require 'lingohub_shield/systems/github_shield'
+require 'lingohub_shield/shield_system'
+
+module LingohubShield
+
+  def self.create(output_path, name, locales, system)
+    shield_system = ShieldSystem.new output_path, name, locales
+
+    if system == 'github'
+      shield_system.github_shield
+    end
+  end
+
+end

data/lingohub_shield.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lingohub_shield/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lingohub_shield'
+  spec.version       = LingohubShield::VERSION
+  spec.authors       = ['Helmut Juskewycz', 'Marko Bošković']
+  spec.email         = ['helmut@lingohub.com', 'marko@lingohub.com']
+  spec.description   = %q{Generate a PNG shield for locales for the Lingohub service.}
+  spec.summary       = %q{Shield generator for Lingohub.}
+  spec.homepage      = 'http://lingohub.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'rmagick', '~> 2.13.1'
+end

data/spec/shield_system_spec.rb

@@ -0,0 +1,37 @@
+require 'rspec'
+require 'lingohub_shield/shield_system'
+require 'spec_helper'
+
+describe ShieldSystem do
+
+  before :each do
+    @output_path = File.dirname(__FILE__) + '/images'
+    @locales = [{ :iso_code => 'en', :percentage => 96 }, { :iso_code => 'de-AT', :percentage => 91 }, { :iso_code => 'es', :percentage => 79 }]
+    @locales2 = [{ :iso_code => 'en', :percentage => 96 }]
+  end
+
+  it 'should generate a github style status badge' do
+    name = 'github_shield'
+    shield = ShieldSystem.new(@output_path, name, @locales)
+
+    shield.github_shield
+    assert_file_exists?(name)
+  end
+
+  it 'should generate a github style status badge when there is a single locale' do
+    name = 'github_shield2'
+    shield = ShieldSystem.new(@output_path, name, @locales2)
+
+    shield.github_shield
+    assert_file_exists?(name)
+  end
+
+  it 'should generate a github style status badge when there are no locales' do
+    name = 'github_shield3'
+    shield = ShieldSystem.new(@output_path, name, [])
+
+    shield.github_shield
+    assert_file_exists?(name)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+class VerifyImage
+
+  def self.is_same(actual,expected)
+    compare = `compare -metric rmse -subimage-search #{actual} #{expected} null: 2>&1`
+    compare.strip == "0 (0)" ? true : compare
+  end
+
+end
+
+def assert_file_exists?(name)
+  actual = @output_path + "/#{name}.png"
+  File.exists?(actual).should == true
+  expected = "spec/images/expected_#{name}.png"
+  VerifyImage.is_same(actual, expected).should == true
+end

data/spec/systems/entry_spec.rb

@@ -0,0 +1,38 @@
+require 'rspec'
+require 'lingohub_shield/systems/entry'
+
+describe Systems::Entry do
+
+  it 'returns colors depending on percentage as expected' do
+    [1, 15, 89, 90, 94, 95, 96, 100].each do |percentage|
+      background_color = Systems::Entry.new('en', percentage).background_color
+
+      if percentage.nil?
+        background_color.should eq Systems::Entry::LH
+      elsif percentage > Systems::Entry::GREEN_THRESHOLD
+        background_color.should eq Systems::Entry::GREEN
+      elsif percentage > Systems::Entry::YELLOW_THRESHOLD
+        background_color.should eq Systems::Entry::YELLOW
+      else
+        background_color.should eq Systems::Entry::RED
+      end
+    end
+  end
+
+
+  it 'sorts entries alphabetically' do
+    entries = []
+    entries << Systems::Entry.new('en', 13)
+    entries << Systems::Entry.new('de-AT', 55)
+    entries << Systems::Entry.new('rs', 22)
+    entries << Systems::Entry.new('en-US', 99)
+
+    entries.sort!
+
+    entries[0].label.should eq 'de-AT'
+    entries[1].label.should eq 'en'
+    entries[2].label.should eq 'en-US'
+    entries[3].label.should eq 'rs'
+  end
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: lingohub_shield
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Helmut Juskewycz
+- Marko Bošković
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+description: Generate a PNG shield for locales for the Lingohub service.
+email:
+- helmut@lingohub.com
+- marko@lingohub.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lingohub_shield.rb
+- lib/lingohub_shield/shield_system.rb
+- lib/lingohub_shield/systems/entry.rb
+- lib/lingohub_shield/systems/github_shield.rb
+- lib/lingohub_shield/version.rb
+- lingohub_shield.gemspec
+- spec/images/expected_github_shield.png
+- spec/images/expected_github_shield2.png
+- spec/images/expected_github_shield3.png
+- spec/images/github_shield.png
+- spec/images/github_shield2.png
+- spec/images/github_shield3.png
+- spec/shield_system_spec.rb
+- spec/spec_helper.rb
+- spec/systems/entry_spec.rb
+homepage: http://lingohub.com
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Shield generator for Lingohub.
+test_files:
+- spec/images/expected_github_shield.png
+- spec/images/expected_github_shield2.png
+- spec/images/expected_github_shield3.png
+- spec/images/github_shield.png
+- spec/images/github_shield2.png
+- spec/images/github_shield3.png
+- spec/shield_system_spec.rb
+- spec/spec_helper.rb
+- spec/systems/entry_spec.rb