Merge branch 'check-generated-code'

Author: lkrms

.github/workflows/ci.yml

@@ -12,8 +12,8 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  format:
-    name: Check formatting
+  check:
+    name: Check generated files and formatting
     runs-on: ubuntu-latest
 
     steps:
@@ -26,15 +26,22 @@ jobs:
           php-version: "8.2"
           coverage: none
 
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress
+
+      - name: Check generated files
+        run: scripts/generate.php --check
+
       - name: Install PrettyPHP
-        run: composer create-project --no-interaction --no-progress --no-dev lkrms/pretty-php=0.4.25 build/pretty-php
+        run: composer create-project --no-interaction --no-progress --no-dev lkrms/pretty-php=0.4.28 build/pretty-php
 
       - name: Run PrettyPHP
         run: build/pretty-php/bin/pretty-php --diff
 
   phpstan:
     name: PHPStan
     runs-on: ubuntu-latest
+    needs: check
 
     strategy:
       fail-fast: false
@@ -61,6 +68,7 @@ jobs:
 
   unit-tests:
     name: PHPUnit tests
+    needs: check
 
     strategy:
       fail-fast: false

.gitignore

@@ -3,7 +3,6 @@
 composer.phar
 
 .env
-*.generated.php
 *.log
 /var
 !/tests/.env

.prettyphp

@@ -2,6 +2,7 @@
     "src": [
         "bin",
         "lib",
+        "scripts",
         "src",
         "tests",
         "bootstrap.php"

composer.json

@@ -27,7 +27,8 @@
         "phpstan/extension-installer": "^1",
         "phpstan/phpstan": "^1",
         "phpstan/phpstan-deprecation-rules": "^1",
-        "phpunit/phpunit": "^9"
+        "phpunit/phpunit": "^9",
+        "sebastian/diff": "^4 || ^5"
     },
     "autoload": {
         "psr-4": {

lib/lk-util/Command/Generate/Concept/GenerateCommand.php

@@ -6,6 +6,7 @@
 use Lkrms\Cli\Exception\CliInvalidArgumentsException;
 use Lkrms\Cli\CliOption;
 use Lkrms\Cli\CliOptionBuilder;
+use Lkrms\Console\Catalog\ConsoleLevel as Level;
 use Lkrms\Facade\Composer;
 use Lkrms\Facade\Console;
 use Lkrms\Facade\File;
@@ -20,6 +21,8 @@
 use Lkrms\Support\TokenExtractor;
 use Lkrms\Utility\Convert;
 use Lkrms\Utility\Test;
+use SebastianBergmann\Diff\Output\StrictUnifiedDiffOutputBuilder;
+use SebastianBergmann\Diff\Differ;
 use ReflectionClass;
 use ReflectionException;
 use ReflectionParameter;
@@ -40,6 +43,7 @@ abstract class GenerateCommand extends Command
     protected ?string $OutputDescription;
     protected ?bool $ToStdout;
     protected ?bool $ReplaceIfExists;
+    protected ?bool $Check;
     protected ?bool $NoMetaTags;
 
     /**
@@ -141,6 +145,10 @@ protected function getOutputOptionList(string $outputType): array
                 ->short('s')
                 ->description('Write to standard output')
                 ->bindTo($this->ToStdout),
+            CliOption::build()
+                ->long('check')
+                ->description('Fail if the output file should be replaced')
+                ->bindTo($this->Check),
             CliOption::build()
                 ->long('force')
                 ->short('f')
@@ -556,25 +564,46 @@ protected function handleOutput($lines): void
             $verb = null;
         } else {
             $file = sprintf('%s.php', $this->OutputClass);
+            $dir = Composer::getNamespacePath($this->OutputNamespace);
 
-            if ($dir = Composer::getNamespacePath($this->OutputNamespace)) {
-                File::maybeCreateDirectory($dir);
+            if ($dir !== null) {
+                if (!$this->Check) {
+                    File::maybeCreateDirectory($dir);
+                }
                 $file = $dir . '/' . $file;
             }
 
             if (file_exists($file)) {
-                if (rtrim(file_get_contents($file)) == rtrim($output)) {
-                    Console::log('Unchanged:', $file);
-
+                $input = file_get_contents($file);
+                if ($input === $output) {
+                    Console::log('Nothing to do:', $file);
                     return;
                 }
-                if (!$this->ReplaceIfExists) {
-                    Console::warn('File already exists:', $file);
-                    $file = substr($file, 0, -4) . '.generated.php';
+                if ($this->Check) {
+                    Console::info('Would replace', $file);
+                    Console::count(Level::ERROR);
+                    $this->setExitStatus(1);
+                    return;
                 }
-                if (file_exists($file)) {
-                    $verb = 'Replacing';
+                if (!$this->ReplaceIfExists) {
+                    $basePath = Composer::getRootPackagePath();
+                    $relative = File::realpath($file);
+                    if (strpos($relative, $basePath) === 0) {
+                        $relative = substr($relative, strlen($basePath) + 1);
+                    }
+                    print (new Differ(new StrictUnifiedDiffOutputBuilder([
+                        'fromFile' => "a/$relative",
+                        'toFile' => "b/$relative",
+                    ])))->diff($input, $output);
+                    Console::info('Out of date:', $file);
+                    return;
                 }
+                $verb = 'Replacing';
+            } elseif ($this->Check) {
+                Console::info('Would create', $file);
+                $this->setExitStatus(1);
+                Console::count(Level::ERROR);
+                return;
             }
         }
 

scripts/generate.php

@@ -6,8 +6,9 @@
 use Lkrms\Console\ConsoleWriter;
 use Lkrms\Container\Application;
 use Lkrms\Container\Container;
-use Lkrms\Curler\Curler;
 use Lkrms\Curler\Support\CurlerPage;
+use Lkrms\Curler\Curler;
+use Lkrms\Facade\Console;
 use Lkrms\LkUtil\Catalog\EnvVar;
 use Lkrms\LkUtil\Command\Generate\GenerateBuilder;
 use Lkrms\LkUtil\Command\Generate\GenerateFacade;
@@ -73,10 +74,22 @@
     $app->env()->unset($constant->getValue());
 }
 
+$args = [
+    '--force',
+    '--no-meta',
+    ...array_slice($argv, 1),
+];
+
+$status = 0;
+
 foreach ($facades as $class => $facade) {
-    $generateFacade('-f', '-m', $class, $facade);
+    $status |= $generateFacade(...[...$args, $class, $facade]);
 }
 
 foreach ($builders as $class => $builder) {
-    $generateBuilder('-f', '-m', $class, $builder);
+    $status |= $generateBuilder(...[...$args, $class, $builder]);
 }
+
+Console::summary('Code generation completed');
+
+exit ($status);

src/Facade/Sync.php

@@ -5,6 +5,7 @@
 use Lkrms\Concept\Facade;
 use Lkrms\Store\Concept\SqliteStore;
 use Lkrms\Sync\Contract\ISyncClassResolver;
+use Lkrms\Sync\Contract\ISyncContext;
 use Lkrms\Sync\Contract\ISyncEntity;
 use Lkrms\Sync\Contract\ISyncProvider;
 use Lkrms\Sync\Support\DeferredSyncEntity;
@@ -26,7 +27,7 @@
  * @method static SyncStore entity(int $providerId, class-string<ISyncEntity> $entityType, int|string $entityId, ISyncEntity $entity) Register a sync entity (see {@see SyncStore::entity()})
  * @method static SyncStore entityType(class-string<ISyncEntity> $entity) Register a sync entity type and set its ID (unless already registered) (see {@see SyncStore::entityType()})
  * @method static SyncStore error(SyncError|ErrorBuilder $error, bool $deduplicate = false, bool $toConsole = false) Report an error that occurred during a sync operation
- * @method static ISyncEntity|null getEntity(int $providerId, class-string<ISyncEntity> $entityType, int|string $entityId) Get a previously registered sync entity
+ * @method static ISyncEntity|DeferredSyncEntity|null getEntity(int $providerId, class-string<ISyncEntity> $entityType, int|string $entityId, ?ISyncContext $context = null) Get a previously registered sync entity
  * @method static string|null getEntityTypeNamespace(class-string<ISyncEntity> $entity) Get the namespace of a sync entity type (see {@see SyncStore::getEntityTypeNamespace()})
  * @method static string|null getEntityTypeUri(class-string<ISyncEntity> $entity, bool $compact = true) Get the canonical URI of a sync entity type (see {@see SyncStore::getEntityTypeUri()})
  * @method static SyncErrorCollection getErrors() Get sync operation errors recorded so far
@@ -38,6 +39,7 @@
  * @method static bool isOpen() Check if a database is open
  * @method static SyncStore namespace(string $prefix, string $uri, string $namespace, class-string<ISyncClassResolver>|null $resolver = null) Register a sync entity namespace (see {@see SyncStore::namespace()})
  * @method static SyncStore provider(ISyncProvider $provider) Register a sync provider and set its provider ID (see {@see SyncStore::provider()})
+ * @method static SyncStore reserveEntity(int $providerId, class-string<ISyncEntity> $entityType, int|string $entityId) Pre-register a sync entity (see {@see SyncStore::reserveEntity()})
  *
  * @uses SyncStore
  *