badges2svg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85ed3f975ac572f368e96138a1faffed45c08879
+  data.tar.gz: 4b03e753f135fcebc11ef4a6ddfc24f26169017f
+SHA512:
+  metadata.gz: 8914c8c2e49d53b73f8ee53159c731b082827d076203bbcd12b76cf8369b69e47b9d746cc9226dcb3551a27bc672eb91aee33ec37ab12bdc9ca4babe351d9dd6
+  data.tar.gz: 1871ed4504be163892781a8393fa76534fe2fe5c95da957d089351cd301f2a277faf4458b678071d0479f609e8fbb5dbed242cfcd8f359df79dc9d31854839e9

data/bin/badges2svg

@@ -0,0 +1,26 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+
+require 'trollop'
+require 'badges2svg'
+
+opts = Trollop.options do
+  version "badges2svg #{BadgesToSVG.version}"
+  banner <<-EOS
+badges2svg is a tool to replace your PNG GitHub badges into SVG ones.
+
+Usage:
+    badges2svg <file>
+EOS
+end
+
+if ARGV.empty?
+  puts 'Error: No file provided. Use -h or --help to see the help.'
+  exit 1
+end
+
+content = File.read(ARGV[0])
+
+File.open(ARGV[0], 'w') do |f|
+  f.write(BadgesToSVG.replace(content))
+end

data/lib/badges2svg.rb

@@ -0,0 +1,104 @@
+module BadgesToSVG
+  class << self
+
+    ROOT = 'https://img.shields.io'
+
+    # see http://shields.io/
+    RULES = [
+      { :name    => :travis_branch,
+        :pattern => 'https?://(?:secure.)?travis-ci.org/%{user}/%{repo}.png' +
+                      '\\?branch=%{branch}',
+        :string  => '/travis/%{user}/%{repo}/%{branch}.svg'
+      },
+      {
+        :name    => :travis,
+        :pattern => 'https?://(?:secure.)?travis-ci.org/%{user}/%{repo}.png',
+        :string  => '/travis/%{user}/%{repo}.svg'
+      },
+      {
+        :name    => :gittip,
+        :pattern => 'https?://img.shields.io/gittip/%{user}.png',
+        :string  => '/gittip/%{user}.svg'
+      },
+      {
+        :name    => :coveralls_branch,
+        :pattern => 'https?://coveralls.io/repos/%{user}/%{repo}/badge.png' +
+                      '\\?branch=%{branch}',
+        :string  => '/coveralls/%{user}/%{repo}/%{branch}.svg'
+      },
+      {
+        :name    => :coveralls,
+        :pattern => 'https?://coveralls.io/repos/%{user}/%{repo}/badge.png',
+        :string  => '/coveralls/%{user}/%{repo}.svg'
+      },
+      {
+        :name    => :gemnasium,
+        :pattern => 'https?://gemnasium.com/%{user}/%{repo}.png',
+        :string  => '/gemnasium/%{user}/%{repo}.svg'
+      },
+      {
+        :name    => :code_climate,
+        :pattern => 'https://codeclimate.com/github/%{user}/%{repo}.png',
+        :string  => '/codeclimate/github/%{user}/%{repo}.svg'
+      },
+
+      {
+        :name    => :gem_version,
+        :pattern => 'https?://badge.fury.io/rb/%{repo}(?:@2x)?.png',
+        :string  => '/gem/v/%{repo}.svg'
+      },
+      {
+        :name    => :npm_version,
+        :pattern => 'https?://badge.fury.io/js/%{repo}(?:@2x)?.png',
+        :string  => '/npm/v/%{repo}.svg'
+      },
+      {
+        :name    => :pypi_version,
+        :pattern => 'https?://badge.fury.io/py/%{repo}(?:@2x)?.png',
+        :string  => '/pypi/v/%{repo}.svg'
+      },
+      {
+        :name    => :packagist_version,
+        :pattern => 'https?://poser.pugx.org/%{user}/%{repo}/version.png',
+        :string  => '/packagist/v/%{user}/%{repo}.svg'
+      },
+
+      {
+        :name    => :packagist_downloads,
+        :pattern => 'https?://poser.pugx.org/%{user}/%{repo}/d/total.png',
+        :string  => '/packagist/dm/%{user}/%{repo}.svg'
+      },
+      {
+        :name    => :pypi_downloads,
+        :pattern => 'https?://pypip.in/d/%{repo}/badge.png',
+        :string  => '/pypi/dm/%{repo}.svg'
+      },
+
+      {
+        :name    => :misc_png,
+        :pattern => 'https?://img.shields.io/%{path}.png',
+        :string  => '/%{path}.svg'
+      },
+    ]
+
+    def version
+      '0.1.0'
+    end
+
+    def compile_pattern(pat, *a)
+      pat = pat.gsub(/\./, '\\.')
+      Regexp.new ("\\b#{pat.gsub(/%\{(\w+)\}/, "(?<\\1>.+?)")}\\b")
+    end
+
+    def replace ct
+      content = ct.clone
+      RULES.each do |r|
+        content.gsub!(compile_pattern(r[:pattern]),
+                      ROOT + r[:string].gsub(/%\{(\w+)\}/, "\\\\k<\\1>"))
+      end
+
+      content
+    end
+
+  end
+end

data/tests/tests.rb

@@ -0,0 +1,245 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'test/unit'
+require 'simplecov'
+
+test_dir = File.expand_path( File.dirname(__FILE__) )
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start { add_filter '/tests/' }
+
+require 'badges2svg'
+
+for t in Dir.glob( File.join( test_dir,  '*_tests.rb' ) )
+  require t
+end
+
+class BadgesToSVGTests < Test::Unit::TestCase
+
+  # == BadgesToSVG#version == #
+
+  def test_version
+    assert(BadgesToSVG.version =~ /^\d+\.\d+\.\d+/)
+  end
+
+  # == BadgesToSVG#compile_pattern == #
+
+  def test_compile_pattern_empty
+    assert_equal(/\b\b/, BadgesToSVG.compile_pattern(""))
+  end
+
+  def test_compile_pattern_no_special_chars
+    assert_equal(/\bfoobar\b/, BadgesToSVG.compile_pattern("foobar"))
+    assert_equal(/\bq-a yo\b/, BadgesToSVG.compile_pattern("q-a yo"))
+  end
+
+  def test_compile_pattern_with_special_chars
+    assert_equal(/\bfoo\.bar\b/, BadgesToSVG.compile_pattern("foo.bar"))
+    assert_equal(/\ba?\b/, BadgesToSVG.compile_pattern("a?"))
+  end
+
+  def test_compile_pattern_with_one_field_name
+    assert_equal(/\b(?<abc>.+?)\b/, BadgesToSVG.compile_pattern("%{abc}"))
+    assert_equal(/\ba?\b/, BadgesToSVG.compile_pattern("a?"))
+  end
+
+  def test_compile_pattern_with_multiple_field_names
+    assert_equal(/\b(?<a>.+?)\/(?<b>.+?)\b/,
+                 BadgesToSVG.compile_pattern("%{a}/%{b}"))
+  end
+
+  # == BadgesToSVG#replace == #
+
+  def test_replace_empty_file
+    assert_equal("", BadgesToSVG.replace(""))
+  end
+
+  def test_replace_simple_file
+    ct = "# README\n\nHello World!"
+    assert_equal(ct, BadgesToSVG.replace(ct))
+  end
+
+  ## travis
+
+  def test_replace_one_travis_https
+    ct1 = "# README\n\nHello ![](https://secure.travis-ci.org/usr/re.png)"
+    ct2 = "# README\n\nHello ![](https://img.shields.io/travis/usr/re.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  def test_replace_one_travis_http
+    ct1 = "# README\n\nHello ![](http://travis-ci.org/usr/re.png)"
+    ct2 = "# README\n\nHello ![](https://img.shields.io/travis/usr/re.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ## travis_branch
+
+  def test_replace_one_travis_branch_https
+    ct1 = "# README\n\nHello ![](https://secure.travis-ci.org/usr/re.png?branch=bx)"
+    ct2 = "# README\n\nHello ![](https://img.shields.io/travis/usr/re/bx.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  def test_replace_one_travis_branch_http
+    ct1 = "# README\n\nHello ![](http://travis-ci.org/usr/re.png?branch=aa)"
+    ct2 = "# README\n\nHello ![](https://img.shields.io/travis/usr/re/aa.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ## gittip
+
+  def test_replace_one_gittip_http
+    ct1 = "here is a badge: ![](http://img.shields.io/gittip/sferik.png)"
+    ct2 = "here is a badge: ![](https://img.shields.io/gittip/sferik.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  def test_replace_one_gittip_https
+    ct1 = "here is a badge: ![](https://img.shields.io/gittip/sferik.png)"
+    ct2 = "here is a badge: ![](https://img.shields.io/gittip/sferik.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ## coveralls
+
+  def test_replace_one_coveralls_http
+    ct1 = "hello ![](http://coveralls.io/repos/sferik/t/badge.png)"
+    ct2 = "hello ![](https://img.shields.io/coveralls/sferik/t.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  def test_replace_one_coveralls_https
+    ct1 = "hello ![](https://coveralls.io/repos/sferik/t/badge.png)"
+    ct2 = "hello ![](https://img.shields.io/coveralls/sferik/t.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ## coveralls_branch
+
+  def test_replace_one_coveralls_branch_http
+    ct1 = "hello ![](http://coveralls.io/repos/sferik/t/badge.png?branch=abc)"
+    ct2 = "hello ![](https://img.shields.io/coveralls/sferik/t/abc.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  def test_replace_one_coveralls_branch_https
+    ct1 = "hello ![](https://coveralls.io/repos/sferik/t/badge.png?branch=abc)"
+    ct2 = "hello ![](https://img.shields.io/coveralls/sferik/t/abc.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ## gemnasium
+
+  def test_replace_one_gemnasium_http
+    ct1 = "![](http://gemnasium.com/sferik/t.png)"
+    ct2 = "![](https://img.shields.io/gemnasium/sferik/t.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  def test_replace_one_gemnasium_https
+    ct1 = "![](https://gemnasium.com/sferik/t.png)"
+    ct2 = "![](https://img.shields.io/gemnasium/sferik/t.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ## code_climate
+
+  def test_replace_one_code_climate
+    ct1 = "![](https://codeclimate.com/github/rails/rails.png)"
+    ct2 = "![](https://img.shields.io/codeclimate/github/rails/rails.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ## *_version
+
+  ### gem
+
+  def test_replace_one_gem_version
+    ct1 = "![](https://badge.fury.io/rb/t.png)"
+    ct2 = "![](https://img.shields.io/gem/v/t.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  def test_replace_one_gem_version_retina
+    ct1 = "![](https://badge.fury.io/rb/t@2x.png)"
+    ct2 = "![](https://img.shields.io/gem/v/t.svg)"
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ### pypi
+
+  def test_replace_one_pypi_version
+    ct1 = '![](https://badge.fury.io/py/gnuplot-py.png)'
+    ct2 = '![](https://img.shields.io/pypi/v/gnuplot-py.svg)'
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  def test_replace_one_pypi_version_retina
+    ct1 = '![](https://badge.fury.io/py/gnuplot-py@2x.png)'
+    ct2 = '![](https://img.shields.io/pypi/v/gnuplot-py.svg)'
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ### npm
+
+  def test_replace_one_npm_version
+    ct1 = '![](https://badge.fury.io/js/tp.png)'
+    ct2 = '![](https://img.shields.io/npm/v/tp.svg)'
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  def test_replace_one_npm_version_retina
+    ct1 = '![](https://badge.fury.io/js/tp@2x.png)'
+    ct2 = '![](https://img.shields.io/npm/v/tp.svg)'
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ### packagist
+
+  def test_replace_one_packagist_version
+    ct1 = '![](https://poser.pugx.org/foo/bar/version.png)'
+    ct2 = '![](https://img.shields.io/packagist/v/foo/bar.svg)'
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ## *_downloads
+
+  ### pypi
+
+  def test_replace_one_pypi_downloads
+    ct1 = '![](https://pypip.in/d/cpe/badge.png)'
+    ct2 = '![](https://img.shields.io/pypi/dm/cpe.svg)'
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ### packagist
+
+  def test_replace_one_packagist_downloads
+    ct1 = '![](https://poser.pugx.org/foo/bar/d/total.png)'
+    ct2 = '![](https://img.shields.io/packagist/dm/foo/bar.svg)'
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  ## misc
+
+  def test_replace_misc_png_http
+    ct1 = "![](http://img.shields.io/foo/bar-qux/zzz.png)"
+    ct2 = ct1.sub(/\.png/, '.svg').sub(/http:/, 'https:')
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+  def test_replace_misc_png_https
+    ct1 = "![](https://img.shields.io/foo/bar-qux/zzz.png)"
+    ct2 = ct1.sub(/\.png/, '.svg').sub(/http:/, 'https:')
+    assert_equal(ct2, BadgesToSVG.replace(ct1))
+  end
+
+end
+
+
+exit Test::Unit::AutoRunner.run

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: badges2svg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Baptiste Fontaine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Parse a markdown file and replace PNG badges with SVG ones.
+email: b@ptistefontaine.fr
+executables:
+- badges2svg
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/badges2svg
+- lib/badges2svg.rb
+- tests/tests.rb
+homepage: https://github.com/bfontaine/badges2svg
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Replace GitHub PNG badges into SVG ones
+test_files:
+- tests/tests.rb