papers 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77662210b020b8018d27e9f2888cba6b61a58d16
-  data.tar.gz: 604cd4f2f5e59829c98e24daaee8b9c94b77e019
+  metadata.gz: ff0340e975da31aa959dcddcdd5b7a78c9140ecc
+  data.tar.gz: fd4265cbcdbd98799e115667658eb9450e52493f
 SHA512:
-  metadata.gz: aa7a0cf071bef428e01cee044ac90956d51876260ef839d8b0caa45fbcc6a4e3e9754a7fca78126296da1353a77bc2d8fb57f11eba620d37229580a43ad861cd
-  data.tar.gz: 485b8df1cbaa13f47ddf4c3d610dcf9f0104cb6b9e496230afe94967150b1577e71076edb317b40359c137685f26b7050ffc646b52168ff4060bed561a5519d5
+  metadata.gz: 0d97ddcc2a8b633bf5a091d1da0451cf19f1c2043c419f38b0cf443b17034045e70923236b46664705fbc6e16195d4644c6787fa65e25a907cf5c2453a7cb883
+  data.tar.gz: 19262716885a3d898bf6629376a5e76904ed3c45a9b9a2258a36d8995385cb8966efd23f9e0d6591b72a5acfb4671038ffd09d6e37916208355c0bb8f13d308a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.4.2
+* Support for `package_whitelist` in configuration.
+* Fix help output from command-line tool
+
 ## 2.4.1
 * Fix problem where missing licenses from gemspecs overrode hand-authored manifest values.
 

data/README.md

@@ -68,6 +68,10 @@ Papers.configure do |config|
   # ]
   # config.license_whitelist << 'New Relic'
 
+  # You can specify packages which should be whitelisted regardless of license, in case you know your usage
+  # is OK even though you prefer not to use its license in other cases.
+  # config.package_whitelist << 'thin-1.7.0'
+
   # 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'

data/Rakefile

@@ -1,5 +1,6 @@
 #!/usr/bin/env rake
 require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
      t.rspec_opts = "-c"

data/lib/papers/cli.rb

@@ -5,48 +5,50 @@ module Papers
   class CLI
 
     def run
-      if options[:generate]
-        begin
-          Papers::ManifestGenerator.new.generate!
-        rescue Papers::FileExistsError => e
-          warn "Error: 'papers_manifest.yml' already exists at '#{e.message}'. Aborting..."
-        end
-      end
+      options.parse!
 
-      if options[:update]
+      case @command
+      when :generate
+        Papers::ManifestGenerator.new.generate!
+      when :update
         Papers::ManifestUpdater.new.update!
+      when :help
+        emit_help ""
+      else
+        emit_help "Unrecognized command."
       end
+    rescue Papers::FileExistsError => e
+      warn "Error: 'papers_manifest.yml' already exists at '#{e.message}'. Aborting..."
+    rescue OptionParser::ParseError => e
+      emit_help "Problem parsing options: #{e.message}"
     end
 
     private
 
     def options
-      @options ||= parse_options
-    end
-
-    def parse_options
-      options = {}
-      OptionParser.new do |opts|
-        opts.banner = "Usage: papers [options]"
+      @options ||= OptionParser.new do |opts|
+        opts.banner = 'Usage: papers [options]'
 
-        opts.on("-g", "--generate", "Generate papers_manifest.yml") do |v|
-          options[:generate] = v
+        opts.on('-g', '--generate', 'Generate papers_manifest.yml') do |v|
+          @command = :generate
         end
 
         opts.on("-u", "--update", "Update papers_manifest.yml for Rubygems") do |v|
-          options[:update] = v
+          @command = :update
         end
 
-        opts.on_tail( '-h', '--help', 'Display this screen' ) do |v|
-          p opts
-          exit
+        opts.on('-h', '--help', 'Display this screen') do
+          @command = :help
         end
-        @avail_opts = opts
-      end.parse!
-
-      p @avail_opts if options.empty?
+      end
+    end
 
-      return options
+    def emit_help(header)
+      unless header.empty?
+        puts header
+        puts
+      end
+      puts options
     end
   end
 end

data/lib/papers/configuration.rb

@@ -2,6 +2,7 @@ module Papers
   class Configuration
     attr_accessor :license_whitelist
     attr_accessor :version_whitelisted_license
+    attr_accessor :package_whitelist
 
     attr_accessor :manifest_file
 
@@ -30,6 +31,8 @@ module Papers
         'ISC'
       ]
 
+      @package_whitelist = []
+
       @version_whitelisted_license = nil
 
       @manifest_file = File.join(Dir.pwd, 'config', 'papers_manifest.yml')

data/lib/papers/dependency_specification.rb

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

data/lib/papers/version.rb

@@ -2,7 +2,7 @@ module Papers
   class Version
     MAJOR = 2
     MINOR = 4
-    PATCH = 1
+    PATCH = 2
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/papers_spec.rb

@@ -121,6 +121,27 @@ describe 'Papers' do
     ])
   end
 
+  it 'is OK with whitelisting specific gems' do
+    allow_any_instance_of(Papers::Configuration).to receive(:package_whitelist).and_return(['foo-1.2'])
+    allow_any_instance_of(Papers::LicenseValidator).to receive(:manifest).and_return({
+      'javascripts' => {},
+      'gems' => {
+        'foo-1.2' => { 'license' => 'GPL' },
+        'baz-1.3' => { 'license' => 'GPL' }
+      }
+    })
+    allow(Bundler).to receive_message_chain(:load, :specs).and_return([
+      double(name: 'foo', version: '1.2', licenses: ['GPL']),
+      double(name: 'baz', version: '1.3', licenses: ['GPL'])
+    ])
+
+    expect(validator).not_to be_valid
+
+    expect(validator.errors).to eq([
+      'Gem baz-1.3 is licensed under GPL, which is not whitelisted'
+    ])
+  end
+
   it 'is OK with matching gem sets but complain about a license issue' do
     allow_any_instance_of(Papers::LicenseValidator).to receive(:manifest).and_return({
       'javascripts' => {},
@@ -413,5 +434,30 @@ describe 'Papers' do
     expect(validator).to be_valid
   end
 
+  describe "Command Line" do
+    def silently
+      vblevel = $VERBOSE 
+      $VERBOSE = nil
+      yield
+    ensure
+      $VERBOSE = vblevel
+    end
+    
+    before do
+      @old_argv = ARGV
+    end
+    after do
+      silently { ARGV = @old_argv }
+    end
+    it "runs the papers command and prints out help" do
+      silently { ARGV = %w[-h] }
+      cli = Papers::CLI.new
+      expect(cli).to receive(:puts) do |opts|
+        expect(opts.to_s).to match /^Usage: papers.*/
+      end
+      cli.run
+    end
+  end
+
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: papers
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - Ralph Bodenner
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2017-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Validate the licenses of software dependencies you use
@@ -111,4 +111,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/package.json
 - spec/support/package_with_error.json
-has_rdoc: