Merge pull request #3 from permafrost-dev/add-get-line-numbers-method

Add helper methods

CHANGELOG.md

@@ -2,7 +2,13 @@
 
 All notable changes to `code-snippets` will be documented in this file.
 
-## 1.1.0 - 2021-07-25
+## 1.2.0 - 2021-07-27
+
+- add `getLineNumbers()` method
+- add `getSelectedBounds()` method
+- add `Bounds::size()` method
+
+## 1.1.0 - 2021-07-27
 
 - add `toString()` and `__toString()` methods
 

src/Bounds.php

@@ -47,4 +47,9 @@ public function copy(self $bounds): self
 
         return $this;
     }
+
+    public function size(): int
+    {
+        return count(range($this->start, $this->end));
+    }
 }

src/CodeSnippet.php

@@ -142,6 +142,16 @@ public function getLineNumberEnd(): int
         return $this->surroundingLines[count($this->surroundingLines) - 1] ?? 0;
     }
 
+    public function getLineNumbers(): array
+    {
+        return array_keys($this->getLines());
+    }
+
+    public function getSelectedBounds(): Bounds
+    {
+        return Bounds::create($this->getLineNumberStart(), $this->getLineNumberEnd());
+    }
+
     public function toString()
     {
         $result = '';

tests/CodeSnippetTest.php

@@ -171,4 +171,27 @@ public function it_returns_a_string_when_the_snippet_is_cast_to_a_string()
 
         $this->assertMatchesSnapshot((string)$snippet);
     }
+
+    /** @test */
+    public function it_returns_the_line_numbers()
+    {
+        $snippet = (new CodeSnippet())
+            ->surroundingLines(10, 12)
+            ->snippetLineCount(8)
+            ->fromFile($this->testsPath('data/file3.php'));
+
+        $this->assertCount(8, $snippet->getLineNumbers());
+        $this->assertMatchesSnapshot($snippet->getLineNumbers());
+    }
+
+    /** @test */
+    public function it_returns_the_selected_bounds()
+    {
+        $snippet = (new CodeSnippet())
+            ->surroundingLines(10, 12)
+            ->snippetLineCount(8)
+            ->fromFile($this->testsPath('data/file3.php'));
+
+        $this->assertEquals([10, 11, 12], range($snippet->getSelectedBounds()->start, $snippet->getSelectedBounds()->end));
+    }
 }

tests/__snapshots__/CodeSnippetTest__it_returns_the_line_numbers__1.yml

@@ -0,0 +1,8 @@
+- 7
+- 8
+- 9
+- 10
+- 11
+- 12
+- 13
+- 14