Issue #26 Refactor & Added tests to increase coverage

Added tests to increase coverage

Author: brandongregoryscott

src/utilities/scroll-utils.test.ts

@@ -7,14 +7,16 @@ describe("ScrollUtils", () => {
     // -----------------------------------------------------------------------------------------
     describe("scrollToElementById", () => {
         it("when element is retrieved, then attempts to scroll", () => {
-            //Arrange
+            // Arrange
             const element = document.createElement("div");
             const scrollIntoViewMock = jest.fn();
             element.scrollIntoView = scrollIntoViewMock;
             jest.spyOn(document, "getElementById").mockImplementation(
                 () => element
             );
-            const elementId = faker.random.uuid();
+            const elementId = faker.random
+                .number({ min: 1, max: 999 })
+                .toString();
 
             // Act
             ScrollUtils.scrollToElementById(elementId);
@@ -24,8 +26,10 @@ describe("ScrollUtils", () => {
         });
 
         test("when element is not found, it attempts to retrieve the element up to 50 times", () => {
-            //Arrange
-            const elementId = faker.random.uuid();
+            // Arrange
+            const elementId = faker.random
+                .number({ min: 1, max: 999 })
+                .toString();
             const getElementByIdMock = jest.spyOn(document, "getElementById");
 
             // Act
@@ -36,6 +40,41 @@ describe("ScrollUtils", () => {
             // Assert
             expect(getElementByIdMock).toBeCalledTimes(50);
         });
+
+        test("when element is not found, it logs a console warning for development environment", () => {
+            // Arrange
+            const elementId = faker.random
+                .number({ min: 1, max: 999 })
+                .toString();
+            process.env.NODE_ENV = "development";
+            const consoleWarnMock = jest.spyOn(console, "warn");
+
+            // Act
+            jest.useFakeTimers();
+            ScrollUtils.scrollToElementById(elementId);
+            jest.runAllTimers();
+
+            // Assert
+            expect(consoleWarnMock).toBeCalled();
+        });
+
+        test("when scrollOption has initial delay, it calls setTimeout with supplied delay", () => {
+            // Arrange
+            const options = { initialDelay: 200 };
+            const elementId = faker.random
+                .number({ min: 1, max: 999 })
+                .toString();
+            const setTimeoutMock = jest.spyOn(window, "setTimeout");
+
+            // Act
+            ScrollUtils.scrollToElementById(elementId, options);
+
+            // Assert
+            expect(setTimeoutMock).toBeCalledWith(
+                expect.any(Function),
+                options.initialDelay
+            );
+        });
     });
     // #endregion scrollToElementById
 
@@ -54,21 +93,26 @@ describe("ScrollUtils", () => {
             expect(result).toBeUndefined();
         });
 
-        it("when location is null, then returns", () => {
-            // Arrange & Act
-            const result = ScrollUtils.scrollToHash(null);
-
-            // Assert
-            expect(result).toBeUndefined();
-        });
-
-        it("when location is undefined, then returns", () => {
-            // Arrange & Act
-            const result = ScrollUtils.scrollToHash(undefined);
-
-            // Assert
-            expect(result).toBeUndefined();
-        });
+        test.each`
+            location
+            ${null}
+            ${undefined}
+        `(
+            "when location is '$location', it does not scroll",
+            ({ location }) => {
+                // Arrange
+                const scrollToElementByIdSpy = jest.spyOn(
+                    ScrollUtils,
+                    "scrollToElementById"
+                );
+
+                // Act
+                ScrollUtils.scrollToHash(location);
+
+                // Assert
+                expect(scrollToElementByIdSpy).not.toBeCalled();
+            }
+        );
 
         it("when location hash has value, then calls scrollToElementById", () => {
             // Arrange