Add support for attribute name formatting. (#20)

Author: hailwood

README.md

@@ -12,6 +12,13 @@ Install this package via composer:
 ```bash
 composer require webfox/laravel-inertia-dataproviders
 ```
+
+Optionally publish the configuration file:
+
+```bash
+php artisan vendor:publish --provider="Webfox\InertiaDataProviders\InertiaDataProvidersServiceProvider"
+````
+
 We assume you've already for the Inertia adapter for Laravel installed.
 
 ## What Problem Does This Package Solve?
@@ -233,6 +240,22 @@ class DemoController extends Controller
 }
 ```
 
+## Attribute Name Formatting
+The attribute name format can be configured in the configuration file by setting the `attribute_name_formatter`.  
+The package ships with three formatters under the namespace `\Webfox\InertiaDataProviders\AttributeNameFormatters` but you are free to create your own.
+
+### AsWritten
+This is the default formatter. The output attribute name will be the same as the input name.
+E.g. a property named `$someData` and a method named `more_data()` will be available in the page as `someData` and `more_data`. 
+
+### SnakeCase
+This formatter will convert the attribute name to snake_case.  
+E.g. a property named `$someData` and a method named `more_data()` will be available in the page as `some_data` and `more_data`.
+
+### CamelCase
+This formatter will convert the attribute name to camelCase.  
+E.g. a property named `$someData` and a method named `more_data()` will be available in the page as `someData` and `moreData`.
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

config/inertia-dataproviders.php

@@ -1,5 +1,5 @@
 <?php
 
 return [
-
-];
+    'attribute_name_formatter' => \Webfox\InertiaDataProviders\AttributeNameFormatters\AsWritten::class,
+];

src/AttributeNameFormatters/AsWritten.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Webfox\InertiaDataProviders\AttributeNameFormatters;
+
+class AsWritten implements AttributeNameFormatter
+{
+    public function __invoke(string $name): string
+    {
+        return $name;
+    }
+}

src/AttributeNameFormatters/AttributeNameFormatter.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Webfox\InertiaDataProviders\AttributeNameFormatters;
+
+interface AttributeNameFormatter
+{
+    public function __invoke(string $name): string;
+}

src/AttributeNameFormatters/CamelCase.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Webfox\InertiaDataProviders\AttributeNameFormatters;
+
+use Illuminate\Support\Str;
+
+class CamelCase implements AttributeNameFormatter
+{
+    public function __invoke(string $name): string
+    {
+        return Str::of($name)->camel()->toString();
+    }
+}

src/AttributeNameFormatters/SnakeCase.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Webfox\InertiaDataProviders\AttributeNameFormatters;
+
+use Illuminate\Support\Str;
+
+class SnakeCase implements AttributeNameFormatter
+{
+    public function __invoke(string $name): string
+    {
+        return Str::of($name)->snake()->toString();
+    }
+}

src/InertiaDataProvidersServiceProvider.php

@@ -11,6 +11,6 @@ public function configurePackage(Package $package): void
     {
         $package
             ->name('laravel-inertia-dataproviders')
-            ->hasConfigFile();
+            ->hasConfigFile('inertia-dataproviders');
     }
 }