license_scout 2.0.7 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7ca7856e42ab2d7004c0e839c6ca76d8469fc1a576bcec0fdb2531e047c7ae8
-  data.tar.gz: dc19f95eaabff06016349cbfedfe786ffe4a44495f3fefc7bdf585aa9212d7c1
+  metadata.gz: 4f4c5bbed2fd2e2af64f8340ebb749ddd4769c5272160d96c945993c4ecd68cf
+  data.tar.gz: 858f07c4c6a5c158298f69da7c19bc58c4b316e29d5da0bfd85111ce9716669f
 SHA512:
-  metadata.gz: df5e1640eeddbac7d2e36ee9ce3ead1195facf295e366e49a86e526150c7018ffd7e606d8d107286c932a63f0c6715e22776ba71d06d635c8182db0d117d6e21
-  data.tar.gz: 503398a3e3f5e82481502fbc8e2debf31be840def48592d928bd7fa96aa26415495b1b2e27c7c5ffd0b968b352cb3e821080dcbad0d0c3947e4ea199c892d5a3
+  metadata.gz: 772a4366a8b3d14e344c1bdc7968ecb6063118c0a233c532c42c5e5f476d92110fb305bd9682504863b6cd6d27bec7b8870db9454187f920305451a0366a9297
+  data.tar.gz: be2e31e7763fc433c5ccf07778158d8d1877f9c3ff857b6148fa2f9137641bf005d5ab0c1373bae3927281eb15903e9f988efbb76ff92a71a5d5fa5760c4fc33

data/README.md

@@ -179,6 +179,22 @@ license_content | A URL to a file where the raw text of the license can be downl
 
 In addition to including any files Licensee identified as potential license files (but couldn't identify), License Scout will also include the Fallback License you specified in the Dependency Manifest.
 
+## Exporting a Dependency Manifest to another format
+
+By default, License Scout creates the Dependency Manifest as a JSON file. We do this because it provides a single document that can be easily processed into many different forms. License Scout has the ability to also export that JSON file into other formats.
+
+### Usage
+
+```
+license_scout export [PATH_TO_JSON_FILE] --format FORMAT
+```
+### Support Formats
+
+Format | Description
+--- | ---
+`csv` | Export the contents of the JSON file into a CSV.
+
+
 ## Configuration
 
 Value | Description | Default

data/lib/license_scout/cli.rb

@@ -19,6 +19,7 @@ require "zlib" # Temporarily require before rugged to fix https://github.com/pro
 
 require "mixlib/cli"
 require "license_scout/config"
+require "license_scout/exporter"
 require "license_scout/collector"
 require "license_scout/reporter"
 
@@ -41,10 +42,17 @@ module LicenseScout
       description: "Comma-separated list of directories to scan",
       proc: Proc.new { |d| d.split(",") }
 
+    option :format,
+      long: "--format FORMAT",
+      description: "When exporting a Dependency Manifest, export to this format",
+      in: LicenseScout::Exporter.supported_formats
+
     option :log_level,
       short: "-l LEVEL",
       long: "--log-level LEVEL",
-      description: "Set the log level (debug, info, warn, error, fatal)",
+      description: "Set the log level",
+      in: [:debug, :info, :warn, :error, :fatal],
+      default: :info,
       proc: Proc.new { |l| l.to_sym }
 
     option :only_show_failures,
@@ -94,11 +102,20 @@ module LicenseScout
 
       LicenseScout::Config.validate!
 
-      collector = LicenseScout::Collector.new
-      collector.collect
+      case cli_arguments[0]
+      when "export"
+        json_file = cli_arguments[1]
+        export_format = config[:format]
+
+        exporter = LicenseScout::Exporter.new(json_file, export_format)
+        exporter.export
+      else
+        collector = LicenseScout::Collector.new
+        collector.collect
 
-      reporter = LicenseScout::Reporter.new(collector.dependencies)
-      reporter.report
+        reporter = LicenseScout::Reporter.new(collector.dependencies)
+        reporter.report
+      end
     end
   end
 end

data/lib/license_scout/exceptions.rb

@@ -20,5 +20,6 @@ module LicenseScout
     class Error < RuntimeError; end
     class ConfigError < Error; end
     class MissingSourceDirectory < Error; end
+    class UnsupportedExporter < Error; end
   end
 end

data/lib/license_scout/exporter.rb

@@ -0,0 +1,51 @@
+#
+# Copyright:: Copyright 2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "license_scout/exporter/csv"
+
+module LicenseScout
+  class Exporter
+
+    attr_reader :json_file
+    attr_reader :export_format
+    attr_reader :exporter
+
+    def initialize(json_file, export_format)
+      @json_file = json_file
+      @export_format = export_format
+
+      @exporter = case export_format
+                  when "csv"
+                    LicenseScout::Exporter::CSV.new(json_file)
+                  else
+                    # We shouldn't ever hit this, because the CLI filters out unsupported formats. But just in case...
+                    raise LicenseScout::Exceptions::UnsupportedExporter.new("'#{export_format}' is not a supported format. Please use one of the following: #{supported_formats.join(", ")}")
+                  end
+    end
+
+    def self.supported_formats
+      [
+        "csv",
+      ]
+    end
+
+    def export
+      LicenseScout::Log.info("[exporter] Exporting #{json_file} to '#{export_format}'")
+      exporter.export
+    end
+  end
+end

data/lib/license_scout/exporter/csv.rb

@@ -0,0 +1,76 @@
+#
+# Copyright:: Copyright 2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "csv"
+
+module LicenseScout
+  class Exporter
+    class CSV
+
+      attr_reader :json
+      attr_reader :output_file
+
+      def initialize(json_file)
+        @json = FFI_Yajl::Parser.parse(File.read(json_file))
+        @output_file = json_file.gsub("json", "csv")
+      end
+
+      def export
+        headers = [
+          "Type",
+          "Name",
+          "Version",
+          "Has Exception",
+          "Exception Reason",
+          "License ID",
+          "License Source",
+          "License Content",
+        ]
+
+        ::CSV.open(output_file, "w+") do |csv|
+          csv << headers
+
+          json["dependencies"].each do |dependency|
+            type = dependency["type"]
+            name = dependency["name"]
+            version = dependency["version"]
+            has_exception = dependency["has_exception"]
+            exception_reason = dependency["exception_reason"]
+            licenses = dependency["licenses"]
+
+            licenses.each do |license|
+              id = license["id"]
+              source = license["source"]
+              content = license["content"]
+
+              csv << [
+                type,
+                name,
+                version,
+                (has_exception.nil? ? "Yes" : "No"),
+                (exception_reason.nil? ? "" : exception_reason),
+                id,
+                source,
+                content
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/license_scout/spdx.rb

@@ -94,7 +94,6 @@ module LicenseScout
 
       def special_cases
         {
-          # Pulled from http://search.cpan.org/~dagolden/CPAN-Meta-2.150010/lib/CPAN/Meta/Spec.pm#license
           "agpl_3"      => "AGPL-3.0",
           "apache_1_1"  => "Apache-1.1",
           "apache_2_0"  => "Apache-2.0",
@@ -109,6 +108,8 @@ module LicenseScout
           "mit"         => "MIT",
           "mozilla_1_0" => "MPL-1.0",
           "mozilla_1_1" => "MPL-1.1",
+          "mplv1.0"     => "MPL-1.0",
+          "mplv1.1"     => "MPL-1.1",
           "openssl"     => "OpenSSL",
           "qpl_1_0"     => "QPL-1.0",
           "perl"        => "Artistic-1.0-Perl",

data/lib/license_scout/version.rb

@@ -16,5 +16,5 @@
 #
 
 module LicenseScout
-  VERSION = "2.0.7"
+  VERSION = "2.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: license_scout
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.9
 platform: ruby
 authors:
 - Serdar Sutay
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-yajl
@@ -173,6 +173,8 @@ files:
 - lib/license_scout/dependency_manager/npm.rb
 - lib/license_scout/dependency_manager/rebar.rb
 - lib/license_scout/exceptions.rb
+- lib/license_scout/exporter.rb
+- lib/license_scout/exporter/csv.rb
 - lib/license_scout/license.rb
 - lib/license_scout/log.rb
 - lib/license_scout/reporter.rb