Add if macro (#217)

* wip

* Fix styling

Co-authored-by: freekmurze <freekmurze@users.noreply.github.com>

.github/workflows/run-tests.yml

@@ -9,14 +9,12 @@ jobs:
             fail-fast: false
             matrix:
                 os: [ubuntu-latest]
-                php: [8.0, 7.4]
+                php: [8.0]
                 laravel: [7.*, 8.*]
                 dependency-version: [prefer-stable]
                 include:
                     -   testbench: 6.*
                         laravel: 8.*
-                    -   testbench: 5.*
-                        laravel: 7.*
 
         name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}
 

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-collection-macros` will be documented in this file
 
+## 7.7.0 - 2021-10-24
+
+- add `if` macro
+
 ## 7.6.0 - 2021-10-15
 
 - Fix docblock indentation by @dwightwatson in https://github.com/spatie/laravel-collection-macros/pull/211

README.md

@@ -54,6 +54,7 @@ The package will automatically register itself.
 - [`glob`](#glob)
 - [`groupByModel`](#groupbymodel)
 - [`head`](#head)
+- [`if`](#if)
 - [`ifAny`](#ifany)
 - [`ifEmpty`](#ifempty)
 - [`insertAfter`](#insertafter)
@@ -388,6 +389,47 @@ $collection = collect([]);
 $collection->head(); // return null
 ```
 
+### `if`
+
+The `if` macro can help  branch collection chains. This is the signature of this macro: 
+
+```php
+if(mixed $if, mixed $then = null, mixed $else = null): mixed
+```
+
+`$if`, `$then` and `$else` can be any type. If a closure is passed to any of these parameters, then that closure will be executed and the macro will use its results.
+
+When `$if` returns a truthy value, then `$then` will be returned, otherwise `$else` will be returned.
+
+Here are some examples:
+
+```php
+collect()->if(true, then: true, else: false) // returns true
+collect()->if(false, then: true, else: false) // returns false
+```
+
+When a closure is passed to `$if`, `$then` or `$else`, the entire collection will be passed as an argument to that closure.
+
+```php
+// the `then` closure will be executed
+// the first element of the returned collection now contains "THIS IS THE VALUE"
+$collection = collect(['this is a value'])
+    ->if(
+        fn(Collection $collection) => $collection->contains('this is a value'),
+        then: fn(Collection $collection) => $collection->map(fn(string $item) => strtoupper($item)),
+        else: fn(Collection $collection) => $collection->map(fn(string $item) => Str::kebab($item))
+    );
+
+// the `else` closure will be executed
+// the first element of the returned collection now contains "this-is-another-value"
+$collection = collect(['this is another value'])
+    ->if(
+        fn(Collection $collection) => $collection->contains('this is a value'),
+        then: fn(Collection $collection) => $collection->map(fn(string $item) => strtoupper($item)),
+        else: fn(Collection $collection) => $collection->map(fn(string $item) => Str::kebab($item))
+    );
+```
+
 ### `ifAny`
 
 Executes the passed callable if the collection isn't empty. The entire collection will be returned.

composer.json

@@ -22,14 +22,14 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0",
-        "illuminate/support": "^7.0|^8.0"
+        "php": "^8.0",
+        "illuminate/support": "^8.67"
     },
     "require-dev": {
         "amphp/parallel": "^0.2.5",
         "amphp/parallel-functions": "^0.1.3",
         "mockery/mockery": "^1.4.2",
-        "orchestra/testbench": "^5.5|^6.5",
+        "orchestra/testbench": "^6.5",
         "phpunit/phpunit": "^9.4.4",
         "symfony/stopwatch": "^5.2"
     },

src/CollectionMacroServiceProvider.php

@@ -35,6 +35,7 @@ private function macros(): array
             'glob' => \Spatie\CollectionMacros\Macros\Glob::class,
             'groupByModel' => \Spatie\CollectionMacros\Macros\GroupByModel::class,
             'head' => \Spatie\CollectionMacros\Macros\Head::class,
+            'if' => \Spatie\CollectionMacros\Macros\IfMacro::class,
             'ifAny' => \Spatie\CollectionMacros\Macros\IfAny::class,
             'ifEmpty' => \Spatie\CollectionMacros\Macros\IfEmpty::class,
             'insertAfter' => \Spatie\CollectionMacros\Macros\InsertAfter::class,

src/Macros/IfMacro.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Spatie\CollectionMacros\Macros;
+
+class IfMacro
+{
+    public function __invoke()
+    {
+        return function (
+            mixed $if,
+            mixed $then = null,
+            mixed $else = null,
+        ): mixed {
+            return value($if, $this)
+                ? value($then, $this)
+                : value($else, $this);
+        };
+    }
+}

tests/Macros/IfTest.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Spatie\CollectionMacros\Test\Macros;
+
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
+use Spatie\CollectionMacros\Test\TestCase;
+
+class IfTest extends TestCase
+{
+    /** @test */
+    public function it_will_return_the_right_branch()
+    {
+        $this->assertTrue(collect()->if(true, then: true, else: false));
+        $this->assertFalse(collect()->if(false, then: true, else: false));
+    }
+
+    /**
+     * @test
+     *
+     * @dataProvider sentences
+     */
+    public function it_will_pass_the_collection_to_the_branches(string $sentence, string $modifiedSentence)
+    {
+        $collection = collect([$sentence])
+            ->if(
+                fn (Collection $collection) => $collection->contains('this is the value'),
+                then: fn (Collection $collection) => $collection->map(fn (string $item) => strtoupper($item)),
+                else: fn (Collection $collection) => $collection->map(fn (string $item) => Str::kebab($item))
+            );
+
+        $this->assertEquals($modifiedSentence, $collection[0]);
+    }
+
+    public function sentences(): array
+    {
+        return [
+            ['this is the value', 'THIS IS THE VALUE'],
+            ['this is another value', 'this-is-another-value'],
+        ];
+    }
+
+    /** @test */
+    public function the_branches_are_optional()
+    {
+        $result = collect(['this is a value'])
+            ->if(
+                false,
+                then: fn (Collection $collection) => 'something',
+            );
+
+        $this->assertNull($result);
+    }
+}