Release v3.0 (#12)

* Add Laravel 5.5 support

* Add package autodiscovery for L5.5

* Drop ownership dependency (#9)

* Renamed HasBans to Bannable.

* Renamed DB table ban to bans

* Add Laravel prefix in classes namespaces

* Move contracts to external package Cog\Contracts\Ban

* Add autoloading migrations.

Author: Anton Komarev

CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to `laravel-ban` will be documented in this file.
 
+## [3.0.0] - 2017-08-27
+
+### Changed
+
+- `Cog\Ban\Contracts\Ban` moved to `Cog\Contracts\Ban\Ban`
+- `Cog\Ban\Contracts\HasBans` moved to `Cog\Contracts\Ban\HasBans`
+- `Cog\Ban\Contracts\BanService` moved to `Cog\Contracts\Ban\BanService`
+- All classes namespaces changed from `Cog\Ban\*` to `Cog\Laravel\Ban\*`
+- Renamed database table `ban` to `bans`
+- Renamed database column `owned_by_id` to `bannable_id`
+- Renamed database column `owned_by_type` to `bannable_type`
+- Renamed trait `HasBans` to `Bannable`
+- Renamed contract `HasBans` to `Bannable`
+- Renamed `Ban::whereOwnedBy($bannable)` to `Ban::whereBannable($bannable)`
+- Renamed Ban model relation `ownedBy` to `bannable`
+
+### Removed
+
+- Dependency Laravel Ownership
+- Removed Ban model `owner` method
+- Removed Ban model `getOwner` method
+
 ## [2.1.0] - 2017-03-21
 
 ### Added
@@ -10,7 +32,7 @@ All notable changes to `laravel-ban` will be documented in this file.
 
 ### Changed
 
-- `HasBans` is a collection of traits `HasBannedAtHelpers`, `HasBannedAtScope`, `HasBansRelation` now.
+- `HasBans` is a collection of traits `HasBannedAtHelpers`, `HasBannedAtScope`, `HasBansRelation` now
 
 ## [2.0.1] - 2017-03-19
 
@@ -29,6 +51,7 @@ All notable changes to `laravel-ban` will be documented in this file.
 
 - Initial release
 
+[3.0.0]: https://github.com/cybercog/laravel-ban/compare/2.1.1...3.0.0
 [2.1.0]: https://github.com/cybercog/laravel-ban/compare/2.0.1...2.1.0
 [2.0.1]: https://github.com/cybercog/laravel-ban/compare/2.0.0...2.0.1
 [2.0.0]: https://github.com/cybercog/laravel-ban/compare/1.0.0...2.0.0

README.md

@@ -1,4 +1,6 @@
-![cog-laravel-ban](https://cloud.githubusercontent.com/assets/1849174/23580161/55a1c060-010d-11e7-9658-efe992bde0a7.png)
+# Laravel Ban
+
+![cog-laravel-ban](https://user-images.githubusercontent.com/1849174/28749192-fe2d2cb4-74c7-11e7-955e-9c48e81106c2.png)
 
 <p align="center">
 <a href="https://travis-ci.org/cybercog/laravel-ban"><img src="https://img.shields.io/travis/cybercog/laravel-ban/master.svg?style=flat-square" alt="Build Status"></a>
@@ -18,14 +20,15 @@ Use case is not limited to User model, any Eloquent model could be banned: Organ
 - [Features](#features)
 - [Installation](#installation)
 - [Usage](#usage)
-    - [Prepare bannable model](#prepare-bannable-model)
-    - [Prepare bannable model database table](#prepare-bannable-model-database-table)
-    - [Available methods](#available-methods)
-    - [Scopes](#scopes)
-    - [Events](#events)
-    - [Middleware](#middleware)
-    - [Scheduling](#scheduling)
+  - [Prepare bannable model](#prepare-bannable-model)
+  - [Prepare bannable model database table](#prepare-bannable-model-database-table)
+  - [Available methods](#available-methods)
+  - [Scopes](#scopes)
+  - [Events](#events)
+  - [Middleware](#middleware)
+  - [Scheduling](#scheduling)
 - [Change log](#change-log)
+- [Upgrading](#upgrading)
 - [Contributing](#contributing)
 - [Testing](#testing)
 - [Security](#security)
@@ -63,14 +66,14 @@ And then include the service provider within `app/config/app.php`:
 
 ```php
 'providers' => [
-    Cog\Ban\Providers\BanServiceProvider::class,
+    Cog\Laravel\Ban\Providers\BanServiceProvider::class,
 ],
 ```
 
 At last you need to publish and run database migrations:
 
 ```sh
-$ php artisan vendor:publish --provider="Cog\Ban\Providers\BanServiceProvider" --tag="migrations"
+$ php artisan vendor:publish --provider="Cog\Laravel\Ban\Providers\BanServiceProvider" --tag="migrations"
 $ php artisan migrate
 ```
 
@@ -79,18 +82,16 @@ $ php artisan migrate
 ### Prepare bannable model
 
 ```php
-use Cog\Ban\Contracts\HasBans as HasBansContract;
-use Cog\Ban\Traits\HasBans;
+use Cog\Contracts\Ban\Bannable as BannableContract;
+use Cog\Laravel\Ban\Traits\Bannable;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 
-class User extends Authenticatable implements HasBansContract
+class User extends Authenticatable implements BannableContract
 {
-    use HasBans;
+    use Bannable;
 }
 ```
 
-*Note: `HasBans` contract using `CanBeOwner` contract under the hood. If you are using [`cybercog/laravel-ownership`](https://github.com/cybercog/laravel-ownership) package `CanBeOwner` contract could be omitted from bannable model.*
-
 ### Prepare bannable model database table
 
 Bannable model must have `nullable timestamp` column named `banned_at`. This value used as flag and simplify checks if user was banned. If you are trying to make default Laravel User model to be bannable you can use example below.
@@ -133,19 +134,12 @@ class AddBannedAtColumnToUsersTable extends Migration
 #### Apply ban for the entity
 
 ```php
-$user->bans()->create([]);
-
 $user->ban();
 ```
 
-
 #### Apply ban for the entity with reason comment
 
 ```php
-$user->bans()->create([
-    'comment' => 'Enjoy your ban!',
-]);
-
 $user->ban([
     'comment' => 'Enjoy your ban!',
 ]);
@@ -154,16 +148,18 @@ $user->ban([
 #### Apply ban for the entity which will be deleted over time
 
 ```php
-$user->bans()->create([
-    'expired_at' => '+1 month',
-]);
-
 $user->ban([
     'expired_at' => '2086-03-28 00:00:00',
 ]);
-```
+``` 
 
-`expired_at` attribute could be `\Carbon\Carbon` instance or any string which could be parsed by `\Carbon\Carbon::parse($string)` method.
+`expired_at` attribute could be `\Carbon\Carbon` instance or any string which could be parsed by `\Carbon\Carbon::parse($string)` method:
+
+```php
+$user->ban([
+    'expired_at' => '+1 month',
+]);
+``` 
 
 #### Remove ban from entity
 
@@ -188,7 +184,7 @@ $user->isNotBanned();
 #### Delete expired bans manually
 
 ```php
-app(\Cog\Ban\Services\BanService::class)->deleteExpiredBans();
+app(\Cog\Laravel\Ban\Services\BanService::class)->deleteExpiredBans();
 ```
 
 ### Scopes
@@ -216,13 +212,13 @@ $users = User::onlyBanned()->get();
 To apply query scopes all the time you can define `shouldApplyBannedAtScope` method in bannable model. If method returns `true` all banned models will be hidden by default.
 
 ```php
-use Cog\Ban\Contracts\HasBans as HasBansContract;
-use Cog\Ban\Traits\HasBans;
+use Cog\Contracts\Ban\Bannable as BannableContract;
+use Cog\Laravel\Ban\Traits\Bannable;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 
-class User extends Authenticatable implements HasBansContract
+class User extends Authenticatable implements BannableContract
 {
-    use HasBans;
+    use Bannable;
 
     /**
      * Determine if BannedAtScope should be applied by default.
@@ -238,9 +234,9 @@ class User extends Authenticatable implements HasBansContract
 
 ### Events
 
-If entity is banned `\Cog\Ban\Events\ModelWasBanned` event is fired.
+If entity is banned `\Cog\Laravel\Ban\Events\ModelWasBanned` event is fired.
 
-Is entity is unbanned `\Cog\Ban\Events\ModelWasUnbanned` event is fired.
+Is entity is unbanned `\Cog\Laravel\Ban\Events\ModelWasUnbanned` event is fired.
 
 ### Middleware
 
@@ -250,7 +246,7 @@ To use it define new middleware in `$routeMiddleware` array of `app/Http/Kernel.
 
 ```php
 protected $routeMiddleware = [
-    'forbid-banned-user' => \Cog\Ban\Http\Middleware\ForbidBannedUser::class,
+    'forbid-banned-user' => \Cog\Laravel\Ban\Http\Middleware\ForbidBannedUser::class,
 ]
 ```
 
@@ -284,6 +280,10 @@ Of course, the time used in the code above is just example. Adjust it to suit yo
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
+## Upgrading
+
+Please see [UPGRADING](UPGRADING.md) for detailed upgrade instructions.
+
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

UPGRADING.md

@@ -0,0 +1,49 @@
+# Upgrade Guide
+
+- [From v2 to v3](#from-v2-to-v3)
+
+## From v2 to v3
+
+Because there are many breaking changes an upgrade is not that easy. There are many edge cases this guide does not cover.
+We accept PRs to improve this guide.
+
+Find and replace: 
+
+- Find all `Cog\Ban\Contracts\Ban` and replace with `Cog\Contracts\Ban\Ban`
+- Find all `Cog\Ban\Contracts\HasBans` and replace with `Cog\Contracts\Ban\Bannable`
+- Find all `Cog\Ban\Contracts\BanService` and replace with `Cog\Contracts\Ban\BanService`
+- Find all `Cog\Ban\Traits\HasBans` and replace with `Cog\Laravel\Ban\Traits\Bannable`
+- Find all `Cog\Ban` and replace with `Cog\Laravel\Ban`
+
+In classes which works with bans:
+
+- Find `Ban::whereOwnedBy` replace with `Ban::whereBannable`
+- Find calls of methods or attributes on the Ban model like `ownedBy`, `owner`, `getOwner` and replace them with `bannable`
+
+These database changes should be performed:
+
+- Rename `ban` table to `bans`
+- Rename `bans` database column `owned_by_id` to `bannable_id`
+- Rename `bans` database column `owned_by_type` to `bannable_type`
+- Update name of migration file in `migrations` table from `2017_03_04_000000_create_ban_table` to `2017_03_04_000000_create_bans_table`
+
+To make all changes in MySQL you could run these 3 commands one by one:
+
+```mysql
+ALTER TABLE `ban` RENAME TO `bans`;
+
+  ALTER TABLE `bans` 
+CHANGE COLUMN `owned_by_id` `bannable_id` INT(10) UNSIGNED NOT NULL,
+CHANGE COLUMN `owned_by_type` `bannable_type` VARCHAR(255) NOT NULL,
+   DROP INDEX `ban_owned_by_id_owned_by_type_index`,
+    ADD INDEX `ban_bannable_id_bannable_type_index` (`bannable_id` ASC, `bannable_type` ASC);
+
+UPDATE `migrations`
+   SET `migration` = '2017_03_04_000000_create_bans_table'
+ WHERE `migration` = '2017_03_04_000000_create_ban_table'
+ LIMIT 1;
+```
+
+Migration files:
+
+- Delete `database/migrations/2017_03_04_000000_create_ban_table.php` migration file (from v3 service provider automatically loading migration files or republish it if custom changes are required to be done).

composer.json

@@ -36,10 +36,9 @@
     },
     "require": {
         "php": "^5.6|^7.0",
-        "cybercog/laravel-ownership": "^3.0",
-        "illuminate/database": "~5.1.20|~5.2.0|~5.3.0|~5.4.0",
-        "illuminate/events": "~5.1.20|~5.2.0|~5.3.0|~5.4.0",
-        "illuminate/support": "~5.1.20|~5.2.0|~5.3.0|~5.4.0"
+        "illuminate/database": "~5.1.20|~5.2|~5.3|~5.4|~5.5",
+        "illuminate/events": "~5.1.20|~5.2|~5.3|~5.4|~5.5",
+        "illuminate/support": "~5.1.20|~5.2|~5.3|~5.4|~5.5"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^1.11",
@@ -50,12 +49,13 @@
     },
     "autoload": {
         "psr-4": {
-            "Cog\\Ban\\": "src/"
+            "Cog\\Contracts\\Ban\\": "contracts/",
+            "Cog\\Laravel\\Ban\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Cog\\Ban\\Tests\\": "tests/"
+            "Cog\\Tests\\Laravel\\Ban\\": "tests/"
         }
     },
     "scripts": {
@@ -64,6 +64,13 @@
     "config": {
         "sort-packages": true
     },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Cog\\Laravel\\Ban\\Providers\\BanServiceProvider"
+            ]
+        }
+    },
     "minimum-stability": "dev",
     "prefer-stable" : true
 }

contracts/Ban.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of Laravel Ban.
+ *
+ * (c) Anton Komarev <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cog\Contracts\Ban;
+
+use Cog\Contracts\Ban\Bannable as BannableContract;
+use Illuminate\Database\Eloquent\Builder;
+
+/**
+ * Interface Ban.
+ *
+ * @package Cog\Contracts\Ban
+ */
+interface Ban
+{
+    /**
+     * Entity responsible for ban.
+     *
+     * @return mixed
+     */
+    public function createdBy();
+
+    /**
+     * Bannable model.
+     *
+     * @return \Cog\Contracts\Ban\Bannable
+     */
+    public function bannable();
+
+    /**
+     * Scope a query to only include bans by bannable model.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     * @param \Cog\Contracts\Ban\Bannable $bannable
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeWhereBannable(Builder $query, BannableContract $bannable);
+}