Breaking: Rename NavItem method getDestination to getRoute

Since the destination property in v2 is normalized to always be a route it no longer makes sense to have a divergent name for it.

Author: emmadesilva

packages/framework/resources/views/components/docs/sidebar-item.blade.php

@@ -4,7 +4,7 @@
         : 'active bg-black/5 dark:bg-black/10' => $item->isCurrent()
     ]) role="listitem">
     @if($item->isCurrent())
-        <a href="{{ $item->getDestination() }}" aria-current="true" @class([$grouped
+        <a href="{{ $item->getRoute() }}" aria-current="true" @class([$grouped
             ? '-ml-8 pl-4 py-1 px-2 block text-indigo-600 dark:text-indigo-400 dark:font-medium border-l-[0.325rem] border-indigo-500 transition-colors duration-300 ease-in-out hover:bg-black/10'
             : '-ml-4 p-2 block hover:bg-black/5 dark:hover:bg-black/10 text-indigo-600 dark:text-indigo-400 dark:font-medium border-l-[0.325rem] border-indigo-500 transition-colors duration-300 ease-in-out'
         ])>
@@ -16,7 +16,7 @@
             {!! $page->getTableOfContents() !!}
         @endif
     @else
-        <a href="{{ $item->getDestination() }}" @class([$grouped
+        <a href="{{ $item->getRoute() }}" @class([$grouped
             ? '-ml-8 pl-4 py-1 px-2 block border-l-[0.325rem] border-transparent transition-colors duration-300 ease-in-out hover:bg-black/10'
             : 'block -ml-4 p-2 border-l-[0.325rem] border-transparent hover:bg-black/5 dark:hover:bg-black/10'
         ])>

packages/framework/src/Framework/Features/Navigation/NavItem.php

@@ -116,7 +116,7 @@ public function __toString(): string
     /**
      * Get the destination route of the navigation item. For dropdowns, this will return null.
      */
-    public function getDestination(): ?Route
+    public function getRoute(): ?Route
     {
         return $this->route;
     }
@@ -144,7 +144,7 @@ public function getLabel(): string
      */
     public function getPriority(): int
     {
-        if ($this->hasChildren() && $this->children[0]->getDestination()->getPageClass() === DocumentationPage::class) {
+        if ($this->hasChildren() && $this->children[0]->getRoute()->getPageClass() === DocumentationPage::class) {
             return min($this->priority, collect($this->getChildren())->min(fn (NavItem $child): int => $child->getPriority()));
         }
 

packages/framework/tests/Unit/NavItemTest.php

@@ -44,36 +44,36 @@ public function testConstruct()
         $route = new Route(new MarkdownPage());
         $item = new NavItem($route, 'Test', 500);
 
-        $this->assertSame($route, $item->getDestination());
+        $this->assertSame($route, $item->getRoute());
     }
 
     public function testPassingRouteInstanceToConstructorUsesRouteInstance()
     {
         $route = new Route(new MarkdownPage());
-        $this->assertSame($route, (new NavItem($route, 'Home'))->getDestination());
+        $this->assertSame($route, (new NavItem($route, 'Home'))->getRoute());
     }
 
     public function testPassingRouteKeyToConstructorUsesRouteInstance()
     {
         $route = Routes::get('index');
 
-        $this->assertSame($route, (new NavItem('index', 'Home'))->getDestination());
+        $this->assertSame($route, (new NavItem('index', 'Home'))->getRoute());
     }
 
     public function testPassingUrlToConstructorUsesExternalRoute()
     {
         $item = new NavItem('https://example.com', 'Home');
-        $this->assertInstanceOf(ExternalRoute::class, $item->getDestination());
-        $this->assertEquals(new ExternalRoute('https://example.com'), $item->getDestination());
-        $this->assertSame('https://example.com', (string) $item->getDestination());
+        $this->assertInstanceOf(ExternalRoute::class, $item->getRoute());
+        $this->assertEquals(new ExternalRoute('https://example.com'), $item->getRoute());
+        $this->assertSame('https://example.com', (string) $item->getRoute());
     }
 
     public function testPassingUnknownRouteKeyToConstructorUsesExternalRoute()
     {
         $item = new NavItem('foo', 'Home');
-        $this->assertInstanceOf(ExternalRoute::class, $item->getDestination());
-        $this->assertEquals(new ExternalRoute('foo'), $item->getDestination());
-        $this->assertSame('foo', (string) $item->getDestination());
+        $this->assertInstanceOf(ExternalRoute::class, $item->getRoute());
+        $this->assertEquals(new ExternalRoute('foo'), $item->getRoute());
+        $this->assertSame('foo', (string) $item->getRoute());
     }
 
     public function testCanConstructWithChildren()
@@ -86,7 +86,7 @@ public function testCanConstructWithChildren()
         $item = new NavItem($route, 'Test', 500, null, $children);
 
         $this->assertSame('Test', $item->getLabel());
-        $this->assertNull($item->getDestination());
+        $this->assertNull($item->getRoute());
         $this->assertSame(500, $item->getPriority());
 
         $this->assertCount(2, $item->getChildren());
@@ -111,7 +111,7 @@ public function testCanConstructWithChildrenWithoutRoute()
         $item = new NavItem('', 'Test', 500, null, $children);
 
         $this->assertSame('Test', $item->getLabel());
-        $this->assertNull($item->getDestination());
+        $this->assertNull($item->getRoute());
 
         $this->assertCount(2, $item->getChildren());
         $this->assertSame($children, $item->getChildren());
@@ -122,7 +122,7 @@ public function testGetDestination()
         $route = new Route(new InMemoryPage('foo'));
         $navItem = new NavItem($route, 'Page', 500);
 
-        $this->assertSame($route, $navItem->getDestination());
+        $this->assertSame($route, $navItem->getRoute());
     }
 
     public function testGetLink()
@@ -171,7 +171,7 @@ public function testFromRoute()
         $route = new Route(new MarkdownPage());
         $item = NavItem::forRoute($route);
 
-        $this->assertSame($route, $item->getDestination());
+        $this->assertSame($route, $item->getRoute());
     }
 
     public function testToString()
@@ -185,7 +185,7 @@ public function testForLink()
     {
         $item = NavItem::forLink('foo', 'bar');
 
-        $this->assertEquals(new ExternalRoute('foo'), $item->getDestination());
+        $this->assertEquals(new ExternalRoute('foo'), $item->getRoute());
         $this->assertSame('bar', $item->getLabel());
         $this->assertSame(500, $item->getPriority());
     }
@@ -200,7 +200,7 @@ public function testForRoute()
         $route = Routes::get('404');
         $item = NavItem::forRoute($route, 'foo');
 
-        $this->assertSame($route, $item->getDestination());
+        $this->assertSame($route, $item->getRoute());
         $this->assertSame('foo', $item->getLabel());
         $this->assertSame(999, $item->getPriority());
     }
@@ -210,7 +210,7 @@ public function testForIndexRoute()
         $route = Routes::get('index');
         $item = NavItem::forRoute($route, 'foo');
 
-        $this->assertSame($route, $item->getDestination());
+        $this->assertSame($route, $item->getRoute());
         $this->assertSame('foo', $item->getLabel());
         $this->assertSame(0, $item->getPriority());
     }