rebranding of the package

Author: michael-rubel

README.md

@@ -1,14 +1,12 @@
-![Laravel Model Mapper](https://user-images.githubusercontent.com/37669560/147101154-e70d8648-ffa3-48c6-b9a8-6a072b7c1f00.png)
+# Laravel Loop Functions
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/michael-rubel/laravel-loop-functions.svg?style=flat-square&logo=packagist)](https://packagist.org/packages/michael-rubel/laravel-loop-functions)
+[![Total Downloads](https://img.shields.io/packagist/dt/michael-rubel/laravel-loop-functions.svg?style=flat-square&logo=packagist)](https://packagist.org/packages/michael-rubel/laravel-loop-functions)
+[![Code Quality](https://img.shields.io/scrutinizer/quality/g/michael-rubel/laravel-loop-functions.svg?style=flat-square&logo=scrutinizer)](https://scrutinizer-ci.com/g/michael-rubel/laravel-loop-functions/?branch=main)
+[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/michael-rubel/laravel-loop-functions.svg?style=flat-square&logo=scrutinizer)](https://scrutinizer-ci.com/g/michael-rubel/laravel-loop-functions/?branch=main)
+[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/michael-rubel/laravel-loop-functions/run-tests/main?style=flat-square&label=tests&logo=github)](https://github.com/michael-rubel/laravel-loop-functions/actions)
+[![PHPStan](https://img.shields.io/github/workflow/status/michael-rubel/laravel-loop-functions/phpstan/main?style=flat-square&label=larastan&logo=laravel)](https://github.com/michael-rubel/laravel-loop-functions/actions)
 
-# Laravel Model-Property Mapper
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/michael-rubel/laravel-model-mapper.svg?style=flat-square&logo=packagist)](https://packagist.org/packages/michael-rubel/laravel-model-mapper)
-[![Total Downloads](https://img.shields.io/packagist/dt/michael-rubel/laravel-model-mapper.svg?style=flat-square&logo=packagist)](https://packagist.org/packages/michael-rubel/laravel-model-mapper)
-[![Code Quality](https://img.shields.io/scrutinizer/quality/g/michael-rubel/laravel-model-mapper.svg?style=flat-square&logo=scrutinizer)](https://scrutinizer-ci.com/g/michael-rubel/laravel-model-mapper/?branch=main)
-[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/michael-rubel/laravel-model-mapper.svg?style=flat-square&logo=scrutinizer)](https://scrutinizer-ci.com/g/michael-rubel/laravel-model-mapper/?branch=main)
-[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/michael-rubel/laravel-model-mapper/run-tests/main?style=flat-square&label=tests&logo=github)](https://github.com/michael-rubel/laravel-model-mapper/actions)
-[![PHPStan](https://img.shields.io/github/workflow/status/michael-rubel/laravel-model-mapper/phpstan/main?style=flat-square&label=larastan&logo=laravel)](https://github.com/michael-rubel/laravel-model-mapper/actions)
-
-This package provides functionality to map your model attributes to local class properties with the same names.
+Collection of functions to loop over your data.
 
 The package requires PHP `^8.x` and Laravel `^8.71`.
 
@@ -19,56 +17,30 @@ The package requires PHP `^8.x` and Laravel `^8.71`.
 ## Installation
 Install the package using composer:
 ```bash
-composer require michael-rubel/laravel-model-mapper
+composer require michael-rubel/laravel-loop-functions
 ```
 
 ## Usage
 ```php
-use WithModelMapping;
+use WithLoopFunctions;
 ```
 
-Then in constructor or any other method:
+## Available methods
+Assign Eloquent model attributes to class properties:
 ```php
-$this->mapModelAttributes($model);
+$this->attributesToProperties($model);
 ```
 
-This is especially handy with Livewire components when you want to map your model data to the view.
-
-For example:
+Assign array key values to class properties:
 ```php
-class CompanyProfile extends Component
-{
-    use WithModelMapping;
-
-    /**
-     * Frontend properties.
-     *
-     * @var string|null
-     */
-    public ?string $name       = null;
-    public ?string $tax_number = null;
-    public ?string $address    = null;
-
-    /**
-     * @param \App\Models\Company $company 
-     *
-     * @return void
-     */
-    public function mount(Company $company): void
-    {
-        $this->mapModelAttributes($company);
-    }
-}
+$this->arrayToProperties($data);
 ```
 
-## Why?
-Why should I use it like this instead of just passing the model to the view? It's because the models are huge objects and you probably shouldn't expose them to the frontend for security and performance reasons. Another thing is primitive view variables are highly customizable through view composers, while it's harder to decorate in the case of using models.
-
 ## Logging
 As the package doesn't throw an error in case of failed assignment (for example type incompatibility), you may wish to log such an event. The package has failed assignment logging disabled by default, but you can turn it on by publishing the config:
 
 ```bash
-php artisan vendor:publish --tag="model-mapper-config"
+php artisan vendor:publish --tag="loop-functions-config"
 ```
 
 ## Testing

composer.json

@@ -1,12 +1,12 @@
 {
-    "name": "michael-rubel/laravel-model-mapper",
-    "description": "Map your model attributes to class properties with ease.",
+    "name": "michael-rubel/laravel-loop-functions",
+    "description": "Collection of functions to loop over your data.",
     "keywords": [
         "michael-rubel",
         "laravel",
-        "laravel-model-mapper"
+        "laravel-loop-functions"
     ],
-    "homepage": "https://github.com/michael-rubel/laravel-model-mapper",
+    "homepage": "https://github.com/michael-rubel/laravel-loop-functions",
     "license": "MIT",
     "authors": [
         {
@@ -31,12 +31,12 @@
     },
     "autoload": {
         "psr-4": {
-            "MichaelRubel\\ModelMapper\\": "src"
+            "MichaelRubel\\LoopFunctions\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "MichaelRubel\\ModelMapper\\Tests\\": "tests"
+            "MichaelRubel\\LoopFunctions\\Tests\\": "tests"
         }
     },
     "scripts": {
@@ -49,7 +49,7 @@
     "extra": {
         "laravel": {
             "providers": [
-                "MichaelRubel\\ModelMapper\\ModelMapperServiceProvider"
+                "MichaelRubel\\LoopFunctions\\LoopFunctionServiceProvider"
             ]
         }
     },

config/model-mapper.php renamed to config/loop-functions.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace MichaelRubel\ModelMapper;
+namespace MichaelRubel\LoopFunctions;
 
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
-class ModelMapperServiceProvider extends PackageServiceProvider
+class LoopFunctionServiceProvider extends PackageServiceProvider
 {
     /**
      * Configure the package.
@@ -19,7 +19,7 @@ class ModelMapperServiceProvider extends PackageServiceProvider
     public function configurePackage(Package $package): void
     {
         $package
-            ->name('laravel-model-mapper')
+            ->name('laravel-loop-functions')
             ->hasConfigFile();
     }
 }

src/ModelMapperServiceProvider.php renamed to src/LoopFunctionServiceProvider.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace MichaelRubel\ModelMapper\Traits;
+namespace MichaelRubel\LoopFunctions\Traits;
 
 use Illuminate\Database\Eloquent\Model;
 
-trait WithModelMapping
+trait WithLoopFunctions
 {
     /**
      * Maps your model attributes to local class properties.
@@ -16,10 +16,10 @@ trait WithModelMapping
      *
      * @return void
      */
-    public function mapModelAttributes(?Model $model = null, mixed $rescue = null): void
+    public function attributesToProperties(?Model $model = null, mixed $rescue = null): void
     {
         if (! is_null($model)) {
-            $toIgnore = config('model-mapper.ignore_attributes');
+            $toIgnore = config('loop-functions.ignore_attributes');
 
             $ignores = is_array($toIgnore)
                 ? $toIgnore
@@ -32,7 +32,7 @@ public function mapModelAttributes(?Model $model = null, mixed $rescue = null):
                         rescue(
                             fn () => $this->{$property} = $model->{$property},
                             $rescue,
-                            config('model-mapper.log') ?? false
+                            config('loop-functions.log') ?? false
                         );
                     }
                 });
@@ -54,7 +54,7 @@ public function arrayToProperties(?array $data, mixed $rescue = null): void
                 rescue(
                     fn () => $this->{$key} = $value,
                     $rescue,
-                    config('model-mapper.log') ?? false
+                    config('loop-functions.log') ?? false
                 );
             }
         });

src/Traits/WithModelMapping.php renamed to src/Traits/WithLoopFunctions.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace MichaelRubel\ModelMapper\Tests;
+namespace MichaelRubel\LoopFunctions\Tests;
 
-use MichaelRubel\ModelMapper\Traits\WithModelMapping;
+use MichaelRubel\LoopFunctions\Traits\WithLoopFunctions;
 
 class ArrayMappingTest extends TestCase
 {
-    use WithModelMapping;
+    use WithLoopFunctions;
 
     public bool $test;
     public string $name;

tests/ArrayMappingTest.php

@@ -1,14 +1,14 @@
 <?php
 
-namespace MichaelRubel\ModelMapper\Tests;
+namespace MichaelRubel\LoopFunctions\Tests;
 
 use Illuminate\Support\Collection;
-use MichaelRubel\ModelMapper\Tests\Boilerplate\TestModel;
-use MichaelRubel\ModelMapper\Traits\WithModelMapping;
+use MichaelRubel\LoopFunctions\Tests\Boilerplate\TestModel;
+use MichaelRubel\LoopFunctions\Traits\WithLoopFunctions;
 
 class AttributeMappingTest extends TestCase
 {
-    use WithModelMapping;
+    use WithLoopFunctions;
 
     public int $id;
     public bool $test;
@@ -30,7 +30,7 @@ public function testMapsAttributesToClassPropertiesCorrectly()
             'files' => collect('/img/src/screen.png'),
         ]);
 
-        $this->mapModelAttributes($model);
+        $this->attributesToProperties($model);
 
         $this->assertTrue($this->test);
         $this->assertIsString($this->name);
@@ -49,7 +49,7 @@ public function testMappingIgnoresDifferentTypes()
             'default' => fn () => true,
         ]);
 
-        $this->mapModelAttributes($model);
+        $this->attributesToProperties($model);
 
         $this->assertFalse((new \ReflectionProperty($this, 'name'))->isInitialized($this));
         $this->assertFalse((new \ReflectionProperty($this, 'files'))->isInitialized($this));
@@ -66,7 +66,7 @@ public function testMappingWorksWithCollections()
             'collection' => new Collection(),
         ]);
 
-        $this->mapModelAttributes($model);
+        $this->attributesToProperties($model);
 
         $this->assertInstanceOf(Collection::class, $this->collection);
     }
@@ -82,7 +82,7 @@ public function testMappingWithCasts()
             'intAsString' => 100,
         ]);
 
-        $this->mapModelAttributes($model);
+        $this->attributesToProperties($model);
 
         $this->assertInstanceOf(Collection::class, $this->collection);
         $this->assertIsString($this->intAsString);
@@ -97,7 +97,7 @@ public function testIdAndPasswordIsIgnored()
             'test'     => true,
         ]);
 
-        $this->mapModelAttributes($model);
+        $this->attributesToProperties($model);
 
         $this->assertTrue($this->test);
         $this->assertFalse((new \ReflectionProperty($this, 'id'))->isInitialized($this));
@@ -107,15 +107,15 @@ public function testIdAndPasswordIsIgnored()
     /** @test */
     public function testSetsDefaultValueWithWrongConfig()
     {
-        config(['model-mapper.ignore_attributes' => 123]);
+        config(['loop-functions.ignore_attributes' => 123]);
 
         $model = new TestModel([
             'id'       => 1,
             'password' => 'hash',
             'test'     => true,
         ]);
 
-        $this->mapModelAttributes($model);
+        $this->attributesToProperties($model);
 
         $this->assertTrue($this->test);
         $this->assertFalse((new \ReflectionProperty($this, 'id'))->isInitialized($this));

tests/AttributeMappingTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace MichaelRubel\ModelMapper\Tests\Boilerplate;
+namespace MichaelRubel\LoopFunctions\Tests\Boilerplate;
 
 use Illuminate\Database\Eloquent\Casts\AsCollection;
 use Illuminate\Database\Eloquent\Model;

tests/Boilerplate/TestModel.php

@@ -1,14 +1,14 @@
 <?php
 
-namespace MichaelRubel\ModelMapper\Tests;
+namespace MichaelRubel\LoopFunctions\Tests;
 
 use Illuminate\Support\Facades\Log;
-use MichaelRubel\ModelMapper\Tests\Boilerplate\TestModel;
-use MichaelRubel\ModelMapper\Traits\WithModelMapping;
+use MichaelRubel\LoopFunctions\Tests\Boilerplate\TestModel;
+use MichaelRubel\LoopFunctions\Traits\WithLoopFunctions;
 
 class LoggingTest extends TestCase
 {
-    use WithModelMapping;
+    use WithLoopFunctions;
 
     public int $number;
 
@@ -25,20 +25,20 @@ public function testMapperCanLog()
             'number' => false,
         ]);
 
-        $this->mapModelAttributes($model);
+        $this->attributesToProperties($model);
     }
 
     /** @test */
     public function testMapperDoesntLogIfDisabled()
     {
-        config(['model-mapper.log' => false]);
+        config(['loop-functions.log' => false]);
 
         Log::shouldReceive('error')->never();
 
         $model = new TestModel([
             'number' => false,
         ]);
 
-        $this->mapModelAttributes($model);
+        $this->attributesToProperties($model);
     }
 }

tests/LoggingTest.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace MichaelRubel\ModelMapper\Tests;
+namespace MichaelRubel\LoopFunctions\Tests;
 
-use MichaelRubel\ModelMapper\ModelMapperServiceProvider;
+use MichaelRubel\LoopFunctions\LoopFunctionServiceProvider;
 use Orchestra\Testbench\TestCase as Orchestra;
 
 class TestCase extends Orchestra
@@ -15,7 +15,7 @@ public function setUp(): void
     protected function getPackageProviders($app): array
     {
         return [
-            ModelMapperServiceProvider::class,
+            LoopFunctionServiceProvider::class,
         ];
     }