bibliothecary 6.4.0 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35f76a25c41ad5a990e6c6232536f768015703be873a63c852d70369e3ae9295
-  data.tar.gz: 7faa006c8ff306dc560d57324cf9ad8d5798030aab058bb7d513b3a834c9ecc4
+  metadata.gz: 34c770ef3ea9fb2cc8cb2a360871f67c2ad1b7007d92644558df16f975d70a2f
+  data.tar.gz: bf68d3358b128c107266c2c3d27b9e78578cf669731d54fb7511aeda7048d76b
 SHA512:
-  metadata.gz: ecc552df23a5489aa6b430e2626f48b8600032a74a1a8c8f522c3ef9d9b9e39a7e1646d61651374bd50dc26f75ec5c905e638c29c9c7a7ab9670b5adc8792d57
-  data.tar.gz: 1a1e7a14eb4e1a75899d3ac319d98367eb9b883d23ea63f312a2405e1076a7d5702fbb35b0755ae864eea2a065fede8ed74749a5a31d7bff31effa835aff60ad
+  metadata.gz: 86c784d59fae0d7096d10066dc270017b8eb8acece490d124eef7c64fa31367f50bbc069f56f62b49bb89703b90af30412a3baccc56cce624f885752f28a932d
+  data.tar.gz: 53cfeccce209501b909f9b132971ca80226b7b1ea34f20a3a5334c803c5ad53979c536aac10a7696bea82e2a7a96846b44a997da4b020c463e0e941fb9c3a764

data/.rubocop.yml

@@ -94,16 +94,6 @@ Lint/HandleExceptions:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions'
   Enabled: true
 
-Lint/InvalidCharacterLiteral:
-  Description: >-
-                 Checks for invalid character literals with a non-escaped
-                 whitespace character.
-  Enabled: true
-
-Lint/LiteralInCondition:
-  Description: 'Checks of literals used in conditions.'
-  Enabled: true
-
 Lint/LiteralInInterpolation:
   Description: 'Checks for literals used in interpolation.'
   Enabled: true
@@ -157,13 +147,6 @@ Lint/UnderscorePrefixedVariableName:
   Description: 'Do not use prefix `_` for a variable that is used.'
   Enabled: true
 
-Lint/UnneededDisable:
-  Description: >-
-                 Checks for rubocop:disable comments that can be removed.
-                 Note: this cop is not disabled when disabling all cops.
-                 It must be explicitly disabled.
-  Enabled: true
-
 Lint/UnusedBlockArgument:
   Description: 'Checks for unused block arguments.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
@@ -257,62 +240,6 @@ Metrics/PerceivedComplexity:
                  human reader.
   Enabled: false
 
-##################### Performance #############################
-
-Performance/Count:
-  Description: >-
-                  Use `count` instead of `select...size`, `reject...size`,
-                  `select...count`, `reject...count`, `select...length`,
-                  and `reject...length`.
-  Enabled: true
-
-Performance/Detect:
-  Description: >-
-                  Use `detect` instead of `select.first`, `find_all.first`,
-                  `select.last`, and `find_all.last`.
-  Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerabledetect-vs-enumerableselectfirst-code'
-  Enabled: true
-
-Performance/FlatMap:
-  Description: >-
-                  Use `Enumerable#flat_map`
-                  instead of `Enumerable#map...Array#flatten(1)`
-                  or `Enumberable#collect..Array#flatten(1)`
-  Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablemaparrayflatten-vs-enumerableflat_map-code'
-  Enabled: true
-  EnabledForFlattenWithoutParams: false
-  # If enabled, this cop will warn about usages of
-  # `flatten` being called without any parameters.
-  # This can be dangerous since `flat_map` will only flatten 1 level, and
-  # `flatten` without any parameters can flatten multiple levels.
-
-Performance/ReverseEach:
-  Description: 'Use `reverse_each` instead of `reverse.each`.'
-  Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablereverseeach-vs-enumerablereverse_each-code'
-  Enabled: true
-
-Performance/Sample:
-  Description: >-
-                  Use `sample` instead of `shuffle.first`,
-                  `shuffle.last`, and `shuffle[Fixnum]`.
-  Reference: 'https://github.com/JuanitoFatas/fast-ruby#arrayshufflefirst-vs-arraysample-code'
-  Enabled: true
-
-Performance/Size:
-  Description: >-
-                  Use `size` instead of `count` for counting
-                  the number of elements in `Array` and `Hash`.
-  Reference: 'https://github.com/JuanitoFatas/fast-ruby#arraycount-vs-arraysize-code'
-  Enabled: true
-
-Performance/StringReplacement:
-  Description: >-
-                  Use `tr` instead of `gsub` when you are replacing the same
-                  number of characters. Use `delete` instead of `gsub` when
-                  you are deleting characters.
-  Reference: 'https://github.com/JuanitoFatas/fast-ruby#stringgsub-vs-stringtr-code'
-  Enabled: true
-
 ##################### Rails ##################################
 
 Rails/ActionFilter:
@@ -622,11 +549,11 @@ Style/InitialIndentation:
     Checks the indentation of the first non-blank non-comment line in a file.
   Enabled: false
 
-Style/FirstParameterIndentation:
+Layout/IndentFirstParameter:
   Description: 'Checks the indentation of the first parameter in a method call.'
   Enabled: false
 
-Style/FlipFlop:
+Lint/FlipFlop:
   Description: 'Checks for flip flops'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-flip-flops'
   Enabled: false
@@ -680,13 +607,13 @@ Style/IndentationWidth:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-indentation'
   Enabled: false
 
-Style/IndentArray:
+Layout/IndentFirstArrayElement:
   Description: >-
                  Checks the indentation of the first element in an array
                  literal.
   Enabled: false
 
-Style/IndentHash:
+Layout/IndentFirstHashElement:
   Description: 'Checks the indentation of the first key in a hash literal.'
   Enabled: false
 
@@ -716,10 +643,11 @@ Style/LineEndConcatenation:
                  line end.
   Enabled: false
 
-Style/MethodCallParentheses:
+Style/MethodCallWithoutArgsParentheses:
   Description: 'Do not use parentheses for method calls with no arguments.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-args-no-parens'
-  Enabled: false
+  StyleGuide: '#method-invocation-parens'
+  Enabled: true
+  IgnoredMethods: []
 
 Style/MethodDefParentheses:
   Description: >-
@@ -816,10 +744,10 @@ Style/OneLineConditional:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#ternary-operator'
   Enabled: false
 
-Style/OpMethod:
+Naming/BinaryOperatorParameterName:
   Description: 'When defining binary operators, name the argument other.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#other-arg'
-  Enabled: false
+  StyleGuide: '#other-arg'
+  Enabled: true
 
 Style/OptionalArguments:
   Description: >-
@@ -1015,7 +943,7 @@ Style/SpaceAroundOperators:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators'
   Enabled: false
 
-Style/SpaceInsideBrackets:
+Layout/SpaceInsideBrackets:
   Description: 'No spaces after [ or before ].'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-spaces-braces'
   Enabled: false
@@ -1084,10 +1012,14 @@ Style/TrailingCommaInArguments:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
   Enabled: false
 
-Style/TrailingCommaInLiteral:
-  Description: 'Checks for trailing comma in literals.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
-  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: '#no-trailing-array-commas'
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  Enabled: true
 
 Style/TrailingWhitespace:
   Description: 'Avoid trailing whitespace.'

data/lib/bibliothecary.rb

@@ -4,6 +4,7 @@ require "bibliothecary/configuration"
 require "bibliothecary/runner"
 require "bibliothecary/exceptions"
 require "bibliothecary/file_info"
+require "bibliothecary/related_files_info"
 require "find"
 
 Dir[File.expand_path('../bibliothecary/parsers/*.rb', __FILE__)].each do |file|
@@ -40,6 +41,10 @@ module Bibliothecary
     runner.package_managers
   end
 
+  def self.find_manifests(path)
+    runner.find_manifests(path)
+  end
+
   def self.ignored_dirs
     configuration.ignored_dirs
   end

data/lib/bibliothecary/analyser.rb

@@ -41,26 +41,24 @@ module Bibliothecary
       end
 
       def parse_file(filename, contents)
-        mapping.each do |matcher, details|
-          if mapping_entry_match?(matcher, details, FileInfo.new(nil, filename, contents))
-            begin
-              # The `parser` method should raise an exception if the file is malformed,
-              # should return empty [] if the file is fine but simply doesn't contain
-              # any dependencies, and should never return nil. At the time of writing
-              # this comment, some of the parsers return [] or nil to mean an error
-              # which is confusing to users.
-              return send(details[:parser], contents)
-            rescue Exception => e # default is StandardError but C bindings throw Exceptions
-              # the C xml parser also puts a newline at the end of the message
-              raise Bibliothecary::FileParsingError.new(e.message.strip, filename)
-            end
-          end
-        end
+        details = first_matching_mapping_details(FileInfo.new(nil, filename, contents))
+
         # this can be raised if we don't check match?/match_info?,
         # OR don't have the file contents when we check them, so
         # it turns out for example that a .xml file isn't a
         # manifest after all.
-        raise Bibliothecary::FileParsingError.new("No parser for this file type", filename)
+        raise Bibliothecary::FileParsingError.new("No parser for this file type", filename) unless details[:parser]
+
+        # The `parser` method should raise an exception if the file is malformed,
+        # should return empty [] if the file is fine but simply doesn't contain
+        # any dependencies, and should never return nil. At the time of writing
+        # this comment, some of the parsers return [] or nil to mean an error
+        # which is confusing to users.
+        send(details[:parser], contents)
+
+      rescue Exception => e # default is StandardError but C bindings throw Exceptions
+        # the C xml parser also puts a newline at the end of the message
+        raise Bibliothecary::FileParsingError.new(e.message.strip, filename)
       end
 
       # this is broken with contents=nil because it can't look at file
@@ -73,9 +71,7 @@ module Bibliothecary
       end
 
       def match_info?(info)
-        mapping.any? do |matcher, details|
-          mapping_entry_match?(matcher, details, info)
-        end
+        first_matching_mapping_details(info).any?
       end
 
       def platform_name
@@ -102,64 +98,18 @@ module Bibliothecary
         end
       end
 
-      def set_related_paths_field(by_dirname_dest, by_dirname_source)
-        by_dirname_dest.each do |dirname, analyses|
-          analyses.each do |(info, analysis)|
-            source_analyses = by_dirname_source[dirname].map { |(info, source_analysis)| info.relative_path }
-            analysis[:related_paths] = source_analyses.sort
-          end
-        end
-      end
-
-      def add_related_paths(analyses)
-        analyses.each do |(info, analysis)|
-          analysis[:related_paths] = []
-        end
-
-        # associate manifests and lockfiles in the same directory;
-
-        # note that right now we're in the context of a single
-        # package manager, so manifest and lockfile in the
-        # same directory is considered proof that they are
-        # matched.
-
-        by_dirname = {
-          "manifest" => Hash.new { |h, k| h[k] = [] },
-          "lockfile" => Hash.new { |h, k| h[k] = [] }
-        }
-
-        analyses.each do |(info, analysis)|
-          dirname = File.dirname(info.relative_path)
-          by_dirname[analysis[:kind]][dirname].push([info, analysis])
-        end
-
-        by_dirname["manifest"].each do |_, manifests|
-          # This determine_can_have_lockfile in theory needs the file contents but
-          # in practice doesn't right now since the only mapping that needs
-          # file contents is a lockfile and not a manifest so won't reach here.
-          manifests.delete_if { |(info, manifest)| !determine_can_have_lockfile_from_info(info) }
-        end
-
-        set_related_paths_field(by_dirname["manifest"], by_dirname["lockfile"])
-        set_related_paths_field(by_dirname["lockfile"], by_dirname["manifest"])
-      end
-
       def analyse(folder_path, file_list)
         analyse_file_info(file_list.map { |full_path| FileInfo.new(folder_path, full_path) })
       end
 
       def analyse_file_info(file_info_list)
-        analyses = file_info_list.map do |info|
-          next unless match_info?(info)
-          [info, analyse_contents_from_info(info)]
-        end
-
-        # strip the ones we failed to analyse
-        analyses = analyses.reject { |(info, analysis)| analysis.nil? }
+        matching_info = file_info_list
+          .select(&method(:match_info?))
 
-        add_related_paths(analyses)
-
-        analyses.map { |(info, analysis)| analysis }
+        matching_info.map do |info|
+          analyse_contents_from_info(info)
+            .merge(related_paths: related_paths(info, matching_info))
+        end
       end
 
       def analyse_contents(filename, contents)
@@ -182,12 +132,8 @@ module Bibliothecary
       end
 
       def determine_kind_from_info(info)
-        mapping.each do |matcher, details|
-          if mapping_entry_match?(matcher, details, info)
-            return details[:kind]
-          end
-        end
-        return nil
+        first_matching_mapping_details(info)
+          .fetch(:kind, nil)
       end
 
       # calling this with contents=nil can produce less-informed
@@ -197,12 +143,8 @@ module Bibliothecary
       end
 
       def determine_can_have_lockfile_from_info(info)
-        mapping.each do |matcher, details|
-          if mapping_entry_match?(matcher, details, info)
-            return details.fetch(:can_have_lockfile, true)
-          end
-        end
-        return true
+        first_matching_mapping_details(info)
+          .fetch(:can_have_lockfile, true)
       end
 
       def parse_ruby_manifest(manifest)
@@ -242,6 +184,31 @@ module Bibliothecary
           lambda { |path| path.end_with?(filename) }
         end
       end
+
+      private
+
+      def related_paths(info, infos)
+        return [] unless determine_can_have_lockfile_from_info(info)
+
+        kind = determine_kind_from_info(info)
+        relate_to_kind = first_matching_mapping_details(info)
+          .fetch(:related_to, %w(manifest lockfile).reject { |k| k == kind })
+        dirname = File.dirname(info.relative_path)
+
+        infos
+          .reject { |i| i == info }
+          .select { |i| relate_to_kind.include?(determine_kind_from_info(i)) }
+          .select { |i| File.dirname(i.relative_path) == dirname }
+          .select(&method(:determine_can_have_lockfile_from_info))
+          .map(&:relative_path)
+          .sort
+      end
+
+      def first_matching_mapping_details(info)
+        mapping
+          .find { |matcher, details| mapping_entry_match?(matcher, details, info) }
+          &.last || {}
+      end
     end
   end
 end

data/lib/bibliothecary/parsers/go.rb

@@ -41,7 +41,7 @@ module Bibliothecary
           match_filename("Gopkg.lock") => {
             kind: 'lockfile',
             parser: :parse_dep_lockfile
-          },
+          }
         }
       end
 

data/lib/bibliothecary/parsers/hackage.rb

@@ -15,7 +15,7 @@ module Bibliothecary
           match_extension("cabal.config") => {
             kind: 'lockfile',
             parser: :parse_cabal_config
-          },
+          }
         }
       end
 

data/lib/bibliothecary/parsers/maven.rb

@@ -53,7 +53,7 @@ module Bibliothecary
         doc = Ox.parse file_contents
         root = doc&.locate("ivy-report")&.first
         return !root.nil?
-      rescue Exception => e
+      rescue Exception => e # rubocop:disable Lint/RescueException
         # We rescue exception here since native libs can throw a non-StandardError
         # We don't want to throw errors during the matching phase, only during
         # parsing after we match.
@@ -111,18 +111,17 @@ module Bibliothecary
 
       def self.parse_pom_manifest(file_contents)
         manifest = Ox.parse file_contents
-        if manifest.respond_to?('project')
-          xml = manifest.project
-        else
-          xml = manifest
-        end
-        return [] unless xml.respond_to?('dependencies')
-        xml.dependencies.locate('dependency').map do |dependency|
-          {
-            name: "#{extract_pom_dep_info(xml, dependency, 'groupId')}:#{extract_pom_dep_info(xml, dependency, 'artifactId')}",
-            requirement: extract_pom_dep_info(xml, dependency, 'version'),
-            type: extract_pom_dep_info(xml, dependency, 'scope') || 'runtime'
-          }
+        xml = manifest.respond_to?('project') ? manifest.project : manifest
+        [].tap do |deps|
+          ['dependencies/dependency', 'dependencyManagement/dependencies/dependency'].each do |deps_xpath|
+            xml.locate(deps_xpath).each do |dep|
+              deps.push({
+                name: "#{extract_pom_dep_info(xml, dep, 'groupId')}:#{extract_pom_dep_info(xml, dep, 'artifactId')}",
+                requirement: extract_pom_dep_info(xml, dep, 'version'),
+                type: extract_pom_dep_info(xml, dep, 'scope') || 'runtime'
+              })
+            end
+          end
         end
       end
 
@@ -148,6 +147,7 @@ module Bibliothecary
         value = field.nodes.first
         match = value.match(/^\$\{(.+)\}/)
         if match
+          return value unless xml.respond_to? 'properties'
           prop_field = xml.properties.locate(match[1]).first
           if prop_field
             return prop_field.nodes.first

data/lib/bibliothecary/parsers/rubygems.rb

@@ -12,16 +12,18 @@ module Bibliothecary
         {
           match_filenames("Gemfile", "gems.rb") => {
             kind: 'manifest',
-            parser: :parse_gemfile
+            parser: :parse_gemfile,
+            related_to: [ 'manifest', 'lockfile' ]
           },
           match_extension(".gemspec") => {
             kind: 'manifest',
             parser: :parse_gemspec,
-            can_have_lockfile: false
+            related_to: [ 'manifest', 'lockfile' ]
           },
           match_filenames("Gemfile.lock", "gems.locked") => {
             kind: 'lockfile',
-            parser: :parse_gemfile_lock
+            parser: :parse_gemfile_lock,
+            related_to: [ 'manifest', 'lockfile' ]
           }
         }
       end
@@ -49,8 +51,6 @@ module Bibliothecary
         manifest = Gemnasium::Parser.send(:gemspec, file_contents)
         parse_ruby_manifest(manifest)
       end
-
-
     end
   end
 end

data/lib/bibliothecary/related_files_info.rb

@@ -0,0 +1,28 @@
+module Bibliothecary
+  class RelatedFilesInfo
+    attr_reader :path
+    attr_reader :platform
+    attr_reader :manifests
+    attr_reader :lockfiles
+
+    def self.create_from_file_infos(file_infos)
+      returns = []
+      paths = file_infos.group_by { |info| File.dirname(info.relative_path) }
+      paths.values.each do |path|
+        same_pm = path.group_by { |info| info.package_manager}
+        same_pm.values.each do |value|
+          returns.append(RelatedFilesInfo.new(value))
+        end
+      end
+      returns
+    end
+
+    def initialize(file_infos)
+      package_manager = file_infos.first.package_manager
+      @platform = package_manager.platform_name
+      @path = Pathname.new(File.dirname(file_infos.first.relative_path)).cleanpath.to_path
+      @manifests = file_infos.select { |info| package_manager.determine_kind_from_info(info) == "manifest" }.map { |info| File.basename(info.relative_path) }
+      @lockfiles = file_infos.select { |info| package_manager.determine_kind_from_info(info) == "lockfile" }.map { |info| File.basename(info.relative_path) }
+    end
+  end
+end

data/lib/bibliothecary/runner.rb

@@ -61,6 +61,10 @@ module Bibliothecary
       file_list
     end
 
+    def find_manifests(path)
+        RelatedFilesInfo.create_from_file_infos(load_file_info_list(path).reject { |info| info.package_manager.nil? })
+    end
+
     def analyse_file(file_path, contents)
       package_managers.select { |pm| pm.match?(file_path, contents) }.map do |pm|
         pm.analyse_contents(file_path, contents)

data/lib/bibliothecary/version.rb

@@ -1,3 +1,3 @@
 module Bibliothecary
-  VERSION = "6.4.0"
+  VERSION = "6.6.0"
 end

data/lib/sdl_parser.rb

@@ -12,7 +12,7 @@ class SdlParser
       deps.push({
         name: dep.value,
         requirement: dep.attribute('version') || ">= 0",
-        type: type,
+        type: type
       })
     end.uniq
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bibliothecary
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.6.0
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml-rb
@@ -250,6 +250,7 @@ files:
 - lib/bibliothecary/parsers/rubygems.rb
 - lib/bibliothecary/parsers/shard.rb
 - lib/bibliothecary/parsers/swift_pm.rb
+- lib/bibliothecary/related_files_info.rb
 - lib/bibliothecary/runner.rb
 - lib/bibliothecary/version.rb
 - lib/sdl_parser.rb