bibliothecary 7.3.5 → 8.1.0

data/lib/bibliothecary/parsers/npm.rb

@@ -33,7 +33,9 @@ module Bibliothecary
         }
       end
 
-      def self.parse_shrinkwrap(file_contents)
+      add_multi_parser(Bibliothecary::MultiParsers::CycloneDX)
+
+      def self.parse_shrinkwrap(file_contents, options: {})
         manifest = JSON.parse(file_contents)
         manifest.fetch('dependencies',[]).map do |name, requirement|
           {
@@ -44,7 +46,7 @@ module Bibliothecary
         end
       end
 
-      def self.parse_package_lock(file_contents)
+      def self.parse_package_lock(file_contents, options: {})
         manifest = JSON.parse(file_contents)
         parse_package_lock_deps_recursively(manifest.fetch('dependencies', []))
       end
@@ -68,14 +70,14 @@ module Bibliothecary
         end
       end
 
-      def self.parse_manifest(file_contents)
+      def self.parse_manifest(file_contents, options: {})
         manifest = JSON.parse(file_contents)
         raise "appears to be a lockfile rather than manifest format" if manifest.key?('lockfileVersion')
         map_dependencies(manifest, 'dependencies', 'runtime') +
         map_dependencies(manifest, 'devDependencies', 'development')
       end
 
-      def self.parse_yarn_lock(file_contents)
+      def self.parse_yarn_lock(file_contents, options: {})
         response = Typhoeus.post("#{Bibliothecary.configuration.yarn_parser_host}/parse", body: file_contents)
 
         raise Bibliothecary::RemoteParsingError.new("Http Error #{response.response_code} when contacting: #{Bibliothecary.configuration.yarn_parser_host}/parse", response.response_code) unless response.success?
@@ -91,7 +93,7 @@ module Bibliothecary
         end
       end
 
-      def self.parse_ls(file_contents)
+      def self.parse_ls(file_contents, options: {})
         manifest = JSON.parse(file_contents)
 
         transform_tree_to_array(manifest.fetch('dependencies', {}))

data/lib/bibliothecary/parsers/nuget.rb

@@ -5,6 +5,7 @@ module Bibliothecary
   module Parsers
     class Nuget
       include Bibliothecary::Analyser
+      extend Bibliothecary::MultiParsers::JSONRuntime
 
       def self.mapping
         {
@@ -43,7 +44,9 @@ module Bibliothecary
         }
       end
 
-      def self.parse_project_lock_json(file_contents)
+      add_multi_parser(Bibliothecary::MultiParsers::CycloneDX)
+
+      def self.parse_project_lock_json(file_contents, options: {})
         manifest = JSON.parse file_contents
         manifest.fetch('libraries',[]).map do |name, _requirement|
           dep = name.split('/')
@@ -55,7 +58,7 @@ module Bibliothecary
         end
       end
 
-      def self.parse_packages_lock_json(file_contents)
+      def self.parse_packages_lock_json(file_contents, options: {})
         manifest = JSON.parse file_contents
 
         frameworks = {}
@@ -82,7 +85,7 @@ module Bibliothecary
         []
       end
 
-      def self.parse_packages_config(file_contents)
+      def self.parse_packages_config(file_contents, options: {})
         manifest = Ox.parse file_contents
         manifest.packages.locate('package').map do |dependency|
           {
@@ -95,7 +98,7 @@ module Bibliothecary
         []
       end
 
-      def self.parse_csproj(file_contents)
+      def self.parse_csproj(file_contents, options: {})
         manifest = Ox.parse file_contents
 
         packages = manifest.locate('ItemGroup/PackageReference').map do |dependency|
@@ -115,7 +118,7 @@ module Bibliothecary
         []
       end
 
-      def self.parse_nuspec(file_contents)
+      def self.parse_nuspec(file_contents, options: {})
         manifest = Ox.parse file_contents
         manifest.package.metadata.dependencies.locate('dependency').map do |dependency|
           {
@@ -128,7 +131,7 @@ module Bibliothecary
         []
       end
 
-      def self.parse_paket_lock(file_contents)
+      def self.parse_paket_lock(file_contents, options: {})
         lines = file_contents.split("\n")
         package_version_re = /\s+(?<name>\S+)\s\((?<version>\d+\.\d+[\.\d+[\.\d+]*]*)\)/
         packages = lines.select { |line| package_version_re.match(line) }.map { |line| package_version_re.match(line) }.map do |match|
@@ -142,7 +145,7 @@ module Bibliothecary
         packages.uniq {|package| package[:name] }
       end
 
-      def self.parse_project_assets_json(file_contents)
+      def self.parse_project_assets_json(file_contents, options: {})
         manifest = JSON.parse file_contents
 
         frameworks = {}

data/lib/bibliothecary/parsers/packagist.rb

@@ -18,7 +18,9 @@ module Bibliothecary
         }
       end
 
-      def self.parse_lockfile(file_contents)
+      add_multi_parser(Bibliothecary::MultiParsers::CycloneDX)
+
+      def self.parse_lockfile(file_contents, options: {})
         manifest = JSON.parse file_contents
         manifest.fetch('packages',[]).map do |dependency|
           {
@@ -41,7 +43,7 @@ module Bibliothecary
         end
       end
 
-      def self.parse_manifest(file_contents)
+      def self.parse_manifest(file_contents, options: {})
         manifest = JSON.parse file_contents
         map_dependencies(manifest, 'require', 'runtime') +
         map_dependencies(manifest, 'require-dev', 'development')

data/lib/bibliothecary/parsers/pub.rb

@@ -18,13 +18,13 @@ module Bibliothecary
         }
       end
 
-      def self.parse_yaml_manifest(file_contents)
+      def self.parse_yaml_manifest(file_contents, options: {})
         manifest = YAML.load file_contents
         map_dependencies(manifest, 'dependencies', 'runtime') +
         map_dependencies(manifest, 'dev_dependencies', 'development')
       end
 
-      def self.parse_yaml_lockfile(file_contents)
+      def self.parse_yaml_lockfile(file_contents, options: {})
         manifest = YAML.load file_contents
         manifest.fetch('packages', []).map do |name, dep|
           {

data/lib/bibliothecary/parsers/pypi.rb

@@ -75,17 +75,19 @@ module Bibliothecary
         }
       end
 
-      def self.parse_pipfile(file_contents)
+      add_multi_parser(Bibliothecary::MultiParsers::CycloneDX)
+
+      def self.parse_pipfile(file_contents, options: {})
         manifest = Tomlrb.parse(file_contents)
         map_dependencies(manifest['packages'], 'runtime') + map_dependencies(manifest['dev-packages'], 'develop')
       end
 
-      def self.parse_poetry(file_contents)
+      def self.parse_poetry(file_contents, options: {})
         manifest = Tomlrb.parse(file_contents)['tool']['poetry']
         map_dependencies(manifest['dependencies'], 'runtime') + map_dependencies(manifest['dev-dependencies'], 'develop')
       end
 
-      def self.parse_conda(file_contents)
+      def self.parse_conda(file_contents, options: {})
         contents = YAML.safe_load(file_contents)
         return [] unless contents
 
@@ -121,7 +123,7 @@ module Bibliothecary
         end
       end
 
-      def self.parse_pipfile_lock(file_contents)
+      def self.parse_pipfile_lock(file_contents, options: {})
         manifest = JSON.parse(file_contents)
         deps = []
         manifest.each do |group, dependencies|
@@ -138,7 +140,7 @@ module Bibliothecary
         deps
       end
 
-      def self.parse_poetry_lock(file_contents)
+      def self.parse_poetry_lock(file_contents, options: {})
         manifest = Tomlrb.parse(file_contents)
         deps = []
         manifest["package"].each do |package|
@@ -159,8 +161,8 @@ module Bibliothecary
         deps
       end
 
-      def self.parse_setup_py(manifest)
-        match = manifest.match(INSTALL_REGEXP)
+      def self.parse_setup_py(file_contents, options: {})
+        match = file_contents.match(INSTALL_REGEXP)
         return [] unless match
         deps = []
         match[1].gsub(/',(\s)?'/, "\n").split("\n").each do |line|
@@ -176,9 +178,9 @@ module Bibliothecary
         deps
       end
 
-      def self.parse_requirements_txt(manifest)
+      def self.parse_requirements_txt(file_contents, options: {})
         deps = []
-        manifest.split("\n").each do |line|
+        file_contents.split("\n").each do |line|
           match = line.delete(' ').match(REQUIREMENTS_REGEXP)
           next unless match
           deps << {

data/lib/bibliothecary/parsers/rubygems.rb

@@ -4,6 +4,7 @@ module Bibliothecary
   module Parsers
     class Rubygems
       include Bibliothecary::Analyser
+      extend Bibliothecary::MultiParsers::BundlerLikeManifest
 
       NAME_VERSION = '(?! )(.*?)(?: \(([^-]*)(?:-(.*))?\))?'.freeze
       NAME_VERSION_4 = /^ {4}#{NAME_VERSION}$/
@@ -28,8 +29,10 @@ module Bibliothecary
         }
       end
 
-      def self.parse_gemfile_lock(manifest)
-        manifest.lines(chomp: true).map do |line|
+      add_multi_parser(Bibliothecary::MultiParsers::CycloneDX)
+
+      def self.parse_gemfile_lock(file_contents, options: {})
+        file_contents.lines(chomp: true).map do |line|
           match = line.match(NAME_VERSION_4)
           next unless match
           name = match[1]
@@ -42,12 +45,12 @@ module Bibliothecary
         end.compact
       end
 
-      def self.parse_gemfile(file_contents)
+      def self.parse_gemfile(file_contents, options: {})
         manifest = Gemnasium::Parser.send(:gemfile, file_contents)
         parse_ruby_manifest(manifest)
       end
 
-      def self.parse_gemspec(file_contents)
+      def self.parse_gemspec(file_contents, options: {})
         manifest = Gemnasium::Parser.send(:gemspec, file_contents)
         parse_ruby_manifest(manifest)
       end

data/lib/bibliothecary/parsers/shard.rb

@@ -18,12 +18,12 @@ module Bibliothecary
         }
       end
 
-      def self.parse_yaml_lockfile(file_contents)
+      def self.parse_yaml_lockfile(file_contents, options: {})
         manifest = YAML.load file_contents
         map_dependencies(manifest, 'shards', 'runtime')
       end
 
-      def self.parse_yaml_manifest(file_contents)
+      def self.parse_yaml_manifest(file_contents, options: {})
         manifest = YAML.load file_contents
         map_dependencies(manifest, 'dependencies', 'runtime') +
         map_dependencies(manifest, 'development_dependencies', 'runtime')

data/lib/bibliothecary/parsers/swift_pm.rb

@@ -12,8 +12,10 @@ module Bibliothecary
         }
       end
 
-      def self.parse_package_swift(manifest)
-        response = Typhoeus.post("#{Bibliothecary.configuration.swift_parser_host}/to-json", body: manifest)
+      add_multi_parser(Bibliothecary::MultiParsers::CycloneDX)
+
+      def self.parse_package_swift(file_contents, options: {})
+        response = Typhoeus.post("#{Bibliothecary.configuration.swift_parser_host}/to-json", body: file_contents)
         raise Bibliothecary::RemoteParsingError.new("Http Error #{response.response_code} when contacting: #{Bibliothecary.configuration.swift_parser_host}/to-json", response.response_code) unless response.success?
         json = JSON.parse(response.body)
         json["dependencies"].map do |dependency|

data/lib/bibliothecary/runner.rb

@@ -1,9 +1,14 @@
 module Bibliothecary
-  # A class that allows bibliothecary to run with multiple configurations at once, rather than with one global
+  # A class that allows bibliothecary to run with multiple configurations at once, rather than with one global.
+  # A runner is created every time a file is targeted to be parsed. Don't call
+  # parse methods directory! Use a Runner.
   class Runner
 
     def initialize(configuration)
       @configuration = configuration
+      @options = {
+        cache: {}
+      }
     end
 
     def analyse(path, ignore_unparseable_files: true)
@@ -15,7 +20,7 @@ module Bibliothecary
       # associate related manifests and lockfiles for example.
       analyses = package_managers.map do |pm|
         matching_infos = info_list.select { |info| info.package_manager == pm }
-        pm.analyse_file_info(matching_infos)
+        pm.analyse_file_info(matching_infos, options: @options)
       end
       analyses = analyses.flatten.compact
 
@@ -102,7 +107,7 @@ module Bibliothecary
 
     def analyse_file(file_path, contents)
       package_managers.select { |pm| pm.match?(file_path, contents) }.map do |pm|
-        pm.analyse_contents(file_path, contents)
+        pm.analyse_contents(file_path, contents, options: @options)
       end.flatten.uniq.compact
     end
     alias analyze_file analyse_file

data/lib/bibliothecary/version.rb

@@ -1,3 +1,3 @@
 module Bibliothecary
-  VERSION = "7.3.5"
+  VERSION = "8.1.0"
 end

data/lib/bibliothecary.rb

@@ -8,6 +8,9 @@ require "bibliothecary/related_files_info"
 require "find"
 require "tomlrb"
 
+Dir[File.expand_path('../bibliothecary/multi_parsers/*.rb', __FILE__)].each do |file|
+  require file
+end
 Dir[File.expand_path('../bibliothecary/parsers/*.rb', __FILE__)].each do |file|
   require file
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bibliothecary
 version: !ruby/object:Gem::Version
-  version: 7.3.5
+  version: 8.1.0
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-18 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tomlrb
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: packageurl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -237,10 +251,16 @@ files:
 - dependencyci.yml
 - lib/bibliothecary.rb
 - lib/bibliothecary/analyser.rb
+- lib/bibliothecary/analyser/analysis.rb
+- lib/bibliothecary/analyser/determinations.rb
+- lib/bibliothecary/analyser/matchers.rb
 - lib/bibliothecary/cli.rb
 - lib/bibliothecary/configuration.rb
 - lib/bibliothecary/exceptions.rb
 - lib/bibliothecary/file_info.rb
+- lib/bibliothecary/multi_parsers/bundler_like_manifest.rb
+- lib/bibliothecary/multi_parsers/cyclonedx.rb
+- lib/bibliothecary/multi_parsers/json_runtime.rb
 - lib/bibliothecary/parsers/bower.rb
 - lib/bibliothecary/parsers/cargo.rb
 - lib/bibliothecary/parsers/carthage.rb