Merge pull request #3 from netsells/feature/enable-hashing-override

feature/enable-hashing-override

Author: tomchkk

README.md

@@ -59,14 +59,17 @@ Publish the package config file:
 
 Optionally set a `HASH_MODEL_IDS_SALT` in `.env`.
 
-
 ## Translations
 
 Publish the package translations file:
 
 `php artisan vendor:publish --tag=hash-model-ids-lang`
 
 
+## Development
+
+Sometimes, during development, it can be awkward dealing with hashed ids. Set `HASH_MODEL_IDS_ENABLED=false` in your environment file to enable use of a (configurable) prefixed version of a model's actual id rather than the default hashed version.
+
 ## Testing
 
 `./vendor/bin/phpunit`

config/hash-model-ids.php

@@ -1,7 +1,9 @@
 <?php
 
 return [
+    'enabled' => (bool) env('HASH_MODEL_IDS_ENABLED', true),
     'salt' => env('HASH_MODEL_IDS_SALT', hash('sha256', env('APP_KEY'))),
     'min_hash_length' => 10,
-    'alphabet' => 'abcdefghijklmnopqrstuvwxyz0123456789'
+    'alphabet' => 'abcdefghijklmnopqrstuvwxyz0123456789',
+    'prefix' => 'id_',
 ];

src/ModelIdPrefixer.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Netsells\HashModelIds;
+
+use Illuminate\Database\Eloquent\Model;
+
+class ModelIdPrefixer implements ModelIdHasherInterface
+{
+    public const DEFAULT_PREFIX = 'id_';
+
+    public function __construct(private readonly string $prefix = self::DEFAULT_PREFIX)
+    {
+        //
+    }
+
+    public function encode(Model $model, $id): string
+    {
+        return "{$this->prefix}{$id}";
+    }
+
+    public function decode(Model $model, $hash): string
+    {
+        return substr($hash, strlen($this->prefix));
+    }
+}

src/ServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace Netsells\HashModelIds;
 
+use Illuminate\Foundation\Application;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 
 class ServiceProvider extends BaseServiceProvider
@@ -19,14 +20,21 @@ public function register()
         );
 
         $this->app->singleton(ModelIdHasherInterface::class, function ($app) {
-            return new ModelIdHasher([
-                'salt' => config('hash-model-ids.salt'),
-                'min_hash_length' => config('hash-model-ids.min_hash_length'),
-                'alphabet' => config('hash-model-ids.alphabet'),
-            ]);
+            return ! $this->shouldHashIds($app)
+                ? new ModelIdPrefixer(config('hash-model-ids.prefix', ModelIdPrefixer::DEFAULT_PREFIX))
+                : new ModelIdHasher([
+                    'salt' => config('hash-model-ids.salt'),
+                    'min_hash_length' => config('hash-model-ids.min_hash_length'),
+                    'alphabet' => config('hash-model-ids.alphabet'),
+                ]);
         });
     }
 
+    private function shouldHashIds(Application $app): bool
+    {
+        return $app->isProduction() || config('hash-model-ids.enabled', true);
+    }
+
     /**
      * Bootstrap any package services.
      *

tests/Integration/AbstractIntegrationTest.php

@@ -14,11 +14,11 @@ protected function getPackageProviders($app): array
 
     protected function defineDatabaseMigrations(): void
     {
-        $this->loadMigrationsFrom(__DIR__ . '/fixtures/migrations');
+        $this->loadMigrationsFrom(__DIR__ . '/Fixtures/migrations');
     }
 
     protected function defineEnvironment($app): void
     {
-        $app['config']->set('hash_model_ids.salt', 'test-salt');
+        $app['config']->set('hash-model-ids.salt', 'test-salt');
     }
 }

tests/Integration/ExistsWithHashedIdRuleTest.php

@@ -5,7 +5,7 @@
 use Illuminate\Database\Eloquent\Builder;
 use InvalidArgumentException;
 use Netsells\HashModelIds\ExistsWithHashedIdRule;
-use Netsells\HashModelIds\Tests\Integration\fixtures\Models;
+use Netsells\HashModelIds\Tests\Integration\Fixtures\Models;
 
 class ExistsWithHashedIdRuleTest extends AbstractIntegrationTest
 {

tests/Integration/fixtures/Models/Bar.php renamed to tests/Integration/Fixtures/Models/Bar.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Netsells\HashModelIds\Tests\Integration\fixtures\Models;
+namespace Netsells\HashModelIds\Tests\Integration\Fixtures\Models;
 
 use Illuminate\Database\Eloquent\Model;
 

tests/Integration/fixtures/Models/Foo.php renamed to tests/Integration/Fixtures/Models/Foo.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Netsells\HashModelIds\Tests\Integration\fixtures\Models;
+namespace Netsells\HashModelIds\Tests\Integration\Fixtures\Models;
 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;

tests/Integration/fixtures/Models/FooRelation.php renamed to tests/Integration/Fixtures/Models/FooRelation.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Netsells\HashModelIds\Tests\Integration\fixtures\Models;
+namespace Netsells\HashModelIds\Tests\Integration\Fixtures\Models;
 
 use Illuminate\Database\Eloquent\Model;
 use Netsells\HashModelIds\HashesModelIdsTrait;

tests/Integration/fixtures/Models/Trashed.php renamed to tests/Integration/Fixtures/Models/Trashed.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Netsells\HashModelIds\Tests\Integration\fixtures\Models;
+namespace Netsells\HashModelIds\Tests\Integration\Fixtures\Models;
 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;