initial commit

Author: anlutro

.gitignore

@@ -0,0 +1,3 @@
+/vendor
+composer.phar
+composer.lock

.travis.yml

@@ -0,0 +1,12 @@
+language: php
+
+php: 
+  - 5.6
+  - 5.4
+  - 5.5
+
+before_script:
+  - curl -s http://getcomposer.org/installer | php
+  - php composer.phar install --dev
+
+script: phpunit

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing
+
+If you want to add a new feature, make an issue rather than a pull request.
+
+Code style is pretty much PSR-2, but with tabs instead of 4 spaces. Use common sense.
+
+Make separate pull requests for separate changes/issues.
+
+Please don't be offended if I don't merge a pull request :)

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Andreas Lutro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,35 @@
+# Menu Builder
+
+Simple dynamic menu building system.
+
+PHP framework agnostic. Uses Twitter Bootstrap 3 class names and is not very configurable in that regard (yet?).
+
+## Installation
+
+`composer require anlutro/menu` - pick the latest tag visible in the github tag list or on packagist.
+
+#### Laravel 4
+
+Add `anlutro\Menu\ServiceProvider` to the list of providers in app/config/app.php. Optionally, add an alias for `'Menu' => 'anlutro\Menu\Facade'` as well. The menu builder instance can be accessed via the facade or via automatic dependency injection by type hinting.
+
+## Usage
+
+Documentation is under construction.
+
+```php
+$builder = new anlutro\Menu\Builder;
+$builder->createMenu('left');
+$builder->getMenu('left')->addItem('Foo Bar', URL::to('foo-bar'));
+$builder->getMenu('left')->addItem('Bar Baz', URL::to('bar-baz'));
+$builder->getMenu('left')->addSubmenu('Sub Menu');
+$builder->getMenu('left')->getItem('sub-menu')->addItem('Baz Foo', URL::to('baz-foo'));
+echo $builder->render('left');
+```
+
+## Contact
+
+Open an issue on GitHub if you have any problems or suggestions.
+
+## License
+
+The contents of this repository is released under the [MIT license](http://opensource.org/licenses/MIT).

composer.json

@@ -0,0 +1,25 @@
+{
+	"name": "anlutro/menu",
+	"description": "Dynamic menu builder.",
+	"license": "MIT",
+	"authors": [
+		{
+			"name": "Andreas Lutro",
+			"email": "[email protected]"
+		}
+	],
+	"require": {
+		"php": ">=5.4.0",
+		"illuminate/support": "4.1.*",
+		"patchwork/utf8": "*"
+	},
+	"require-dev": {
+		"mockery/mockery": "dev-master"
+	},
+	"autoload": {
+		"psr-4": {
+			"anlutro\\LaravelMenu\\": "src/"
+		}
+	},
+	"minimum-stability": "stable"
+}

phpunit.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+		 backupStaticAttributes="false"
+		 bootstrap="vendor/autoload.php"
+		 colors="true"
+		 convertErrorsToExceptions="true"
+		 convertNoticesToExceptions="true"
+		 convertWarningsToExceptions="true"
+		 processIsolation="false"
+		 stopOnFailure="false"
+		 syntaxCheck="false"
+>
+	<testsuites>
+		<testsuite name="Package Test Suite">
+			<directory suffix=".php">./tests/</directory>
+		</testsuite>
+	</testsuites>
+</phpunit>

src/Builder.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace anlutro\Menu;
+
+use Illuminate\Support\Str;
+
+class Builder
+{
+	protected $menus = [];
+	protected $topMenuClass = 'nav navbar-nav';
+
+	public function __construct(array $options = array())
+	{
+		if (isset($options['top-menu-class'])) {
+			$this->topMenuClass = $options['top-menu-class'];
+		}
+	}
+
+	public function createMenu($key, array $attributes = array())
+	{
+		if (isset($this->menus[$key])) {
+			throw new \InvalidArgumentException("Menu $key already exists");
+		}
+
+		$attributes['id'] = isset($attributes['id']) ? $attributes['id'] : $key;
+		$attributes['class'] = isset($attributes['class']) ? $attributes['class'] : $this->topMenuClass;
+
+		return $this->menus[$key] = $this->makeMenuCollection($attributes);
+	}
+
+	public function getMenu($key)
+	{
+		return array_key_exists($key, $this->menus) ? $this->menus[$key] : null;
+	}
+
+	public function hasMenu($key)
+	{
+		return array_key_exists($key, $this->menus);
+	}
+
+	public function render($key)
+	{
+		if ($menu = $this->getMenu($key)) return $menu->render();
+	}
+
+	protected function makeMenuCollection(array $attributes)
+	{
+		return new Collection($attributes);
+	}
+}

src/Collection.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace anlutro\Menu;
+
+use Illuminate\Support\Str;
+use Illuminate\Support\Collection as BaseCollection;
+
+class Collection// extends BaseCollection
+{
+	const DIVIDER = 'divider';
+
+	protected $items = [];
+	protected $ids;
+
+	public function __construct(array $attributes = array())
+	{
+		$this->attributes = $this->parseAttributes($attributes);
+	}
+
+	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;
+	}
+
+	public function renderAttributes()
+	{
+		$attributes = $this->attributes;
+		$attributes['class'] = implode(' ', $this->attributes['class']);
+		$strings = [];
+		foreach ($attributes as $key => $value) {
+			if (!empty($value)) $strings[] = "$key=\"$value\"";
+		}
+		return implode(' ', $strings);
+	}
+
+	public function addItemInstance(ItemInterface $item, $priority = null)
+	{
+		$priority = (int) $priority;
+		$this->items[$priority][] = $item;
+		$this->ids[$item->getId()] = $item;
+		return $item;
+	}
+
+	public function addItem($title, $url, array $attributes = array(), $priority = null)
+	{
+		return $this->addItemInstance($this->makeItem($title, $url, $attributes), $priority);
+	}
+
+	public function makeItem($title, $url, array $attributes = array())
+	{
+		return new Item($title, $url, $attributes);
+	}
+
+	public function addSubmenu($title, array $attributes = array(), $priority = null)
+	{
+		return $this->addItemInstance($this->makeSubmenu($title), $priority);
+	}
+
+	public function makeSubmenu($title)
+	{
+		return new SubmenuItem($title);
+	}
+
+	public function addDivider()
+	{
+		$this->items[] = 'divider';
+	}
+
+	public function getItem($id)
+	{
+		return array_key_exists($id, $this->ids) ? $this->ids[$id] : null;
+	}
+
+	public function render()
+	{
+		$items = '';
+		$sorted = $this->items;
+		ksort($sorted);
+		foreach (array_flatten($sorted) as $item) {
+			if ($item === static::DIVIDER) $items .= '<li class="divider"></li>';
+			else $items .= '<li>'.$item->render().'</li>';
+		}
+		return '<ul '.$this->renderAttributes().'>'.$items.'</ul>';
+	}
+}

src/Facade.php

@@ -0,0 +1,10 @@
+<?php
+namespace anlutro\Menu;
+
+class Facade extends \Illuminate\Support\Facades\Facade
+{
+	protected static function getFacadeAccessor()
+	{
+		return 'anlutro\Menu\Builder';
+	}
+}

src/Item.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace anlutro\Menu;
+
+use Illuminate\Support\Str;
+
+class Item implements ItemInterface
+{
+	protected $title;
+	protected $url;
+	protected $attributes;
+	protected $glyphicon;
+
+	public function __construct($title, $url, array $attributes = array())
+	{
+		$this->title = $title;
+		$this->url = $url;
+		$this->attributes = $this->parseAttributes($attributes);
+	}
+
+	protected function parseAttributes(array $in)
+	{
+		if (isset($in['glyphicon'])) {
+			$this->glyphicon = $in['glyphicon'];
+		}
+
+		$out = array_except($in, ['glyphicon', 'href']);
+		$out['class'] = isset($in['class']) ? explode(' ', $in['class']) : [];
+		$out['id'] = isset($in['id']) ? $in['id'] : Str::slug($this->title);
+		return $out;
+	}
+
+	public function getId()
+	{
+		return $this->attributes['id'];
+	}
+
+	public function renderLink()
+	{
+		return '<a href="' . $this->renderUrl() . '" ' .$this->renderAttributes() .
+			'>' . $this->renderTitle() . '</a>';
+	}
+
+	public function renderAttributes()
+	{
+		$attributes = $this->attributes;
+		$attributes['class'] = implode(' ', $this->attributes['class']);
+		$strings = [];
+		foreach ($attributes as $key => $value) {
+			if (!empty($value)) $strings[] = "$key=\"$value\"";
+		}
+		return implode(' ', $strings);
+	}
+
+	public function renderUrl()
+	{
+		return $this->url;
+	}
+
+	public function renderTitle()
+	{
+		$prepend = '';
+		if ($this->glyphicon) {
+			$prepend = "<span class=\"glyphicon glyphicon-{$this->glyphicon}\"></span> ";
+		}
+		return $prepend . e($this->title);
+	}
+
+	public function render()
+	{
+		return $this->renderLink();
+	}
+
+	public function __toString()
+	{
+		return $this->render();
+	}
+}

src/ItemInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace anlutro\Menu;
+
+interface ItemInterface
+{
+	public function render();
+}

src/ServiceProvider.php

@@ -0,0 +1,19 @@
+<?php
+namespace anlutro\Menu;
+
+class ServiceProvider extends \Illuminate\Support\ServiceProvider
+{
+	protected $defer = true;
+
+	public function register()
+	{
+		$this->app->bindShared('anlutro\Menu\Builder', function($app) {
+			return new Builder($app['config']['anlutro/menu::config']);
+		});
+	}
+
+	public function boot()
+	{
+		$this->app['config']->package('anlutro/menu', __DIR__.'/config', 'anlutro/menu');
+	}
+}