Add easy way to override model class names on runtime

Author: FrittenKeeZ

README.md

@@ -76,7 +76,7 @@ $vouchers = Vouchers::create(10);
 ```
 
 ### Redeem Vouchers
-Redeeming vouchers requires that one provides a redeemer entity.  
+Redeeming vouchers requires that you provide a redeemer entity.  
 Additional metadata for the redeemer can be provided.
 ```php
 Vouchers::redeem(string $code, Illuminate\Database\Eloquent\Model $entity, array $metadata = []): bool;
@@ -145,7 +145,14 @@ try {
 ```
 
 ### Options
-Besides defaults specified in `config/vouchers.php`, one can override options when generating codes or creating vouchers.  
+Besides defaults specified in `config/vouchers.php`, you can override options when generating codes or creating vouchers.  
+Overriding model class names on runtime can be done using these methods.
+```php
+// Override model class names.
+Config::withModels(string|null $voucher = null, string|null $redeemer = null, string|null $entity = null);
+// Reset model class names.
+Config::resetModels();
+```
 Following methods apply to `Vouchers::generate()`, `Vouchers::batch()` and `Vouchers::create()` calls.
 ```php
 // Override characters list.

src/Config.php

@@ -17,6 +17,13 @@ class Config
      */
     protected array $options = [];
 
+    /**
+     * Overridden model class names.
+     *
+     * @var array<string, string>
+     */
+    protected static array $models = [];
+
     /**
      * Get dynamically set options.
      */
@@ -320,18 +327,34 @@ public function withOwner(?Model $owner): self
     }
 
     /**
-     * Get model class name from config.
+     * Set model class name overrides.
+     */
+    public static function withModels(?string $voucher = null, ?string $redeemer = null, ?string $entity = null): void
+    {
+        static::$models = compact('entity', 'redeemer', 'voucher');
+    }
+
+    /**
+     * Reset model class name overrides.
+     */
+    public static function resetModels(): void
+    {
+        static::$models = [];
+    }
+
+    /**
+     * Get model class name from override or config.
      */
     public static function model(string $name): ?string
     {
-        return config('vouchers.models.' . $name);
+        return static::$models[$name] ?? config("vouchers.models.{$name}");
     }
 
     /**
      * Get database table name for a model from config.
      */
     public static function table(string $name): ?string
     {
-        return config('vouchers.tables.' . $name);
+        return config("vouchers.tables.{$name}");
     }
 }

tests/Feature/Vouchers/ConfigTest.php

@@ -26,7 +26,16 @@
         'redeemer' => 'FakeRedeemer',
         'voucher'  => 'FakeVoucher',
     ];
-    app()['config']->set('vouchers.models', $models);
+
+    // Temporarily overrides.
+    Config::withModels(...$models);
+    foreach ($models as $name => $model) {
+        expect(Config::model($name))->toBe($model);
+    }
+    Config::resetModels();
+
+    // Config overrides.
+    config(['vouchers.models' => $models]);
     foreach ($models as $name => $model) {
         expect(Config::model($name))->toBe($model);
     }
@@ -51,7 +60,7 @@
         'redeemers' => 'this_redeemers',
         'vouchers'  => 'this_vouchers',
     ];
-    app()['config']->set('vouchers.tables', $tables);
+    config(['vouchers.tables' => $tables]);
     foreach ($tables as $name => $table) {
         expect(Config::table($name))->toBe($table);
     }
@@ -66,22 +75,20 @@
  */
 test('default options', function () {
     $config = new Config();
-    $app_config = app()['config'];
 
     expect($config->getOptions())->toBeEmpty();
-    expect($config->getCharacters())->toBe($app_config->get('vouchers.characters'));
-    expect($config->getMask())->toBe($app_config->get('vouchers.mask'));
-    expect($config->getPrefix())->toBe($app_config->get('vouchers.prefix'));
-    expect($config->getSuffix())->toBe($app_config->get('vouchers.suffix'));
-    expect($config->getSeparator())->toBe($app_config->get('vouchers.separator'));
+    expect($config->getCharacters())->toBe(config('vouchers.characters'));
+    expect($config->getMask())->toBe(config('vouchers.mask'));
+    expect($config->getPrefix())->toBe(config('vouchers.prefix'));
+    expect($config->getSuffix())->toBe(config('vouchers.suffix'));
+    expect($config->getSeparator())->toBe(config('vouchers.separator'));
 });
 
 /**
  * Test options overridden in config.
  */
 test('config overridden options', function () {
     $config = new Config();
-    $app_config = app()['config'];
 
     // Override config.
     $options = [
@@ -94,7 +101,7 @@
     foreach ($options as $key => $value) {
         $getter = 'get' . ucfirst($key);
         expect($value)->not->toBe($config->{$getter}());
-        $app_config->set('vouchers.' . $key, $value);
+        config(["vouchers.{$key}" => $value]);
     }
 
     expect($config->getOptions())->toBeEmpty();
@@ -147,11 +154,11 @@
         ->withSuffix(null)
         ->withSeparator(null)
     ;
-    expect($config->getCharacters())->toBe(app()['config']->get('vouchers.characters'));
-    expect($config->getMask())->toBe(app()['config']->get('vouchers.mask'));
-    expect($config->getPrefix())->toBe(app()['config']->get('vouchers.prefix'));
-    expect($config->getSuffix())->toBe(app()['config']->get('vouchers.suffix'));
-    expect($config->getSeparator())->toBe(app()['config']->get('vouchers.separator'));
+    expect($config->getCharacters())->toBe(config('vouchers.characters'));
+    expect($config->getMask())->toBe(config('vouchers.mask'));
+    expect($config->getPrefix())->toBe(config('vouchers.prefix'));
+    expect($config->getSuffix())->toBe(config('vouchers.suffix'));
+    expect($config->getSeparator())->toBe(config('vouchers.separator'));
 });
 
 /**