Bruce/nomsu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved tutorial.

Browse Source
This commit is contained in:
Bruce Hill 2019-01-27 02:08:53 -08:00
parent 1ff4e4d432
commit 92a603f199
1 changed files with 113 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
lib/tools/tutorial.nom
View File

@ -63,7 +63,7 @@ $lessons = [
for $num in [0, -1, 10, 4]: for $num in [0, -1, 10, 4]:
$correct_answer = (4 * ($num * $num)) $correct_answer = (4 * ($num * $num))
if (($num doubled then squared) != $correct_answer): if (($num doubled then squared) != $correct_answer):
fail "Wrong answer for \$num!" fail "Wrong answer for \($num)!"
lesson "Conditionals": lesson "Conditionals":
# Make this action return "big" if its argument # Make this action return "big" if its argument
@ -85,6 +85,7 @@ $lessons = [
# Fix this action so the tests pass: # Fix this action so the tests pass:
(the sum of $numbers) means: (the sum of $numbers) means:
$sum = 0 $sum = 0
# You can loop over the values in a list like this: # You can loop over the values in a list like this:
for $number in $numbers: for $number in $numbers:
# Hint: math expressions may need parentheses # Hint: math expressions may need parentheses
@ -162,6 +163,7 @@ $lessons = [
lesson "Failure and Recovery": lesson "Failure and Recovery":
$what_happened = "nothing" $what_happened = "nothing"
# In Nomsu, sometimes things fail, but you can recover from failures with 'try': # In Nomsu, sometimes things fail, but you can recover from failures with 'try':
try: try:
# The 'fail' action triggers failure # The 'fail' action triggers failure
@ -247,16 +249,19 @@ $lessons = [
# Write a method called ($self, length) that returns the total # Write a method called ($self, length) that returns the total
length of all the bits in the buffer: length of all the bits in the buffer:
<your code here> <your code here>
$b = (a Buffer) $b = (a Buffer)
$b, add "xx" $b, add "xx"
$b, add "yyy" $b, add "yyy"
assume (($b, length) == 5) assume (($b, length) == 5)
] ]
$(ask normally) = $(ask)
command line program with $args: command line program with $args:
if ($args.help or $args.h): if ($args.help or $args.h):
say "Nomsu tutorial usage: nomsu -t tutorial [-x] [<location to put tutorial files>]" say ("
Nomsu tutorial usage: nomsu -t tutorial [-x] [<location to put tutorial files>]
")
exit exit
say say
@ -268,36 +273,61 @@ command line program with $args:
") ")
# For this tutorial questions are hilighted in bold cyan:
(ask $q) means (ask normally (bold (cyan $q)))
# Find the tutorial file directory:
if ($args.extras is empty): if ($args.extras is empty):
$tutorial_dir = "./nomsu_tutorial" $tutorial_dir = "./nomsu_tutorial"
if (not ($Files.exists $tutorial_dir)): unless ($Files.exists $tutorial_dir):
when (ask "The Nomsu tutorial files will be in \(bold $tutorial_dir) is that okay? [Y/n] ") is: when
ask ("
The Nomsu tutorial files will be in \$tutorial_dir is that okay? [Y/n] \;
")
..is:
"n" "N" "no": "n" "N" "no":
say "Okay. If you want to specify another file location, run `nomsu -t tutorial <your location>`" say ("
Okay. If you want to specify another file location, run `nomsu -t tutorial <your location>`
")
exit exit
..else: ..else:
$tutorial_dir = $args.extras.1 $tutorial_dir = $args.extras.1
# Set up the tutorial file directory:
if (not ($Files.exists $tutorial_dir)): if (not ($Files.exists $tutorial_dir)):
sh> "mkdir \$tutorial_dir" make directory $tutorial_dir
(filename of $i) means ("\($tutorial_dir)/lesson\$i.nom", with "//" -> "/")
for $lesson in $lessons at $i:
$filename = (filename of $i)
unless ($Files.exists $filename):
write $lesson.lesson to file $filename
if ($args.x): # Display info about editing the tutorial files:
if $args.x:
say (" say ("
The tutorial files are located in \$tutorial_dir. The tutorial files are located in \$tutorial_dir.
You're in charge of editing them yourself. You're in charge of editing them yourself.
") ")
..else: ..else:
$EDITOR = (($os.getenv "EDITOR") or "nano") $EDITOR = ($os.getenv "EDITOR")
say (" if $EDITOR:
The tutorial will use \(yellow $EDITOR) for editing files. when
If you'd rather edit the files in another window, use the \(yellow "-x") flag. ask ("
e.g. \(yellow "nomsu -t tutorial -x tutorials/") \$EDITOR is your system editor, would you like this tutorial to use it? [Y/n] \;
") ")
(filename of $i) means ("\$tutorial_dir/lesson\$i.nom", with "//" -> "/") ..is:
for $lesson in $lessons at $i: "n" "N" "no":
$filename = (filename of $i) $EDITOR = (nil)
unless ($Files.exists $filename):
write $lesson.lesson to file $filename unless $EDITOR:
say
$EDITOR =
ask ("
What program would you like to use to edit tutorial files?
(leave blank if you want to edit on your own in a different window)
> \;
")
if ($EDITOR == ""): $EDITOR = (nil)
(get failures) means [ (get failures) means [
: for $lesson in $lessons at $i: : for $lesson in $lessons at $i:
@ -311,20 +341,21 @@ command line program with $args:
add {.lesson_number = $i, .failure = $msg} add {.lesson_number = $i, .failure = $msg}
] ]
say "" say
say (bold "Lessons:") say (bold "Lessons:")
(show first failure from $failures) means: (show first failure from $failures) means:
say (" say ("
\(bold "Next thing to fix:") \( \(bold "Next thing to fix:") \(
bold (yellow "Lesson \($failures.1.lesson_number): \($lessons.($failures.1.lesson_number).name)") bold
yellow ("
Lesson \($failures.1.lesson_number): \($lessons.($failures.1.lesson_number).name)
")
) )
\($failures.1.failure, indented) \($failures.1.failure, indented)
") ")
$failures = (get failures) $failures = (get failures)
for $lesson in $lessons at $i: for $lesson in $lessons at $i:
for $f in $failures: for $f in $failures:
@ -332,17 +363,30 @@ command line program with $args:
say (bold (red " \$i. \($lesson.name) [incomplete]")) say (bold (red " \$i. \($lesson.name) [incomplete]"))
do next $lesson do next $lesson
say (bold (green " \$i. \($lesson.name) [passed]")) say (bold (green " \$i. \($lesson.name) [passed]"))
say "\n\(bold "Your progress:") \(20 wide (((#$lessons) - (#$failures)) / (#$lessons)) progress bar)"
repeat while (not ($failures is empty)): say ("
\(bold "Your progress:") \(
20 wide (((#$lessons) - (#$failures)) / (#$lessons)) progress bar
)
")
repeat until ($failures is empty):
show first failure from $failures show first failure from $failures
if ($args.x):
# Have the user fix the first failure:
unless $EDITOR:
# If the user is using an external editor, wait for the file to change
$filename = (filename of $failures.1.lesson_number) $filename = (filename of $failures.1.lesson_number)
say "\(yellow "Waiting for you to fix ")\(bold $filename) \(yellow "(press ctrl+c to exit)...")" say ("
\(yellow "Waiting for you to fix ")\(bold $filename) \
..\(yellow "(press ctrl+c to exit)...")
")
try: try:
$files = [: for $ in 1 to (#$lessons): add (read file (filename of $))] $files = [: for $ in 1 to (#$lessons): add (read file (filename of $))]
repeat: repeat:
sh> "sleep 0.5" sleep for 0.5 seconds
$new_files = [: for $ in 1 to (#$lessons): add (read file (filename of $))] $new_files = [: for $ in 1 to (#$lessons): add (read file (filename of $))]
if ($new_files != $files): if ($new_files != $files):
$files = $new_files $files = $new_files
@ -351,14 +395,11 @@ command line program with $args:
say "\nGoodbye." say "\nGoodbye."
exit exit
..else: ..else:
# If the user is using $EDITOR, launch it so they can edit the file:
$filename = (filename of $failures.1.lesson_number) $filename = (filename of $failures.1.lesson_number)
--- (retry file) --- --- (retry file) ---
when when (ask "Edit \$filename to get it to pass? [Y/n/exit] ") is:
ask (bold (cyan "Edit \$filename to get it to pass? [Y/n/exit] ")) "q" "quit" "exit" "n" "N" "no": exit
..is:
"q" "quit" "exit" "n" "N" "no":
exit
"y" "Y" "yes" "": "y" "Y" "yes" "":
$f = (read file $filename) $f = (read file $filename)
[$line, $col] = ($failures.1.failure, match ":(%d+),(%d+)") [$line, $col] = ($failures.1.failure, match ":(%d+),(%d+)")
@ -377,10 +418,10 @@ command line program with $args:
sh> "\$EDITOR \$filename" sh> "\$EDITOR \$filename"
..else: ..else:
sh> "\$EDITOR \$filename" sh> "\$EDITOR \$filename"
else: else:
say "Sorry, I don't understand that." say "Sorry, I don't understand that."
go to (retry file) go to (retry file)
$file = (read file $filename) $file = (read file $filename)
$file = ($NomsuCode, from (Source $filename 1 (#$file)) $file) $file = ($NomsuCode, from (Source $filename 1 (#$file)) $file)
try: try:
@ -390,12 +431,13 @@ command line program with $args:
say (bold (red "\n There's a bit more to fix:")) say (bold (red "\n There's a bit more to fix:"))
$msg = ($msg, with "\n *stack traceback:.*" -> "") $msg = ($msg, with "\n *stack traceback:.*" -> "")
say ($msg, indented) say ($msg, indented)
say "" say
go to (retry file) go to (retry file)
$prev_progress = (((#$lessons) - (#$failures)) / (#$lessons)) $prev_progress = (((#$lessons) - (#$failures)) / (#$lessons))
$failures = (get failures) $failures = (get failures)
$progress = (((#$lessons) - (#$failures)) / (#$lessons)) $progress = (((#$lessons) - (#$failures)) / (#$lessons))
# Update the progressbar if progess has changed:
if ($progress != $prev_progress): if ($progress != $prev_progress):
if ($progress > $prev_progress): if ($progress > $prev_progress):
say (bold (green "\nSuccess!\n")) say (bold (green "\nSuccess!\n"))
@ -407,9 +449,10 @@ command line program with $args:
$p = ($prev_progress to $progress mixed by $k) $p = ($prev_progress to $progress mixed by $k)
say "\r\(bold "Your progress:") \(20 wide $p progress bar)" inline say "\r\(bold "Your progress:") \(20 wide $p progress bar)" inline
$io.flush() $io.flush()
sh> "sleep \(1 / $N)" sleep for (1 / $N) seconds
say "" say
# All done, no more failures:
say (" say ("
\(bold "\(slow blink "Congratulations!")") \(bold "\(slow blink "Congratulations!")")