Add test directories to code quality inspections, change eol

ruleset-php_cs.php

@@ -154,7 +154,7 @@
     __DIR__.'/database',
     __DIR__.'/resources',
     __DIR__.'/routes',
-    //    __DIR__.'/tests'
+    __DIR__.'/tests'
 ];
 
 $finder = Finder::create()

ruleset-phpstan.neon

@@ -3,6 +3,7 @@ includes:
 parameters:
     paths:
         - src
+        - tests
     # The level 8 is the highest level
     level: 6
     reportStaticMethodSignatures: true

tests/Feature/UiTest.php

@@ -2,11 +2,8 @@
 
 namespace GeoSot\EnvEditor\Tests\Feature;
 
-
 use GeoSot\EnvEditor\Facades\EnvEditor;
 use GeoSot\EnvEditor\Tests\TestCase;
-use Illuminate\Config\Repository;
-use Illuminate\Filesystem\Filesystem;
 
 class UiTest extends TestCase
 {
@@ -41,7 +38,6 @@ public function can_download(): void
         $response->assertDownload(self::getTestFile());
     }
 
-
     /**
      * @param  string  $route
      * @param  array<string, string>  $parameters

tests/TestCase.php

@@ -7,20 +7,17 @@
 use Illuminate\Encryption\Encrypter;
 use Orchestra\Testbench\TestCase as OrchestraTestCase;
 
-
 abstract class TestCase extends OrchestraTestCase
 {
-
     protected function getEnvironmentSetUp($app)
     {
         $key = 'base64:'.base64_encode(
-                Encrypter::generateKey('AES-256-CBC')
-            );
+            Encrypter::generateKey('AES-256-CBC')
+        );
 
         $app['config']->set('app.key', $key);
     }
 
-
     /**
      * @inheritdoc
      */
@@ -49,6 +46,7 @@ protected static function getTestPath(): string
     protected static function getTestFile(bool $fullPath = false): string
     {
         $file = '.env.example';
+
         return $fullPath ? static::getTestPath().DIRECTORY_SEPARATOR.$file : $file;
     }
 }

tests/Unit/Helpers/EnvKeysManagerTest.php

@@ -11,7 +11,6 @@
 
 class EnvKeysManagerTest extends TestCase
 {
-
     protected function setUp(): void
     {
         parent::setUp(); // TODO: Change the autogenerated stub
@@ -61,7 +60,6 @@ public function deletes_keys(): void
         self::assertTrue($this->getEnvKeysManager()->deleteKey('CACHE_DRIVER'));
         self::assertStringNotContainsString('CACHE_DRIVER="file"', file_get_contents($fullPath));
 
-
         self::assertStringNotContainsString('CACHE_DRIVER', file_get_contents($fullPath));
         try {
             $this->getEnvKeysManager()->deleteKey('CACHE_DRIVER');
@@ -80,7 +78,6 @@ public function edits_keys(): void
         $fullPath = $this->createNewDummyFile($fileName);
         $this->app['config']->set('env-editor.envFileName', $fileName);
 
-
         self::assertStringContainsString('LOG_CHANNEL=stack', file_get_contents($fullPath));
         self::assertTrue($this->getEnvKeysManager()->editKey('LOG_CHANNEL', 'foo'));
         self::assertStringContainsString('LOG_CHANNEL=foo', file_get_contents($fullPath));
@@ -95,7 +92,6 @@ public function edits_keys(): void
         self::assertTrue($this->getEnvKeysManager()->editKey('CACHE_DRIVER', null));
         self::assertStringContainsString('CACHE_DRIVER=', file_get_contents($fullPath));
 
-
         self::assertStringNotContainsString('WRONG_KEY', file_get_contents($fullPath));
         try {
             $this->getEnvKeysManager()->editKey('WRONG_KEY', 'fail');
@@ -105,7 +101,10 @@ public function edits_keys(): void
         }
     }
 
-
+    /**
+     * @param  array<string, mixed>  $config
+     * @return EnvKeysManager
+     */
     protected function getEnvKeysManager(array $config = []): EnvKeysManager
     {
         $envEditor = new EnvEditor(
@@ -115,6 +114,7 @@ protected function getEnvKeysManager(array $config = []): EnvKeysManager
         $this->app->singleton(EnvEditor::class, function () use ($envEditor) {
             return $envEditor;
         });
+
         return $envEditor->getKeysManager();
     }
 
@@ -126,5 +126,4 @@ protected function createNewDummyFile(string $name = 'test.tmp'): string
 
         return $dummyFullPath;
     }
-
 }

tests/Unit/Helpers/FilesManagerTest.php

@@ -26,7 +26,7 @@ protected function tearDown(): void
      * @test
      * Test makeBackupsDirectory method
      */
-    public function constructor_calls_makeBackupsDirectory_method()
+    public function constructor_calls_makeBackupsDirectory_method(): void
     {
         $classname = EnvFilesManager::class;
 
@@ -51,7 +51,7 @@ public function constructor_calls_makeBackupsDirectory_method()
      * @test
      * Test makeBackupsDirectory method
      */
-    public function backupDir_is_created()
+    public function backupDir_is_created(): void
     {
         $path = $this->getEnvFilesManager()->getBackupsDir();
         $this->createAndTestPath($path);
@@ -61,7 +61,7 @@ public function backupDir_is_created()
      * @test
      * Test makeBackupsDirectory method
      */
-    public function getEnvDir_exists()
+    public function getEnvDir_exists(): void
     {
         $path = $this->getEnvFilesManager()->getEnvDir();
         $this->createAndTestPath($path);
@@ -70,7 +70,7 @@ public function getEnvDir_exists()
     /**
      * @test
      */
-    public function getBackupsDir_can_return_file()
+    public function getBackupsDir_can_return_file(): void
     {
         $path = $this->getEnvFilesManager()->getBackupsDir();
         $filename = 'test.tmp';
@@ -85,7 +85,7 @@ public function getBackupsDir_can_return_file()
     /**
      * @test
      */
-    public function getEnvDir_can_return_file()
+    public function getEnvDir_can_return_file(): void
     {
         $path = $this->getEnvFilesManager()->getEnvDir();
         $filename = 'test.tmp';
@@ -100,7 +100,7 @@ public function getEnvDir_can_return_file()
     /**
      * @test
      */
-    public function getAllBackUps_returns_all_files()
+    public function getAllBackUps_returns_all_files(): void
     {
         $manager = $this->getEnvFilesManager();
         $file1 = $manager->getBackupsDir('test.tmp');
@@ -118,7 +118,7 @@ public function getAllBackUps_returns_all_files()
     /**
      * @test
      */
-    public function backUpCurrentEnv_works_and_returns_bool()
+    public function backUpCurrentEnv_works_and_returns_bool(): void
     {
         $fileName = 'test.tmp';
         $this->app['config']->set('env-editor.envFileName', $fileName);
@@ -147,7 +147,7 @@ public function backUpCurrentEnv_works_and_returns_bool()
     /**
      * @test
      */
-    public function restoreBackup_works_and_returns_bool()
+    public function restoreBackup_works_and_returns_bool(): void
     {
         $manager = $this->getEnvFilesManager();
         //place a dummy env file
@@ -170,7 +170,7 @@ public function restoreBackup_works_and_returns_bool()
     /**
      * @test
      */
-    public function deleteBackup_works_and_returns_bool()
+    public function deleteBackup_works_and_returns_bool(): void
     {
         $fileName = time().'_test.tmp';
         $manager = $this->getEnvFilesManager();
@@ -195,20 +195,22 @@ private function createAndTestPath(string $path): void
         unlink($filename);
     }
 
-    /**
-     * @return mixed
-     */
     private function cleanBackUpDir(): void
     {
         (new Filesystem())->cleanDirectory($this->getEnvFilesManager()->getBackupsDir());
     }
 
+    /**
+     * @param  array<string, mixed>  $config
+     * @return EnvFilesManager
+     */
     protected function getEnvFilesManager(array $config = []): EnvFilesManager
     {
         $envEditor = new EnvEditor(
             new Repository($config ?: $this->app['config']->get('env-editor')),
             new Filesystem()
         );
+
         return $envEditor->getFilesManager();
     }
 }