Merge branch 'coursework/sprint-3' of https://github.com/HoussamLh/Module-Structuring-and-Testing-Data into coursework/sprint-3

Author: HoussamLh

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
-blank_issues_enabled: false
+blank_issues_enabled: true
 contact_links:
   - name: CYF
     url: [email protected]
@@ -8,7 +8,7 @@ contact_links:
     about: Join CYF here
   - name: CYF Slack
     url: codeyourfuture.slack.com
-    about: Come to #cyf-syllabus-tech and chat
+    about: Come to #cyf-curriculum and chat
   - name: CYF Tech Ed
     url: https://github.com/orgs/CodeYourFuture/teams/mentors
     about: CYF mentors on Github

.github/ISSUE_TEMPLATE/pd-assignment.yml

@@ -1,7 +1,7 @@
 name: PD Coursework
 description: Assign a piece of PD coursework
 title: "[PD] <title>"
-labels: [PD, 🏝 Priority Stretch, 🐇 Size Small]
+labels: [PD, 🏝 Priority Stretch, 🐇 Size Small, 📅 Sprint 1]
 body:
   - type: markdown
     attributes:

.github/ISSUE_TEMPLATE/tech-ed-assignment.yml

@@ -1,26 +1,34 @@
 name: Tech Ed Coursework
 description: Assign a piece of technical coursework
-title: "[TECH ED] <title>"
-labels: [Tech Ed, 🏕 Priority Mandatory, 🐂 Size Medium]
+title: "<title>"
+labels: [Tech Ed, 🏕 Priority Mandatory, 🐂 Size Medium, 📅 Sprint 1]
 body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to assign this coursework! 
+        Thanks for taking the time to assign this coursework!
 
-        To support our trainees with planning and prioritising their own learning journey, we want our coursework assignments to be more informative. 
+        To support our trainees with planning and prioritising their own learning journey, we want our coursework assignments to be more informative.
         We don't just want to tell them what to do, we want to tell them stuff like:
         - why we are doing it
         - what it's "for" (problem-solving, debugging, etc)
         - how long they should spend on it, maximum
-        - how to get help 
-        - how to review it with answers 
+        - how to get help
+        - how to review it with answers
         - how to get it reviewed from mentors and peers
   - type: input
     attributes:
       label: Link to the coursework
     validations:
       required: true
+  - type : textarea
+    attributes:
+      label: Learning Objectives
+      description: https://common.codeyourfuture.io/common-theme/shortcodes/objectives/
+      placeholder: |
+        <!--{{<objectives}}-->
+        - [ ] CYF format, task list formatting
+        <!--{{</objectives}}-->
   - type: textarea
     attributes:
       label: Why are we doing this?
@@ -37,14 +45,14 @@ body:
     attributes:
       label: How to get help
       description: State simply how trainees can get help with this assignment
-      placeholder: |
+      value: |
         Share your blockers in your class channel
-        https://syllabus.codeyourfuture.io/guides/asking-questions
+        https://curriculum.codeyourfuture.io/guides/getting-help/asking-questions/
   - type: textarea
     attributes:
       label: How to submit
       description: State in clear steps how a trainee can submit this assignment.
-      placeholder: |
+      value: |
         Fork the repo to your own GitHub account
         Make regular small commits with clear messages
         When you are ready, open a Pull Request to the CYF repo
@@ -72,9 +80,9 @@ body:
         1. Update labels
         - priority -- is this coursework key, mandatory, or stretch? Pick one.
         - size -- help trainees plan their time with rough estimation. Pick one
-        - topics -- add all that seem relevant to you. 
-        2. Add to milestone
-        - week 1,2,3,4
+        - topics -- add all that seem relevant to you.
+        2. Add a Sprint label to add to the backlog view
+        - sprint 1,2,3,4
 
         Once your ticket is complete, you may like to add it to the example project board attached to this repo.
         This is so you understand how trainees will use your work. Nobody has built a board copier yet, so trainees will be doing this step themselves.

.github/pull_request_template.md

@@ -2,26 +2,30 @@
 
 You must title your PR like this:
 
-REGION | COHORT_NAME | FIRST_NAME LAST_NAME | PROJ_NAME
+Region | Cohort | FirstName LastName | Sprint | Assignment Title
 
 For example,
 
-London | May-2025 | Carol Owen | Sprint-1
+London | 25-ITP-May | Carol Owen | Sprint 1 | Alarm Clock
 
-Complete the task list below this message.
-If your PR is rejected, check the task list.
+Fill in the template below - remove any sections that don't apply.
+
+Complete the self checklist - replace each empty box in the checklist [ ] with a [x].
+
+Add the label "Needs Review" and you will get review.
+
+Respond to volunteer reviews until the volunteer marks it as "Complete".
 
 -->
 
 ## Learners, PR Template
 
 Self checklist
 
-- [ ] I have committed my files one by one, on purpose, and for a reason
-- [ ] I have titled my PR with REGION | COHORT_NAME | FIRST_NAME LAST_NAME | PROJ_NAME
+- [ ] I have titled my PR with Region | Cohort | FirstName LastName | Sprint | Assignment Title
+- [ ] My changes meet the requirements of the task
 - [ ] I have tested my changes
-- [ ] My changes follow the [style guide](https://curriculum.codeyourfuture.io/guides/contributing/)
-- [ ] My changes meet the [requirements](./README.md) of this task
+- [ ] My changes follow the [style guide](https://curriculum.codeyourfuture.io/guides/reviewing/style-guide/)
 
 ## Changelist
 

.github/workflows/validate-pr-metadata.yml

@@ -0,0 +1,18 @@
+name: Validate PR Metadata
+on:
+  pull_request_target:
+    types:
+      - labeled
+      - unlabeled
+      - opened
+      - edited
+      - reopened
+
+jobs:
+  validate_pr_metadata:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: CodeYourFuture/actions/validate-pr-metadata@main
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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

@@ -0,0 +1,44 @@
+# Implement solutions and rewrite tests with Jest
+
+## 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`.

…nt-3/1-key-implement/1-get-angle-type.js …rite-tests/implement/1-get-angle-type.jsSprint-3/1-key-implement/1-get-angle-type.js renamed to Sprint-3/1-implement-and-rewrite-tests/implement/1-get-angle-type.js Sprint-3/1-key-implement/1-get-angle-type.js renamed to Sprint-3/1-implement-and-rewrite-tests/implement/1-get-angle-type.js

@@ -8,13 +8,25 @@
 // Then, write the next test! :) Go through this process until all the cases are implemented
 
 function getAngleType(angle) {
+<<<<<<< HEAD:Sprint-3/1-key-implement/1-get-angle-type.js
   if (angle === 90) return "Right angle";
   if (angle < 90) return "Acute angle";
   if (angle > 90 && angle < 180) return "Obtuse angle";
   if (angle === 180) return "Straight angle";
   if (angle > 180 && angle < 360) return "Reflex angle";
+=======
+  if (angle === 90) {
+    return "Right angle";
+  }
+   // Run the tests, work out what Case 2 is testing, and implement the required code here.
+   // Then keep going for the other cases, one at a time.
+>>>>>>> 8f3d6cf2d1733da02a010f1a16c46b8b5ab4c491:Sprint-3/1-implement-and-rewrite-tests/implement/1-get-angle-type.js
 }
 
+// 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;
+
 // we're going to use this helper function to make our assertions easier to read
 // if the actual output matches the target output, the test will pass
 function assertEquals(actualOutput, targetOutput) {

…/1-key-implement/2-is-proper-fraction.js …-tests/implement/2-is-proper-fraction.jsSprint-3/1-key-implement/2-is-proper-fraction.js renamed to Sprint-3/1-implement-and-rewrite-tests/implement/2-is-proper-fraction.js Sprint-3/1-key-implement/2-is-proper-fraction.js renamed to Sprint-3/1-implement-and-rewrite-tests/implement/2-is-proper-fraction.js

@@ -8,11 +8,21 @@
 // write one test at a time, and make it pass, build your solution up methodically
 
 function isProperFraction(numerator, denominator) {
+<<<<<<< HEAD:Sprint-3/1-key-implement/2-is-proper-fraction.js
   // Use absolute value of numerator to handle negatives
     if (numerator < denominator) return true;
     return false; // for all other cases
+=======
+  if (numerator < denominator) {
+    return true;
+  }
+>>>>>>> 8f3d6cf2d1733da02a010f1a16c46b8b5ab4c491:Sprint-3/1-implement-and-rewrite-tests/implement/2-is-proper-fraction.js
 }
 
+// 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(

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

@@ -0,0 +1,83 @@
+// This problem involves playing cards: https://en.wikipedia.org/wiki/Standard_52-card_deck
+
+// You will need to implement a function getCardValue
+// the function takes a single parameter, a string representing a playing card
+// the function should return the numerical value of the card
+// the first test and first case is written for you
+// complete the rest of the tests and cases
+// write one test at a time, and make it pass, build your solution up methodically
+// just make one change at a time -- don't rush -- programmers are deep and careful thinkers
+function getCardValue(card) {
+<<<<<<< HEAD:Sprint-3/1-key-implement/3-get-card-value.js
+  const rank = card.slice(0, -1); // remove the emoji 
+  if (rank === "A") return 11;
+  if (["K", "Q", "J", "10"].includes(rank)) return 10;
+  const number = Number(rank);
+  if (number >= 2 && number <= 9) return number;
+  throw new Error("Invalid card rank");
+=======
+  if (rank === "A") {
+    return 11;
+  }
+>>>>>>> 8f3d6cf2d1733da02a010f1a16c46b8b5ab4c491:Sprint-3/1-implement-and-rewrite-tests/implement/3-get-card-value.js
+}
+
+// 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;
+
+// You need to write assertions for your function to check it works in different cases
+// we're going to use this helper function 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}`
+  );
+}
+// Acceptance criteria:
+
+// Given a card string in the format "A♠" (representing a card in blackjack - the last character will always be an emoji for a suit, and all characters before will be a number 2-10, or one letter of J, Q, K, A),
+// When the function getCardValue is called with this card string as input,
+// Then it should return the numerical card value
+const aceofSpades = getCardValue("A♠");
+assertEquals(aceofSpades, 11);
+
+// Handle Number Cards (2-10):
+// Given a card with a rank between "2" and "9",
+// When the function is called with such a card,
+// Then it should return the numeric value corresponding to the rank (e.g., "5" should return 5).
+const fiveofHearts = getCardValue("5♥");
+assertEquals(fiveofHearts, 5);
+
+
+// Handle Face Cards (J, Q, K):
+// Given a card with a rank of "10," "J," "Q," or "K",
+// When the function is called with such a card,
+// Then it should return the value 10, as these cards are worth 10 points each in blackjack.
+const jackofClubs = getCardValue("J♣");
+assertEquals(jackofClubs, 10);
+
+const queenofDiamonds = getCardValue("Q♦");
+assertEquals(queenofDiamonds, 10);
+
+const kingofHearts = getCardValue("K♥");
+assertEquals(kingofHearts, 10);
+
+// Handle Ace (A):
+// Given a card with a rank of "A",
+// When the function is called with an Ace,
+// Then it should, by default, assume the Ace is worth 11 points, which is a common rule in blackjack.
+
+const aceofSpades = getCardValue("A♠");
+assertEquals(aceofSpades, 11);
+
+// Handle Invalid Cards:
+// Given a card with an invalid rank (neither a number nor a recognized face card),
+// When the function is called with such a card,
+// Then it should throw an error indicating "Invalid card rank."
+
+
+// getCardValue("Z♠"); // should throw "Invalid card rank"
+
+

…ndatory-rewrite/1-get-angle-type.test.js …tests-with-jest/1-get-angle-type.test.jsSprint-3/2-mandatory-rewrite/1-get-angle-type.test.js renamed to Sprint-3/1-implement-and-rewrite-tests/rewrite-tests-with-jest/1-get-angle-type.test.js Sprint-3/2-mandatory-rewrite/1-get-angle-type.test.js renamed to Sprint-3/1-implement-and-rewrite-tests/rewrite-tests-with-jest/1-get-angle-type.test.js

@@ -1,4 +1,6 @@
-const getAngleType = require("./1-get-angle-type");
+// 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");
 
 test("should identify right angle (90°)", () => {
   expect(getAngleType(90)).toEqual("Right angle");