Add script to help add new practice exercise (#1635)

Add a `bin/add_practice_exercise <slug>` script that helps with adding a new practice exercise.

The script will:
1. Add an entry to the `config.json`'s `exercises.practice[]` array
2. Create exercism-specific files, like `.meta/config.json` and the documentation
3. Create Rust-specific files, like `Cargo.toml` and `src/lib.rb`
4. Create a tests files with functions for the tests cases as defined in the exercise's canonical data

Author: dem4ron

.github/workflows/tests.yml

@@ -123,20 +123,12 @@ jobs:
         run: ./_test/check_exercises.sh
         continue-on-error: ${{ matrix.rust == 'beta' && matrix.deny_warnings == '1' }}
 
-      - name: Cargo clean (to prevent previous compilation from unintentionally interfering with later ones)
-        run: ./_test/cargo_clean_all.sh
-
       - name: Ensure stubs compile
         env:
           DENYWARNINGS: ${{ matrix.deny_warnings }}
         run: ./_test/ensure_stubs_compile.sh
         continue-on-error: ${{ matrix.rust == 'beta' && matrix.deny_warnings == '1' }}
 
-      - name: Check exercise crate
-        env:
-          DENYWARNINGS: ${{ matrix.deny_warnings }}
-        run: ./_test/check_exercise_crate.sh
-        continue-on-error: ${{ matrix.rust == 'beta' && matrix.deny_warnings == '1' }}
 
   rustformat:
     name: Check Rust Formatting

.gitignore

@@ -7,5 +7,8 @@ bin/configlet
 bin/configlet.exe
 bin/exercise
 bin/exercise.exe
+bin/generator-utils/ngram
 exercises/*/*/Cargo.lock
 exercises/*/*/clippy.log
+canonical_data.json
+.vscode

_test/cargo_clean_all.sh

@@ -0,0 +1,101 @@
+#!/usr/bin/env bash
+
+# shellcheck source=/dev/null
+source ./bin/generator-utils/utils.sh
+source ./bin/generator-utils/prompts.sh
+source ./bin/generator-utils/templates.sh
+
+# Exit if anything fails.
+set -euo pipefail
+
+# If argument not provided, print usage and exit
+if [ $# -ne 1 ] && [ $# -ne 2 ] && [ $# -ne 3 ]; then
+    echo "Usage: bin/add_practice_exercise <exercise-slug> [difficulty] [author-github-handle]"
+    exit 1
+fi
+
+# Check if sed is gnu-sed
+if ! sed --version | grep -q "GNU sed"; then
+    echo "GNU sed is required. Please install it and make sure it's in your PATH."
+    exit 1
+fi
+
+# Check if jq and curl are installed
+command -v jq >/dev/null 2>&1 || {
+    echo >&2 "jq is required but not installed. Please install it and make sure it's in your PATH."
+    exit 1
+}
+command -v curl >/dev/null 2>&1 || {
+    echo >&2 "curl is required but not installed. Please install it and make sure it's in your PATH."
+    exit 1
+}
+
+# Check if exercise exists in configlet info or in config.json
+check_exercise_existence "$1"
+
+# ==================================================
+
+SLUG="$1"
+HAS_CANONICAL_DATA=true
+# Fetch canonical data
+canonical_json=$(bin/fetch_canonical_data "$SLUG")
+
+if [ "${canonical_json}" == "404: Not Found" ]; then
+    HAS_CANONICAL_DATA=false
+    message "warning" "This exercise doesn't have canonical data"
+
+else
+    echo "$canonical_json" >canonical_data.json
+    message "success" "Fetched canonical data successfully!"
+fi
+
+UNDERSCORED_SLUG=$(dash_to_underscore "$SLUG")
+EXERCISE_DIR="exercises/practice/${SLUG}"
+EXERCISE_NAME=$(format_exercise_name "$SLUG")
+message "info" "Using ${YELLOW}${EXERCISE_NAME}${BLUE} as a default exercise name. You can edit this later in the config.json file"
+# using default value for difficulty
+EXERCISE_DIFFICULTY=$(validate_difficulty_input "${2:-$(get_exercise_difficulty)}")
+message "info" "The exercise difficulty has been set to ${YELLOW}${EXERCISE_DIFFICULTY}${BLUE}. You can edit this later in the config.json file"
+# using default value for author
+AUTHOR_HANDLE=${3:-$(get_author_handle)}
+message "info" "Using ${YELLOW}${AUTHOR_HANDLE}${BLUE} as author's handle. You can edit this later in the 'authors' field in the ${EXERCISE_DIR}/.meta/config.json file"
+
+
+create_rust_files "$EXERCISE_DIR" "$SLUG" "$HAS_CANONICAL_DATA"
+
+
+# ==================================================
+
+# build configlet
+./bin/fetch-configlet
+message "success" "Fetched configlet successfully!"
+
+# Preparing config.json
+message "info" "Adding instructions and configuration files..."
+UUID=$(bin/configlet uuid)
+
+jq --arg slug "$SLUG" --arg uuid "$UUID" --arg name "$EXERCISE_NAME" --arg difficulty "$EXERCISE_DIFFICULTY" \
+    '.exercises.practice += [{slug: $slug, name: $name, uuid: $uuid, practices: [], prerequisites: [], difficulty: $difficulty}]' \
+    config.json >config.json.tmp
+# jq always rounds whole numbers, but average_run_time needs to be a float
+sed -i 's/"average_run_time": \([0-9]\+\)$/"average_run_time": \1.0/' config.json.tmp
+mv config.json.tmp config.json
+message "success" "Added instructions and configuration files"
+
+# Create instructions and config files
+echo "Creating instructions and config files"
+./bin/configlet sync --update --yes --docs --metadata --exercise "$SLUG"
+./bin/configlet sync --update --yes --filepaths --exercise "$SLUG"
+./bin/configlet sync --update --tests include --exercise "$SLUG"
+message "success" "Created instructions and config files"
+
+META_CONFIG="$EXERCISE_DIR"/.meta/config.json
+jq --arg author "$AUTHOR_HANDLE" '.authors += [$author]' "$META_CONFIG" >"$META_CONFIG".tmp && mv "$META_CONFIG".tmp "$META_CONFIG"
+message "success" "You've been added as the author of this exercise."
+
+sed -i "s/name = \".*\"/name = \"$UNDERSCORED_SLUG\"/" "$EXERCISE_DIR"/Cargo.toml
+
+message "done" "All stub files were created."
+
+message "info" "After implementing the solution, tests and configuration, please run:"
+echo "./bin/configlet fmt --update --yes --exercise ${SLUG}"

_test/check_exercise_crate.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+# This script fetches the canonical data of the exercise.
+
+if [ $# -ne 1 ]; then
+  echo "Usage: bin/fetch_canonical_data <exercise-slug>"
+  exit 1
+fi
+
+# check if curl is installed
+command -v curl >/dev/null 2>&1 || {
+  echo >&2 "curl is required but not installed. Please install it and make sure it's in your PATH."
+  exit 1
+}
+
+slug=$1
+
+curlopts=(
+  --silent
+  --retry 3
+  --max-time 4
+)
+curl "${curlopts[@]}" "https://raw.githubusercontent.com/exercism/problem-specifications/main/exercises/${slug}/canonical-data.json"

bin/add_practice_exercise

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+# shellcheck source=/dev/null
+source ./bin/generator-utils/utils.sh
+
+function digest_template() {
+  template=$(cat bin/test_template)
+  # shellcheck disable=SC2001
+  # turn every token into a jq command
+  echo "$template" | sed 's/${\([^}]*\)\}\$/$(echo $case | jq -r '\''.\1'\'')/g'
+}
+
+message "info" "Generating tests.."
+canonical_json=$(cat canonical_data.json)
+SLUG=$(echo "$canonical_json" | jq '.exercise')
+# shellcheck disable=SC2001
+# Remove double quotes
+SLUG=$(echo "$SLUG" | sed 's/"//g')
+EXERCISE_DIR="exercises/practice/$SLUG"
+TEST_FILE="$EXERCISE_DIR/tests/$SLUG.rs"
+
+cat <<EOT >"$TEST_FILE"
+use $(dash_to_underscore "$SLUG")::*;
+// Add tests here
+
+EOT
+
+# Flattens canonical json, extracts only the objects with a uuid
+cases=$(echo "$canonical_json" | jq '[ .. | objects | with_entries(select(.key | IN("uuid", "description", "input", "expected", "property"))) | select(. != {}) | select(has("uuid")) ]')
+
+# shellcheck disable=SC2034
+jq -c '.[]' <<<"$cases" | while read -r case; do
+
+  # Evaluate the bash parts and replace them with their return values
+  eval_template="$(digest_template | sed -e "s/\$(\(.*\))/\$\(\1\)/g")"
+  eval_template="$(eval "echo \"$eval_template\"")"
+
+  # Turn function name unto snake_case
+  formatted_template=$(echo "$eval_template" | sed -e ':loop' -e 's/\(fn[^(]*\)[ -]/\1_/g' -e 't loop' | sed 's/fn_/fn /')
+  # Push to file
+
+  echo "$formatted_template" >>"$TEST_FILE"
+  printf "\\n" >>"$TEST_FILE"
+
+done
+
+rustfmt "$TEST_FILE"
+
+message "success" "Generated tests successfully! Check out ${TEST_FILE}"

bin/fetch_canonical_data

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+# shellcheck disable=SC2034
+# Reset
+RESET=$(echo -e '\033[0m')
+
+# Regular Colors
+BLACK=$(echo -e '\033[0;30m')
+RED=$(echo -e '\033[0;31m')
+GREEN=$(echo -e '\033[0;32m')
+YELLOW=$(echo -e '\033[0;33m')
+BLUE=$(echo -e '\033[0;34m')
+PURPLE=$(echo -e '\033[0;35m')
+CYAN=$(echo -e '\033[0;36m')
+WHITE=$(echo -e '\033[0;37m')
+
+# Bold
+BOLD_BLACK=$(echo -e '\033[1;30m')
+BOLD_RED=$(echo -e '\033[1;31m')
+BOLD_GREEN=$(echo -e '\033[1;32m')
+BOLD_YELLOW=$(echo -e '\033[1;33m')
+BOLD_BLUE=$(echo -e '\033[1;34m')
+BOLD_PURPLE=$(echo -e '\033[1;35m')
+BOLD_CYAN=$(echo -e '\033[1;36m')
+BOLD_WHITE=$(echo -e '\033[1;37m')
+
+# Underline
+UNDERLINE=$(echo -e ='\033[4m')
+
+# Background
+BG_BLACK=$(echo -e ='\033[40m')
+BG_RED=$(echo -e ='\033[41m')
+BG_GREEN=$(echo -e ='\033[42m')
+BG_YELLOW=$(echo -e ='\033[43m')
+BG_BLUE=$(echo -e ='\033[44m')
+BG_PURPLE=$(echo -e ='\033[45m')
+BG_CYAN=$(echo -e ='\033[46m')
+BG_WHITE=$(echo -e ='\033[47m')

bin/generate_tests

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+# shellcheck source=/dev/null
+source ./bin/generator-utils/colors.sh
+
+function get_exercise_difficulty() {
+    read -rp "Difficulty of exercise (1-10): " exercise_difficulty
+    echo "$exercise_difficulty"
+}
+
+function validate_difficulty_input() {
+
+    valid_input=false
+    while ! $valid_input; do
+        if [[ "$1" =~ ^[1-9]$|^10$ ]]; then
+            exercise_difficulty=$1
+            valid_input=true
+        else
+            read -rp "${RED}Invalid input. ${RESET}Please enter an integer between 1 and 10. " exercise_difficulty
+            [[ "$exercise_difficulty" =~ ^[1-9]$|^10$ ]] && valid_input=true
+
+        fi
+    done
+    echo "$exercise_difficulty"
+}
+
+function get_author_handle {
+    DEFAULT_AUTHOR_HANDLE="$(git config user.name)"
+
+    if [ -z "$DEFAULT_AUTHOR_HANDLE" ]; then
+        read -rp "Hey! Couldn't find your Github handle. Add it now or skip with enter and add it later in the .meta.config.json file: " AUTHOR_HANDLE
+    else
+        AUTHOR_HANDLE="$DEFAULT_AUTHOR_HANDLE"
+
+    fi
+    echo "$AUTHOR_HANDLE"
+
+}