make html ids less likely to conflict

anlutro · anlutro · commit 1b0aca36598e · 2014-06-25T16:59:22.000+02:00
diff --git a/src/AbstractItem.php b/src/AbstractItem.php
@@ -90,7 +90,7 @@ protected function parseAttributes(array $in)
 
 		$out = array_except($in, static::$notHtmlAttributes);
 		$out['class'] = isset($in['class']) ? explode(' ', $in['class']) : [];
-		$out['id'] = isset($in['id']) ? $in['id'] : 'menu-item-' . Str::slug($this->title);
+		$out['id'] = isset($in['id']) ? $in['id'] : Str::slug($this->title);
 		return $out;
 	}
 
@@ -134,6 +134,9 @@ abstract public function renderUrl();
 	public function renderAttributes()
 	{
 		$attributes = $this->attributes;
+		if (isset($attributes['id']) && !Str::startsWith('menu-item--', $attributes['id'])) {
+			$attributes['id'] = 'menu-item--'.$attributes['id'];
+		}
 		$attributes['class'] = implode(' ', $this->attributes['class']);
 		$strings = [];
 		foreach ($attributes as $key => $value) {
diff --git a/src/Collection.php b/src/Collection.php
@@ -94,9 +94,6 @@ public function __construct(array $attributes = array(), array $options = array(
 	protected function parseAttributes(array $in)
 	{
 		$out = $in;
-		if (isset($in['id']) && !Str::startsWith('menu-', $in['id'])) {
-			$out['id'] = 'menu-' . $in['id'];
-		}
 		$out['class'] = isset($in['class']) ? explode(' ', $in['class']) : [];
 		return $out;
 	}
@@ -109,6 +106,9 @@ protected function parseAttributes(array $in)
 	public function renderAttributes()
 	{
 		$attributes = $this->attributes;
+		if (isset($attributes['id']) && !Str::startsWith('menu--', $attributes['id'])) {
+			$attributes['id'] = 'menu--'.$attributes['id'];
+		}
 		$attributes['class'] = implode(' ', $this->attributes['class']);
 		$strings = [];
 		foreach ($attributes as $key => $value) {
diff --git a/tests/MenuBuilderTest.php b/tests/MenuBuilderTest.php
@@ -38,13 +38,13 @@ public function testRenderSimpleMenu()
 		$builder->getMenu('left')->getItem('test-submenu')->addItem('Test Item 3', '/url-3');
 		$builder->getMenu('left')->getItem('test-submenu')->addItem('Test Item 4', '/url-4');
 		$str = $builder->render('left');
-		$expected = str_replace(["\n","\t"], '', '<ul id="menu-left" class="nav navbar-nav">
-		<li><a href="/url-1" class="foo-bar" id="test-item-1">Test Item 1</a></li>
-		<li><a href="/url-2" data-foo="bar" id="test-item-2">Test Item 2</a></li>
-		<li><a href="#" data-toggle="dropdown" class="dropdown-toggle" id="test-submenu">
+		$expected = str_replace(["\n","\t"], '', '<ul id="menu--left" class="nav navbar-nav">
+		<li><a href="/url-1" class="foo-bar" id="menu-item--test-item-1">Test Item 1</a></li>
+		<li><a href="/url-2" data-foo="bar" id="menu-item--test-item-2">Test Item 2</a></li>
+		<li><a href="#" data-toggle="dropdown" class="dropdown-toggle" id="menu-item--test-submenu">
 		Test Submenu <b class="caret"></b></a><ul class="dropdown-menu">
-		<li><a href="/url-3" id="test-item-3">Test Item 3</a></li>
-		<li><a href="/url-4" id="test-item-4">Test Item 4</a></li>
+		<li><a href="/url-3" id="menu-item--test-item-3">Test Item 3</a></li>
+		<li><a href="/url-4" id="menu-item--test-item-4">Test Item 4</a></li>
 		</ul></li></ul>');
 		$this->assertEquals($expected, $str);
 	}
@@ -66,13 +66,13 @@ public function setDefaultClasses()
 		$builder->getMenu('left')->getItem('test-submenu')->addItem('Test Item 3', '/url-3');
 		$builder->getMenu('left')->getItem('test-submenu')->addItem('Test Item 4', '/url-4');
 		$str = $builder->render('left');
-		$expected = str_replace(["\n","\t"], '', '<ul id="menu-left" class="custom-top-class">
-		<li><a href="/url-1" class="foo-bar" id="test-item-1">Test Item 1</a></li>
-		<li><a href="/url-2" data-foo="bar" id="test-item-2">Test Item 2</a></li>
-		<li><a href="#" data-toggle="custom-data" class="custom-sub-toggle-class" id="test-submenu">
+		$expected = str_replace(["\n","\t"], '', '<ul id="menu--left" class="custom-top-class">
+		<li><a href="/url-1" class="foo-bar" id="menu-item--test-item-1">Test Item 1</a></li>
+		<li><a href="/url-2" data-foo="bar" id="menu-item--test-item-2">Test Item 2</a></li>
+		<li><a href="#" data-toggle="custom-data" class="custom-sub-toggle-class" id="menu-item--test-submenu">
 		Test Submenu <custom-tag /></a><ul class="custom-sub-class">
-		<li><a href="/url-3" id="test-item-3">Test Item 3</a></li>
-		<li><a href="/url-4" id="test-item-4">Test Item 4</a></li>
+		<li><a href="/url-3" id="menu-item--test-item-3">Test Item 3</a></li>
+		<li><a href="/url-4" id="menu-item--test-item-4">Test Item 4</a></li>
 		</ul></li></ul>');
 		$this->assertEquals($expected, $str);
 	}
diff --git a/tests/MenuCollectionTest.php b/tests/MenuCollectionTest.php
@@ -50,8 +50,8 @@ public function testSimpleRender()
 		$this->assertContains('Second Item', $str);
 		$this->assertContains('<a href="/foo-bar', $str);
 		$this->assertContains('<a href="/bar-baz', $str);
-		$this->assertContains('id="test-item"', $str);
-		$this->assertContains('id="second-item"', $str);
+		$this->assertContains('id="menu-item--test-item"', $str);
+		$this->assertContains('id="menu-item--second-item"', $str);
 	}
 
 	public function testAddWithPriorities()
diff --git a/tests/MenuItemTest.php b/tests/MenuItemTest.php
@@ -17,37 +17,37 @@ public function testRenderTitleAndUrl()
 	public function testRenderAttributes()
 	{
 		$item = $this->makeItem('', '', ['id' => 'foobar', 'data-foo' => 'baz']);
-		$this->assertEquals('id="foobar" data-foo="baz"', $item->renderAttributes());
+		$this->assertEquals('id="menu-item--foobar" data-foo="baz"', $item->renderAttributes());
 	}
 
 	public function testDefaultIdIsSetFromTitle()
 	{
 		$item = $this->makeItem('foo bar baz', '');
-		$this->assertEquals('id="foo-bar-baz"', $item->renderAttributes());
+		$this->assertEquals('id="menu-item--foo-bar-baz"', $item->renderAttributes());
 	}
 
 	public function testRenderGlyphicon()
 	{
 		$item = $this->makeItem('foo', 'bar', ['glyphicon' => 'baz']);
-		$this->assertEquals('<a href="bar" id="foo"><span class="glyphicon glyphicon-baz"></span> foo</a>', $item->render());
+		$this->assertEquals('<a href="bar" id="menu-item--foo"><span class="glyphicon glyphicon-baz"></span> foo</a>', $item->render());
 	}
 
 	public function testRenderFAIcon()
 	{
 		$item = $this->makeItem('foo', 'bar', ['fa-icon' => 'baz']);
-		$this->assertEquals('<a href="bar" id="foo"><i class="fa fa-baz"></i> foo</a>', $item->render());
+		$this->assertEquals('<a href="bar" id="menu-item--foo"><i class="fa fa-baz"></i> foo</a>', $item->render());
 
 		$item = $this->makeItem('foo', 'bar', ['fa-icon' => 'baz 4x']);
-		$this->assertEquals('<a href="bar" id="foo"><i class="fa fa-baz fa-4x"></i> foo</a>', $item->render());
+		$this->assertEquals('<a href="bar" id="menu-item--foo"><i class="fa fa-baz fa-4x"></i> foo</a>', $item->render());
 	}
 
 	public function testCustomIconResolver()
 	{
 		\anlutro\Menu\Item::addIconResolvers(['custom' => 'CustomIcon']);
 		$item = $this->makeItem('foo', 'bar', ['custom' => 'baz']);
-		$this->assertEquals('<a href="bar" id="foo">custom-icon foo</a>', $item->render());
+		$this->assertEquals('<a href="bar" id="menu-item--foo">custom-icon foo</a>', $item->render());
 		$item = $this->makeItem('foo', 'bar', ['custom' => 'baz', 'glyphicon' => 'baz']);
-		$this->assertEquals('<a href="bar" id="foo">custom-icon foo</a>', $item->render());
+		$this->assertEquals('<a href="bar" id="menu-item--foo">custom-icon foo</a>', $item->render());
 	}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -94,9 +94,6 @@ public function __construct(array $attributes = array(), array $options = array(`
`94`	`94`	`protected function parseAttributes(array $in)`
`95`	`95`	`{`
`96`	`96`	`$out = $in;`
`97`		`- if (isset($in['id']) && !Str::startsWith('menu-', $in['id'])) {`
`98`		`- $out['id'] = 'menu-' . $in['id'];`
`99`		`- }`
`100`	`97`	`$out['class'] = isset($in['class']) ? explode(' ', $in['class']) : [];`
`101`	`98`	`return $out;`
`102`	`99`	`}`
`@@ -109,6 +106,9 @@ protected function parseAttributes(array $in)`
`109`	`106`	`public function renderAttributes()`
`110`	`107`	`{`
`111`	`108`	`$attributes = $this->attributes;`
	`109`	`+ if (isset($attributes['id']) && !Str::startsWith('menu--', $attributes['id'])) {`
	`110`	`+ $attributes['id'] = 'menu--'.$attributes['id'];`
	`111`	`+ }`
`112`	`112`	`$attributes['class'] = implode(' ', $this->attributes['class']);`
`113`	`113`	`$strings = [];`
`114`	`114`	`foreach ($attributes as $key => $value) {`
Original file line number	Diff line number	Diff line change
`@@ -17,37 +17,37 @@ public function testRenderTitleAndUrl()`
`17`	`17`	`public function testRenderAttributes()`
`18`	`18`	`{`
`19`	`19`	`$item = $this->makeItem('', '', ['id' => 'foobar', 'data-foo' => 'baz']);`
`20`		`- $this->assertEquals('id="foobar" data-foo="baz"', $item->renderAttributes());`
	`20`	`+ $this->assertEquals('id="menu-item--foobar" data-foo="baz"', $item->renderAttributes());`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`public function testDefaultIdIsSetFromTitle()`
`24`	`24`	`{`
`25`	`25`	`$item = $this->makeItem('foo bar baz', '');`
`26`		`- $this->assertEquals('id="foo-bar-baz"', $item->renderAttributes());`
	`26`	`+ $this->assertEquals('id="menu-item--foo-bar-baz"', $item->renderAttributes());`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`public function testRenderGlyphicon()`
`30`	`30`	`{`
`31`	`31`	`$item = $this->makeItem('foo', 'bar', ['glyphicon' => 'baz']);`
`32`		`- $this->assertEquals('<a href="bar" id="foo"><span class="glyphicon glyphicon-baz"></span> foo</a>', $item->render());`
	`32`	`+ $this->assertEquals('<a href="bar" id="menu-item--foo"><span class="glyphicon glyphicon-baz"></span> foo</a>', $item->render());`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`public function testRenderFAIcon()`
`36`	`36`	`{`
`37`	`37`	`$item = $this->makeItem('foo', 'bar', ['fa-icon' => 'baz']);`
`38`		`- $this->assertEquals('<a href="bar" id="foo"><i class="fa fa-baz"></i> foo</a>', $item->render());`
	`38`	`+ $this->assertEquals('<a href="bar" id="menu-item--foo"><i class="fa fa-baz"></i> foo</a>', $item->render());`
`39`	`39`
`40`	`40`	`$item = $this->makeItem('foo', 'bar', ['fa-icon' => 'baz 4x']);`
`41`		`- $this->assertEquals('<a href="bar" id="foo"><i class="fa fa-baz fa-4x"></i> foo</a>', $item->render());`
	`41`	`+ $this->assertEquals('<a href="bar" id="menu-item--foo"><i class="fa fa-baz fa-4x"></i> foo</a>', $item->render());`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`public function testCustomIconResolver()`
`45`	`45`	`{`
`46`	`46`	`\anlutro\Menu\Item::addIconResolvers(['custom' => 'CustomIcon']);`
`47`	`47`	`$item = $this->makeItem('foo', 'bar', ['custom' => 'baz']);`
`48`		`- $this->assertEquals('<a href="bar" id="foo">custom-icon foo</a>', $item->render());`
	`48`	`+ $this->assertEquals('<a href="bar" id="menu-item--foo">custom-icon foo</a>', $item->render());`
`49`	`49`	`$item = $this->makeItem('foo', 'bar', ['custom' => 'baz', 'glyphicon' => 'baz']);`
`50`		`- $this->assertEquals('<a href="bar" id="foo">custom-icon foo</a>', $item->render());`
	`50`	`+ $this->assertEquals('<a href="bar" id="menu-item--foo">custom-icon foo</a>', $item->render());`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`