dependabot-common 0.383.0 → 0.384.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fb1a4d6243812d664a20067d226c2eec111080d39e7337217744a58a9d8f0b6
-  data.tar.gz: 609737fc8b6040222a744d58ea03f8587fec15136cb835d319c31b798f7ebf32
+  metadata.gz: 4011821492cf0ae915acc4d9b0783f699f5522946eac07bbef8973e8692df1f9
+  data.tar.gz: 7502e7687e79b39ec94fad1c9318e1b40b7cdf7965c8c1818ebda3a7a914b8ee
 SHA512:
-  metadata.gz: 5e3042cb52f78e0396e75a3c6707a6706a1e2f4f1e12fc16310079eae0ae08336f688a75a92795cc6a8ba50ba62b9d0b9168b3ca4d5780439c7bccf574ab4179
-  data.tar.gz: a15d7f181d2d4afd8b5bf3e72f0450827d435f8e61e98f7863bfa0c254e8e2b983bb831901f1c95d27da8abfe791bf673d6c6e7fcc29b8d5e61c0e3c631ea9e6
+  metadata.gz: c5f9708f6197bf0fe6e6dd22b971e41522f7deb6af1963786276dd5246d3177741768e4065d437c4ad3906ff0d0d91afd10b41a0108c0e553a14be2ae1dfde5f
+  data.tar.gz: 1e9ebca6d67ec61d619f36e71cfd02cd92c1aca3d6701b47ff4a94c95f2abcdb05277de57902d4dea2b1d5bb6410cabbc027c81bb0e8884bbee84d31cd43e2f4

data/lib/dependabot/config/file.rb

@@ -102,33 +102,68 @@ module Dependabot
         T::Hash[String, String]
       )
 
-      sig { params(cfg: T.nilable(T::Hash[Symbol, T.untyped])).returns(T::Array[IgnoreCondition]) }
+      sig { params(cfg: T.nilable(T::Hash[Symbol, T.anything])).returns(T::Array[IgnoreCondition]) }
       def ignore_conditions(cfg)
-        ignores = cfg&.dig(:ignore) || []
-        ignores.map do |ic|
+        array_values(cfg&.dig(:ignore)).map do |raw|
+          ic = hash_values(raw)
           IgnoreCondition.new(
-            dependency_name: ic[:"dependency-name"],
-            versions: ic[:versions],
-            update_types: ic[:"update-types"]
+            dependency_name: T.must(string_value(ic[:"dependency-name"])),
+            versions: string_array(ic[:versions]),
+            update_types: string_array(ic[:"update-types"])
           )
         end
       end
 
       sig do
-        params(cfg: T.nilable(T::Hash[Symbol, T.untyped])).returns(UpdateConfig::CommitMessageOptions)
+        params(cfg: T.nilable(T::Hash[Symbol, T.anything])).returns(UpdateConfig::CommitMessageOptions)
       end
       def commit_message_options(cfg)
-        commit_message = cfg&.dig(:"commit-message") || {}
+        commit_message = hash_values(cfg&.dig(:"commit-message"))
+        prefix = string_value(commit_message[:prefix])
         UpdateConfig::CommitMessageOptions.new(
-          prefix: commit_message[:prefix],
-          prefix_development: commit_message[:"prefix-development"] || commit_message[:prefix],
-          include: commit_message[:include]
+          prefix: prefix,
+          prefix_development: string_value(commit_message[:"prefix-development"]) || prefix,
+          include: string_value(commit_message[:include])
         )
       end
 
-      sig { params(cfg: T.nilable(T::Hash[Symbol, T.untyped])).returns(T::Array[String]) }
+      sig { params(cfg: T.nilable(T::Hash[Symbol, T.anything])).returns(T::Array[String]) }
       def exclude_paths(cfg)
-        Array(cfg&.dig(:"exclude-paths") || [])
+        string_array(cfg&.dig(:"exclude-paths")) || []
+      end
+
+      # The methods below narrow the loosely typed, parsed-YAML config values
+      # (Symbol-keyed hashes whose values are arbitrary) into the specific
+      # types the config objects expect.
+
+      sig { params(value: T.anything).returns(T.nilable(String)) }
+      def string_value(value)
+        case value
+        when String then value
+        end
+      end
+
+      sig { params(value: T.anything).returns(T::Hash[Symbol, T.anything]) }
+      def hash_values(value)
+        case value
+        when Hash then value
+        else {}
+        end
+      end
+
+      sig { params(value: T.anything).returns(T::Array[T.anything]) }
+      def array_values(value)
+        case value
+        when Array then value
+        else []
+        end
+      end
+
+      sig { params(value: T.anything).returns(T.nilable(T::Array[String])) }
+      def string_array(value)
+        case value
+        when Array then value.map(&:to_s)
+        end
       end
     end
   end

data/lib/dependabot/config/ignore_condition.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: strong
 # frozen_string_literal: true
 
 require "sorbet-runtime"

data/lib/dependabot/package/package_latest_version_finder.rb

@@ -1,7 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "cgi"
 require "excon"
 require "nokogiri"
 require "sorbet-runtime"

data/lib/dependabot/pull_request_creator/commit_message_options.rb

@@ -0,0 +1,70 @@
+# typed: strong
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+module Dependabot
+  class PullRequestCreator
+    # Typed view over the `commit_message_options` hash threaded into the PR
+    # creator's title and prefix builders. The raw options arrive as a loosely
+    # typed hash sourced from user config, so this parses the known keys once at
+    # the boundary and lets downstream builders use typed readers instead of
+    # digging an untyped hash.
+    class CommitMessageOptions
+      extend T::Sig
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :prefix
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :prefix_development
+
+      sig { returns(T::Boolean) }
+      attr_reader :include_scope
+
+      sig do
+        params(
+          prefix: T.nilable(String),
+          prefix_development: T.nilable(String),
+          include_scope: T::Boolean
+        ).void
+      end
+      def initialize(prefix: nil, prefix_development: nil, include_scope: false)
+        @prefix = prefix
+        @prefix_development = prefix_development
+        @include_scope = include_scope
+      end
+
+      # Parses a raw options hash. Unknown keys are ignored, and absent or
+      # non-string prefixes become nil.
+      sig { params(options: T::Hash[Symbol, T.anything]).returns(CommitMessageOptions) }
+      def self.from_hash(options)
+        new(
+          prefix: coerce_string(options[:prefix]),
+          prefix_development: coerce_string(options[:prefix_development]),
+          include_scope: options[:include_scope] ? true : false
+        )
+      end
+
+      sig { params(value: T.anything).returns(T.nilable(String)) }
+      def self.coerce_string(value)
+        case value
+        when String then value
+        end
+      end
+      private_class_method :coerce_string
+
+      # True when an explicit (non-nil) prefix was provided.
+      sig { returns(T::Boolean) }
+      def prefix?
+        !prefix.nil?
+      end
+
+      # True when an explicit (non-nil) development prefix was provided.
+      sig { returns(T::Boolean) }
+      def prefix_development?
+        !prefix_development.nil?
+      end
+    end
+  end
+end

data/lib/dependabot/pull_request_creator/message_builder/metadata_presenter.rb

@@ -247,7 +247,7 @@ module Dependabot
           end
         end
 
-        sig { params(details: T::Hash[String, T.untyped]).returns(String) }
+        sig { params(details: T::Hash[String, T.anything]).returns(String) }
         def vulnerability_version_range_lines(details)
           msg = ""
           %w(
@@ -256,9 +256,12 @@ module Dependabot
             affected_versions
           ).each do |tp|
             type = T.must(tp.split("_").first).capitalize
-            next unless details[tp]
+            versions = case (value = details[tp])
+                       when Array then value
+                       end
+            next unless versions
 
-            versions_string = details[tp].any? ? details[tp].join("; ") : "none"
+            versions_string = versions.any? ? versions.join("; ") : "none"
             versions_string = versions_string.gsub(/(?<!\\)~/, '\~')
             msg += "> #{type} versions: #{versions_string}\n"
           end

data/lib/dependabot/pull_request_creator/message_builder/title_builder.rb

@@ -1,9 +1,10 @@
-# typed: strict
+# typed: strong
 # frozen_string_literal: true
 
 require "sorbet-runtime"
 require "dependabot/dependency"
 require "dependabot/logger"
+require "dependabot/pull_request_creator/commit_message_options"
 require "dependabot/pull_request_creator/pr_name_prefixer"
 
 module Dependabot
@@ -25,7 +26,7 @@ module Dependabot
         sig { returns(T.nilable(Dependabot::PullRequestCreator::PrNamePrefixer)) }
         attr_reader :prefixer
 
-        sig { returns(T.nilable(T::Hash[Symbol, T.untyped])) }
+        sig { returns(T.nilable(CommitMessageOptions)) }
         attr_reader :commit_message_options
 
         sig { returns(T.nilable(T::Array[Dependabot::Dependency])) }
@@ -35,14 +36,17 @@ module Dependabot
           params(
             base_title: String,
             prefixer: T.nilable(Dependabot::PullRequestCreator::PrNamePrefixer),
-            commit_message_options: T.nilable(T::Hash[Symbol, T.untyped]),
+            commit_message_options: T.nilable(T::Hash[Symbol, T.anything]),
             dependencies: T.nilable(T::Array[Dependabot::Dependency])
           ).void
         end
         def initialize(base_title:, prefixer: nil, commit_message_options: nil, dependencies: nil)
           @base_title = base_title
           @prefixer = prefixer
-          @commit_message_options = commit_message_options
+          @commit_message_options = T.let(
+            commit_message_options && CommitMessageOptions.from_hash(commit_message_options),
+            T.nilable(CommitMessageOptions)
+          )
           @dependencies = dependencies
         end
 
@@ -85,12 +89,12 @@ module Dependabot
         # but without requiring source/credentials.
         sig { returns(String) }
         def build_explicit_prefix
-          return "" unless commit_message_options&.key?(:prefix)
+          return "" unless commit_message_options&.prefix?
 
           prefix = explicit_prefix_string
           return "" if prefix.empty?
 
-          prefix += "(#{scope})" if commit_message_options&.dig(:include_scope)
+          prefix += "(#{scope})" if commit_message_options&.include_scope
           # Append colon after alphanumeric or closing bracket to follow
           # conventional commit format (e.g., "chore: ..." or "fix(deps): ...")
           prefix += ":" if prefix.match?(/[A-Za-z0-9\)\]]\Z/)
@@ -101,11 +105,11 @@ module Dependabot
         sig { returns(String) }
         def explicit_prefix_string
           if production_dependencies?
-            commit_message_options&.dig(:prefix).to_s
-          elsif commit_message_options&.key?(:prefix_development)
-            commit_message_options&.dig(:prefix_development).to_s
+            commit_message_options&.prefix.to_s
+          elsif commit_message_options&.prefix_development?
+            commit_message_options&.prefix_development.to_s
           else
-            commit_message_options&.dig(:prefix).to_s
+            commit_message_options&.prefix.to_s
           end
         end
 

data/lib/dependabot/pull_request_creator/pr_name_prefixer.rb

@@ -9,6 +9,7 @@ require "dependabot/clients/codecommit"
 require "dependabot/clients/github_with_retries"
 require "dependabot/clients/gitlab_with_retries"
 require "dependabot/pull_request_creator"
+require "dependabot/pull_request_creator/commit_message_options"
 
 module Dependabot
   class PullRequestCreator
@@ -39,7 +40,7 @@ module Dependabot
           dependencies: T::Array[Dependency],
           credentials: T::Array[Dependabot::Credential],
           security_fix: T::Boolean,
-          commit_message_options: T.nilable(T::Hash[Symbol, T.untyped])
+          commit_message_options: T.nilable(T::Hash[Symbol, T.anything])
         )
           .void
       end
@@ -54,7 +55,10 @@ module Dependabot
         @source                 = source
         @credentials            = credentials
         @security_fix           = security_fix
-        @commit_message_options = commit_message_options
+        @commit_message_options = T.let(
+          commit_message_options && CommitMessageOptions.from_hash(commit_message_options),
+          T.nilable(CommitMessageOptions)
+        )
       end
 
       sig { returns(String) }
@@ -85,7 +89,7 @@ module Dependabot
       sig { returns(T::Array[Dependabot::Credential]) }
       attr_reader :credentials
 
-      sig { returns(T.nilable(T::Hash[Symbol, T.untyped])) }
+      sig { returns(T.nilable(CommitMessageOptions)) }
       attr_reader :commit_message_options
 
       sig { returns(T::Boolean) }
@@ -96,7 +100,7 @@ module Dependabot
       sig { returns(T.nilable(String)) }
       def commit_prefix
         # If a preferred prefix has been explicitly provided, use it
-        return prefix_from_explicitly_provided_details if commit_message_options&.key?(:prefix)
+        return prefix_from_explicitly_provided_details if commit_message_options&.prefix?
 
         # Otherwise, if there is a previous Dependabot commit and it used a
         # known style, use that as our model for subsequent commits
@@ -112,7 +116,7 @@ module Dependabot
         prefix = explicitly_provided_prefix_string
         return if prefix.empty?
 
-        prefix += "(#{scope})" if commit_message_options&.dig(:include_scope)
+        prefix += "(#{scope})" if commit_message_options&.include_scope
         prefix += ":" if prefix.match?(/[A-Za-z0-9\)\]]\Z/)
         prefix += " " unless prefix.end_with?(" ")
         prefix
@@ -121,14 +125,14 @@ module Dependabot
       # rubocop:disable Metrics/PerceivedComplexity
       sig { returns(String) }
       def explicitly_provided_prefix_string
-        raise "No explicitly provided prefix!" unless commit_message_options&.key?(:prefix)
+        raise "No explicitly provided prefix!" unless commit_message_options&.prefix?
 
         if dependencies.any?(&:production?)
-          commit_message_options&.dig(:prefix).to_s
-        elsif commit_message_options&.key?(:prefix_development)
-          commit_message_options&.dig(:prefix_development).to_s
+          commit_message_options&.prefix.to_s
+        elsif commit_message_options&.prefix_development?
+          commit_message_options&.prefix_development.to_s
         else
-          commit_message_options&.dig(:prefix).to_s
+          commit_message_options&.prefix.to_s
         end
       end
       # rubocop:enable Metrics/PerceivedComplexity

data/lib/dependabot/version.rb

@@ -32,6 +32,19 @@ module Dependabot
       version.to_s.match?(ANCHORED_VERSION_PATTERN)
     end
 
+    # RubyGems 4 eagerly computes a numeric sort key in Gem::Version#initialize and
+    # skips it for prereleases. Dependabot's subclasses override #prerelease? with
+    # ecosystem-specific semantics, so a version with alphabetic segments (e.g.
+    # "1.0.0.RELEASE" or "2.0.0.post1") can report prerelease? == false and reach
+    # RubyGems' radix comparison, which raises when a segment is a String. Returning
+    # nil for those versions falls back to the segment-by-segment comparison.
+    sig { override.overridable.returns(T.nilable(Integer)) }
+    def compute_sort_key
+      return if canonical_segments.any?(String)
+
+      super
+    end
+
     sig { overridable.returns(String) }
     def to_semver
       @original_version

data/lib/dependabot.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Dependabot
-  VERSION = "0.383.0"
+  VERSION = "0.384.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dependabot-common
 version: !ruby/object:Gem::Version
-  version: 0.383.0
+  version: 0.384.0
 platform: ruby
 authors:
 - Dependabot
@@ -580,6 +580,7 @@ files:
 - lib/dependabot/pull_request_creator/branch_namer/multi_ecosystem_strategy.rb
 - lib/dependabot/pull_request_creator/branch_namer/solo_strategy.rb
 - lib/dependabot/pull_request_creator/codecommit.rb
+- lib/dependabot/pull_request_creator/commit_message_options.rb
 - lib/dependabot/pull_request_creator/commit_signer.rb
 - lib/dependabot/pull_request_creator/github.rb
 - lib/dependabot/pull_request_creator/gitlab.rb
@@ -620,7 +621,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/dependabot/dependabot-core/issues
-  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.383.0
+  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.384.0
 rdoc_options: []
 require_paths:
 - lib
@@ -635,7 +636,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.7
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.14
 specification_version: 4
 summary: Shared code used across Dependabot Core
 test_files: []