Release/1.8.0 (#19)

* feat: Adds flatten method to remove nested collections and return a single flattened Collection.

Author: gustavofreze

.github/workflows/ci.yml

@@ -1,55 +1,49 @@
 name: CI
 
 on:
-  push:
   pull_request:
 
 permissions:
   contents: read
 
+env:
+  PHP_VERSION: '8.3'
+
 jobs:
   auto-review:
     name: Auto review
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Use PHP 8.2
+      - name: Configure PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.2'
+          php-version: ${{ env.PHP_VERSION }}
 
       - name: Install dependencies
         run: composer update --no-progress --optimize-autoloader
 
-      - name: Run phpcs
-        run: composer phpcs
-
-      - name: Run phpmd
-        run: composer phpmd
+      - name: Run review
+        run: composer review
 
   tests:
     name: Tests
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Use PHP 8.2
+      - name: Use PHP ${{ env.PHP_VERSION }}
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.2'
+          php-version: ${{ env.PHP_VERSION }}
 
       - name: Install dependencies
         run: composer update --no-progress --optimize-autoloader
 
-      - name: Run unit tests
-        env:
-          XDEBUG_MODE: coverage
-        run: composer test
-
-      - name: Run mutation tests
-        run: composer test-mutation
+      - name: Run tests
+        run: composer tests

Makefile

@@ -1,4 +1,4 @@
-DOCKER_RUN = docker run --rm -it --net=host -v ${PWD}:/app -w /app gustavofreze/php:8.2
+DOCKER_RUN = docker run --rm -it --net=host -v ${PWD}:/app -w /app gustavofreze/php:8.3
 
 .PHONY: configure test test-file test-no-coverage review show-reports clean
 
@@ -9,7 +9,7 @@ test:
 	@${DOCKER_RUN} composer tests
 
 test-file:
-	@${DOCKER_RUN} composer tests-file-no-coverage ${FILE}
+	@${DOCKER_RUN} composer test-file ${FILE}
 
 test-no-coverage:
 	@${DOCKER_RUN} composer tests-no-coverage
@@ -22,4 +22,4 @@ show-reports:
 
 clean:
 	@sudo chown -R ${USER}:${USER} ${PWD}
-	@rm -rf report vendor .phpunit.cache
+	@rm -rf report vendor .phpunit.cache .lock

README.md

@@ -63,8 +63,8 @@ declare(strict_types=1);
 namespace Example;
 
 use TinyBlocks\Collection\Collection;
-use TinyBlocks\Collection\Internal\Operations\Order\Order;
-use TinyBlocks\Collection\Internal\Operations\Transform\PreserveKeys;
+use TinyBlocks\Collection\Order;
+use TinyBlocks\Collection\PreserveKeys;
 
 $collection = Collection::createFrom(elements: [1, 2, 3, 4, 5])
     ->add(elements: [6, 7]) 
@@ -159,7 +159,7 @@ These methods enable sorting elements in the Collection based on the specified o
   By default, `Order::ASCENDING_KEY` is used.
 
   ```php
-  use TinyBlocks\Collection\Internal\Operations\Order\Order;
+  use TinyBlocks\Collection\Order;
         
   $collection->sort(order: Order::DESCENDING_VALUE);
   ```
@@ -168,7 +168,7 @@ These methods enable sorting elements in the Collection based on the specified o
   compared.
 
   ```php
-  use TinyBlocks\Collection\Internal\Operations\Order\Order;
+  use TinyBlocks\Collection\Order;
 
   $collection->sort(order: Order::ASCENDING_VALUE, predicate: fn(Amount $amount): float => $amount->value);
   ``` 
@@ -296,6 +296,18 @@ These methods allow the Collection's elements to be transformed or converted int
   $collection->map(transformations: fn(int $value): int => $value * 2);
   ```
 
+#### Flattening elements
+
+- `flatten`: Flattens a collection by removing any nested collections and returning a single collection with all
+  elements in a single level.
+
+  This method recursively flattens any iterable elements, combining them into one collection, regardless of their
+  nesting depth.
+
+  ```php
+  $collection->flatten();
+  ```
+
 #### Convert to array
 
 - `toArray`: Converts the Collection into an array.
@@ -308,7 +320,7 @@ These methods allow the Collection's elements to be transformed or converted int
   By default, `PreserveKeys::PRESERVE` is used.
 
   ```php
-  use TinyBlocks\Collection\Internal\Operations\Transform\PreserveKeys;
+  use TinyBlocks\Collection\PreserveKeys;
 
   $collection->toArray(preserveKeys: PreserveKeys::DISCARD);
   ```
@@ -325,7 +337,7 @@ These methods allow the Collection's elements to be transformed or converted int
   By default, `PreserveKeys::PRESERVE` is used.
 
   ```php
-  use TinyBlocks\Collection\Internal\Operations\Transform\PreserveKeys;
+  use TinyBlocks\Collection\PreserveKeys;
 
   $collection->toJson(preserveKeys: PreserveKeys::DISCARD);
   ```
@@ -352,8 +364,8 @@ Lazy evaluation, enabled by [PHP's Generators](https://www.php.net/manual/en/lan
 This results in significant memory savings when working with large datasets or performing complex
 chained operations.
 
-However, this also means that some operations will entirely consume the generator, and you won't be
-able to reaccess the elements unless you recreate the `Collection`.
+However, this also means that some operations will consume the generator, and you cannot access the elements unless you
+recreate the `Collection`.
 
 <div id='license'></div>
 

composer.json

@@ -44,38 +44,34 @@
         }
     },
     "require": {
-        "php": "^8.2",
+        "php": "^8.3",
         "tiny-blocks/serializer": "^3"
     },
     "require-dev": {
         "phpmd/phpmd": "^2.15",
         "phpunit/phpunit": "^11",
         "phpstan/phpstan": "^1",
-        "infection/infection": "^0.29",
-        "squizlabs/php_codesniffer": "^3.10"
+        "infection/infection": "^0",
+        "squizlabs/php_codesniffer": "^3"
     },
     "scripts": {
+        "test": "phpunit -d memory_limit=2G --configuration phpunit.xml tests",
         "phpcs": "phpcs --standard=PSR12 --extensions=php ./src",
         "phpmd": "phpmd ./src text phpmd.xml --suffixes php --ignore-violations-on-exit",
         "phpstan": "phpstan analyse -c phpstan.neon.dist --quiet --no-progress",
-        "test": "phpunit --log-junit=report/coverage/junit.xml --coverage-xml=report/coverage/coverage-xml --coverage-html=report/coverage/coverage-html tests",
-        "test-mutation": "infection --only-covered --logger-html=report/coverage/mutation-report.html --coverage=report/coverage --min-msi=100 --min-covered-msi=100 --threads=4",
-        "test-no-coverage": "phpunit --no-coverage",
-        "test-mutation-no-coverage": "infection --only-covered --min-msi=100 --threads=4",
+        "test-file": "phpunit --configuration phpunit.xml --no-coverage --filter",
+        "mutation-test": "infection --only-covered --threads=max --logger-html=report/coverage/mutation-report.html --coverage=report/coverage",
+        "test-no-coverage": "phpunit --configuration phpunit.xml --no-coverage tests",
         "review": [
             "@phpcs",
             "@phpmd",
             "@phpstan"
         ],
         "tests": [
             "@test",
-            "@test-mutation"
+            "@mutation-test"
         ],
         "tests-no-coverage": [
-            "@test-no-coverage",
-            "@test-mutation-no-coverage"
-        ],
-        "tests-file-no-coverage": [
             "@test-no-coverage"
         ]
     }

infection.json.dist

@@ -1,21 +1,23 @@
 {
-    "timeout": 10,
-    "testFramework": "phpunit",
+    "logs": {
+        "text": "report/infection/logs/infection-text.log",
+        "summary": "report/infection/logs/infection-summary.log"
+    },
     "tmpDir": "report/infection/",
+    "minMsi": 100,
+    "timeout": 30,
     "source": {
         "directories": [
             "src"
         ]
     },
-    "logs": {
-        "text": "report/infection/logs/infection-text.log",
-        "summary": "report/infection/logs/infection-summary.log"
+    "phpUnit": {
+        "configDir": "",
+        "customPath": "./vendor/bin/phpunit"
     },
     "mutators": {
         "@default": true
     },
-    "phpUnit": {
-        "configDir": "",
-        "customPath": "./vendor/bin/phpunit"
-    }
-}
+    "minCoveredMsi": 100,
+    "testFramework": "phpunit"
+}

phpunit.xml

@@ -6,6 +6,7 @@
          failOnRisky="true"
          failOnWarning="true"
          cacheDirectory=".phpunit.cache"
+         executionOrder="random"
          beStrictAboutOutputDuringTests="true">
 
     <source>
@@ -22,14 +23,15 @@
 
     <coverage>
         <report>
+            <xml outputDirectory="report/coverage/coverage-xml"/>
+            <html outputDirectory="report/coverage/coverage-html"/>
             <text outputFile="report/coverage.txt"/>
-            <html outputDirectory="report/html/"/>
             <clover outputFile="report/coverage-clover.xml"/>
         </report>
     </coverage>
 
     <logging>
-        <junit outputFile="report/execution-result.xml"/>
+        <junit outputFile="report/coverage/junit.xml"/>
     </logging>
 
 </phpunit>