restored deleted files

Author: Pretty Taruvinga

Sprint-3/1-implement-and-rewrite-tests/README.md

@@ -0,0 +1,47 @@
+# Implement solutions and rewrite tests with Jest
+
+Before writing any code, please read the [Testing Function Guide](testing-guide.md) to learn how
+to choose test values that thoroughly test a function.
+
+## 1 Implement solutions
+
+In the `implement` directory you've got a number of functions you'll need to implement.
+For each function, you also have a number of different cases you'll need to check for your function.
+
+Write your assertions and build up your program case by case. Don't rush to a solution. The point of these assignments is to learn how to write assertions and build up a program step by step.
+
+Here is a recommended order:
+
+1. `1-get-angle-type.js`
+2. `2-is-proper-fraction.js`
+3. `3-get-card-value.js`
+
+## 2 Rewrite tests with Jest
+
+`console.log` is most often used as a debugging tool. We use to inspect the state of our program during runtime.
+
+We can use `console.assert` to write assertions: however, it is not very easy to use when writing large test suites. In the first section, Implement, we used a custom "helper function" to make our assertions more readable.
+
+Jest is a whole library of helper functions we can use to make our assertions more readable and easier to write.
+
+Your new task is to write the same tests as you wrote in the `implement` directory, but using Jest instead of `console.assert`.
+
+You shouldn't have to change the contents of `implement` to write these tests.
+
+There are files for your Jest tests in the `rewrite-tests-with-jest` directory. They will automatically use the functions you already implemented.
+
+You can run all the tests in this repo by running `npm test` in your terminal. However, VSCode has a built-in test runner that you can use to run the tests, and this should make it much easier to focus on building up your test cases one at a time.
+
+https://code.visualstudio.com/docs/editor/testing
+
+1. Go to rewrite-tests-with-jest/1-get-angle-type.test.js
+2. Click the green play button to run the test. It's on the left of the test function in the gutter.
+3. Read the output in the TEST_RESULTS tab at the bottom of the screen.
+4. Explore all the tests in this repo by opening the TEST EXPLORER tab. The logo is a beaker.
+
+![VSCode Test Runner](../../run-this-test.png)
+
+![Test Results](../../test-results-output.png)
+
+> [!TIP]
+> You can always run a single test file by running `npm test path/to/test-file.test.js`.

Sprint-3/1-implement-and-rewrite-tests/implement/1-get-angle-type.js

@@ -0,0 +1,37 @@
+// Implement a function getAngleType
+//
+// When given an angle in degrees, it should return a string indicating the type of angle:
+// - "Acute angle" for angles greater than 0° and less than 90°
+// - "Right angle" for exactly 90°
+// - "Obtuse angle" for angles greater than 90° and less than 180°
+// - "Straight angle" for exactly 180°
+// - "Reflex angle" for angles greater than 180° and less than 360°
+// - "Invalid angle" for angles outside the valid range.
+
+// Assumption: The parameter is a valid number. (You do not need to handle non-numeric inputs.)
+
+// Acceptance criteria:
+// After you have implemented the function, write tests to cover all the cases, and
+// execute the code to ensure all tests pass.
+
+function getAngleType(angle) {
+  // TODO: Implement this function
+}
+
+// The line below allows us to load the getAngleType function into tests in other files.
+// This will be useful in the "rewrite tests with jest" step.
+module.exports = getAngleType;
+
+// This helper function is written to make our assertions easier to read.
+// If the actual output matches the target output, the test will pass
+function assertEquals(actualOutput, targetOutput) {
+  console.assert(
+    actualOutput === targetOutput,
+    `Expected ${actualOutput} to equal ${targetOutput}`
+  );
+}
+
+// TODO: Write tests to cover all cases, including boundary and invalid cases.
+// Example: Identify Right Angles
+const right = getAngleType(90);
+assertEquals(right, "Right angle");

Sprint-3/1-implement-and-rewrite-tests/implement/2-is-proper-fraction.js

@@ -0,0 +1,33 @@
+// Implement a function isProperFraction,
+// when given two numbers, a numerator and a denominator, it should return true if
+// the given numbers form a proper fraction, and false otherwise.
+
+// Assumption: The parameters are valid numbers (not NaN or Infinity).
+
+// Note: If you are unfamiliar with proper fractions, please look up its mathematical definition.
+
+// Acceptance criteria:
+// After you have implemented the function, write tests to cover all the cases, and
+// execute the code to ensure all tests pass.
+
+function isProperFraction(numerator, denominator) {
+  // TODO: Implement this function
+}
+
+// The line below allows us to load the isProperFraction function into tests in other files.
+// This will be useful in the "rewrite tests with jest" step.
+module.exports = isProperFraction;
+
+// Here's our helper again
+function assertEquals(actualOutput, targetOutput) {
+  console.assert(
+    actualOutput === targetOutput,
+    `Expected ${actualOutput} to equal ${targetOutput}`
+  );
+}
+
+// TODO: Write tests to cover all cases.
+// What combinations of numerators and denominators should you test?
+
+// Example: 1/2 is a proper fraction
+assertEquals(isProperFraction(1, 2), true);

Sprint-3/1-implement-and-rewrite-tests/implement/3-get-card-value.js

@@ -0,0 +1,52 @@
+// This problem involves playing cards: https://en.wikipedia.org/wiki/Standard_52-card_deck
+
+// Implement a function getCardValue, when given a string representing a playing card,
+// should return the numerical value of the card.
+
+// A valid card string will contain a rank followed by the suit.
+// The rank can be one of the following strings:
+//   "A", "2", "3", "4", "5", "6", "7", "8", "9", "10", "J", "Q", "K"
+// The suit can be one of the following emojis:
+//   "♠", "♥", "♦", "♣"
+// For example: "A♠", "2♥", "10♥", "J♣", "Q♦", "K♦".
+
+// When the card is an ace ("A"), the function should return 11.
+// When the card is a face card ("J", "Q", "K"), the function should return 10.
+// When the card is a number card ("2" to "10"), the function should return its numeric value.
+
+// When the card string is invalid (not following the above format), the function should
+// throw an error.
+
+// Acceptance criteria:
+// After you have implemented the function, write tests to cover all the cases, and
+// execute the code to ensure all tests pass.
+
+function getCardValue(card) {
+  // TODO: Implement this function
+}
+
+// The line below allows us to load the getCardValue function into tests in other files.
+// This will be useful in the "rewrite tests with jest" step.
+module.exports = getCardValue;
+
+// Helper functions to make our assertions easier to read.
+function assertEquals(actualOutput, targetOutput) {
+  console.assert(
+    actualOutput === targetOutput,
+    `Expected ${actualOutput} to equal ${targetOutput}`
+  );
+}
+
+// TODO: Write tests to cover all outcomes, including throwing errors for invalid cards.
+// Examples:
+assertEquals(getCardValue("9♠"), 9);
+
+// Handling invalid cards
+try {
+  getCardValue("invalid");
+
+  // This line will not be reached if an error is thrown as expected
+  console.error("Error was not thrown for invalid card");
+} catch (e) {}
+
+// What other invalid card cases can you think of?

Sprint-3/1-implement-and-rewrite-tests/rewrite-tests-with-jest/1-get-angle-type.test.js

@@ -0,0 +1,20 @@
+// This statement loads the getAngleType function you wrote in the implement directory.
+// We will use the same function, but write tests for it using Jest in this file.
+const getAngleType = require("../implement/1-get-angle-type");
+
+// TODO: Write tests in Jest syntax to cover all cases/outcomes,
+// including boundary and invalid cases.
+
+// Case 1: Acute angles
+test(`should return "Acute angle" when (0 < angle < 90)`, () => {
+  // Test various acute angles, including boundary cases
+  expect(getAngleType(1)).toEqual("Acute angle");
+  expect(getAngleType(45)).toEqual("Acute angle");
+  expect(getAngleType(89)).toEqual("Acute angle");
+});
+
+// Case 2: Right angle
+// Case 3: Obtuse angles
+// Case 4: Straight angle
+// Case 5: Reflex angles
+// Case 6: Invalid angles

Sprint-3/1-implement-and-rewrite-tests/rewrite-tests-with-jest/2-is-proper-fraction.test.js

@@ -0,0 +1,10 @@
+// This statement loads the isProperFraction function you wrote in the implement directory.
+// We will use the same function, but write tests for it using Jest in this file.
+const isProperFraction = require("../implement/2-is-proper-fraction");
+
+// TODO: Write tests in Jest syntax to cover all combinations of positives, negatives, zeros, and other categories.
+
+// Special case: numerator is zero
+test(`should return false when denominator is zero`, () => {
+  expect(isProperFraction(1, 0)).toEqual(false);
+});

Sprint-3/1-implement-and-rewrite-tests/rewrite-tests-with-jest/3-get-card-value.test.js

@@ -0,0 +1,20 @@
+// This statement loads the getCardValue function you wrote in the implement directory.
+// We will use the same function, but write tests for it using Jest in this file.
+const getCardValue = require("../implement/3-get-card-value");
+
+// TODO: Write tests in Jest syntax to cover all possible outcomes.
+
+// Case 1: Ace (A)
+test(`Should return 11 when given an ace card`, () => {
+  expect(getCardValue("A♠")).toEqual(11);
+});
+
+// Suggestion: Group the remaining test data into these categories:
+//   Number Cards (2-10)
+//   Face Cards (J, Q, K)
+//   Invalid Cards
+
+// To learn how to test whether a function throws an error as expected in Jest,
+// please refer to the Jest documentation:
+// https://jestjs.io/docs/expect#tothrowerror
+

Sprint-3/1-implement-and-rewrite-tests/testing-guide.md

@@ -0,0 +1,92 @@
+# A Beginner's Guide to Testing Functions
+
+## 1. What Is a Function?
+
+```
+Input  ──▶  Function  ──▶  Output
+```
+
+A function
+- Takes **input** (via **arguments**)
+- Does some work
+- Produces **one output** (via a **return value**)
+ 
+Example:
+
+```
+sum(2, 3) → 5
+```
+
+Important idea: the same input should produce the same output.
+
+
+## 2. Testing Means Predicting
+
+Testing means: 
+> If I give this input, what output should I get?
+
+
+## 3. Choosing Good Test Values
+
+### Step 1: Determining the space of possible inputs
+Ask:
+- What type of value is expected?
+- What values make sense?
+  - If they are numbers:
+    - Are they integers or floating-point numbers?
+    - What is their range?
+  - If they are strings:
+    - What are their length and patterns?
+- What values would not make sense?
+
+### Step 2: Choosing Good Test Values 
+
+#### Normal Cases
+
+These confirm that the function works in normal use.
+
+- What does a typical, ordinary input look like?
+- Are there multiple ordinary groups of inputs? e.g. for an age checking function, maybe there are "adults" and "children" as expected ordinary groups of inputs.
+
+  
+#### Boundary Cases
+
+Test values exactly at, just inside, and just outside defined ranges. 
+These values are where logic breaks most often.
+
+#### Consider All Outcomes
+
+Every outcome must be reached by at least one test.
+
+- How many different results can this function produce?
+- Have I tested a value that leads to each one?
+
+#### Crossing the Edges and Invalid Values
+
+This tests how the function behaves when assumptions are violated.
+- What happens when input is outside of the expected range?
+- What happens when input is not of the expected type?
+- What happens when input is not in the expected format?
+
+## 4. How to Test
+
+### 1. Using `console.assert()`
+
+```javascript
+  // Report a failure only when the first argument is false
+  console.assert( sum(4, 6) === 10, "Expected 4 + 6 to equal 10" );
+```
+
+It is simpler than using `if-else` and requires no setup.
+  
+### 2. Jest Testing Framework
+
+```javascript
+  test("Should correctly return the sum of two positive numbers", () => {
+    expect( sum(4, 6) ).toEqual(10);
+    ... // Can test multiple samples 
+  });
+
+```
+
+Jest supports many useful functions for testing but requires additional setup.