Repository: TheAlgorithms/Java
Pull request #5356 (2024-08-20 22:49:13)

refactor: `StackArrayList`
Cleanup StackArrayList.
Readability improvements.
Added tests.

<!--
Thank you for your contribution!
In order to reduce the number of notifications sent to the maintainers, please:
- create your PR as draft, cf. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests,
- make sure that all of the CI checks pass,
- mark your PR as ready for review, cf. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review
-->

<!-- For completed items, change [ ] to [x] -->

- [x] I have read [CONTRIBUTING.md](https://github.com/TheAlgorithms/Java/blob/master/CONTRIBUTING.md).
- [x] This pull request is all my own work -- I have not plagiarized it.
- [x] All filenames are in PascalCase.
- [x] All functions and variable names follow Java naming conventions.
- [x] All new algorithms have a URL in their comments that points to Wikipedia or other similar explanations.
- [x] All new code is formatted with `clang-format -i --style=file path/to/your/file.java`

codecov-commenter: ## [Codecov](https://app.codecov.io/gh/TheAlgorithms/Java/pull/5356?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TheAlgorithms) Report
All modified and coverable lines are covered by tests :white_check_mark:
> Project coverage is 44.50%. Comparing base [(`f5c0314`)](https://app.codecov.io/gh/TheAlgorithms/Java/commit/f5c0314111f5973748862e21d6e7ccbb9e53a3ee?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TheAlgorithms) to head [(`e536507`)](https://app.codecov.io/gh/TheAlgorithms/Java/commit/e536507291b32c387ac1d3b47e3b17cdc9d8f50e?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TheAlgorithms).

<details><summary>Additional details and impacted files</summary>


```diff
@@             Coverage Diff              @@
##             master    #5356      +/-   ##
============================================
+ Coverage     44.38%   44.50%   +0.12%     
- Complexity     2752     2761       +9     
============================================
  Files           522      522              
  Lines         15419    15405      -14     
  Branches       2942     2935       -7     
============================================
+ Hits           6843     6856      +13     
+ Misses         8282     8254      -28     
- Partials        294      295       +1     
```

</details>

[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/TheAlgorithms/Java/pull/5356?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TheAlgorithms).   
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TheAlgorithms).


Patch:
diff --git a/src/main/java/com/thealgorithms/datastructures/stacks/StackArrayList.java b/src/main/java/com/thealgorithms/datastructures/stacks/StackArrayList.java
index 9506ae38..088156a9 100644
--- a/src/main/java/com/thealgorithms/datastructures/stacks/StackArrayList.java
+++ b/src/main/java/com/thealgorithms/datastructures/stacks/StackArrayList.java
@@ -6,110 +6,48 @@ import java.util.EmptyStackException;
 /**
  * This class implements a Stack using an ArrayList.
  *
- * <p>
- * A stack is exactly what it sounds like. An element gets added to the top of
- * the stack and only the element on the top may be removed.
- *
- * <p>
- * This is an ArrayList Implementation of a stack, where size is not a problem
- * we can extend the stack as much as we want.
+ * @param <T> the type of elements in this stack
  */
-public class StackArrayList {
-
-    /**
-     * Driver Code
-     */
-    public static void main(String[] args) {
-        StackArrayList stack = new StackArrayList();
-        assert stack.isEmpty();
-
-        for (int i = 1; i <= 5; ++i) {
-            stack.push(i);
-            assert stack.size() == i;
-        }
-
-        assert stack.size() == 5;
-        assert stack.peek() == 5 && stack.pop() == 5 && stack.peek() == 4;
+public class StackArrayList<T> implements Stack<T> {
 
-        /* pop elements at the top of this stack one by one */
-        while (!stack.isEmpty()) {
-            stack.pop();
-        }
-        assert stack.isEmpty();
-
-        try {
-            stack.pop();
-            assert false;
-            /* this should not happen */
-        } catch (EmptyStackException e) {
-            assert true;
-            /* this should happen */
-        }
-    }
+    private final ArrayList<T> stack;
 
-    /**
-     * ArrayList representation of the stack
-     */
-    private ArrayList<Integer> stack;
-
-    /**
-     * Constructor
-     */
     public StackArrayList() {
         stack = new ArrayList<>();
     }
 
-    /**
-     * Adds value to the end of list which is the top for stack
-     *
-     * @param value value to be added
-     */
-    public void push(int value) {
+    @Override
+    public void push(T value) {
         stack.add(value);
     }
 
-    /**
-     * Removes the element at the top of this stack and returns
-     *
-     * @return Element popped
-     * @throws EmptyStackException if the stack is empty.
-     */
-    public int pop() {
+    @Override
+    public T pop() {
         if (isEmpty()) {
             throw new EmptyStackException();
         }
+        return stack.removeLast();
+    }
 
-        /* remove the element on the top of the stack */
-        return stack.remove(stack.size() - 1);
+    @Override
+    public T peek() {
+        if (isEmpty()) {
+            throw new EmptyStackException();
+        }
+        return stack.getLast();
     }
 
-    /**
-     * Test if the stack is empty.
-     *
-     * @return {@code true} if this stack is empty, {@code false} otherwise.
-     */
+    @Override
     public boolean isEmpty() {
         return stack.isEmpty();
     }
 
-    /**
-     * Return the element at the top of this stack without removing it from the
-     * stack.
-     *
-     * @return the element at the top of this stack.
-     */
-    public int peek() {
-        if (isEmpty()) {
-            throw new EmptyStackException();
-        }
-        return stack.get(stack.size() - 1);
+    @Override
+    public void makeEmpty() {
+        stack.clear();
     }
 
-    /**
-     * Return size of this stack.
-     *
-     * @return size of this stack.
-     */
+    @Override
     public int size() {
         return stack.size();
     }


Test patch:
diff --git a/src/test/java/com/thealgorithms/datastructures/stacks/StackArrayListTest.java b/src/test/java/com/thealgorithms/datastructures/stacks/StackArrayListTest.java
new file mode 100644
index 00000000..f4c26190
--- /dev/null
+++ b/src/test/java/com/thealgorithms/datastructures/stacks/StackArrayListTest.java
@@ -0,0 +1,76 @@
+package com.thealgorithms.datastructures.stacks;
+
+import java.util.EmptyStackException;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+class StackArrayListTest {
+
+    private StackArrayList<Integer> stack;
+
+    @BeforeEach
+    void setUp() {
+        stack = new StackArrayList<>();
+    }
+
+    @Test
+    void testPushAndPop() {
+        stack.push(1);
+        stack.push(2);
+        stack.push(3);
+
+        Assertions.assertEquals(3, stack.pop());
+        Assertions.assertEquals(2, stack.pop());
+        Assertions.assertEquals(1, stack.pop());
+    }
+
+    @Test
+    void testPeek() {
+        stack.push(10);
+        stack.push(20);
+
+        Assertions.assertEquals(20, stack.peek());
+        stack.pop(); // Remove 20
+        Assertions.assertEquals(10, stack.peek());
+    }
+
+    @Test
+    void testIsEmpty() {
+        Assertions.assertTrue(stack.isEmpty());
+        stack.push(1);
+        Assertions.assertFalse(stack.isEmpty());
+        stack.pop();
+        Assertions.assertTrue(stack.isEmpty());
+    }
+
+    @Test
+    void testMakeEmpty() {
+        stack.push(1);
+        stack.push(2);
+        stack.push(3);
+        stack.makeEmpty();
+        Assertions.assertTrue(stack.isEmpty());
+        Assertions.assertEquals(0, stack.size());
+    }
+
+    @Test
+    void testSize() {
+        Assertions.assertEquals(0, stack.size());
+        stack.push(1);
+        stack.push(2);
+        Assertions.assertEquals(2, stack.size());
+        stack.pop();
+        Assertions.assertEquals(1, stack.size());
+    }
+
+    @Test
+    void testPopEmptyStackThrowsException() {
+        Assertions.assertThrows(EmptyStackException.class, stack::pop);
+    }
+
+    @Test
+    void testPeekEmptyStackThrowsException() {
+        Assertions.assertThrows(EmptyStackException.class, stack::peek);
+    }
+}