Add sublist exercise (#75)

* Add sublist exercise

* Format config.json

* Add annotations

config.json

@@ -143,6 +143,14 @@
         "prerequisites": [],
         "difficulty": 2
       },
+      {
+        "slug": "sublist",
+        "name": "Sublist",
+        "uuid": "2b64b4ad-fdd6-47d0-b4b5-fb4b299816a6",
+        "practices": [],
+        "prerequisites": [],
+        "difficulty": 2
+      },
       {
         "slug": "sum-of-multiples",
         "name": "Sum of Multiples",

exercises/practice/sublist/.docs/instructions.md

@@ -0,0 +1,25 @@
+# Instructions
+
+Given any two lists `A` and `B`, determine if:
+
+- List `A` is equal to list `B`; or
+- List `A` contains list `B` (`A` is a superlist of `B`); or
+- List `A` is contained by list `B` (`A` is a sublist of `B`); or
+- None of the above is true, thus lists `A` and `B` are unequal
+
+Specifically, list `A` is equal to list `B` if both lists have the same values in the same order.
+List `A` is a superlist of `B` if `A` contains a sub-sequence of values equal to `B`.
+List `A` is a sublist of `B` if `B` contains a sub-sequence of values equal to `A`.
+
+Examples:
+
+- If `A = []` and `B = []` (both lists are empty), then `A` and `B` are equal
+- If `A = [1, 2, 3]` and `B = []`, then `A` is a superlist of `B`
+- If `A = []` and `B = [1, 2, 3]`, then `A` is a sublist of `B`
+- If `A = [1, 2, 3]` and `B = [1, 2, 3, 4, 5]`, then `A` is a sublist of `B`
+- If `A = [3, 4, 5]` and `B = [1, 2, 3, 4, 5]`, then `A` is a sublist of `B`
+- If `A = [3, 4]` and `B = [1, 2, 3, 4, 5]`, then `A` is a sublist of `B`
+- If `A = [1, 2, 3]` and `B = [1, 2, 3]`, then `A` and `B` are equal
+- If `A = [1, 2, 3, 4, 5]` and `B = [2, 3, 4]`, then `A` is a superlist of `B`
+- If `A = [1, 2, 4]` and `B = [1, 2, 3, 4, 5]`, then `A` and `B` are unequal
+- If `A = [1, 2, 3]` and `B = [1, 3, 2]`, then `A` and `B` are unequal

exercises/practice/sublist/.meta/Example.roc

@@ -0,0 +1,27 @@
+module [sublist]
+
+sublist : List a, List a -> [Equal, Sublist, Superlist, Unequal] where a implements Eq
+sublist = \list1, list2 ->
+    when List.len list1 |> Num.compare (List.len list2) is
+        GT ->
+            when list2 |> sublist list1 is
+                Sublist -> Superlist
+                Unequal -> Unequal
+                Superlist -> crash "Unreachable: list 2 is shorter than list 1"
+                Equal -> crash "Unreachable: list 1 and 2 don't have the same length"
+
+        EQ ->
+            if list1 == list2 then Equal else Unequal
+
+        LT ->
+            lengthDiff = List.len list2 - List.len list1
+            maybeEqualIndex =
+                List.range { start: At 0, end: At lengthDiff }
+                |> List.findFirst \start ->
+                    list2
+                    |> List.sublist { start, len: List.len list1 }
+                    |> Bool.isEq list1
+
+            when maybeEqualIndex is
+                Ok _ -> Sublist
+                Err NotFound -> Unequal

exercises/practice/sublist/.meta/config.json

@@ -0,0 +1,17 @@
+{
+  "authors": [
+    "ageron"
+  ],
+  "files": {
+    "solution": [
+      "Sublist.roc"
+    ],
+    "test": [
+      "sublist-test.roc"
+    ],
+    "example": [
+      ".meta/Example.roc"
+    ]
+  },
+  "blurb": "Write a function to determine if a list is a sublist of another list."
+}

exercises/practice/sublist/.meta/template.j2

@@ -0,0 +1,13 @@
+{%- import "generator_macros.j2" as macros with context -%}
+{{ macros.canonical_ref() }}
+{{ macros.header() }}
+
+import {{ exercise | to_pascal }} exposing [{{ cases[0]["property"] | to_camel }}]
+
+{% for case in cases -%}
+# {{ case["description"] }}
+expect
+    result = {{ case["input"]["listOne"] | to_roc }} |> {{ case["property"] | to_camel }} {{ case["input"]["listTwo"] | to_roc }}
+    result == {{ case["expected"] | to_pascal }}
+
+{% endfor %}

exercises/practice/sublist/.meta/tests.toml

@@ -0,0 +1,64 @@
+# 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.
+
+[97319c93-ebc5-47ab-a022-02a1980e1d29]
+description = "empty lists"
+
+[de27dbd4-df52-46fe-a336-30be58457382]
+description = "empty list within non empty list"
+
+[5487cfd1-bc7d-429f-ac6f-1177b857d4fb]
+description = "non empty list contains empty list"
+
+[1f390b47-f6b2-4a93-bc23-858ba5dda9a6]
+description = "list equals itself"
+
+[7ed2bfb2-922b-4363-ae75-f3a05e8274f5]
+description = "different lists"
+
+[3b8a2568-6144-4f06-b0a1-9d266b365341]
+description = "false start"
+
+[dc39ed58-6311-4814-be30-05a64bc8d9b1]
+description = "consecutive"
+
+[d1270dab-a1ce-41aa-b29d-b3257241ac26]
+description = "sublist at start"
+
+[81f3d3f7-4f25-4ada-bcdc-897c403de1b6]
+description = "sublist in middle"
+
+[43bcae1e-a9cf-470e-923e-0946e04d8fdd]
+description = "sublist at end"
+
+[76cf99ed-0ff0-4b00-94af-4dfb43fe5caa]
+description = "at start of superlist"
+
+[b83989ec-8bdf-4655-95aa-9f38f3e357fd]
+description = "in middle of superlist"
+
+[26f9f7c3-6cf6-4610-984a-662f71f8689b]
+description = "at end of superlist"
+
+[0a6db763-3588-416a-8f47-76b1cedde31e]
+description = "first list missing element from second list"
+
+[83ffe6d8-a445-4a3c-8795-1e51a95e65c3]
+description = "second list missing element from first list"
+
+[7bc76cb8-5003-49ca-bc47-cdfbe6c2bb89]
+description = "first list missing additional digits from second list"
+
+[0d7ee7c1-0347-45c8-9ef5-b88db152b30b]
+description = "order matters to a list"
+
+[5f47ce86-944e-40f9-9f31-6368aad70aa6]
+description = "same digits but different numbers"

exercises/practice/sublist/Sublist.roc

@@ -0,0 +1,5 @@
+module [sublist]
+
+sublist : List a, List a -> [Equal, Sublist, Superlist, Unequal] where a implements Eq
+sublist = \list1, list2 ->
+    crash "Please implement the 'sublist' function"

exercises/practice/sublist/sublist-test.roc

@@ -0,0 +1,102 @@
+# These tests are auto-generated with test data from:
+# https://github.com/exercism/problem-specifications/tree/main/exercises/sublist/canonical-data.json
+# File last updated on 2024-09-05
+app [main] {
+    pf: platform "https://github.com/roc-lang/basic-cli/releases/download/0.15.0/SlwdbJ-3GR7uBWQo6zlmYWNYOxnvo8r6YABXD-45UOw.tar.br",
+}
+
+main =
+    Task.ok {}
+
+import Sublist exposing [sublist]
+
+# empty lists
+expect
+    result = [] |> sublist []
+    result == Equal
+
+# empty list within non empty list
+expect
+    result = [] |> sublist [1, 2, 3]
+    result == Sublist
+
+# non empty list contains empty list
+expect
+    result = [1, 2, 3] |> sublist []
+    result == Superlist
+
+# list equals itself
+expect
+    result = [1, 2, 3] |> sublist [1, 2, 3]
+    result == Equal
+
+# different lists
+expect
+    result = [1, 2, 3] |> sublist [2, 3, 4]
+    result == Unequal
+
+# false start
+expect
+    result = [1, 2, 5] |> sublist [0, 1, 2, 3, 1, 2, 5, 6]
+    result == Sublist
+
+# consecutive
+expect
+    result = [1, 1, 2] |> sublist [0, 1, 1, 1, 2, 1, 2]
+    result == Sublist
+
+# sublist at start
+expect
+    result = [0, 1, 2] |> sublist [0, 1, 2, 3, 4, 5]
+    result == Sublist
+
+# sublist in middle
+expect
+    result = [2, 3, 4] |> sublist [0, 1, 2, 3, 4, 5]
+    result == Sublist
+
+# sublist at end
+expect
+    result = [3, 4, 5] |> sublist [0, 1, 2, 3, 4, 5]
+    result == Sublist
+
+# at start of superlist
+expect
+    result = [0, 1, 2, 3, 4, 5] |> sublist [0, 1, 2]
+    result == Superlist
+
+# in middle of superlist
+expect
+    result = [0, 1, 2, 3, 4, 5] |> sublist [2, 3]
+    result == Superlist
+
+# at end of superlist
+expect
+    result = [0, 1, 2, 3, 4, 5] |> sublist [3, 4, 5]
+    result == Superlist
+
+# first list missing element from second list
+expect
+    result = [1, 3] |> sublist [1, 2, 3]
+    result == Unequal
+
+# second list missing element from first list
+expect
+    result = [1, 2, 3] |> sublist [1, 3]
+    result == Unequal
+
+# first list missing additional digits from second list
+expect
+    result = [1, 2] |> sublist [1, 22]
+    result == Unequal
+
+# order matters to a list
+expect
+    result = [1, 2, 3] |> sublist [3, 2, 1]
+    result == Unequal
+
+# same digits but different numbers
+expect
+    result = [1, 0, 1] |> sublist [10, 1]
+    result == Unequal
+