init

Author: QuentinGab

.github/FUNDING.yml

@@ -1 +1 @@
-github: :vendor_name
+github: ElegantEngineeringTech

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,11 @@
 blank_issues_enabled: false
 contact_links:
   - name: Ask a question
-    url: https://github.com/:vendor_slug/:package_name/discussions/new?category=q-a
+    url: https://github.com/elegantly/laravel-banhammer/discussions/new?category=q-a
     about: Ask the community for help
   - name: Request a feature
-    url: https://github.com/:vendor_slug/:package_name/discussions/new?category=ideas
+    url: https://github.com/elegantly/laravel-banhammer/discussions/new?category=ideas
     about: Share ideas for new features
   - name: Report a security issue
-    url: https://github.com/:vendor_slug/:package_name/security/policy
+    url: https://github.com/elegantly/laravel-banhammer/security/policy
     about: Learn how to notify us for sensitive bugs

.github/workflows/update-changelog.yml

@@ -1,3 +1,3 @@
 # Changelog
 
-All notable changes to `:package_name` will be documented in this file.
+All notable changes to `laravel-banhammer` will be documented in this file.

CHANGELOG.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) :vendor_name <author@domain.com>
+Copyright (c) Elegantly <quentin.gabriele@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE.md

@@ -1,68 +1,102 @@
-# :package_description
+# This is my package laravel-banhammer
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
-<!--delete-->
----
-This repo can be used to scaffold a Laravel package. Follow these steps to get started:
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/elegantly/laravel-banhammer.svg?style=flat-square)](https://packagist.org/packages/elegantly/laravel-banhammer)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/elegantly/laravel-banhammer/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/elegantly/laravel-banhammer/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/elegantly/laravel-banhammer/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/elegantly/laravel-banhammer/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/elegantly/laravel-banhammer.svg?style=flat-square)](https://packagist.org/packages/elegantly/laravel-banhammer)
 
-1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
-2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
-3. Have fun creating your package.
-4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
----
-<!--/delete-->
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+A simple package to ban an model (users, teams...).
 
 ## Installation
 
 You can install the package via composer:
 
 ```bash
-composer require :vendor_slug/:package_slug
+composer require elegantly/laravel-banhammer
 ```
 
-You can publish and run the migrations with:
+First, publish the config with:
 
 ```bash
-php artisan vendor:publish --tag=":package_slug-migrations"
-php artisan migrate
+php artisan vendor:publish --tag="banhammer-config"
 ```
 
-You can publish the config file with:
+Then define the bannable models in the config file like this:
+
+```php
+use Elegantly\Banhammer\Models\Ban;
+use Illuminate\Foundation\Auth\User;
+
+return [
+
+    'model_ban' => Ban::class,
+
+    'model_user' => User::class,
+
+    'bannables' => [
+        \App\Models\User::class,
+        // \App\Models\Team::class
+    ],
+
+];
+
+```
+
+Next, publish and run the migrations with:
 
 ```bash
-php artisan vendor:publish --tag=":package_slug-config"
+php artisan vendor:publish --tag="banhammer-migrations"
+php artisan migrate
 ```
 
-This is the contents of the published config file:
+Finally schedule the command from `bootstrap/app.php` with:
 
 ```php
-return [
-];
+use Illuminate\Foundation\Application;
+use Illuminate\Console\Scheduling\Schedule;
+use Elegantly\Banhammer\Commands\DenormalizeBannableCommand;
+
+return Application::configure(basePath: dirname(__DIR__))
+    // ...
+    ->withSchedule(function (Schedule $schedule) {
+        $schedule->command(DenormalizeBannableCommand::class)->everyMinute();
+    })
+    ->create();
 ```
 
-Optionally, you can publish the views using
+Or from `routes/console.php` with:
 
-```bash
-php artisan vendor:publish --tag=":package_slug-views"
+```php
+use Illuminate\Support\Facades\Schedule;
+use Elegantly\Banhammer\Commands\DenormalizeBannableCommand;
+
+Schedule::command(DenormalizeBannableCommand::class)->everyMinute();
 ```
 
 ## Usage
 
+### Prepare your models:
+
+```php
+namespace App\Models;
+
+use Elegantly\Banhammer\Models\Concerns\Bannable;
+use Elegantly\Banhammer\Models\Contracts\BannableContract;
+use Illuminate\Foundation\Auth\User as Authenticatable;
+
+class User extends Authenticatable implements BannableContract
+{
+    use Bannable;
+}
+```
+
 ```php
-$variable = new VendorName\Skeleton();
-echo $variable->echoPhrase('Hello, VendorName!');
+$user->ban(
+    level: 0,
+    reason: "spam",
+    from: now(),
+    until: null,
+);
 ```
 
 ## Testing
@@ -85,8 +119,8 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [:author_name](https://github.com/:author_username)
-- [All Contributors](../../contributors)
+-   [Quentin Gabriele](https://github.com/QuentinGab)
+-   [All Contributors](../../contributors)
 
 ## License
 

README.md

@@ -1,17 +1,17 @@
 {
-    "name": ":vendor_slug/:package_slug",
-    "description": ":package_description",
+    "name": "elegantly/laravel-banhammer",
+    "description": "Ban any model in your Laravel App",
     "keywords": [
-        ":vendor_name",
+        "Elegantly",
         "laravel",
-        ":package_slug"
+        "laravel-banhammer"
     ],
-    "homepage": "https://github.com/:vendor_slug/:package_slug",
+    "homepage": "https://github.com/elegantly/laravel-banhammer",
     "license": "MIT",
     "authors": [
         {
-            "name": ":author_name",
-            "email": "author@domain.com",
+            "name": "Quentin Gabriele",
+            "email": "quentin.gabriele@gmail.com",
             "role": "Developer"
         }
     ],
@@ -30,28 +30,44 @@
         "pestphp/pest-plugin-laravel": "^3.0",
         "phpstan/extension-installer": "^1.3||^2.0",
         "phpstan/phpstan-deprecation-rules": "^1.1||^2.0",
-        "phpstan/phpstan-phpunit": "^1.3||^2.0",
-        "spatie/laravel-ray": "^1.35"
+        "phpstan/phpstan-phpunit": "^1.3||^2.0"
     },
     "autoload": {
         "psr-4": {
-            "VendorName\\Skeleton\\": "src/",
-            "VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
+            "Elegantly\\Banhammer\\": "src/",
+            "Elegantly\\Banhammer\\Database\\Factories\\": "database/factories/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "VendorName\\Skeleton\\Tests\\": "tests/",
-            "Workbench\\App\\": "workbench/app/"
+            "Elegantly\\Banhammer\\Tests\\": "tests/",
+            "Workbench\\App\\": "workbench/app/",
+            "Workbench\\Database\\Factories\\": "workbench/database/factories/",
+            "Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
         }
     },
     "scripts": {
-        "post-autoload-dump": "@composer run prepare",
+        "post-autoload-dump": [
+            "@clear",
+            "@prepare",
+            "@composer run prepare"
+        ],
         "prepare": "@php vendor/bin/testbench package:discover --ansi",
         "analyse": "vendor/bin/phpstan analyse",
         "test": "vendor/bin/pest",
         "test-coverage": "vendor/bin/pest --coverage",
-        "format": "vendor/bin/pint"
+        "format": "vendor/bin/pint",
+        "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
+        "build": "@php vendor/bin/testbench workbench:build --ansi",
+        "serve": [
+            "Composer\\Config::disableProcessTimeout",
+            "@build",
+            "@php vendor/bin/testbench serve --ansi"
+        ],
+        "lint": [
+            "@php vendor/bin/pint --ansi",
+            "@php vendor/bin/phpstan analyse --verbose --ansi"
+        ]
     },
     "config": {
         "sort-packages": true,
@@ -63,10 +79,10 @@
     "extra": {
         "laravel": {
             "providers": [
-                "VendorName\\Skeleton\\SkeletonServiceProvider"
+                "Elegantly\\Banhammer\\BanhammerServiceProvider"
             ],
             "aliases": {
-                "Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
+                "Banhammer": "Elegantly\\Banhammer\\Facades\\Banhammer"
             }
         }
     },

composer.json

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+use Elegantly\Banhammer\Models\Ban;
+use Illuminate\Foundation\Auth\User;
+
+return [
+
+    'model_ban' => Ban::class,
+
+    'model_user' => User::class,
+
+    'bannables' => [
+        // \App\Models\User::class
+    ],
+
+];