Merge pull request #5 from KaririCode-Framework/develop

Add ArrayStack Implementation and Comprehensive Unit Tests

Author: walmir-silva

src/Stack/ArrayStack.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KaririCode\DataStructure\Stack;
+
+use KaririCode\Contract\DataStructure\Stack;
+
+/**
+ * ArrayStack implementation.
+ *
+ * This class implements a stack using a dynamic array.
+ * It provides O(1) time complexity for push, pop, and peek operations.
+ *
+ * @category  Stacks
+ *
+ * @author    Walmir Silva <walmir.silva@kariricode.org>
+ * @license   MIT
+ *
+ * @see       https://kariricode.org/
+ */
+class ArrayStack implements Stack
+{
+    private array $elements = [];
+
+    public function push(mixed $element): void
+    {
+        $this->elements[] = $element;
+    }
+
+    public function pop(): mixed
+    {
+        if ($this->isEmpty()) {
+            return null;
+        }
+
+        return array_pop($this->elements);
+    }
+
+    public function peek(): mixed
+    {
+        if ($this->isEmpty()) {
+            return null;
+        }
+
+        return $this->elements[count($this->elements) - 1];
+    }
+
+    public function isEmpty(): bool
+    {
+        return empty($this->elements);
+    }
+
+    public function size(): int
+    {
+        return count($this->elements);
+    }
+
+    public function clear(): void
+    {
+        $this->elements = [];
+    }
+
+    public function getItems(): array
+    {
+        return array_reverse($this->elements);
+    }
+}

tests/Stack/ArrayStackTest.php

@@ -0,0 +1,134 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KaririCode\DataStructure\Tests\Stack;
+
+use KaririCode\DataStructure\Stack\ArrayStack;
+use PHPUnit\Framework\TestCase;
+
+final class ArrayStackTest extends TestCase
+{
+    // Test pushing elements onto the stack
+    public function testPushAddsElementToStack(): void
+    {
+        $stack = new ArrayStack();
+        $stack->push(1);
+        $this->assertSame(1, $stack->peek());
+    }
+
+    // Test popping elements from the stack
+    public function testPopRemovesElementFromStack(): void
+    {
+        $stack = new ArrayStack();
+        $stack->push(1);
+        $stack->push(2);
+        $this->assertSame(2, $stack->pop());
+        $this->assertSame(1, $stack->peek());
+    }
+
+    // Test popping from an empty stack
+    public function testPopFromEmptyStackReturnsNull(): void
+    {
+        $stack = new ArrayStack();
+        $this->assertNull($stack->pop());
+    }
+
+    // Test peeking elements
+    public function testPeekReturnsElementFromTopWithoutRemovingIt(): void
+    {
+        $stack = new ArrayStack();
+        $stack->push(1);
+        $this->assertSame(1, $stack->peek());
+        $this->assertSame(1, $stack->peek());
+    }
+
+    // Test peeking from an empty stack
+    public function testPeekFromEmptyStackReturnsNull(): void
+    {
+        $stack = new ArrayStack();
+        $this->assertNull($stack->peek());
+    }
+
+    // Test checking if stack is empty
+    public function testIsEmptyReturnsTrueIfStackIsEmpty(): void
+    {
+        $stack = new ArrayStack();
+        $this->assertTrue($stack->isEmpty());
+        $stack->push(1);
+        $this->assertFalse($stack->isEmpty());
+    }
+
+    // Test getting the size of the stack
+    public function testSizeReturnsNumberOfElementsInStack(): void
+    {
+        $stack = new ArrayStack();
+        $this->assertSame(0, $stack->size());
+        $stack->push(1);
+        $stack->push(2);
+        $this->assertSame(2, $stack->size());
+    }
+
+    // Test clearing the stack
+    public function testClearRemovesAllElementsFromStack(): void
+    {
+        $stack = new ArrayStack();
+        $stack->push(1);
+        $stack->push(2);
+        $stack->clear();
+        $this->assertTrue($stack->isEmpty());
+    }
+
+    // Test converting the stack to an array
+    public function testGetItemsReturnsAllElementsInStack(): void
+    {
+        $stack = new ArrayStack();
+        $stack->push(1);
+        $stack->push(2);
+        $this->assertSame([2, 1], $stack->getItems());
+    }
+
+    // Test stack with various data types
+    public function testStackWithVariousDataTypes(): void
+    {
+        $stack = new ArrayStack();
+        $stack->push(123);
+        $stack->push('string');
+        $stack->push([1, 2, 3]);
+        $stack->push(new \stdClass());
+
+        $this->assertInstanceOf(\stdClass::class, $stack->pop());
+        $this->assertSame([1, 2, 3], $stack->pop());
+        $this->assertSame('string', $stack->pop());
+        $this->assertSame(123, $stack->pop());
+    }
+
+    // Test stack behavior after mixed operations
+    public function testStackBehaviorAfterMixedOperations(): void
+    {
+        $stack = new ArrayStack();
+        $stack->push(1);
+        $stack->push(2);
+        $stack->pop();
+        $stack->push(3);
+        $stack->clear();
+        $stack->push(4);
+        $stack->push(5);
+
+        $this->assertSame(5, $stack->pop());
+        $this->assertSame(4, $stack->peek());
+    }
+
+    // Test LIFO behavior
+    public function testStackFollowsLifoOrder(): void
+    {
+        $stack = new ArrayStack();
+        $stack->push(1);
+        $stack->push(2);
+        $stack->push(3);
+
+        $this->assertSame(3, $stack->pop());
+        $this->assertSame(2, $stack->pop());
+        $this->assertSame(1, $stack->pop());
+    }
+}