Merge pull request #37 from tattersoftware/refactor-tests

MGatner · web-flow · commit 196b5c4ef14a · 2022-01-23T20:25:18.000-05:00
Refactor Tests
diff --git a/.github/workflows/rector.yml b/.github/workflows/rector.yml
@@ -64,5 +64,5 @@ jobs:
 
       - name: Analyze for refactoring
         run: |
-          composer global require --dev rector/rector:^0.12.10
+          composer global require --dev rector/rector:dev-main
           rector process --dry-run --no-progress-bar
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-vendor/
+/vendor/
 build/
 phpunit*.xml
 phpunit
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -5,6 +5,7 @@
 
 * Switches to `Tatter\Preferences` for managing persistent settings; read more below
 * Drops `Tatter\Audits` as a dependency and adds it as a suggestion; read more below
+* Access rights are now handled via Config file; see [Tatter\Permits](https://github.com/tattersoftware/codeigniter4-permits) for more information
 
 ### `Settings` Migration
 
@@ -29,7 +30,7 @@ php spark migrate --all
 ```
 
 Example model file in **app/Models/FileModel.php**:
-```
+```php
 <?php
 
 namespace App\Models;
diff --git a/composer.json b/composer.json
@@ -26,12 +26,11 @@
         "tatter/alerts": "^2.0",
         "tatter/exports": "^2.0",
         "tatter/frontend": "^1.0",
-        "tatter/permits": "^2.0",
+        "tatter/permits": "^3.0",
         "tatter/preferences": "^1.0",
         "tatter/thumbnails": "^1.2"
     },
     "require-dev": {
-        "antecedent/patchwork": "^2.1",
         "codeigniter4/devkit": "^1.0",
         "codeigniter4/framework": "^4.1",
         "tatter/imposter": "^1.0"
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -10,7 +10,6 @@
 		convertErrorsToExceptions="true"
 		convertNoticesToExceptions="true"
 		convertWarningsToExceptions="true"
-		executionOrder="random"
 		failOnRisky="true"
 		failOnWarning="true"
 		stopOnError="false"
diff --git a/rector.php b/rector.php
@@ -77,6 +77,11 @@
             __DIR__ . '/tests',
         ],
 
+        // Ignore files that should not be namespaced
+        NormalizeNamespaceByPSR4ComposerAutoloadRector::class => [
+            __DIR__ . '/src/Helpers',
+        ],
+
         // May load view files directly when detecting classes
         StringClassNameToClassConstantRector::class,
 
diff --git a/src/Config/Registrar.php b/src/Config/Registrar.php
@@ -17,4 +17,21 @@ public static function Pager()
             ],
         ];
     }
+
+    /**
+     * Adds necessary configuration values for Permits
+     * to identify the owner(s) of files.
+     *
+     * @return array<string,mixed>
+     */
+    public static function Permits()
+    {
+        return [
+            'files' => [
+                'userKey'    => 'user_id',
+                'pivotKey'   => 'file_id',
+                'pivotTable' => 'files_users',
+            ],
+        ];
+    }
 }
diff --git a/src/Controllers/Files.php b/src/Controllers/Files.php
@@ -23,7 +23,7 @@ class Files extends Controller
     protected FilesConfig $config;
 
     /**
-     * The model to use, may be a child of this library's.
+     * The model to use.
      */
     protected FileModel $model;
 
@@ -156,7 +156,6 @@ public function user($userId = null)
             }
 
             $this->setData([
-                'access'   => $this->model->mayAdmin() ? 'manage' : 'display',
                 'title'    => 'User Files',
                 'userName' => 'User',
             ]);
diff --git a/src/Entities/File.php b/src/Entities/File.php
@@ -18,7 +18,7 @@ class File extends Entity
     /**
      * Resolved path to the default thumbnail
      */
-    protected static ?string $defaultThumbnail;
+    protected static ?string $defaultThumbnail = null;
 
     /**
      * Returns the absolute path to the configured default thumbnail
diff --git a/src/Models/FileModel.php b/src/Models/FileModel.php
@@ -34,12 +34,6 @@ class FileModel extends Model
         'size' => 'permit_empty|is_natural',
     ];
 
-    // Permits
-    protected $mode       = 04660;
-    protected $userKey    = 'user_id';
-    protected $pivotKey   = 'file_id';
-    protected $usersPivot = 'files_users';
-
     //--------------------------------------------------------------------
 
     /**
diff --git a/src/Structures/FileObject.php b/src/Structures/FileObject.php
@@ -16,7 +16,7 @@ class FileObject extends File
     /**
      * Base file name to override disk version
      */
-    protected ?string $basename;
+    protected ?string $basename = null;
 
     /**
      * Returns the full path to this file
@@ -35,7 +35,7 @@ public function setBasename(?string $basename = null): self
      *
      * @param string $suffix Optional suffix to omit from the base name returned
      */
-    public function getBasename($suffix = null): string
+    public function getBasename($suffix = ''): string
     {
         if ($this->basename) {
             return basename($this->basename, $suffix);
diff --git a/tests/_support/FeatureTestCase.php b/tests/_support/FeatureTestCase.php
@@ -2,9 +2,7 @@
 
 namespace Tests\Support;
 
-use CodeIgniter\Config\Factories;
 use CodeIgniter\Test\FeatureTestTrait;
-use Tests\Support\Models\UserModel;
 
 /**
  * @internal
@@ -22,9 +20,6 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        // Make sure we use the correct UserModel for permissions
-        Factories::injectMock('models', UserModel::class, new UserModel());
-
         // Make sure everything is published once
         $this->publishAll();
     }
diff --git a/tests/_support/Models/UserModel.php b/tests/_support/Models/UserModel.php
diff --git a/tests/_support/TestCase.php b/tests/_support/TestCase.php
@@ -8,6 +8,10 @@
 use org\bovigo\vfs\vfsStream;
 use Tatter\Assets\Test\AssetsTestTrait;
 use Tatter\Files\Config\Files;
+use Tatter\Files\Models\FileModel;
+use Tatter\Imposter\Entities\User;
+use Tatter\Imposter\Factories\ImposterFactory;
+use Tatter\Users\UserProvider;
 
 /**
  * @internal
@@ -17,19 +21,26 @@ abstract class TestCase extends CIUnitTestCase
     use AssetsTestTrait;
     use DatabaseTestTrait;
 
-    protected $refresh = false;
+    protected $refreshVfs = false;
+    protected $refresh    = false;
     protected $namespace;
 
     /**
      * Path to a test file to work with
      */
     protected string $testPath;
 
+    /**
+     * @var FileModel
+     */
+    protected $model;
+
     public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
 
         helper(['auth', 'files', 'preferences']);
+        UserProvider::addFactory(ImposterFactory::class, ImposterFactory::class);
     }
 
     protected function setUp(): void
@@ -38,22 +49,50 @@ protected function setUp(): void
 
         parent::setUp();
 
-        $_REQUEST = [];
         $_POST    = [];
         $_GET     = [];
         $_FILES   = [];
+        $_REQUEST = [];
 
-        // Copy the files to VFS
-        vfsStream::copyFromFileSystem(SUPPORTPATH . 'VFS', $this->root);
-
-        // "vendor" gets ignored by .gitignore so rename it after copying to VFS
-        $path = $this->root->url() . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR;
-        rename($this->root->url() . '/storage', $path);
-        $this->testPath = $path . 'image.jpg';
+        // Make sure all files are on a single page
+        $_REQUEST['perPage'] = 200;
 
         // Force Files config to the virtual path
+        $path   = self::$root->url() . DIRECTORY_SEPARATOR;
         $config = config('Files');
         $config->setPath($path);
         Factories::injectMock('config', 'Files', $config);
+
+        // Copy the files to VFS (if necessary)
+        $this->testPath = $config->getPath() . 'image.jpg';
+        if (! is_file($this->testPath)) {
+            vfsStream::copyFromFileSystem(SUPPORTPATH . 'VFS', self::$root);
+        }
+
+        // Set up the model
+        $this->model = model(FileModel::class); // @phpstan-ignore-line
+    }
+
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        ImposterFactory::reset();
+    }
+
+    /**
+     * Creates a test User with some files.
+     *
+     * @return array Tuple of [User, File]
+     */
+    protected function createUserWithFile(): array
+    {
+        $user     = ImposterFactory::fake();
+        $user->id = ImposterFactory::add($user);
+
+        $file = fake(FileModel::class);
+        $this->model->addToUser($file->id, $user->id);
+
+        return [$user, $file];
     }
 }
diff --git a/tests/_support/VFS/image.jpg b/tests/_support/VFS/image.jpg
diff --git a/tests/feature/DisplayTest.php b/tests/feature/DisplayTest.php
@@ -8,7 +8,8 @@
  */
 final class DisplayTest extends FeatureTestCase
 {
-    protected $refresh = true;
+    protected $refresh    = true;
+    protected $refreshVfs = true;
 
     public function testNoFiles()
     {
@@ -144,8 +145,6 @@ public function testSearches(string $keyword)
 
     public function testPages()
     {
-        $_REQUEST['perPage'] = 2;
-
         for ($i = 0; $i < 2; $i++) {
             $file = fake(FileModel::class);
         }
@@ -156,7 +155,8 @@ public function testPages()
         ]);
 
         // Last file should be on the next page
-        $result = $this->get('files');
+        $_REQUEST['perPage'] = 2;
+        $result              = $this->get('files');
 
         $result->assertStatus(200);
         $result->assertDontSee($file->filename);
diff --git a/tests/feature/PermissionsTest.php b/tests/feature/PermissionsTest.php
diff --git a/tests/feature/UserTest.php b/tests/feature/UserTest.php
diff --git a/tests/misc/ControllerTest.php b/tests/misc/ControllerTest.php
diff --git a/tests/misc/EntityTest.php b/tests/misc/EntityTest.php
diff --git a/tests/misc/ModelTest.php b/tests/misc/ModelTest.php

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-vendor/`
	`1`	`+/vendor/`
`2`	`2`	`build/`
`3`	`3`	`phpunit*.xml`
`4`	`4`	`phpunit`