feat: Added global config

Author: nea

README.md

@@ -35,6 +35,31 @@ You can install the package via composer:
 composer require elipzis/laravel-cacheable-model
 ```
 
+You can publish the config file with:
+
+```bash
+php artisan vendor:publish --tag="cacheable-model-config"
+```
+
+This is the contents of the published config file:
+
+```php
+    //Default values for the Cacheable trait - Can be overridden per model
+    return [
+        //How long should cache last in general?
+        'ttl' => 300,
+        //By what should cache entries be prefixed?
+        'prefix' => 'cacheable',
+        //What is the identifying, unique column name?
+        'identifier' => 'id',
+        //Do you need logging?
+        'logging' => [
+            'enabled' => false,
+            'level' => 'debug',
+        ],
+    ];
+```
+
 ## Usage
 
 Make your model cacheable by adding the trait:

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "elipzis/laravel-cacheable-model",
-    "description": "Query-based cacheable models on-the-fly for your Laravel app",
+    "description": "Automatic query-based model cache for your Laravel app",
     "keywords": [
         "elipZis",
         "laravel",
@@ -22,8 +22,8 @@
         }
     ],
     "require": {
-        "php": "^8.0|^8.1",
-        "spatie/laravel-package-tools": "^1.9.2",
+        "php": "^8.0",
+        "spatie/laravel-package-tools": "^1.13",
         "illuminate/contracts": "^9.0"
     },
     "require-dev": {

config/cacheable.php

@@ -0,0 +1,16 @@
+<?php
+
+//Default values for the Cacheable trait - Can be overridden per model
+return [
+    //How long should cache last in general?
+    'ttl' => 300,
+    //By what should cache entries be prefixed?
+    'prefix' => 'cacheable',
+    //What is the identifying, unique column name?
+    'identifier' => 'id',
+    //Do you need logging?
+    'logging' => [
+        'enabled' => false,
+        'level' => 'debug',
+    ],
+];

src/CacheableServiceProvider.php

@@ -19,6 +19,6 @@ class CacheableServiceProvider extends PackageServiceProvider
      */
     public function configurePackage(Package $package): void
     {
-        $package->name('laravel-cacheable-model');
+        $package->name('laravel-cacheable-model')->hasConfigFile('cacheable');
     }
 }

src/Models/Traits/Cacheable.php

@@ -32,12 +32,12 @@ protected function newBaseQueryBuilder()
     public function getCacheableProperties(): array
     {
         return [
-            'ttl' => 300,
-            'prefix' => 'cacheable',
-            'identifier' => 'id',
+            'ttl' => config('cacheable.ttl', 300),
+            'prefix' => config('cacheable.prefix', 'cacheable'),
+            'identifier' => config('cacheable.identifier', 'id'),
             'logging' => [
-                'enabled' => false,
-                'level' => 'debug',
+                'enabled' => config('cacheable.logging.enabled', false),
+                'level' => config('cacheable.logging.level', 'debug',),
             ],
         ];
     }