Generator script improvements (#1663)

* Add difficulty as int, further format fn name

* Add util fn to escape double quotes

* Simplify escape double quotes algo

* Add missing end line

Author: dem4ron

.gitignore

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

bin/add_practice_exercise

@@ -82,7 +82,7 @@ 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" \
+jq --arg slug "$slug" --arg uuid "$uuid" --arg name "$exercise_name" --argjson 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

bin/generate_tests

@@ -1,18 +1,21 @@
 #!/usr/bin/env bash
 
-
 # Exit if anything fails.
 set -euo pipefail
 
-
 # see comment in generator-utils/utils.sh
 # shellcheck source=bin/generator-utils/utils.sh
 # shellcheck source=./generator-utils/utils.sh
 source ./bin/generator-utils/utils.sh
 
+if [ ! -e bin/generator-utils/escape_double_quotes ]; then
+  message "info" "Building util function"
+  cd util/escape_double_quotes && ./build && cd ../..
+fi
+
 digest_template() {
   local template
-  template=$(cat bin/test_template)
+  template=$(bin/generator-utils/escape_double_quotes bin/test_template)
   # Turn every token into a jq command
 
   echo "$template" | sed 's/${\([^}]*\)\}\$/$(echo $case | jq -r '\''.\1'\'')/g'
@@ -35,7 +38,6 @@ 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
@@ -45,9 +47,8 @@ jq -c '.[]' <<<"$cases" | while read -r case; do
   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 /')
+  formatted_template=$(echo "$eval_template" | sed -E -e '/^fn/!b' -e 's/[^a-zA-Z0-9_{}()[:space:]-]//g' -e 's/([[:upper:]])/ \L\1/g' -e 's/(fn[[:space:]]+)([a-z0-9_-]+)/\1\L\2/g' -e 's/ /_/g' -e 's/_\{/\{/g' -e 's/-/_/g' | sed 's/fn_/fn /' | sed 's/__\+/_/g')
 
   # Push to test file
   echo "$formatted_template" >>"$test_file"
@@ -58,4 +59,3 @@ done
 rustfmt "$test_file"
 
 message "success" "Generated tests successfully! Check out ${test_file}"
-

bin/test_template

@@ -1,7 +1,6 @@
 #[test]
 #[ignore]
 fn ${description}$() {
-
-    assert_eq!(${property}$(${input}$), ${expected}$);
+let expected = "${expected}$";
+    assert_eq!(${property}$(${input}$), expected);
 }
-

util/escape_double_quotes/Cargo.lock

@@ -0,0 +1,8 @@
+[package]
+name = "escape_double_quotes"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

util/escape_double_quotes/Cargo.toml

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+cargo build --release --quiet && cp ./target/release/escape_double_quotes ../../bin/generator-utils && rm -rf ./target

util/escape_double_quotes/build

@@ -0,0 +1,2 @@
+pub mod utils;
+pub use utils::escape_double_quotes::*;

util/escape_double_quotes/src/lib.rs

@@ -0,0 +1,30 @@
+use std::env;
+use std::fs::File;
+use std::io::{self, BufRead, BufReader, BufWriter, Write};
+mod utils;
+use utils::escape_double_quotes::*;
+
+
+fn main() -> io::Result<()> {
+    let args: Vec<String> = env::args().collect();
+    if args.len() != 2 {
+        eprintln!("Usage: {} <file>", args[0]);
+        std::process::exit(1);
+    }
+
+    let file_path = &args[1];
+    let file = File::open(file_path)?;
+    let reader = BufReader::new(file);
+
+    let stdout = io::stdout();
+    let mut writer = BufWriter::new(stdout.lock());
+
+    for line in reader.lines() {
+        let input = line?;
+        let output = escape_double_quotes(&input);
+        writeln!(writer, "{}", output)?;
+    }
+
+    Ok(())
+}
+

util/escape_double_quotes/src/main.rs

@@ -0,0 +1,22 @@
+pub fn escape_double_quotes(input: &str) -> String {
+    let mut output = String::new();
+    let mut escape = true;
+
+    let mut chars = input.chars().peekable();
+    while let Some(char) = chars.next() {
+        match char {
+            '$' if chars.peek() == Some(&'{') => {
+                escape = false;
+                output.push(char)
+            }
+            '}' if chars.peek() == Some(&'$') => {
+                escape = true;
+                output.push(char)
+            }
+            '"' if escape => output.push_str("\\\""),
+            _ => output.push(char),
+        }
+    }
+
+    output
+}

util/escape_double_quotes/src/utils/escape_double_quotes.rs

@@ -0,0 +1 @@
+pub mod escape_double_quotes;

util/escape_double_quotes/src/utils/mod.rs

@@ -0,0 +1,36 @@
+use escape_double_quotes::utils::escape_double_quotes::escape_double_quotes;
+
+#[test]
+fn test_no_double_quotes() {
+    let input = "let x = 5;";
+    let expected = "let x = 5;";
+    assert_eq!(escape_double_quotes(input), expected);
+}
+
+#[test]
+fn test_simple_double_quotes() {
+    let input = "let something = \"string\";";
+    let expected = "let something = \\\"string\\\";";
+    assert_eq!(escape_double_quotes(input), expected);
+}
+
+#[test]
+fn test_braces_with_double_quotes() {
+    let input = "let expected = \"${expected | join(\\\"\\n\\\")}$\";";
+    let expected = "let expected = \\\"${expected | join(\\\"\\n\\\")}$\\\";";
+    assert_eq!(escape_double_quotes(input), expected);
+}
+
+#[test]
+fn test_mixed_double_quotes() {
+    let input = "let a = \"value\"; let b = \"${value | filter(\\\"text\\\")}$\";";
+    let expected = "let a = \\\"value\\\"; let b = \\\"${value | filter(\\\"text\\\")}$\\\";";
+    assert_eq!(escape_double_quotes(input), expected);
+}
+
+#[test]
+fn test_nested_braces() {
+    let input = "let nested = \"${outer {inner | escape(\\\"\\n\\\")}}$\";";
+    let expected = "let nested = \\\"${outer {inner | escape(\\\"\\n\\\")}}$\\\";";
+    assert_eq!(escape_double_quotes(input), expected);
+}