Collections, In-Memory Indexing, Media Handling Modernization

.github/workflows/phan.yml

@@ -0,0 +1,32 @@
+name: Phan
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+permissions:
+  contents: read
+
+jobs:
+  phan:
+    name: Phan
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+
+      - name: Install dependencies
+        run: composer install --no-interaction --prefer-dist --no-progress
+
+      - name: Run Phan
+        run: composer analyze

.phan/config.php

@@ -0,0 +1,20 @@
+<?php
+
+return [
+    'target_php_version' => '8.4',
+    'directory_list' => [
+        'src',
+        'vendor/filp/whoops/src',
+        'vendor/guzzlehttp/psr7/src',
+        'vendor/psr/http-message/src',
+        'vendor/psr/http-server-handler/src',
+        'vendor/twig/twig/src',
+    ],
+    'exclude_analysis_directory_list' => [
+        'vendor',
+    ],
+    'exclude_file_regex' => '@^vendor/.*/(?:tests?|Tests?)/@',
+    'suppress_issue_types' => [
+        'PhanUnreferencedUseNormal',
+    ],
+];

.php-cs-fixer.dist.php

@@ -0,0 +1,98 @@
+<?php
+
+$header = <<<EOF
+This file is part of the Divergence package.
+
+(c) Henry Paradiz <henry.paradiz@gmail.com>
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+EOF;
+
+$headerRule = [
+    'header' => $header,
+    'validator' => '/' . preg_quote($header, '/') . '(?P<EXTRA>.*)??/s',
+    'comment_type' => 'PHPDoc',
+    'location' => 'after_open',
+    'separate' => 'none',
+];
+
+$headerPolicy = new class($headerRule) implements PhpCsFixer\Config\RuleCustomisationPolicyInterface {
+    private array $headerRule;
+    private string $headerPrefix;
+
+    public function __construct(array $headerRule)
+    {
+        $this->headerRule = $headerRule;
+        $this->headerPrefix = "<?php\n/**\n" . implode("\n", array_map(
+            static fn (string $line): string => rtrim(' * ' . $line),
+            explode("\n", $headerRule['header'])
+        )) . "\n";
+    }
+
+    public function getPolicyVersionForCache(): string
+    {
+        return 'preserve-header-separation-v3';
+    }
+
+    public function getRuleCustomisers(): array
+    {
+        return [
+            'header_comment' => $this->customizeHeaderComment(...),
+        ];
+    }
+
+    private function customizeHeaderComment(SplFileInfo $file): bool|PhpCsFixer\Fixer\FixerInterface
+    {
+        $contents = file_get_contents($file->getPathname());
+
+        if (false !== $contents && str_starts_with(str_replace("\r", '', $contents), $this->headerPrefix)) {
+            return false;
+        }
+
+        $headerRule = $this->headerRule;
+
+        if (false !== $contents && preg_match('/\A<\?php\R(?<doc>\/\*\*.*?\*\/)(?<separator>\R*)/s', $contents, $matches)) {
+            $lines = array_slice(explode("\n", str_replace("\r", '', $matches['doc'])), 1, -1);
+            $extra = implode("\n", array_map(
+                static fn (string $line): string => ' *' === $line ? '' : (str_starts_with($line, ' * ') ? substr($line, 3) : $line),
+                $lines
+            ));
+
+            if ('' !== trim($extra)) {
+                $headerRule['header'] .= "\n\n" . $extra;
+            }
+
+            if (1 < substr_count(str_replace("\r", '', $matches['separator']), "\n")) {
+                $headerRule['separate'] = 'bottom';
+            }
+        }
+
+        $fixer = new PhpCsFixer\Fixer\Comment\HeaderCommentFixer();
+        $fixer->configure($headerRule);
+
+        return $fixer;
+    }
+};
+
+$finder = (new PhpCsFixer\Finder())
+    //->exclude('somedir')
+    ->in(__DIR__)
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR1' => true,
+        '@PSR2' => true,
+        'no_break_comment' => false,
+        'array_syntax' => ['syntax' => 'short'],
+        'trailing_comma_in_multiline' => ['elements' => ['arrays']],
+        'no_trailing_comma_in_singleline' => true,
+        'ternary_operator_spaces' => true,
+        'trim_array_spaces' => true,
+        'indentation_type' => true,
+        'header_comment' => $headerRule,
+    ])
+    ->setRuleCustomisationPolicy($headerPolicy)
+    ->setFinder($finder)   
+;

.scrutinizer.yml

@@ -1,12 +1,23 @@
 checks:
   php:
+    argument_type_checks: false 
     code_rating: true
     duplication: true
+    fix_doc_comments: false
+    no_exit: false
+    unused_parameters: false
+    unused_properties: false
+    unused_variables: false
+    use_statement_alias_conflict: false
+    verify_property_names: false
 
 build:
   image: default-jammy
   environment:
-    php: 8.4.11
+    php:
+      version: 8.4.11
+      ini:
+        memory_limit: "512M"
   nodes:
     coverage:
       services:

composer.json

@@ -43,12 +43,14 @@
         "phpunit/phpcov": "^12.0",
         "friendsofphp/php-cs-fixer": "*",
         "mikey179/vfsstream": "^1.6",
-        "fakerphp/faker": "^1.20"
+        "fakerphp/faker": "^1.20",
+        "phan/phan": "^6.0"
     },
     "suggest": {
         "divergence/cli": "Lets you initialize a new project as well as create, edit, and test database configurations via CLI."
     },
     "scripts": {
+        "analyze": "phan --allow-polyfill-parser --no-progress-bar",
         "fix-code": "php-cs-fixer fix",
         "test": [
             "@test:mysql",

src/Controllers/Media/Endpoints/Browse.php

@@ -1,4 +1,14 @@
 <?php
+/**
+ * This file is part of the Divergence package.
+ *
+ * (c) Henry Paradiz <henry.paradiz@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @phan-file-suppress PhanUndeclaredClassMethod
+ */
 
 namespace Divergence\Controllers\Media\Endpoints;
 

src/Controllers/Media/Endpoints/Caption.php

@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * This file is part of the Divergence package.
+ *
+ * (c) Henry Paradiz <henry.paradiz@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 namespace Divergence\Controllers\Media\Endpoints;
 
 use Divergence\Controllers\Media\AbstractMediaEndpoint;

src/Controllers/Media/Endpoints/Delete.php

@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * This file is part of the Divergence package.
+ *
+ * (c) Henry Paradiz <henry.paradiz@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 namespace Divergence\Controllers\Media\Endpoints;
 
 use Divergence\Controllers\Media\AbstractMediaEndpoint;

src/Controllers/Media/Endpoints/Download.php

@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * This file is part of the Divergence package.
+ *
+ * (c) Henry Paradiz <henry.paradiz@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 namespace Divergence\Controllers\Media\Endpoints;
 
 use Divergence\Controllers\Media\AbstractMediaEndpoint;
@@ -41,6 +48,9 @@ public function handle(...$arguments): ResponseInterface
         }
 
         $filePath = $Media->getFilesystemPath('original');
+        if ($filePath === null) {
+            return $this->handler->throwNotFoundError();
+        }
         $this->handler->responseBuilder = MediaBuilder::class;
         $response = $this->handler->respondWithMedia($Media, 'original', $filePath);
 

src/Controllers/Media/Endpoints/Info.php

@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * This file is part of the Divergence package.
+ *
+ * (c) Henry Paradiz <henry.paradiz@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 namespace Divergence\Controllers\Media\Endpoints;
 
 use Divergence\Controllers\Media\AbstractMediaEndpoint;

src/Controllers/Media/Endpoints/Media.php

@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * This file is part of the Divergence package.
+ *
+ * (c) Henry Paradiz <henry.paradiz@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 namespace Divergence\Controllers\Media\Endpoints;
 
 use Divergence\Controllers\Media\AbstractMediaEndpoint;
@@ -66,6 +73,10 @@ public function handle(...$arguments): ResponseInterface
         set_time_limit(0);
         $filePath = $Media->getFilesystemPath($variant);
 
+        if ($filePath === null) {
+            return $this->handler->throwNotFoundError();
+        }
+
         if (!empty($_server['HTTP_IF_NONE_MATCH']) || !empty($_server['HTTP_IF_MODIFIED_SINCE'])) {
             $this->handler->responseBuilder = EmptyBuilder::class;
             $response = $this->handler->respondEmpty($filePath);

src/Controllers/Media/Endpoints/MediaDelete.php

@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * This file is part of the Divergence package.
+ *
+ * (c) Henry Paradiz <henry.paradiz@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 namespace Divergence\Controllers\Media\Endpoints;
 
 use Divergence\Controllers\Media\AbstractMediaEndpoint;
@@ -39,7 +46,7 @@ public function handle(...$arguments): ResponseInterface
 
         $deleted = [];
         foreach ($mediaArray as $mediaId => $Media) {
-            if ($Media->delete()) {
+            if ($Media->destroy()) {
                 $deleted[] = $mediaId;
             }
         }

src/Controllers/Media/Endpoints/Thumbnail.php

@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * This file is part of the Divergence package.
+ *
+ * (c) Henry Paradiz <henry.paradiz@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 namespace Divergence\Controllers\Media\Endpoints;
 
 use Divergence\Controllers\Media\AbstractMediaEndpoint;
@@ -41,7 +48,8 @@ public function handle(...$arguments): ResponseInterface
             return $response;
         }
 
-        if (preg_match('/^(\d+)x(\d+)(x([0-9A-F]{6})?)?$/i', $this->handler->peekPath(), $matches)) {
+        $size = $this->handler->peekPath();
+        if (is_string($size) && preg_match('/^(\d+)x(\d+)(x([0-9A-F]{6})?)?$/i', $size, $matches)) {
             $this->handler->shiftPath();
             $maxWidth = $matches[1];
             $maxHeight = $matches[2];
@@ -62,7 +70,7 @@ public function handle(...$arguments): ResponseInterface
             $thumbPath = $Media->getThumbnail($maxWidth, $maxHeight, $fillColor, $cropped);
             $this->handler->responseBuilder = MediaBuilder::class;
 
-            return $this->handler->respondWithThumbnail($Media, "$maxWidth-$maxHeight-$fillColor-$cropped", $thumbPath);
+            return $this->handler->respondWithThumbnail($Media, "$maxWidth-$maxHeight-$fillColor-".(int)$cropped, $thumbPath);
         } catch (Exception $e) {
             return $this->handler->throwNotFoundError();
         }