Merge branch 'main' into stub-generator-patch

Author: dem4ron

bin/add_practice_exercise

@@ -1,8 +1,10 @@
 #!/usr/bin/env bash
 
+
 # shellcheck source=./generator-utils/utils.sh 
 # shellcheck source=./generator-utils/prompts.sh 
 # shellcheck source=./generator-utils/templates.sh 
+
 source ./bin/generator-utils/utils.sh
 source ./bin/generator-utils/prompts.sh
 source ./bin/generator-utils/templates.sh
@@ -37,20 +39,23 @@ check_exercise_existence "$1"
 
 # ==================================================
 
+
 slug="$1"
 # Fetch canonical data
 canonical_json=$(bin/fetch_canonical_data "$slug")
 
 has_canonical_data=true
 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")
@@ -67,15 +72,18 @@ 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)
 
 # Add exercise-data to global config.json
 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
@@ -85,6 +93,7 @@ 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"
@@ -97,7 +106,10 @@ 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}"
+

bin/fetch_canonical_data

@@ -1,9 +1,11 @@
 #!/usr/bin/env bash
 # This script fetches the canonical data of the exercise.
 
+
 # Exit if anything fails.
 set -euo pipefail
 
+
 if [ $# -ne 1 ]; then
   echo "Usage: bin/fetch_canonical_data <exercise-slug>"
   exit 1

bin/generate_tests

@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
 
+
 # Exit if anything fails.
 set -euo pipefail
 
@@ -11,11 +12,13 @@ digest_template() {
   local template
   template=$(cat bin/test_template)
   # 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')
 # Remove double quotes
 slug=$(echo "$slug" | sed 's/"//g')
@@ -24,21 +27,25 @@ 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 doesn't recognize that `case` is not unused
+
 # 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 into snake_case
   formatted_template=$(echo "$eval_template" | sed -e ':loop' -e 's/\(fn[^(]*\)[ -]/\1_/g' -e 't loop' | sed 's/fn_/fn /')
 
@@ -51,3 +58,4 @@ done
 rustfmt "$test_file"
 
 message "success" "Generated tests successfully! Check out ${test_file}"
+

bin/generator-utils/prompts.sh

@@ -1,13 +1,16 @@
 #!/usr/bin/env bash
 
+
 # shellcheck source=./colors.sh
 source ./bin/generator-utils/colors.sh
 
 get_exercise_difficulty() {
+
     read -rp "Difficulty of exercise (1-10): " exercise_difficulty
     echo "$exercise_difficulty"
 }
 
+
 validate_difficulty_input() {
 
     local valid_input=false
@@ -17,13 +20,15 @@ validate_difficulty_input() {
             local valid_input=true
         else
             read -rp "${red}Invalid input. ${reset_color}Please enter an integer between 1 and 10. " exercise_difficulty
+
             [[ "$exercise_difficulty" =~ ^[1-9]$|^10$ ]] && valid_input=true
 
         fi
     done
     echo "$exercise_difficulty"
 }
 
+
 get_author_handle() {
     local default_author_handle
     default_author_handle="$(git config user.name)"
@@ -35,5 +40,4 @@ get_author_handle() {
 
     fi
     echo "$author_handle"
-
 }

bin/generator-utils/templates.sh

@@ -10,6 +10,7 @@ create_fn_name() {
     if [ "$has_canonical_data" == false ]; then
         fn_name=$(dash_to_underscore "$slug")
         local fn_name
+
     else
         fn_name=$(jq -r 'first(.. | .property? // empty)' canonical_data.json)
     fi
@@ -19,6 +20,7 @@ create_fn_name() {
 }
 
 create_test_file_template() {
+
     local exercise_dir=$1
     local slug=$2
     local has_canonical_data=$3
@@ -40,15 +42,19 @@ EOT
         message "info" "This exercise doesn't have canonical data."
         message "success" "Stub file for tests has been created!"
     else
+
         local canonical_json
+
         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
+
         local cases
         cases=$(echo "$canonical_json" | jq '[ .. | objects | with_entries(select(.key | IN("uuid", "description", "input", "expected"))) | select(. != {}) | select(has("uuid")) ]')
         local fn_name
+
         fn_name=$(echo "$canonical_json" | jq -r 'first(.. | .property? // empty)')
 
         first_iteration=true
@@ -83,6 +89,7 @@ create_lib_rs_template() {
     local slug=$2
     local has_canonical_data=$3
     local fn_name
+
     fn_name=$(create_fn_name "$slug" "$has_canonical_data")
     cat <<EOT >"${exercise_dir}/src/lib.rs"
 pub fn ${fn_name}() {
@@ -93,6 +100,7 @@ EOT
 }
 
 overwrite_gitignore() {
+
     local exercise_dir=$1
     cat <<EOT >"$exercise_dir"/.gitignore
 # Generated by Cargo
@@ -107,12 +115,16 @@ EOT
     message "success" ".gitignore has been overwritten!"
 }
 
+
 create_example_rs_template() {
+
     local exercise_dir=$1
     local slug=$2
     local has_canonical_data=$3
 
+
     local fn_name
+
     fn_name=$(create_fn_name "$slug" "$has_canonical_data")
 
     mkdir "${exercise_dir}/.meta"
@@ -126,7 +138,9 @@ EOT
     message "success" "Stub file for example.rs has been created!"
 }
 
+
 create_rust_files() {
+
     local exercise_dir=$1
     local slug=$2
     local has_canonical_data=$3

bin/generator-utils/utils.sh

@@ -1,13 +1,16 @@
 #!/usr/bin/env bash
 
+
 # shellcheck source=./colors.sh
 source ./bin/generator-utils/colors.sh
 
 message() {
+
     local flag=$1
     local message=$2
 
     case "$flag" in
+
     "success") printf "${green}%s${reset_color}\n" "[success]: $message" ;;
     "task") printf "${cyan}%s${reset_color}\n" "[task]: $message" ;;
     "info") printf "${blue}%s${reset_color}\n" "[info]: $message" ;;
@@ -21,33 +24,40 @@ message() {
         printf "%*s\n" "$cols" "" | tr " " "-"
         echo
         printf "${bold_green}%s${reset_color}\n" "[done]: $message"
+
         ;;
     *)
         echo "Invalid flag: $flag"
         ;;
     esac
 }
 
+
 dash_to_underscore() {
+
     echo "$1" | sed 's/-/_/g'
 }
 
 # exercise_name -> Exercise Name
+
 format_exercise_name() {
     echo "$1" | sed 's/-/ /g; s/\b\(.\)/\u\1/g'
 }
 
 check_exercise_existence() {
     message "info" "Looking for exercise.."
     local slug="$1"
+
     # Check if exercise is already in config.json
     if jq '.exercises.practice | map(.slug)' config.json | grep -q "$slug"; then
         echo "${1} has already been implemented."
         exit 1
     fi
 
+
     # Fetch configlet and crop out exercise list
     local unimplemented_exercises
+
     unimplemented_exercises=$(bin/configlet info | sed -n '/With canonical data:/,/Track summary:/p' | sed -e '/\(With\(out\)\? canonical data:\|Track summary:\)/d' -e '/^$/d')
     if echo "$unimplemented_exercises" | grep -q "^$slug$"; then
         message "success" "Exercise has been found!"
@@ -57,6 +67,7 @@ check_exercise_existence() {
 ${unimplemented_exercises}"
 
         # Find closest match to typed-in not-found slug
+
         # See util/ngram for source
         # First it builds a binary for the system of the contributor
         if [ -e bin/generator-utils/ngram ]; then
@@ -65,6 +76,7 @@ ${unimplemented_exercises}"
             message "info" "Building typo-checker binary for $(uname -m) system."
 
             cd util/ngram && ./build && cd ../.. && echo "${yellow}$(bin/generator-utils/ngram "${unimplemented_exercises}" "$slug")${reset_color}"
+
         fi
 
         exit 1