bibliothecary 7.3.0 → 7.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bf41693f3224f06747aa8ea8799d369d68b262033689b900fe1a18c35803b85
-  data.tar.gz: 4cee903aaa6fff7e24e7ca4f8ddd162d2dd42af4ec04161fac21397622e6f5cd
+  metadata.gz: f9cdc8b0bab4370b5ae6a4a6762e3284bf5c2d8dac3ea8245e58951035d23bd3
+  data.tar.gz: ed8b124a915ef7abc4453b0108e0ddbf491b5e1958f6e44df592ba3386a7de58
 SHA512:
-  metadata.gz: c178932cf88d945686cfa34ab2e9cf581c2b99878d51e2fc783e98804b63737f7f852a1017c81c4aec9c8ca7f425b54b3092722f95b767e37be07fce343a2740
-  data.tar.gz: b11a8ea3373f61fb2d1def0f203a400c864f30eec52faa77551d256cdc1a9c27e20e960b4151713982987faea0af8529e83f0d8606129613591487a358c26755
+  metadata.gz: 337ad0b7fb2585f5d557458176be1933ba89c0be4863486a310e3e7cc4cce6b230b0461b42bbca4e76f058e6a10031e24799f8a6d72adc49d0ff30f7bc1cd257
+  data.tar.gz: f4a6b28b6e815a255fa6e7e2917df95b70204bb657b2a92c58f8d85badfe71cbe1f7e83c43fbe23fdc53f016cc3b417c4de47832841d7105e3b3f5f4295ca57d

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/lib/bibliothecary/analyser.rb

@@ -25,6 +25,10 @@ module Bibliothecary
       base.extend(ClassMethods)
     end
     module ClassMethods
+      def generic?
+        platform_name == "generic"
+      end
+
       def mapping_entry_match?(matcher, details, info)
         if matcher.call(info.relative_path)
           # we only want to load contents if we don't have them already
@@ -119,13 +123,32 @@ module Bibliothecary
       end
       alias analyze_contents analyse_contents
 
+      def dependencies_to_analysis(info, kind, dependencies)
+        dependencies = dependencies || [] # work around any legacy parsers that return nil
+        if generic?
+          analyses = []
+          grouped = dependencies.group_by { |dep| dep[:platform] }
+          all_analyses = grouped.keys.map do |platform|
+            deplatformed_dependencies = grouped[platform].map { |d| d.delete(:platform); d }
+            Bibliothecary::Analyser::create_analysis(platform, info.relative_path, kind, deplatformed_dependencies)
+          end
+          # this is to avoid a larger refactor for the time being. The larger refactor
+          # needs to make analyse_contents return multiple analysis, or add another
+          # method that can return multiple and deprecate analyse_contents, perhaps.
+          raise "File contains zero or multiple platforms, currently must have exactly one" if all_analyses.length != 1
+          all_analyses.first
+        else
+          Bibliothecary::Analyser::create_analysis(platform_name, info.relative_path, kind, dependencies)
+        end
+      end
+
       def analyse_contents_from_info(info)
         # If your Parser needs to return multiple responses for one file, please override this method
         # For example see conda.rb
         kind = determine_kind_from_info(info)
         dependencies = parse_file(info.relative_path, info.contents)
 
-        Bibliothecary::Analyser::create_analysis(platform_name, info.relative_path, kind, dependencies || [])
+        dependencies_to_analysis(info, kind, dependencies)
       rescue Bibliothecary::FileParsingError => e
         Bibliothecary::Analyser::create_error_analysis(platform_name, info.relative_path, kind, e.message)
       end

data/lib/bibliothecary/parsers/generic.rb

@@ -0,0 +1,39 @@
+require 'csv'
+
+module Bibliothecary
+  module Parsers
+    class Generic
+      include Bibliothecary::Analyser
+
+      def self.mapping
+        {
+          match_filename("dependencies.csv") => {
+            kind: 'lockfile',
+            parser: :parse_lockfile
+          }
+        }
+      end
+
+      def self.parse_lockfile(file_contents)
+        table = CSV.parse(file_contents, headers: true)
+
+        required_headers = ["platform", "name", "requirement"]
+        missing_headers = required_headers - table.headers
+        raise "Missing headers #{missing_headers} in CSV" unless missing_headers.empty?
+
+        table.map.with_index do |row, idx|
+          line = idx + 1
+          required_headers.each do |h|
+            raise "missing field '#{h}' on line #{line}" if row[h].empty?
+          end
+          {
+            platform: row['platform'],
+            name: row['name'],
+            requirement: row['requirement'],
+            type: row.fetch('type', 'runtime'),
+          }
+        end
+      end
+    end
+  end
+end

data/lib/bibliothecary/parsers/maven.rb

@@ -127,10 +127,12 @@ module Bibliothecary
 
           split = gradle_dep_match.captures[0]
 
-          # org.springframework.boot:spring-boot-starter-web:2.1.0.M3 (*)
-          # Lines can end with (c), (n), or (*)
-          # to indicate that something was a dependency constraint (c), not resolved (n), or resolved previously (*).
-          dep = line.split(split)[1].sub(/(\((c|n|\*)\))$/, "").sub(" -> ", ":").strip.split(":")
+
+          dep = line
+            .split(split)[1].sub(/(\((c|n|\*)\))$/, "") # line ending legend: (c) means a dependency constraint, (n) means not resolved, or (*) means resolved previously, e.g. org.springframework.boot:spring-boot-starter-web:2.1.0.M3 (*)
+            .sub(/ FAILED$/, "") # dependency could not be resolved (but still may have a version)
+            .sub(" -> ", ":") # handle version arrow syntax
+            .strip.split(":")
 
           # A testImplementation line can look like this so just skip those
           # \--- org.springframework.security:spring-security-test (n)
@@ -279,7 +281,7 @@ module Bibliothecary
         non_prop_name = property_name.gsub(".", "/").gsub("project/", "")
         return "${#{property_name}}" if !xml.respond_to?("properties") && parent_properties.empty? && xml.locate(non_prop_name).empty?
 
-        prop_field = xml.properties.locate(property_name).first
+        prop_field = xml.properties.locate(property_name).first if xml.respond_to?("properties")
         parent_prop = parent_properties[property_name]
         if prop_field
           prop_field.nodes.first

data/lib/bibliothecary/parsers/npm.rb

@@ -97,6 +97,18 @@ module Bibliothecary
         transform_tree_to_array(manifest.fetch('dependencies', {}))
       end
 
+      def self.lockfile_preference_order(file_infos)
+        files = file_infos.each_with_object({}) do |file_info, obj|
+          obj[File.basename(file_info.full_path)] = file_info
+        end
+
+        if files["npm-shrinkwrap.json"]
+          [files["npm-shrinkwrap.json"]] + files.values.reject { |fi| File.basename(fi.full_path) == "npm-shrinkwrap.json" }
+        else
+          files.values
+        end
+      end
+
       private_class_method def self.transform_tree_to_array(deps_by_name)
         deps_by_name.map do |name, metadata|
           [

data/lib/bibliothecary/related_files_info.rb

@@ -19,6 +19,9 @@ module Bibliothecary
 
     def initialize(file_infos)
       package_manager = file_infos.first.package_manager
+      if package_manager.respond_to?(:lockfile_preference_order)
+        file_infos = package_manager.lockfile_preference_order(file_infos)
+      end
       @platform = package_manager.platform_name
       @path = Pathname.new(File.dirname(file_infos.first.relative_path)).cleanpath.to_path
       # `package_manager.determine_kind_from_info(info)` can be an Array, so use include? which also works for string

data/lib/bibliothecary/version.rb

@@ -1,3 +1,3 @@
 module Bibliothecary
-  VERSION = "7.3.0"
+  VERSION = "7.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bibliothecary
 version: !ruby/object:Gem::Version
-  version: 7.3.0
+  version: 7.3.4
 platform: ruby
 authors:
 - Andrew Nesbitt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tomlrb
@@ -206,7 +206,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - andrewnez@gmail.com
 executables:
@@ -251,6 +251,7 @@ files:
 - lib/bibliothecary/parsers/cran.rb
 - lib/bibliothecary/parsers/dub.rb
 - lib/bibliothecary/parsers/elm.rb
+- lib/bibliothecary/parsers/generic.rb
 - lib/bibliothecary/parsers/go.rb
 - lib/bibliothecary/parsers/hackage.rb
 - lib/bibliothecary/parsers/haxelib.rb
@@ -274,7 +275,7 @@ homepage: https://github.com/librariesio/bibliothecary
 licenses:
 - AGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -290,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Find and parse manifests
 test_files: []