Merge pull request #14931 from owncloud/issue/14881-closures-for-navigation-entries

Issue/14881 closures for navigation entries

3 files changed, 182 insertions, 4 deletions

diff --git a/lib/private/navigationmanager.php b/lib/private/navigationmanager.php
index 8ad2f4c8f63..205ecccd506 100644
--- a/lib/private/navigationmanager.php
+++ b/lib/private/navigationmanager.php
@@ -14,13 +14,23 @@ namespace OC;
  */
 class NavigationManager implements \OCP\INavigationManager {
 	protected $entries = array();
+	protected $closureEntries = array();
 	protected $activeEntry;
 
 	/**
 	 * Creates a new navigation entry
-	 * @param array $entry containing: id, name, order, icon and href key
+	 *
+	 * @param array|\Closure $entry Array containing: id, name, order, icon and href key
+	 *					The use of a closure is preferred, because it will avoid
+	 * 					loading the routing of your app, unless required.
+	 * @return void
 	 */
-	public function add(array $entry) {
+	public function add($entry) {
+		if ($entry instanceof \Closure) {
+			$this->closureEntries[] = $entry;
+			return;
+		}
+
 		$entry['active'] = false;
 		if(!isset($entry['icon'])) {
 			$entry['icon'] = '';
@@ -33,6 +43,10 @@ class NavigationManager implements \OCP\INavigationManager {
 	 * @return array an array of the added entries
 	 */
 	public function getAll() {
+		foreach ($this->closureEntries as $c) {
+			$this->add($c());
+		}
+		$this->closureEntries = array();
 		return $this->entries;
 	}
 
@@ -41,6 +55,7 @@ class NavigationManager implements \OCP\INavigationManager {
 	 */
 	public function clear() {
 		$this->entries = array();
+		$this->closureEntries = array();
 	}
 
 	/**
diff --git a/lib/public/inavigationmanager.php b/lib/public/inavigationmanager.php
index 9497d3fd08e..9e0e6826454 100644
--- a/lib/public/inavigationmanager.php
+++ b/lib/public/inavigationmanager.php
@@ -36,10 +36,13 @@ namespace OCP;
 interface INavigationManager {
 	/**
 	 * Creates a new navigation entry
-	 * @param array $entry containing: id, name, order, icon and href key
+	 *
+	 * @param array|\Closure $entry Array containing: id, name, order, icon and href key
+	 *					The use of a closure is preferred, because it will avoid
+	 * 					loading the routing of your app, unless required.
 	 * @return void
 	 */
-	public function add(array $entry);
+	public function add($entry);
 
 	/**
 	 * Sets the current navigation entry of the currently running app
diff --git a/tests/lib/navigationmanagertest.php b/tests/lib/navigationmanagertest.php
new file mode 100644
index 00000000000..96708786e39
--- /dev/null
+++ b/tests/lib/navigationmanagertest.php
@@ -0,0 +1,160 @@
+<?php
+/**
+ * ownCloud
+ *
+ * @author Joas Schilling
+ * @copyright 2015 Joas Schilling nickvergessen@owncloud.com
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace Test;
+
+use OC\NavigationManager;
+
+class NavigationManagerTest extends TestCase {
+	/** @var \OC\NavigationManager */
+	protected $navigationManager;
+
+	protected function setUp() {
+		parent::setUp();
+
+		$this->navigationManager = new NavigationManager();
+	}
+
+	public function addArrayData() {
+		return [
+			[
+				[
+					'id'	=> 'entry id',
+					'name'	=> 'link text',
+					'order'	=> 1,
+					'icon'	=> 'optional',
+					'href'	=> 'url',
+				],
+				[
+					'id'		=> 'entry id',
+					'name'		=> 'link text',
+					'order'		=> 1,
+					'icon'		=> 'optional',
+					'href'		=> 'url',
+					'active'	=> false,
+				],
+			],
+			[
+				[
+					'id'	=> 'entry id',
+					'name'	=> 'link text',
+					'order'	=> 1,
+					//'icon'	=> 'optional',
+					'href'	=> 'url',
+					'active'	=> true,
+				],
+				[
+					'id'		=> 'entry id',
+					'name'		=> 'link text',
+					'order'		=> 1,
+					'icon'		=> '',
+					'href'		=> 'url',
+					'active'	=> false,
+				],
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider addArrayData
+	 *
+	 * @param array $entry
+	 * @param array $expectedEntry
+	 */
+	public function testAddArray(array $entry, array $expectedEntry) {
+		$this->assertEmpty($this->navigationManager->getAll(), 'Expected no navigation entry exists');
+		$this->navigationManager->add($entry);
+
+		$navigationEntries = $this->navigationManager->getAll();
+		$this->assertEquals(1, sizeof($navigationEntries), 'Expected that 1 navigation entry exists');
+		$this->assertEquals($expectedEntry, $navigationEntries[0]);
+
+		$this->navigationManager->clear();
+		$this->assertEmpty($this->navigationManager->getAll(), 'Expected no navigation entry exists after clear()');
+	}
+
+	/**
+	 * @dataProvider addArrayData
+	 *
+	 * @param array $entry
+	 * @param array $expectedEntry
+	 */
+	public function testAddClosure(array $entry, array $expectedEntry) {
+		global $testAddClosureNumberOfCalls;
+		$testAddClosureNumberOfCalls = 0;
+
+		$this->navigationManager->add(function () use ($entry) {
+			global $testAddClosureNumberOfCalls;
+			$testAddClosureNumberOfCalls++;
+
+			return $entry;
+		});
+
+		$this->assertEquals(0, $testAddClosureNumberOfCalls, 'Expected that the closure is not called by add()');
+
+		$navigationEntries = $this->navigationManager->getAll();
+		$this->assertEquals(1, $testAddClosureNumberOfCalls, 'Expected that the closure is called by getAll()');
+		$this->assertEquals(1, sizeof($navigationEntries), 'Expected that 1 navigation entry exists');
+		$this->assertEquals($expectedEntry, $navigationEntries[0]);
+
+		$navigationEntries = $this->navigationManager->getAll();
+		$this->assertEquals(1, $testAddClosureNumberOfCalls, 'Expected that the closure is only called once for getAll()');
+		$this->assertEquals(1, sizeof($navigationEntries), 'Expected that 1 navigation entry exists');
+		$this->assertEquals($expectedEntry, $navigationEntries[0]);
+
+		$this->navigationManager->clear();
+		$this->assertEmpty($this->navigationManager->getAll(), 'Expected no navigation entry exists after clear()');
+	}
+
+	public function testAddArrayClearGetAll() {
+		$entry = [
+			'id'	=> 'entry id',
+			'name'	=> 'link text',
+			'order'	=> 1,
+			'icon'	=> 'optional',
+			'href'	=> 'url',
+		];
+
+		$this->assertEmpty($this->navigationManager->getAll(), 'Expected no navigation entry exists');
+		$this->navigationManager->add($entry);
+		$this->navigationManager->clear();
+		$this->assertEmpty($this->navigationManager->getAll(), 'Expected no navigation entry exists after clear()');
+	}
+
+	public function testAddClosureClearGetAll() {
+		$this->assertEmpty($this->navigationManager->getAll(), 'Expected no navigation entry exists');
+
+		$entry = [
+			'id'	=> 'entry id',
+			'name'	=> 'link text',
+			'order'	=> 1,
+			'icon'	=> 'optional',
+			'href'	=> 'url',
+		];
+
+		global $testAddClosureNumberOfCalls;
+		$testAddClosureNumberOfCalls = 0;
+
+		$this->navigationManager->add(function () use ($entry) {
+			global $testAddClosureNumberOfCalls;
+			$testAddClosureNumberOfCalls++;
+
+			return $entry;
+		});
+
+		$this->assertEquals(0, $testAddClosureNumberOfCalls, 'Expected that the closure is not called by add()');
+		$this->navigationManager->clear();
+		$this->assertEquals(0, $testAddClosureNumberOfCalls, 'Expected that the closure is not called by clear()');
+		$this->assertEmpty($this->navigationManager->getAll(), 'Expected no navigation entry exists after clear()');
+		$this->assertEquals(0, $testAddClosureNumberOfCalls, 'Expected that the closure is not called by getAll()');
+	}
+}