Bottle song

bin/add-practice-exercise

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+# Synopsis:
+# Scaffold the files for a new practice exercise.
+# After creating the exercise, follow the instructions in the output.
+
+# Example:
+# bin/add-practice-exercise two-fer
+
+# Example with difficulty:
+# bin/add-practice-exercise -d 5 two-fer
+
+# Example with author and difficulty:
+# bin/add-practice-exercise -a foo -d 3 two-fer
+
+set -euo pipefail
+scriptname=$0
+
+help_and_exit() {
+    echo >&2 "Scaffold the files for a new practice exercise."
+    echo >&2 "Usage: ${scriptname} [-h] [-a author] [-d difficulty] <exercise-slug>"
+    echo >&2 "Where: author is the GitHub username of the exercise creator."
+    echo >&2 "Where: difficulty is between 1 (easiest) to 10 (hardest)."
+    exit 1
+}
+
+die() { echo >&2 "$*"; exit 1; }
+
+required_tool() {
+    command -v "${1}" >/dev/null 2>&1 ||
+        die "${1} is required but not installed. Please install it and make sure it's in your PATH."
+}
+
+require_files_template() {
+    jq -e --arg key "${1}" '.files[$key] | length > 0' config.json > /dev/null ||
+        die "The '.files.${1}' array in the 'config.json' file is empty. Please add at least one file. See https://exercism.org/docs/building/tracks/config-json#h-files for more information."
+}
+
+required_tool jq
+
+require_files_template "solution"
+require_files_template "test"
+require_files_template "example"
+
+[[ -f ./bin/fetch-configlet ]] || die "Run this script from the repo's root directory."
+
+author=''
+difficulty='1'
+while getopts :ha:d: opt; do
+    case $opt in
+        h) help_and_exit ;;
+        a) author=$OPTARG ;;
+        d) difficulty=$OPTARG ;;
+        ?) echo >&2 "Unknown option: -$OPTARG"; help_and_exit ;;
+    esac
+done
+shift "$((OPTIND - 1))"
+
+(( $# >= 1 )) || help_and_exit
+
+slug="${1}"
+
+if [[ -z "${author}" ]]; then
+    read -rp 'Your GitHub username: ' author
+fi
+
+./bin/fetch-configlet
+./bin/configlet create --practice-exercise "${slug}" --author "${author}" --difficulty "${difficulty}"
+
+exercise_dir="exercises/practice/${slug}"
+files=$(jq -r --arg dir "${exercise_dir}" '.files | to_entries | map({key: .key, value: (.value | map("'"'"'" + $dir + "/" + . + "'"'"'") | join(" and "))}) | from_entries' "${exercise_dir}/.meta/config.json")
+
+cat << NEXT_STEPS
+
+Your next steps are:
+- Create the test suite in $(jq -r '.test' <<< "${files}")
+  - The tests should be based on the canonical data at 'https://github.com/exercism/problem-specifications/blob/main/exercises/${slug}/canonical-data.json'
+  - Any test cases you don't implement, mark them in 'exercises/practice/${slug}/.meta/tests.toml' with "include = false"
+- Create the example solution in $(jq -r '.example' <<< "${files}")
+- Verify the example solution passes the tests by running 'bin/verify-exercises ${slug}'
+- Create the stub solution in $(jq -r '.solution' <<< "${files}")
+- Update the 'difficulty' value for the exercise's entry in the 'config.json' file in the repo's root
+- Validate CI using 'bin/configlet lint' and 'bin/configlet fmt'
+NEXT_STEPS

config.json

@@ -1282,6 +1282,20 @@
         "practices": [],
         "prerequisites": [],
         "difficulty": 3
+      },
+      {
+        "slug": "bottle-song",
+        "name": "Bottle Song",
+        "uuid": "0c786feb-8653-4215-9281-2e1c83afeefe",
+        "practices": [],
+        "prerequisites": [],
+        "difficulty": 3,
+        "topics": [
+          "algorithms",
+          "control_flow",
+          "strings",
+          "text_formatting"
+        ]
       }
     ]
   },

exercises/practice/bottle-song/.docs/instructions.md

@@ -0,0 +1,57 @@
+# Instructions
+
+Recite the lyrics to that popular children's repetitive song: Ten Green Bottles.
+
+Note that not all verses are identical.
+
+```text
+Ten green bottles hanging on the wall,
+Ten green bottles hanging on the wall,
+And if one green bottle should accidentally fall,
+There'll be nine green bottles hanging on the wall.
+
+Nine green bottles hanging on the wall,
+Nine green bottles hanging on the wall,
+And if one green bottle should accidentally fall,
+There'll be eight green bottles hanging on the wall.
+
+Eight green bottles hanging on the wall,
+Eight green bottles hanging on the wall,
+And if one green bottle should accidentally fall,
+There'll be seven green bottles hanging on the wall.
+
+Seven green bottles hanging on the wall,
+Seven green bottles hanging on the wall,
+And if one green bottle should accidentally fall,
+There'll be six green bottles hanging on the wall.
+
+Six green bottles hanging on the wall,
+Six green bottles hanging on the wall,
+And if one green bottle should accidentally fall,
+There'll be five green bottles hanging on the wall.
+
+Five green bottles hanging on the wall,
+Five green bottles hanging on the wall,
+And if one green bottle should accidentally fall,
+There'll be four green bottles hanging on the wall.
+
+Four green bottles hanging on the wall,
+Four green bottles hanging on the wall,
+And if one green bottle should accidentally fall,
+There'll be three green bottles hanging on the wall.
+
+Three green bottles hanging on the wall,
+Three green bottles hanging on the wall,
+And if one green bottle should accidentally fall,
+There'll be two green bottles hanging on the wall.
+
+Two green bottles hanging on the wall,
+Two green bottles hanging on the wall,
+And if one green bottle should accidentally fall,
+There'll be one green bottle hanging on the wall.
+
+One green bottle hanging on the wall,
+One green bottle hanging on the wall,
+And if one green bottle should accidentally fall,
+There'll be no green bottles hanging on the wall.
+```

exercises/practice/bottle-song/.meta/Example.scala

@@ -0,0 +1,17 @@
+object BottleSong:
+  private val numbers = List("no", "One", "Two", "Three", "Four", "Five", "Six", "Seven", "Eight", "Nine", "Ten")
+
+  private def suffix(bottles: Int) = if bottles == 1 then "" else "s"
+
+  private def hanging(bottles: Int) =
+    s"${numbers(bottles)} green bottle${suffix(bottles)} hanging on the wall"
+
+  private def firstLine(bottles: Int) = hanging(bottles) + ",\n"
+
+  private def lastLine(bottles: Int) = "There'll be " + hanging(bottles).toLowerCase + ".\n"
+
+  private def verse(bottles: Int) = firstLine(bottles).repeat(2) +
+    "And if one green bottle should accidentally fall,\n" + lastLine(bottles - 1)
+
+  def recite(startBottles: Int, takeDown: Int): String =
+    startBottles until startBottles - takeDown by -1 map verse mkString "\n"

exercises/practice/bottle-song/.meta/config.json

@@ -0,0 +1,19 @@
+{
+  "authors": [
+    "rabestro"
+  ],
+  "files": {
+    "solution": [
+      "src/main/scala/BottleSong.scala"
+    ],
+    "test": [
+      "src/test/scala/BottleSongTest.scala"
+    ],
+    "example": [
+      ".meta/Example.scala"
+    ]
+  },
+  "blurb": "Produce the lyrics to the popular children's repetitive song: Ten Green Bottles.",
+  "source": "Wikipedia",
+  "source_url": "https://en.wikipedia.org/wiki/Ten_Green_Bottles"
+}

exercises/practice/bottle-song/.meta/tests.toml

@@ -0,0 +1,31 @@
+# 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.
+
+[d4ccf8fc-01dc-48c0-a201-4fbeb30f2d03]
+description = "verse -> single verse -> first generic verse"
+
+[0f0aded3-472a-4c64-b842-18d4f1f5f030]
+description = "verse -> single verse -> last generic verse"
+
+[f61f3c97-131f-459e-b40a-7428f3ed99d9]
+description = "verse -> single verse -> verse with 2 bottles"
+
+[05eadba9-5dbd-401e-a7e8-d17cc9baa8e0]
+description = "verse -> single verse -> verse with 1 bottle"
+
+[a4a28170-83d6-4dc1-bd8b-319b6abb6a80]
+description = "lyrics -> multiple verses -> first two verses"
+
+[3185d438-c5ac-4ce6-bcd3-02c9ff1ed8db]
+description = "lyrics -> multiple verses -> last three verses"
+
+[28c1584a-0e51-4b65-9ae2-fbc0bf4bbb28]
+description = "lyrics -> multiple verses -> all verses"

exercises/practice/bottle-song/build.sbt

@@ -0,0 +1,3 @@
+scalaVersion := "3.4.2"
+
+libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.19" % Test

exercises/practice/bottle-song/project/build.properties

@@ -0,0 +1 @@
+sbt.version=1.10.1

exercises/practice/bottle-song/src/test/scala/BottleSongTest.scala

@@ -0,0 +1,134 @@
+import org.scalatest.funsuite.AnyFunSuite
+import org.scalatest.matchers.should.Matchers
+
+class BottleSongTest extends AnyFunSuite with Matchers {
+
+  test("first generic verse") {
+    BottleSong.recite(10, 1) shouldBe
+      """Ten green bottles hanging on the wall,
+        |Ten green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be nine green bottles hanging on the wall.
+        |""".stripMargin.trim + "\n"
+  }
+
+  test("last generic verse") {
+    pending
+    BottleSong.recite(3, 1) shouldBe
+      """Three green bottles hanging on the wall,
+        |Three green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be two green bottles hanging on the wall.
+        |""".stripMargin.trim + "\n"
+  }
+
+  test("verse with two bottles") {
+    pending
+    BottleSong.recite(2, 1) shouldBe
+      """Two green bottles hanging on the wall,
+        |Two green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be one green bottle hanging on the wall.
+        |""".stripMargin.trim + "\n"
+  }
+
+  test("verse with one bottle") {
+    pending
+    BottleSong.recite(1, 1) shouldBe
+      """One green bottle hanging on the wall,
+        |One green bottle hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be no green bottles hanging on the wall.
+        |""".stripMargin.trim + "\n"
+  }
+
+  test("first two verses") {
+    pending
+    BottleSong.recite(10, 2) shouldBe
+      """Ten green bottles hanging on the wall,
+        |Ten green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be nine green bottles hanging on the wall.
+        |
+        |Nine green bottles hanging on the wall,
+        |Nine green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be eight green bottles hanging on the wall.
+        |""".stripMargin.trim + "\n"
+  }
+
+  test("last three verses") {
+    pending
+    BottleSong.recite(3, 3) shouldBe
+      """Three green bottles hanging on the wall,
+        |Three green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be two green bottles hanging on the wall.
+        |
+        |Two green bottles hanging on the wall,
+        |Two green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be one green bottle hanging on the wall.
+        |
+        |One green bottle hanging on the wall,
+        |One green bottle hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be no green bottles hanging on the wall.
+        |""".stripMargin.trim + "\n"
+  }
+
+  test("all verses") {
+    pending
+    BottleSong.recite(10, 10) shouldBe
+      """Ten green bottles hanging on the wall,
+        |Ten green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be nine green bottles hanging on the wall.
+        |
+        |Nine green bottles hanging on the wall,
+        |Nine green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be eight green bottles hanging on the wall.
+        |
+        |Eight green bottles hanging on the wall,
+        |Eight green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be seven green bottles hanging on the wall.
+        |
+        |Seven green bottles hanging on the wall,
+        |Seven green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be six green bottles hanging on the wall.
+        |
+        |Six green bottles hanging on the wall,
+        |Six green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be five green bottles hanging on the wall.
+        |
+        |Five green bottles hanging on the wall,
+        |Five green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be four green bottles hanging on the wall.
+        |
+        |Four green bottles hanging on the wall,
+        |Four green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be three green bottles hanging on the wall.
+        |
+        |Three green bottles hanging on the wall,
+        |Three green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be two green bottles hanging on the wall.
+        |
+        |Two green bottles hanging on the wall,
+        |Two green bottles hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be one green bottle hanging on the wall.
+        |
+        |One green bottle hanging on the wall,
+        |One green bottle hanging on the wall,
+        |And if one green bottle should accidentally fall,
+        |There'll be no green bottles hanging on the wall.
+        |""".stripMargin.trim + "\n"
+  }
+}