license_finder 1.1.1 → 1.2

data/spec/support/shared_examples_for_package.rb

@@ -0,0 +1,46 @@
+module LicenseFinder
+  shared_examples "a Package" do
+    context "the interface required by PackageSave" do
+      it { expect { subject.name }.to_not raise_error }
+      it { expect { subject.version }.to_not raise_error }
+      it { expect { subject.summary }.to_not raise_error }
+      it { expect { subject.description }.to_not raise_error }
+      it { expect { subject.homepage }.to_not raise_error }
+      it { expect { subject.groups }.to_not raise_error }
+      it { expect { subject.children }.to_not raise_error }
+      it { expect { subject.licenses }.to_not raise_error }
+    end
+
+    context "logging" do
+      let!(:logger) { Logger::Quiet.new }
+      before { allow(Logger::Default).to receive(:new) { logger } }
+
+      it "logs licenses found in specs" do
+        license_short_name = "foo"
+        license_pretty_name = "pretty foo"
+        license = double(:license, name: license_pretty_name)
+
+        allow(subject).to receive(:license_names_from_spec).and_return([license_short_name])
+        allow(License).to receive(:find_by_name).with(license_short_name) { license }
+
+        expect(logger).to receive(:license).with(anything, subject.name, license_pretty_name, "from spec")
+
+        subject.licenses_from_spec
+      end
+
+      it "logs licenses found in files" do
+        license_short_name = "foo"
+        license_pretty_name = "pretty foo"
+        license_path = "/path/to/license"
+        license = double(:license, name: license_pretty_name)
+        license_file = double(:license_file, license: license, path: license_path)
+
+        allow(subject).to receive(:license_files) { [license_file] }
+
+        expect(logger).to receive(:license).with(anything, subject.name, license_pretty_name, "from file '#{license_path}'")
+
+        subject.licenses_from_files
+      end
+    end
+  end
+end

data/spec/support/shared_examples_for_package_manager.rb

@@ -0,0 +1,15 @@
+module LicenseFinder
+  shared_examples "a PackageManager" do
+    it { expect(described_class.ancestors).to include PackageManager }
+
+    context "logging" do
+      it "logs when it checks for active-ness" do
+        logger = double(:logger)
+        expect(logger).to receive(:active)
+
+        subject = described_class.new logger: logger
+        subject.active?
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: license_finder
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: '1.2'
 platform: ruby
 authors:
 - Jacob Maine
@@ -16,10 +16,11 @@ authors:
 - David Dening
 - Geoff Pleiss
 - Mike Chinigo
+- Mike Dalessio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -217,30 +218,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
-- !ruby/object:Gem::Dependency
-  name: cocoapods
-  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: |2
-    Do you know the licenses of all your application's dependencies? What open source software licenses will your business accept?
-
-    LicenseFinder culls your package managers, detects the licenses of the packages in them, 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.
+      LicenseFinder works with your package managers to find
+      dependencies, detect the licenses of the packages in them, compare
+      those licenses against a user-defined whitelist, and give you an
+      actionable exception report.
 email:
 - commoncode@pivotalabs.com
 executables:
 - license_finder
+- license_finder_pip.py
 extensions: []
 extra_rdoc_files: []
 files:
@@ -251,8 +238,11 @@ files:
 - CHANGELOG.rdoc
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
+- TODO.md
 - bin/license_finder
+- bin/license_finder_pip.py
 - db/migrate/201303290935_create_dependencies.rb
 - db/migrate/201303291155_create_licenses.rb
 - db/migrate/201303291402_create_approvals.rb
@@ -275,6 +265,7 @@ files:
 - db/migrate/201403190028_add_manual_approvals.rb
 - db/migrate/201403191419_add_timestamps_to_manual_approvals.rb
 - db/migrate/201403191645_remove_license_aliases.rb
+- db/migrate/201410031451_rename_dependency_license_name.rb
 - features/cli.feature
 - features/cocoapods_dependencies.feature
 - features/configure_bundler_groups.feature
@@ -286,6 +277,7 @@ files:
 - features/manually_approved.feature
 - features/manually_assigned_license.feature
 - features/maven_dependencies.feature
+- features/multiple_licenses.feature
 - features/node_dependencies.feature
 - features/python_dependencies.feature
 - features/report_csv.feature
@@ -301,6 +293,7 @@ files:
 - features/step_definitions/manually_approved_steps.rb
 - features/step_definitions/manually_assigned_license_steps.rb
 - features/step_definitions/maven_steps.rb
+- features/step_definitions/multiple_licenses_steps.rb
 - features/step_definitions/node_steps.rb
 - features/step_definitions/python_steps.rb
 - features/step_definitions/report_csv_steps.rb
@@ -329,7 +322,9 @@ files:
 - lib/license_finder/license/none_matcher.rb
 - lib/license_finder/license/template.rb
 - lib/license_finder/license/text.rb
+- lib/license_finder/logger.rb
 - lib/license_finder/package.rb
+- lib/license_finder/package_manager.rb
 - lib/license_finder/package_managers/bower.rb
 - lib/license_finder/package_managers/bower_package.rb
 - lib/license_finder/package_managers/bundler.rb
@@ -364,7 +359,6 @@ files:
 - lib/templates/markdown_report.erb
 - lib/templates/text_report.erb
 - license_finder.gemspec
-- readme.md
 - release/gem_version.rb
 - release/manual_instructions.md
 - release/publish.sh
@@ -427,6 +421,8 @@ files:
 - spec/lib/license_finder/yml_to_sql_spec.rb
 - spec/lib/license_finder_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples_for_package.rb
+- spec/support/shared_examples_for_package_manager.rb
 - spec/support/stdout_helpers.rb
 homepage: https://github.com/pivotal/LicenseFinder
 licenses:
@@ -452,95 +448,4 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Audit the OSS licenses of your application's dependencies.
-test_files:
-- features/cli.feature
-- features/cocoapods_dependencies.feature
-- features/configure_bundler_groups.feature
-- features/configure_ignore_dependencies.feature
-- features/configure_project_name.feature
-- features/configure_whitelist.feature
-- features/gradle_dependencies.feature
-- features/manually_added.feature
-- features/manually_approved.feature
-- features/manually_assigned_license.feature
-- features/maven_dependencies.feature
-- features/node_dependencies.feature
-- features/python_dependencies.feature
-- features/report_csv.feature
-- features/report_html.feature
-- features/step_definitions/cli_steps.rb
-- features/step_definitions/cocoapod_steps.rb
-- features/step_definitions/configure_bundler_groups_steps.rb
-- features/step_definitions/configure_ignore_dependencies.rb
-- features/step_definitions/configure_project_name_steps.rb
-- features/step_definitions/configure_whitelist_steps.rb
-- features/step_definitions/gradle_steps.rb
-- features/step_definitions/manually_added_steps.rb
-- features/step_definitions/manually_approved_steps.rb
-- features/step_definitions/manually_assigned_license_steps.rb
-- features/step_definitions/maven_steps.rb
-- features/step_definitions/node_steps.rb
-- features/step_definitions/python_steps.rb
-- features/step_definitions/report_csv_steps.rb
-- features/step_definitions/report_html_steps.rb
-- features/step_definitions/shared_steps.rb
-- spec/fixtures/APACHE-2-LICENSE
-- spec/fixtures/GPLv2
-- spec/fixtures/ISC-LICENSE
-- spec/fixtures/MIT-LICENSE
-- spec/fixtures/MIT-LICENSE-with-varied-disclaimer
-- spec/fixtures/Podfile
-- spec/fixtures/README-with-MIT-LICENSE
-- spec/fixtures/build.gradle
-- spec/fixtures/license_directory/COPYING
-- spec/fixtures/license_directory/LICENSE/BSD-2-Clause.txt
-- spec/fixtures/license_directory/LICENSE/GPL-2.0.txt
-- spec/fixtures/license_directory/LICENSE/LICENSE
-- spec/fixtures/license_directory/LICENSE/MIT.txt
-- spec/fixtures/license_directory/LICENSE/RUBY.txt
-- spec/fixtures/license_names/COPYING.txt
-- spec/fixtures/license_names/LICENSE
-- spec/fixtures/license_names/Licence.rdoc
-- spec/fixtures/license_names/Mit-License
-- spec/fixtures/license_names/README.rdoc
-- spec/fixtures/mit_licensed_gem/LICENSE
-- spec/fixtures/nested_gem/vendor/LICENSE
-- spec/fixtures/nested_readme/vendor/README
-- spec/fixtures/other_licensed_gem/LICENSE
-- spec/fixtures/pom.xml
-- spec/fixtures/readme/Project ReadMe
-- spec/fixtures/readme/README
-- spec/fixtures/readme/Readme.markdown
-- spec/fixtures/utf8_gem/README
-- spec/lib/license_finder/cli_spec.rb
-- spec/lib/license_finder/configuration_spec.rb
-- spec/lib/license_finder/dependency_manager_spec.rb
-- spec/lib/license_finder/license/definitions_spec.rb
-- spec/lib/license_finder/license_spec.rb
-- spec/lib/license_finder/package_managers/bower_package_spec.rb
-- spec/lib/license_finder/package_managers/bower_spec.rb
-- spec/lib/license_finder/package_managers/bundler_package_spec.rb
-- spec/lib/license_finder/package_managers/bundler_spec.rb
-- spec/lib/license_finder/package_managers/cocoa_pods_package_spec.rb
-- spec/lib/license_finder/package_managers/cocoa_pods_spec.rb
-- spec/lib/license_finder/package_managers/gradle_package_spec.rb
-- spec/lib/license_finder/package_managers/gradle_spec.rb
-- spec/lib/license_finder/package_managers/maven_package_spec.rb
-- spec/lib/license_finder/package_managers/maven_spec.rb
-- spec/lib/license_finder/package_managers/npm_package_spec.rb
-- spec/lib/license_finder/package_managers/npm_spec.rb
-- spec/lib/license_finder/package_managers/pip_package_spec.rb
-- spec/lib/license_finder/package_managers/pip_spec.rb
-- spec/lib/license_finder/package_saver_spec.rb
-- spec/lib/license_finder/possible_license_file_spec.rb
-- spec/lib/license_finder/possible_license_files_spec.rb
-- spec/lib/license_finder/reports/detailed_text_report_spec.rb
-- spec/lib/license_finder/reports/html_report_spec.rb
-- spec/lib/license_finder/reports/markdown_report_spec.rb
-- spec/lib/license_finder/reports/reporter_spec.rb
-- spec/lib/license_finder/reports/text_report_spec.rb
-- spec/lib/license_finder/tables/dependency_spec.rb
-- spec/lib/license_finder/yml_to_sql_spec.rb
-- spec/lib/license_finder_spec.rb
-- spec/spec_helper.rb
-- spec/support/stdout_helpers.rb
+test_files: []

data/readme.md

@@ -1,259 +0,0 @@
-# License Finder
-
-[![Build Status](https://secure.travis-ci.org/pivotal/LicenseFinder.png)](http://travis-ci.org/pivotal/LicenseFinder)
-[![Code Climate](https://codeclimate.com/github/pivotal/LicenseFinder.png)](https://codeclimate.com/github/pivotal/LicenseFinder)
-
-With bundler and other dependency management tools, it's easy for your project to depend on many packages.  This decomposition is nice, but managing licenses becomes difficult.  license_finder gathers info about the licenses of the packages in your project.
-
-### Supported project types
-- Ruby (+ Bundler)
-- Python (+ Eggs)
-- Node.js (+ Modules)
-- Bower
-
-### Experimental project types 
-- Java (+ Maven)
-- Java (+ Gradle)
-- Objective-C (+ CocoaPods)
-
-## Installation
-
-Add license_finder to your project's Gemfile and `bundle`:
-
-```ruby
-gem 'license_finder'
-```
-
-## Usage
-
-
-license_finder will generate reports of action items - i.e., dependencies that do not fall within your license "whitelist".
-
-```sh
-$ license_finder
-```
-
-(Note) If you wish to run license_finder without the progress spinner use the --quiet option.
-
-license_finder will include packages for all supported languages, as long as that language has a Gemfile/requirements.txt/package.json in the project directory.
-
-On a brand new Rails project, you could expect license_finder to output something like the following
-(assuming you whitelisted the MIT license -- see [Configuration](#configuration)):
-
-```
-Dependencies that need approval:
-
-highline, 1.6.14, ruby
-json, 1.7.5, ruby
-mime-types, 1.19, ruby
-rails, 3.2.8, other
-rdoc, 3.12, other
-rubyzip, 0.9.9, ruby
-xml-simple, 1.1.1, other
-```
-
-The executable task will also write out a dependencies.db, dependencies.csv, and dependencies.html file (in the doc/
-directory by default -- see [Configuration](#configuration)).
-
-The latter two files are human readable reports that you could send to your non-technical business partners, lawyers, etc.
-
-license_finder will also return a non-zero exit status if there are
-unapproved dependencies. You could use this in a CI build, for example, to alert you whenever someone adds an
-unapproved dependency to the project.
-
-Run `license_finder help` to see other available commands.
-
-### Manually setting licenses
-
-When license_finder reports that a dependency's license is 'other', you should manually research what the actual
-license is.  When you have established the real license, you can record it with:
-
-```sh
-$ license_finder license MIT my_unknown_dependency
-```
-
-This command would assign the MIT license to the dependency `my_unknown_dependency`.
-
-### Manually approving dependencies
-
-Whenever you have a dependency that falls outside of your whitelist, license_finder will tell you.
-If your business decides that this is an acceptable risk, you can manually approve the dependency by using the
-`license_finder approve` command.
-
-For example, lets assume you've only
-whitelisted the "MIT" license in your `config/license_finder.yml`. You then add the `awesome_gpl_gem` to your Gemfile,
-which we'll assume is licensed with the `GPL` license. You then run `license_finder` and see
-the gem listed in the output:
-
-```sh
-awesome_gpl_gem, 1.0.0, GPL
-```
-
-Your business tells you that in this case, it's acceptable to use this gem. You now run:
-
-```sh
-$ license_finder approve awesome_gpl_gem
-```
-
-If you rerun license_finder, you should no longer see `awesome_gpl_gem` in the output.
-
-To record who approved the dependency and why:
-
-```sh
-$ license_finder approve awesome_gpl_gem --approver CTO --message "Go ahead"
-```
-
-### Manually managing dependencies
-
-license_finder can track dependencies that your package managers don't know about (JS libraries that don't
-appear in your Gemfile/requirements.txt/package.json, etc.)
-
-```sh
-$ license_finder dependencies add MIT my_js_dep 0.1.2
-```
-
-To automatically approve an unmanaged dependency when you add it, use:
-
-```sh
-$ license_finder dependencies add MIT my_js_dep 0.1.2 --approve
-```
-
-To record who approved the dependency when you add it, use:
-
-```sh
-$ license_finder dependencies add MIT my_js_dep 0.1.2 --approve --approver CTO --message "Go ahead"
-```
-
-The version is optional.  Run `license_finder dependencies help` for additional documentation about
-managing these dependencies.
-
-license_finder cannot automatically detect when one of these dependencies has been removed from your
-project, so you can use:
-
-```sh
-$ license_finder dependencies remove my_js_dep
-```
-
-
-## Configuration
-
-The first time you run license_finder it will create a default configuration file `./config/license_finder.yml`:
-
-```yaml
----
-whitelist:
-#- MIT
-#- Apache 2.0
-ignore_groups:
-#- test
-#- development
-ignore_dependencies:
-#- bundler
-dependencies_file_dir: './doc/'
-project_name: My Project Name
-gradle_command: # only meaningful if used with a Java/gradle project. Defaults to "gradle".
-```
-
-By modifying this file, you can configure license_finder's behavior.
-
-- Licenses in the `whitelist` will be automatically approved.
-- You can exclude test or development dependencies by setting `ignore_groups`.  (Currently this only
-works for Bundler.)
-- You can exclude specific dependencies by setting `ignore_dependencies`.
-(Think carefully before adding dependencies to this list. A likely item to exclude is
-bundler itself, to avoid noisy changes to the doc files when different people run
-license_finder with different versions of bundler.)
-- You can store the license database and text files in another directory by changing 
-`dependencies_file_dir`. And the `project_name`, which defaults to your working
-directory, appears in the [HTML report](#html-report).
-- See below for explanation of "gradle_command".
-
-You can also configure license_finder through the command line.  See
-`license_finder whitelist help`, `license_finder ignored_bundler_groups help`
-and `license_finder project_name help` for more details.
-
-### 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)
-
-LicenseFinder assumes that gradle is on your shell's include path and is invoked by just calling `gradle`. If you invoke gradle some other way (say, with a custom `gradlew` script), set the `gradle_command` option in your project's `license_finder.yml`:
-
-```yaml
-# … other configuration …
-
-gradle_command: ./gradlew
-```
-
-By default, license_finder will report on gradle's "runtime" dependencies. If you want to generate a report for some other dependency configuration (e.g. Android projects will sometimes specify their meaningful dependencies in the "compile" group), you can specify it in your project's `build.gradle` like so:
-
-```
-// Must come *after* the 'apply plugin: license' line
-
-downloadLicenses {
-  dependencyConfiguration "compile"
-}
-```
-
-## HTML Report
-
-The HTML report generated by license_finder shows a summary of the project's dependencies
-and dependencies which need to be approved. The project name at the top of the report can
-be set in `config/license_finder.yml`.
-
-## Upgrade for pre 0.8.0 users
-
-If you wish to cleanup your root directory you can run:
-
-```sh
-$ license_finder move
-```
-
-This will move your `dependencies.*` files to the doc/ directory and update the config.
-
-
-## Compatibility
-
-license_finder is compatible with ruby >= 1.9, and jruby.
-
-
-## A note to gem authors / maintainers
-
-For the good of humanity, please add a license to your gemspec!
-
-```ruby
-Gem::Specification.new do |s|
-  s.name = "my_great_gem"
-  s.license = "MIT"
-end
-```
-
-And add a `LICENSE` file to your gem that contains your license text.
-
-
-## Support
-
-* Send an email to the list: [license-finder@googlegroups.com](license-finder@googlegroups.com)
-* View the project backlog at Pivotal Tracker: [https://www.pivotaltracker.com/s/projects/234851](https://www.pivotaltracker.com/s/projects/234851)
-
-
-## Contributing
-
-* Fork the project
-* Create a feature branch
-* Make your feature addition or bug fix (with tests)
-* Rebase on top of master
-* Send a pull request
-
-To successfully run the test suite, you will need node.js, python, pip and gradle installed.
-
-For the python dependency tests you will want to have virtualenv installed. See: http://hackercodex.com/guide/python-development-environment-on-mac-osx/#virtualenv (This will allow pip to work without sudo)
-
-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
-
-LicenseFinder is released under the MIT License. http://www.opensource.org/licenses/mit-license