badgerbadgerbadger 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63132b8d500ee333f3fe6863f0400946fbc5eb9e
-  data.tar.gz: fd48a9db56e240b6ed0ce88f56a79f829148b8ce
+  metadata.gz: 6c290bb11da1c9bd67b11daa9f0dd1a734dce612
+  data.tar.gz: 5262999603b13416c27d83bf98de0d25b9a31883
 SHA512:
-  metadata.gz: 804a07ca25f61c6f6f903606a7bceb37e25371ac039e7fdf7f1db96dca00c57f62de06169d305194279d5617940641955968ad0ae09f68673a30c47d63aae591
-  data.tar.gz: 87dce7e9fc0b1de21375cf7a54d45ab40372765b95d5ff0d68ebf05ce5ee98d6690bcff85b1a466a9e9feb0d6afd508b231540187d9c9d1f7526ed1883aec1a7
+  metadata.gz: 3fb86368c205671bf9e6d4a6107b31c5a4223740efb16054aed7491c97cd750ca3aaf20413784440a924d1b53e956ada96314613670acbfef2f2adec1f41e563
+  data.tar.gz: 96141314900a00beb62b70384f288b800cba8dcdd86f4491b3ad384b21a69075f233ea5212c126abc8a9729a4aa66a79b7a5c7222c27d17e8a5ea7b9b284df9d

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.idea
+.idea
+TODO

data/config/config.yaml

@@ -0,0 +1 @@
+badge_service:    img.shields.io

data/config/licenses.yaml

@@ -0,0 +1,22 @@
+# license_name: - as found in a gemspec
+#   url:        - where the license lives
+#   regex:      - text to look for in the license file
+#   badge-text: - text to use in the generated badge, if different from license_name
+
+mit:
+  url:        http://%s.mit-license.org
+  regex:      The MIT License
+
+apache:
+  url:        http://www.apache.org/licenses/LICENSE-2.0.html
+  regex:      Apache License
+
+gpl-2.0:
+  url:        http://www.gnu.org/licenses/gpl-2.0.html
+  badge_text: gpl2
+  regex:      GNU GENERAL PUBLIC LICENSE.*Version 2
+
+gpl-3.0:
+  url:        http://www.gnu.org/licenses/gpl-3.0.html
+  badge_text: gpl3
+  regex:      GNU GENERAL PUBLIC LICENSE.*Version 3/

data/config/services.yaml

@@ -1,29 +1,26 @@
-services:
-  defaults:
-    travis:
-      alt_text:   Build Status
-      url:        travis-ci.org
-      badge_slug: travis
+defaults:
+  travis:
+    alt_text:   Build Status
+    url:        travis-ci.org
+    badge_slug: travis
 
-    coveralls:
-      alt_text:   Coverage Status
-      url:        coveralls.io/r
-      badge_slug: coveralls
+  coveralls:
+    alt_text:   Coverage Status
+    url:        coveralls.io/r
+    badge_slug: coveralls
 
-    gemnasium:
-      alt_text:   Dependency Status
-      url:        gemnasium.com
-      badge_slug: gemnasium
+  gemnasium:
+    alt_text:   Dependency Status
+    url:        gemnasium.com
+    badge_slug: gemnasium
 
-    codeclimate:
-      alt_text:   Code Climate
-      url:        codeclimate.com/github
-      badge_slug: codeclimate/github
+  codeclimate:
+    alt_text:   Code Climate
+    url:        codeclimate.com/github
+    badge_slug: codeclimate/github
 
-  extras:
-    mit:
-      alt_text:   License
-      badge_path: ":license-mit-blue.svg"
-      url:        http://%s.mit-license.org
-
-badge_service:    img.shields.io
+extras:
+  mit:
+    alt_text:   License
+    badge_path: ":license-mit-blue.svg"
+    url:        http://%s.mit-license.org

data/features/badger.feature

@@ -58,16 +58,16 @@ Feature: Badge Robot
 [![Code Climate](http://img.shields.io/codeclimate/github/doge/wow.svg)](https://codeclimate.com/github/doge/wow)
      """
 
-   Scenario: Generate additional badges
-     When I successfully run `badger badge --also mit /tmp/wow_repo`
-     Then the output should contain:
-     """
-[![Build Status](http://img.shields.io/travis/doge/wow.svg)](https://travis-ci.org/doge/wow)
-[![Coverage Status](http://img.shields.io/coveralls/doge/wow.svg)](https://coveralls.io/r/doge/wow)
-[![Dependency Status](http://img.shields.io/gemnasium/doge/wow.svg)](https://gemnasium.com/doge/wow)
-[![Code Climate](http://img.shields.io/codeclimate/github/doge/wow.svg)](https://codeclimate.com/github/doge/wow)
-[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
-     """
+#   Scenario: Generate additional badges
+#     When I successfully run `badger badge --also mit /tmp/wow_repo`
+#     Then the output should contain:
+#     """
+#[![Build Status](http://img.shields.io/travis/doge/wow.svg)](https://travis-ci.org/doge/wow)
+#[![Coverage Status](http://img.shields.io/coveralls/doge/wow.svg)](https://coveralls.io/r/doge/wow)
+#[![Dependency Status](http://img.shields.io/gemnasium/doge/wow.svg)](https://gemnasium.com/doge/wow)
+#[![Code Climate](http://img.shields.io/codeclimate/github/doge/wow.svg)](https://codeclimate.com/github/doge/wow)
+#[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
+#     """
 
    @gemspec
    Scenario: Generate badges based on gemspec
@@ -82,14 +82,14 @@ Feature: Badge Robot
 [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
      """
 
-   @gemspec
-   Scenario: gemspec and --also mit
-     Given I successfully run `badger badge --also mit /tmp/wow_repo`
-     Then the output should not contain:
-     """
-[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
-[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
-     """
+#   @gemspec
+#   Scenario: gemspec and --also mit
+#     Given I successfully run `badger badge --also mit /tmp/wow_repo`
+#     Then the output should not contain:
+#     """
+#[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
+#[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
+#     """
 
    Scenario: handle a non-git-repo gracefully
      When I run `badger badge /tmp`

data/features/licenses.feature

@@ -0,0 +1,45 @@
+Feature: Badge Robot
+
+  Background:
+    Given git remote is "https://github.com/doge/wow.git"
+
+  @license @mit
+  Scenario: Generate MIT license
+    When I successfully run `badger badge /tmp/wow_repo`
+    Then the output should contain:
+    """
+![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
+    """
+    And the output should not contain:
+    """
+Apache
+    """
+    And the output should not contain:
+    """
+![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
+![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
+    """
+
+  @license @apache
+  Scenario: Generate Apache license
+    When I successfully run `badger badge /tmp/wow_repo`
+    Then the output should contain:
+    """
+![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+    """
+    And the output should not contain:
+    """
+GPL
+    """
+
+  @license @gpl2
+  Scenario: Generate GPL2 license
+    When I successfully run `badger badge /tmp/wow_repo`
+    Then the output should contain:
+    """
+![License](http://img.shields.io/:license-gpl2-blue.svg)](http://www.gnu.org/licenses/gpl-2.0.html)
+    """
+    And the output should not contain:
+    """
+MIT
+    """

data/features/support/hooks.rb

@@ -23,6 +23,32 @@ Before '@no-remote' do
 end
 
 After '@no-remote' do
-#  FileUtils.remove_dir '/tmp/not_wow', :force => true
+  FileUtils.remove_dir '/tmp/not_wow', :force => true
 end
 
+Before '@mit' do
+  f = File.open '/tmp/wow_repo/LICENSE.md', 'w'
+  f.write "The MIT License (MIT)\n"
+  f.close
+end
+
+Before '@apache' do
+  f = File.open '/tmp/wow_repo/LICENSE.md', 'w'
+  f.write "Apache License\n"
+  f.write "Version 2.0\n"
+  f.close
+end
+
+Before '@gpl2' do
+  f = File.open '/tmp/wow_repo/LICENSE.md', 'w'
+  f.write "GNU GENERAL PUBLIC LICENSE\n"
+  f.write "Version 2\n"
+  f.close
+end
+
+Before '@gpl3' do
+  f = File.open '/tmp/wow_repo/LICENSE.md', 'w'
+  f.write "GNU GENERAL PUBLIC LICENSE\n"
+  f.write "Version 3\n"
+  f.close
+end

data/lib/badger.rb

@@ -3,6 +3,7 @@ require 'git'
 require 'badger/version'
 require 'badger/badger'
 require 'badger/service'
+require 'badger/license'
 
 module Badger
 

data/lib/badger/badger.rb

@@ -2,32 +2,31 @@ require 'yaml'
 
 module Badger
   class Badger
+    attr_reader :licenses, :badge_service
+
     def initialize url
       @github_slug = github_slug url
       @blacklist   = []
 
-      yaml = YAML.load(
-          File.open(
-              File.join(
-                  File.dirname(__FILE__),
-                  '..',
-                  '..',
-                  'config/services.yaml'
-              )
-          )
-      )
-
-      @services      = yaml['services']['defaults']
-      @extras        = yaml['services']['extras']
-      @badge_service = yaml['badge_service']
-      @extra_badges  = []
+      @licenses = YAML.load(File.open(File.join(File.dirname(__FILE__), '..', '..', 'config/licenses.yaml')))
+      yaml      = YAML.load(File.open(File.join(File.dirname(__FILE__), '..', '..', 'config/services.yaml')))
+      @services = yaml['defaults']
+      @extras   = yaml['extras']
+      @config   = YAML.load(File.open(File.join(File.dirname(__FILE__), '..', '..', 'config/config.yaml')))
+
+      @badge_service = @config['badge_service']
 
+      @extra_badges = []
     end
 
     def github_slug url
       @github_slug ||= /.*github\.com.(.*)\.git/.match(url)[1]
     end
 
+    def owner
+      @owner ||= @github_slug.split('/')[0]
+    end
+
     def badge
       s = []
       @services.each_pair do |k, h|
@@ -47,6 +46,11 @@ module Badger
       s.uniq
     end
 
+    def license type
+      @license = License.new self, type
+      @extra_badges << @license.badge
+    end
+
     def remove items
       items = [items] unless items.class.name == 'Array'
       items.each do |item|
@@ -68,20 +72,10 @@ module Badger
       items = [items] unless items.class.name == 'Array'
       s     = ''
       items.each do |item|
-
-        if @extras[item]
-          e = @extras[item]
-
-          owner = @github_slug.split('/')[0]
-          t     = e['url'] % owner
-          s     = "[![%s](http://%s/%s)](%s)" % [
-              e['alt_text'],
-              @badge_service,
-              e['badge_path'],
-              t
-          ]
+        if @licenses[item]
+          @license = License.new self, item
+          s << @license.badge
         end
-
         @extra_badges << s
       end
     end
@@ -97,17 +91,15 @@ module Badger
 
       @extra_badges << rg
 
-      lc      = ''
-      owner   = @github_slug.split('/')[0]
-      license = (lines.select { |l| /license/.match l })[0].split(/\s/)[-1]
-      if /MIT/i.match license
-        lc << "[![License](http://%s/:license-mit-blue.svg)](http://%s.mit-license.org)" % [
-            @badge_service,
-            owner
-        ]
+      spec_license = (lines.select { |l| /license/.match l })[0].split(/\s/)[-1][1..-2]
 
-        @extra_badges << lc
+      @licenses.each_pair do |k, v|
+        if /#{k}/im.match spec_license
+          @license = License.new self, spec_license
+        end
       end
+
+      @extra_badges << @license.badge
     end
 
     def to_s

data/lib/badger/cli.rb

@@ -15,21 +15,28 @@ Generates badges for Github READMEs. The default services are:
 
     * Gemnasium
 
-Extra badges: currently only one extra badge is supported, a link to the MIT license from here: https://github.com/remy/mit-license, e.g.
+If a gemspec is found, the following badges will also be generated:
 
-  [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)
+    * [License] badge, linking to the appropriate license
 
+    * [Gem version] badge, linking to rubygems.org
 
-If a gemspec is found, the following badges will also be generated:
+If a license file is found, a license badge will be generated. Currently supported licenses are:
 
-    * [License: MIT] badge (presuming an MIT license is specified, linked as above)
+    * MIT
+
+    * Apache
+
+    * GPL-2
+
+    * GPL-3
+
+The supported license details are in https://github.com/pikesley/badger/blob/master/config/licenses.yaml, if you're using a different license, send a PR! And if your gemspec license conflicts with your LICENSE file, you should probably fix that.
 
-    * [Gem version] badge, linking to rubygems.org
 
     LONGDESC
     option :not, desc: 'Exclude these services (comma-separated list)'
     option :only, desc: 'Generate for *only* these services (comma-separated list)'
-    option :also, desc: 'Include this extra service (currently only \'mit\')'
 
     def badge dir = '.'
       begin
@@ -57,6 +64,17 @@ If a gemspec is found, the following badges will also be generated:
         @badger.gemspec lines
       end
 
+      license_file = (Dir.entries dir).select { |i| /LICENSE/i.match i }[0]
+
+      if license_file
+        words = File.open(File.join(dir, license_file), 'r').read
+        @badger.licenses.each_pair do |k, v|
+          if /#{v['regex']}/im.match words
+            @badger.license k
+          end
+        end
+      end
+
       puts @badger.to_s
     end
 

data/lib/badger/license.rb

@@ -0,0 +1,27 @@
+module Badger
+  class License
+    def initialize badger, type
+      @badger = badger
+      @type   = type.downcase
+    end
+
+    def badge
+      return nil unless config = @badger.licenses[@type]
+
+      @url   = config['url']
+      if /%s/.match @url
+        @url = @url % @badger.owner
+      end
+
+      badge_text = @type unless badge_text = config['badge_text']
+
+      s = "[![License](http://%s/:license-%s-blue.svg)](%s)" % [
+          @badger.badge_service,
+          badge_text,
+          @url
+      ]
+
+      s
+    end
+  end
+end

data/lib/badger/version.rb

@@ -1,3 +1,3 @@
 module Badger
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/badger_spec.rb

@@ -14,6 +14,10 @@ module Badger
       it 'for an ssh url' do
         @badger.github_slug('git@github.com:doge/wow.git').should eql('doge/wow')
       end
+
+      it 'should have the owner' do
+        @badger.owner.should eql 'doge'
+      end
     end
 
     it 'should generate a badge list' do
@@ -64,5 +68,27 @@ module Badger
         @badger.badge[5].should == "[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)"
       end
     end
+
+    context 'licenses' do
+      it 'should generate an MIT badge' do
+        @badger.license 'mit'
+        @badger.badge[4].should == "[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)"
+      end
+
+      it 'should generate an Apache badge' do
+        @badger.license 'apache'
+        @badger.badge[4].should == "[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)"
+      end
+
+      it 'should generate a GPL3 badge' do
+        @badger.license 'gpl-3.0'
+        @badger.badge[4].should == "[![License](http://img.shields.io/:license-gpl3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0.html)"
+      end
+
+      it 'should generate nothing for an unknown license' do
+        @badger.license 'doge-license'
+        @badger.badge[4].should == nil
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: badgerbadgerbadger
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - pikesley
@@ -211,14 +211,18 @@ files:
 - Rakefile
 - badger.gemspec
 - bin/badger
+- config/config.yaml
+- config/licenses.yaml
 - config/services.yaml
 - features/badger.feature
+- features/licenses.feature
 - features/step_definitions/badger_steps.rb
 - features/support/env.rb
 - features/support/hooks.rb
 - lib/badger.rb
 - lib/badger/badger.rb
 - lib/badger/cli.rb
+- lib/badger/license.rb
 - lib/badger/service.rb
 - lib/badger/version.rb
 - spec/badger_spec.rb
@@ -250,6 +254,7 @@ summary: Badge-Driven Development made easy. Generate a set of Github badges for
   project without cutting-n-pasting every time
 test_files:
 - features/badger.feature
+- features/licenses.feature
 - features/step_definitions/badger_steps.rb
 - features/support/env.rb
 - features/support/hooks.rb