🔀 Merge branch 'release/0.0.3' into stable

🔖🐛 Fix missing extension

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.0.3] - 2025-03-11
+
+### Features
+
+- Added `WithSeparator` to allow for different separators between the parts of the generated filename.
+
 ## [0.0.2] - 2025-03-11
 
 Bugfix release

config.go

@@ -5,12 +5,14 @@ type Config struct {
 	prefix    string
 	suffix    string
 	extension string
+	separator string
 	generator Generator
 }
 
 func NewConfig(options ...Option) Config {
 	conf := Config{
 		extension: ".txt",
+		separator: "_",
 		generator: uuidGen,
 	}
 	for _, opt := range options {

config_test.go

@@ -18,5 +18,5 @@ func TestNewConf(t *testing.T) {
 func TestNewConfWithOpts(t *testing.T) {
 	c := NewConfig(WithoutExtension(), WithPrefix("foobar"))
 	assert.Equal(t, "", c.extension)
-	assert.Equal(t, "foobar_", c.prefix)
+	assert.Equal(t, "foobar", c.prefix)
 }

generators_examples_test.go

@@ -0,0 +1,20 @@
+package nomino
+
+import "fmt"
+
+func ExampleWithGenerator_custom_generator() {
+	gen := func() (string, error) {
+		return "hello", nil
+	}
+	option := WithGenerator(gen)
+
+	str, _ := Make(NewConfig(option))
+	fmt.Println(str)
+
+	str, _ = Make(NewConfig(option, WithoutExtension()))
+	fmt.Println(str)
+
+	// Output:
+	// hello.txt
+	// hello
+}

make.go

@@ -11,5 +11,16 @@ func Make(conf Config) (string, error) {
 		return "", err
 	}
 
+	if conf.prefix != "" {
+		conf.prefix = conf.prefix + conf.separator
+	}
+	if conf.original != "" {
+		conf.original = conf.separator + conf.original
+	}
+	if conf.suffix != "" {
+		conf.suffix = conf.separator + conf.suffix
+
+	}
+
 	return fmt.Sprintf("%s%s%s%s%s", conf.prefix, name, conf.original, conf.suffix, conf.extension), nil
 }

make_examples_test.go

@@ -0,0 +1,9 @@
+package nomino
+
+import "fmt"
+
+func ExampleMake_basic() {
+	// Use default config
+	out, _ := Make(NewConfig())
+	fmt.Println(out)
+}

make_test.go

@@ -20,6 +20,7 @@ func TestMake(t *testing.T) {
 		{"with original", []Option{WithOriginal("file")}, "abc_file.txt"},
 		{"without ext", []Option{WithoutExtension()}, "abc"},
 		{"with ext", []Option{WithExtension("xml")}, "abc.xml"},
+		{"with sep", []Option{WithOriginal("file"), WithSeparator("---")}, "abc---file.txt"},
 		{
 			"with all",
 			[]Option{
@@ -27,8 +28,9 @@ func TestMake(t *testing.T) {
 				WithOriginal("file"),
 				WithSuffix("suff"),
 				WithExtension("svg"),
+				WithSeparator("+"),
 			},
-			"pre_abc_file_suff.svg",
+			"pre+abc+file+suff.svg",
 		},
 	}
 

options.go

@@ -9,21 +9,21 @@ type Option func(c *Config)
 // This will be included in the generated name after the generated string and before the suffix.
 func WithOriginal(o string) Option {
 	return func(c *Config) {
-		c.original = "_" + o
+		c.original = o
 	}
 }
 
 // WithPrefix sets a prefix for the generated name.
 func WithPrefix(p string) Option {
 	return func(c *Config) {
-		c.prefix = p + "_"
+		c.prefix = p
 	}
 }
 
 // WithSuffix sets a suffix for the generated name. It will be included in the base name before the suffix.
 func WithSuffix(s string) Option {
 	return func(c *Config) {
-		c.suffix = "_" + s
+		c.suffix = s
 	}
 }
 
@@ -40,3 +40,10 @@ func WithExtension(ext string) Option {
 		c.extension = "." + strings.TrimPrefix(ext, ".")
 	}
 }
+
+// WithSeparator sets the separator for the generated filename.
+func WithSeparator(sep string) Option {
+	return func(c *Config) {
+		c.separator = sep
+	}
+}

options_test.go

@@ -10,21 +10,21 @@ func TestWithOriginal(t *testing.T) {
 	var c Config
 	name := "foobar"
 	WithOriginal(name)(&c)
-	assert.Equal(t, "_"+name, c.original)
+	assert.Equal(t, name, c.original)
 }
 
 func TestWithPrefix(t *testing.T) {
 	var c Config
 	pref := "draft"
 	WithPrefix(pref)(&c)
-	assert.Equal(t, pref+"_", c.prefix)
+	assert.Equal(t, pref, c.prefix)
 }
 
 func TestWithSuffix(t *testing.T) {
 	var c Config
 	suff := "out"
 	WithSuffix(suff)(&c)
-	assert.Equal(t, "_"+suff, c.suffix)
+	assert.Equal(t, suff, c.suffix)
 }
 
 func TestWithoutExtension(t *testing.T) {
@@ -39,3 +39,10 @@ func TestWithExtension(t *testing.T) {
 	WithExtension(ext)(&c)
 	assert.Equal(t, "."+ext, c.extension)
 }
+
+func TestWithSeparator(t *testing.T) {
+	var c Config
+	sep := "---"
+	WithSeparator(sep)(&c)
+	assert.Equal(t, sep, c.separator)
+}