Merge pull request #5 from permafrost-dev/use-code-snippets-pkg

use code-snippets package

Author: patinthehat

composer.json

@@ -13,7 +13,8 @@
     ],
     "require": {
         "php": "^7.3|^8.0",
-        "nikic/php-parser": "^4.10"
+        "nikic/php-parser": "^4.10",
+        "permafrost-dev/code-snippets": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

src/Code/CodeSnippet.php

@@ -2,10 +2,10 @@
 
 namespace Permafrost\PhpCodeSearch\Results;
 
+use Permafrost\CodeSnippets\CodeSnippet;
 use Permafrost\PhpCodeSearch\Code\CodeLocation;
-use Permafrost\PhpCodeSearch\Code\CodeSnippet;
-use Permafrost\PhpCodeSearch\Results\Nodes\ResultNode;
 use Permafrost\PhpCodeSearch\Support\File;
+use Permafrost\PhpCodeSearch\Results\Nodes\ResultNode;
 
 class FileSearchResults
 {
@@ -21,7 +21,11 @@ class FileSearchResults
     /** @var bool */
     protected $withSnippets = true;
 
-    public function __construct(File $file, bool $withSnippets = true)
+    /**
+     * @param \Permafrost\PhpCodeSearch\Support\File|\Permafrost\CodeSnippets\File $file
+     * @param bool $withSnippets
+     */
+    public function __construct($file, bool $withSnippets = true)
     {
         $this->file = $file;
         $this->withSnippets = $withSnippets;
@@ -57,6 +61,6 @@ protected function makeSnippet(int $startLine, int $lineCount = 8): ?CodeSnippet
         return (new CodeSnippet())
             ->surroundingLine($startLine)
             ->snippetLineCount($lineCount)
-            ->fromFile($this->file);
+            ->fromFile($this->file->getRealPath());
     }
 }

src/Results/FileSearchResults.php

@@ -3,13 +3,13 @@
 namespace Permafrost\PhpCodeSearch\Results;
 
 use Permafrost\PhpCodeSearch\Code\CodeLocation;
-use Permafrost\PhpCodeSearch\Code\CodeSnippet;
+use Permafrost\CodeSnippets\CodeSnippet;
+use Permafrost\CodeSnippets\File;
 use Permafrost\PhpCodeSearch\Code\GenericCodeLocation;
 use Permafrost\PhpCodeSearch\Results\Nodes\FunctionCallNode;
 use Permafrost\PhpCodeSearch\Results\Nodes\ResultNode;
 use Permafrost\PhpCodeSearch\Results\Nodes\StaticMethodCallNode;
 use Permafrost\PhpCodeSearch\Results\Nodes\VariableNode;
-use Permafrost\PhpCodeSearch\Support\File;
 
 class SearchResult
 {
@@ -28,8 +28,8 @@ class SearchResult
     /**
      * @param \Permafrost\PhpCodeSearch\Results\Nodes\ResultNode $node
      * @param \Permafrost\PhpCodeSearch\Code\CodeLocation $location
-     * @param \Permafrost\PhpCodeSearch\Code\CodeSnippet|null $snippet
-     * @param \Permafrost\PhpCodeSearch\Support\File|string $file
+     * @param \Permafrost\CodeSnippets\CodeSnippet|null $snippet
+     * @param \Permafrost\CodeSnippets\File|string $file
      */
     public function __construct(ResultNode $node, CodeLocation $location, ?CodeSnippet $snippet, $file)
     {

src/Results/SearchResult.php

@@ -2,10 +2,10 @@
 
 namespace Permafrost\PhpCodeSearch;
 
+use Permafrost\CodeSnippets\File;
 use Permafrost\PhpCodeSearch\Results\FileSearchResults;
 use Permafrost\PhpCodeSearch\Results\SearchError;
 use Permafrost\PhpCodeSearch\Support\Arr;
-use Permafrost\PhpCodeSearch\Support\File;
 use Permafrost\PhpCodeSearch\Support\VirtualFile;
 use Permafrost\PhpCodeSearch\Visitors\AssignmentVisitor;
 use Permafrost\PhpCodeSearch\Visitors\FunctionCallVisitor;
@@ -138,7 +138,12 @@ public function searchCode(string $code): FileSearchResults
         return $this->search($file);
     }
 
-    protected function parseFile(File $file, FileSearchResults $results): bool
+    /**
+     * @param \Permafrost\PhpCodeSearch\Support\File|\Permafrost\CodeSnippets\File $file
+     * @param FileSearchResults $results
+     * @return bool
+     */
+    protected function parseFile($file, FileSearchResults $results): bool
     {
         try {
             /** @var array|Stmt[] $ast */

src/Searcher.php

@@ -2,11 +2,11 @@
 
 namespace Permafrost\PhpCodeSearch\Tests\Results;
 
-use Permafrost\PhpCodeSearch\Code\CodeSnippet;
+use Permafrost\CodeSnippets\CodeSnippet;
+use Permafrost\CodeSnippets\File;
 use Permafrost\PhpCodeSearch\Code\GenericCodeLocation;
 use Permafrost\PhpCodeSearch\Results\Nodes\VariableNode;
 use Permafrost\PhpCodeSearch\Results\SearchResult;
-use Permafrost\PhpCodeSearch\Support\File;
 use PHPUnit\Framework\TestCase;
 use Spatie\Snapshots\MatchesSnapshots;
 
@@ -19,7 +19,7 @@ public function it_creates_the_object_with_correct_properties()
     {
         $file = new File(tests_path('data/file2.txt'));
         $location = new GenericCodeLocation(1, 1);
-        $snippet = (new CodeSnippet())->fromFile($file);
+        $snippet = (new CodeSnippet())->surroundingLine(2)->snippetLineCount(10)->fromFile($file);
         $resultNode = new VariableNode('myVar');
         $result = new SearchResult($resultNode, $location, $snippet, $file);
 

tests/Code/CodeSnippetTest.php

@@ -5,5 +5,7 @@ location:
 node:
     name: myVar
 snippet:
-    code: { 1: '1', 2: '2', 3: '3', 4: '4', 5: '5' }
-    lineNumber: 1
+    snippetLineCount: 10
+    lines: { 1: { selected: false, lineNumber: 1, value: '1', isSelected: false }, 2: { selected: true, lineNumber: 2, value: '2', isSelected: true }, 3: { selected: false, lineNumber: 3, value: '3', isSelected: false }, 4: { selected: false, lineNumber: 4, value: '4', isSelected: false }, 5: { selected: false, lineNumber: 5, value: '5', isSelected: false } }
+    lineNumberStart: 2
+    lineNumberEnd: 2