Add twelve-days exercise (#240)

Author: keiravillekode

config.json

@@ -399,6 +399,14 @@
         "prerequisites": [],
         "difficulty": 3
       },
+      {
+        "slug": "twelve-days",
+        "name": "Twelve Days",
+        "uuid": "6c366848-a77a-478a-8925-7a8947a14260",
+        "practices": [],
+        "prerequisites": [],
+        "difficulty": 3
+      },
       {
         "slug": "affine-cipher",
         "name": "Affine Cipher",

exercises/practice/twelve-days/.docs/instructions.md

@@ -0,0 +1,36 @@
+# Instructions
+
+Your task in this exercise is to write code that returns the lyrics of the song: "The Twelve Days of Christmas."
+
+"The Twelve Days of Christmas" is a common English Christmas carol.
+Each subsequent verse of the song builds on the previous verse.
+
+The lyrics your code returns should _exactly_ match the full song text shown below.
+
+## Lyrics
+
+```text
+On the first day of Christmas my true love gave to me: a Partridge in a Pear Tree.
+
+On the second day of Christmas my true love gave to me: two Turtle Doves, and a Partridge in a Pear Tree.
+
+On the third day of Christmas my true love gave to me: three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+
+On the fourth day of Christmas my true love gave to me: four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+
+On the fifth day of Christmas my true love gave to me: five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+
+On the sixth day of Christmas my true love gave to me: six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+
+On the seventh day of Christmas my true love gave to me: seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+
+On the eighth day of Christmas my true love gave to me: eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+
+On the ninth day of Christmas my true love gave to me: nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+
+On the tenth day of Christmas my true love gave to me: ten Lords-a-Leaping, nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+
+On the eleventh day of Christmas my true love gave to me: eleven Pipers Piping, ten Lords-a-Leaping, nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+
+On the twelfth day of Christmas my true love gave to me: twelve Drummers Drumming, eleven Pipers Piping, ten Lords-a-Leaping, nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+```

exercises/practice/twelve-days/.meta/config.json

@@ -0,0 +1,19 @@
+{
+  "authors": [
+    "keiravillekode"
+  ],
+  "files": {
+    "solution": [
+      "twelve-days.v"
+    ],
+    "test": [
+      "run_test.v"
+    ],
+    "example": [
+      ".meta/example.v"
+    ]
+  },
+  "blurb": "Output the lyrics to 'The Twelve Days of Christmas'.",
+  "source": "Wikipedia",
+  "source_url": "https://en.wikipedia.org/wiki/The_Twelve_Days_of_Christmas_(song)"
+}

exercises/practice/twelve-days/.meta/example.v

@@ -0,0 +1,22 @@
+module main
+
+import strings
+
+const gifts = 'twelve Drummers Drumming, eleven Pipers Piping, ten Lords-a-Leaping, nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.\n'
+
+const ordinals = ['', 'first', 'second', 'third', 'fourth', 'fifth', 'sixth', 'seventh', 'eighth',
+	'ninth', 'tenth', 'eleventh', 'twelfth']
+
+const table = [0, 235, 213, 194, 174, 157, 137, 113, 90, 69, 48, 26, 0]
+
+fn recite(start_verse int, end_verse int) string {
+	mut builder := strings.new_builder(4000)
+	for verse in start_verse .. (end_verse + 1) {
+		builder.write_string('On the ')
+		builder.write_string(ordinals[verse])
+		builder.write_string(' day of Christmas my true love gave to me: ')
+		builder.write_string(gifts[table[verse]..])
+	}
+	builder.go_back(1) // Omit final newline
+	return builder.str()
+}

exercises/practice/twelve-days/.meta/tests.toml

@@ -0,0 +1,48 @@
+# This is an auto-generated file. Regular comments will be removed when this
+# file is regenerated. Regenerating will not touch any manually added keys,
+# so comments can be added in a "comment" key.
+
+[c0b5a5e6-c89d-49b1-a6b2-9f523bff33f7]
+description = "verse -> first day a partridge in a pear tree"
+
+[1c64508a-df3d-420a-b8e1-fe408847854a]
+description = "verse -> second day two turtle doves"
+
+[a919e09c-75b2-4e64-bb23-de4a692060a8]
+description = "verse -> third day three french hens"
+
+[9bed8631-ec60-4894-a3bb-4f0ec9fbe68d]
+description = "verse -> fourth day four calling birds"
+
+[cf1024f0-73b6-4545-be57-e9cea565289a]
+description = "verse -> fifth day five gold rings"
+
+[50bd3393-868a-4f24-a618-68df3d02ff04]
+description = "verse -> sixth day six geese-a-laying"
+
+[8f29638c-9bf1-4680-94be-e8b84e4ade83]
+description = "verse -> seventh day seven swans-a-swimming"
+
+[7038d6e1-e377-47ad-8c37-10670a05bc05]
+description = "verse -> eighth day eight maids-a-milking"
+
+[37a800a6-7a56-4352-8d72-0f51eb37cfe8]
+description = "verse -> ninth day nine ladies dancing"
+
+[10b158aa-49ff-4b2d-afc3-13af9133510d]
+description = "verse -> tenth day ten lords-a-leaping"
+
+[08d7d453-f2ba-478d-8df0-d39ea6a4f457]
+description = "verse -> eleventh day eleven pipers piping"
+
+[0620fea7-1704-4e48-b557-c05bf43967f0]
+description = "verse -> twelfth day twelve drummers drumming"
+
+[da8b9013-b1e8-49df-b6ef-ddec0219e398]
+description = "lyrics -> recites first three verses of the song"
+
+[c095af0d-3137-4653-ad32-bfb899eda24c]
+description = "lyrics -> recites three verses from the middle of the song"
+
+[20921bc9-cc52-4627-80b3-198cbbfcf9b7]
+description = "lyrics -> recites the whole song"

exercises/practice/twelve-days/run_test.v

@@ -0,0 +1,91 @@
+module main
+
+fn test_verse__first_day_a_partridge_in_a_pear_tree() {
+	expected := 'On the first day of Christmas my true love gave to me: a Partridge in a Pear Tree.'
+	assert recite(1, 1) == expected
+}
+
+fn test_verse__second_day_two_turtle_doves() {
+	expected := 'On the second day of Christmas my true love gave to me: two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(2, 2) == expected
+}
+
+fn test_verse__third_day_three_french_hens() {
+	expected := 'On the third day of Christmas my true love gave to me: three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(3, 3) == expected
+}
+
+fn test_verse__fourth_day_four_calling_birds() {
+	expected := 'On the fourth day of Christmas my true love gave to me: four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(4, 4) == expected
+}
+
+fn test_verse__fifth_day_five_gold_rings() {
+	expected := 'On the fifth day of Christmas my true love gave to me: five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(5, 5) == expected
+}
+
+fn test_verse__sixth_day_six_geese_a_laying() {
+	expected := 'On the sixth day of Christmas my true love gave to me: six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(6, 6) == expected
+}
+
+fn test_verse__seventh_day_seven_swans_a_swimming() {
+	expected := 'On the seventh day of Christmas my true love gave to me: seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(7, 7) == expected
+}
+
+fn test_verse__eighth_day_eight_maids_a_milking() {
+	expected := 'On the eighth day of Christmas my true love gave to me: eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(8, 8) == expected
+}
+
+fn test_verse__ninth_day_nine_ladies_dancing() {
+	expected := 'On the ninth day of Christmas my true love gave to me: nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(9, 9) == expected
+}
+
+fn test_verse__tenth_day_ten_lords_a_leaping() {
+	expected := 'On the tenth day of Christmas my true love gave to me: ten Lords-a-Leaping, nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(10, 10) == expected
+}
+
+fn test_verse__eleventh_day_eleven_pipers_piping() {
+	expected := 'On the eleventh day of Christmas my true love gave to me: eleven Pipers Piping, ten Lords-a-Leaping, nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(11, 11) == expected
+}
+
+fn test_verse__twelfth_day_twelve_drummers_drumming() {
+	expected := 'On the twelfth day of Christmas my true love gave to me: twelve Drummers Drumming, eleven Pipers Piping, ten Lords-a-Leaping, nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.'
+	assert recite(12, 12) == expected
+}
+
+fn test_lyrics__recites_first_three_verses_of_the_song() {
+	expected := ('On the first day of Christmas my true love gave to me: a Partridge in a Pear Tree.
+On the second day of Christmas my true love gave to me: two Turtle Doves, and a Partridge in a Pear Tree.
+On the third day of Christmas my true love gave to me: three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.')
+	assert recite(1, 3) == expected
+}
+
+fn test_lyrics__recites_three_verses_from_the_middle_of_the_song() {
+	expected := ('On the fourth day of Christmas my true love gave to me: four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the fifth day of Christmas my true love gave to me: five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the sixth day of Christmas my true love gave to me: six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.')
+	assert recite(4, 6) == expected
+}
+
+fn test_lyrics__recites_the_whole_song() {
+	expected := ('On the first day of Christmas my true love gave to me: a Partridge in a Pear Tree.
+On the second day of Christmas my true love gave to me: two Turtle Doves, and a Partridge in a Pear Tree.
+On the third day of Christmas my true love gave to me: three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the fourth day of Christmas my true love gave to me: four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the fifth day of Christmas my true love gave to me: five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the sixth day of Christmas my true love gave to me: six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the seventh day of Christmas my true love gave to me: seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the eighth day of Christmas my true love gave to me: eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the ninth day of Christmas my true love gave to me: nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the tenth day of Christmas my true love gave to me: ten Lords-a-Leaping, nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the eleventh day of Christmas my true love gave to me: eleven Pipers Piping, ten Lords-a-Leaping, nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.
+On the twelfth day of Christmas my true love gave to me: twelve Drummers Drumming, eleven Pipers Piping, ten Lords-a-Leaping, nine Ladies Dancing, eight Maids-a-Milking, seven Swans-a-Swimming, six Geese-a-Laying, five Gold Rings, four Calling Birds, three French Hens, two Turtle Doves, and a Partridge in a Pear Tree.')
+	assert recite(1, 12) == expected
+}

exercises/practice/twelve-days/twelve-days.v

@@ -0,0 +1,4 @@
+module main
+
+fn recite(start_verse int, end_verse int) string {
+}