trackler 2.2.1.86 → 2.2.1.87

data/tracks/bash/exercises/raindrops/README.md

@@ -17,9 +17,14 @@ Convert a number to a string, the contents of which depend on the number's facto
 - 34 has four factors: 1, 2, 17, and 34.
   - In raindrop-speak, this would be "34".
 
+
 Run the tests with:
 
-    bats raindrop_test.sh
+```bash
+bats raindrops_test.sh
+```
+
+After the first test(s) pass, continue by commenting out or removing the `skip` annotations prepending other tests.
 
 ## Source
 

data/tracks/bash/exercises/reverse-string/README.md

@@ -1,4 +1,4 @@
-# Reverse String 
+# Reverse String
 
 Reverse a string
 
@@ -6,9 +6,18 @@ For example:
 input: "cool"
 output: "looc"
 
+
+Run the tests with:
+
+```bash
+bats reverse_string_test.sh
+```
+
+After the first test(s) pass, continue by commenting out or removing the `skip` annotations prepending other tests.
+
 ## Source
 
-Introductory challenge to reverse an input string. [medium.freecodecamp.org/](https://medium.freecodecamp.org/how-to-reverse-a-string-in-javascript-in-3-different-ways-75e4763c68cb)
+Introductory challenge to reverse an input string [https://medium.freecodecamp.org/how-to-reverse-a-string-in-javascript-in-3-different-ways-75e4763c68cb](https://medium.freecodecamp.org/how-to-reverse-a-string-in-javascript-in-3-different-ways-75e4763c68cb)
 
 ## Submitting Incomplete Solutions
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.

data/tracks/bash/exercises/rna-transcription/README.md

@@ -1,4 +1,4 @@
-# Rna Transcription
+# RNA Transcription
 
 Given a DNA strand, return its RNA complement (per RNA transcription).
 
@@ -18,9 +18,14 @@ each nucleotide with its complement:
 * `T` -> `A`
 * `A` -> `U`
 
+
 Run the tests with:
 
-    bats rna_transcription_test.sh
+```bash
+bats rna_transcription_test.sh
+```
+
+After the first test(s) pass, continue by commenting out or removing the `skip` annotations prepending other tests.
 
 ## Source
 

data/tracks/bash/exercises/roman-numerals/README.md

@@ -16,7 +16,7 @@ into stone tablets).
 
 ```text
  1  => I
- 10  => X
+10  => X
  7  => VII
 ```
 
@@ -42,9 +42,18 @@ In Roman numerals 1990 is MCMXC:
 
 See also: http://www.novaroma.org/via_romana/numbers.html
 
+
+Run the tests with:
+
+```bash
+bats roman_numerals_test.sh
+```
+
+After the first test(s) pass, continue by commenting out or removing the `skip` annotations prepending other tests.
+
 ## Source
 
-The Roman Numeral Kata. [codingdojo.org](http://codingdojo.org/cgi-bin/index.pl?KataRomanNumerals)
+The Roman Numeral Kata [http://codingdojo.org/cgi-bin/index.pl?KataRomanNumerals](http://codingdojo.org/cgi-bin/index.pl?KataRomanNumerals)
 
 ## Submitting Incomplete Solutions
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.

data/tracks/bash/exercises/triangle/README.md

@@ -22,17 +22,18 @@ The case where the sum of the lengths of two sides _equals_ that of the
 third is known as a _degenerate_ triangle - it has zero area and looks like
 a single line. Feel free to add your own code/tests to check for degenerate triangles.
 
-## Tests
 
 Run the tests with:
 
 ```bash
-    bats triangle_test.sh
+bats triangle_test.sh
 ```
 
+After the first test(s) pass, continue by commenting out or removing the `skip` annotations prepending other tests.
+
 ## Source
 
-The [Ruby Koans](http://rubykoans.com) triangle project, parts 1 & 2
+The Ruby Koans triangle project, parts 1 & 2 [http://rubykoans.com](http://rubykoans.com)
 
 ## Submitting Incomplete Solutions
-It's possible to submit an incomplete solution so you can see how others have completed the exercise.
+It's possible to submit an incomplete solution so you can see how others have completed the exercise.

data/tracks/bash/exercises/two-fer/README.md

@@ -2,7 +2,7 @@
 
 `Two-fer` or `2-fer` is short for two for one. One for you and one for me.
 
-```
+```text
 "One for X, one for me."
 ```
 
@@ -11,21 +11,19 @@ When X is a name or "you".
 If the given name is "Alice", the result should be "One for Alice, one for me."
 If no name is given, the result should be "One for you, one for me."
 
-## Instructions
-
-Submissions are encouraged to be general, within reason. Having said that, it's
-also important not to over-engineer a solution.
 
-It's important to remember that the goal is to make code as expressive and
-readable as we can.
 
 Run the tests with:
 
-    bats two_fer_test.sh
+```bash
+bats two_fer_test.sh
+```
+
+After the first test(s) pass, continue by commenting out or removing the `skip` annotations prepending other tests.
 
 ## Source
 
-This is an exercise to introduce users to basic programming constructs, just after hello World. [https://en.wikipedia.org/wiki/Two-fer](https://en.wikipedia.org/wiki/Two-fer)
+This is an exercise to introduce users to basic programming constructs, just after Hello World. [https://en.wikipedia.org/wiki/Two-fer](https://en.wikipedia.org/wiki/Two-fer)
 
 ## Submitting Incomplete Solutions
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.

data/tracks/bash/exercises/word-count/README.md

@@ -4,7 +4,7 @@ Given a phrase, count the occurrences of each word in that phrase.
 
 For example for the input `"olly olly in come free"`
 
-```plain
+```text
 olly: 2
 in: 1
 come: 1
@@ -14,7 +14,11 @@ free: 1
 
 Run the tests with:
 
-    bats word_count_test.sh
+```bash
+bats word_count_test.sh
+```
+
+After the first test(s) pass, continue by commenting out or removing the `skip` annotations prepending other tests.
 
 ## Source
 

data/tracks/bash/exercises/word-count/example.sh

@@ -1,21 +1,30 @@
 #!/usr/bin/env bash
 
-input="$1";
+input="$1"
 
-if [ ! -n "${input}" ]
+if [[ ! -n "${input}" ]]
 then
 	echo "Usage: $0 <input>"
-	exit;
+	exit
 fi
 
-awk_progfile="${0%sh}awk";
+echo "$input" \
+  | tr '[:upper:]' '[:lower:]' \
+  | tr '.,:&@$%^!' ' ' \
+  | awk -f <(cat - <<-'HEREDOC'
+      {
+        for (field_index = 1; field_index <= NF; field_index++)
+        {
+          result[$field_index]++
+        }
+      }
+      END {
+        for (field_index in result)
+        {
+          printf "%s: %d\n", field_index, result[field_index]
+        }
+      }
+HEREDOC
+)
 
-if [ ! -f "${awk_progfile}" ]
-then
-	echo "Awk program file not found."
-	exit 1;
-fi
-
-echo "$input" | tr '[:upper:]' '[:lower:]' | tr '.,:&@$%^!' ' ' | awk -f "${awk_progfile}";
-
-exit $?;
+exit $?

data/tracks/bash/scripts/canonical_data_check.sh

@@ -0,0 +1,112 @@
+#!/usr/bin/env bash
+
+print_usage() {
+    echo "Usage: ./canonical_data_check.sh -t path/to/track -s path/to/problem/specifications"
+}
+
+# Execution begins
+
+command -v jq >/dev/null 2>&1 || {
+    echo >&2 "This script requires jq but it's not installed. Aborting."
+    exit 1
+}
+
+num_args=$#
+
+if [ $num_args -eq 0 ]
+then
+    print_usage
+    exit 0
+fi
+
+path_to_track=
+path_to_problem_specifications=
+
+while getopts ":t:s:" option
+do
+    case "$option" in
+        "t")
+            path_to_track="$OPTARG"
+            ;;
+        "s")
+            path_to_problem_specifications="$OPTARG"
+            ;;
+        *)
+            echo "Unrecognized option. Aborting."
+            print_usage
+            exit 1
+            ;;
+    esac
+done
+
+if [ -z "$path_to_track" ]
+then
+    echo "Path to track missing."
+    print_usage
+    exit 1
+fi
+
+if [ -z "$path_to_problem_specifications" ]
+then
+    echo "Path to problem specifications missing."
+    print_usage
+    exit 1
+fi
+
+config_file_path="$path_to_track/config.json"
+
+if ! [ -f "$config_file_path" ]
+then
+    echo "Config file not found at $config_file_path."
+    exit 1
+fi
+
+track_exercise_slugs=$(jq '.exercises[] | select(has("deprecated") | not) | .slug' $config_file_path | tr -d "\"")
+update_needed_count=0
+
+for slug in $track_exercise_slugs
+do
+    canonical_data_folder_path="$path_to_problem_specifications/exercises/$slug"
+
+    if ! [ -d "$canonical_data_folder_path" ]
+    then
+        echo "Canonical data folder $canonical_data_folder_path not found. Aborting."
+        exit 1
+    fi
+
+    canonical_data_file_path="$canonical_data_folder_path/canonical-data.json"
+
+    if ! [ -f "$canonical_data_file_path" ]
+    then
+        # echo "$slug: no canonical data found."
+        continue
+    fi
+
+    canonical_data_version=$(jq '.version' $canonical_data_file_path | tr -d "\"")
+
+    track_exercise_version_file_path="$path_to_track/exercises/$slug/.meta/version"
+
+    if ! [ -f "$track_exercise_version_file_path" ]
+    then
+        echo "$slug: needs update or version file (v$canonical_data_version)."
+        update_needed_count=$((update_needed_count + 1))
+        continue
+    fi
+
+    track_data_version=$(cat $track_exercise_version_file_path)
+
+    if [ "$track_data_version" = "$canonical_data_version" ]
+    then
+        # echo "$slug: up-to-date."
+        continue
+    else
+        update_needed_count=$((update_needed_count + 1))
+        echo "$slug: needs update (v$track_data_version -> v$canonical_data_version)."
+    fi
+
+done
+
+if [ $update_needed_count -eq 0 ]
+then
+    echo "All exercises are up to date!"
+fi

data/tracks/c/exercises/gigasecond/.meta/hints.md

@@ -0,0 +1,124 @@
+## Exercises without stub implementations
+
+Like the majority of C programs you will write, this exercise comes without any header file (`*.h`) or source file (`*.c`).
+
+
+### Add the required files
+
+You will need to create these yourself as part of the exercise. 
+This is so that you get to practice deciding on and creating the program's interface yourself, which is an important part of programming in C.
+It does mean that when you first try to run the tests, they won't compile.
+They will give you an error similar to:
+
+```bash
+make: *** No rule to make target 'src/exercise_name.c', needed by 'tests.out'.  Stop.
+```
+
+This error occurs because the `makefile` attempts to use a file that hasn't been created yet (`exercise_name.c`).
+To resolve this error you will need to add a matching file to the `src` directory.
+For example, for the error above you would add a file called `exercise_name.c`.
+
+When you try to run the tests again you will get a slightly different error.
+
+```bash
+make: *** No rule to make target 'src/exercise_name.h', needed by 'tests.out'.  Stop.
+```
+
+Again the `makefile` still needs another file that has yet to be created (`exercise_name.h`).
+The solution to this error is similar to the last, add the matching file to the `src` directory.
+For example, for the above error you would add a file called `exercise_name.h`
+
+
+### Add the required declarations
+
+Running the tests a third time you see you will get new errors, similar to:
+
+```bash
+Compiling tests.out
+src/exercise_name.c:1:0: error: ISO C forbids an empty translation unit [-Werror=pedantic]
+cc1: all warnings being treated as errors
+test/test_exercise_name.c:13:1: error: unknown type name ‘bar_t’; did you mean ‘__bar_t’?
+    bar_t b = foo(a, 2.5);
+    ^~~~~~
+ __bar_t
+test/test_exercise_name.c:15:14: error: storage size of fizz isn’t known
+    struct baz fizz;
+               ^~~~
+test/test_exercise_name.c:29:20: error: implicit declaration of function ‘foo’ [-Werror=implicit-function-declaration]
+    bar_t b = foo_function(fizz, 2.5);
+```
+
+This error means that you need to add function, type and variable decarations to the header file to match those the test file is attempting to use.
+In doing this you will need to look at the build errors and the test code to determine what needs to be declared in the header file.
+
+For example, for the error above you should declare a type named  `bar_t`, a `struct` called `baz` and a function named `foo()`. 
+Additionally we can tell from looking at the above errors that function `foo()` has two parameters. 
+
+The first parameter is passed an argument of `fizz` and thus should have a type of `struct baz`.
+The second parameter is passed `2.5` and so could have one of two types, either `float` or `double`.
+You will need to look at the test code to determine which.
+
+The _names_ of the parameters are not determined by the test code and so are left up to you to decide, though in keeping with C programming practices they should be descriptive but not overly long.
+
+Further, we can see that the the return type expected by the test code is of the type `bar_t`.
+
+Putting this all together we end up with a function declaration that looks like the following:
+
+```c
+// The parameter names are not very good here they should be more descriptive in a real exercise.
+// We have decide on a double for the second parameter in this hypothetical example.
+bar_t foo(struct baz b, double d);
+```
+
+You should continue to do this for any further similar errors.
+To check that you have correctly determined the required declaration, just run the tests again and analyse any errors similarly.
+
+Additionally, remember to add any includes to the header file any headers that it itself requires.
+
+
+### Include guards
+
+Before you are finished with the header file, you should add include guards.
+Include guards are used to help prevent the file from being included multiple times by accident.
+If the file _was_ included multiple times then the functions and other items would be declared twice; In C this is an error because the compiler thinks you are trying to declare another _different_ function that has the same name.
+
+To add include guards, add something similar to the following as the first two lines of the header:
+
+```c
+#ifndef EXERCISE_NAME_H
+#define EXERCISE_NAME_H
+```
+
+And on the very last line:
+
+```c
+#endif
+```
+
+
+### Add the required definitions
+
+Once the header file is complete you may still have build errors similar to the following:
+
+```bash
+Compiling tests.out
+src/exercise_name.c:1:0: error: ISO C forbids an empty translation unit [-Werror=pedantic]
+cc1: all warnings being treated as errors
+makefile:24: recipe for target 'tests.out' failed
+make: *** [tests.out] Error 1
+```
+
+This is because although you have _declared_ all the items you need to, they have not yet been _defined_.
+To define the needed items you need to add their implementation to the `exercise_name.c` file.
+For the function `foo()` from the previous example, this would look similar to:
+
+```c
+#include "exercise_name.h"
+
+bar_t foo(struct baz b, double d)
+{
+    // Your exercise code here
+}
+```
+
+After having resolved these errors you should be ready to start making the tests pass!