Provide an auto-sync script (#879)

Author: mk-mxp

bin/auto-sync.sh

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+scriptDirectory="$( dirname "$0" )"
+if [[ "$#" != 0 ]]; then
+    forwardedParameters=( "$@" )
+else
+    forwardedParameters=( -o -u -y --docs --filepaths --metadata )
+fi
+
+exitWithFailure() {
+    echo "$1"
+    exit 1
+}
+
+isPracticeExercise() {
+    [ -d "exercises/practice/$1" ]
+}
+
+reportUnknownExercise() {
+    echo "Unknown practice exercise: $1"
+}
+
+isNoPracticeExercise() {
+    isPracticeExercise "$1" || {
+        reportUnknownExercise "$1"
+        return 0
+    }
+    return 1
+}
+
+reportRepeatedExercise() {
+    echo "Repeated exercise slug: $1"
+}
+
+syncPracticeExercise() {
+    local exerciseSlug="$1"
+
+    bin/configlet sync -v q -e "$exerciseSlug" "${forwardedParameters[@]}"
+}
+
+main() {
+    local -A uniqueSlugs=()
+    local -a exerciseSlugs
+    local exerciseSlug
+
+    # Refresh 'problem-spec' cache once
+    bin/configlet info || exitWithFailure "configlet not ready to run offline"
+
+    mapfile -t exerciseSlugs < "$scriptDirectory/auto-sync.txt"
+
+    for exerciseSlug in "${exerciseSlugs[@]}"; do
+        if [[ "${uniqueSlugs[$exerciseSlug]}" == "set" ]]; then
+            reportRepeatedExercise "$exerciseSlug"
+        else
+            uniqueSlugs[$exerciseSlug]="set"
+            isNoPracticeExercise "${exerciseSlug}" && continue
+            syncPracticeExercise "${exerciseSlug}"
+        fi
+    done
+}
+
+main

bin/auto-sync.txt

@@ -0,0 +1,71 @@
+acronym
+affine-cipher
+all-your-base
+allergies
+alphametics
+anagram
+armstrong-numbers
+atbash-cipher
+bank-account
+binary-search
+binary-search-tree
+bob
+book-store
+bowling
+change
+circular-buffer
+clock
+collatz-conjecture
+connect
+crypto-square
+darts
+diamond
+difference-of-squares
+dnd-character
+eliuds-eggs
+etl
+food-chain
+grade-school
+hamming
+house
+isbn-verifier
+isogram
+killer-sudoku-helper
+kindergarten-garden
+knapsack
+largest-series-product
+leap
+list-ops
+luhn
+matching-brackets
+meetup
+micro-blog
+minesweeper
+nucleotide-count
+pangram
+pascals-triangle
+phone-number
+pig-latin
+protein-translation
+raindrops
+resistor-color
+resistor-color-duo
+resistor-color-trio
+reverse-string
+rna-transcription
+robot-simulator
+roman-numerals
+rotational-cipher
+run-length-encoding
+scrabble-score
+secret-handshake
+sieve
+space-age
+spiral-matrix
+state-of-tic-tac-toe
+strain
+sublist
+two-bucket
+two-fer
+yacht
+zebra-puzzle

exercises/practice/affine-cipher/.docs/instructions.md

@@ -4,7 +4,7 @@ Create an implementation of the affine cipher, an ancient encryption system crea
 
 The affine cipher is a type of monoalphabetic substitution cipher.
 Each character is mapped to its numeric equivalent, encrypted with a mathematical function and then converted to the letter relating to its new numeric value.
-Although all monoalphabetic ciphers are weak, the affine cipher is much stronger than the atbash cipher, because it has many more keys.
+Although all monoalphabetic ciphers are weak, the affine cipher is much stronger than the Atbash cipher, because it has many more keys.
 
 [//]: # " monoalphabetic as spelled by Merriam-Webster, compare to polyalphabetic "
 

exercises/practice/anagram/.docs/instructions.md

@@ -1,13 +1,12 @@
 # Instructions
 
-Your task is to, given a target word and a set of candidate words, to find the subset of the candidates that are anagrams of the target.
+Given a target word and one or more candidate words, your task is to find the candidates that are anagrams of the target.
 
 An anagram is a rearrangement of letters to form a new word: for example `"owns"` is an anagram of `"snow"`.
 A word is _not_ its own anagram: for example, `"stop"` is not an anagram of `"stop"`.
 
-The target and candidates are words of one or more ASCII alphabetic characters (`A`-`Z` and `a`-`z`).
-Lowercase and uppercase characters are equivalent: for example, `"PoTS"` is an anagram of `"sTOp"`, but `StoP` is not an anagram of `sTOp`.
-The anagram set is the subset of the candidate set that are anagrams of the target (in any order).
-Words in the anagram set should have the same letter case as in the candidate set.
+The target word and candidate words are made up of one or more ASCII alphabetic characters (`A`-`Z` and `a`-`z`).
+Lowercase and uppercase characters are equivalent: for example, `"PoTS"` is an anagram of `"sTOp"`, but `"StoP"` is not an anagram of `"sTOp"`.
+The words you need to find should be taken from the candidate words, using the same letter case.
 
-Given the target `"stone"` and candidates `"stone"`, `"tones"`, `"banana"`, `"tons"`, `"notes"`, `"Seton"`, the anagram set is `"tones"`, `"notes"`, `"Seton"`.
+Given the target `"stone"` and the candidate words `"stone"`, `"tones"`, `"banana"`, `"tons"`, `"notes"`, and `"Seton"`, the anagram words you need to find are `"tones"`, `"notes"`, and `"Seton"`.

exercises/practice/atbash-cipher/.docs/instructions.md

@@ -1,6 +1,6 @@
 # Instructions
 
-Create an implementation of the atbash cipher, an ancient encryption system created in the Middle East.
+Create an implementation of the Atbash cipher, an ancient encryption system created in the Middle East.
 
 The Atbash cipher is a simple substitution cipher that relies on transposing all the letters in the alphabet such that the resulting alphabet is backwards.
 The first letter is replaced with the last letter, the second with the second-last, and so on.

exercises/practice/atbash-cipher/.meta/config.json

@@ -20,7 +20,7 @@
       ".meta/example.php"
     ]
   },
-  "blurb": "Create an implementation of the atbash cipher, an ancient encryption system created in the Middle East.",
+  "blurb": "Create an implementation of the Atbash cipher, an ancient encryption system created in the Middle East.",
   "source": "Wikipedia",
   "source_url": "https://en.wikipedia.org/wiki/Atbash"
 }

exercises/practice/change/.docs/instructions.md

@@ -1,14 +1,8 @@
 # Instructions
 
-Correctly determine the fewest number of coins to be given to a customer such that the sum of the coins' value would equal the correct amount of change.
+Determine the fewest number of coins to give a customer so that the sum of their values equals the correct amount of change.
 
-## For example
+## Examples
 
-- An input of 15 with [1, 5, 10, 25, 100] should return one nickel (5) and one dime (10) or [5, 10]
-- An input of 40 with [1, 5, 10, 25, 100] should return one nickel (5) and one dime (10) and one quarter (25) or [5, 10, 25]
-
-## Edge cases
-
-- Does your algorithm work for any given set of coins?
-- Can you ask for negative change?
-- Can you ask for a change value smaller than the smallest coin value?
+- An amount of 15 with available coin values [1, 5, 10, 25, 100] should return one coin of value 5 and one coin of value 10, or [5, 10].
+- An amount of 40 with available coin values [1, 5, 10, 25, 100] should return one coin of value 5, one coin of value 10, and one coin of value 25, or [5, 10, 25].

exercises/practice/change/.docs/introduction.md

@@ -0,0 +1,26 @@
+# Introduction
+
+In the mystical village of Coinholt, you stand behind the counter of your bakery, arranging a fresh batch of pastries.
+The door creaks open, and in walks Denara, a skilled merchant with a keen eye for quality goods.
+After a quick meal, she slides a shimmering coin across the counter, representing a value of 100 units.
+
+You smile, taking the coin, and glance at the total cost of the meal: 88 units.
+That means you need to return 12 units in change.
+
+Denara holds out her hand expectantly.
+"Just give me the fewest coins," she says with a smile.
+"My pouch is already full, and I don't want to risk losing them on the road."
+
+You know you have a few options.
+"We have Lumis (worth 10 units), Viras (worth 5 units), and Zenth (worth 2 units) available for change."
+
+You quickly calculate the possibilities in your head:
+
+- one Lumis (1 × 10 units) + one Zenth (1 × 2 units) = 2 coins total
+- two Viras (2 × 5 units) + one Zenth (1 × 2 units) = 3 coins total
+- six Zenth (6 × 2 units) = 6 coins total
+
+"The best choice is two coins: one Lumis and one Zenth," you say, handing her the change.
+
+Denara smiles, clearly impressed.
+"As always, you've got it right."

exercises/practice/collatz-conjecture/.docs/instructions.md

@@ -1,29 +1,3 @@
 # Instructions
 
-The Collatz Conjecture or 3x+1 problem can be summarized as follows:
-
-Take any positive integer n.
-If n is even, divide n by 2 to get n / 2.
-If n is odd, multiply n by 3 and add 1 to get 3n + 1.
-Repeat the process indefinitely.
-The conjecture states that no matter which number you start with, you will always reach 1 eventually.
-
-Given a number n, return the number of steps required to reach 1.
-
-## Examples
-
-Starting with n = 12, the steps would be as follows:
-
-0. 12
-1. 6
-2. 3
-3. 10
-4. 5
-5. 16
-6. 8
-7. 4
-8. 2
-9. 1
-
-Resulting in 9 steps.
-So for input n = 12, the return value would be 9.
+Given a positive integer, return the number of steps it takes to reach 1 according to the rules of the Collatz Conjecture.

exercises/practice/collatz-conjecture/.docs/introduction.md

@@ -0,0 +1,28 @@
+# Introduction
+
+One evening, you stumbled upon an old notebook filled with cryptic scribbles, as though someone had been obsessively chasing an idea.
+On one page, a single question stood out: **Can every number find its way to 1?**
+It was tied to something called the **Collatz Conjecture**, a puzzle that has baffled thinkers for decades.
+
+The rules were deceptively simple.
+Pick any positive integer.
+
+- If it's even, divide it by 2.
+- If it's odd, multiply it by 3 and add 1.
+
+Then, repeat these steps with the result, continuing indefinitely.
+
+Curious, you picked number 12 to test and began the journey:
+
+12 ➜ 6 ➜ 3 ➜ 10 ➜ 5 ➜ 16 ➜ 8 ➜ 4 ➜ 2 ➜ 1
+
+Counting from the second number (6), it took 9 steps to reach 1, and each time the rules repeated, the number kept changing.
+At first, the sequence seemed unpredictable — jumping up, down, and all over.
+Yet, the conjecture claims that no matter the starting number, we'll always end at 1.
+
+It was fascinating, but also puzzling.
+Why does this always seem to work?
+Could there be a number where the process breaks down, looping forever or escaping into infinity?
+The notebook suggested solving this could reveal something profound — and with it, fame, [fortune][collatz-prize], and a place in history awaits whoever could unlock its secrets.
+
+[collatz-prize]: https://mathprize.net/posts/collatz-conjecture/