feat: Enable Miraclesort in CLI

Makefile

@@ -36,6 +36,8 @@ e2e:
 	./dist/sortof -h
 	./dist/sortof bogo <test_case.unsorted | diff test_case.sorted -
 	./dist/sortof bogo -t 5s <test_case.unsorted | diff test_case.sorted -
+	./dist/sortof miracle <test_case.sorted | diff test_case.sorted -
+	./dist/sortof miracle -t 1ms <test_case.unsorted 2>&1 | grep '^sortof: '
 	./dist/sortof slow <test_case.unsorted | diff test_case.sorted -
 	./dist/sortof slow -t 100ms <test_case.unsorted | diff test_case.sorted -
 	./dist/sortof stalin <test_case.unsorted | diff test_case.stalinsorted -

README.md

@@ -13,7 +13,7 @@
 Implemented algorithms:
 
 - [bogosort](https://en.wikipedia.org/wiki/Bogosort)
-- [miraclesort](https://en.wikipedia.org/wiki/Bogosort#miracle_sort) (currently module only)
+- [miraclesort](https://en.wikipedia.org/wiki/Bogosort#miracle_sort)
 - [slowsort](https://en.wikipedia.org/wiki/Slowsort)
 - [stalinsort](https://mastodon.social/@mathew/100958177234287431).
 

cmd/sortof/config.go

@@ -25,6 +25,7 @@ const helpMsg = "sortof - sort lines of text files\n" +
 	"\n" +
 	"Algorithms:\n" +
 	"   bogo          Bogosort\n" +
+	"   miracle       Miraclesort\n" +
 	"   slow          Slowsort\n" +
 	"   stalin        Stalinsort\n" +
 	"\n" +
@@ -70,6 +71,8 @@ func NewAppConfig(cliArgs []string) (AppConfig, error) {
 	switch cliArgs[0] {
 	case "bogo":
 		config.SortFunc = BogosortFile
+	case "miracle":
+		config.SortFunc = MiraclesortFile
 	case "slow":
 		config.SortFunc = SlowsortFile
 	case "stalin":

cmd/sortof/sortfiles.go

@@ -32,6 +32,30 @@ func BogosortFile(ctx context.Context, file io.ReadCloser) ([]string, error) {
 	return lines, nil
 }
 
+// MiraclesortFile returns a sorted lines from the file in ascending order.
+// A context controls cancellation.
+func MiraclesortFile(ctx context.Context, file io.ReadCloser) ([]string, error) {
+	lines := []string{}
+	scanner := bufio.NewScanner(file)
+	for scanner.Scan() {
+		select {
+		case <-ctx.Done():
+			return []string{}, context.Cause(ctx)
+		default:
+			lines = append(lines, scanner.Text())
+		}
+	}
+	if err := scanner.Err(); err != nil {
+		return []string{}, err
+	}
+
+	if err := sortof.Miraclesort(ctx, lines); err != nil {
+		return []string{}, err
+	}
+
+	return lines, nil
+}
+
 // SlowsortFile returns a sorted lines from the file in ascending order.
 // A context controls cancellation.
 func SlowsortFile(ctx context.Context, file io.ReadCloser) ([]string, error) {