Merge pull request '1.1.0 - Add optional key argument to Collection::add method' (#2) from dev into main

Reviewed-on: #2

.gitattributes

@@ -1,3 +1,5 @@
 phpunit.xml export-ignore
 tests/ export-ignore
 CHANGELOG.md export-ignore
+package.json export-ignore
+.gitignore export-ignore

.gitignore

@@ -1,4 +1,7 @@
 /.idea
 /vendor
+/node_modules
+/coverage
 composer.lock
+package-lock.json
 .phpunit.result.cache

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2025-04-12
+### Added
+- Add optional `key` argument to `AbstractCollection::add()` method
+
+## [1.0.2] - 2025-04-10
+### Changed
+- Increased unit test coverage to 100%
+
+## [1.0.1] - 2025-04-10
+### Added
+- Added description to `composer.json` to provide a description on Packagist.
+
 ## [1.0.0] - 2025-04-09
 ### Added
 - Initial release of the `loomlabs/utility.collection` package.

README.md

@@ -1,5 +1,14 @@
 # Loom Utilities | Collection
 
+<div>
+<!-- Version Badge -->
+<img src="https://img.shields.io/badge/Version-1.1.0-blue" alt="Version 1.1.0">
+<!-- PHP Coverage Badge -->
+<img src="https://img.shields.io/badge/PHP%20Coverage-100.00%25-green" alt="PHP Coverage 100.00%">
+<!-- License Badge -->
+<img src="https://img.shields.io/badge/License-MIT-34ad9b" alt="License MIT">
+</div>
+
 A Collection library for an object-oriented way to work with arrays.
 
 ## Installation

composer.json

@@ -1,5 +1,6 @@
 {
     "name": "loomlabs/utility.collection",
+    "description": "An object-oriented way to work with arrays.",
     "autoload": {
         "psr-4": {
             "Loom\\Utility\\Collection\\": "src/"
@@ -10,7 +11,10 @@
             "Loom\\Utility\\Collection\\Tests\\": "tests/"
         }
     },
-    "version": "1.0.0",
+    "scripts": {
+        "test": "php -d xdebug.mode=coverage ./vendor/bin/phpunit --testdox --colors=always --coverage-html coverage --coverage-clover coverage/coverage.xml --testdox-html coverage/testdox.html && npx badger --phpunit ./coverage/coverage.xml && npx badger --version ./composer.json && npx badger --license ./composer.json"
+    },
+    "version": "1.1.0",
     "license": "MIT",
     "require-dev": {
         "phpunit/phpunit": "^12.1"

package.json

@@ -0,0 +1,5 @@
+{
+  "devDependencies": {
+    "@dannyxcii/badger": "^0.5.0"
+  }
+}

src/AbstractCollection.php

@@ -12,12 +12,18 @@ class AbstractCollection implements CollectionInterface
     {
     }
 
-    public function add(mixed $item): void
+    public function add(mixed $item, string $key = null): void
     {
         if (null === $item) {
             return;
         }
 
+        if ($key) {
+            $this->items[$key] = $item;
+
+            return;
+        }
+
         $this->items[] = $item;
     }
 

tests/CollectionTest.php

@@ -11,10 +11,10 @@ use PHPUnit\Framework\TestCase;
 class CollectionTest extends TestCase
 {
     #[DataProvider('addDataProvider')]
-    public function testAdd(array $startingItems, mixed $itemToAdd, array $expectedResult): void
+    public function testAdd(array $startingItems, mixed $itemToAdd, array $expectedResult, string $key = null): void
     {
         $collection = new Collection($startingItems);
-        $collection->add($itemToAdd);
+        $collection->add($itemToAdd, $key);
 
         $this->assertEquals($expectedResult, $collection->toArray());
     }
@@ -35,6 +35,16 @@ class CollectionTest extends TestCase
         $this->assertEquals($expectedResult, $collection->count());
     }
 
+    public function testIteration(): void
+    {
+        $array = ['A', 'B', 'C'];
+        $collection = new Collection($array);
+
+        foreach ($collection as $key => $value) {
+            $this->assertEquals($array[$key], $value);
+        }
+    }
+
     public static function addDataProvider(): array
     {
         return [
@@ -42,17 +52,26 @@ class CollectionTest extends TestCase
                 'startingItems' => ['A', 'B', 'C'],
                 'itemToAdd' => 'D',
                 'expectedResult' => ['A', 'B', 'C', 'D'],
+                'key' => null,
             ],
             [
                 'startingItems' => [],
                 'itemToAdd' => 1,
                 'expectedResult' => [1],
+                'key' => null,
             ],
             [
                 'startingItems' => [],
                 'itemToAdd' => null,
                 'expectedResult' => [],
+                'key' => null,
             ],
+            [
+                'startingItems' => ['A' => 'A', 'B' => 'B', 'C' => 'C'],
+                'itemToAdd' => 'D',
+                'expectedResult' => ['A' => 'A', 'B' => 'B', 'C' => 'C', 'D' => 'D'],
+                'key' => 'D',
+            ]
         ];
     }