refactor(internal/semver): pass options into DeriveNext functions (#3421)

Update DeriveNext and DeriveNextPreview to accept DeriveNextOptions as
an explicit argument rather than being methods on a receiver.

This removes the need to instantiate an empty struct solely to access
behavior and makes the required inputs explicit at the call site.

The top-level convenience wrappers have been removed in favor of calling
the underlying functions directly.

Author: julieqiu

internal/legacylibrarian/legacylibrarian/commit_version_analyzer.go

@@ -171,7 +171,7 @@ func isUnderAnyPath(file string, paths []string) bool {
 // NextVersion calculates the next semantic version based on a slice of conventional commits.
 func NextVersion(commits []*legacygitrepo.ConventionalCommit, currentVersion string) (string, error) {
 	highestChange := getHighestChange(commits)
-	return semver.DeriveNext(highestChange, currentVersion)
+	return semver.DeriveNext(highestChange, currentVersion, semver.DeriveNextOptions{})
 }
 
 // getHighestChange determines the highest-ranking change type from a slice of commits.

internal/librarian/rust/release.go

@@ -49,10 +49,11 @@ func ReleaseLibrary(library *config.Library, srcPath string) error {
 	if manifest.Package == nil {
 		return err
 	}
-	newVersion, err := semver.DeriveNextOptions{
-		BumpVersionCore:       true,
-		DowngradePreGAChanges: true,
-	}.DeriveNext(semver.Minor, manifest.Package.Version)
+	newVersion, err := semver.DeriveNext(semver.Minor, manifest.Package.Version,
+		semver.DeriveNextOptions{
+			BumpVersionCore:       true,
+			DowngradePreGAChanges: true,
+		})
 	if err != nil {
 		return err
 	}

internal/semver/semver.go

@@ -271,7 +271,7 @@ type DeriveNextOptions struct {
 
 // DeriveNext determines the appropriate SemVer version bump based on the
 // provided [ChangeLevel] and the provided [DeriveNextOptions].
-func (o DeriveNextOptions) DeriveNext(changeLevel ChangeLevel, currentVersion string) (string, error) {
+func DeriveNext(changeLevel ChangeLevel, currentVersion string, opts DeriveNextOptions) (string, error) {
 	if changeLevel == None {
 		return currentVersion, nil
 	}
@@ -281,13 +281,13 @@ func (o DeriveNextOptions) DeriveNext(changeLevel ChangeLevel, currentVersion st
 		return "", err
 	}
 
-	return o.deriveNext(changeLevel, v), nil
+	return deriveNext(changeLevel, v, opts), nil
 }
 
 // deriveNext implements next version derivation based on the [DeriveNextOptions].
-func (o DeriveNextOptions) deriveNext(changeLevel ChangeLevel, v version) string {
+func deriveNext(changeLevel ChangeLevel, v version, opts DeriveNextOptions) string {
 	// Only bump the prerelease version number.
-	if v.Prerelease != "" && !o.BumpVersionCore {
+	if v.Prerelease != "" && !opts.BumpVersionCore {
 		// Append prerelease number if there isn't one.
 		if v.PrereleaseNumber == nil {
 			v.PrereleaseSeparator = "."
@@ -302,7 +302,7 @@ func (o DeriveNextOptions) deriveNext(changeLevel ChangeLevel, v version) string
 	}
 
 	// Reset prerelease number, if present, then fallthrough to bump version core.
-	if v.PrereleaseNumber != nil && o.BumpVersionCore {
+	if v.PrereleaseNumber != nil && opts.BumpVersionCore {
 		*v.PrereleaseNumber = 1
 	}
 
@@ -312,7 +312,7 @@ func (o DeriveNextOptions) deriveNext(changeLevel ChangeLevel, v version) string
 	if v.Major == 0 {
 		if changeLevel == Major {
 			changeLevel = Minor
-		} else if changeLevel == Minor && o.DowngradePreGAChanges {
+		} else if changeLevel == Minor && opts.DowngradePreGAChanges {
 			changeLevel = Patch
 		}
 	}
@@ -351,7 +351,7 @@ var (
 // version, it must be caught up. When the preview version is ahead, a
 // prerelease number bump is all that is necessary. Every change is treated as a
 // [Minor] change. The provided preview version must have a prerelease segment.
-func (o DeriveNextOptions) DeriveNextPreview(previewVersion, stableVersion string) (string, error) {
+func DeriveNextPreview(previewVersion, stableVersion string, opts DeriveNextOptions) (string, error) {
 	pv, err := parse(previewVersion)
 	if err != nil {
 		return "", errors.Join(errInvalidPreviewVersion, err)
@@ -365,7 +365,7 @@ func (o DeriveNextOptions) DeriveNextPreview(previewVersion, stableVersion strin
 	}
 
 	// Make a shallow copy of original options to retain any language-specific needs.
-	nextVerOpts := o
+	nextVerOpts := opts
 	coreStrOpts := stringifyOptions{
 		VersionCoreOnly: true,
 		IncludeVPrefix:  true,
@@ -386,20 +386,5 @@ func (o DeriveNextOptions) DeriveNextPreview(previewVersion, stableVersion strin
 
 		nextVerOpts.BumpVersionCore = true
 	}
-
-	return nextVerOpts.deriveNext(Minor, pv), nil
-}
-
-// DeriveNext calculates the next version based on the highest change type and
-// current version using the default [DeriveNextOptions]. This is a convenience
-// method.
-func DeriveNext(highestChange ChangeLevel, currentVersion string) (string, error) {
-	return DeriveNextOptions{}.DeriveNext(highestChange, currentVersion)
-}
-
-// DeriveNextPreview calculates the next preview version based on the provided
-// stable version using the default [DeriveNextOptions]. This is a convenience
-// method.
-func DeriveNextPreview(previewVersion, stableVersion string) (string, error) {
-	return DeriveNextOptions{}.DeriveNextPreview(previewVersion, stableVersion)
+	return deriveNext(Minor, pv, nextVerOpts), nil
 }

internal/semver/semver_test.go

@@ -215,79 +215,79 @@ func TestVersion_String(t *testing.T) {
 
 func TestDeriveNext(t *testing.T) {
 	for _, test := range []struct {
-		name            string
-		highestChange   ChangeLevel
-		currentVersion  string
-		expectedVersion string
+		name           string
+		highestChange  ChangeLevel
+		currentVersion string
+		want           string
 	}{
 		{
-			name:            "major bump",
-			highestChange:   Major,
-			currentVersion:  "1.2.3",
-			expectedVersion: "2.0.0",
+			name:           "major bump",
+			highestChange:  Major,
+			currentVersion: "1.2.3",
+			want:           "2.0.0",
 		},
 		{
-			name:            "minor bump",
-			highestChange:   Minor,
-			currentVersion:  "1.2.3",
-			expectedVersion: "1.3.0",
+			name:           "minor bump",
+			highestChange:  Minor,
+			currentVersion: "1.2.3",
+			want:           "1.3.0",
 		},
 		{
-			name:            "patch bump",
-			highestChange:   Patch,
-			currentVersion:  "1.2.3",
-			expectedVersion: "1.2.4",
+			name:           "patch bump",
+			highestChange:  Patch,
+			currentVersion: "1.2.3",
+			want:           "1.2.4",
 		},
 		{
-			name:            "pre-1.0.0 feat is patch bump",
-			highestChange:   Minor, // feat is minor
-			currentVersion:  "0.2.3",
-			expectedVersion: "0.3.0",
+			name:           "pre-1.0.0 feat is patch bump",
+			highestChange:  Minor, // feat is minor
+			currentVersion: "0.2.3",
+			want:           "0.3.0",
 		},
 		{
-			name:            "pre-1.0.0 fix is patch bump",
-			highestChange:   Patch,
-			currentVersion:  "0.2.3",
-			expectedVersion: "0.2.4",
+			name:           "pre-1.0.0 fix is patch bump",
+			highestChange:  Patch,
+			currentVersion: "0.2.3",
+			want:           "0.2.4",
 		},
 		{
-			name:            "pre-1.0.0 breaking change is minor bump",
-			highestChange:   Major,
-			currentVersion:  "0.2.3",
-			expectedVersion: "0.3.0",
+			name:           "pre-1.0.0 breaking change is minor bump",
+			highestChange:  Major,
+			currentVersion: "0.2.3",
+			want:           "0.3.0",
 		},
 		{
-			name:            "prerelease bump with numeric trailer",
-			highestChange:   Minor,
-			currentVersion:  "1.2.3-beta.1",
-			expectedVersion: "1.2.3-beta.2",
+			name:           "prerelease bump with numeric trailer",
+			highestChange:  Minor,
+			currentVersion: "1.2.3-beta.1",
+			want:           "1.2.3-beta.2",
 		},
 		{
-			name:            "prerelease bump without numeric trailer",
-			highestChange:   Patch,
-			currentVersion:  "1.2.3-beta",
-			expectedVersion: "1.2.3-beta.1",
+			name:           "prerelease bump without numeric trailer",
+			highestChange:  Patch,
+			currentVersion: "1.2.3-beta",
+			want:           "1.2.3-beta.1",
 		},
 		{
-			name:            "prerelease bump with betaXX format",
-			highestChange:   Major,
-			currentVersion:  "1.2.3-beta21",
-			expectedVersion: "1.2.3-beta22",
+			name:           "prerelease bump with betaXX format",
+			highestChange:  Major,
+			currentVersion: "1.2.3-beta21",
+			want:           "1.2.3-beta22",
 		},
 		{
-			name:            "no bump",
-			highestChange:   None,
-			currentVersion:  "1.2.3",
-			expectedVersion: "1.2.3",
+			name:           "no bump",
+			highestChange:  None,
+			currentVersion: "1.2.3",
+			want:           "1.2.3",
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			nextVersion, err := DeriveNext(test.highestChange, test.currentVersion)
+			got, err := DeriveNext(test.highestChange, test.currentVersion, DeriveNextOptions{})
 			if err != nil {
-				t.Fatalf("DeriveNext() returned an error: %v", err)
+				t.Fatal(err)
 			}
-			if diff := cmp.Diff(test.expectedVersion, nextVersion); diff != "" {
-				t.Errorf("mismatch (-want +got):\n%s", diff)
+			if got != test.want {
+				t.Errorf("DeriveNext(%v, %q) = %q, want %q", test.highestChange, test.currentVersion, got, test.want)
 			}
 		})
 	}
@@ -405,9 +405,9 @@ func TestDeriveNextOptions_DeriveNext(t *testing.T) {
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			nextVersion, err := test.opts.DeriveNext(test.highestChange, test.currentVersion)
+			nextVersion, err := DeriveNext(test.highestChange, test.currentVersion, test.opts)
 			if err != nil {
-				t.Fatalf("DeriveNextOptions.DeriveNext() returned an error: %v", err)
+				t.Fatal(err)
 			}
 			if diff := cmp.Diff(test.expectedVersion, nextVersion); diff != "" {
 				t.Errorf("mismatch (-want +got):\n%s", diff)
@@ -431,7 +431,7 @@ func TestDeriveNextOptions_DeriveNext_Error(t *testing.T) {
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			_, err := DeriveNextOptions{}.DeriveNext(test.changeLevel, test.currentVersion)
+			_, err := DeriveNext(test.changeLevel, test.currentVersion, DeriveNextOptions{})
 			if err == nil {
 				t.Errorf("DeriveNextOptions.DeriveNext(%v, %q) did not return an error as expected.", test.changeLevel, test.currentVersion)
 			} else if !errors.Is(err, test.wantErr) {
@@ -539,9 +539,9 @@ func TestDeriveNextOptions_DeriveNextPreview(t *testing.T) {
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			nextVersion, err := test.opts.DeriveNextPreview(test.previewVersion, test.stableVersion)
+			nextVersion, err := DeriveNextPreview(test.previewVersion, test.stableVersion, test.opts)
 			if err != nil {
-				t.Fatalf("DeriveNextOptions.DeriveNextPreview() returned an error: %v", err)
+				t.Fatalf("DeriveNextPreview() returned an error: %v", err)
 			}
 			if diff := cmp.Diff(test.want, nextVersion); diff != "" {
 				t.Errorf("mismatch (-want +got):\n%s", diff)
@@ -577,9 +577,9 @@ func TestDeriveNextOptions_DeriveNextPreview_Errors(t *testing.T) {
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			_, err := DeriveNextOptions{}.DeriveNextPreview(test.previewVersion, test.stableVersion)
+			_, err := DeriveNextPreview(test.previewVersion, test.stableVersion, DeriveNextOptions{})
 			if err == nil {
-				t.Errorf("DeriveNextOptions.DeriveNextPreview(%q, %q) did not return an error as expected.", test.previewVersion, test.stableVersion)
+				t.Errorf("DeriveNextPreview(%q, %q) did not return an error as expected.", test.previewVersion, test.stableVersion)
 			} else if !errors.Is(err, test.wantErr) {
 				t.Errorf("mismatch, got %v, wanted inclusion of %v", err, test.wantErr)
 			}

internal/sidekick/rust_release/update_manifest.go

@@ -61,10 +61,11 @@ func updateManifest(config *config.Release, lastTag, manifest string) ([]string,
 	if !info.Package.Publish {
 		return nil, nil
 	}
-	newVersion, err := semver.DeriveNextOptions{
-		BumpVersionCore:       true,
-		DowngradePreGAChanges: true,
-	}.DeriveNext(semver.Minor, info.Package.Version)
+	newVersion, err := semver.DeriveNext(semver.Minor, info.Package.Version,
+		semver.DeriveNextOptions{
+			BumpVersionCore:       true,
+			DowngradePreGAChanges: true,
+		})
 	if err != nil {
 		return nil, err
 	}