Add line-up exercise (exercism#349)

Author: keiravillekode

config.json

@@ -345,6 +345,14 @@
         "prerequisites": [],
         "difficulty": 3
       },
+      {
+        "slug": "line-up",
+        "name": "Line Up",
+        "uuid": "6b707608-65f8-4cb7-9f2f-e1a19ac48ad8",
+        "practices": [],
+        "prerequisites": [],
+        "difficulty": 3
+      },
       {
         "slug": "perfect-numbers",
         "name": "Perfect Numbers",

exercises/practice/line-up/.docs/instructions.md

@@ -0,0 +1,19 @@
+# Instructions
+
+Given a name and a number, your task is to produce a sentence using that name and that number as an [ordinal numeral][ordinal-numeral].
+Yaʻqūb expects to use numbers from 1 up to 999.
+
+Rules:
+
+- Numbers ending in 1 (except for 11) → `"st"`
+- Numbers ending in 2 (except for 12) → `"nd"`
+- Numbers ending in 3 (except for 13) → `"rd"`
+- All other numbers → `"th"`
+
+Examples:
+
+- `"Mary", 1` → `"Mary, you are the 1st customer we serve today. Thank you!"`
+- `"John", 12` → `"John, you are the 12th customer we serve today. Thank you!"`
+- `"Dahir", 162` → `"Dahir, you are the 162nd customer we serve today. Thank you!"`
+
+[ordinal-numeral]: https://en.wikipedia.org/wiki/Ordinal_numeral

exercises/practice/line-up/.docs/introduction.md

@@ -0,0 +1,7 @@
+# Introduction
+
+Your friend Yaʻqūb works the counter at a deli in town, slicing, weighing, and wrapping orders for a line of hungry customers that gets longer every day.
+Waiting customers are starting to lose track of who is next, so he wants numbered tickets they can use to track the order in which they arrive.
+
+To make the customers feel special, he does not want the ticket to have only a number on it.
+They shall get a proper English sentence with their name and number on it.

exercises/practice/line-up/.meta/config.json

@@ -0,0 +1,19 @@
+{
+  "authors": [
+    "keiravillekode"
+  ],
+  "files": {
+    "solution": [
+      "line-up.sml"
+    ],
+    "test": [
+      "test.sml"
+    ],
+    "example": [
+      ".meta/example.sml"
+    ]
+  },
+  "blurb": "Help lining up customers at Yaʻqūb's Deli.",
+  "source": "mk-mxp, based on previous work from Exercism contributors codedge and neenjaw",
+  "source_url": "https://forum.exercism.org/t/new-exercise-ordinal-numbers/19147"
+}

exercises/practice/line-up/.meta/example.sml

@@ -0,0 +1,19 @@
+fun suffix number =
+  let
+    val units = number mod 10
+    val tens = number div 10 mod 10
+  in
+    if units = 1 andalso tens <> 1 then "st"
+    else if units = 2 andalso tens <> 1 then "nd"
+    else if units = 3 andalso tens <> 1 then "rd"
+    else "th"
+  end;
+
+fun format name number =
+  String.concat [
+    name,
+    ", you are the ",
+    (Int.toString number),
+    (suffix number),
+    " customer we serve today. Thank you!"
+  ]

exercises/practice/line-up/.meta/tests.toml

@@ -0,0 +1,67 @@
+# This is an auto-generated file.
+#
+# Regenerating this file via `configlet sync` will:
+# - Recreate every `description` key/value pair
+# - Recreate every `reimplements` key/value pair, where they exist in problem-specifications
+# - Remove any `include = true` key/value pair (an omitted `include` key implies inclusion)
+# - Preserve any other key/value pair
+#
+# As user-added comments (using the # character) will be removed when this file
+# is regenerated, comments can be added via a `comment` key.
+
+[7760d1b8-4864-4db4-953b-0fa7c047dbc0]
+description = "format smallest non-exceptional ordinal numeral 4"
+
+[e8b7c715-6baa-4f7b-8fb3-2fa48044ab7a]
+description = "format greatest single digit non-exceptional ordinal numeral 9"
+
+[f370aae9-7ae7-4247-90ce-e8ff8c6934df]
+description = "format non-exceptional ordinal numeral 5"
+
+[37f10dea-42a2-49de-bb92-0b690b677908]
+description = "format non-exceptional ordinal numeral 6"
+
+[d8dfb9a2-3a1f-4fee-9dae-01af3600054e]
+description = "format non-exceptional ordinal numeral 7"
+
+[505ec372-1803-42b1-9377-6934890fd055]
+description = "format non-exceptional ordinal numeral 8"
+
+[8267072d-be1f-4f70-b34a-76b7557a47b9]
+description = "format exceptional ordinal numeral 1"
+
+[4d8753cb-0364-4b29-84b8-4374a4fa2e3f]
+description = "format exceptional ordinal numeral 2"
+
+[8d44c223-3a7e-4f48-a0ca-78e67bf98aa7]
+description = "format exceptional ordinal numeral 3"
+
+[6c4f6c88-b306-4f40-bc78-97cdd583c21a]
+description = "format smallest two digit non-exceptional ordinal numeral 10"
+
+[e257a43f-d2b1-457a-97df-25f0923fc62a]
+description = "format non-exceptional ordinal numeral 11"
+
+[bb1db695-4d64-457f-81b8-4f5a2107e3f4]
+description = "format non-exceptional ordinal numeral 12"
+
+[60a3187c-9403-4835-97de-4f10ebfd63e2]
+description = "format non-exceptional ordinal numeral 13"
+
+[2bdcebc5-c029-4874-b6cc-e9bec80d603a]
+description = "format exceptional ordinal numeral 21"
+
+[74ee2317-0295-49d2-baf0-d56bcefa14e3]
+description = "format exceptional ordinal numeral 62"
+
+[b37c332d-7f68-40e3-8503-e43cbd67a0c4]
+description = "format exceptional ordinal numeral 100"
+
+[0375f250-ce92-4195-9555-00e28ccc4d99]
+description = "format exceptional ordinal numeral 101"
+
+[0d8a4974-9a8a-45a4-aca7-a9fb473c9836]
+description = "format non-exceptional ordinal numeral 112"
+
+[06b62efe-199e-4ce7-970d-4bf73945713f]
+description = "format exceptional ordinal numeral 123"

exercises/practice/line-up/line-up.sml

@@ -0,0 +1,2 @@
+fun format name number =
+  raise Fail "'format' is not implemented"

exercises/practice/line-up/test.sml

@@ -0,0 +1,69 @@
+(* version 1.0.0 *)
+
+use "testlib.sml";
+use "line-up.sml";
+
+infixr |>
+fun x |> f = f x
+
+val testsuite =
+  describe "line-up" [
+    test "format smallest non-exceptional ordinal numeral 4"
+      (fn _ => format "Gianna" 4 |> Expect.equalTo "Gianna, you are the 4th customer we serve today. Thank you!"),
+
+    test "format greatest single digit non-exceptional ordinal numeral 9"
+      (fn _ => format "Maarten" 9 |> Expect.equalTo "Maarten, you are the 9th customer we serve today. Thank you!"),
+
+    test "format non-exceptional ordinal numeral 5"
+      (fn _ => format "Petronila" 5 |> Expect.equalTo "Petronila, you are the 5th customer we serve today. Thank you!"),
+
+    test "format non-exceptional ordinal numeral 6"
+      (fn _ => format "Attakullakulla" 6 |> Expect.equalTo "Attakullakulla, you are the 6th customer we serve today. Thank you!"),
+
+    test "format non-exceptional ordinal numeral 7"
+      (fn _ => format "Kate" 7 |> Expect.equalTo "Kate, you are the 7th customer we serve today. Thank you!"),
+
+    test "format non-exceptional ordinal numeral 8"
+      (fn _ => format "Maximiliano" 8 |> Expect.equalTo "Maximiliano, you are the 8th customer we serve today. Thank you!"),
+
+    test "format exceptional ordinal numeral 1"
+      (fn _ => format "Mary" 1 |> Expect.equalTo "Mary, you are the 1st customer we serve today. Thank you!"),
+
+    test "format exceptional ordinal numeral 2"
+      (fn _ => format "Haruto" 2 |> Expect.equalTo "Haruto, you are the 2nd customer we serve today. Thank you!"),
+
+    test "format exceptional ordinal numeral 3"
+      (fn _ => format "Henriette" 3 |> Expect.equalTo "Henriette, you are the 3rd customer we serve today. Thank you!"),
+
+    test "format smallest two digit non-exceptional ordinal numeral 10"
+      (fn _ => format "Alvarez" 10 |> Expect.equalTo "Alvarez, you are the 10th customer we serve today. Thank you!"),
+
+    test "format non-exceptional ordinal numeral 11"
+      (fn _ => format "Jacqueline" 11 |> Expect.equalTo "Jacqueline, you are the 11th customer we serve today. Thank you!"),
+
+    test "format non-exceptional ordinal numeral 12"
+      (fn _ => format "Juan" 12 |> Expect.equalTo "Juan, you are the 12th customer we serve today. Thank you!"),
+
+    test "format non-exceptional ordinal numeral 13"
+      (fn _ => format "Patricia" 13 |> Expect.equalTo "Patricia, you are the 13th customer we serve today. Thank you!"),
+
+    test "format exceptional ordinal numeral 21"
+      (fn _ => format "Washi" 21 |> Expect.equalTo "Washi, you are the 21st customer we serve today. Thank you!"),
+
+    test "format exceptional ordinal numeral 62"
+      (fn _ => format "Nayra" 62 |> Expect.equalTo "Nayra, you are the 62nd customer we serve today. Thank you!"),
+
+    test "format exceptional ordinal numeral 100"
+      (fn _ => format "John" 100 |> Expect.equalTo "John, you are the 100th customer we serve today. Thank you!"),
+
+    test "format exceptional ordinal numeral 101"
+      (fn _ => format "Zeinab" 101 |> Expect.equalTo "Zeinab, you are the 101st customer we serve today. Thank you!"),
+
+    test "format non-exceptional ordinal numeral 112"
+      (fn _ => format "Knud" 112 |> Expect.equalTo "Knud, you are the 112th customer we serve today. Thank you!"),
+
+    test "format exceptional ordinal numeral 123"
+      (fn _ => format "Yma" 123 |> Expect.equalTo "Yma, you are the 123rd customer we serve today. Thank you!")
+  ]
+
+val _ = Test.run testsuite

exercises/practice/line-up/testlib.sml

@@ -0,0 +1,160 @@
+structure Expect =
+struct
+  datatype expectation = Pass | Fail of string * string
+
+  local
+    fun failEq b a =
+      Fail ("Expected: " ^ b, "Got: " ^ a)
+    
+    fun failExn b a =
+      Fail ("Expected: " ^ b, "Raised: " ^ a)
+
+    fun exnName (e: exn): string = General.exnName e
+  in
+    fun truthy a =
+      if a
+      then Pass
+      else failEq "true" "false"
+
+    fun falsy a =
+      if a
+      then failEq "false" "true"
+      else Pass
+
+    fun equalTo b a = 
+      if a = b
+      then Pass
+      else failEq (PolyML.makestring b) (PolyML.makestring a)
+
+    fun nearTo delta b a =
+      if Real.abs (a - b) <= delta * Real.abs a orelse
+         Real.abs (a - b) <= delta * Real.abs b
+      then Pass
+      else failEq (Real.toString b ^ " +/- " ^ Real.toString delta) (Real.toString a)
+
+    fun anyError f =
+      (
+        f ();
+        failExn "an exception" "Nothing"
+      ) handle _ => Pass
+
+    fun error e f =
+      (
+        f ();
+        failExn (exnName e) "Nothing"
+      ) handle e' => if exnMessage e' = exnMessage e
+                     then Pass
+                     else failExn (exnMessage e) (exnMessage e')
+  end
+end
+
+structure TermColor =
+struct
+  datatype color = Red | Green | Yellow | Normal
+
+  fun f Red    = "\027[31m"
+    | f Green  = "\027[32m"
+    | f Yellow = "\027[33m"
+    | f Normal = "\027[0m"
+
+  fun colorize color s = (f color) ^ s ^ (f Normal)
+
+  val redit = colorize Red
+
+  val greenit = colorize Green
+
+  val yellowit = colorize Yellow
+end
+
+structure Test =
+struct
+  datatype testnode = TestGroup of string * testnode list
+                    | Test of string * (unit -> Expect.expectation)
+
+  local
+    datatype evaluation = Success of string
+                        | Failure of string * string * string
+                        | Error of string * string
+
+    fun indent n s = (implode (List.tabulate (n, fn _ => #" "))) ^ s
+
+    fun fmt indentlvl ev =
+      let
+        val check = TermColor.greenit "\226\156\148 " (* ✔ *)
+        val cross = TermColor.redit "\226\156\150 "   (* ✖ *)
+        val indentlvl = indentlvl * 2
+      in
+      case ev of
+        Success descr => indent indentlvl (check ^ descr)
+      | Failure (descr, exp, got) =>
+          String.concatWith "\n" [indent indentlvl (cross ^ descr),
+                                  indent (indentlvl + 2) exp,
+                                  indent (indentlvl + 2) got]
+      | Error (descr, reason) =>
+          String.concatWith "\n" [indent indentlvl (cross ^ descr),
+                                  indent (indentlvl + 2) (TermColor.redit reason)]
+      end
+
+    fun eval (TestGroup _) = raise Fail "Only a 'Test' can be evaluated"
+      | eval (Test (descr, thunk)) =
+          (
+            case thunk () of
+              Expect.Pass   => ((1, 0, 0), Success descr)
+            | Expect.Fail (s, s') => ((0, 1, 0), Failure (descr, s, s'))
+          )
+          handle e => ((0, 0, 1), Error (descr, "Unexpected error: " ^ exnMessage e))
+
+    fun flatten depth testnode =
+      let
+        fun sum (x, y, z) (a, b, c) = (x + a, y + b, z + c)
+
+        fun aux (t, (counter, acc)) =
+          let
+            val (counter', texts) = flatten (depth + 1) t
+          in
+            (sum counter' counter, texts :: acc)
+          end
+      in
+        case testnode of
+          TestGroup (descr, ts) =>
+            let
+              val (counter, texts) = foldr aux ((0, 0, 0), []) ts
+            in
+              (counter, (indent (depth * 2) descr) :: List.concat texts)
+            end
+        | Test _ =>
+            let
+              val (counter, evaluation) = eval testnode
+            in
+              (counter, [fmt depth evaluation])
+            end
+      end
+    
+    fun println s = print (s ^ "\n")
+  in
+    fun run suite =
+      let
+        val ((succeeded, failed, errored), texts) = flatten 0 suite
+
+        val summary = String.concatWith ", " [
+          TermColor.greenit ((Int.toString succeeded) ^ " passed"),
+          TermColor.redit ((Int.toString failed) ^ " failed"),
+          TermColor.redit ((Int.toString errored) ^ " errored"),
+          (Int.toString (succeeded + failed + errored)) ^ " total"
+        ]
+        
+        val status = if failed = 0 andalso errored = 0
+                     then OS.Process.success
+                     else OS.Process.failure
+
+      in
+        List.app println texts;
+        println "";
+        println ("Tests: " ^ summary);
+        OS.Process.exit status
+      end
+  end
+end
+
+fun describe description tests = Test.TestGroup (description, tests)
+fun test description thunk = Test.Test (description, thunk)