papers 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfd7610ff7eff6eb48c83d3f902c4f7c4ef4d214
-  data.tar.gz: 45cb1a15b0fba628c1eb364aae04334a9dfd0d65
+  metadata.gz: 8b479439cba7ef8f166e55d48d8b93ff23c03163
+  data.tar.gz: 17e3b3b2ce0e29fdb3374d1204915ff5bb1df325
 SHA512:
-  metadata.gz: 06ba1ff51f47f3ca4f0d83de73e603b4bb81b8a1221a3dd7bb7df879960a345cb36dd390d78db3c4d7d9f3b1dbca526491f5e3a89fe3678aaeb61b6145b6721c
-  data.tar.gz: d3b580aadb4eade7e5bb0b054d119e5c31589d6e58bcbd0b55bd70a8a0475b36e567668d251f5684fffb23cd09439fb993fd66f6ac2bcb81590abf816742bbd9
+  metadata.gz: 936e52964c04812d06e480f6bd17be2b177acf37be576eba220481f64cd457c69ad10929b42ea05b4bec207135e093e428622a96af5336896508884bade0a366
+  data.tar.gz: 195bcdbba896629fda6d65c0763b5a696f9e5eb489610b2a87e1db2d9cfa8d33b7d0955d274752ced76265549faeac42932da71e8ca1d7ae25ab2d1c59cd6d16

data/README.md

@@ -92,6 +92,13 @@ 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'
+
+  # Configures Papers to validate licenses for NPM dependencies. Defaults to false.
+  config.validate_npm_packages = false
+
+  # Configures where Papers should look for the package.json file. Defaults to:
+  # package.json in the root directory of the project
+  config.npm_package_json_path = File.join(Dir.pwd, 'package.json')
 end
 ```
 

data/lib/papers/configuration.rb

@@ -8,9 +8,11 @@ module Papers
     attr_accessor :validate_gems
     attr_accessor :validate_javascript
     attr_accessor :validate_bower_components
+    attr_accessor :validate_npm_packages
 
     attr_accessor :javascript_paths
     attr_accessor :bower_components_path
+    attr_accessor :npm_package_json_path
 
     def initialize
       @license_whitelist = [
@@ -32,6 +34,8 @@ module Papers
       @validate_gems             = true
       @validate_javascript       = true
       @validate_bower_components = false
+      @validate_npm_packages = false
+
 
       @javascript_paths = [
         File.join(Dir.pwd, 'app',    'assets', 'javascripts'),
@@ -40,6 +44,8 @@ module Papers
       ]
 
       @bower_components_path = File.join(Dir.pwd, 'vendor', 'assets', 'components')
+
+      @npm_package_json_path = File.join(Dir.pwd, 'package.json')
     end
 
     def validate_gems?
@@ -53,5 +59,10 @@ module Papers
     def validate_bower_components?
       !!@validate_bower_components
     end
+
+    def validate_npm_packages?
+      !!@validate_npm_packages
+    end
+
   end
 end

data/lib/papers/dependency_specification/npm_package.rb

@@ -0,0 +1,41 @@
+require 'json'
+
+module Papers
+  class NpmPackage < DependencySpecification
+    def self.introspected
+      full_introspected_entries.map {|e| "#{e['name']}-#{e['version']}"}
+    end
+
+    def self.full_introspected_entries
+      packages = (package['dependencies'] || {}).merge((package['devDependencies'] || {}))
+      packages.map do |name, version|
+        version.sub!(/^\D+/, '')
+        {
+          'name' => name,
+          'version' => version
+        }
+      end
+    end
+
+    def pretty_hash
+      {
+        name: name_without_version,
+        license: license,
+        license_url: @license_url,
+        project_url: @project_url
+      }
+    end
+
+    def self.manifest_key
+      "npm_packages"
+    end
+
+    private
+
+    def self.package
+      pkg = File.read(Papers.config.npm_package_json_path)
+      JSON.parse(pkg)
+    end
+  end
+end
+

data/lib/papers/license_validator.rb

@@ -4,6 +4,7 @@ require 'papers/dependency_specification'
 require 'papers/dependency_specification/gem'
 require 'papers/dependency_specification/javascript'
 require 'papers/dependency_specification/bower_component'
+require 'papers/dependency_specification/npm_package'
 
 module Papers
   class LicenseValidator
@@ -19,6 +20,7 @@ module Papers
       validate_spec_type(Gem)            if Papers.config.validate_gems?
       validate_spec_type(Javascript)     if Papers.config.validate_javascript?
       validate_spec_type(BowerComponent) if Papers.config.validate_bower_components?
+      validate_spec_type(NpmPackage)  if Papers.config.validate_npm_packages?
 
       @errors.empty?
     end
@@ -39,6 +41,10 @@ module Papers
       BowerComponent.all_from_manifest(manifest).map(&:pretty_hash)
     end
 
+    def pretty_npm_package_list
+      NpmPackage.all_from_manifest(manifest).map(&:pretty_hash)
+    end
+
     private
 
       def validate_spec_type(spec_type)

data/lib/papers/manifest_generator.rb

@@ -40,7 +40,8 @@ module Papers
       manifest = {
         "gems"             => get_installed_gems,
         "javascripts"      => get_installed_javascripts,
-        "bower_components" => get_installed_bower_components
+        "bower_components" => get_installed_bower_components,
+        "npm_packages" => get_npm_packages
       }
       return manifest
     end
@@ -91,6 +92,17 @@ module Papers
       components.empty? ? nil : components
     end
 
+    def get_npm_packages
+      packages = {}
+      NpmPackage.full_introspected_entries.each do |entry|
+        packages[entry['name']] = {
+          'license' => 'Unknown',
+          'license_url' => nil,
+          'project_url' => nil
+        }
+      end
+    end
+
     def manifest_exists?
       !!File.exist?(@manifest_path)
     end

data/lib/papers/version.rb

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

data/spec/npm_package_spec.rb

@@ -0,0 +1,93 @@
+require 'bundler/setup'
+require 'rspec'
+require_relative '../lib/papers'
+
+describe 'NpmPackageSpecification' do
+  describe '#full_introspected_entries' do
+    it 'reads dependencies from the specified file' do
+      Papers::Configuration.any_instance.stub(:npm_package_json_path).and_return('spec/support/package.json')
+
+      expect(Papers::NpmPackage.full_introspected_entries).to eq([
+        {"name"=>"prod_dependency", "version"=>"3.2.0"},
+        {"name"=>"dev_dependency", "version"=>"1.2.3"}
+      ])
+    end
+
+    it "raises an error when package.json is not found" do
+      expect { Papers::NpmPackage.full_introspected_entries }.to raise_error Errno::ENOENT
+    end
+
+    it "raises an error when package.json does not parse properly" do
+      Papers::Configuration.any_instance.stub(:npm_package_json_path).and_return('spec/support/package_with_error.json')
+      expect { Papers::NpmPackage.full_introspected_entries }.to raise_error JSON::ParserError
+    end
+
+    it 'combines dependencies and devDependencies' do
+      Papers::NpmPackage.stub(:package)
+                    .and_return({'dependencies' => {'prod_package' => '~> 1.2.3'},
+                                 'devDependencies' => {'dev_package' => '~> 1.2.0'}})
+
+
+      expect(Papers::NpmPackage.full_introspected_entries).to eq([
+        { 'name' => 'prod_package', 'version' => '1.2.3' },
+        { 'name' => 'dev_package', 'version' => '1.2.0' }
+      ])
+    end
+
+    it 'returns dependencies when devDependencies is not defined' do
+      Papers::NpmPackage.stub(:package)
+                    .and_return({'dependencies' => {'npm_package' => '1.2.3'}})
+
+      expect(Papers::NpmPackage.full_introspected_entries).to eq([{
+        'name' => 'npm_package',
+        'version' => '1.2.3'
+      }])
+    end
+
+    it 'returns devDependencies when dependencies is not defined' do
+      Papers::NpmPackage.stub(:package)
+                    .and_return({'devDependencies' => {'npm_package' => '1.2.3'}})
+
+      expect(Papers::NpmPackage.full_introspected_entries).to eq([{
+        'name' => 'npm_package',
+        'version' => '1.2.3'
+      }])
+    end
+
+    it 'removes leading non-digits from the version' do
+      Papers::NpmPackage.stub(:package)
+                    .and_return({'dependencies' => {'npm_package' => '~> 1.2.3'}})
+
+      expect(Papers::NpmPackage.full_introspected_entries).to eq([{
+        'name' => 'npm_package',
+        'version' => '1.2.3'
+      }])
+    end
+
+    it 'returns an empty array when the dependencies and devDependencies keys are not defined' do
+      Papers::NpmPackage.stub(:package)
+                    .and_return({})
+
+      expect(Papers::NpmPackage.full_introspected_entries).to eq([])
+    end
+  end
+
+  describe "#introspected" do
+    it "returns an array of name-version strings" do
+      Papers::NpmPackage.stub(:full_introspected_entries)
+                           .and_return([{
+                                          'name' => 'npm_package',
+                                          'version' => '1.2.3'
+                                        }])
+
+      expect(Papers::NpmPackage.introspected).to eq(["npm_package-1.2.3"])
+    end
+
+    it "returns an empty array when the dependencies key is not defined" do
+      Papers::NpmPackage.stub(:full_introspected_entries)
+                           .and_return([])
+
+      expect(Papers::NpmPackage.introspected).to eq([])
+    end
+  end
+end

data/spec/papers_spec.rb

@@ -256,6 +256,53 @@ describe 'Papers' do
     ])
   end
 
+  it 'displays npm package licenses in a pretty format without versions' do
+    Papers::Configuration.any_instance.stub(:validate_npm_packages?).and_return(true)
+
+    Papers::LicenseValidator.any_instance.stub(:manifest).and_return({
+      'javascripts' => {},
+      'gems' => {},
+      'npm_packages' => {
+        '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
+        }
+      },
+    })
+
+    expect(validator.pretty_npm_package_list).to eq([
+      {
+        name: 'baz',
+        license: 'BSD',
+        license_url: nil,
+        project_url: nil
+      },
+      {
+        name: 'foo',
+        license: 'MIT',
+        license_url: nil,
+        project_url: nil
+      },
+      {
+        name: 'with-hyphens',
+        license: 'MIT',
+        license_url: nil,
+        project_url: nil
+      }
+    ])
+  end
+
   it 'displays the gem name when the gemspec does not specify a version' do
     gemspec = Papers::Gem.new(name: 'foo')
     expect('foo').to eq(gemspec.name_without_version)

data/spec/support/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "test_package_file",
+  "version": "0.0.0",
+  "dependencies": {
+    "prod_dependency": "~3.2.0"
+  },
+  "devDependencies": {
+    "dev_dependency": "1.2.3"
+  }
+}

data/spec/support/package_with_error.json

@@ -0,0 +1,11 @@
+// This has a syntax error to test for proper failure
+{
+  "name": "test_package_file",
+  "version": "0.0.0",
+  "dependencies": {
+    "prod_dependency": "~3.2.0",
+  },
+  "devDependencies": {
+    "dev_dependency": "1.2.3"
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: papers
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Ralph Bodenner
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -67,11 +67,15 @@ files:
 - lib/papers/dependency_specification/bower_component.rb
 - lib/papers/dependency_specification/gem.rb
 - lib/papers/dependency_specification/javascript.rb
+- lib/papers/dependency_specification/npm_package.rb
 - lib/papers/license_validator.rb
 - lib/papers/manifest_generator.rb
 - lib/papers/version.rb
 - papers.gemspec
+- spec/npm_package_spec.rb
 - spec/papers_spec.rb
+- spec/support/package.json
+- spec/support/package_with_error.json
 homepage: http://github.com/newrelic/papers
 licenses:
 - MIT
@@ -97,5 +101,8 @@ signing_key:
 specification_version: 4
 summary: Validate the licenses of software dependencies you use
 test_files:
+- spec/npm_package_spec.rb
 - spec/papers_spec.rb
+- spec/support/package.json
+- spec/support/package_with_error.json
 has_rdoc: