Initial commit

.gitignore

@@ -0,0 +1 @@
+/idea

.styleci.yml

@@ -0,0 +1 @@
+preset: laravel

changelog.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to `Cerberus` will be documented in this file.
+
+## Version 1.0
+
+### Added
+- Everything

composer.json

@@ -0,0 +1,41 @@
+{
+    "name": "emodyz/cerberus",
+    "description": "Hell's Gatekeeper",
+    "license": "GPL-3.0-only",
+    "authors": [
+        {
+            "name": "Saber Nouira",
+            "email": "contact@emodyz.eu",
+            "homepage": "https://emodyz.eu"
+        }
+    ],
+    "homepage": "https://github.com/emodyz/cerberus",
+    "keywords": ["Laravel", "Cerberus"],
+    "require": {
+        "illuminate/support": "~7|~8"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "~9.0",
+        "orchestra/testbench": "~5|~6"
+    },
+    "autoload": {
+        "psr-4": {
+            "Emodyz\\Cerberus\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Emodyz\\Cerberus\\Tests\\": "tests"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Emodyz\\Cerberus\\CerberusServiceProvider"
+            ],
+            "aliases": {
+                "Cerberus": "Emodyz\\Cerberus\\Facades\\Cerberus"
+            }
+        }
+    }
+}

config/cerberus.php

@@ -0,0 +1,26 @@
+<?php
+
+return [
+    'roles' => [
+        'owner' => [
+            'displayName' => 'Owner',
+            'can' => [
+                '*'
+            ]
+        ],
+        'admin' => [
+            'displayName' => 'Administrator',
+            'can' => []
+        ],
+        'default' => [
+            'displayName' => 'User',
+            'can' => []
+        ]
+    ],
+    'authorizations' => [
+        [
+            'slug' => '*',
+            'description' => 'a user can do everything'
+        ],
+    ]
+];

contributing.md

@@ -0,0 +1,27 @@
+# Contributing
+
+Contributions are welcome and will be fully credited.
+
+Contributions are accepted via Pull Requests on [Github](https://github.com/emodyz/cerberus).
+
+# Things you could do
+If you want to contribute but do not know where to start, this list provides some starting points.
+- Add license text
+- Remove rewriteRules.php
+- Set up TravisCI, StyleCI, ScrutinizerCI
+- Write a comprehensive ReadMe
+
+## Pull Requests
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `readme.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+
+**Happy coding**!

database/migrations/2020_11_05_081923_add_role_column_to_users_table.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddRoleColumnToUsersTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->string('role')->default('default')->index();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('users', function (Blueprint $table) {
+            //
+        });
+    }
+}

license.md

@@ -0,0 +1,5 @@
+# The license
+
+Copyright (c) author name <author email>
+
+...Add your license text here...

phpunit.xml

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

readme.md

@@ -0,0 +1,57 @@
+# Cerberus
+
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![Total Downloads][ico-downloads]][link-downloads]
+[![Build Status][ico-travis]][link-travis]
+[![StyleCI][ico-styleci]][link-styleci]
+
+This is where your description should go. Take a look at [contributing.md](contributing.md) to see a to do list.
+
+## Installation
+
+Via Composer
+
+``` bash
+$ composer require emodyz/cerberus
+```
+
+## Usage
+
+## Change log
+
+Please see the [changelog](changelog.md) for more information on what has changed recently.
+
+## Testing
+
+``` bash
+$ composer test
+```
+
+## Contributing
+
+Please see [contributing.md](contributing.md) for details and a todolist.
+
+## Security
+
+If you discover any security related issues, please email author email instead of using the issue tracker.
+
+## Credits
+
+- [author name][link-author]
+- [All Contributors][link-contributors]
+
+## License
+
+license. Please see the [license file](license.md) for more information.
+
+[ico-version]: https://img.shields.io/packagist/v/emodyz/cerberus.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/emodyz/cerberus.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/emodyz/cerberus/master.svg?style=flat-square
+[ico-styleci]: https://styleci.io/repos/12345678/shield
+
+[link-packagist]: https://packagist.org/packages/emodyz/cerberus
+[link-downloads]: https://packagist.org/packages/emodyz/cerberus
+[link-travis]: https://travis-ci.org/emodyz/cerberus
+[link-styleci]: https://styleci.io/repos/12345678
+[link-author]: https://github.com/emodyz
+[link-contributors]: ../../contributors

src/AuthorizationRegistrar.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Emodyz\Cerberus;
+
+use Illuminate\Contracts\Auth\Access\Authorizable;
+use Illuminate\Contracts\Auth\Access\Gate;
+
+class AuthorizationRegistrar
+{
+
+    // TODO: cache everything
+
+    /**
+     * PermissionManager constructor.
+     */
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Register the permission check method on the gate.
+     * We resolve the Gate fresh here, for benefit of long-running instances.
+     *
+     * @return bool
+     */
+    public function registerPermissions(): bool
+    {
+        app(Gate::class)->before(function (Authorizable $user, string $ability) {
+            if (method_exists($user, 'checkAuthorizationTo')) {
+                return $user->checkAuthorizationTo($ability) ?: null;
+            }
+        });
+
+        return true;
+    }
+}

src/Cerberus.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Emodyz\Cerberus;
+
+class Cerberus
+{
+    public static function config($key = null): \Illuminate\Support\Collection
+    {
+        switch ($key) {
+            case 'roles':
+                return collect(config('cerberus.roles'));
+            case 'authorizations':
+                return collect(config('cerberus.authorizations'));
+            case !null:
+                return collect(config('cerberus.' . $key));
+            default:
+                return collect(config('cerberus'));
+        }
+    }
+}

src/CerberusServiceProvider.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace Emodyz\Cerberus;
+
+use Illuminate\Support\ServiceProvider;
+
+class CerberusServiceProvider extends ServiceProvider
+{
+    /**
+     * Perform post-registration booting of services.
+     *
+     * @param AuthorizationRegistrar $permissionLoader
+     * @return void
+     */
+    public function boot(AuthorizationRegistrar $permissionLoader): void
+    {
+        // $this->loadTranslationsFrom(__DIR__.'/../resources/lang', 'emodyz');
+        // $this->loadViewsFrom(__DIR__.'/../resources/views', 'emodyz');
+        $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
+        // $this->loadRoutesFrom(__DIR__.'/routes.php');
+
+        // Publishing is only necessary when using the CLI.
+        if ($this->app->runningInConsole()) {
+            $this->bootForConsole();
+        }
+
+        $permissionLoader->registerPermissions();
+
+        $this->app->singleton(AuthorizationRegistrar::class, function ($app) use ($permissionLoader) {
+            return $permissionLoader;
+        });
+    }
+
+    /**
+     * Register any package services.
+     *
+     * @return void
+     */
+    public function register(): void
+    {
+        $this->mergeConfigFrom(__DIR__.'/../config/cerberus.php', 'cerberus');
+
+        // Register the service the package provides.
+        $this->app->singleton('cerberus', function ($app) {
+            return new Cerberus();
+        });
+
+        // $this->app->alias(Cerberus::class, 'cerberus');
+    }
+
+    /**
+     * Get the services provided by the provider.
+     *
+     * @return array
+     */
+    public function provides()
+    {
+        return ['cerberus'];
+    }
+
+    /**
+     * Console-specific booting.
+     *
+     * @return void
+     */
+    protected function bootForConsole(): void
+    {
+        // Publishing the configuration file.
+        $this->publishes([
+            __DIR__.'/../config/cerberus.php' => config_path('cerberus.php'),
+        ], 'cerberus.config');
+
+        // Publishing the migration files.
+        $this->publishes([
+            __DIR__.'/../database/migrations' => base_path('database/migrations/emodyz/cerberus'),
+        ], 'cerberus.migrations');
+
+        // Publishing the views.
+        /*$this->publishes([
+            __DIR__.'/../resources/views' => base_path('resources/views/vendor/emodyz/cerberus'),
+        ], 'cerberus.views');*/
+
+        // Publishing assets.
+        /*$this->publishes([
+            __DIR__.'/../resources/assets' => public_path('vendor/emodyz/cerberus'),
+        ], 'cerberus.views');*/
+
+        // Publishing the translation files.
+        /*$this->publishes([
+            __DIR__.'/../resources/lang' => resource_path('lang/vendor/emodyz/cerberus'),
+        ], 'cerberus.views');*/
+
+        // Registering package commands.
+        // $this->commands([]);
+    }
+}