final sweep of module js2

Dedekind561 · Dedekind561 · commit df0854177eea · 2023-10-24T16:54:30.000+01:00
diff --git a/week-1/fix/median.js b/week-1/fix/median.js
@@ -1,5 +1,6 @@
-// fix this implementation
-// start by running the tests for this function
+// Fix this implementation
+// Start by running the tests for this function
+// If you're in the week-1 directory, you can run npm test -- fix to run the tests in the fix directory
 
 function calculateMedian(list) {
   const middleIndex = Math.floor(list.length / 2);
diff --git a/week-1/implement/dedupe.test.js b/week-1/implement/dedupe.test.js
@@ -2,7 +2,7 @@ const dedupe = require("./dedupe.js");
 /*
 Dedupe Array
 
-📖 Dedupe means deduplicate
+📖 Dedupe means **deduplicate**
 
 In this kata, you will need to deduplicate the elements of an array
 
diff --git a/week-1/implement/max.test.js b/week-1/implement/max.test.js
@@ -1,4 +1,4 @@
-/* find the maximum element of an array of numbers
+/* Find the maximum element of an array of numbers
 
 In this kata, you will need to implement a function that sums the numerical elements of an array
 
diff --git a/week-1/implement/sum.test.js b/week-1/implement/sum.test.js
@@ -1,4 +1,4 @@
-/* sum the numbers in an array
+/* Sum the numbers in an array
 
 In this kata, you will need to implement a function that sums the numerical elements of an array
 
diff --git a/week-1/readme.md b/week-1/readme.md
@@ -14,20 +14,32 @@ To run tests in the `week-1` directory you can:
 1. Change directory into `week-1`
 2. Run the tests using `npm test`
 
-## Exercises
+## Fix
 
-In this section, you'll have a short program and task. Some of the syntax may be unfamiliar - in this case, you'll need to look things up in documentation.
+In this section, you'll have a function and some tests. The function isn't working for all the tests - you'll need to:
 
-## Errors
+- run the tests
+- interpret the test feedback
+- fix the tests
 
-In this section, you'll need to go to each file in `errors` directory and run the file with node to check what the error is. Your task is to interpret the error message and explain why it occurs. The [errors documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors) will help you figure out the solution.
+To run the tests for the `fix` directory you can `cd` into `week-1` and run `npm test -- fix`.
 
-## Interpret
+## 🔨 Implement
 
-In these tasks, you have to interpret a slightly larger program with some syntax / operators / functions that may be unfamiliar.
-You must use documentation to make sense of anything unfamiliar - learning how to look things up this way is a fundamental part of being a developer!
-You can also use `console.log` to check the value of different variables in the code.
+In this section, you will have a short set of requirements about a function. You will need to implement a function based off this set of requirements. Make sure you check your function works for a number of different inputs.
 
-## Explore - Stretch 💪
+Here is a recommended order:
 
-This stretch activity will get you to start exploring new concepts and environments by yourself. It will do so by prompting you to reflect on some questions.
+1. `max.test.js`
+2. `sum.test.js`
+3. `dedupe.test.js`
+
+## 🧹 Refactor
+
+In these problems, you'll be given an implementation and then asked to change it. Once you've updated the implementations you'll need to double check that they are still working!
+
+Once you've completed all these tasks, raise a PR with your work so far. Don't wait to complete your coursework before completing the PR.
+
+## Stretch 💪
+
+Try the more challenging problem from Advent of Code!
diff --git a/week-2/debug/address.js b/week-2/debug/address.js
@@ -1,7 +1,8 @@
-// predict and explain first...
+// Predict and explain first...
 
-// this code should log out the houseNumber from the address object
+// This code should log out the houseNumber from the address object
 // but it isn't working...
+// Fix anything that isn't working
 
 const address = {
   houseNumber: 42,
diff --git a/week-2/debug/author.js b/week-2/debug/author.js
@@ -0,0 +1,16 @@
+// Predict and explain first...
+
+// This program attempts to log out all the property values in the object.
+// But it isn't working. Explain why first and then fix the problem
+
+const author = {
+  firstName: "Zadie",
+  lastName: "Smith",
+  occupation: "writer",
+  age: 40,
+  alive: true,
+};
+
+for (const value of author) {
+  console.log(value);
+}
diff --git a/week-2/debug/authors.js b/week-2/debug/authors.js
diff --git a/week-2/debug/recipe.js b/week-2/debug/recipe.js
@@ -1,4 +1,4 @@
-// predict and explain first...
+// Predict and explain first...
 
 // This program should log out the title, how many it serves and the ingredients.
 // Each ingredient should be logged on a new line
@@ -12,4 +12,4 @@ const recipe = {
 
 console.log(`${recipe.title} serves ${recipe.serves}
   ingredients:
-  ${recipe}`);
+${recipe}`);
diff --git a/week-2/errors/0.js b/week-2/errors/0.js
diff --git a/week-2/errors/1.js b/week-2/errors/1.js
diff --git a/week-2/errors/2.js b/week-2/errors/2.js
diff --git a/week-2/implement/contains.test.js b/week-2/implement/contains.test.js
@@ -9,27 +9,26 @@ as the object contains a key of 'a'
 
 E.g. contains({a : 1, b : 2},'c') // returns false
 as the object doesn't contains a key of 'c'
+*/
 
-Acceptance criteria:
-
-Given a contains function
-When passed an object and a property name
-Then it should return true if the object contains the property, false otherwise
+// Acceptance criteria:
 
-Given an empty object
-When passed to contains
-Then it should return false
+// Given a contains function
+// When passed an object and a property name
+// Then it should return true if the object contains the property, false otherwise
 
-Given an object with properties
-When passed to contains with an existing property name
-Then it should return true
+// Given an empty object
+// When passed to contains
+// Then it should return false
 
-Given an object with properties
-When passed to contains with a non-existent property name
-Then it should return false
+// Given an object with properties
+// When passed to contains with an existing property name
+// Then it should return true
 
-Given invalid parameters like arrays
-When passed to contains
-Then it should return false or throw an error
+// Given an object with properties
+// When passed to contains with a non-existent property name
+// Then it should return false
 
-*/
+// Given invalid parameters like arrays
+// When passed to contains
+// Then it should return false or throw an error
diff --git a/week-2/implement/lookup.test.js b/week-2/implement/lookup.test.js
@@ -13,8 +13,8 @@ When
 
 Then
  - It should return an object where:
-   - The keys are the country codes
-   - The values are the corresponding currency codes
+ - The keys are the country codes
+ - The values are the corresponding currency codes
 
 Example
 Given: [['US', 'USD'], ['CA', 'CAD']]
diff --git a/week-2/implement/tally.test.js b/week-2/implement/tally.test.js
@@ -10,23 +10,22 @@
  * tally(['a']), target output: { a: 1 }
  * tally(['a','a','a']), target output: { a: 3 }
  * tally(['a','a','b','c']), target output: { a : 2, b: 1, c: 1 }
- *
- * Acceptance criteria:
- *
- * Given a function called tally
- * When passed an array of items
- * Then it should return an object containing the count for each unique item
- *
- * Given an empty array
- * When passed to tally
- * Then it should return an empty object
- *
- * Given an array with duplicate items
- * When passed to tally
- * Then it should return counts for each unique item
- *
- * Given an invalid parameter like a string
- * When passed to tally
- * Then it should throw an error
- *
  */
+
+// Acceptance criteria:
+
+// Given a function called tally
+// When passed an array of items
+// Then it should return an object containing the count for each unique item
+
+// Given an empty array
+// When passed to tally
+// Then it should return an empty object
+
+// Given an array with duplicate items
+// When passed to tally
+// Then it should return counts for each unique item
+
+// Given an invalid input like a string
+// When passed to tally
+// Then it should throw an error
diff --git a/week-2/interpret/invert.js b/week-2/interpret/invert.js
@@ -1,3 +1,11 @@
+// Let's define how invert should work
+
+// Given an object
+// When invert is passed this object
+// Then it should swap the keys and values in the object
+
+// E.g. invert({x : 10, y : 20}), target output: {"10": "x", "20": "y"}
+
 function invert(obj) {
   const invertedObj = {};
 
@@ -14,6 +22,6 @@ function invert(obj) {
 
 // c) What is the target return value when invert is called with {a : 1, b: 2}
 
-// c) What does Object.entries return? Why is it needed in this problem?
+// c) What does Object.entries return? Why is it needed in this program?
 
 // d) Explain why the current return value is different from the target output
diff --git a/week-2/readme.md b/week-2/readme.md
@@ -14,20 +14,28 @@ To run tests in the `week-2` directory you can:
 1. Change directory into `week-2`
 2. Run the tests using `npm test`
 
-## Exercises
+## 🐛 Debug
 
-In this section, you'll have a short program and task. Some of the syntax may be unfamiliar - in this case, you'll need to look things up in documentation.
+Each of the files in `debug` contains a 🐛. Predict and explain first and then run the code with node to check your prediction. Fix any bugs that appear in the code.
 
-## Errors
+## 🔨 Implement
 
-In this section, you'll need to go to each file in `errors` directory and run the file with node to check what the error is. Your task is to interpret the error message and explain why it occurs. The [errors documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors) will help you figure out the solution.
+In this section, you will have a short set of requirements about a function. You will need to implement a function based off this set of requirements. Make sure you check your function works for a number of different inputs.
+
+Here is a recommended order:
+
+1. `contains.test.js`
+2. `lookup.test.js`
+3. `tally.test.js`
 
 ## Interpret
 
 In these tasks, you have to interpret a slightly larger program with some syntax / operators / functions that may be unfamiliar.
 You must use documentation to make sense of anything unfamiliar - learning how to look things up this way is a fundamental part of being a developer!
 You can also use `console.log` to check the value of different variables in the code.
 
-## Explore - Stretch 💪
+Once you've completed all these tasks, raise a PR with your work so far. Don't wait to complete your coursework before completing the PR.
+
+## Stretch 💪
 
-This stretch activity will get you to start exploring new concepts and environments by yourself. It will do so by prompting you to reflect on some questions.
+Try the stretch tasks after you've completed the other sections.
diff --git a/week-2/stretch/till.js b/week-2/stretch/till.js
@@ -23,8 +23,10 @@ const till = {
 };
 const totalAmount = totalTill(till);
 
-// a) What is the target output for when totalTill is called with till
+// a) What is the target output when totalTill is called with the till object
 
 // b) Why do we need to use Object.entries inside the for...of loop in this function?
 
 // c) What does coin * quantity evaluate to inside the for...of loop?
+
+// d) Write a test for this function to check it works and then fix the implementation of totalTill
diff --git a/week-2/writers.js b/week-2/writers.js

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/* find the maximum element of an array of numbers`
	`1`	`+/* Find the maximum element of an array of numbers`
`2`	`2`
`3`	`3`	`In this kata, you will need to implement a function that sums the numerical elements of an array`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/* sum the numbers in an array`
	`1`	`+/* Sum the numbers in an array`
`2`	`2`
`3`	`3`	`In this kata, you will need to implement a function that sums the numerical elements of an array`
`4`	`4`