bibliothecary 8.7.4 → 8.7.5

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Temporarily pegging to HEAD until 0.2.1 is released: https://github.com/piotrmurach/strings-ansi/pull/2
 gem "strings-ansi", ref: "35d0c9430cf0a8022dc12bdab005bce296cb9f00", git: "git@github.com:piotrmurach/strings-ansi.git"

data/Rakefile

@@ -4,3 +4,13 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+desc "Run the linter"
+task :lint do
+  sh "bundle exec rubocop -P"
+end
+
+desc "Run the linter with autofix"
+task :fix do
+  sh "bundle exec rubocop -A"
+end

data/bibliothecary.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bibliothecary/version'
+require "bibliothecary/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "bibliothecary"

data/lib/bibliothecary/analyser.rb

@@ -1,6 +1,6 @@
-require_relative './analyser/matchers.rb'
-require_relative './analyser/determinations.rb'
-require_relative './analyser/analysis.rb'
+require_relative "./analyser/matchers.rb"
+require_relative "./analyser/determinations.rb"
+require_relative "./analyser/analysis.rb"
 
 module Bibliothecary
   module Analyser
@@ -22,7 +22,7 @@ module Bibliothecary
         path: relative_path,
         dependencies: dependencies,
         kind: kind,
-        success: true
+        success: true,
       }
     end
 
@@ -53,7 +53,7 @@ module Bibliothecary
       end
 
       def platform_name
-        self.name.to_s.split('::').last.downcase
+        self.name.to_s.split("::").last.downcase
       end
 
       def map_dependencies(hash, key, type)
@@ -61,7 +61,7 @@ module Bibliothecary
           {
             name: name,
             requirement: requirement,
-            type: type
+            type: type,
           }
         end
       end

data/lib/bibliothecary/cli.rb

@@ -1,22 +1,22 @@
-require 'bibliothecary/version'
-require 'bibliothecary'
-require 'commander'
+require "bibliothecary/version"
+require "bibliothecary"
+require "commander"
 
 module Bibliothecary
   class CLI
     include Commander::Methods
 
     def run
-      program :name, 'Bibliothecary'
+      program :name, "Bibliothecary"
       program :version, Bibliothecary::VERSION
-      program :description, 'Parse dependency information from a file or folder of code'
+      program :description, "Parse dependency information from a file or folder of code"
 
       command(:list) do |c|
-        c.syntax = 'bibliothecary list'
-        c.description = 'List dependencies'
+        c.syntax = "bibliothecary list"
+        c.description = "List dependencies"
         c.option("--path FILENAME", String, "Path to file/folder to analyse")
         c.action do |_args, options|
-          options.default path: './'
+          options.default path: "./"
           output = Bibliothecary.analyse(options.path)
           output.each do |file_contents|
             puts "#{file_contents[:path]} (#{file_contents[:platform]})"

data/lib/bibliothecary/configuration.rb

@@ -11,15 +11,15 @@ module Bibliothecary
     attr_accessor :cabal_parser_host
 
     def initialize
-      @ignored_dirs = ['.git', 'node_modules', 'bower_components', 'vendor', 'dist']
+      @ignored_dirs = [".git", "node_modules", "bower_components", "vendor", "dist"]
       @ignored_files = []
-      @carthage_parser_host = 'https://carthage.libraries.io'
-      @clojars_parser_host  = 'https://clojars.libraries.io'
-      @mix_parser_host      = 'https://mix.libraries.io'
-      @yarn_parser_host     = 'https://yarn-parser.libraries.io'
-      @conda_parser_host    = 'https://conda-parser.libraries.io'
-      @swift_parser_host    = 'http://swift.libraries.io'
-      @cabal_parser_host    = 'http://cabal.libraries.io'
+      @carthage_parser_host = "https://carthage.libraries.io"
+      @clojars_parser_host  = "https://clojars.libraries.io"
+      @mix_parser_host      = "https://mix.libraries.io"
+      @yarn_parser_host     = "https://yarn-parser.libraries.io"
+      @conda_parser_host    = "https://conda-parser.libraries.io"
+      @swift_parser_host    = "http://swift.libraries.io"
+      @cabal_parser_host    = "http://cabal.libraries.io"
     end
   end
 end

data/lib/bibliothecary/file_info.rb

@@ -1,4 +1,4 @@
-require 'pathname'
+require "pathname"
 
 module Bibliothecary
   # A representation of a file on the filesystem, with location information
@@ -17,7 +17,7 @@ module Bibliothecary
             # file that's actually on the filesystem
             nil
           else
-            contents = Bibliothecary.utf8_string(File.open(@full_path).read)
+            Bibliothecary.utf8_string(File.open(@full_path).read)
           end
         end
     end

data/lib/bibliothecary/multi_parsers/bundler_like_manifest.rb

@@ -13,7 +13,7 @@ module Bibliothecary
               .sort_by(&:last)
               .map { |op, version| "#{op} #{version}" }
               .join(", "),
-            type: dep.type
+            type: dep.type,
           })
         end.uniq
       end

data/lib/bibliothecary/multi_parsers/cyclonedx.rb

@@ -1,11 +1,11 @@
-require 'json'
-require 'ox'
+require "json"
+require "ox"
 
 # packageurl-ruby uses pattern-matching (https://docs.ruby-lang.org/en/2.7.0/NEWS.html#label-Pattern+matching)
 # which warns a whole bunch in Ruby 2.7 as being an experimental feature, but has
 # been accepted in Ruby 3.0 (https://rubyreferences.github.io/rubychanges/3.0.html#pattern-matching).
 Warning[:experimental] = false
-require 'package_url'
+require "package_url"
 Warning[:experimental] = true
 
 module Bibliothecary
@@ -36,7 +36,7 @@ module Bibliothecary
           @manifests[mapping] << {
             name: self.class.full_name_for_purl(purl),
             requirement: purl.version,
-            type: 'lockfile'
+            type: "lockfile",
           }
         end
 
@@ -67,30 +67,29 @@ module Bibliothecary
 
           case purl.type
           when "maven"
-            parts.join(':')
+            parts.join(":")
           else
-            parts.join('/')
+            parts.join("/")
           end
         end
       end
 
       def self.mapping
         {
-          match_filename('cyclonedx.json') => {
-            kind: 'lockfile',
+          match_filename("cyclonedx.json") => {
+            kind: "lockfile",
             parser: :parse_cyclonedx_json,
-            ungroupable: true
+            ungroupable: true,
           },
-          match_filename('cyclonedx.xml') => {
-            kind: 'lockfile',
+          match_filename("cyclonedx.xml") => {
+            kind: "lockfile",
             parser: :parse_cyclonedx_xml,
-            ungroupable: true
-          }
+            ungroupable: true,
+          },
         }
       end
 
       def parse_cyclonedx_json(file_contents, options: {})
-        manifest = nil
 
         manifest = try_cache(options, options[:filename]) do
           JSON.parse(file_contents)
@@ -119,14 +118,14 @@ module Bibliothecary
           root = root.bom
         end
 
-        raise NoComponents unless root.locate('components').first
+        raise NoComponents unless root.locate("components").first
 
-        entries = ManifestEntries.new(parse_queue: root.locate('components/*'))
+        entries = ManifestEntries.new(parse_queue: root.locate("components/*"))
 
         entries.parse! do |component, parse_queue|
           # #locate returns an empty array if nothing is found, so we can
           # always safely concatenate it to the parse queue.
-          parse_queue.concat(component.locate('components/*'))
+          parse_queue.concat(component.locate("components/*"))
 
           component.locate("purl").first&.text
         end

data/lib/bibliothecary/multi_parsers/dependencies_csv.rb

@@ -1,4 +1,4 @@
-require 'csv'
+require "csv"
 
 module Bibliothecary
   module MultiParsers
@@ -8,11 +8,11 @@ module Bibliothecary
 
       def self.mapping
         {
-          match_filename('dependencies.csv') => {
-            kind: 'lockfile',
+          match_filename("dependencies.csv") => {
+            kind: "lockfile",
             ungroupable: true,
-            parser: :parse_dependencies_csv
-          }
+            parser: :parse_dependencies_csv,
+          },
         }
       end
 
@@ -29,20 +29,20 @@ module Bibliothecary
         HEADERS = {
           "platform" => {
             match: [
-              /^platform$/i
-            ]
+              /^platform$/i,
+            ],
           },
           "name" => {
             match: [
-              /^name$/i
-            ]
+              /^name$/i,
+            ],
           },
           # Lockfiles have exact versions.
           "lockfile_requirement" => {
             match: [
               /^(lockfile |)requirement$/i,
-              /^version$/i
-            ]
+              /^version$/i,
+            ],
           },
           # Manifests have versions that can have operators.
           # However, since Bibliothecary only currently supports analyzing a
@@ -52,16 +52,16 @@ module Bibliothecary
           "requirement" => {
             match: [
               /^(lockfile |)requirement$/i,
-              /^version$/i
-            ]
+              /^version$/i,
+            ],
           },
           "type" => {
             default: "runtime",
             match: [
               /^(lockfile |)type$/i,
-              /^(manifest |)type$/i
-            ]
-          }
+              /^(manifest |)type$/i,
+            ],
+          },
         }
 
         attr_reader :result

data/lib/bibliothecary/multi_parsers/json_runtime.rb

@@ -2,12 +2,12 @@ module Bibliothecary
   module MultiParsers
     # Provide JSON Runtime Manifest parsing
     module JSONRuntime
-      def parse_json_runtime_manifest(file_contents, options: {})
-        JSON.parse(file_contents).fetch('dependencies',[]).map do |name, requirement|
+      def parse_json_runtime_manifest(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
+        JSON.parse(file_contents).fetch("dependencies",[]).map do |name, requirement|
           {
             name: name,
             requirement: requirement,
-            type: 'runtime'
+            type: "runtime",
           }
         end
       end

data/lib/bibliothecary/multi_parsers/spdx.rb

@@ -2,7 +2,7 @@
 # which warns a whole bunch in Ruby 2.7 as being an experimental feature, but has
 # been accepted in Ruby 3.0 (https://rubyreferences.github.io/rubychanges/3.0.html#pattern-matching).
 Warning[:experimental] = false
-require 'package_url'
+require "package_url"
 Warning[:experimental] = true
 
 module Bibliothecary
@@ -12,27 +12,27 @@ module Bibliothecary
       include Bibliothecary::Analyser::TryCache
 
       # e.g. 'SomeText:' (allowing for leading whitespace)
-      WELLFORMED_LINE_REGEX = /^\s*[a-zA-Z]+:/
+      WELLFORMED_LINE_REGEXP = /^\s*[a-zA-Z]+:/
 
       # e.g. 'PackageName: (allowing for excessive whitespace)
-      PACKAGE_NAME_REGEX = /^\s*PackageName:\s*(.*)/
+      PACKAGE_NAME_REGEXP = /^\s*PackageName:\s*(.*)/
 
       # e.g. 'PackageVersion:' (allowing for excessive whitespace)
-      PACKAGE_VERSION_REGEX =/^\s*PackageVersion:\s*(.*)/
+      PACKAGE_VERSION_REGEXP =/^\s*PackageVersion:\s*(.*)/
 
       # e.g. "ExternalRef: PACKAGE-MANAGER purl (allowing for excessive whitespace)
-      PURL_REGEX = /^\s*ExternalRef:\s*PACKAGE[-|_]MANAGER\s*purl\s*(.*)/
+      PURL_REGEXP = /^\s*ExternalRef:\s*PACKAGE[-|_]MANAGER\s*purl\s*(.*)/
 
       NoEntries = Class.new(StandardError)
       MalformedFile = Class.new(StandardError)
 
       def self.mapping
         {
-          match_extension('.spdx') => {
-            kind: 'lockfile',
+          match_extension(".spdx") => {
+            kind: "lockfile",
             parser: :parse_spdx_tag_value,
-            ungroupable: true
-          }
+            ungroupable: true,
+          },
         }
       end
 
@@ -64,13 +64,13 @@ module Bibliothecary
 
           next if skip_line?(stripped_line)
 
-          raise MalformedFile unless stripped_line.match(WELLFORMED_LINE_REGEX)
+          raise MalformedFile unless stripped_line.match(WELLFORMED_LINE_REGEXP)
 
-          if (match = stripped_line.match(PACKAGE_NAME_REGEX))
+          if (match = stripped_line.match(PACKAGE_NAME_REGEXP))
             package_name = match[1]
-          elsif (match = stripped_line.match(PACKAGE_VERSION_REGEX))
+          elsif (match = stripped_line.match(PACKAGE_VERSION_REGEXP))
             package_version = match[1]
-          elsif (match = stripped_line.match(PURL_REGEX))
+          elsif (match = stripped_line.match(PURL_REGEXP))
             platform ||= get_platform(match[1])
           end
 
@@ -79,7 +79,7 @@ module Bibliothecary
             entries[platform.to_sym] << {
               name: package_name,
               requirement: package_version,
-              type: 'lockfile'
+              type: "lockfile",
             }
 
             package_name = package_version = platform = nil

data/lib/bibliothecary/parsers/bower.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 module Bibliothecary
   module Parsers
@@ -8,18 +8,18 @@ module Bibliothecary
       def self.mapping
         {
           match_filename("bower.json") => {
-            kind: 'manifest',
-            parser: :parse_manifest
-          }
+            kind: "manifest",
+            parser: :parse_manifest,
+          },
         }
       end
 
       add_multi_parser(Bibliothecary::MultiParsers::DependenciesCSV)
 
-      def self.parse_manifest(file_contents, options: {})
+      def self.parse_manifest(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
         json = JSON.parse(file_contents)
-        map_dependencies(json, 'dependencies', 'runtime') +
-        map_dependencies(json, 'devDependencies', 'development')
+        map_dependencies(json, "dependencies", "runtime") +
+        map_dependencies(json, "devDependencies", "development")
       end
     end
   end

data/lib/bibliothecary/parsers/cargo.rb

@@ -6,13 +6,13 @@ module Bibliothecary
       def self.mapping
         {
           match_filename("Cargo.toml") => {
-            kind: 'manifest',
-            parser: :parse_manifest
+            kind: "manifest",
+            parser: :parse_manifest,
           },
           match_filename("Cargo.lock") => {
-            kind: 'lockfile',
-            parser: :parse_lockfile
-          }
+            kind: "lockfile",
+            parser: :parse_lockfile,
+          },
         }
       end
 
@@ -20,20 +20,20 @@ module Bibliothecary
       add_multi_parser(Bibliothecary::MultiParsers::Spdx)
       add_multi_parser(Bibliothecary::MultiParsers::DependenciesCSV)
 
-      def self.parse_manifest(file_contents, options: {})
+      def self.parse_manifest(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
         manifest = Tomlrb.parse(file_contents)
 
         parsed_dependencies = []
 
-        manifest.fetch_values('dependencies', 'dev-dependencies').each_with_index do |deps, index|
+        manifest.fetch_values("dependencies", "dev-dependencies").each_with_index do |deps, index|
           parsed_dependencies << deps.map do |name, requirement|
             if requirement.respond_to?(:fetch)
-              requirement = requirement['version'] or next
+              requirement = requirement["version"] or next
             end
             {
               name: name,
               requirement: requirement,
-              type: index.zero? ? 'runtime' : 'development'
+              type: index.zero? ? "runtime" : "development",
             }
           end
         end
@@ -41,14 +41,14 @@ module Bibliothecary
         parsed_dependencies.flatten.compact
       end
 
-      def self.parse_lockfile(file_contents, options: {})
+      def self.parse_lockfile(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
         manifest = Tomlrb.parse(file_contents)
-        manifest.fetch('package',[]).map do |dependency|
-          next if not dependency['source'] or not dependency['source'].start_with?('registry+')
+        manifest.fetch("package",[]).map do |dependency|
+          next if not dependency["source"] or not dependency["source"].start_with?("registry+")
           {
-            name: dependency['name'],
-            requirement: dependency['version'],
-            type: 'runtime'
+            name: dependency["name"],
+            requirement: dependency["version"],
+            type: "runtime",
           }
         end
           .compact

data/lib/bibliothecary/parsers/carthage.rb

@@ -6,32 +6,32 @@ module Bibliothecary
       def self.mapping
         {
           match_filename("Cartfile") => {
-            kind: 'manifest',
-            parser: :parse_cartfile
+            kind: "manifest",
+            parser: :parse_cartfile,
           },
           match_filename("Cartfile.private") => {
-            kind: 'manifest',
-            parser: :parse_cartfile_private
+            kind: "manifest",
+            parser: :parse_cartfile_private,
           },
           match_filename("Cartfile.resolved") => {
-            kind: 'lockfile',
-            parser: :parse_cartfile_resolved
-          }
+            kind: "lockfile",
+            parser: :parse_cartfile_resolved,
+          },
         }
       end
 
       add_multi_parser(Bibliothecary::MultiParsers::DependenciesCSV)
 
-      def self.parse_cartfile(file_contents, options: {})
-        map_dependencies(file_contents, 'cartfile')
+      def self.parse_cartfile(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
+        map_dependencies(file_contents, "cartfile")
       end
 
-      def self.parse_cartfile_private(file_contents, options: {})
-        map_dependencies(file_contents, 'cartfile.private')
+      def self.parse_cartfile_private(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
+        map_dependencies(file_contents, "cartfile.private")
       end
 
-      def self.parse_cartfile_resolved(file_contents, options: {})
-        map_dependencies(file_contents, 'cartfile.resolved')
+      def self.parse_cartfile_resolved(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
+        map_dependencies(file_contents, "cartfile.resolved")
       end
 
       def self.map_dependencies(manifest, path)
@@ -41,9 +41,9 @@ module Bibliothecary
 
         json.map do |dependency|
           {
-            name: dependency['name'],
-            requirement: dependency['version'],
-            type: dependency["type"]
+            name: dependency["name"],
+            requirement: dependency["version"],
+            type: dependency["type"],
           }
         end
       end

data/lib/bibliothecary/parsers/clojars.rb

@@ -1,5 +1,5 @@
-require 'json'
-require 'typhoeus'
+require "json"
+require "typhoeus"
 
 module Bibliothecary
   module Parsers
@@ -9,15 +9,15 @@ module Bibliothecary
       def self.mapping
         {
           match_filename("project.clj") => {
-            kind: 'manifest',
-            parser: :parse_manifest
-          }
+            kind: "manifest",
+            parser: :parse_manifest,
+          },
         }
       end
 
       add_multi_parser(Bibliothecary::MultiParsers::DependenciesCSV)
 
-      def self.parse_manifest(file_contents, options: {})
+      def self.parse_manifest(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
         response = Typhoeus.post("#{Bibliothecary.configuration.clojars_parser_host}/project.clj", body: file_contents)
         raise Bibliothecary::RemoteParsingError.new("Http Error #{response.response_code} when contacting: #{Bibliothecary.configuration.clojars_parser_host}/project.clj", response.response_code) unless response.success?
         json = JSON.parse response.body
@@ -29,7 +29,7 @@ module Bibliothecary
           {
             name: dependency[0],
             requirement: dependency[1],
-            type: "runtime"
+            type: "runtime",
           }
         end
       end