Setup library config validation

Author: veeqtoh

composer.json

@@ -31,7 +31,8 @@
         "nesbot/carbon": "^2.0|^3.0",
         "illuminate/container": "^10.0|^11.0",
         "illuminate/database": "^10.0|^11.0",
-        "ramsey/uuid": "^4.0"
+        "ramsey/uuid": "^4.0",
+        "ashallendesign/laravel-config-validator": "^2.6.1"
     },
     "require-dev": {
         "mockery/mockery": "^1.0",

config/door-access.php

@@ -36,7 +36,8 @@
     | Code format
     |--------------------------------------------------------------------------
     |
-    | Define the format of the code. The options are 'numeric', 'alphanumeric' or 'mixed'.
+    | Define the format of the code. The options are
+    | 'numeric', 'alphanumeric' or 'mixed'.
     | The default for numeric format is '0123456789'.
     |
     */
@@ -49,13 +50,27 @@
     |--------------------------------------------------------------------------
     |
     | Define the characters of the generated code.
-    | The code generator dynamically selects the appropriate character set depending on the chosen code format.
+    | The code generator dynamically selects the appropriate
+    | character set depending on the chosen code format.
     |
     */
 
     'numeric_characters'      => '0123456789', // Default for numeric format.
-    'alphanumeric_characters' => '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ', // Default for alphanumeric format.
-    'mixed_characters'        => '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!@#$%^&*()-_=+[]{};:<>,.?/', // Combined set.
+    'alphanumeric_characters' => '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
+    'mixed_characters'        => '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!@#$%^&*()-_=+[]{};:<>,.?/',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Config Validation
+    |--------------------------------------------------------------------------
+    |
+    | Choose whether you want the config to be validated. This
+    | can be useful for ensuring that your config values are
+    | safe to use.
+    |
+    */
+
+    'validate_config' => true,
 
     /*
     |--------------------------------------------------------------------------

src/Classes/Validation.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Veeqtoh\DoorAccess\Classes;
+
+use AshAllenDesign\ConfigValidator\Exceptions\InvalidConfigValueException;
+use AshAllenDesign\ConfigValidator\Services\ConfigValidator;
+use AshAllenDesign\ConfigValidator\Services\Rule;
+use Veeqtoh\DoorAccess\Exceptions\ValidationException;
+
+class Validation
+{
+    /**
+     * Validate all the config related to the library.
+     *
+     * @throws ValidationException
+     * @throws InvalidConfigValueException
+     */
+    public function validateConfig(): bool
+    {
+        $validator = app(ConfigValidator::class);
+
+        $passes = $validator
+            ->throwExceptionOnFailure(false)
+            ->runInline([
+                'door-access' => [
+                    Rule::make('code_length')->rules(['required', 'integer', 'min:6', 'max:19']),
+                    Rule::make('character_repeated_limit')->rules(['required', 'integer', 'min:3', 'max:19']),
+                    Rule::make('sequence_length_limit')->rules(['required', 'integer', 'min:3']),
+                    Rule::make('unique_characters_limit')->rules(['required', 'integer', 'min:3']),
+                ],
+            ]);
+
+        if (! $passes) {
+            $validationMessage = $validator->errors()[array_key_first($validator->errors())][0];
+
+            throw new ValidationException($validationMessage);
+        }
+
+        return $passes;
+    }
+}

src/Exceptions/ValidationException.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Veeqtoh\DoorAccess\Exceptions;
+
+use Exception;
+
+/**
+ * class ValidationException
+ * This class provides the exception for library config validations.
+ *
+ * @package Veeqtoh\DoorAccess\Exceptions
+ */
+class ValidationException extends Exception
+{
+    //
+}

src/Providers/DoorAccessProvider.php

@@ -4,6 +4,7 @@
 namespace Veeqtoh\DoorAccess\Providers;
 
 use Illuminate\Support\ServiceProvider;
+use Veeqtoh\DoorAccess\Classes\Validation;
 
 /**
  * class DoorAccessProvider
@@ -27,16 +28,21 @@ public function register(): void
      *
      * @return void
      */
-    public function boot()
+    public function boot(): void
     {
         // Publish the package configuration file to the Laravel application.
         $this->publishes([
             __DIR__ . '/../../config/door-access.php' => config_path('door-access.php'),
         ], 'config');
 
-        // Migrate the package's database tables.
+        // Publish the package's migrations.
         $this->publishes([
             __DIR__.'/../../database/migrations' => database_path('migrations'),
         ], 'door-access-migrations');
+
+        // Validate the library configs or not.
+        if (config('door-access') && config('door-access.validate_config')) {
+            (new Validation())->validateConfig();
+        }
     }
 }