feat(laravel): update json view compiler to not render disabled blocks

Author: eldomagan

packages/laravel/src/Craftile.php

@@ -13,6 +13,8 @@ class Craftile
 
     protected $regionViewResolver = null;
 
+    protected $renderBlockChecker = null;
+
     public function __construct(
         protected BlockSchemaRegistry $schemaRegistry,
         protected PropertyTransformerRegistry $transformerRegistry,
@@ -37,6 +39,14 @@ public function detectPreviewUsing(callable $detector): void
         $this->previewModeCache = null;
     }
 
+    /**
+     * Register a custom block render checker.
+     */
+    public function checkIfBlockCanRenderUsing(callable $checker): void
+    {
+        $this->renderBlockChecker = $checker;
+    }
+
     /**
      * Check if currently in preview mode.
      */
@@ -88,6 +98,18 @@ public function endBlock(string $blockId): void
         $this->previewDataCollector->endBlock($blockId);
     }
 
+    /**
+     * Check if a block should be rendered.
+     */
+    public function shouldRenderBlock(BlockData $blockData): bool
+    {
+        if ($this->renderBlockChecker) {
+            return call_user_func($this->renderBlockChecker, $blockData);
+        }
+
+        return ! $blockData->disabled;
+    }
+
     /**
      * Start tracking content region (page-specific content).
      */

packages/laravel/src/View/JsonViewCompiler.php

@@ -284,6 +284,8 @@ protected function compileBlock($blockData, $template, $path): string
         return <<<PHP
         <?php $blockDataVar = \\Craftile\\Laravel\\Facades\\BlockDatastore::getBlock("{$blockData['id']}"); ?>
 
+        <?php if (craftile()->shouldRenderBlock($blockDataVar)): ?>
+
         <?php if (craftile()->inPreview()) {
             craftile()->startBlock("{$blockData['id']}", $blockDataVar);
         } ?>
@@ -295,6 +297,8 @@ protected function compileBlock($blockData, $template, $path): string
             craftile()->endBlock("{$blockData['id']}");
         } ?>
 
+        <?php endif; ?>
+
         <?php unset($blockDataVar); ?>
         PHP;
     }

tests/laravel/Unit/CraftileTest.php

@@ -57,3 +57,71 @@
 
     expect($result)->toBe('themes.default.regions.sidebar');
 });
+
+test('shouldRenderBlock returns true for enabled blocks by default', function () {
+    $craftile = app(Craftile::class);
+    $blockData = \Craftile\Laravel\BlockData::make([
+        'id' => 'test-block',
+        'type' => 'test',
+        'disabled' => false,
+    ]);
+
+    expect($craftile->shouldRenderBlock($blockData))->toBeTrue();
+});
+
+test('shouldRenderBlock returns false for disabled blocks by default', function () {
+    $craftile = app(Craftile::class);
+    $blockData = \Craftile\Laravel\BlockData::make([
+        'id' => 'test-block',
+        'type' => 'test',
+        'disabled' => true,
+    ]);
+
+    expect($craftile->shouldRenderBlock($blockData))->toBeFalse();
+});
+
+test('shouldRenderBlock can use custom checker', function () {
+    $craftile = app(Craftile::class);
+
+    // Custom logic: only render blocks with 'public' in their ID
+    $craftile->checkIfBlockCanRenderUsing(function ($blockData) {
+        return str_contains($blockData->id, 'public');
+    });
+
+    $publicBlock = \Craftile\Laravel\BlockData::make([
+        'id' => 'public-block',
+        'type' => 'test',
+    ]);
+
+    $privateBlock = \Craftile\Laravel\BlockData::make([
+        'id' => 'private-block',
+        'type' => 'test',
+    ]);
+
+    expect($craftile->shouldRenderBlock($publicBlock))->toBeTrue();
+    expect($craftile->shouldRenderBlock($privateBlock))->toBeFalse();
+});
+
+test('custom render checker overrides default disabled logic', function () {
+    $craftile = app(Craftile::class);
+
+    // Custom logic that ignores disabled flag and only checks type
+    $craftile->checkIfBlockCanRenderUsing(function ($blockData) {
+        return $blockData->type === 'always-render';
+    });
+
+    $disabledButAllowedType = \Craftile\Laravel\BlockData::make([
+        'id' => 'test-block',
+        'type' => 'always-render',
+        'disabled' => true, // This should be ignored
+    ]);
+
+    $enabledButWrongType = \Craftile\Laravel\BlockData::make([
+        'id' => 'test-block',
+        'type' => 'never-render',
+        'disabled' => false,
+    ]);
+
+    expect($craftile->shouldRenderBlock($disabledButAllowedType))->toBeTrue();
+    expect($craftile->shouldRenderBlock($enabledButWrongType))->toBeFalse();
+});

tests/laravel/Unit/View/JsonViewCompilerTest.php

@@ -339,3 +339,34 @@
     expect($blocksToInvalidate)->toContain('grandparent'); // Grandparent
     expect($blocksToInvalidate)->toHaveCount(3);
 });
+
+test('skips rendering disabled blocks', function () {
+    $templateData = [
+        'blocks' => [
+            'enabled' => [
+                'id' => 'enabled',
+                'type' => 'test',
+                'properties' => ['content' => 'This should render'],
+            ],
+            'disabled' => [
+                'id' => 'disabled',
+                'type' => 'test',
+                'properties' => ['content' => 'This should not render'],
+                'disabled' => true,
+            ],
+        ],
+        'regions' => [
+            ['name' => 'main', 'blocks' => ['enabled', 'disabled']],
+        ],
+    ];
+
+    $compiled = $this->compiler->compileTemplate($templateData);
+
+    // Should contain check for shouldRenderBlock
+    expect($compiled)->toContain('craftile()->shouldRenderBlock');
+    expect($compiled)->toContain('endif');
+
+    // Should contain both block IDs in the compiled output
+    expect($compiled)->toContain('enabled');
+    expect($compiled)->toContain('disabled');
+});