Merge pull request #4 from TheDragonCode/1.x

Added the ability to set custom macro names

README.md

@@ -15,6 +15,55 @@ To get the latest version of `HTTP Macros`, simply require the project using [Co
 composer require dragon-code/laravel-http-macros
 ```
 
+## Configuration
+
+If desired, you can publish the configuration file using the console command:
+
+```bash
+php artisan vendor:publish --provider="DragonCode\\LaravelHttpMacros\\ServiceProvider"
+```
+
+If your application already has a `config/http.php` file, then you can simply add a new `macros` key from the
+[configuration](config/http.php) file to it.
+
+Here you can specify a list of your classes for registering macros.
+Macro classes must inherit from the abstract class `DragonCode\LaravelHttpMacros\Macros\Macro`.
+
+You can also redefine macro names using an associative array. For example:
+
+```php
+// Config
+return [
+    'macros' => [
+        'response' => [
+            ToDataMacro::class,
+        ],
+    ],
+];
+
+// Macro
+Http::get()->toData(...);
+```
+
+```php
+// Config
+return [
+    'macros' => [
+        'response' => [
+            'qwerty' => ToDataMacro::class,
+        ],
+    ],
+];
+
+// Macro
+Http::get()->qwerty(...);
+Http::get()->toData(...); // will be method not found exception
+```
+
+> Note
+> 
+> Please note that IDE hints will not work in this case.
+
 ## Usage
 
 ### As Class

config/http.php

@@ -10,6 +10,9 @@
         'response' => [
             ToDataMacro::class,
             ToDataCollectionMacro::class,
+
+            // CustomMacro::class,
+            // 'toFoo' => CustomMacro::class,
         ],
     ],
 ];

src/ServiceProvider.php

@@ -4,7 +4,6 @@
 
 namespace DragonCode\LaravelHttpMacros;
 
-use DragonCode\LaravelHttpMacros\Macros\Macro;
 use Illuminate\Http\Client\Response;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 
@@ -23,20 +22,17 @@ public function boot(): void
 
     protected function bootMacros(): void
     {
-        foreach ($this->macros() as $macros) {
-            Response::macro($macros::name(), $macros::callback());
+        foreach ($this->macros() as $name => $macro) {
+            Response::macro(
+                name : is_string($name) ? $name : $macro::name(),
+                macro: $macro::callback()
+            );
         }
     }
 
-    /**
-     * @throws \Psr\Container\ContainerExceptionInterface
-     * @throws \Psr\Container\NotFoundExceptionInterface
-     *
-     * @return array<string|Macro>
-     */
     protected function macros(): array
     {
-        return $this->app['config']->get('http.macros.response', []);
+        return config('http.macros.response', []);
     }
 
     protected function registerConfig(): void

tests/Fixtures/ConstructorData.php → tests/Fixtures/Data/ConstructorData.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Fixtures;
+namespace Tests\Fixtures\Data;
 
 class ConstructorData
 {

tests/Fixtures/FromMethodData.php → tests/Fixtures/Data/FromMethodData.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Fixtures;
+namespace Tests\Fixtures\Data;
 
 class FromMethodData
 {

tests/Fixtures/SpatieConstructorData.php → tests/Fixtures/Data/SpatieConstructorData.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Fixtures;
+namespace Tests\Fixtures\Data;
 
 use Spatie\LaravelData\Data;
 

tests/Fixtures/SpatiePropertiesData.php → tests/Fixtures/Data/SpatiePropertiesData.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Fixtures;
+namespace Tests\Fixtures\Data;
 
 use Spatie\LaravelData\Data;
 

tests/TestCase.php

@@ -2,7 +2,10 @@
 
 namespace Tests;
 
+use DragonCode\LaravelHttpMacros\Macros\ToDataCollectionMacro;
+use DragonCode\LaravelHttpMacros\Macros\ToDataMacro;
 use DragonCode\LaravelHttpMacros\ServiceProvider;
+use Illuminate\Config\Repository;
 use Orchestra\Testbench\TestCase as BaseTestCase;
 use Spatie\LaravelData\LaravelDataServiceProvider;
 
@@ -15,4 +18,16 @@ protected function getPackageProviders($app): array
             ServiceProvider::class,
         ];
     }
+
+    protected function defineEnvironment($app): void
+    {
+        tap($app['config'], function (Repository $config) {
+            $config->set('http.macros.response', [
+                ToDataMacro::class,
+                ToDataCollectionMacro::class,
+
+                'toFoo' => ToDataMacro::class,
+            ]);
+        });
+    }
 }

tests/Unit/ToDataCollectionConstructorTest.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 use Illuminate\Support\Collection;
-use Tests\Fixtures\ConstructorData;
+use Tests\Fixtures\Data\ConstructorData;
 
 test('many', function () {
     $response = fakeRequest()->get('many');

tests/Unit/ToDataCollectionFromMethodTest.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 use Illuminate\Support\Collection;
-use Tests\Fixtures\FromMethodData;
+use Tests\Fixtures\Data\FromMethodData;
 
 test('many', function () {
     $response = fakeRequest()->get('many');

tests/Unit/ToDataCollectionSpatieConstructorTest.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 use Illuminate\Support\Collection;
-use Tests\Fixtures\SpatieConstructorData;
+use Tests\Fixtures\Data\SpatieConstructorData;
 
 test('many', function () {
     $response = fakeRequest()->get('many');

tests/Unit/ToDataCollectionSpatieFromMethodTest.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 use Illuminate\Support\Collection;
-use Tests\Fixtures\SpatiePropertiesData;
+use Tests\Fixtures\Data\SpatiePropertiesData;
 
 test('many', function () {
     $response = fakeRequest()->get('many');

tests/Unit/ToDataConstructorTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Tests\Fixtures\ConstructorData;
+use Tests\Fixtures\Data\ConstructorData;
 
 test('simple', function () {
     $response = fakeRequest()->get('simple');

tests/Unit/ToDataFromMethodTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Tests\Fixtures\FromMethodData;
+use Tests\Fixtures\Data\FromMethodData;
 
 test('simple', function () {
     $response = fakeRequest()->get('simple');

tests/Unit/ToDataSpatieConstructor.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Tests\Fixtures\SpatieConstructorData;
+use Tests\Fixtures\Data\SpatieConstructorData;
 
 test('simple', function () {
     $response = fakeRequest()->get('simple');

tests/Unit/ToDataSpatieFromMethodTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Tests\Fixtures\SpatiePropertiesData;
+use Tests\Fixtures\Data\SpatiePropertiesData;
 
 test('simple', function () {
     $response = fakeRequest()->get('simple');

tests/Unit/ToFooTest.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+use Tests\Fixtures\Data\ConstructorData;
+
+test('simple', function () {
+    $response = fakeRequest()->get('simple');
+
+    expect($response->toFoo(ConstructorData::class))
+        ->toBeInstanceOf(ConstructorData::class)
+        ->id->toBe(1)
+        ->title->toBe('Qwerty 1');
+});
+
+test('single', function () {
+    $response = fakeRequest()->get('single');
+
+    expect($response->toFoo(ConstructorData::class, 'result.item'))
+        ->toBeInstanceOf(ConstructorData::class)
+        ->id->toBe(1)
+        ->title->toBe('Qwerty 1');
+});
+
+test('many', function () {
+    $response = fakeRequest()->get('many');
+
+    expect($response->toFoo(ConstructorData::class, 'result.items.1'))
+        ->toBeInstanceOf(ConstructorData::class)
+        ->id->toBe(3)
+        ->title->toBe('Qwerty 3');
+});
+
+test('callback', function () {
+    $response = fakeRequest()->get('many');
+
+    expect(
+        $response->toFoo(
+            fn (array $items) => new ConstructorData(
+                $items[0]['id'],
+                $items[1]['title'],
+            ),
+            'result.items'
+        )
+    )
+        ->toBeInstanceOf(ConstructorData::class)
+        ->id->toBe(2)
+        ->title->toBe('Qwerty 3');
+});
+
+test('missing key', function () {
+    $response = fakeRequest()->get('simple');
+
+    expect($response->toFoo(ConstructorData::class, 'missing_key'))->toBeNull();
+});