Skip to content
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion Sprint-3/2-practice-tdd/count.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
function countChar(stringOfCharacters, findCharacter) {
return 5
if (arguments.length !== 2) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That looks good, but can we be more specific about which arguments we are expecting? Using " arguments" works, but in my experience is not very common.

throw new Error(
"Function requires exactly two arguments: a string and a character to find."
);
}
if (typeof stringOfCharacters !== 'string'){
throw new Error("First argument must be a string.");
}
if (typeof findCharacter !== "string") {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we wrap up this condition and the condition above into a single condition ?

throw new Error("Second argument must be a string.");
}
if (findCharacter.length !== 1) {
throw new Error("Character to find must be a single character.");
}
if (stringOfCharacters.length === 0) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would that be the same as
(!stringOfCharacters.length) ?

return 0;
}
return Array.from(stringOfCharacters).filter(char => char === findCharacter).length;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we use spread operator here ? [...stringOfCharacters] ?

}

module.exports = countChar;
92 changes: 92 additions & 0 deletions Sprint-3/2-practice-tdd/count.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,95 @@ test("should count multiple occurrences of a character", () => {
// And a character char that does not exist within the case-sensitive str,
// When the function is called with these inputs,
// Then it should return 0, indicating that no occurrences of the char were found in the case-sensitive str.
test("should return 0 if no occurrences of a character", () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These unit tests are good but they are a bit slim. Can you think of corner and edge cases that your function might encounter? What if, for example, other data types or not all parameters are passed? Thinking about these scenarios will make your function more robust and your tests more thorough.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

const str = "bbbbbb";
const char = "a";
const count = countChar(str, char);
expect(count).toEqual(0);
});

// Scenario: Single Occurrence
test("should return 1 for a single occurrence of a character", () => {
const str = "hello";
const char = "e";
const count = countChar(str, char);
expect(count).toEqual(1);
});

// Scenario: Case Sensitivity
test("should be case sensitive when counting characters", () => {
const str = "Hello World";
const char = "h";
const count = countChar(str, char);
expect(count).toEqual(0);
});

// Scenario: Empty String
test("should return 0 when the input string is empty", () => {
const str = "";
const char = "a";
const count = countChar(str, char);
expect(count).toEqual(0);
});

// Scenario: Numeric Characters
test("should count numeric characters in the string", () => {
const str = "123123123";
const char = "2";
const count = countChar(str, char);
expect(count).toEqual(3);
});

// Scenario: Whitespace Characters
test("should count whitespace characters in the string", () => {
const str = "a b c d e f ";
const char = " ";
const count = countChar(str, char);
expect(count).toEqual(6);
});

// Scenario: Edge Case - Character Not a Single Character
test('should throw error if char is not a single character', () => {
const str = 'hello';
const char = 'll';
expect(() => {
countChar(str, char);
}).toThrow('Character to find must be a single character');
})

// Scenario: Special Case - Special Characters
test.each([
{ str: "!!!@@@###", char: "!", expected: 3 },
{ str: "$$$%%%^^^", char: "%", expected: 3 },
{ str: "&&&***(((", char: "(", expected: 3 },
])(
"should count special characters correctly in '$str'",
({ str, char, expected }) => {
const count = countChar(str, char);
expect(count).toEqual(expected);
}
);
//Scenario: Invalid Input Types
test.each([
{ str: 12345, char: "a", error: "First argument must be a string." },
{ str: "hello", char: 5, error: "Second argument must be a string." },
{ str: [], char: "a", error: "First argument must be a string." },
{ str: "hello", char: {}, error: "Second argument must be a string." },
{ str: null, char: "a", error: "First argument must be a string." },
{str: "hi", char: undefined, error: "Second argument must be a string." },
])("should throw error for invalid inputs", ({ str, char, error }) => {
expect(() => {
countChar(str, char);
}).toThrow(error);
});
//test for 2 arguments
test("should throw error if more/less than 2 arguments are provided", () => {
expect(() => {
countChar("hello");
}).toThrow("Function requires exactly two arguments: a string and a character to find.");
expect(() => {
countChar("hello", "h", "extra");
}).toThrow(
"Function requires exactly two arguments: a string and a character to find."
);
});
36 changes: 35 additions & 1 deletion Sprint-3/2-practice-tdd/get-ordinal-number.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,39 @@
function getOrdinalNumber(num) {
return "1st";
if (arguments.length !== 1) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, can we be more specific about which arguments we are referring to?

throw new Error("Function requires exactly one argument");
}
if (typeof num !== "number") {
throw new Error("Input must be a number");
}
if (!isFinite(num)) {
throw new Error("Input must be a finite number");
}
if (!Number.isInteger(num) || num < 0) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we wrap all these conditions in one statement ?

throw new Error("Input must be a non-negative integer");
}


switch (num % 100) {
case 11:
case 12:
case 13:
return num + "th";
break;
}
switch (num % 10) {
case 1:
return num + "st";
break;
case 2:
return num + "nd";
break;
case 3:
return num + "rd";
break;
default:
return num + "th";
break;
}
}

module.exports = getOrdinalNumber;
94 changes: 94 additions & 0 deletions Sprint-3/2-practice-tdd/get-ordinal-number.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,97 @@ const getOrdinalNumber = require("./get-ordinal-number");
test("should return '1st' for 1", () => {
expect(getOrdinalNumber(1)).toEqual("1st");
});

test("should return '2nd' for 2", () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as my previous comment. What if someone passes "3", undefined, or another unexpected value to your function? I understand your assumptions, but users of your functions (both internal within your team and external if you build some sort of API) can pass values you didn't safeguard against, which can break your function.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

expect(getOrdinalNumber(2)).toEqual("2nd");
});

test("should return '3rd' for 3", () => {
expect(getOrdinalNumber(3)).toEqual("3rd");
});

test("should return '4th' for 4", () => {
expect(getOrdinalNumber(4)).toEqual("4th");
});

test("should return '11th' for 11", () => {
expect(getOrdinalNumber(11)).toEqual("11th");
});

test("should return '12th' for 12", () => {
expect(getOrdinalNumber(12)).toEqual("12th");
});

test("should return '13th' for 13", () => {
expect(getOrdinalNumber(13)).toEqual("13th");
});

test("should return '21st' for 21", () => {
expect(getOrdinalNumber(21)).toEqual("21st");
});

test("should return '22nd' for 22", () => {
expect(getOrdinalNumber(22)).toEqual("22nd");
});

test("should return '23rd' for 23", () => {
expect(getOrdinalNumber(23)).toEqual("23rd");
});

test("should return '101st' for 101", () => {
expect(getOrdinalNumber(101)).toEqual("101st");
});

test("should return '111th' for 111", () => {
expect(getOrdinalNumber(111)).toEqual("111th");
});

test("should return '0th' for 0", () => {
expect(getOrdinalNumber(0)).toEqual("0th");
});

// Extra test to check for correct number of arguments
test("should throw an error if no arguments are provided", () => {
expect(() => getOrdinalNumber()).toThrow("Function requires exactly one argument");
});

test("should throw an error if more than one argument is provided", () => {
expect(() => getOrdinalNumber(1, 2)).toThrow("Function requires exactly one argument");
});

//Invalid input tests
test("should throw an error if the argument is not a number", () => {
expect(() => getOrdinalNumber("a")).toThrow("Input must be a number");
});

test("should throw an error if the argument is a negative number", () => {
expect(() => getOrdinalNumber(-1)).toThrow("Input must be a non-negative integer");
});

test("should throw an error if the argument is a decimal", () => {
expect(() => getOrdinalNumber(1.5)).toThrow("Input must be a non-negative integer");
});

test("should throw an error if the argument is NaN", () => {
expect(() => getOrdinalNumber(NaN)).toThrow("Input must be a finite number");
});

test("should throw an error if the argument is Infinity", () => {
expect(() => getOrdinalNumber(Infinity)).toThrow("Input must be a finite number");
});

test("should throw an error if the argument is -Infinity", () => {
expect(() => getOrdinalNumber(-Infinity)).toThrow("Input must be a finite number");
});
test("should throw an error if the argument is an object", () => {
expect(() => getOrdinalNumber({})).toThrow("Input must be a number");
});
test("should throw an error if the argument is an array", () => {
expect(() => getOrdinalNumber([])).toThrow("Input must be a number");
});
test("should throw an error if the argument is null", () => {
expect(() => getOrdinalNumber(null)).toThrow("Input must be a number");
});
test("should throw an error if the argument is undefined", () => {
expect(() => getOrdinalNumber(undefined)).toThrow("Input must be a number");
});
14 changes: 12 additions & 2 deletions Sprint-3/2-practice-tdd/repeat.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
function repeat() {
return "hellohellohello";
function repeat(str, count) {
if ( arguments.length !== 2) {
throw new Error(`Function requires exactly two arguments: a string and a count. Received ${arguments.length} arguments`);

}
if (typeof str !== "string") {
throw new Error("First argument must be a string. Received type " + typeof str);
}
if (!Number.isInteger(count) || count < 0) {
throw new Error("Second argument must be a non-negative integer. Received " + count );
}
return str.repeat(count);
}

module.exports = repeat;
69 changes: 69 additions & 0 deletions Sprint-3/2-practice-tdd/repeat.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,81 @@ test("should repeat the string count times", () => {
// When the repeat function is called with these inputs,
// Then it should return the original str without repetition, ensuring that a count of 1 results in no repetition.

test("should return original string if count is 1", () => {
const str = "hello";
const count = 1;
expect(repeat(str, count)).toEqual("hello");
});

// case: Handle Count of 0:
// Given a target string str and a count equal to 0,
// When the repeat function is called with these inputs,
// Then it should return an empty string, ensuring that a count of 0 results in an empty output.

test("should return empty string if count is 0", () => {
const str = "hello";
const count = 0;
expect(repeat(str, count)).toEqual("");
});

// case: Negative Count:
// Given a target string str and a negative integer count,
// When the repeat function is called with these inputs,
// Then it should throw an error or return an appropriate error message, as negative counts are not valid.

test("should return error message for negative count", () => {
const str = "hello";
const count = -2;
expect(() => repeat(str, count)).toThrow("Second argument must be a non-negative integer");
});

// invalid input tests
test("should return error message for non-integer count", () => {
const str = "hello";
const count = 2.5;
expect(() => repeat(str, count)).toThrow("Second argument must be a non-negative integer");
});

test("should return error message for non-string input", () => {
const str = 123;
const count = 3;
expect(() => repeat(str, count)).toThrow("First argument must be a string");
});

test("should return error message for non-string input with invalid count", () => {
const str = { text: "hello" };
const count = -2;
expect(() => repeat(str, count)).toThrow("First argument must be a string");
});

test("should return error message for string input with non number count", () => {
const str = "hello";
const count = "3";
const count2 = [];
expect(() => repeat(str, count)).toThrow("Second argument must be a non-negative integer");
expect(() => repeat(str, count2)).toThrow("Second argument must be a non-negative integer");
});

test("should return error message for string input with NaN count", () => {
const str = "hello";
const count = NaN;
expect(() => repeat(str, count)).toThrow("Second argument must be a non-negative integer");
});

test("should return error message for string input with null count", () => {
const str = "hello";
const count = null;
expect(() => repeat(str, count)).toThrow("Second argument must be a non-negative integer");
});

test("should return error message for string input with undefined count", () => {
const str = "hello";
const count = undefined;
expect(() => repeat(str, count)).toThrow("Second argument must be a non-negative integer. Received undefined");
});

test('should have the correct amount of arguments', () => {
expect(() => repeat('hello')).toThrow(new Error("Function requires exactly two arguments: a string and a count. Received 1 arguments"));
expect(() => repeat("hello", 3, 3)).toThrow(new Error("Function requires exactly two arguments: a string and a count. Received 3 arguments"));
})