base library

Author: VictorAvelar

README.md

@@ -0,0 +1,36 @@
+# Slugger
+
+An extensible and configurable library with language specific support for generating slugs.
+
+## Motivation
+
+> TL;DR This is yet another slug generation library.
+
+Creating a slug is common for applications and services and
+althought there are several existing libraries the maintenance or purpose
+doesn't clearly align with our needs.
+
+## Usage
+
+To generate slugs you will need to define a configuration, the library ships several
+options to have a fluent approach for this task.
+
+Here is a basic example for an slugger using English and no suffixes.
+
+```go
+package main
+
+import "github.com/avocatl/slugger"
+
+func main() {
+	cfg := slugger.NewConfig(
+		slugger.WithLanguage(slugger.English),
+		slugger.WithNoSuffix(),
+	)
+
+	s := slugger.New(cfg)
+
+	slug := s.Slugify("Hello, World!")
+	println(slug) // Output: hello-world
+}
+```

config.go

@@ -0,0 +1,120 @@
+package slugger
+
+// Language defines the language used for slugification.
+type Language int
+
+// Supported languages for slugification.
+const (
+	English Language = iota
+	German
+	Spanish
+)
+
+// Suffix defines the type of suffix to append to slugs.
+type Suffix int
+
+// Different suffix strategies.
+const (
+	None Suffix = iota
+	Numbered
+	TimestampBased
+	HashBased
+)
+
+// Config holds configuration options for the slugger.
+type Config struct {
+	Lowercase bool
+	Separator string
+	MaxLength int
+	Language   Language
+	SuffixStrategy Suffix
+	SuffixLength int
+	TimestampTimezone string
+	CounterProvider CounterProviderFunction
+}
+
+// ConfigOption defines a function type for configuring the Slugger.
+type ConfigOption func(*Config)
+
+// WithoutLowercase sets whether slugs should be lowercase.
+func WithoutLowercase() ConfigOption {
+	return func(c *Config) {
+		c.Lowercase = false
+	}
+}
+
+// WithSeparator sets the separator character for slugs.
+func WithSeparator(separator string) ConfigOption {
+	return func(c *Config) {
+		c.Separator = separator
+	}
+}
+
+// WithMaxLength sets the maximum length for slugs.
+func WithMaxLength(maxLength int) ConfigOption {
+	return func(c *Config) {
+		c.MaxLength = maxLength
+	}
+}
+
+
+// WithLanguage sets the language for slugification.
+func WithLanguage(language Language) ConfigOption {
+	return func(c *Config) {
+		c.Language = language
+	}
+}
+
+// WithSuffixStrategy sets the suffix strategy for slugs.
+func WithSuffixStrategy(suffix Suffix) ConfigOption {
+	return func(c *Config) {
+		c.SuffixStrategy = suffix
+	}
+}
+
+// WithHashSuffixLength sets the length of the hash-based suffix.
+func WithHashSuffixLength(length int) ConfigOption {
+	return func(c *Config) {
+		c.SuffixStrategy = HashBased
+		c.SuffixLength = length
+	}
+}
+
+// WithTimestampTimezone sets the timezone for timestamp-based suffixes.
+func WithTimestampTimezone(timezone string) ConfigOption {
+	return func(c *Config) {
+		c.SuffixStrategy = TimestampBased
+		c.TimestampTimezone = timezone
+	}
+}
+
+// WithNumberedCounterProvider sets the counter provider function for numbered suffixes.
+func WithNumberedCounterProvider(counterProvider CounterProviderFunction) ConfigOption {
+	return func(c *Config) {
+		c.SuffixStrategy = Numbered
+		c.CounterProvider = counterProvider
+	}
+}
+
+func WithNoSuffix() ConfigOption {
+	return func(c *Config) {
+		c.SuffixStrategy = None
+	}
+}
+
+// NewConfig creates a new Config with the provided options.
+func NewConfig(options ...ConfigOption) *Config {
+	config := &Config{
+		Lowercase:     true,
+		Separator:     "-",
+		MaxLength:     240,
+		Language:      English,
+		SuffixStrategy: None,
+	}
+
+	for _, option := range options {
+		option(config)
+	}
+
+	return config
+}

config_test.go

@@ -0,0 +1,62 @@
+package slugger_test
+
+import (
+	"log"
+	"reflect"
+	"testing"
+
+	"github.com/avocatl/slugger"
+)
+
+func TestCofigOptions(t *testing.T) {
+	cases := []struct {
+		name string
+		opts []slugger.ConfigOption
+		expected *slugger.Config
+	}{
+		{
+			name: "Default configuration",
+			opts: []slugger.ConfigOption{},
+			expected: &slugger.Config{
+				Lowercase: true,
+				Separator: "-",
+				MaxLength: 240,
+			},
+		},
+		{
+			name: "Custom separator and max length",
+			opts: []slugger.ConfigOption{
+				slugger.WithSeparator("_"),
+				slugger.WithMaxLength(10),
+			},
+			expected: &slugger.Config{
+				Lowercase: true,
+				Separator: "_",
+				MaxLength: 10,
+			},
+		},
+		{
+			name: "Disable lowercase",
+			opts: []slugger.ConfigOption{
+				slugger.WithoutLowercase(),
+			},
+			expected: &slugger.Config{
+				Lowercase: false,
+				Separator: "-",
+				MaxLength: 240,
+			},
+		},
+	}
+
+	for _, tc := range cases {
+		t.Run(tc.name, func(t *testing.T) {
+			cfg := slugger.NewConfig(tc.opts...)
+
+			log.Println(cfg == tc.expected)
+
+			if !reflect.DeepEqual(cfg, tc.expected) {
+				t.Errorf("Expected config %+v, got %+v", tc.expected, cfg)
+			}
+		})
+	}
+}

go.mod

@@ -0,0 +1,5 @@
+module github.com/avocatl/slugger
+
+go 1.25.6
+
+require golang.org/x/text v0.33.0

go.sum

@@ -0,0 +1,2 @@
+golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE=
+golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8=

replacer.go

@@ -0,0 +1,84 @@
+package slugger
+
+import "strings"
+
+// LanguageReplacer defines an interface for replacing special characters based on language.
+type LanguageReplacer interface {
+	Replace(string) string
+}
+
+type germanReplacer struct {
+	rep *strings.Replacer
+}
+
+// Replace replaces special German characters in the input string.
+func (r *germanReplacer) Replace(input string) string {
+	return r.rep.Replace(input)
+}
+
+type englishReplacer struct {
+	rep *strings.Replacer
+}
+
+// Replace replaces special English characters in the input string.
+func (r *englishReplacer) Replace(input string) string {
+	return r.rep.Replace(input)
+}
+
+type spanishReplacer struct {
+	rep *strings.Replacer
+}
+
+// Replace replaces special Spanish characters in the input string.
+func (r *spanishReplacer) Replace(input string) string {
+	return r.rep.Replace(input)
+}
+
+// NewReplacer creates a LanguageReplacer based on the specified language.
+func NewReplacer(language Language) LanguageReplacer {
+	switch language {
+	case German:
+		var oldnew []string
+
+		for old, new := range GermanCharacterMapping {
+			oldnew = append(oldnew, old, new)
+		}
+
+		rep := strings.NewReplacer(oldnew...)
+		
+		return &germanReplacer{rep: rep}
+
+	case English:
+		var oldnew []string
+
+		for old, new := range EnglishCharacterMapping {
+			oldnew = append(oldnew, old, new)
+		}
+
+		rep := strings.NewReplacer(oldnew...)
+
+		return &englishReplacer{rep: rep}
+
+	case Spanish:
+		var oldnew []string
+
+		for old, new := range SpanishCharacterMapping {
+			oldnew = append(oldnew, old, new)
+		}
+
+		rep := strings.NewReplacer(oldnew...)
+
+		return &spanishReplacer{rep: rep}
+
+	default:
+		// For unsupported languages, return a no-op replacer.
+		return &noopReplacer{}
+	}
+}
+
+type noopReplacer struct{}
+
+// Replace returns the input string unchanged.
+func (r *noopReplacer) Replace(input string) string {
+	return input
+}

replacer_test.go

@@ -0,0 +1,45 @@
+package slugger_test
+
+import (
+	"testing"
+
+	"github.com/avocatl/slugger"
+)
+
+func TestReplacer(t *testing.T) {
+	cases := []struct {
+		name    string
+		language slugger.Language
+		input    string
+		expected string
+	}{
+		{
+			name:     "German Replacer",
+			language: slugger.German,
+			input:    "Fähigkeit Straße über",
+			expected: "Faehigkeit Strasse ueber",
+		},
+		{
+			name:     "English Replacer",
+			language: slugger.English,
+			input:    "Café & Drinks",
+			expected: "Café and Drinks",
+		},
+		{
+			name:     "Spanish Replacer",
+			language: slugger.Spanish,
+			input:    "niño corazón jalapeño",
+			expected: "nino corazon jalapeno",
+		},
+	}
+
+	for _, tc := range cases {
+		t.Run(tc.name, func(t *testing.T) {
+			replacer := slugger.NewReplacer(tc.language)
+			result := replacer.Replace(tc.input)
+			if result != tc.expected {
+				t.Errorf("expected %q, got %q", tc.expected, result)
+			}
+		})
+	}
+}