license_finder 0.9.5.1 → 1.0.0.0

data/lib/license_finder/yml_to_sql.rb

@@ -8,7 +8,7 @@ module LicenseFinder
     end
 
     def self.load_yml
-      YAML.load File.read(yml_path)
+      YAML.load yml_path.read
     end
 
     def self.convert_all(all_legacy_attrs)
@@ -20,15 +20,15 @@ module LicenseFinder
     end
 
     def self.needs_conversion?
-      File.exists?(yml_path)
+      yml_path.exist?
     end
 
     def self.remove_yml
-      File.delete(yml_path)
+      yml_path.delete
     end
 
     def self.yml_path
-      LicenseFinder.config.dependencies_yaml
+      LicenseFinder.config.artifacts.legacy_yaml_file
     end
 
     def initialize(attrs)

data/license_finder.gemspec

@@ -3,7 +3,7 @@ require './lib/license_finder/platform'
 Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.3'
   s.name        = "license_finder"
-  s.version     = "0.9.5.1"
+  s.version     = "1.0.0.0"
   s.authors     = ["Jacob Maine", "Matthew Kane Parker", "Ian Lesperance", "David Edwards", "Paul Meskers", "Brent Wheeldon", "Trevor John", "David Tengdin", "William Ramsey"]
   s.email       = ["licensefinder@pivotalabs.com"]
   s.homepage    = "https://github.com/pivotal/LicenseFinder"
@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
   s.add_dependency "bundler"
   s.add_dependency "sequel"
   s.add_dependency "thor"
-  s.add_dependency "rake"
   s.add_dependency "httparty"
+  s.add_dependency "xml-simple"
   s.add_dependency LicenseFinder::Platform.sqlite_gem
 
   %w(rspec xpath cucumber pry).each do |gem|
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "capybara", "~> 2.0.0"
   s.add_development_dependency "rails", "~> 3.2.0"
   s.add_development_dependency "webmock", "~> 1.13"
+  s.add_development_dependency "rake"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/readme.md

@@ -16,9 +16,14 @@ Add license_finder to your project's Gemfile and `bundle`:
 gem 'license_finder'
 ```
 
+#### For gradle projects
+
+You need to install the license gradle plugin: [https://github.com/hierynomus/license-gradle-plugin](https://github.com/hierynomus/license-gradle-plugin)
+
 
 ## Usage
 
+
 License finder will generate reports of action items - i.e., dependencies that do not fall within your license "whitelist".
 
 ```sh
@@ -246,7 +251,11 @@ And add a `LICENSE` file to your gem that contains your license text.
 * Rebase on top of master
 * Send a pull request
 
-To successfully run the test suite, you will need node.js, and python installed.
+To successfully run the test suite, you will need node.js, python and pip installed (pip should not require sudo to work, virtualenv will work for this). If you're running the test suite with jruby, you're probably going to want to set up these environment variables:
+
+```
+JAVA_OPTS='-client -XX:+TieredCompilation -XX:TieredStopAtLevel=1' JRUBY_OPTS='-J-Djruby.launch.inproc=true'
+```
 
 ## License
 

data/release/publish.sh

@@ -14,16 +14,19 @@ function perform {
   $1
 }
 
-printf "\nBuilding jruby..."
+printf "\nBuilding jruby gem"
 perform "rvm use jruby"
-perform "rake build"
+perform "gem build *.gemspec"
 
-printf "\nBuilding ruby..."
+printf "\nBuilding ruby gem"
 perform "rvm use ruby"
-perform "rake build"
+perform "gem build *.gemspec"
 
-printf "\nPublishing to rubygems..."
-perform "rake release"
-perform "gem push pkg/license_finder-$LF_GEM_VERSION-java.gem"
+for file in *.gem
+do
+    perform "gem push $file"
+done
+
+perform "rm *.gem"
 
 printf "\nRelease finished."

data/spec/fixtures/build.gradle

@@ -0,0 +1,24 @@
+apply plugin: 'java'
+
+sourceCompatibility = 1.5
+version = '1.0'
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    compile group: 'junit', name: 'junit', version: '4.11'
+}
+
+buildscript {
+    repositories {
+        mavenCentral()
+    }
+
+    dependencies {
+        classpath 'nl.javadude.gradle.plugins:license-gradle-plugin:0.7.0'
+    }
+}
+
+apply plugin: 'license'

data/spec/fixtures/pom.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>dummy</groupId>
+  <artifactId>dummy</artifactId>
+  <version>1.0-SNAPSHOT</version>
+
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.11</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+</project>

data/spec/lib/license_finder/cli_spec.rb

@@ -206,6 +206,16 @@ module LicenseFinder
             subject.approve 'foo', 'bar'
           end
         end
+
+        it "raises a warning if no gem was specified" do
+          DependencyManager.should_not_receive(:approve!)
+
+          silence_stdout do
+            subject.should_receive(:say).with(/Warning/, :red)
+            subject.should_not_receive(:say).with(/dependency has been approved/, anything)
+            subject.approve
+          end
+        end
       end
 
       describe "#action_items" do
@@ -213,8 +223,8 @@ module LicenseFinder
           Dependency.stub(:unapproved) { ['one dependency'] }
           TextReport.stub(:new) { double(:report, to_s: "a report!") }
           silence_stdout do
-            $stdout.stub(:puts)
-            $stdout.should_receive(:puts).with(/dependencies/i)
+            subject.stub(:say)
+            subject.should_receive(:say).with(/dependencies/i, :red)
             expect { subject.action_items }.to raise_error(SystemExit)
           end
         end
@@ -222,7 +232,7 @@ module LicenseFinder
         it "reports that all dependencies are approved" do
           Dependency.stub(:unapproved) { [] }
           silence_stdout do
-            $stdout.should_receive(:puts).with(/approved/i)
+            subject.should_receive(:say).with(/approved/i, :green)
             expect { subject.action_items }.to_not raise_error
           end
         end

data/spec/lib/license_finder/configuration_spec.rb

@@ -2,123 +2,170 @@ require "spec_helper"
 
 module LicenseFinder
   describe Configuration do
-    let(:config) { described_class.new }
+    describe ".ensure_default" do
+      it "should init and use saved config" do
+        Configuration::Persistence.should_receive(:init)
+        Configuration::Persistence.stub(:get).and_return('whitelist' => ['Saved License'])
 
-    let(:klass) { described_class }
+        described_class.ensure_default.whitelist.should == ['Saved License']
+      end
+    end
 
     describe '.new' do
-      let(:attributes) do
-        {
-          "whitelist" => ["FooLicense", "BarLicense"],
-          "ignore_groups" => [:test, :development],
-          "dependencies_file_dir" => ".",
-          "project_name" => "my_app"
-        }
+      it "should default missing attributes" do
+        subject = described_class.new({})
+        subject.whitelist.should == []
+        subject.ignore_groups.should == []
+        subject.artifacts.dir.should == Pathname('./doc/')
       end
 
-      subject { klass.new(attributes) }
+      it "should default missing attributes even if they are saved as nils in the YAML file" do
+        attributes = {
+          "whitelist" => nil,
+          "ignore_groups" => nil,
+          "dependencies_file_dir" => nil,
+          "project_name" => nil
+        }
+        subject = described_class.new(attributes)
+        subject.whitelist.should == []
+        subject.ignore_groups.should == []
+        subject.artifacts.dir.should == Pathname('./doc/')
+        subject.project_name.should_not be_nil
+      end
 
-      context "with known attributes" do
-        it "should set the all of the attributes on the instance" do
-          subject.whitelist.should == attributes['whitelist']
-          subject.ignore_groups.should == attributes['ignore_groups']
-          subject.dependencies_dir.should == attributes['dependencies_file_dir']
-          subject.project_name.should == attributes['project_name']
-        end
+      it "should set the all of the attributes on the instance" do
+        attributes = {
+          "whitelist" => %w{a whitelist},
+          "ignore_groups" => %w{test development},
+          "dependencies_file_dir" => "some/path",
+          "project_name" => "my_app"
+        }
+        subject = described_class.new(attributes)
+        subject.whitelist.should == %w{a whitelist}
+        subject.ignore_groups.should == %w{test development}
+        subject.artifacts.dir.should == Pathname("some/path")
+        subject.project_name.should == "my_app"
       end
     end
 
-    describe "#database_uri" do
-      it "should URI escape absolute path the dependencies_file_dir" do
-        config = described_class.new('dependencies_file_dir' => 'test path')
-        config.database_uri.should =~ /test%20path\/dependencies\.db$/
+    describe "file paths" do
+      it "should be relative to artifacts dir" do
+        artifacts = described_class.new('dependencies_file_dir' => './elsewhere').artifacts
+        artifacts.dir.should == Pathname('./elsewhere')
+        artifacts.legacy_yaml_file.should == Pathname('./elsewhere/dependencies.yml')
+        artifacts.text_file.should == Pathname('./elsewhere/dependencies.csv')
+        artifacts.html_file.should == Pathname('./elsewhere/dependencies.html')
       end
     end
 
-    describe "#whitelist" do
-      it "should default to an empty array" do
-        klass.new.whitelist.should == []
+    describe "#database_uri" do
+      it "should URI escape absolute path to dependencies_file_dir, even with spaces" do
+        artifacts = described_class.new('dependencies_file_dir' => 'test path').artifacts
+        artifacts.database_uri.should =~ %r{test%20path/dependencies\.db$}
       end
     end
 
     describe "#project_name" do
-      let(:directory_name) { "test_dir" }
-
-      before do
-        Configuration.stub(:config_hash).and_return({})
-        Dir.stub(:getwd).and_return("/path/to/#{directory_name}")
-      end
-
       it "should default to the directory name" do
-        klass.new.project_name.should == directory_name
+        Dir.stub(:getwd).and_return("/path/to/a_project")
+        described_class.new({}).project_name.should == "a_project"
       end
     end
 
     describe "whitelisted?" do
-      context "canonical name whitelisted" do
-        before { config.whitelist = [License::Apache2.names[rand(License::Apache2.names.count)]]}
+      context "short name whitelisted" do
+        subject { described_class.new('whitelist' => ["Apache2"]) }
 
-        let(:possible_license_names) { License::Apache2.names }
-
-        it "should return true if if the license is the canonical name, pretty name, or alternative name of the license" do
-          possible_license_names.each do |name|
-            config.whitelisted?(name).should be_true, "expected #{name} to be whitelisted, but wasn't."
-          end
+        it "should accept any of the licenses names" do
+          subject.should be_whitelisted "Apache2"
+          subject.should be_whitelisted "Apache 2.0"
+          subject.should be_whitelisted "Apache-2.0"
         end
 
         it "should be case-insensitive" do
-          possible_license_names.map(&:downcase).each do |name|
-            config.whitelisted?(name).should be_true, "expected #{name} to be whitelisted, but wasn't"
-          end
+          subject.should be_whitelisted "apache2"
+          subject.should be_whitelisted "apache 2.0"
+          subject.should be_whitelisted "apache-2.0"
         end
       end
     end
 
     describe "#save" do
-      let(:tmp_yml) { '.tmp.configuration_spec.yml' }
-      let(:yaml) { YAML.load(File.read(tmp_yml)) }
+      def attributes # can't be a let... the caching causes polution
+        {
+          'whitelist' => ['my_gem'],
+          'ignore_groups' => ['other_group', 'test'],
+          'project_name' => "New Project Name",
+          'dependencies_file_dir' => "./deps"
+        }
+      end
 
-      before do
-        Configuration.stub(:config_file_path).and_return(tmp_yml)
-        config.whitelist = ['my_gem']
-        config.ignore_groups = ['other_group', 'test']
-        config.project_name = "New Project Name"
-        config.dependencies_dir = "./deps"
+      it "persists the configuration attributes" do
+        Configuration::Persistence.should_receive(:set).with(attributes)
+        described_class.new(attributes).save
       end
 
-      after do
-        File.delete(tmp_yml)
+      it "doesn't persist duplicate entries" do
+        config = described_class.new(attributes)
+        config.whitelist << 'my_gem'
+        config.ignore_groups << 'test'
+
+        Configuration::Persistence.should_receive(:set).with(attributes)
+        config.save
       end
+    end
+  end
 
-      describe "writes the configuration attributes to the yaml file" do
-        before { config.save }
+  describe Configuration::Persistence do
+    describe ".get" do
+      it "should use saved configuration" do
+        file = double(:file,
+                      :exist? => true,
+                      :read => {'some' => 'config'}.to_yaml)
+        described_class.stub(:file).and_return(file)
 
-        it "writes the whitelist" do
-          yaml["whitelist"].should include("my_gem")
-        end
+        described_class.get.should == {'some' => 'config'}
+      end
 
-        it "writes the ignored bundler groups" do
-          yaml["ignore_groups"].should include("other_group")
-          yaml["ignore_groups"].should include("test")
-        end
+      it "should not mind if config is not saved" do
+        file = double(:file, :exist? => false)
+        described_class.stub(:file).and_return(file)
 
-        it "writes the dependencies_dir" do
-          yaml["dependencies_file_dir"].should eq("./deps")
-        end
+        file.should_not_receive(:read)
+        described_class.get.should == {}
+      end
+    end
 
-        it "writes the project name" do
-          yaml["project_name"].should eq("New Project Name")
-        end
+    describe ".set" do
+      let(:tmp_yml) { '.tmp.configuration_spec.yml' }
+
+      after do
+        File.delete(tmp_yml)
       end
 
-      it "doesn't write duplicate entries" do
-        config.whitelist << 'my_gem'
-        config.ignore_groups << 'test'
+      it "writes the configuration attributes to the yaml file" do
+        described_class.stub(:file).and_return(Pathname.new(tmp_yml))
 
-        config.save
+        described_class.set('some' => 'config')
+        described_class.get.should == {'some' => 'config'}
+      end
+    end
+
+    describe ".init" do
+      it "initializes the config file" do
+        file = double(:file, :exist? => false)
+        described_class.stub(:file).and_return(file)
+
+        FileUtils.should_receive(:cp).with(described_class.send(:file_template), file)
+        described_class.init
+      end
+
+      it "does nothing if there is already a config file" do
+        file = double(:file, :exist? => true)
+        described_class.stub(:file).and_return(file)
 
-        yaml["whitelist"].count("my_gem").should == 1
-        yaml["ignore_groups"].count("test").should == 1
+        FileUtils.should_not_receive(:cp)
+        described_class.init
       end
     end
   end

data/spec/lib/license_finder/dependency_manager_spec.rb

@@ -2,11 +2,10 @@ require 'spec_helper'
 
 module LicenseFinder
   describe DependencyManager do
-    let(:config) { Configuration.new }
+    let(:config) { Configuration.new('whitelist' => ['MIT', 'other']) }
 
     before do
       LicenseFinder.stub(:config).and_return config
-      config.whitelist = ["MIT", "other"]
       Reporter.stub(:write_reports)
     end
 
@@ -55,6 +54,13 @@ module LicenseFinder
         expect { described_class.create_manually_managed("GPL", "current dependency 1", "0.0.0") }
           .to raise_error(LicenseFinder::Error)
       end
+
+      it "re-uses an existing, unassociated, license alias" do
+        existing_license = LicenseAlias.named("existing license")
+
+        dep = described_class.create_manually_managed("existing license", "js_dep", "0.0.0")
+        dep.license.should == existing_license
+      end
     end
 
     describe ".destroy_manually_managed" do
@@ -105,8 +111,13 @@ module LicenseFinder
     end
 
     describe ".modifying" do
+      let(:file_exists) { double(:file, :exist? => true) }
+      let(:file_does_not_exist) { double(:file, :exist? => false) }
+
       context "when the database doesn't exist" do
-        before { File.stub(:exists?) { false } }
+        before do
+          config.artifacts.stub(:database_file).and_return(file_does_not_exist)
+        end
 
         it "writes reports" do
           Reporter.should_receive(:write_reports)
@@ -115,7 +126,9 @@ module LicenseFinder
       end
 
       context "when the database exists" do
-        before { File.stub(:exists?) { true } }
+        before do
+          config.artifacts.stub(:database_file).and_return(file_exists)
+        end
 
         context "when the database has changed" do
           before do
@@ -134,21 +147,26 @@ module LicenseFinder
             Digest::SHA2.stub_chain(:file, :hexdigest) { 5 }
           end
 
-          it "does not write reports" do
-            Reporter.should_not_receive(:write_reports)
-            DependencyManager.modifying {}
-          end
-        end
+          context "when the reports exist" do
+            before do
+              config.artifacts.stub(:html_file).and_return(file_exists)
+            end
 
-        context "when the reports do not exist" do
-          before do
-            Digest::SHA2.stub_chain(:file, :hexdigest) { 5 }
-            File.stub(:exists?).with(LicenseFinder.config.dependencies_html) { false }
+            it "does not write reports" do
+              Reporter.should_not_receive(:write_reports)
+              DependencyManager.modifying {}
+            end
           end
 
-          it "writes reports" do
-            Reporter.should_receive(:write_reports)
-            DependencyManager.modifying {}
+          context "when the reports do not exist" do
+            before do
+              config.artifacts.stub(:html_file).and_return(file_does_not_exist)
+            end
+
+            it "writes reports" do
+              Reporter.should_receive(:write_reports)
+              DependencyManager.modifying {}
+            end
           end
         end
       end