repo-small-badge 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d016c07e5425d160473ee038e4f425be76d1d9e508a20f00a9418057dd7c980
+  data.tar.gz: ccf25c903bb72632592af4f3494fe7e43703c999812e5f6842c0310a3ea558ee
+SHA512:
+  metadata.gz: 938fb539afd31f41eeec309264b1e2758dd6a8047f60187cfc505237333dca6961b31af6f14c2a0457f77f4083ef404a3172d1e6da9a92a6b4151f472882f0f9
+  data.tar.gz: 772a1738476f175c19d803d146f5c7b9f2e5ba319eab883735b4636a03755579d7eab0d10882885d91d0b134362e4acdfb3cdf406d2b01470fd034aa8e0f1da2

data/.document

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

data/.gitignore

@@ -0,0 +1,15 @@
+.rvmrc
+.bundle
+Gemfile.lock
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.sass-cache
+*.gem
+
+## PROJECT::SPECIFIC
+
+vendor
+.byebug_history

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Metrics/ModuleLength:
+  Exclude:
+    - "spec/*_spec.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/*_spec.rb"

data/.ruby-gemset

@@ -0,0 +1 @@
+repo-small-badge

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+branches:
+  only:
+  - master
+rvm:
+- 2.5.1
+cache: bundler
+bundler_args: "--jobs=3 --retry=3 --without production"
+matrix:
+  fast_finish: true
+script:
+- sh script/travis.sh
+deploy:
+  provider: pages
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  keep-history: true
+  verbose: true
+  on:
+    branch: master

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'byebug', group: %i[development test]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Marc Grimme
+
+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,45 @@
+# RepoSmallBadge
+
+[![Build Status](https://api.travis-ci.org/MarcGrimme/repo-small-badge.svg?branch=master)](https://secure.travis-ci.org/MarcGrimme/repo-small-badge)
+[![Depfu](https://badges.depfu.com/badges/e794da00404482f66ce7ca05eea9640b/count.svg)](https://depfu.com/github/MarcGrimme/repo-small-badge?project_id=6915)
+![Coverage](https://marcgrimme.github.io/repo-small-badge/badges/coverage_badge_total.png)
+
+*RepoSmalladge* is a gem that can be added to the `Gemfile` and consolidates functionality to produce a badge file.
+The text place and other configurable can be specified at instance time.
+
+## Installation
+
+The badge creation is dependent on the [MiniMagic gem](https://github.com/minimagick/minimagick) which requires the [ImageMagick](http://www.imagemagick.org/index.php) software.
+
+It can be installed in your Ruby library or rails app as part of the `Gemfile` as follows.
+
+```
+# In your gemfile
+gem 'repo-small-badge', :require => false
+```
+
+## Usage
+
+Most propably you need a surrounding formatter for a different badge you want to create and this gem is implicitly required.
+
+Examples are:
+* [SimpleCovSmallBadge](https://github.com/MarcGrimme/simplecov-small-badge)
+
+## Configuration Options
+
+The behaviour of `RepoSmallBadge` can be influenced by configuration options that are passed to the constructor as a hash.
+The following options are supported:
+
+## Development
+
+After checking out the repo, run `bundle update` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/marcgrimme/repo-small-badge/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task default: :spec

data/bin/console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'simplecov_small_badge'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+# rubocop:disable Style/GlobalVars
+$badge = RepoSmallBadge::Image.new(config)
+# rubocop:enable Style/GlobalVars
+
+require 'irb'
+IRB.start

data/lib/repo_small_badge.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module RepoSmallBadge
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
+require 'repo_small_badge/version'
+require 'repo_small_badge/image'

data/lib/repo_small_badge/image.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'mini_magick'
+
+ImageMagickError = Class.new(StandardError)
+
+module RepoSmallBadge
+  # :nodoc:
+  class Image
+    # Create new instance.
+    # @config is a Hash of configurables. Keys are symbols.
+    def initialize(config = {})
+      raise ImageMagicError, 'Imagemagick is not installed on this system.' \
+        unless MiniMagick.imagemagick?
+
+      @config = config
+      MiniMagick.logger = Logger.new($stdout, level:
+                                     @config.fetch(:log_level, 'info')
+        .to_sym)
+    end
+
+    # Creates the badge.
+    # @name the suffix for the filename (badge_#{name})
+    # @title the title of the badge.
+    # @value is the overall value to be written to the right side of the badge.
+    # @state can be either good, bad, unknown
+    #        (background color is determined from it.)
+    def badge(name, title, value, state)
+      MiniMagick::Tool::Convert.new do |convert|
+        convert.gravity('center')
+        convert.background(@config.fetch(:background, 'transparent'))
+        convert.pango(pango(title, value, state))
+        rounded_border? &&
+          rounded_border(convert,
+                         @config.fetch(:rounded_edge_radius, 3))
+        convert << filename(name)
+      end
+      true
+    end
+
+    private
+
+    # rubocop:disable Lint/Void, Metrics/LineLength, Metrics/MethodLength, Metrics/AbcSize
+    def rounded_border(convert, radius = 3)
+      convert.stack do |stack|
+        stack.clone.+
+        stack.alpha('extract')
+        stack.draw("fill black polygon 0,0 0,#{radius} #{radius},0 fill white circle #{radius},#{radius} #{radius},0")
+        stack.stack do |stack1|
+          stack1.clone.+
+          stack1.flip
+        end
+        stack.compose('Multiply')
+        stack.composite
+        stack.stack do |stack1|
+          stack1.clone.+
+          stack1.flop
+        end
+        stack.compose('Multiply')
+        stack.composite
+      end
+      convert.alpha('off')
+      convert.compose('CopyOpacity')
+      convert.composite
+    end
+    # rubocop:enable Lint/Void, Metrics/LineLength, Metrics/MethodLength, Metrics/AbcSize
+
+    def rounded_border?
+      @config.fetch(:rounded_border, true)
+    end
+
+    def pango(title, value, state)
+      "#{pango_title(title)}#{pango_value(value, state)}"
+    end
+
+    def pango_title(suffix)
+      pango_text(title(suffix), @config.fetch(:title_font, 'Helvetica'),
+                 @config.fetch(:title_font_color, 'white'),
+                 @config.fetch(:title_font_size, '16'),
+                 @config.fetch(:title_background, '#595959'))
+    end
+
+    def pango_value(value, state)
+      pango_text " #{value} ",
+                 @config.fetch(:value_font, 'Helvetica-Narrow-Bold'),
+                 @config.fetch(:coverage_font_color, 'white'),
+                 @config.fetch(:coverage_font_size, '16'),
+                 state_background(state)
+    end
+
+    def pango_text(text, font, font_color, font_size, background)
+      "<span foreground=\"#{font_color}\"
+             background=\"#{background}\"\
+             size=\"#{font_size.to_i * 1000}\"\
+             font=\"#{font}\"\
+        >#{text}</span>"
+    end
+
+    def state_background(state)
+      @config.fetch(:"value_background_#{state}", 'yellow')
+    end
+
+    def filename(suffix = '')
+      prefix = @config.fetch(:filename_prefix, 'badge')
+      format = @config.fetch(:format, 'png')
+      "#{output_path}/#{prefix}_#{suffix}.#{format}"
+    end
+
+    def title(suffix)
+      " #{@config.fetch(:title_prefix, 'badge')} #{suffix} "
+    end
+
+    def output_path
+      @config.fetch(:output_path, '.')
+    end
+  end
+end

data/lib/repo_small_badge/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RepoSmallBadge
+  VERSION = '0.1'
+end

data/repo-small-badge.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'repo_small_badge/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'repo-small-badge'
+  s.version     = RepoSmallBadge::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Marc Grimme']
+  s.email       = ['marc.grimme at gmail dot com']
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/marcgrimme/repo-small-badge'
+  s.summary     = %(Small Badge generator to be used for different tools 4 ruby)
+  s.description = %(Small Badge generator to be used for different tools 4 ruby)
+
+  s.rubyforge_project = 'repo-small-badge'
+
+  s.add_dependency 'mini_magick'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
+  # s.add_development_dependency 'simplecov-small-badge'
+
+  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/script/travis.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+set -e
+RUBYCRITICLIMIT=${RUBYCRITICLIMIT:-"90.0"}
+
+bundle exec rspec
+bundle exec rubocop
+gem install bundler-audit && bundle-audit update && bundle-audit check
+gem install rubycritic && rubycritic app lib config ${RUBYCRITICPARAMS} --format console --minimum-score ${RUBYCRITICLIMIT}
+echo "Pushing badges upstream"
+[ -d badges ] || mkdir badges
+cp coverage/*.png badges/ 2>/dev/null || true

data/spec/repo_small_badge_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RepoSmallBadge::Image do
+  include TestRepoSmallBadge::Mocks
+
+  context '#coverage_total' do
+    describe '#coverage' do
+      it do
+        mock_mini_magick(name: 'total', title: 'badge Total',
+                         color: 'yellow', value: '100',
+                         output_path: '.',
+                         stack: mock_mini_magick_stack)
+        expect(subject.badge('total', 'Total', 100, 'good'))
+          .to be_truthy
+      end
+
+      context 'without rounded' do
+        subject { described_class.new(rounded_border: false) }
+        it do
+          mock_mini_magick(name: 'total', title: 'badge Total',
+                           color: 'yellow', value: '100',
+                           rounded_border: false,
+                           output_path: '.',
+                           stack: mock_mini_magick_stack)
+          expect(subject.badge('total', 'Total', 100, 'good')).to be_truthy
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'byebug'
+
+SimpleCov.start do
+  # module SimpleCovSmallBadge
+  #   class Formatter
+  #   end
+  # end
+  #
+  # SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+  #   [
+  #     SimpleCov::Formatter::HTMLFormatter,
+  #     SimpleCovSmallBadge::Formatter
+  #   ]
+  # )
+end
+
+SimpleCov.minimum_coverage 100
+
+# require 'simplecov-small-badge'
+require 'repo_small_badge'
+require 'rubygems'
+require 'bundler/setup'
+
+Dir[File.join('./spec/support/*.rb')].each { |f| require f }
+
+# SimpleCovSmallBadge.configure do |config|
+#   # config.rounded_border = false
+# end
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/support/mocks.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module TestRepoSmallBadge
+  module Mocks
+    # rubocop:disable Metrics/LineLength
+    def pango_text_match(title = 'badge', color = 'green', value = '100')
+      %(<span foreground="white"
+             background="#595959"             size="16000"             font="Helvetica"        > #{title} </span><span foreground="white"
+             background="#{color}"             size="16000"             font="Helvetica-Narrow-Bold"        > #{value} </span>)
+    end
+    # rubocop:enable Metrics/LineLength
+
+    # rubocop:disable Metrics/LineLength, Metrics/AbcSize
+    def mock_mini_magick_stack(stack = instance_double('Stack'))
+      allow(stack).to receive_message_chain('clone.+')
+      allow(stack).to receive(:alpha).with('extract')
+      allow(stack).to receive(:draw).with('fill black polygon 0,0 0,3 3,0 fill white circle 3,3 3,0')
+      allow(stack).to receive(:flip)
+      allow(stack).to receive(:flop)
+      allow(stack).to receive(:compose).with('Multiply')
+      allow(stack).to receive(:composite)
+      allow(stack).to receive(:stack).and_yield(stack)
+      stack
+    end
+    # rubocop:enable Metrics/LineLength, Metrics/AbcSize
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def mock_mini_magick(**keys)
+      keys[:convert] ||= instance_double('Convert')
+      convert = keys[:convert]
+      pango_text = pango_text_match(keys[:title], keys[:color], keys[:value])
+      allow(MiniMagick::Tool::Convert)
+        .to receive(:new).and_yield(keys[:convert])
+      allow(convert).to receive(:gravity).with('center')
+      allow(convert).to receive(:background).with('transparent')
+      allow(convert).to receive(:pango).with(pango_text)
+
+      if keys.fetch(:rounded_border, true)
+        allow(convert).to receive(:stack).and_yield(keys[:stack])
+        allow(convert).to receive(:compose).with('CopyOpacity')
+        allow(convert).to receive(:alpha).with('off')
+        allow(convert).to receive(:composite)
+      end
+      allow(convert).to receive(:<<)
+        .with("#{keys[:output_path]}/badge_#{keys[:name]}.png")
+      convert
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: repo-small-badge
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Marc Grimme
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: 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: rubocop
+  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: simplecov
+  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: Small Badge generator to be used for different tools 4 ruby
+email:
+- marc.grimme at gmail dot com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- lib/repo_small_badge.rb
+- lib/repo_small_badge/image.rb
+- lib/repo_small_badge/version.rb
+- repo-small-badge.gemspec
+- script/travis.sh
+- spec/repo_small_badge_spec.rb
+- spec/spec_helper.rb
+- spec/support/mocks.rb
+homepage: https://github.com/marcgrimme/repo-small-badge
+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: repo-small-badge
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Small Badge generator to be used for different tools 4 ruby
+test_files: []