Refactor, update tests and snapshots

diglactic · May 23, 2021 · c798236 · c798236
1 parent e109770
commit c798236
Show file tree

Hide file tree

Showing 22 changed files with 57 additions and 217 deletions.
diff --git a/src/Breadcrumbs.php b/src/Breadcrumbs.php
@@ -13,9 +13,9 @@
  * @method static void after(callable $callback)
  * @method static bool exists(string $name = NULL)
  * @method static \Illuminate\Support\Collection generate(string $name = NULL, ...$params)
- * @method static \Illuminate\Support\HtmlString view(string $view, string $name = NULL, ...$params)
- * @method static \Illuminate\Support\HtmlString render(string $name = NULL, ...$params)
- * @method static \stdClass|null current()
+ * @method static \Illuminate\Contracts\View\View view(string $view, string $name = NULL, ...$params)
+ * @method static \Illuminate\Contracts\View\View render(string $name = NULL, ...$params)
+ * @method static object|null current()
  * @method static array getCurrentRoute()
  * @method static void setCurrentRoute(string $name, ...$params)
  * @method static void clearCurrentRoute()

diff --git a/src/Manager.php b/src/Manager.php
@@ -10,7 +10,6 @@
 use Illuminate\Contracts\View\View;
 use Illuminate\Routing\Router;
 use Illuminate\Support\Collection;
-use Illuminate\Support\HtmlString;
 use Illuminate\Support\Traits\Macroable;
 
 /**
@@ -182,14 +181,14 @@ public function view(string $view, ?string $name = null, ...$params): View
      *
      * @param string|null $name The name of the current page.
      * @param mixed ...$params The parameters to pass to the closure for the current page.
-     * @return \Illuminate\Support\HtmlString The generated HTML.
+     * @return \Illuminate\Contracts\View\View The generated view.
      * @throws \Diglactic\Breadcrumbs\Exceptions\InvalidBreadcrumbException if the name is (or any ancestor names are)
      *                                                                      not registered.
      * @throws \Diglactic\Breadcrumbs\Exceptions\UnnamedRouteException if no name is given and the current route doesn't
      *                                                                 have an associated name.
      * @throws \Diglactic\Breadcrumbs\Exceptions\ViewNotSetException if no view has been set.
      */
-    public function render(?string $name = null, ...$params): HtmlString
+    public function render(?string $name = null, ...$params): View
     {
         $view = config('breadcrumbs.view');
 

diff --git a/tests/AdvancedUsageTest.php b/tests/AdvancedUsageTest.php
@@ -286,8 +286,10 @@ public function testClearCurrentRoute()
 
     public function testBreadcrumbsSupportForArrowFunctions()
     {
-        Route::name('home')->get('/', function () { });
-        Route::name('blog.index')->get('/blog', function () { });
+        Route::name('home')->get('/', function () {
+        });
+        Route::name('blog.index')->get('/blog', function () {
+        });
 
         Breadcrumbs::for('home', function ($trail) {
             $trail->push('Some Data')

diff --git a/tests/AliasTest.php b/tests/AliasTest.php
diff --git a/tests/BasicFunctionalityTest.php b/tests/BasicFunctionalityTest.php
@@ -9,6 +9,9 @@
 
 class BasicFunctionalityTest extends TestCase
 {
+    /** @var object */
+    private $post;
+
     protected function setUp(): void
     {
         parent::setUp();

diff --git a/tests/DeferredLoadingTest.php b/tests/DeferredLoadingTest.php
@@ -8,7 +8,7 @@
 
 class DeferredLoadingTest extends TestCase
 {
-    protected function getEnvironmentSetUp($app)
+    protected function getEnvironmentSetUp($app): void
     {
         parent::getEnvironmentSetUp($app);
 
@@ -38,5 +38,6 @@ class DisabledConsoleKernel extends \Orchestra\Testbench\Console\Kernel
 {
     public function bootstrap()
     {
+        //
     }
 }
diff --git a/tests/FacadePhpDocTest.php b/tests/FacadePhpDocTest.php
@@ -44,7 +44,7 @@ public function testFullyQualifiedClassNames($class, $line)
         // IDE Helper (v2.4.3) doesn't rewrite class names to FQCNs, so make sure only
         // fully qualified class names and built-in types are used in the Manager class
         $this->assertRegExp(
-            '/^(\\\\.*|array|bool|callable|int|mixed|null|string|void)$/',
+            '/^(\\\\.*|array|object|bool|callable|int|mixed|null|string|void)$/',
             $class,
             "Must use fully qualified class names in BreadcrumbsManger PhpDoc: $line"
         );

diff --git a/tests/IgnitionTest.php b/tests/IgnitionTest.php
@@ -25,7 +25,7 @@ private function assertSolutionMatchesSnapshot(ProvidesSolution $exception)
         $this->assertMatchesSnapshot($solution->getDocumentationLinks());
     }
 
-    public function dataOneOrManyConfigFiles()
+    public function dataOneOrManyConfigFiles(): array
     {
         return [
             'Single config file' => [['routes/breadcrumbs.php']],

diff --git a/tests/MultipleFileLoadingTest.php b/tests/MultipleFileLoadingTest.php
@@ -6,7 +6,7 @@
 
 class MultipleFileLoadingTest extends TestCase
 {
-    protected function getEnvironmentSetUp($app)
+    protected function getEnvironmentSetUp($app): void
     {
         parent::getEnvironmentSetUp($app);
 

diff --git a/tests/OutputTest.php b/tests/OutputTest.php
@@ -6,6 +6,12 @@
 
 class OutputTest extends TestCase
 {
+    /** @var object */
+    private $category;
+
+    /** @var string */
+    private $expectedHtml;
+
     protected function setUp(): void
     {
         parent::setUp();

diff --git a/tests/RecursionTest.php b/tests/RecursionTest.php
@@ -6,6 +6,15 @@
 
 class RecursionTest extends TestCase
 {
+    /** @var object */
+    private $category1;
+
+    /** @var object */
+    private $category2;
+
+    /** @var object */
+    private $category3;
+
     protected function setUp(): void
     {
         parent::setUp();

diff --git a/tests/RegisterFunctionTest.php b/tests/RegisterFunctionTest.php
diff --git a/tests/SingleFileLoadingTest.php b/tests/SingleFileLoadingTest.php
@@ -6,7 +6,7 @@
 
 class SingleFileLoadingTest extends TestCase
 {
-    protected function getEnvironmentSetUp($app)
+    protected function getEnvironmentSetUp($app): void
     {
         parent::getEnvironmentSetUp($app);
 

diff --git a/tests/SkipFileLoadingTest.php b/tests/SkipFileLoadingTest.php
@@ -4,7 +4,7 @@
 
 class SkipFileLoadingTest extends TestCase
 {
-    protected function getEnvironmentSetUp($app)
+    protected function getEnvironmentSetUp($app): void
     {
         parent::getEnvironmentSetUp($app);
 

diff --git a/tests/TemplatesTest.php b/tests/TemplatesTest.php
@@ -48,24 +48,24 @@ public function viewProvider(): Generator
     /** @dataProvider viewProvider */
     public function testView($view)
     {
-        $html = Breadcrumbs::view("breadcrumbs::$view", 'category', $this->category)->toHtml();
+        $html = Breadcrumbs::view("breadcrumbs::{$view}", 'category', $this->category)->toHtml();
 
         $this->assertMatchesXmlSnapshot($html);
     }
 
     public function testCanResolveFacade()
     {
-        app(Breadcrumbs::class)->for('category', function ($trail, $category) {
+        resolve('breadcrumbs')->for('foo', function ($trail, $category) {
             $trail->parent('blog');
             $trail->push($category->title, url("blog/category/{$category->id}"));
         });
     }
 
     public function testCanReferenceDirectly()
     {
-        \Diglactic\Breadcrumbs\Breadcrumbs::for('category', function (\Diglactic\Breadcrumbs\Generator $trail, $category) {
+        \Diglactic\Breadcrumbs\Breadcrumbs::for('bar', function (\Diglactic\Breadcrumbs\Generator $trail) {
             $trail->parent('blog');
-            $trail->push($category->title, url("blog/category/{$category->id}"));
+            $trail->push('Bar', 'some/path');
         });
     }
 }
diff --git a/tests/__snapshots__/IgnitionTest__testUnnamedClosureRouteSolution__2.txt b/tests/__snapshots__/IgnitionTest__testUnnamedClosureRouteSolution__2.txt
@@ -1,6 +1,5 @@
 For example:
 
-
 ```php
 Route::get('blog', function() {
     ...

diff --git a/tests/__snapshots__/IgnitionTest__testUnnamedControllerRouteSolution__2.txt b/tests/__snapshots__/IgnitionTest__testUnnamedControllerRouteSolution__2.txt
@@ -1,6 +1,5 @@
 For example:
 
-
 ```php
 Route::get('posts/{post}', 'PostController@edit')->name('sample-name');
 ```
diff --git a/tests/__snapshots__/IgnitionTest__testUnnamedViewRouteSolution__2.txt b/tests/__snapshots__/IgnitionTest__testUnnamedViewRouteSolution__2.txt
@@ -1,6 +1,5 @@
 For example:
 
-
 ```php
 Route::view('blog', 'page')->name('sample-name');
 ```
diff --git a/tests/__snapshots__/TemplatesTest__testView with data set bootstrap2__1.xml b/tests/__snapshots__/TemplatesTest__testView with data set bootstrap2__1.xml
diff --git a/tests/__snapshots__/TemplatesTest__testView with data set bootstrap3__1.xml b/tests/__snapshots__/TemplatesTest__testView with data set bootstrap3__1.xml