papers 2.4.2 → 2.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ff0340e975da31aa959dcddcdd5b7a78c9140ecc
-  data.tar.gz: fd4265cbcdbd98799e115667658eb9450e52493f
+SHA256:
+  metadata.gz: 174c6341ec833049a5cb09f89779966021a1c50b8152e96bb9be8866a4446b7e
+  data.tar.gz: f7b0dc8ef6a71ef26698f95eb9264fb66c2235c13113eacba5694c506f64946b
 SHA512:
-  metadata.gz: 0d97ddcc2a8b633bf5a091d1da0451cf19f1c2043c419f38b0cf443b17034045e70923236b46664705fbc6e16195d4644c6787fa65e25a907cf5c2453a7cb883
-  data.tar.gz: 19262716885a3d898bf6629376a5e76904ed3c45a9b9a2258a36d8995385cb8966efd23f9e0d6591b72a5acfb4671038ffd09d6e37916208355c0bb8f13d308a
+  metadata.gz: 1b187474da6f2d1d898916db86b673935618c9e3dc9fbc2c005d7363d7a45eeccce39ee1742662eb94a31097a320475e64371189df8dad0321ebfcaeb8578d87
+  data.tar.gz: f151154a7a5f36bd62acec733f17fa5d9313765d11bdddab9dce97a85643d81b0736669f0e1ea447e818676a723820e71a4735e437dd30e501259c04da48c6cf

data/.gitignore

@@ -4,3 +4,5 @@ Guardfile
 *.swp
 Gemfile.lock
 *.gem
+# Ignore coverage files
+coverage

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.4.4
+* Fix to not re-apply already present license change warnings.
+
+## 2.4.3
+* Better whitespace output to avoid trailing spaces.
+
 ## 2.4.2
 * Support for `package_whitelist` in configuration.
 * Fix help output from command-line tool

data/Gemfile

@@ -1,3 +1,9 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gemspec
+gemspec
+gem 'rspec', '~> 3.5'
+gem 'rubocop', group: 'development'
+
+group :test do
+  gem 'simplecov', '~> 0.21.2'
+end

data/README.md

@@ -164,6 +164,16 @@ Finished in 0.01043 seconds
 1 examples, 1 failures
 ```
 
+### Generating the manifest from inside your tests
+If you update your gems on a frequent basis, failing to remember to update the Papers manifest can be a time-consuming effort in getting your tests to pass.  You can add this to your test to generate the manifest automatically:
+
+```ruby
+Papers::ManifestUpdater.new.update!
+```
+
+Note that you should not do this if you manually edit your manifest!
+
+
 ## License
 
 The Papers Gem is licensed under the __MIT License__.  See [MIT-LICENSE](https://github.com/newrelic/papers/blob/master/MIT-LICENSE) for full text.

data/lib/papers/dependency_specification.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module Papers
   class DependencySpecification
     attr_accessor :name, :license, :license_url, :project_url
@@ -16,27 +18,25 @@ module Papers
 
     def acceptable_license?
       Papers.config.license_whitelist.include?(license) ||
-      Papers.config.version_whitelisted_license == license ||
-      Papers.config.package_whitelist.include?(name)
+        Papers.config.version_whitelisted_license == license ||
+        Papers.config.package_whitelist.include?(name)
     end
 
-    protected
-
-      def self.all_from_manifest(manifest)
-        (manifest[manifest_key] || []).map do |name, info|
-          license_url = info['license_url']
-          license = info['license']
-          project_url = info['project_url']
-          self.new(name: name, license: license, license_url: license_url, project_url: project_url)
-        end.sort { |a, b| a.name.downcase <=> b.name.downcase }
-      end
+    def self.all_from_manifest(manifest)
+      (manifest[manifest_key] || []).map do |name, info|
+        license_url = info['license_url']
+        license = info['license']
+        project_url = info['project_url']
+        new(name: name, license: license, license_url: license_url, project_url: project_url)
+      end.sort { |a, b| a.name.downcase <=> b.name.downcase }
+    end
 
-      def self.missing_from_manifest(manifest)
-        introspected.to_set - all_from_manifest(manifest).map(&:name).to_set
-      end
+    def self.missing_from_manifest(manifest)
+      introspected.to_set - all_from_manifest(manifest).map(&:name).to_set
+    end
 
-      def self.unknown_in_manifest(manifest)
-        all_from_manifest(manifest).map(&:name).to_set - introspected.to_set
-      end
+    def self.unknown_in_manifest(manifest)
+      all_from_manifest(manifest).map(&:name).to_set - introspected.to_set
+    end
   end
 end

data/lib/papers/manifest_updater.rb

@@ -27,15 +27,18 @@ module Papers
       result = YAML.load(original_content)
 
       update_gems(result)
-      update_javascript(result, "javascripts", get_installed_javascripts)
-      update_javascript(result, "bower_components", get_installed_bower_components)
-      update_javascript(result, "npm_packages", get_installed_npm_packages)
+      update_javascript(result, 'javascripts', get_installed_javascripts)
+      update_javascript(result, 'bower_components', get_installed_bower_components)
+      update_javascript(result, 'npm_packages', get_installed_npm_packages)
 
-      build_header + YAML.dump(result)
+      manifest_content = build_header + YAML.dump(result)
+
+      # strip trailing whitespace, ensure file ends with a newline
+      manifest_content.gsub(/\s*$/, '') + "\n"
     end
 
     def update_gems(result)
-      result_gems = result["gems"]
+      result_gems = result['gems']
       return unless result_gems
 
       manifest_names = manifest_names(result_gems)
@@ -69,12 +72,15 @@ module Papers
 
     def update_gem(result_gems, gemspec, manifest_gem_key)
       manifest_gem = result_gems.delete(manifest_gem_key)
-      if gemspec.license && gemspec.license != manifest_gem["license"]
+      if gemspec.license && gemspec.license != manifest_gem['license']
         new_licenses = gemspec.licenses || []
         new_licenses << gemspec.license
         new_licenses.uniq!
 
-        manifest_gem["license"] = "License Change! Was '#{manifest_gem["license"]}', is now #{new_licenses}"
+        # license key could be an array to_s to protect against that
+        unless manifest_gem['license'].to_s.match(/^License Change! Was '.+', is now .+$/)
+          manifest_gem['license'] = "License Change! Was '#{manifest_gem['license']}', is now #{new_licenses}"
+        end
       end
 
       name = gem_name_and_version(gemspec)
@@ -96,7 +102,7 @@ module Papers
     end
 
     def name_from_key(key)
-      key.include?("-") ? key.rpartition("-").first : key
+      key.include?('-') ? key.rpartition('-').first : key
     end
 
     def manifest_names(result_gems)

data/lib/papers/version.rb

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

data/spec/manifest_updater_spec.rb

@@ -28,11 +28,11 @@ EOS
 gems:
   rails-4.2.0:
     license: MIT
-    license_url: 
+    license_url:
     project_url: https://github.com/rails/rails
   newrelic_rpm:
     license: New Relic
-    license_url: 
+    license_url:
     project_url: https://github.com/newrelic/rpm
 EOS
     }
@@ -40,11 +40,82 @@ EOS
     let(:shoes_license) { <<EOS
   shoes-4.0.0:
     license: MIT
-    license_url: 
+    license_url:
     project_url: http://shoesrb.com
 EOS
     }
 
+    let(:foo_license) { <<EOS
+      signed_payload-2.0.1:
+        license: License Change! Was 'New Relic', is now ["Nonstandard"]
+      license_url:
+        project_url: https://source.datanerd.us/account-auth-and-access/signed_payload
+EOS
+    }
+
+    it 'should avoid nesting license change messages' do
+      gemspec = double(name: 'foo', version: '1.2.3', license: "some License Change! Was 'New Relic', is now [\"Nonstandard\"]", licenses: [], homepage: 'foo.com')
+
+      result_gems = {}
+      manifest_gem_key = 'foo'
+      allow(result_gems).to receive(:delete).with(manifest_gem_key).and_return({
+        'name' => 'foo',
+        'version' => '1.2.3',
+        'license' => "License Change! Was 'New Relic', is now [\"Nonstandard\"]",
+        'homepage' => 'foo.com'
+      })
+
+      updater.update_gem(result_gems, gemspec, manifest_gem_key)
+      expect(result_gems['foo']).to eq({
+        'name' => 'foo',
+        'version' => '1.2.3',
+        'license' => "License Change! Was 'New Relic', is now [\"Nonstandard\"]",
+        'homepage' => 'foo.com'
+      })
+    end
+
+    it 'should work as normal for non nested changes' do
+      gemspec = double(name: 'foo', version: '1.2.3', license: "asdf", licenses: [], homepage: 'foo.com')
+
+      result_gems = {}
+      manifest_gem_key = 'foo'
+      allow(result_gems).to receive(:delete).with(manifest_gem_key).and_return({
+        'name' => 'foo',
+        'version' => '1.2.3',
+        'license' => "ldkadfaldfjalkdsfj",
+        'homepage' => 'foo.com'
+      })
+
+      updater.update_gem(result_gems, gemspec, manifest_gem_key)
+      expect(result_gems['foo']).to eq({
+        'name' => 'foo',
+        'version' => '1.2.3',
+        'license' => "License Change! Was 'ldkadfaldfjalkdsfj', is now [\"asdf\"]",
+        'homepage' => 'foo.com'
+      })
+    end
+
+    # We don't want to support it fully, but don't bomb out if we find an array
+    it 'should handle array in manifest' do
+      gemspec = double(name: 'foo', version: '1.2.3', license: "asdf", licenses: ["asdf", "new"], homepage: 'foo.com')
+
+      result_gems = {}
+      manifest_gem_key = 'foo'
+      allow(result_gems).to receive(:delete).with(manifest_gem_key).and_return({
+        'name' => 'foo',
+        'version' => '1.2.3',
+        'license' => ["asdf", "old"],
+        'homepage' => 'foo.com'
+      })
+
+      updater.update_gem(result_gems, gemspec, manifest_gem_key)
+      expect(result_gems['foo']).to eq({
+        'name' => 'foo',
+        'version' => '1.2.3',
+        'license' => "License Change! Was '[\"asdf\", \"old\"]', is now [\"asdf\", \"new\"]",
+        'homepage' => 'foo.com'
+      })
+    end
 
     it "avoids unnecessary updates" do
       allow(updater).to receive(:gemspecs).and_return([
@@ -117,26 +188,26 @@ javascripts:
     project_url: http://newrelic.com
   app/javascripts/instances/show.js:
     license: Unknown
-    license_url: 
-    project_url: 
+    license_url:
+    project_url:
 bower_components:
   angular:
     license: MIT
-    license_url: 
-    project_url: 
+    license_url:
+    project_url:
   lodash:
     license: Unknown
-    license_url: 
-    project_url: 
+    license_url:
+    project_url:
 npm_packages:
   react:
     license: MIT
-    license_url: 
-    project_url: 
+    license_url:
+    project_url:
   redux:
     license: Unknown
-    license_url: 
-    project_url: 
+    license_url:
+    project_url:
 EOS
     }
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
 require 'bundler/setup'
 require 'rspec'
 require_relative '../lib/papers'
+require "simplecov"
+SimpleCov.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: papers
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.4.4
 platform: ruby
 authors:
 - Ralph Bodenner
@@ -9,10 +9,10 @@ authors:
 - Andrew Bloomgarden
 - Lucas Charles
 - David Celis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -84,7 +84,7 @@ homepage: http://github.com/newrelic/papers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,9 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Validate the licenses of software dependencies you use
 test_files: