feat(spaced): Avoid naming stutter (#12)

Author: 72636c

.gitignore

@@ -4,4 +4,5 @@ dist/
 vendor/
 
 .DS_Store
+debug.test
 hyperspaced

README.md

@@ -26,10 +26,10 @@ import (
   "github.com/72636c/hyperspaced"
 )
 
-hyperspaced.Spaced("AESTHETIC")
+hyperspaced.One("AESTHETIC")
 // A E S T H E T I C
 
-hyperspaced.SpacedN("AESTHETIC", 2)
+hyperspaced.N("AESTHETIC", 2)
 // A  E  S  T  H  E  T  I  C
 ```
 

hyperspaced.go

@@ -6,12 +6,20 @@ import (
 	"github.com/72636c/hyperspaced/internal/text/transform"
 )
 
-// Spaced inserts a space between each character in a string.
-func Spaced(str string) string {
-	return transform.Spaced(str)
-}
+var (
+	// Spaced is an alias for One that is retained for backwards compatibility.
+	Spaced = One
+
+	// SpacedN is an alias for N that is retained for backwards compatibility.
+	SpacedN = N
+)
 
-// SpacedN inserts n spaces between each character in a string.
-func SpacedN(str string, n int) string {
+// N inserts n spaces between each character in a string.
+func N(str string, n int) string {
 	return transform.SpacedN(str, n)
 }
+
+// One inserts a space between each character in a string.
+func One(str string) string {
+	return transform.Spaced(str)
+}

hyperspaced_test.go

@@ -6,16 +6,16 @@ import (
 	"github.com/72636c/hyperspaced"
 )
 
-func ExampleSpaced() {
-	output := hyperspaced.Spaced("AESTHETIC")
+func ExampleN() {
+	output := hyperspaced.N("AESTHETIC", 2)
 
 	fmt.Println(output)
-	// Output: A E S T H E T I C
+	// Output: A  E  S  T  H  E  T  I  C
 }
 
-func ExampleSpacedN() {
-	output := hyperspaced.SpacedN("AESTHETIC", 2)
+func ExampleOne() {
+	output := hyperspaced.One("AESTHETIC")
 
 	fmt.Println(output)
-	// Output: A  E  S  T  H  E  T  I  C
+	// Output: A E S T H E T I C
 }

internal/text/transform/spaced.go

@@ -15,7 +15,7 @@ func Spaced(str string) string {
 // SpacedN inserts n spaces between each character in a string.
 func SpacedN(str string, n int) string {
 	if n < 0 {
-		panic(errors.New("hyperspaced.SpacedN: really?"))
+		panic(errors.New("hyperspaced/internal/text.SpacedN: really?"))
 	}
 
 	chars := text.SplitString(str)

internal/text/transform/spaced_test.go

@@ -6,49 +6,7 @@ import (
 	"github.com/72636c/hyperspaced"
 )
 
-func Test_Spaced(t *testing.T) {
-	testCases := []struct {
-		description string
-		input       string
-		expected    string
-	}{
-		{
-			description: "Empty String",
-			input:       "",
-			expected:    "",
-		},
-		{
-			description: "One Word",
-			input:       "AESTHETIC",
-			expected:    "A E S T H E T I C",
-		},
-		{
-			description: "Two Words",
-			input:       "no u",
-			expected:    "n o   u",
-		},
-		{
-			description: "Emojified Buzzword",
-			input:       "\U0001f30f planet scale \u2696",
-			expected:    "🌏   p l a n e t   s c a l e   ⚖",
-		},
-	}
-
-	for _, testCase := range testCases {
-		t.Run(testCase.description, func(t *testing.T) {
-			actual := hyperspaced.Spaced(testCase.input)
-			if actual != testCase.expected {
-				t.Errorf(
-					"expected %+[1]q (%[1]s), received %+[2]q (%[2]s)",
-					testCase.expected,
-					actual,
-				)
-			}
-		})
-	}
-}
-
-func Test_SpacedN(t *testing.T) {
+func Suite_N(t *testing.T, f func(string, int) string) {
 	testCases := []struct {
 		description string
 		inputString string
@@ -71,7 +29,7 @@ func Test_SpacedN(t *testing.T) {
 
 	for _, testCase := range testCases {
 		t.Run(testCase.description, func(t *testing.T) {
-			actual := hyperspaced.SpacedN(testCase.inputString, testCase.inputN)
+			actual := f(testCase.inputString, testCase.inputN)
 			if actual != testCase.expected {
 				t.Errorf(
 					"expected %+[1]q (%[1]s), received %+[2]q (%[2]s)",
@@ -83,8 +41,8 @@ func Test_SpacedN(t *testing.T) {
 	}
 }
 
-func Test_SpacedN_Panics_OnNegativeN(t *testing.T) {
-	expectedMessage := "hyperspaced.SpacedN: really?"
+func Suite_N_Panics_OnNegativeN(t *testing.T, f func(string, int) string) {
+	expectedMessage := "hyperspaced/internal/text.SpacedN: really?"
 
 	defer func() {
 		r := recover()
@@ -105,7 +63,73 @@ func Test_SpacedN_Panics_OnNegativeN(t *testing.T) {
 		}
 	}()
 
-	hyperspaced.SpacedN("", -1)
+	f("", -1)
 
 	t.Error("expected panic")
 }
+
+func Suite_One(t *testing.T, f func(string) string) {
+	testCases := []struct {
+		description string
+		input       string
+		expected    string
+	}{
+		{
+			description: "Empty String",
+			input:       "",
+			expected:    "",
+		},
+		{
+			description: "One Word",
+			input:       "AESTHETIC",
+			expected:    "A E S T H E T I C",
+		},
+		{
+			description: "Two Words",
+			input:       "no u",
+			expected:    "n o   u",
+		},
+		{
+			description: "Emojified Buzzword",
+			input:       "\U0001f30f planet scale \u2696",
+			expected:    "🌏   p l a n e t   s c a l e   ⚖",
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.description, func(t *testing.T) {
+			actual := f(testCase.input)
+			if actual != testCase.expected {
+				t.Errorf(
+					"expected %+[1]q (%[1]s), received %+[2]q (%[2]s)",
+					testCase.expected,
+					actual,
+				)
+			}
+		})
+	}
+}
+
+func Test_N(t *testing.T) {
+	Suite_N(t, hyperspaced.N)
+}
+
+func Test_N_Panics_OnNegativeN(t *testing.T) {
+	Suite_N_Panics_OnNegativeN(t, hyperspaced.N)
+}
+
+func Test_One(t *testing.T) {
+	Suite_One(t, hyperspaced.One)
+}
+
+func Test_Spaced(t *testing.T) {
+	Suite_One(t, hyperspaced.Spaced)
+}
+
+func Test_SpacedN(t *testing.T) {
+	Suite_N(t, hyperspaced.SpacedN)
+}
+
+func Test_SpacedN_Panics_OnNegativeN(t *testing.T) {
+	Suite_N_Panics_OnNegativeN(t, hyperspaced.SpacedN)
+}