Add PHP CS Fixer configuration file for code style enforcement and update README for clarity. Adjust composer dependencies to support PHP 8.3 and improve modal optional div link handling in the view. (#32)

* Add PHP CS Fixer configuration file for code style enforcement and update README for clarity. Adjust composer dependencies to support PHP 8.3 and improve modal optional div link handling in the view.

* Fix styling

* Update package versions in composer.json to support newer releases of dependencies.

* Update GitHub Actions workflow to reduce test timeout, expand OS and PHP versions, and include additional Laravel versions for improved compatibility and testing coverage. Remove unnecessary GitHub token configuration steps.

* Update GitHub Actions workflow permissions to read-only for pull requests and contents, enhancing security. Add .php-cs-fixer.cache to .gitignore to prevent unnecessary files from being tracked.

Author: thejmitchener

.github/workflows/fix-php-code-style-issues.yml

@@ -8,8 +8,8 @@ on:
       - main
 
 permissions:
-  pull-requests: write
-  contents: write
+  pull-requests: read
+  contents: read
 
 jobs:
   test:
@@ -48,13 +48,6 @@ jobs:
           echo "::add-matcher::${{ runner.tool_cache }}/php.json"
           echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 
-      - name: Configure GitHub Token
-        env:
-          GH_TOKEN: ${{ secrets.GHA_PERSONAL_ACCESS_TOKEN }}
-        run: |
-          git config --global url."https://${GH_TOKEN}@github.com/".insteadOf "https://github.com/"
-          git config --global url."https://${GH_TOKEN}@github.com/".insteadOf "[email protected]:"
-
       - name: Install dependencies
         run: |
           composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update

.github/workflows/run-tests.yml

@@ -31,3 +31,4 @@ yarn-error.log
 php.ini
 error_log
 .DS_Store
+.php-cs-fixer.cache

.gitignore

@@ -0,0 +1,43 @@
+<?php
+
+$finder = Symfony\Component\Finder\Finder::create()
+    ->notPath('bootstrap/*')
+    ->notPath('storage/*')
+    ->notPath('resources/view/mail/*')
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'ordered_imports' => ['sort_algorithm' => 'alpha'],
+        'no_unused_imports' => true,
+        'not_operator_with_successor_space' => true,
+        'trailing_comma_in_multiline' => true,
+        'phpdoc_scalar' => true,
+        'unary_operator_spaces' => true,
+        'binary_operator_spaces' => true,
+        'blank_line_before_statement' => [
+            'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
+        ],
+        'phpdoc_single_line_var_spacing' => true,
+        'phpdoc_var_without_name' => true,
+        'class_attributes_separation' => [
+            'elements' => [
+                'method' => 'one',
+            ],
+        ],
+        'method_argument_space' => [
+            'on_multiline' => 'ensure_fully_multiline',
+            'keep_multiple_spaces_after_comma' => true,
+        ],
+        'single_trait_insert_per_statement' => true,
+    ])
+    ->setFinder($finder);

.php-cs-fixer.cache

@@ -22,103 +22,6 @@ You can manually publish the config file with:
 php artisan vendor:publish --tag="forms-config"
 ```
 
-This is the contents of the published config file:
-
-```php
-return [
-    'forms' => [
-        'free_estimate' => [
-            'production_url' => 'https://fuelforms.com/api/f/',
-            'development_url' => 'https://dev.fuelforms.com/api/f/',
-        ],
-
-        'contact_us' => [
-            'production_url' => 'https://fuelforms.com/api/f/',
-            'development_url' => 'https://dev.fuelforms.com/api/f/',
-        ],
-
-        'careers' => [
-            'production_url' => 'https://fuelforms.com/api/f/',
-            'development_url' => 'https://dev.fuelforms.com/api/f/',
-        ],
-    ],
-
-    'modal' => [
-        'title' => 'Your Project Info',
-        'form_key' => 'free_estimate',
-
-        'steps' => [
-            1 => [
-                'heading' => 'Where do you need painting?',
-                'locations' => [
-                    'inside',
-                    'outside',
-                    'cabinets',
-                ],
-            ],
-        ],
-
-        'tos' => [
-            'enabled' => true,
-            'content' => 'By clicking "Submit" above, I expressly consent to...',
-        ],
-
-        'optional_div' => [
-            'enabled' => true,
-            'title' => 'Looking to work with us?',
-            'link_text' => 'Apply Here',
-            'link_route' => 'welcome',
-        ],
-    ],
-
-    'validation' => [
-        'default' => [
-            'firstName' => 'required|min:2|max:24',
-            'lastName' => 'required|min:2|max:24',
-            'email' => 'required|email',
-            'phone' => 'required|min:7|max:19',
-            'message' => 'nullable|max:255',
-        ],
-
-        'free_estimate' => [
-            'firstName' => 'required|min:2|max:24',
-            'lastName' => 'required|min:2|max:24',
-            'email' => 'required|email',
-            'phone' => 'required|min:7|max:19',
-            'message' => 'nullable|max:255',
-        ],
-
-        'contact_us' => [
-            'firstName' => 'required|min:2|max:24',
-            'lastName' => 'required|min:2|max:24',
-            'email' => 'required|email',
-            'phone' => 'required|min:7|max:19',
-            'message' => 'nullable|max:255',
-        ],
-
-        'steps' => [
-            1 => [
-                'location' => 'required|in:inside,outside,cabinets',
-            ],
-            2 => [
-                'firstName' => 'required|min:2|max:24',
-                'lastName' => 'required|min:2|max:24',
-                'email' => 'required|email',
-                'phone' => 'required|min:7|max:19',
-                'zipCode' => 'required|min:4|max:9',
-                'message' => 'nullable|max:255',
-                'location' => 'required|in:inside,outside,cabinets',
-            ],
-        ],
-    ],
-
-    'spam_redirects' => [
-        'yelp' => 'https://yelp.com',
-        'bbb' => 'https://bbb.org',
-    ],
-];
-```
-
 You can publish the view files with:
 
 ```bash
@@ -299,7 +202,8 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [Thejmitchener](https://github.com/thejmitchener)
+- [Joshua Mitchener](https://github.com/thejmitchener)
+- [Daniel Clark](https://github.com/sweatybreeze)
 - [Fuelviews](https://github.com/fuelviews)
 - [All Contributors](../../contributors)
 

.php-cs-fixer.dist.php

@@ -4,32 +4,31 @@
     "keywords": [
         "fuelviews",
         "laravel",
-        "laravel-forms",
         "forms"
     ],
     "homepage": "https://github.com/fuelviews/laravel-forms",
     "license": "MIT",
     "authors": [
         {
             "name": "Joshua Mitchener",
-            "email": "[email protected]",
             "homepage": "https://fuelviews.com",
             "role": "Developer"
         }
     ],
     "require": {
-        "php": "^8.2",
-        "spatie/laravel-package-tools": "^1.16"
+        "php": "^8.3||^8.2",
+        "spatie/laravel-package-tools": "^1.16",
+        "illuminate/contracts": "^10.0||^11.0||^12.0"
     },
     "require-dev": {
         "fuelviews/laravel-sabhero-wrapper": ">=0.0",
         "laravel/pint": "^1.14",
         "livewire/livewire": ">=3.5",
         "nunomaduro/collision": "^8.1.1||^7.10.0",
-        "orchestra/testbench": "^9.0.0||^8.22.0",
-        "pestphp/pest": "^2.34",
-        "pestphp/pest-plugin-arch": "^2.7",
-        "pestphp/pest-plugin-laravel": "^2.3"
+        "orchestra/testbench": "^10.2||^9.0.0||^8.22.0",
+        "pestphp/pest": "^3.0||^2.34",
+        "pestphp/pest-plugin-arch": "^3.0||^2.7",
+        "pestphp/pest-plugin-laravel": "^3.2||^2.3"
     },
     "autoload": {
         "psr-4": {

README.md

@@ -1,6 +1,10 @@
 @if (Forms::isModalOptionalDivEnabled())
     <div class="bg-gray-100 text-xs md:text-sm md:text-md p-2 rounded-tl-lg rounded-br-lg text-center -mb-4 -mr-4">
         <span class="block text-gray-900">{{ Forms::getModalOptionalDivTitle() }}</span>
-        <a href="{{ route(Forms::getModalOptionalDivLinkRoute()) }}" class="text-blue-500 text-blue-700 hover:underline text-sm">{{ Forms::getModalOptionalDivLinkText() }}</a>
+        @php
+            $routeName = Forms::getModalOptionalDivLinkRoute();
+            $routeExists = Route::has($routeName);
+        @endphp
+        <a href="{{ $routeExists ? route($routeName) : '#' }}" class="text-blue-500 text-blue-700 hover:underline text-sm">{{ Forms::getModalOptionalDivLinkText() }}</a>
     </div>
 @endif

composer.json

@@ -5,7 +5,6 @@
 use Illuminate\Console\Command;
 use Symfony\Component\Process\Exception\ProcessFailedException;
 use Symfony\Component\Process\Process;
-use Spatie\LaravelPackageTools\Commands\InstallCommand;
 
 class FormsInstallCommand extends Command
 {
@@ -33,6 +32,7 @@ public function handle(): int
             $this->info('✅ Packages installed successfully.');
         } catch (ProcessFailedException $e) {
             $this->error('❌ Failed to install packages: ' . $e->getMessage());
+
             return self::FAILURE;
         }
 

resources/views/components/modal/optional-div.blade.php

@@ -10,10 +10,10 @@
 use Fuelviews\Forms\Middleware\HandleUtm;
 use Fuelviews\Forms\Services\FormsSubmitService;
 use Fuelviews\Forms\Services\FormsValidationRuleService;
-use Illuminate\Support\Facades\Route;
-use Illuminate\Foundation\Application;
 use Illuminate\Contracts\Http\Kernel;
+use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Configuration\Middleware;
+use Illuminate\Support\Facades\Route;
 use Livewire\Livewire;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
@@ -83,7 +83,6 @@ public function registeringPackage(): void
         });
     }
 
-
     private function providerIsLoaded($app, $providerClass): bool
     {
         return collect($app->getLoadedProviders())->has($providerClass);

src/Commands/FormsInstallCommand.php

@@ -44,6 +44,7 @@ public function handleSubmit(Request $request)
         if (is_array($result) && $result['status'] === 'failure') {
             session()->flash('status', 'failure');
             session()->flash('message', $result['message'] ?? 'There was an issue submitting the form.');
+
             return back()->withInput();
         }
 
@@ -54,6 +55,7 @@ public function handleSubmit(Request $request)
                 'status' => session('status'),
                 'message' => session('message'),
             ]);
+
             return redirect()->route('forms.thank-you');
         }
     }