licensed 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd572795c842f263e5fc3c180b1bf716404b9021
-  data.tar.gz: '094c5d5227704cbac518df12e20b05456a4bba03'
+  metadata.gz: c0f8ca7a1d4607f4051c9347ce5d9de2b42fa46f
+  data.tar.gz: 9a0aee1b3d112ca9c57ea0ec74db1c91e62048cd
 SHA512:
-  metadata.gz: be757c8f540285eaa610799963f184522e923c14bdb54d6250709511a13e6f08d3cac1da1e72b5d625687a5b0b4b874cfab50f8589ad3614cf2673a8b1781766
-  data.tar.gz: 836885af14623a25feb9ebaf8a697a9c7878bd9bc839615c4dc5e685f913059ddeb93b122b9b7ba19a2419965b2a8009c2d6f8594cbafcba922f2259505d1a72
+  metadata.gz: 3e9c5fcd573bbe2bd7a275ac60ae90423d207b87673d900e95322404081f2aefd7db237aef8f582a5bf51b9e007e271e49a28b8cb73e7df612c5e5559b8c9954
+  data.tar.gz: ea703164f15583a9eb0728055a2443ddde2e14e53a0b93fae2dcada23ca64b926f8e4821ad1c76edf0397a3af8abd0540790084e3d93e741b2cb1fadaff7f4d8

data/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## 2.0.1 - 2019-02-14
+
+### Changes
+- Dependency paths that don't exist on the local disk are reported as warnings
+- Cache, status and list output is sorted by app name, source type and dependency name
+- Bumped `licensee` gem requirement
+
 ## 2.0.0 - 2019-02-09
 
 **This is a major release and includes breaking changes to the configuration and cached record file formats**
@@ -133,4 +140,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 Initial release :tada:
 
-[Unreleased]: https://github.com/github/licensed/compare/2.0.0...HEAD
+[Unreleased]: https://github.com/github/licensed/compare/2.0.1...HEAD

data/lib/licensed/commands/cache.rb

@@ -41,6 +41,10 @@ module Licensed
           report["cached"] = true
         end
 
+        if !dependency.exist?
+          report.warnings << "expected dependency path #{dependency.path} does not exist"
+        end
+
         true
       end
 

data/lib/licensed/commands/command.rb

@@ -20,7 +20,9 @@ module Licensed
         @options = options
         begin
           result = reporter.report_run(self) do
-            config.apps.map { |app| run_app(app) }.all?
+            config.apps.sort_by { |app| app["name"] }
+                       .map { |app| run_app(app) }
+                       .all?
           end
         ensure
           @options = nil
@@ -41,7 +43,9 @@ module Licensed
         reporter.report_app(app) do |report|
           Dir.chdir app.source_path do
             begin
-              app.sources.select(&:enabled?).map { |source| run_source(app, source) }.all?
+              app.sources.select(&:enabled?)
+                         .sort_by { |source| source.class.type }
+                         .map { |source| run_source(app, source) }.all?
             rescue Licensed::Shell::Error => err
               report.errors << err.message
               false
@@ -60,7 +64,9 @@ module Licensed
       def run_source(app, source)
         reporter.report_source(source) do |report|
           begin
-            source.dependencies.map { |dependency| run_dependency(app, source, dependency) }.all?
+            source.dependencies.sort_by { |dependency| dependency.name }
+                               .map { |dependency| run_dependency(app, source, dependency) }
+                               .all?
           rescue Licensed::Shell::Error => err
             report.errors << err.message
             false

data/lib/licensed/dependency.rb

@@ -23,9 +23,8 @@ module Licensed
     def initialize(name:, version:, path:, search_root: nil, metadata: {}, errors: [])
       # check the path for default errors if no other errors
       # were found when loading the dependency
-      if errors.empty?
-        path_error = path_error(path, search_root)
-        errors.push(path_error) if path_error
+      if errors.empty? && path.to_s.empty?
+        errors.push("dependency path not found")
       end
 
       @name = name
@@ -47,6 +46,21 @@ module Licensed
       super(path, search_root: search_root, detect_readme: true, detect_packages: true)
     end
 
+    # Returns whether the dependency exists locally
+    def exist?
+      # some types of dependencies won't necessarily have a path that exists,
+      # but they can still find license contents between the given path and
+      # the search root
+      # @root is defined
+      path.exist? || File.exist?(@root)
+    end
+
+    # Returns the location of this dependency on the local disk
+    def path
+      # exposes the private method Licensee::Projects::FSProject#dir_path
+      dir_path
+    end
+
     # Returns true if the dependency has any errors, false otherwise
     def errors?
       errors.any?
@@ -96,17 +110,6 @@ module Licensed
 
     private
 
-    def path_error(path, search_root)
-      return "dependency path not found" if path.to_s.empty?
-      return if File.exist?(path)
-      return if search_root && File.exist?(search_root)
-
-      # if the given path doesn't exist
-      # AND a search root isn't given, or the search root doesn't exist
-      # then set an error that the expected dependency path doesn't exist
-      "expected dependency path #{path} does not exist"
-    end
-
     # Returns the sources for a group of license or notice file contents
     #
     # Sources are returned as a single string with sources separated by ", "

data/lib/licensed/reporters/cache_reporter.rb

@@ -27,6 +27,22 @@ module Licensed
           shell.info "  #{source.class.type}"
           result = yield report
 
+          warning_reports = report.all_reports.select { |report| report.warnings.any? }.to_a
+          if warning_reports.any?
+            shell.newline
+            shell.warn "  * Warnings:"
+            warning_reports.each do |report|
+              display_metadata = report.map { |k, v| "#{k}: #{v}" }.join(", ")
+
+              shell.warn "    * #{report.name}"
+              shell.warn "    #{display_metadata}" unless display_metadata.empty?
+              report.warnings.each do |warning|
+                shell.warn "      - #{warning}"
+              end
+              shell.newline
+            end
+          end
+
           errored_reports = report.all_reports.select { |report| report.errors.any? }.to_a
           if errored_reports.any?
             shell.newline

data/lib/licensed/reporters/reporter.rb

@@ -19,6 +19,10 @@ module Licensed
           @errors ||= []
         end
 
+        def warnings
+          @warnings ||= []
+        end
+
         def all_reports
           result = []
           result << self

data/lib/licensed/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Licensed
-  VERSION = "2.0.0".freeze
+  VERSION = "2.0.1".freeze
 
   def self.previous_major_versions
     major_version = Gem::Version.new(Licensed::VERSION).segments.first

data/licensed.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_dependency "licensee", "~> 9.0"
+  spec.add_dependency "licensee", "~> 9.10"
   spec.add_dependency "thor", "~> 0.19"
   spec.add_dependency "pathname-common_prefix", "~> 0.0.1"
   spec.add_dependency "tomlrb", "~> 1.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: licensed
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2019-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: licensee
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '9.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '9.10'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement