add support for extarcting version from comment

Author: AbhishekBhaskar

.rubocop_todo.yml

@@ -155,6 +155,7 @@ Metrics/AbcSize:
 # Offense count: 354/350
 Metrics/ClassLength:
   Exclude:
+    - 'common/lib/dependabot/dependency.rb'
     - 'opentofu/lib/dependabot/opentofu/file_parser.rb'
 
 # Offense count: 8

common/lib/dependabot/dependency.rb

@@ -14,6 +14,10 @@ class Dependency
     )
     @display_name_builders = T.let({}, T::Hash[String, T.proc.params(arg0: String).returns(String)])
     @name_normalisers = T.let({}, T::Hash[String, T.proc.params(arg0: String).returns(String)])
+    @humanized_previous_version_builders = T.let(
+      {},
+      T::Hash[String, T.proc.params(arg0: Dependency).returns(T.nilable(String))]
+    )
 
     sig do
       params(package_manager: String).returns(T.proc.params(arg0: T::Array[T.untyped]).returns(T::Boolean))
@@ -61,6 +65,25 @@ def self.register_name_normaliser(package_manager, name_builder)
       @name_normalisers[package_manager] = name_builder
     end
 
+    sig do
+      params(
+        package_manager: String
+      ).returns(T.nilable(T.proc.params(arg0: Dependency).returns(T.nilable(String))))
+    end
+    def self.humanized_previous_version_builder_for_package_manager(package_manager)
+      @humanized_previous_version_builders[package_manager]
+    end
+
+    sig do
+      params(
+        package_manager: String,
+        builder: T.proc.params(arg0: Dependency).returns(T.nilable(String))
+      ).void
+    end
+    def self.register_humanized_previous_version_builder(package_manager, builder)
+      @humanized_previous_version_builders[package_manager] = builder
+    end
+
     sig { returns(String) }
     attr_reader :name
 
@@ -225,24 +248,10 @@ def display_name
 
     sig { returns(T.nilable(String)) }
     def humanized_previous_version
-      # If we don't have a previous version, we *may* still be able to figure
-      # one out if a ref was provided and has been changed (in which case the
-      # previous ref was essentially the version).
-      if previous_version.nil?
-        return ref_changed? ? previous_ref : nil
-      end
-
-      if T.must(previous_version).match?(/^[0-9a-f]{40}/)
-        return previous_ref if ref_changed? && previous_ref
+      custom_version = custom_humanized_previous_version
+      return custom_version if custom_version
 
-        "`#{T.must(previous_version)[0..6]}`"
-      elsif version == previous_version &&
-            package_manager == "docker"
-        digest = docker_digest_from_reqs(T.must(previous_requirements))
-        "`#{T.must(T.must(digest).split(':').last)[0..6]}`"
-      else
-        previous_version
-      end
+      default_humanized_previous_version
     end
 
     sig { returns(T.nilable(String)) }
@@ -391,6 +400,40 @@ def requirements_changed?
 
     private
 
+    sig { returns(T.nilable(String)) }
+    def custom_humanized_previous_version
+      builder = self.class.humanized_previous_version_builder_for_package_manager(package_manager)
+      return nil unless builder
+
+      builder.call(self)
+    end
+
+    sig { returns(T.nilable(String)) }
+    def default_humanized_previous_version
+      # If we don't have a previous version, we *may* still be able to figure
+      # one out if a ref was provided and has been changed (in which case the
+      # previous ref was essentially the version).
+      return (ref_changed? ? previous_ref : nil) if previous_version.nil?
+
+      return humanized_sha_previous_version if T.must(previous_version).match?(/^[0-9a-f]{40}/)
+      return humanized_docker_previous_version if version == previous_version && package_manager == "docker"
+
+      previous_version
+    end
+
+    sig { returns(T.nilable(String)) }
+    def humanized_sha_previous_version
+      return previous_ref if ref_changed? && previous_ref
+
+      "`#{T.must(previous_version)[0..6]}`"
+    end
+
+    sig { returns(String) }
+    def humanized_docker_previous_version
+      digest = docker_digest_from_reqs(T.must(previous_requirements))
+      "`#{T.must(T.must(digest).split(':').last)[0..6]}`"
+    end
+
     sig { void }
     def check_values
       check_requirement_fields

common/spec/dependabot/dependency_spec.rb

@@ -392,4 +392,112 @@
       expect(dependency.all_versions).to eq(["1.0.0", "2.0.0"])
     end
   end
+
+  describe "#humanized_previous_version" do
+    context "with a registered humanized_previous_version_builder" do
+      before do
+        described_class.register_humanized_previous_version_builder(
+          "test_pm",
+          ->(dep) { dep.previous_requirements&.dig(0, :metadata, :comment_version) }
+        )
+      end
+
+      it "uses the registered builder when it returns a value" do
+        dependency = described_class.new(
+          name: "dep",
+          version: "abc123def456789012345678901234567890abcd",
+          previous_version: "6f6a02c2c85a1b45e39c1aa5e6cc40f7a3d6df5e",
+          requirements: [{
+            file: "config.yaml",
+            requirement: nil,
+            groups: [],
+            source: { type: "git", ref: "abc123def456789012345678901234567890abcd" }
+          }],
+          previous_requirements: [{
+            file: "config.yaml",
+            requirement: nil,
+            groups: [],
+            source: { type: "git", ref: "6f6a02c2c85a1b45e39c1aa5e6cc40f7a3d6df5e" },
+            metadata: { comment_version: "v2.2.1" }
+          }],
+          package_manager: "test_pm"
+        )
+
+        expect(dependency.humanized_previous_version).to eq("v2.2.1")
+      end
+
+      it "falls back to default behavior when builder returns nil" do
+        dependency = described_class.new(
+          name: "dep",
+          version: "abc123def456789012345678901234567890abcd",
+          previous_version: "6f6a02c2c85a1b45e39c1aa5e6cc40f7a3d6df5e",
+          requirements: [{
+            file: "config.yaml",
+            requirement: nil,
+            groups: [],
+            source: { type: "git", ref: "abc123def456789012345678901234567890abcd" }
+          }],
+          previous_requirements: [{
+            file: "config.yaml",
+            requirement: nil,
+            groups: [],
+            source: { type: "git", ref: "6f6a02c2c85a1b45e39c1aa5e6cc40f7a3d6df5e" }
+          }],
+          package_manager: "test_pm"
+        )
+
+        # Falls back to previous_ref when ref changed and previous_ref exists
+        expect(dependency.humanized_previous_version).to eq("6f6a02c2c85a1b45e39c1aa5e6cc40f7a3d6df5e")
+      end
+    end
+
+    context "without a registered builder" do
+      it "returns the previous_version when it's not a SHA" do
+        dependency = described_class.new(
+          name: "dep",
+          version: "v2.0.0",
+          previous_version: "v1.0.0",
+          requirements: [{
+            file: "config.yaml",
+            requirement: nil,
+            groups: [],
+            source: nil
+          }],
+          previous_requirements: [{
+            file: "config.yaml",
+            requirement: nil,
+            groups: [],
+            source: nil
+          }],
+          package_manager: "no_builder_pm"
+        )
+
+        expect(dependency.humanized_previous_version).to eq("v1.0.0")
+      end
+
+      it "returns previous_ref when previous_version is a SHA and ref changed" do
+        dependency = described_class.new(
+          name: "dep",
+          version: "abc123def456789012345678901234567890abcd",
+          previous_version: "6f6a02c2c85a1b45e39c1aa5e6cc40f7a3d6df5e",
+          requirements: [{
+            file: "config.yaml",
+            requirement: nil,
+            groups: [],
+            source: { type: "git", ref: "abc123def456789012345678901234567890abcd" }
+          }],
+          previous_requirements: [{
+            file: "config.yaml",
+            requirement: nil,
+            groups: [],
+            source: { type: "git", ref: "6f6a02c2c85a1b45e39c1aa5e6cc40f7a3d6df5e" }
+          }],
+          package_manager: "no_builder_pm"
+        )
+
+        # Returns previous_ref when ref changed and previous_ref exists
+        expect(dependency.humanized_previous_version).to eq("6f6a02c2c85a1b45e39c1aa5e6cc40f7a3d6df5e")
+      end
+    end
+  end
 end

pre_commit/lib/dependabot/pre_commit.rb

@@ -1,4 +1,4 @@
-# typed: strong
+# typed: strict
 # frozen_string_literal: true
 
 # These all need to be required so the various classes can be registered in a
@@ -11,10 +11,29 @@
 require "dependabot/pre_commit/version"
 require "dependabot/pre_commit/requirement"
 require "dependabot/pre_commit/helpers"
+require "dependabot/pre_commit/comment_version_helper"
 
 require "dependabot/pull_request_creator/labeler"
 Dependabot::PullRequestCreator::Labeler
   .register_label_details("pre_commit", name: "pre_commit", colour: "000000")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check("pre_commit", ->(_) { true })
+
+# Register a humanized previous version builder for pre_commit that extracts
+# the version from the comment when using frozen SHA format (e.g., rev: <sha> # v2.2.1)
+Dependabot::Dependency.register_humanized_previous_version_builder(
+  "pre_commit",
+  lambda { |dep|
+    previous_reqs = dep.previous_requirements
+    return nil unless previous_reqs
+
+    comment = previous_reqs
+              .filter_map { |r| r.dig(:metadata, :comment) }
+              .first
+    return nil unless comment
+
+    match = comment.match(Dependabot::PreCommit::CommentVersionHelper::COMMENT_VERSION_PATTERN)
+    match&.[](0)
+  }
+)