license_finder 2.0.0.rc2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 272a63170ce7ba95ee485b5810c3d9bf525a0326
-  data.tar.gz: f6e7364050de7afec4d9ffb95f3e1d20cadb780f
+  metadata.gz: cfcc32451073719f18ccbd51a98c62a8a741500f
+  data.tar.gz: 5d51cb13de5f31a9b994ec5259850432b7ad5b6d
 SHA512:
-  metadata.gz: 3207fee7de7b192aac50c45208931002322a0dbc8fb24e30adb072a28dbacc6e11567c210895bd88163f65de2df0095db2ba7d39a75966b9ad636ae2d0b3c1d6
-  data.tar.gz: 5dd187332ae0d7d61ebde94a3610c43b8a81ac60332bf963b3dab5518950f2ae7e6036c58d6570cd864d7bb038f2e3e96b70eb457686748eb31db33f0892e98a
+  metadata.gz: 1bf9e97e40975279f6e3a8b7920093be14084b7ac3cfb668e54ee1429b03e825a8d5120877959df8e626e82a5882a84c5f7109c599919fcf1af4cf159b1ea647
+  data.tar.gz: bea4e4ad49d7567e2650bac22d018f3361868a7d8eaf4e2d6f35d4c7958db902c9e18aa007221ad59395a058bcff3fdaf6410178fac96d696c3e7fe1c6e988e4

data/.travis.yml

@@ -23,10 +23,12 @@ notifications:
     on_start: true
 
 before_install:
+  - python --version
+  - pip --version
   - cd /tmp
   - wget http://services.gradle.org/distributions/gradle-1.11-all.zip
   - unzip -q gradle*
   - rm gradle*.zip
   - mv gradle* ~/gradle
   - npm install -g bower
-  - cd -
+  - cd -

data/CHANGELOG.rdoc

@@ -1,19 +1,26 @@
-=== 2.0.0 / unreleased
+=== 2.0.0 / 2015-03-02
 
 * Features
 
-  * Stores (in an append-only YAML file) every decision that has been made
-    about a project's dependencies, even if a decision was later reverted.
-  * Stores timestamps and other metadata (who, why) about each decision.
+  * Stores every decision that has been made about a project's dependencies,
+    even if a decision was later reverted.  These decisions are kept in an
+    append-only YAML file which can be considered an audit log.
+  * Stores timestamps and other optional transactional metadata (who, why)
+    about every kind of decision.
   * When needed, applies those decisions to the list of packages currently
     reported by the package managers.
+  * Removed dependencies on sqlite and sequel.
   * The CLI never writes HTML or CSV reports to the file system, only to
     STDOUT. So, users have more choice over which reports to generate, when to
-    generate them, and where to put them. See `license_finder report`.
-  * Removed dependencies on sqlite and sequel.
-  * Minimized the responsibilities of the configuration YAML file. The CLI
-    never updates the config file, which means less futzing with the file
-    system. Makes room for replacing the config file with command line options.
+    generate them, and where to put them. See `license_finder report`.  If you
+    would like to update reports automatically (e.g., in a rake task or git
+    hook) see this gist: https://gist.github.com/mainej/1a4d61a92234c5cebeab.
+  * The configuration YAML file is no longer required, though it can still be
+    useful.  Most of its functionality has been moved into the decisions
+    infrastructure, and the remaining bits can be passed as arguments to the
+    CLI.  Most users will not need these arguments.  If the file is present, the
+    CLI arguments can be omitted.  The CLI no longer updates this file.
+  * Requires pip >= 6.0
 
 * Bugfixes
 

data/CONTRIBUTING.md

@@ -11,9 +11,9 @@
 
 ## Development Dependencies
 
-To successfully run the test suite, you will need node.js, python, pip
-and gradle installed. If you run `rake check_dependencies`, you'll see
-exactly what you're missing.
+To successfully run the test suite, you will need npm, maven, pip, gradle and
+bower installed. If you run `rake check_dependencies`, you'll see exactly what
+you're missing.
 
 ### Python
 

data/README.md

@@ -306,8 +306,11 @@ downloadLicenses {
 
 ## Upgrading
 
-To upgrade from `license_finder` version ~1.2 to 2.0, see
+To upgrade from `license_finder` version 1.2 to 2.0, see
 [`license_finder_upgrade`](https://github.com/mainej/license_finder_upgrade).
+To upgrade to 2.0 from a version lower than 1.2, first upgrade to 1.2, and run
+`license_finder` at least once.  This will ensure that the `license_finder`
+database is in a state which `license_finder_upgrade` understands.
 
 
 ## A Plea to Package Authors and Maintainers

data/TODO.md

@@ -1,28 +1,15 @@
-
 # immediate
-
-- gradle and maven are broken
-  - [x] let's refactor `PossibleLicenseFiles` to accept a nil install_path
-  - [x] then remove `#licenses_from_files` from `{maven,gradle}_package.rb`
-  - [x] update docs in package.rb to reflect what our expectations are.
-- [x] commit the rest of the WIP
-
+- Packages should log which licenses came from decisions. Maybe have
+  Activations, which store a license and a source, which can be logged or
+  otherwise manipulated.
 
 # architecture
 
-- [x] package managers should use instance methods so we can inject things like loggers
-- [ ] are we sprinkling database logic around too much? see 23f4cae for related work.
-
-
 # renamings, etc.
 
-- [x] retitle the shared example "it conforms to interface required by PackageSaver"
-- [x] shared specs should go into a separate file(s)
-- [ ] classes under `package_managers` should be in a PackageManagers module
-- [ ] `license_names_from_standard_spec` should be the default instance method
-- [ ] #groups in some Packages, #included_groups etc. in others
-
+- classes under `package_managers` should be in a PackageManagers module
+- `license_names_from_standard_spec` should be the default instance method
 
 # docs
 
-- [ ] specify gradle version >= 1.8
+- specify gradle version >= 1.8

data/bin/license_finder_pip.py

@@ -1,7 +1,7 @@
-#! /usr/bin/env python
+#!/usr/bin/env python
 
 import json
-from pip.util import get_installed_distributions
+from pip.utils import get_installed_distributions
 
 packages = []
 

data/features/features/cli_spec.rb

@@ -5,39 +5,39 @@ describe "License Finder command line executable" do
   # I want a command-line interface
   # So that I can manage my application's dependencies and licenses
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:developer) { LicenseFinder::TestingDSL::User.new }
 
   specify "reports unapproved dependencies" do
-    user.create_empty_project
-    user.execute_command("license_finder dependencies add unapproved_gem Whatever")
+    developer.create_empty_project
+    developer.execute_command("license_finder dependencies add unapproved_gem Whatever")
 
-    user.run_license_finder
-    expect(user).to be_receiving_exit_code(1)
-    expect(user).to be_seeing 'unapproved_gem'
+    developer.run_license_finder
+    expect(developer).to be_receiving_exit_code(1)
+    expect(developer).to be_seeing 'unapproved_gem'
   end
 
   specify "reports that all dependencies are approved" do
-    user.create_empty_project
+    developer.create_empty_project
 
-    user.run_license_finder
-    expect(user).to be_receiving_exit_code(0)
-    expect(user).to be_seeing 'All dependencies are approved for use'
+    developer.run_license_finder
+    expect(developer).to be_receiving_exit_code(0)
+    expect(developer).to be_seeing 'All dependencies are approved for use'
   end
 
   specify "shows usage and subcommand help" do
-    user.create_empty_project
+    developer.create_empty_project
 
-    user.execute_command "license_finder help"
-    expect(user).to be_seeing 'license_finder help [COMMAND]'
+    developer.execute_command "license_finder help"
+    expect(developer).to be_seeing 'license_finder help [COMMAND]'
 
-    user.execute_command "license_finder ignored_groups help add"
-    expect(user).to be_seeing 'license_finder ignored_groups add GROUP'
+    developer.execute_command "license_finder ignored_groups help add"
+    expect(developer).to be_seeing 'license_finder ignored_groups add GROUP'
   end
 
   it "reports `license_finder`'s license is MIT" do
-    user.create_ruby_app # has license_finder as a dependency
+    developer.create_ruby_app # has license_finder as a dependency
 
-    user.run_license_finder
-    expect(user).to be_seeing_something_like /license_finder.*MIT/
+    developer.run_license_finder
+    expect(developer).to be_seeing_something_like /license_finder.*MIT/
   end
 end

data/features/features/configure/add_dependencies_spec.rb

@@ -3,35 +3,35 @@ require 'feature_helper'
 describe "Manually Added Dependencies" do
   # As a developer
   # I want to be able to manually add dependencies
-  # So that I can track dependencies not managed by Bundler, NPM, etc.
+  # So that I can track dependencies not managed by any official package manager
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:developer) { LicenseFinder::TestingDSL::User.new }
 
-  before { user.create_empty_project }
+  before { developer.create_empty_project }
 
   specify "appear in reports" do
-    user.execute_command 'license_finder dependencies add manual_dep MIT 1.2.3'
+    developer.execute_command 'license_finder dependencies add manual_dep MIT 1.2.3'
 
-    user.run_license_finder
-    expect(user).to be_seeing 'manual_dep, 1.2.3, MIT'
+    developer.run_license_finder
+    expect(developer).to be_seeing 'manual_dep, 1.2.3, MIT'
   end
 
   specify "can be simultaneously approved" do
-    user.execute_command 'license_finder dependencies add --approve manual Whatever'
+    developer.execute_command 'license_finder dependencies add --approve manual Whatever'
 
-    user.run_license_finder
-    expect(user).not_to be_seeing 'manual_dep'
+    developer.run_license_finder
+    expect(developer).not_to be_seeing 'manual_dep'
   end
 
   specify "appear in the CLI" do
-    user.execute_command 'license_finder dependencies add manual_dep Whatever'
-    expect(user).to be_seeing 'manual_dep'
+    developer.execute_command 'license_finder dependencies add manual_dep Whatever'
+    expect(developer).to be_seeing 'manual_dep'
 
-    user.execute_command 'license_finder dependencies list'
-    expect(user).to be_seeing 'manual_dep'
+    developer.execute_command 'license_finder dependencies list'
+    expect(developer).to be_seeing 'manual_dep'
 
-    user.execute_command 'license_finder dependencies remove manual_dep'
-    user.execute_command 'license_finder dependencies list'
-    expect(user).to_not be_seeing 'manual_dep'
+    developer.execute_command 'license_finder dependencies remove manual_dep'
+    developer.execute_command 'license_finder dependencies list'
+    expect(developer).to_not be_seeing 'manual_dep'
   end
 end

data/features/features/configure/approve_dependencies_spec.rb

@@ -2,24 +2,25 @@ require 'feature_helper'
 
 describe "Manually Approved Dependencies" do
   # As a developer
-  # I want to approve dependencies that do not have whitelisted licenses
-  # So that I can track the dependencies which my business has approved
+  # I want to approve dependencies without whitelisting their licenses
+  # So that my business can track individual dependencies which it has approved
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:developer) { LicenseFinder::TestingDSL::User.new }
+  let(:product_owner) { LicenseFinder::TestingDSL::User.new }
 
   before do
-    user.create_empty_project
-    user.execute_command 'license_finder dependencies add manual_dep MIT 1.2.3'
-    user.execute_command "license_finder approval add manual_dep --who 'Julian' --why 'We really need this'"
+    developer.create_empty_project
+    developer.execute_command 'license_finder dependencies add manual_dep MIT 1.2.3'
+    developer.execute_command "license_finder approval add manual_dep --who 'Julian' --why 'We really need this'"
   end
 
   specify "do not appear in action items" do
-    user.run_license_finder
-    expect(user).to_not be_seeing "manual_dep"
+    developer.run_license_finder
+    expect(developer).to_not be_seeing "manual_dep"
   end
 
   specify "include approval detail in reports" do
-    html = user.view_html
+    html = product_owner.view_html
     expect(html).to be_approved 'manual_dep'
 
     html.in_dep("manual_dep") do |section|

data/features/features/configure/assign_licenses_spec.rb

@@ -2,19 +2,19 @@ require 'feature_helper'
 
 describe "Manually Assigned Licenses" do
   # As a developer
-  # I want to be able to override the licenses license_finder finds
+  # I want to be able to override the licenses which license_finder finds
   # So that my dependencies all have the correct licenses
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:developer) { LicenseFinder::TestingDSL::User.new }
 
   specify "are shown in reports" do
-    project = user.create_ruby_app
-    gem = user.create_gem 'mislicensed_dep', license: 'Unknown'
+    project = developer.create_ruby_app
+    gem = developer.create_gem 'mislicensed_dep', license: 'Unknown'
     project.depend_on gem
-    user.execute_command 'license_finder licenses add mislicensed_dep Known'
+    developer.execute_command 'license_finder licenses add mislicensed_dep Known'
 
-    user.run_license_finder
-    expect(user).not_to be_seeing_something_like /mislicensed_dep.*Unknown/
-    expect(user).to be_seeing_something_like /mislicensed_dep.*Known/
+    developer.run_license_finder
+    expect(developer).not_to be_seeing_something_like /mislicensed_dep.*Unknown/
+    expect(developer).to be_seeing_something_like /mislicensed_dep.*Known/
   end
 end

data/features/features/configure/ignore_dependencies_spec.rb

@@ -5,31 +5,31 @@ describe "Ignored Dependencies" do
   # I want to ignore certain dependencies
   # To avoid frequently changing reports about dependencies I know will always be approved
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:developer) { LicenseFinder::TestingDSL::User.new }
 
   before do
-    user.create_empty_project
-    user.execute_command 'license_finder dependencies add ignored_dep Whatever'
+    developer.create_empty_project
+    developer.execute_command 'license_finder dependencies add ignored_dep Whatever'
   end
 
   specify "are excluded from reports" do
-    user.execute_command 'license_finder ignored_dependencies add ignored_dep'
+    developer.execute_command 'license_finder ignored_dependencies add ignored_dep'
 
-    user.run_license_finder
-    expect(user).to_not be_seeing 'ignored_dep'
-    user.execute_command('license_finder report')
-    expect(user).to_not be_seeing 'ignored_dep'
+    developer.run_license_finder
+    expect(developer).to_not be_seeing 'ignored_dep'
+    developer.execute_command('license_finder report')
+    expect(developer).to_not be_seeing 'ignored_dep'
   end
 
   specify "appear in the CLI" do
-    user.execute_command 'license_finder ignored_dependencies add ignored_dep'
-    expect(user).to be_seeing 'ignored_dep'
+    developer.execute_command 'license_finder ignored_dependencies add ignored_dep'
+    expect(developer).to be_seeing 'ignored_dep'
 
-    user.execute_command 'license_finder ignored_dependencies list'
-    expect(user).to be_seeing 'ignored_dep'
+    developer.execute_command 'license_finder ignored_dependencies list'
+    expect(developer).to be_seeing 'ignored_dep'
 
-    user.execute_command 'license_finder ignored_dependencies remove ignored_dep'
-    user.execute_command 'license_finder ignored_dependencies list'
-    expect(user).to_not be_seeing 'ignored_dep'
+    developer.execute_command 'license_finder ignored_dependencies remove ignored_dep'
+    developer.execute_command 'license_finder ignored_dependencies list'
+    expect(developer).to_not be_seeing 'ignored_dep'
   end
 end

data/features/features/configure/ignore_groups_spec.rb

@@ -3,29 +3,29 @@ require 'feature_helper'
 describe "Ignored Groups" do
   # As a developer
   # I want to ignore certain groups
-  # So that any gems I use in development, or for testing, are automatically approved for use
+  # So that license_finder skips any gems I use in development, or for testing
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:developer) { LicenseFinder::TestingDSL::User.new }
 
   specify "are excluded from reports" do
-    project = user.create_ruby_app
-    gem = user.create_gem 'dev_gem', license: 'GPL'
+    project = developer.create_ruby_app
+    gem = developer.create_gem 'dev_gem', license: 'GPL'
     project.depend_on gem, groups: ['dev']
-    user.execute_command 'license_finder ignored_group add dev'
+    developer.execute_command 'license_finder ignored_group add dev'
 
-    user.run_license_finder
-    expect(user).to_not be_seeing 'dev_gem'
+    developer.run_license_finder
+    expect(developer).to_not be_seeing 'dev_gem'
   end
 
   specify "appear in the CLI" do
-    user.create_empty_project
-    user.execute_command 'license_finder ignored_group add dev'
-    expect(user).to be_seeing 'dev'
-    user.execute_command 'license_finder ignored_group list'
-    expect(user).to be_seeing 'dev'
+    developer.create_empty_project
+    developer.execute_command 'license_finder ignored_group add dev'
+    expect(developer).to be_seeing 'dev'
+    developer.execute_command 'license_finder ignored_group list'
+    expect(developer).to be_seeing 'dev'
 
-    user.execute_command 'license_finder ignored_group remove dev'
-    user.execute_command 'license_finder ignored_group list'
-    expect(user).to_not be_seeing 'dev'
+    developer.execute_command 'license_finder ignored_group remove dev'
+    developer.execute_command 'license_finder ignored_group list'
+    expect(developer).to_not be_seeing 'dev'
   end
 end

data/features/features/configure/name_project_spec.rb

@@ -3,30 +3,31 @@ require 'feature_helper'
 describe "Project name" do
   # As a developer
   # I want to assign a name for my project
-  # So that the reports show it
+  # So that product owners see it in the reports
 
-  let(:user) { LicenseFinder::TestingDSL::User.new }
+  let(:developer) { LicenseFinder::TestingDSL::User.new }
+  let(:product_owner) { LicenseFinder::TestingDSL::User.new }
 
-  before { user.create_empty_project }
+  before { developer.create_empty_project }
 
   specify "appears in the HTML report" do
-    user.execute_command 'license_finder project_name add changed_name'
+    developer.execute_command 'license_finder project_name add changed_name'
 
-    expect(user.view_html).to be_titled 'changed_name'
+    expect(product_owner.view_html).to be_titled 'changed_name'
   end
 
   specify "defaults to the directory name" do
-    expect(user.view_html).to be_titled 'my_app'
+    expect(product_owner.view_html).to be_titled 'my_app'
   end
 
   specify "appears in the CLI" do
-    user.execute_command 'license_finder project_name add my_proj'
-    expect(user).to be_seeing 'my_proj'
-    user.execute_command 'license_finder project_name show'
-    expect(user).to be_seeing 'my_proj'
-
-    user.execute_command 'license_finder project_name remove'
-    user.execute_command 'license_finder project_name show'
-    expect(user).to_not be_seeing 'my_proj'
+    developer.execute_command 'license_finder project_name add my_proj'
+    expect(developer).to be_seeing 'my_proj'
+    developer.execute_command 'license_finder project_name show'
+    expect(developer).to be_seeing 'my_proj'
+
+    developer.execute_command 'license_finder project_name remove'
+    developer.execute_command 'license_finder project_name show'
+    expect(developer).to_not be_seeing 'my_proj'
   end
 end