Use property as fn name if there is canonical data, use slug if there isn't

Author: dem4ron

.gitignore

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

bin/generator-utils/fetch_canonical_data renamed to bin/fetch_canonical_data

@@ -1,7 +1,8 @@
 #!/usr/bin/env bash
+# This script fetches the canonical data of the exercise.
 
 if [ $# -ne 1 ]; then
-  echo "Usage: bin/generator-utils/fetch_canonical_data <exercise-slug>"
+  echo "Usage: bin/fetch_canonical_data <exercise-slug>"
   exit 1
 fi
 

bin/generate_practice_exercise.sh renamed to bin/generate_practice_exercise

@@ -36,6 +36,19 @@ 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")
@@ -52,9 +65,9 @@ cargo new --lib "$EXERCISE_DIR" -q
 mkdir -p "$EXERCISE_DIR"/tests
 touch "${EXERCISE_DIR}/tests/${SLUG}.rs"
 
-create_test_file_template "$EXERCISE_DIR" "$SLUG"
-create_lib_rs_template "$EXERCISE_DIR" "$SLUG"
-create_example_rs_template "$EXERCISE_DIR" "$SLUG"
+create_test_file_template "$EXERCISE_DIR" "$SLUG" "$HAS_CANONICAL_DATA"
+create_lib_rs_template "$EXERCISE_DIR" "$SLUG" "$HAS_CANONICAL_DATA"
+create_example_rs_template "$EXERCISE_DIR" "$SLUG" "$HAS_CANONICAL_DATA"
 overwrite_gitignore "$EXERCISE_DIR"
 
 message "success" "Created Rust files succesfully!"

bin/generate_tests

@@ -1,10 +1,11 @@
 #!/usr/bin/env bash
 
+set -euo pipefail
 # shellcheck source=/dev/null
 source ./bin/generator-utils/utils.sh
 
 function digest_template() {
-  template=$(cat bin/generator-utils/test_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'

bin/generator-utils/templates.sh

@@ -6,6 +6,7 @@ source ./bin/generator-utils/utils.sh
 function create_test_file_template() {
     local exercise_dir=$1
     local slug=$2
+    local has_canonical_data=$3
     local test_file="${exercise_dir}/tests/${slug}.rs"
 
     cat <<EOT >"$test_file"
@@ -14,11 +15,7 @@ use $(dash_to_underscore "$slug")::*;
 
 EOT
 
-    canonical_json=$(bin/generator-utils/fetch_canonical_data "$slug")
-    echo "$canonical_json" >canonical_data.json
-
-    if [ "${canonical_json}" == "404: Not Found" ]; then
-        canonical_json=$(jq --null-input '{cases: []}')
+    if [ "$has_canonical_data" == false ]; then
 
         cat <<EOT >>"$test_file"
 // As there isn't a canonical data file for this exercise, you will need to craft your own tests.
@@ -28,6 +25,8 @@ EOT
         message "info" "This exercise doesn't have canonical data."
         message "success" "Stub file for tests has been created!"
     else
+        canonical_json=$(cat canonical_data.json)
+
         # sometimes canonical data has multiple levels with multiple `cases` arrays.
         #(see kindergarten-garden https://github.com/exercism/problem-specifications/blob/main/exercises/kindergarten-garden/canonical-data.json)
         # so let's flatten it
@@ -64,6 +63,8 @@ EOT
 function create_lib_rs_template() {
     local exercise_dir=$1
     local slug=$2
+    local has_canonical_data=$3
+    fn_name=$(create_fn_name "$slug" "$has_canonical_data")
     cat <<EOT >"${exercise_dir}/src/lib.rs"
 pub fn $(dash_to_underscore "$slug")() {
     unimplemented!("implement ${slug} exercise")
@@ -88,15 +89,33 @@ EOT
 }
 
 function create_example_rs_template() {
-    exercise_dir=$1
-    slug=$2
+    local exercise_dir=$1
+    local slug=$2
+    local has_canonical_data=$3
+
+    fn_name=$(create_fn_name "$slug" "$has_canonical_data")
+
     mkdir "${exercise_dir}/.meta"
     cat <<EOT >"${exercise_dir}/.meta/example.rs"
-pub fn $(dash_to_underscore "$slug")() {
+pub fn ${fn_name}() {
    // TODO: Create a solution that passes all the tests
    unimplemented!("implement ${slug} exercise")
 }
 
 EOT
     message "success" "Stub file for example.rs has been created!"
 }
+
+function create_fn_name() {
+    slug=$1
+    has_canonical_data=$2
+
+    if [ "$has_canonical_data" == true ]; then
+        fn_name=$(dash_to_underscore "$slug")
+    else
+        fn_name=$(jq -r 'first(.. | .property? // empty)' canonical_data.json)
+    fi
+
+    echo "$fn_name"
+
+}

bin/generator-utils/utils.sh

@@ -10,6 +10,7 @@ function message() {
     case "$flag" in
     "success") printf "${GREEN}%s${RESET}\n" "[success]: $message" ;;
     "info") printf "${BLUE}%s${RESET}\n" "[info]: $message" ;;
+    "warning") printf "${YELLOW}%s${RESET}\n" "[warning]: $message" ;;
     "error") printf "${RED}%s${RESET}\n" "[error]: $message" ;;
     "done")
         echo