Function TestSpec_PublicAPI_SanitizeName

pkg/stringutil/spec_test.go:815–846

TestSpec_PublicAPI_SanitizeName validates the documented behavior of SanitizeName as described in the package README.md. Specification: "Sanitizes a name for identifiers and filenames using configurable behavior (preserved special characters, optional hyphen trimming, and fallback default value)."

(t *testing.T)

// The README documents the SanitizeOptions type as: "Options for SanitizeName
// (preserved characters, hyphen trimming, and default value)."
func TestSpec_PublicAPI_SanitizeName(t *testing.T) {
	t.Run("uses default value when sanitized result would be empty", func(t *testing.T) {
		opts := &SanitizeOptions{DefaultValue: "fallback"}
		result := SanitizeName("!!!", opts)
		assert.Equal(t, "fallback", result,
			"SanitizeName should return DefaultValue when sanitization yields an empty string")
	})

	t.Run("TrimHyphens removes leading and trailing hyphens", func(t *testing.T) {
		opts := &SanitizeOptions{TrimHyphens: true}
		result := SanitizeName("---hello---", opts)
		assert.NotEmpty(t, result,
			"SanitizeName should return non-empty result")
		assert.False(t, strings.HasPrefix(result, "-"),
			"SanitizeName with TrimHyphens=true should not return a result with leading '-'")
		assert.False(t, strings.HasSuffix(result, "-"),
			"SanitizeName with TrimHyphens=true should not return a result with trailing '-'")
	})

	t.Run("PreserveSpecialChars preserves listed characters", func(t *testing.T) {
		opts := &SanitizeOptions{PreserveSpecialChars: []rune{'.'}}
		result := SanitizeName("file.name", opts)
		assert.Contains(t, result, ".",
			"SanitizeName with '.' in PreserveSpecialChars should preserve '.'")
	})

	t.Run("nil options is accepted", func(t *testing.T) {
		result := SanitizeName("hello", nil)
		assert.NotEmpty(t, result,
			"SanitizeName should accept nil options and return a non-empty sanitized name")
	})
}

// TestSpec_PublicAPI_FindClosestMatches validates the documented behavior of
// FindClosestMatches as described in the package README.md.