First commit

.editorconfig

@@ -0,0 +1,15 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+indent_size = 2

.gitattributes

@@ -0,0 +1,12 @@
+* text=auto
+
+/.github          export-ignore
+/_docs            export-ignore
+/tests            export-ignore
+.editorconfig     export-ignore
+.gitattributes    export-ignore
+.gitignore        export-ignore
+.scrutinizer.yml  export-ignore
+.travis.yml       export-ignore
+phpunit.xml       export-ignore
+CONTRIBUTING.md   export-ignore

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,7 @@
+- Sidebar Version: #.#.#
+- Laravel Version: #.#.#
+- PHP Version: #.#.#
+
+### Description:
+
+### Steps To Reproduce:

.gitignore

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

.scrutinizer.yml

@@ -0,0 +1,35 @@
+filter:
+    excluded_paths: [tests/*, vendor/*]
+
+checks:
+    php:
+        code_rating: true
+        duplication: true
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true
+
+tools:
+    external_code_coverage:
+        timeout: 600
+        runs: 3
+    php_code_sniffer:
+        enabled: true
+        config:
+            standard: PSR2
+        filter:
+            paths: ['src']
+    php_loc:
+        enabled: true
+    php_cpd:
+        enabled: true

.travis.yml

@@ -0,0 +1,29 @@
+language: php
+
+sudo: false
+
+php:
+  - 5.6
+  - 7.0
+  - 7.1
+  - nightly
+
+matrix:
+  allow_failures:
+    - php: nightly
+
+env:
+  - TESTBENCH_VERSION=3.4.*
+
+before_script:
+  - travis_retry composer self-update
+  - travis_retry composer require --prefer-source --no-interaction --dev "orchestra/testbench:${TESTBENCH_VERSION}"
+
+script:
+  - composer validate
+  - mkdir -p build/logs
+  - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
+
+after_script:
+  - if [ "$TRAVIS_PHP_VERSION" != "nightly" ]; then wget https://scrutinizer-ci.com/ocular.phar; fi
+  - if [ "$TRAVIS_PHP_VERSION" != "nightly" ]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# CONTRIBUTING
+
+Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.
+
+## Guidelines
+
+  * Please follow the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) Coding Standard, PHP-FIG Naming Conventions and the [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) autoloading standard
+  * Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
+  * Remember that we follow SemVer. If you are changing the behaviour, or the public api, you may need to update the docs.
+  * Send a coherent commit history, making sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
+  * You may also need to rebase to avoid merge conflicts.
+
+## Running Tests
+
+You will need an install of [Composer](https://getcomposer.org) before continuing.
+
+First, install the dependencies:
+
+```bash
+$ composer install
+```
+
+Then run phpunit:
+
+```bash
+$ vendor/bin/phpunit --coverage-text
+```
+
+If the test suite passes on your local machine you should be good to go.
+
+When you make a pull request, the tests will automatically be run again by [Travis CI](https://travis-ci.org/).

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 | ARCANEDEV <arcanedev.maroc@gmail.com> - Sidebar
+
+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

@@ -1,2 +1,35 @@
-# Sidebar
-Sidebar generator for ARCANESOFT's admin dashboard
+# Sidebar [![Packagist License][badge_license]](LICENSE.md) [![For ARCANESOFT CMS][badge_arcanesoft]][link-arcanesoft-repo]
+
+[![Travis Status][badge_build]][link-travis]
+[![Coverage Status][badge_coverage]][link-scrutinizer]
+[![Scrutinizer Code Quality][badge_quality]][link-scrutinizer]
+[![SensioLabs Insight][badge_insight]][link-insight]
+[![Github Issues][badge_issues]][link-github-issues]
+
+[![Packagist][badge_package]][link-packagist]
+[![Packagist Release][badge_release]][link-packagist]
+[![Packagist Downloads][badge_downloads]][link-packagist]
+
+*By [ARCANEDEV©](http://www.arcanedev.net/)*
+
+Sidebar generator for ARCANESOFT's admin dashboard.
+
+[badge_license]:     https://img.shields.io/packagist/l/arcanedev/sidebar.svg?style=flat-square
+[badge_arcanesoft]:  https://img.shields.io/badge/For-ARCANESOFT%20CMS-orange.svg?style=flat-square
+[badge_build]:       https://img.shields.io/travis/ARCANEDEV/Sidebar.svg?style=flat-square
+[badge_coverage]:    https://img.shields.io/scrutinizer/coverage/g/ARCANEDEV/Sidebar.svg?style=flat-square
+[badge_quality]:     https://img.shields.io/scrutinizer/g/ARCANEDEV/Sidebar.svg?style=flat-square
+[badge_insight]:     https://img.shields.io/sensiolabs/i/[id].svg?style=flat-square
+[badge_issues]:      https://img.shields.io/github/issues/ARCANEDEV/Sidebar.svg?style=flat-square
+[badge_package]:     https://img.shields.io/badge/package-arcanedev/sidebar-blue.svg?style=flat-square
+[badge_release]:     https://img.shields.io/packagist/v/arcanedev/sidebar.svg?style=flat-square
+[badge_downloads]:   https://img.shields.io/packagist/dt/arcanedev/sidebar.svg?style=flat-square
+
+[link-author]:          https://github.com/arcanedev-maroc
+[link-arcanesoft-repo]: https://github.com/ARCANESOFT/ARCANESOFT
+[link-github-issues]:   https://github.com/ARCANEDEV/Sidebar/issues
+[link-contributors]:    https://github.com/ARCANEDEV/Sidebar/graphs/contributors
+[link-packagist]:       https://packagist.org/packages/arcanedev/sidebar
+[link-travis]:          https://travis-ci.org/ARCANEDEV/Sidebar
+[link-scrutinizer]:     https://scrutinizer-ci.com/g/ARCANEDEV/Sidebar/?branch=master
+[link-insight]:         https://insight.sensiolabs.com/projects/[id]

composer.json

@@ -0,0 +1,44 @@
+{
+    "name":        "arcanesoft/sidebar",
+    "description": "Sidebar generator for ARCANESOFT's admin dashboard",
+    "keywords":    ["arcanedev", "arcanesoft", "laravel", "sidebar", "navigation"],
+    "homepage":    "https://github.com/ARCANESOFT/Sidebar",
+    "authors": [
+        {
+            "name":     "ARCANEDEV",
+            "email":    "arcanedev.maroc@gmail.com",
+            "homepage": "https://github.com/arcanedev-maroc",
+            "role":     "Developer"
+        }
+    ],
+    "type":    "library",
+    "license": "MIT",
+    "require": {
+        "php":                  ">=5.6.4",
+        "arcanedev/support":    "~4.0",
+        "arcanesoft/contracts": "~2.0"
+    },
+    "require-dev": {
+        "phpunit/phpcov":  "~3.0",
+        "phpunit/phpunit": "~5.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Arcanesoft\\Sidebar\\": "src/"
+        },
+        "files": ["helpers.php"]
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Arcanesoft\\Sidebar\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "testbench": "composer require --dev \"orchestra/testbench=~3.0\""
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0-dev"
+        }
+    }
+}

helpers.php

@@ -0,0 +1 @@
+<?php

phpunit.xml

@@ -0,0 +1,31 @@
+<?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="Application Test Suite">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+    <php>
+        <env name="APP_ENV" value="testing"/>
+    </php>
+    <logging>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+        <log type="coverage-text" target="build/logs/coverage.txt"/>
+        <log type="coverage-html" target="build/logs/coverage" charset="UTF-8" yui="true" highlight="true"/>
+    </logging>
+</phpunit>

src/Contracts/Manager.php

@@ -0,0 +1,104 @@
+<?php namespace Arcanesoft\Sidebar\Contracts;
+
+/**
+ * Interface  Manager
+ *
+ * @package   Arcanesoft\Sidebar\Contracts
+ * @author    ARCANEDEV <arcanedev.maroc@gmail.com>
+ */
+interface Manager
+{
+    /* -----------------------------------------------------------------
+     |  Getters & Setters
+     | -----------------------------------------------------------------
+     */
+    /**
+     * Set the view name.
+     *
+     * @param  string  $view
+     *
+     * @return self
+     */
+    public function setView($view);
+
+    /**
+     * Get the current item name.
+     *
+     * @return string
+     */
+    public function getCurrent();
+
+    /**
+     * Set the current item name.
+     *
+     * @param  string  $currentName
+     *
+     * @return $this
+     */
+    public function setCurrent($currentName);
+
+    /**
+     * Get the sidebar items.
+     *
+     * @return \Arcanesoft\Sidebar\Entities\ItemCollection
+     */
+    public function getItems();
+
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
+     */
+    /**
+     * Add a routed item.
+     *
+     * @param  string       $name
+     * @param  string       $title
+     * @param  string       $route
+     * @param  array        $parameters
+     * @param  string|null  $icon
+     *
+     * @return self
+     */
+    public function addRouteItem($name, $title, $route, array $parameters = [], $icon = null);
+
+    /**
+     * Add an item.
+     *
+     * @param  string       $name
+     * @param  string       $title
+     * @param  string       $url
+     * @param  string|null  $icon
+     *
+     * @return self
+     */
+    public function addItem($name, $title, $url = '#', $icon = null);
+
+    /**
+     * Add an item from array.
+     *
+     * @param  array  $array
+     *
+     * @return self
+     */
+    public function add(array $array);
+
+    /**
+     * Render the sidebar.
+     *
+     * @param  string|null  $view
+     *
+     * @return string
+     */
+    public function render($view = null);
+
+    /* -----------------------------------------------------------------
+     |  Check Methods
+     | -----------------------------------------------------------------
+     */
+    /**
+     * Check if the sidebar has items.
+     *
+     * @return bool
+     */
+    public function hasItems();
+}