feat(sprint-2): Restore Sprint 2 work into fresh subtree

Author: Tarawally

Sprint-2/debug/address.js

@@ -1,5 +1,10 @@
 // Predict and explain first...
 
+// This outputs undefined because address[0] tries to access an object like an array.
+// Objects use property names, not numeric indices.
+// References:
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors
+
 // This code should log out the houseNumber from the address object
 // but it isn't working...
 // Fix anything that isn't working
@@ -12,4 +17,5 @@ const address = {
   postcode: "XYZ 123",
 };
 
-console.log(`My house number is ${address[0]}`);
+// Fix: Dot notation accesses the property correctly
+console.log(`My house number is ${address.houseNumber}`);

Sprint-2/debug/author.js

@@ -1,5 +1,10 @@
 // Predict and explain first...
 
+// This throws a TypeError because plain objects cannot be used with for...of directly.
+// References:
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...of
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/values
+
 // 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
 
@@ -11,6 +16,7 @@ const author = {
   alive: true,
 };
 
-for (const value of author) {
+// Fix: Object.values() returns an array that can be looped over
+for (const value of Object.values(author)) {
   console.log(value);
 }

Sprint-2/debug/recipe.js

@@ -1,5 +1,11 @@
 // Predict and explain first...
 
+// This outputs [object Object] because putting an object in a template string calls toString().
+// The default toString() for objects just returns "[object Object]".
+// References:
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/toString
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join
+
 // This program should log out the title, how many it serves and the ingredients.
 // Each ingredient should be logged on a new line
 // How can you fix it?
@@ -10,6 +16,7 @@ const recipe = {
   ingredients: ["olive oil", "tomatoes", "salt", "pepper"],
 };
 
+// Fix: Accesses each property directly and uses join() to format the ingredients
 console.log(`${recipe.title} serves ${recipe.serves}
   ingredients:
-${recipe}`);
+${recipe.ingredients.join("\n")}`);

Sprint-2/implement/contains.js

@@ -1,3 +1,16 @@
-function contains() {}
+// Checks if an object has a specific property.
+// References:
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/typeof
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
+
+function contains(obj, propertyName) {
+  // Returns false for invalid inputs (null, arrays, or non-objects)
+  if (typeof obj !== "object" || obj === null || Array.isArray(obj)) {
+    return false;
+  }
+
+  return obj.hasOwnProperty(propertyName);
+}
 
 module.exports = contains;

Sprint-2/implement/contains.test.js

@@ -8,7 +8,7 @@ E.g. contains({a: 1, b: 2}, 'a') // returns true
 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'
+as the object doesn't contain a key of 'c'
 */
 
 // Acceptance criteria:
@@ -17,19 +17,54 @@ as the object doesn't contains a key of 'c'
 // When passed an object and a property name
 // Then it should return true if the object contains the property, false otherwise
 
+// Returns true when the property exists
+test("contains returns true if the property exists", () => {
+  expect(contains({ a: 1, b: 2 }, "a")).toBe(true);
+});
+
 // Given an empty object
 // When passed to contains
 // Then it should return false
-test.todo("contains on empty object returns false");
+
+// An empty object has no properties
+test("contains returns false for an empty object", () => {
+  expect(contains({}, "a")).toBe(false);
+});
 
 // Given an object with properties
 // When passed to contains with an existing property name
 // Then it should return true
 
+// Finds a named property in a typical object
+test("contains returns true for another property that exists", () => {
+  expect(contains({ name: "Lisa", age: 73 }, "name")).toBe(true);
+});
+
 // Given an object with properties
-// When passed to contains with a non-existent property name
+// When passed to contains with a property name that does not exist
+// Then it should return false
+
+// Returns false for a missing property
+test("contains returns false for a property that does not exist", () => {
+  expect(contains({ name: "Leo", age: 19 }, "height")).toBe(false);
+});
+
+// Given an object
+// When passed to contains with a property that does not exist
 // Then it should return false
 
+// Returns false for a property not in the object
+test("contains returns false when the property is not present", () => {
+  expect(contains({ a: 1, b: 2 }, "c")).toBe(false);
+});
+
 // Given invalid parameters like an array
 // When passed to contains
 // Then it should return false or throw an error
+
+// Handles invalid inputs gracefully
+test("contains handles invalid parameters", () => {
+  expect(contains([], "a")).toBe(false);
+  expect(contains(null, "a")).toBe(false);
+  expect(contains(undefined, "a")).toBe(false);
+});

Sprint-2/implement/lookup.js

@@ -1,5 +1,20 @@
-function createLookup() {
-  // implementation here
+// Converts an array of pairs into a lookup object.
+// References:
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...of
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors#bracket_notation
+
+function createLookup(arrayOfPairs) {
+  const lookupObject = {};
+
+  for (const pair of arrayOfPairs) {
+    const key = pair[0];
+    const value = pair[1];
+
+    // Bracket notation allows using a variable as the property name
+    lookupObject[key] = value;
+  }
+
+  return lookupObject;
 }
 
 module.exports = createLookup;

Sprint-2/implement/lookup.test.js

@@ -1,7 +1,5 @@
 const createLookup = require("./lookup.js");
 
-test.todo("creates a country currency code lookup for multiple codes");
-
 /*
 
 Create a lookup object of key value pairs from an array of code pairs
@@ -33,3 +31,18 @@ It should return:
    'CA': 'CAD'
  }
 */
+
+// Converts multiple pairs into a lookup object
+test("creates a country currency code lookup for multiple codes", () => {
+  const input = [
+    ["US", "USD"],
+    ["CA", "CAD"],
+  ];
+
+  const expectedOutput = {
+    US: "USD",
+    CA: "CAD",
+  };
+
+  expect(createLookup(input)).toEqual(expectedOutput);
+});

Sprint-2/implement/querystring.js

@@ -1,12 +1,26 @@
+// Parses a query string into an object.
+// References:
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice
+
 function parseQueryString(queryString) {
   const queryParams = {};
+
+  // Returns early if the string is empty
   if (queryString.length === 0) {
     return queryParams;
   }
+
   const keyValuePairs = queryString.split("&");
 
   for (const pair of keyValuePairs) {
-    const [key, value] = pair.split("=");
+    // Finds only the first "=" since values may contain "=" too
+    const firstEqualsIndex = pair.indexOf("=");
+
+    const key = pair.slice(0, firstEqualsIndex);
+    const value = pair.slice(firstEqualsIndex + 1);
+
     queryParams[key] = value;
   }
 

Sprint-2/implement/querystring.test.js

@@ -3,10 +3,54 @@
 // Below is one test case for an edge case the implementation doesn't handle well.
 // Fix the implementation for this test, and try to think of as many other edge cases as possible - write tests and fix those too.
 
-const parseQueryString = require("./querystring.js")
+const parseQueryString = require("./querystring.js");
 
+// Handles values containing "="
 test("parses querystring values containing =", () => {
   expect(parseQueryString("equation=x=y+1")).toEqual({
-    "equation": "x=y+1",
+    equation: "x=y+1",
+  });
+});
+
+// Parses a simple key-value pair
+test("parses a simple key-value pair", () => {
+  expect(parseQueryString("name=John")).toEqual({
+    name: "Samantha",
+  });
+});
+
+// Parses multiple pairs separated by "&"
+test("parses multiple key-value pairs", () => {
+  expect(parseQueryString("name=John&age=25")).toEqual({
+    name: "Samantha",
+    age: "33",
+  });
+});
+
+// Returns an empty object for an empty string
+test("returns an empty object for an empty string", () => {
+  expect(parseQueryString("")).toEqual({});
+});
+
+// Handles keys with empty values
+test("parses a key with no value after the equals sign", () => {
+  expect(parseQueryString("name=")).toEqual({
+    name: "",
+  });
+});
+
+// Preserves multiple "=" in values
+test("parses querystring with multiple = signs in value", () => {
+  expect(parseQueryString("formula=a=b=c")).toEqual({
+    formula: "a=b=c",
+  });
+});
+
+// Handles a mix of simple and complex values
+test("parses mixed simple and complex key-value pairs", () => {
+  expect(parseQueryString("name=John&equation=1+1=2&city=London")).toEqual({
+    name: "Samantha",
+    equation: "1+1=2",
+    city: "London",
   });
 });

Sprint-2/implement/tally.js

@@ -1,3 +1,30 @@
-function tally() {}
+// Counts how often each item appears in an array.
+// References:
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
+// - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...of
+
+function tally(arrayOfItems) {
+  // Checks the input is actually an array
+  const inputIsNotAnArray = !Array.isArray(arrayOfItems);
+
+  if (inputIsNotAnArray) {
+    throw new Error("Input must be an array");
+  }
+
+  const countObject = {};
+
+  for (const item of arrayOfItems) {
+    // If the item is already counted, add 1; otherwise start at 1
+    const itemAlreadyCounted = countObject[item] !== undefined;
+
+    if (itemAlreadyCounted) {
+      countObject[item] = countObject[item] + 1;
+    } else {
+      countObject[item] = 1;
+    }
+  }
+
+  return countObject;
+}
 
 module.exports = tally;