papers 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d38f6dd8a9213870b3198c533cb7a54731d8d15b
-  data.tar.gz: 460c188a68833bd4d67522e36163037a1c65e073
+  metadata.gz: a3dbc559e575243918efffa385aac928d327a56d
+  data.tar.gz: d3ef809f5a3d9593a82ff4039bd821d58aabf038
 SHA512:
-  metadata.gz: a90556c81b2d76635c8ee185c9da05952c75d49762f3731eeb4af79297e929e8491b499d2900978915ad18282df9be4000841f836e46f795c93c68adaa7ddbe9
-  data.tar.gz: 55573fadd64de745cedfe761eb48c6eea4ab2a0a23012a3b57f95e1f37b57735c7a82de5329350b2145459d906932730c4da57c11ed02316dd1cb5abd72c653b
+  metadata.gz: fe00245204a6bdc2116983f15f43af78500c14dbc8a67910bcba588c58cff579f58d3c44573c0997e033ca064cc54f9e8619bc71ba8bf253eb89dec44aaedfcb
+  data.tar.gz: 5a2067a1aec1942ecb6a2a5170c7f32e43c1f70f9e9ad2f75a1f78c6d26e9c01b030af9d67611665cf16fded5f126f5616ec43e12dd0fd644bb18ca0df5d347c

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## 1.1.0 (Current release)
+
+* Add support for validating the licenses of Bower components (thanks to [@Aughr](https://github.com/aughr))
+
+## 1.0.0 (Initial Release)
+
+* Initial release of Papers. Support for validating the licenses of:
+  * Ruby Gems
+  * Javascript libraries and files

data/README.md

@@ -66,7 +66,11 @@ Papers.configure do |config|
   #   'Manually Reviewed',
   #   'Unlicensed'
   # ]
-  config.license_whitelist << 'New Relic'
+  # config.license_whitelist << 'New Relic'
+
+  # You can specify a single license that, when used, ignores the version. Defaults to nil.
+  # WARNING: You should only use this for software licensed in house.
+  # config.version_whitelisted_license = 'New Relic'
 
   # The location of your dependency manifest. Defaults to config/papers_manifest.yml
   config.manifest_file = File.join('config', 'papers_manifest.yml')
@@ -87,7 +91,7 @@ Papers.configure do |config|
 
   # Configures where Papers should look for bower components. Each component
   # must have a .bower.json file in its directory for Papers to see it.
-  config.bower_components_path = 'vendor/assets/components'
+  # config.bower_components_path = 'vendor/assets/components'
 end
 ```
 
@@ -101,7 +105,7 @@ describe 'Papers License Validation' do
   subject(:validator) { Papers::LicenseValidator.new }
 
   it 'knows and is satisfied by all dependency licenses' do
-    expect(validator).to be_valid, "License validator failed:\n#{validator.errors.join("\n")}"
+    expect(validator).to be_valid, -> { "License validation failed:\n#{validator.errors.join("\n")}" }
   end
 end
 
@@ -112,7 +116,7 @@ class PapersLicenseValidationTest < ActiveSupport::TestCase
   def test_know_and_be_satisfied_by_all_licenses
     validator = Papers::LicenseValidator.new
 
-    assert validator.valid?, "License validator failed:\n#{validator.errors.join("\n")}"
+    assert validator.valid?, "License validation failed:\n#{validator.errors.join("\n")}"
   end
 end
 ```

data/lib/papers/configuration.rb

@@ -1,6 +1,7 @@
 module Papers
   class Configuration
     attr_accessor :license_whitelist
+    attr_accessor :version_whitelisted_license
 
     attr_accessor :manifest_file
 
@@ -24,6 +25,8 @@ module Papers
         'Unlicensed'
       ]
 
+      @version_whitelisted_license = nil
+
       @manifest_file = File.join(Dir.pwd, 'config', 'papers_manifest.yml')
 
       @validate_gems             = true

data/lib/papers/dependency_specification.rb

@@ -15,7 +15,8 @@ module Papers
     end
 
     def acceptable_license?
-      Papers.config.license_whitelist.include?(license)
+      Papers.config.license_whitelist.include?(license) ||
+      Papers.config.version_whitelisted_license == license
     end
 
     protected

data/lib/papers/dependency_specification/gem.rb

@@ -11,9 +11,11 @@ module Papers
 
     def self.introspected
       Bundler.load.specs.map do |spec|
-        # bundler versions aren't controlled by the Gemfile
+        # Bundler versions aren't controlled by the Gemfile
         if spec.name == 'bundler'
           spec.name
+        elsif spec.licenses.include?(Papers.config.version_whitelisted_license)
+          spec.name
         else
           "#{spec.name}-#{spec.version}"
         end

data/lib/papers/version.rb

@@ -1,6 +1,6 @@
 module Papers
   MAJOR = 1
-  MINOR = 1
+  MINOR = 2
   PATCH = 0
 
   VERSION = [MAJOR, MINOR, PATCH].join('.')

data/spec/papers_spec.rb

@@ -18,21 +18,16 @@ describe 'Papers' do
 
   it 'detects mismatched gems' do
     Papers::LicenseValidator.any_instance.stub(:manifest).and_return({
-        'javascripts' => {},
-        'gems' => {
-          'foo-1.2' => {
-            'license' => 'MIT',
-            'license_url' => nil,
-            'project_url' => nil
-          },
-          'baz-1.3' => {
-            'license' => 'BSD',
-            'license_url' => nil,
-            'project_url' => nil
-          }
-        }
-      })
-    Papers::Gem.stub(:introspected).and_return(['bar-1.2', 'baz-1.3'])
+      'javascripts' => {},
+      'gems' => {
+        'foo-1.2' => { 'license' => 'MIT' },
+        'baz-1.3' => { 'license' => 'BSD' }
+      }
+    })
+    Bundler.stub_chain(:load, :specs).and_return([
+      double(name: 'bar', version: '1.2', licenses: ['MIT']),
+      double(name: 'baz', version: '1.3', licenses: ['BSD'])
+    ])
 
     expect(validator.valid?).to be_false
 
@@ -50,19 +45,14 @@ describe 'Papers' do
     Papers::LicenseValidator.any_instance.stub(:manifest).and_return({
       'javascripts' => {},
       'gems' => {
-        'foo-1.2' => {
-          'license' => 'MIT',
-          'license_url' => nil,
-          'project_url' => nil
-        },
-        'baz-1.3' => {
-          'license' => 'BSD',
-          'license_url' => nil,
-          'project_url' => nil
-        }
+        'foo-1.2' => { 'license' => 'MIT' },
+        'baz-1.3' => { 'license' => 'BSD' }
       }
     })
-    Papers::Gem.stub(:introspected).and_return(['foo-1.2', 'baz-1.2'])
+    Bundler.stub_chain(:load, :specs).and_return([
+      double(name: 'foo', version: '1.2', licenses: ['MIT']),
+      double(name: 'baz', version: '1.2', licenses: ['BSD'])
+    ])
 
     expect(validator.valid?).to be_false
 
@@ -73,73 +63,94 @@ describe 'Papers' do
     validator.valid?
   end
 
+  it 'detects omitted gem versions' do
+    Papers::Configuration.any_instance.stub(:validate_javascript?).and_return(false)
+
+    Papers::LicenseValidator.any_instance.stub(:manifest).and_return({
+      'javascripts' => {},
+      'gems' => {
+        'foo' => { 'license' => 'MIT' },
+        'baz-1.2' => { 'license' => 'BSD' }
+      }
+    })
+    Bundler.stub_chain(:load, :specs).and_return([
+      double(name: 'foo', version: '1.2', licenses: ['MIT']),
+      double(name: 'baz', version: '1.2', licenses: ['BSD'])
+    ])
+
+    expect(validator).not_to be_valid
+
+    expect(validator.errors).to eq([
+      'foo-1.2 is included in the application, but not in the manifest',
+      'foo is included in the manifest, but not in the application'
+    ])
+    validator.valid?
+  end
+
   it 'is OK with matching gem sets' do
     Papers::LicenseValidator.any_instance.stub(:manifest).and_return({
       'javascripts' => {},
       'gems' => {
-        'foo-1.2' => {
-          'license' => 'MIT',
-          'license_url' => nil,
-          'project_url' => nil
-        },
-        'baz-1.3' => {
-          'license' => 'BSD',
-          'license_url' => nil,
-          'project_url' => nil
-        }
-      },
+        'foo-1.2' => { 'license' => 'MIT' },
+        'baz-1.2' => { 'license' => 'BSD' }
+      }
     })
-    Papers::Gem.stub(:introspected).and_return(['foo-1.2', 'baz-1.3'])
+    Bundler.stub_chain(:load, :specs).and_return([
+      double(name: 'foo', version: '1.2', licenses: ['MIT']),
+      double(name: 'baz', version: '1.2', licenses: ['BSD'])
+    ])
 
     expect(validator.valid?).to be_true
   end
 
+  it 'is OK with whitelisting gem versions on a specific license' do
+    Papers::LicenseValidator.any_instance.stub(:manifest).and_return({
+      'javascripts' => {},
+      'gems' => {
+        'foo' => { 'license' => 'MIT' },
+        'baz' => { 'license' => 'BSD' }
+      }
+    })
+    Bundler.stub_chain(:load, :specs).and_return([
+      double(name: 'foo', version: '1.2', licenses: ['MIT']),
+      double(name: 'baz', version: '1.2', licenses: ['BSD'])
+    ])
+    Papers::Configuration.any_instance.stub(:version_whitelisted_license).and_return('MIT')
+
+    expect(validator).not_to be_valid
+    expect(validator.errors).to eq([
+      'baz-1.2 is included in the application, but not in the manifest',
+      'baz is included in the manifest, but not in the application'
+    ])
+  end
+
   it 'is OK with matching gem sets but complain about a license issue' do
     Papers::LicenseValidator.any_instance.stub(:manifest).and_return({
       'javascripts' => {},
       'gems' => {
-        'foo-1.2' => {
-          'license' => 'MIT',
-          'license_url' => nil,
-          'project_url' => nil
-        },
-        'baz-1.3' => {
-          'license' => 'GPL',
-          'license_url' => nil,
-          'project_url' => nil
-        }
-      },
+        'foo-1.2' => { 'license' => 'MIT' },
+        'baz-1.3' => { 'license' => 'GPL' }
+      }
     })
-    Papers::Gem.stub(:introspected).and_return(['foo-1.2', 'baz-1.3'])
+    Bundler.stub_chain(:load, :specs).and_return([
+      double(name: 'foo', version: '1.2', licenses: ['MIT']),
+      double(name: 'baz', version: '1.3', licenses: ['GPL'])
+    ])
 
-    expect(validator.valid?).to be_false
+    expect(validator).not_to be_valid
 
     expect(validator.errors).to eq([
       'baz-1.3 is licensed under GPL, which is not whitelisted'
     ])
-
-    validator.valid?
   end
 
   it 'displays gem licenses in a pretty format without versions' do
     Papers::LicenseValidator.any_instance.stub(:manifest).and_return({
       'javascripts' => {},
       'gems' => {
-        'foo-1.2' => {
-          'license' => 'MIT',
-          'license_url' => nil,
-          'project_url' => nil
-        },
-        'baz-1.3' => {
-          'license' => 'BSD',
-          'license_url' => nil,
-          'project_url' => nil
-        },
-        'with-hyphens-1.4' => {
-          'license' => 'MIT',
-          'license_url' => nil,
-          'project_url' => nil
-        }
+        'foo-1.2'          => { 'license' => 'MIT' },
+        'baz-1.3'          => { 'license' => 'BSD' },
+        'with-hyphens-1.4' => { 'license' => 'MIT' }
       },
     })
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: papers
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ralph Bodenner
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -53,6 +53,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md