Refactor and Normalize Collection Interface and Implementation (#16)

* add size method

* feat: Normalize Interfaces

- Refined and standardized interface definitions across the project
- Applied Single Responsibility Principle (SRP) to ensure each interface has a clear, singular purpose
- Consistent naming conventions were implemented for better readability and maintainability
- Added thorough documentation for each interface, including method descriptions and expected behaviors
- Organized interfaces within appropriate namespaces to prevent naming collisions and maintain a logical structure
- Ensured parameter names in interface methods are consistent with implementing classes
- Avoided including constructors in interfaces to maintain flexibility

These changes enhance the overall clarity, maintainability, and professional quality of the codebase.

* Refactor and Normalize Collection Interface and Implementation

- Refactored `Collection` interface for consistency and adherence to best practices.
- Ensured all tests are comprehensive and validate the expected behavior.

Author: walmir-silva

src/DataStructure/Structural/Collection.php

@@ -29,4 +29,11 @@ interface Collection extends Countable, Indexable, Modifiable, Searchable
      * @param Collection $collection The collection whose elements are to be added
      */
     public function addAll(Collection $collection): void;
+
+    /**
+     * Returns an array containing all elements in the collection.
+     *
+     * @return array The elements in the collection
+     */
+    public function getItems(): array;
 }

tests/DataStructure/Structural/CollectionTest.php

@@ -12,7 +12,9 @@ final class CollectionTest extends TestCase
     public function testAdd(): void
     {
         $mock = $this->createMock(Collection::class);
-        $mock->expects($this->once())->method('add')->with('element');
+        $mock->expects($this->once())
+            ->method('add')
+            ->with('element');
 
         $mock->add('element');
     }
@@ -21,32 +23,77 @@ public function testAddAll(): void
     {
         $collectionMock = $this->createMock(Collection::class);
         $mock = $this->createMock(Collection::class);
-        $mock->expects($this->once())->method('addAll')->with($collectionMock);
+        $mock->expects($this->once())
+            ->method('addAll')
+            ->with($collectionMock);
 
         $mock->addAll($collectionMock);
     }
 
     public function testRemove(): void
     {
         $mock = $this->createMock(Collection::class);
-        $mock->method('remove')->with('element')->willReturn(true);
+        $mock->method('remove')
+            ->with('element')
+            ->willReturn(true);
 
         $this->assertTrue($mock->remove('element'));
     }
 
     public function testContains(): void
     {
         $mock = $this->createMock(Collection::class);
-        $mock->method('contains')->with('element')->willReturn(true);
+        $mock->method('contains')
+            ->with('element')
+            ->willReturn(true);
 
         $this->assertTrue($mock->contains('element'));
     }
 
     public function testClear(): void
     {
         $mock = $this->createMock(Collection::class);
-        $mock->expects($this->once())->method('clear');
+        $mock->expects($this->once())
+            ->method('clear');
 
         $mock->clear();
     }
+
+    public function testSize(): void
+    {
+        $mock = $this->createMock(Collection::class);
+        $mock->method('size')
+            ->willReturn(3);
+
+        $this->assertSame(3, $mock->size());
+    }
+
+    public function testGetItems(): void
+    {
+        $mock = $this->createMock(Collection::class);
+        $mock->method('getItems')
+            ->willReturn(['item1', 'item2']);
+
+        $this->assertSame(['item1', 'item2'], $mock->getItems());
+    }
+
+    public function testGet(): void
+    {
+        $mock = $this->createMock(Collection::class);
+        $mock->method('get')
+            ->with(0)
+            ->willReturn('element');
+
+        $this->assertSame('element', $mock->get(0));
+    }
+
+    public function testSet(): void
+    {
+        $mock = $this->createMock(Collection::class);
+        $mock->expects($this->once())
+            ->method('set')
+            ->with(0, 'element');
+
+        $mock->set(0, 'element');
+    }
 }