Merge pull request #20 from StyleShit/fix/includes-with-data

fix: includes with data sometimes throw exceptions
spatie · Oct 17, 2023 · 9850bfe · 9850bfe
2 parents b2a9f03 + 8789e5d
commit 9850bfe
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 6 deletions.
diff --git a/src/Commenters/BladeCommenters/IncludeCommenter.php b/src/Commenters/BladeCommenters/IncludeCommenter.php
@@ -13,11 +13,11 @@ public function pattern(): string
             $excludesRegex = '(?!'.implode('|', $excludes).')';
         }
 
-        return "/@include\([\'\"]{$excludesRegex}(.*?)['\"]\)/";
+        return "/@include\((?<q>[\'\"]){$excludesRegex}(.*?)\k<q>(,(.*))?\)/s";
     }
 
     public function replacement(): string
     {
-        return '<!-- Start include: $1 -->$0<!-- End include: $1 -->';
+        return '<!-- Start include: $2 -->$0<!-- End include: $2 -->';
     }
 }
diff --git a/src/Commenters/BladeCommenters/IncludeIfCommenter.php b/src/Commenters/BladeCommenters/IncludeIfCommenter.php
@@ -6,18 +6,18 @@ class IncludeIfCommenter implements BladeCommenter
 {
     public function pattern(): string
     {
-        $excludeRegex = '';
+        $excludesRegex = '';
         $excludes = config('blade-comments.excludes.includes', []);
 
         if (count($excludes)) {
-            $excludeRegex = '(?!'.implode('|', $excludes).')';
+            $excludesRegex = '(?!'.implode('|', $excludes).')';
         }
 
-        return "/@includeIf\([\'\"]{$excludeRegex}(.*?)['\"]\)/";
+        return "/@includeIf\((?<q>[\'\"]){$excludesRegex}(.*?)\k<q>(,(.*))?\)/s";
     }
 
     public function replacement(): string
     {
-        return '<!-- Start includeIf: $1 -->$0<!-- End includeIf: $1 -->';
+        return '<!-- Start includeIf: $2 -->$0<!-- End includeIf: $2 -->';
     }
 }
diff --git a/tests/PrecompilerTests/BladeIncludeTest.php b/tests/PrecompilerTests/BladeIncludeTest.php
@@ -8,6 +8,12 @@
     assertMatchesHtmlSnapshot($renderedView);
 });
 
+it('will add comments for includes with data', function () {
+    $renderedView = view('includes.include.page-with-data')->render();
+
+    assertMatchesHtmlSnapshot($renderedView);
+});
+
 it('should filter excluded includes', function () {
     config(['blade-comments.excludes.includes' => ['includes.exclude']]);
 
@@ -22,6 +28,12 @@
     assertMatchesHtmlSnapshot($renderedView);
 });
 
+it('will add comments for includeIf with data', function () {
+    $renderedView = view('includes.includeIf.page-with-data')->render();
+
+    assertMatchesHtmlSnapshot($renderedView);
+});
+
 it('should filter excluded includeIfs', function () {
     config(['blade-comments.excludes.includes' => ['includes.exclude']]);
     $renderedView = view('includes.includeIf.excludes')->render();

diff --git a/tests/TestSupport/views/includes/include/page-with-data.blade.php b/tests/TestSupport/views/includes/include/page-with-data.blade.php
@@ -0,0 +1,10 @@
+This is the start of the page
+
+@include('includes.include.include', [
+    'number' => 1,
+    'string' => 'string',
+    'array' => ['one', 'two', 'three'],
+    'function_call' => __('test'),
+])
+
+This is the end of the page
diff --git a/tests/TestSupport/views/includes/includeIf/page-with-data.blade.php b/tests/TestSupport/views/includes/includeIf/page-with-data.blade.php
@@ -0,0 +1,10 @@
+This is the start of the page
+
+@includeIf('includes.includeIf.includeIf', [
+    'number' => 1,
+    'string' => 'string',
+    'array' => ['one', 'two', 'three'],
+    'function_call' => __('test'),
+])
+
+This is the end of the page
diff --git a/tests/__snapshots__/BladeIncludeTest__it_will_add_comments_for_includeIf_with_data__1.html b/tests/__snapshots__/BladeIncludeTest__it_will_add_comments_for_includeIf_with_data__1.html
@@ -0,0 +1,7 @@
+<html><body><p>This is the start of the page
+
+<!-- Start includeIf: includes.includeIf.includeIf -->This is the includeIf
+<!-- End includeIf: includes.includeIf.includeIf -->
+
+This is the end of the page
+</p></body></html>
diff --git a/tests/__snapshots__/BladeIncludeTest__it_will_add_comments_for_includes_with_data__1.html b/tests/__snapshots__/BladeIncludeTest__it_will_add_comments_for_includes_with_data__1.html
@@ -0,0 +1,7 @@
+<html><body><p>This is the start of the page
+
+<!-- Start include: includes.include.include -->This is the include
+<!-- End include: includes.include.include -->
+
+This is the end of the page
+</p></body></html>