From e7247fb81e09814caa991fbbf6a60678fc1ee05b Mon Sep 17 00:00:00 2001
From: Randall Wilk <22842525+rawilk@users.noreply.github.com>
Date: Wed, 27 Sep 2023 12:31:06 -0500
Subject: [PATCH] Update pint config (#29)

---
 .github/workflows/pint.yml      |  54 ++++++------
 config/settings.php             |   2 +
 pint.json                       |  32 +++++++-
 src/Drivers/Factory.php         |  10 +--
 src/Models/Setting.php          |   8 +-
 src/Settings.php                | 140 ++++++++++++++++----------------
 src/SettingsServiceProvider.php |  16 ++--
 tests/Feature/SettingsTest.php  |   2 +-
 tests/Pest.php                  |   2 +
 tests/TestCase.php              |  14 ++--
 10 files changed, 159 insertions(+), 121 deletions(-)

diff --git a/.github/workflows/pint.yml b/.github/workflows/pint.yml
index e8f2d06..4b12f4a 100644
--- a/.github/workflows/pint.yml
+++ b/.github/workflows/pint.yml
@@ -1,34 +1,38 @@
 name: PHP Linting (Pint)
 
 on:
-  workflow_dispatch:
-  push:
-    branches-ignore:
-      - 'dependabot/npm_and_yarn/*'
+    workflow_dispatch:
+    push:
+        branches-ignore:
+            - 'dependabot/npm_and_yarn/*'
+
+permissions:
+    contents: write
 
 jobs:
-  phplint:
-    runs-on: ubuntu-latest
+    phplint:
+        runs-on: ubuntu-latest
 
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 2
+        steps:
+            -   name: Checkout code
+                uses: actions/checkout@v4
+                with:
+                    fetch-depth: 2
+                    ref: ${{ github.head_ref }}
 
-      - name: Laravel pint
-        uses: aglipanci/laravel-pint-action@2.3.0
-        with:
-          preset: laravel
+            -   name: Laravel pint
+                uses: aglipanci/laravel-pint-action@2.3.0
+                with:
+                    preset: laravel
 
-      - name: Extract branch name
-        shell: bash
-        run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
-        id: extract_branch
+            -   name: Extract branch name
+                shell: bash
+                run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+                id: extract_branch
 
-      - name: Commit Changes
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: PHP Linting (Pint)
-          branch: ${{ steps.extract_branch.outputs.branch }}
-          skip_fetch: true
+            -   name: Commit Changes
+                uses: stefanzweifel/git-auto-commit-action@v4
+                with:
+                    commit_message: PHP Linting (Pint)
+                    branch: ${{ steps.extract_branch.outputs.branch }}
+                    skip_fetch: true
diff --git a/config/settings.php b/config/settings.php
index 7d898ee..6553bf3 100644
--- a/config/settings.php
+++ b/config/settings.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
     /*
     |--------------------------------------------------------------------------
diff --git a/pint.json b/pint.json
index 5b7dcca..2e326cc 100644
--- a/pint.json
+++ b/pint.json
@@ -7,6 +7,36 @@
         "types_spaces": {
             "space": "none"
         },
-        "single_trait_insert_per_statement": true
+        "combine_consecutive_issets": true,
+        "combine_consecutive_unsets": true,
+        "declare_parentheses": true,
+        "declare_strict_types": true,
+        "explicit_string_variable": true,
+        "single_trait_insert_per_statement": true,
+        "ordered_class_elements": {
+            "order": [
+                "use_trait",
+                "case",
+                "constant",
+                "constant_public",
+                "constant_protected",
+                "constant_private",
+                "property_public",
+                "property_protected",
+                "property_private",
+                "construct",
+                "destruct",
+                "magic",
+                "phpunit",
+                "method_abstract",
+                "method_public_static",
+                "method_public",
+                "method_protected_static",
+                "method_protected",
+                "method_private_static",
+                "method_private"
+            ],
+            "sort_algorithm": "none"
+        }
     }
 }
diff --git a/src/Drivers/Factory.php b/src/Drivers/Factory.php
index 0c45db6..36e9d4a 100644
--- a/src/Drivers/Factory.php
+++ b/src/Drivers/Factory.php
@@ -33,6 +33,11 @@ public function extend(string $driver, Closure $callback): self
         return $this;
     }
 
+    public function setDefaultDriver(string $driver): void
+    {
+        $this->app['config']['settings.driver'] = $driver;
+    }
+
     protected function createDatabaseDriver(array $config): DatabaseDriver
     {
         return new DatabaseDriver(
@@ -54,11 +59,6 @@ protected function getDefaultDriver(): string
         return $this->app['config']['settings.driver'];
     }
 
-    public function setDefaultDriver(string $driver): void
-    {
-        $this->app['config']['settings.driver'] = $driver;
-    }
-
     protected function getDriverConfig(string $driver): ?array
     {
         return $this->app['config']["settings.drivers.{$driver}"];
diff --git a/src/Models/Setting.php b/src/Models/Setting.php
index eec7de1..781946b 100644
--- a/src/Models/Setting.php
+++ b/src/Models/Setting.php
@@ -10,8 +10,12 @@
 
 class Setting extends Model implements SettingContract
 {
+    public $timestamps = false;
+
     protected ?string $teamForeignKey = null;
 
+    protected $guarded = ['id'];
+
     public function __construct(array $attributes = [])
     {
         parent::__construct($attributes);
@@ -20,10 +24,6 @@ public function __construct(array $attributes = [])
         $this->teamForeignKey = config('settings.team_foreign_key');
     }
 
-    protected $guarded = ['id'];
-
-    public $timestamps = false;
-
     public static function getValue(string $key, $default = null, $teamId = null)
     {
         $value = static::query()
diff --git a/src/Settings.php b/src/Settings.php
index 40b4619..c670c82 100755
--- a/src/Settings.php
+++ b/src/Settings.php
@@ -213,62 +213,6 @@ public function isTrue(string $key, $default = true): bool
         return $value === true || $value === '1' || $value === 1;
     }
 
-    protected function normalizeKey(string $key): string
-    {
-        if (Str::startsWith(haystack: $key, needles: 'file_')) {
-            return str_replace(search: 'file_', replace: 'file.', subject: $key);
-        }
-
-        return $key;
-    }
-
-    protected function getCacheKey(string $key): string
-    {
-        $cacheKey = $this->cacheKeyPrefix . $key;
-
-        if ($this->teams) {
-            $teamId = $this->teamId ?? 'null';
-
-            $cacheKey .= "::team:{$teamId}";
-        }
-
-        return $cacheKey;
-    }
-
-    protected function getKeyForStorage(string $key): string
-    {
-        return $this->keyGenerator->generate(key: $key, context: $this->context);
-    }
-
-    protected function serializeValue($value): string
-    {
-        return $this->valueSerializer->serialize($value);
-    }
-
-    protected function unserializeValue($serialized)
-    {
-        if (! is_string($serialized)) {
-            return $serialized;
-        }
-
-        // Attempt to unserialize the value, but return the original value if that fails.
-        return rescue(fn () => $this->valueSerializer->unserialize($serialized), fn () => $serialized);
-    }
-
-    protected function shouldSetNewValue(string $key, $newValue): bool
-    {
-        if (! $this->cacheIsEnabled()) {
-            return true;
-        }
-
-        // To prevent decryption errors, we will check if we have a setting set for the current context and key.
-        if (! $this->doNotResetContext()->has($key)) {
-            return true;
-        }
-
-        return $newValue !== $this->doNotResetContext()->get($key);
-    }
-
     public function disableCache(): self
     {
         $this->cacheEnabled = false;
@@ -297,15 +241,6 @@ public function setCache(Cache $cache): self
         return $this;
     }
 
-    protected function cacheIsEnabled(): bool
-    {
-        if ($this->temporarilyDisableCache) {
-            return false;
-        }
-
-        return $this->cacheEnabled && $this->cache !== null;
-    }
-
     public function disableEncryption(): self
     {
         $this->encryptionEnabled = false;
@@ -327,11 +262,6 @@ public function setEncrypter(Encrypter $encrypter): self
         return $this;
     }
 
-    protected function encryptionIsEnabled(): bool
-    {
-        return $this->encryptionEnabled && $this->encrypter !== null;
-    }
-
     public function enableTeams(): self
     {
         $this->teams = true;
@@ -358,6 +288,76 @@ public function useCacheKeyPrefix(string $prefix): self
         return $this;
     }
 
+    protected function normalizeKey(string $key): string
+    {
+        if (Str::startsWith(haystack: $key, needles: 'file_')) {
+            return str_replace(search: 'file_', replace: 'file.', subject: $key);
+        }
+
+        return $key;
+    }
+
+    protected function getCacheKey(string $key): string
+    {
+        $cacheKey = $this->cacheKeyPrefix . $key;
+
+        if ($this->teams) {
+            $teamId = $this->teamId ?? 'null';
+
+            $cacheKey .= "::team:{$teamId}";
+        }
+
+        return $cacheKey;
+    }
+
+    protected function getKeyForStorage(string $key): string
+    {
+        return $this->keyGenerator->generate(key: $key, context: $this->context);
+    }
+
+    protected function serializeValue($value): string
+    {
+        return $this->valueSerializer->serialize($value);
+    }
+
+    protected function unserializeValue($serialized)
+    {
+        if (! is_string($serialized)) {
+            return $serialized;
+        }
+
+        // Attempt to unserialize the value, but return the original value if that fails.
+        return rescue(fn () => $this->valueSerializer->unserialize($serialized), fn () => $serialized);
+    }
+
+    protected function shouldSetNewValue(string $key, $newValue): bool
+    {
+        if (! $this->cacheIsEnabled()) {
+            return true;
+        }
+
+        // To prevent decryption errors, we will check if we have a setting set for the current context and key.
+        if (! $this->doNotResetContext()->has($key)) {
+            return true;
+        }
+
+        return $newValue !== $this->doNotResetContext()->get($key);
+    }
+
+    protected function cacheIsEnabled(): bool
+    {
+        if ($this->temporarilyDisableCache) {
+            return false;
+        }
+
+        return $this->cacheEnabled && $this->cache !== null;
+    }
+
+    protected function encryptionIsEnabled(): bool
+    {
+        return $this->encryptionEnabled && $this->encrypter !== null;
+    }
+
     protected function decryptValue($value)
     {
         if (! $this->encryptionIsEnabled()) {
diff --git a/src/SettingsServiceProvider.php b/src/SettingsServiceProvider.php
index 0a2bea9..4e30aab 100644
--- a/src/SettingsServiceProvider.php
+++ b/src/SettingsServiceProvider.php
@@ -32,6 +32,14 @@ public function packageRegistered(): void
         $this->registerSettings();
     }
 
+    public function provides(): array
+    {
+        return [
+            Settings::class,
+            'SettingsFactory',
+        ];
+    }
+
     protected function bootModelBindings(): void
     {
         $config = $this->app['config']['settings.drivers.eloquent'];
@@ -70,12 +78,4 @@ protected function registerSettings(): void
             return $settings;
         });
     }
-
-    public function provides(): array
-    {
-        return [
-            Settings::class,
-            'SettingsFactory',
-        ];
-    }
 }
diff --git a/tests/Feature/SettingsTest.php b/tests/Feature/SettingsTest.php
index 8b672bd..9fe2eed 100644
--- a/tests/Feature/SettingsTest.php
+++ b/tests/Feature/SettingsTest.php
@@ -340,7 +340,7 @@ function isSerialized(mixed $data): bool
         case 'd':
             $end = '';
 
-            return (bool) preg_match("/^{$token}:[0-9.E+-]+;$end/", $data);
+            return (bool) preg_match("/^{$token}:[0-9.E+-]+;{$end}/", $data);
     }
 
     return false;
diff --git a/tests/Pest.php b/tests/Pest.php
index 2b450b0..e50d933 100644
--- a/tests/Pest.php
+++ b/tests/Pest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use Illuminate\Support\Facades\DB;
 use Rawilk\Settings\Facades\Settings;
 use Rawilk\Settings\Tests\TestCase;
diff --git a/tests/TestCase.php b/tests/TestCase.php
index 1c61f4a..f431e2d 100644
--- a/tests/TestCase.php
+++ b/tests/TestCase.php
@@ -9,13 +9,6 @@
 
 class TestCase extends Orchestra
 {
-    protected function getPackageProviders($app): array
-    {
-        return [
-            SettingsServiceProvider::class,
-        ];
-    }
-
     public function getEnvironmentSetUp($app): void
     {
         $migrations = [
@@ -27,4 +20,11 @@ public function getEnvironmentSetUp($app): void
             $migration->up();
         }
     }
+
+    protected function getPackageProviders($app): array
+    {
+        return [
+            SettingsServiceProvider::class,
+        ];
+    }
 }