license_finder 0.5.0 → 0.6.0

data/lib/license_finder/license.rb

@@ -23,10 +23,20 @@ module LicenseFinder::License
 
   class Base
     class << self
+      attr_accessor :license_url, :alternative_names
+
       def inherited(descendant)
         LicenseFinder::License.all << descendant
       end
 
+      def names
+        [demodulized_name] + self.alternative_names
+      end
+
+      def alternative_names
+        @alternative_names ||= []
+      end
+
       def demodulized_name
         name.gsub(/^.*::/, '')
       end
@@ -41,7 +51,7 @@ module LicenseFinder::License
 
       def license_text
         unless defined?(@license_text)
-          template = File.join(LicenseFinder::ROOT_PATH, "templates", "#{demodulized_name}.txt").to_s
+          template = File.join(LicenseFinder::ROOT_PATH, "data", "licenses", "#{demodulized_name}.txt").to_s
 
           @license_text = Text.new(File.read(template)).to_s if File.exists?(template)
         end

data/lib/license_finder/license/apache2.rb

@@ -0,0 +1,8 @@
+class LicenseFinder::License::Apache2 < LicenseFinder::License::Base
+  self.alternative_names = ["Apache 2.0", "Apache2"]
+  self.license_url       = "http://www.apache.org/licenses/LICENSE-2.0.txt"
+
+  def self.pretty_name
+    'Apache 2.0'
+  end
+end

data/lib/license_finder/license/bsd.rb

@@ -1,2 +1,4 @@
 class LicenseFinder::License::BSD < LicenseFinder::License::Base
+  self.alternative_names = ["BSD4", "bsd-old", "4-clause BSD"]
+  self.license_url = "http://en.wikipedia.org/wiki/BSD_licenses#4-clause_license_.28original_.22BSD_License.22.29"
 end

data/lib/license_finder/license/gplv2.rb

@@ -1,2 +1,4 @@
 class LicenseFinder::License::GPLv2 < LicenseFinder::License::Base
+  self.license_url = 'http://www.gnu.org/licenses/gpl-2.0.txt'
+  self.alternative_names = ["GPL V2", "gpl-v2", "GNU GENERAL PUBLIC LICENSE Version 2"]
 end

data/lib/license_finder/license/isc.rb

@@ -1,2 +1,3 @@
 class LicenseFinder::License::ISC < LicenseFinder::License::Base
+  self.license_url = "http://en.wikipedia.org/wiki/ISC_license"
 end

data/lib/license_finder/license/lgpl.rb

@@ -1,2 +1,3 @@
 class LicenseFinder::License::LGPL < LicenseFinder::License::Base
+  self.license_url = "http://www.gnu.org/licenses/lgpl.txt"
 end

data/lib/license_finder/license/mit.rb

@@ -1,7 +1,10 @@
 class LicenseFinder::License::MIT < LicenseFinder::License::Base
+  self.license_url = "http://opensource.org/licenses/mit-license"
+  self.alternative_names = ["Expat"]
+
   HEADER_REGEX = /The MIT Licen[sc]e/
   ONE_LINER_REGEX = /is released under the MIT licen[sc]e/
-  URL_REGEX = %r{MIT Licen[sc]e.*http://www.opensource.org/licenses/mit-license}
+  URL_REGEX = %r{MIT Licen[sc]e.*http://(?:www.)?opensource.org/licenses/mit-license}
 
   def matches?
     super || matches_url? || matches_header?

data/lib/license_finder/license/new_bsd.rb

@@ -1,4 +1,7 @@
 class LicenseFinder::License::NewBSD < LicenseFinder::License::Base
+  self.license_url = "http://opensource.org/licenses/BSD-3-Clause"
+  self.alternative_names = ["Modified BSD", "BSD3", "BSD-3", "3-clause BSD"]
+
   def self.pretty_name
     'New BSD'
   end

data/lib/license_finder/license/ruby.rb

@@ -1,11 +1,11 @@
 class LicenseFinder::License::Ruby < LicenseFinder::License::Base
-  URL_REGEX = %r{http://www.ruby-lang.org/en/LICENSE.txt}
+  self.license_url = "http://www.ruby-lang.org/en/LICENSE.txt"
 
   def self.pretty_name
     'ruby'
   end
 
   def matches?
-    super || !!(text =~ URL_REGEX)
+    super || !!(text =~ /#{self.class.license_url}/)
   end
 end

data/lib/license_finder/license/simplified_bsd.rb

@@ -1,4 +1,7 @@
 class LicenseFinder::License::SimplifiedBSD < LicenseFinder::License::Base
+  self.license_url = "http://opensource.org/licenses/bsd-license"
+  self.alternative_names = ["Simplified BSD", "FreeBSD", "2-clause BSD"]
+
   def self.pretty_name
     'Simplified BSD'
   end

data/lib/license_finder/license_url.rb

@@ -0,0 +1,10 @@
+module LicenseFinder::LicenseUrl
+  extend self
+
+  def find_by_name(name)
+    return unless name.respond_to?(:downcase)
+
+    license = LicenseFinder::License.all.detect {|l| l.names.map(&:downcase).include? name.downcase }
+    license.license_url if license
+  end
+end

data/lib/license_finder/possible_license_file.rb

@@ -10,7 +10,7 @@ module LicenseFinder
     end
 
     def full_file_path
-      @file_path.realpath.to_s
+      Pathname.new(@file_path).realpath.to_s
     end
 
     def file_name
@@ -26,7 +26,7 @@ module LicenseFinder
         klass.new(text).matches?
       end
 
-      license && license.pretty_name
+      license.pretty_name if license
     end
   end
 end

data/lib/license_finder/railtie.rb

@@ -1,9 +1,7 @@
-require 'license_finder'
-require 'rails'
 module LicenseFinder
   class Railtie < Rails::Railtie
     rake_tasks do
       load "tasks/license_finder.rake"
     end
   end
-end
+end

data/lib/license_finder/reporter.rb

@@ -0,0 +1,51 @@
+module LicenseFinder
+  class Reporter
+    def self.create_default_configuration
+      unless File.exists?(LicenseFinder.config.config_file_path)
+        FileUtils.mkdir_p(File.join('.', 'config'))
+        FileUtils.cp(
+          File.join(File.dirname(__FILE__), '..', '..', 'files', 'license_finder.yml'),
+          LicenseFinder.config.config_file_path
+        )
+      end
+    end
+
+    def initialize
+      self.class.create_default_configuration
+      @dependency_list = generate_list
+      save_reports
+    end
+
+    def action_items
+      dependency_list.action_items
+    end
+
+    private
+
+    attr_reader :dependency_list
+
+    def save_reports
+      write_file LicenseFinder.config.dependencies_yaml, dependency_list.to_yaml
+      write_file LicenseFinder.config.dependencies_text, dependency_list.to_s
+      write_file LicenseFinder.config.dependencies_html, dependency_list.to_html
+    end
+
+    def write_file(file_path, content)
+      File.open(file_path, 'w+') do |f|
+        f.puts content
+      end
+    end
+
+    def generate_list
+      bundler_list = DependencyList.from_bundler
+
+      if File.exists?(LicenseFinder.config.dependencies_yaml)
+        yml = File.open(LicenseFinder.config.dependencies_yaml).readlines.join
+        existing_list = DependencyList.from_yaml(yml)
+        existing_list.merge(bundler_list)
+      else
+        bundler_list
+      end
+    end
+  end
+end

data/lib/license_finder/viewable.rb

@@ -0,0 +1,31 @@
+module LicenseFinder
+  module Viewable
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def underscored_name
+        @underscored_name ||= begin
+          str = name.dup
+          str.sub!(/.*::/, '')
+          str.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+          str.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+          str.downcase!
+        end
+      end
+    end
+
+    def to_yaml
+      as_yaml.to_yaml
+    end
+
+    def to_html
+      filename = File.join(File.dirname(__FILE__), '..', 'templates', "#{self.class.underscored_name}.html.erb")
+      template = ERB.new(File.read(filename))
+      template.result(binding)
+    end
+  end
+end

data/lib/tasks/license_finder.rake

@@ -1,29 +1,4 @@
-namespace :license do
-  desc 'write out example config file'
-  task :init do
-    `mkdir -p ./config`
-    FileUtils.cp(File.join(File.dirname(__FILE__), '..', '..', 'files', 'license_finder.yml'), './config/license_finder.yml')
-  end
-
-  desc 'generate a list of dependency licenses'
-  task :generate_dependencies do
-    LicenseFinder::Finder.new.write_files
-  end
-
-  desc 'action items'
-  task :action_items => :generate_dependencies do
-    LicenseFinder::CLI.new.check_for_action_items
-  end
-
-  desc 'return a failure status code for unapproved dependencies'
-  task 'action_items:ok' => :generate_dependencies do
-    puts "rake license:action_items:ok is deprecated and will be removed in version 1.0.  Use rake license:action_items instead."
-
-    found = LicenseFinder::Finder.new.action_items
-    if found.size == 0
-      puts "All gems are approved for use"
-    else
-      exit 1
-    end
-  end
+desc 'Audit your Gemfile for software licenses. This is the same as running `license_finder` in the terminal.'
+task :license_finder do
+  LicenseFinder::CLI.check_for_action_items
 end

data/lib/templates/dependency.html.erb

@@ -0,0 +1,54 @@
+<div id="<%= name %>" class="<%= approved ? "approved" : "unapproved" %>">
+  <h2>
+    <% if homepage && !homepage.empty? %>
+      <a href="<%= homepage %>"><%= name %></a>
+    <% else %>
+      <%= name %>
+    <% end %>
+    v<%= version %>
+    <% if bundler_groups.any? %>
+      (<%= bundler_groups.join(", ") %>)
+    <% end %>
+  </h2>
+  <table class="table table-striped table-bordered">
+    <thead>
+    <tr>
+      <th>Summary</th>
+      <th>Description</th>
+      <th>License</th>
+    </tr>
+    </thead>
+    <tbody>
+    <tr>
+      <td><%= summary %></td>
+      <td><%= description %></td>
+      <td>
+        <% if license_url && !license_url.empty? %>
+          <a href="<%= license_url %>"><%= license %></a>
+        <% else %>
+          <%= license %>
+        <% end %>
+      </td>
+      </td>
+    </tr>
+    </tbody>
+  </table>
+
+  <% if parents.any? %>
+    <dl>
+      <dt>Parents</dt>
+      <% parents.each do |parent| %>
+        <dd><%= parent.name %></dd>
+      <% end %>
+    </dl>
+  <% end %>
+
+  <% if children.any? %>
+    <dl>
+      <dt>Children</dt>
+      <% children.each do |child| %>
+        <dd><%= child.name %></dd>
+      <% end %>
+    </dl>
+  <% end %>
+</div>

data/lib/templates/dependency_list.html.erb

@@ -0,0 +1,38 @@
+<html>
+<head>
+  <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.1.1/css/bootstrap.min.css" rel="stylesheet">
+  <style type="text/css">
+    body {
+      margin: 50px;
+    }
+
+    .unapproved h2, .unapproved h2 a {
+      color: red;
+    }
+  </style>
+</head>
+<body>
+<div class="container">
+  <div class="summary hero-unit">
+    <h1>Dependencies</h1>
+
+    <h4>
+      <%= dependencies.size %> total
+
+      <% if unapproved_dependencies.any? %>
+        <span class="badge badge-important"><%= unapproved_dependencies.size %> unapproved</span>
+      <% end %>
+    </h4>
+
+    <ul>
+      <% grouped_dependencies.each do |license, group| %>
+        <li><%= group.size %> <%= license %></li>
+      <% end %>
+    </ul>
+  </div>
+  <div class="dependencies">
+    <%= sorted_dependencies.map(&:to_html).join("\n") %>
+  </div>
+</div>
+</body>
+</html>

data/license_finder.gemspec

@@ -1,16 +1,24 @@
 Gem::Specification.new do |s|
   s.name        = "license_finder"
-  s.version     = "0.5.0"
+  s.version     = "0.6.0"
   s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards", "Paul Meskers"]
   s.email       = ["brent@pivotalabs.com"]
   s.homepage    = "https://github.com/pivotal/LicenseFinder"
-  s.summary     = "Know your dependencies - and the licenses they are binding your application to."
-  s.description = "Find and display licenses of a project's gem dependencies, so that you know what your limitations are when distributing your application."
+  s.summary     = "Audit the OSS licenses of your application's dependencies."
+
+  s.description = <<-DESCRIPTION
+  Do you know the licenses of all your application's dependencies? What open source software licenses will your business accept?
+
+  LicenseFinder culls your Gemfile, detects the licenses of the gems in it, and gives you a report that you can act on. If you already know 
+  what licenses your business is comfortable with, you can whitelist them, leaving you with an action report of only those dependencies that have 
+  licenses that fall outside of the whitelist.
+  DESCRIPTION
+
   s.license     = "MIT"
 
   s.add_dependency "bundler"
   s.add_development_dependency "rails", ">=3"
-  %w(rspec rr rake cucumber rails pry).each do |gem|
+  %w(rspec rr rake cucumber rails pry capybara).each do |gem|
     s.add_development_dependency gem
   end
 

data/spec/lib/license_finder/bundled_gem_spec.rb

@@ -9,11 +9,12 @@ describe LicenseFinder::BundledGem do
       s.version = '2.1.3'
       s.summary = 'summary'
       s.description = 'description'
+      s.homepage = 'homepage'
     end
   end
 
   def fixture_path(fixture)
-    File.realpath(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec', 'fixtures', fixture))
+    Pathname.new(File.join(File.dirname(__FILE__), '..', '..', '..', 'spec', 'fixtures', fixture)).realpath.to_s
   end
 
   its(:name) { should == 'spec_name 2.1.3' }
@@ -108,14 +109,15 @@ describe LicenseFinder::BundledGem do
     end
   end
 
-  describe '#dependency' do
-    subject { LicenseFinder::BundledGem.new(gemspec).dependency }
+  describe '#to_dependency' do
+    subject { LicenseFinder::BundledGem.new(gemspec).to_dependency }
 
     its(:name) { should == 'spec_name' }
     its(:version) { should == '2.1.3' }
     its(:summary) { should == 'summary' }
     its(:source) { should == 'bundle' }
     its(:description) { should == 'description' }
+    its(:homepage) { should == 'homepage' }
 
     describe 'with a known license' do
       before do

data/spec/lib/license_finder/dependency_list_spec.rb

@@ -1,12 +1,16 @@
 require 'spec_helper'
 
 describe LicenseFinder::DependencyList do
-  def build_gemspec(name, version)
+  def build_gemspec(name, version, dependency=nil)
     Gem::Specification.new do |s|
       s.name = name
       s.version = version
       s.summary = 'summary'
       s.description = 'description'
+
+      if dependency
+        s.add_dependency dependency
+      end
     end
   end
 
@@ -37,6 +41,24 @@ describe LicenseFinder::DependencyList do
       subject.dependencies[1].name.should == 'gem2'
       subject.dependencies[1].version.should == '0.4.2'
     end
+
+    context "when initialized with a parent and child gem" do
+      subject do
+        bundle = stub(Bundler::Definition).build.stub!
+        bundle.dependencies { [] }
+        bundle.groups { [] }
+        bundle.specs_for { [build_gemspec('gem1', '1.2.3', 'gem2'), build_gemspec('gem2', '0.4.2')] }
+
+        LicenseFinder::DependencyList.from_bundler
+      end
+
+      it "should update the child dependency with its parent data" do
+        gem1 = subject.dependencies.first
+        gem2 = subject.dependencies.last
+
+        gem2.parents.should == [gem1]
+      end
+    end
   end
 
   describe '#from_yaml' do
@@ -74,7 +96,8 @@ describe LicenseFinder::DependencyList do
           'license' => 'MIT',
           'approved' => false,
           'source' => nil,
-          'license_url' => '',
+          'homepage' => nil,
+          'license_url' => LicenseFinder::License::MIT.license_url,
           'notes' => '',
           'license_files' => nil,
           'readme_files' => nil
@@ -85,7 +108,8 @@ describe LicenseFinder::DependencyList do
           'license' => 'MIT',
           'approved' => false,
           'source' => 'bundle',
-          'license_url' => '',
+          'homepage' => nil,
+          'license_url' => LicenseFinder::License::MIT.license_url,
           'notes' => '',
           'license_files' => nil,
           'readme_files' => nil
@@ -175,24 +199,45 @@ describe LicenseFinder::DependencyList do
   describe "#to_s" do
     it "should return a human readable list of dependencies" do
 
-      gem1 = Struct.new(:name, :to_s).new("a", "a string ")
+      gem1 = Struct.new(:name, :to_s).new("a", "a string")
       gem2 = Struct.new(:name, :to_s).new("b", "b string")
 
       list = LicenseFinder::DependencyList.new([gem2, gem1])
 
-      list.to_s.should == "a string b string"
+      list.to_s.should == "a string\nb string"
     end
   end
 
   describe '#action_items' do
     it "should return all unapproved dependencies" do
-      gem1 = Struct.new(:name, :to_s, :approved).new("a", "a string ", true)
-      gem2 = Struct.new(:name, :to_s, :approved).new("b", "b string ", false)
-      gem3 = Struct.new(:name, :to_s, :approved).new("c", "c string", false)
+      gem1 = LicenseFinder::Dependency.new('name' => 'a', 'approved' => true)
+      stub(gem1).to_s { 'a string' }
+
+      gem2 = LicenseFinder::Dependency.new('name' => 'b', 'approved' => false)
+      stub(gem2).to_s { 'b string' }
+
+      gem3 = LicenseFinder::Dependency.new('name' => 'c', 'approved' => false)
+      stub(gem3).to_s { 'c string' }
 
       list = LicenseFinder::DependencyList.new([gem1, gem2, gem3])
 
-      list.action_items.should == "b string c string"
+      list.action_items.should == "b string\nc string"
+    end
+  end
+
+  describe '#to_html' do
+    it "should concatenate the results of the each dependency's #to_html and plop it into a proper HTML document" do
+      gem1 = LicenseFinder::Dependency.new('name' => 'a')
+      stub(gem1).to_html { 'A' }
+
+      gem2 = LicenseFinder::Dependency.new('name' => 'b')
+      stub(gem2).to_html { 'B' }
+
+      list = LicenseFinder::DependencyList.new([gem1, gem2])
+
+      html = list.to_html
+      html.should include "A"
+      html.should include "B"
     end
   end
 end