Initial commit

.gitignore

@@ -0,0 +1 @@
+/vendor

composer.json

@@ -0,0 +1,25 @@
+{
+    "name": "kyzegs/prunable",
+    "description": "Laravel's prunable traits without force deleting",
+    "authors": [
+        {
+            "name": "Sebastiaan",
+            "email": "[email protected]"
+        }
+    ],
+    "require-dev": {
+        "laravel/pint": "^1.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Kyzegs\\Prunable\\": "src/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Kyzegs\\Providers\\PrunableProvider"
+            ]
+        }
+    }
+}

src/Concerns/SafeMassPrunable.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Kyzegs\Prunable\Concerns;
+
+use Illuminate\Database\Events\ModelsPruned;
+use LogicException;
+
+trait SafeMassPrunable
+{
+    /**
+     * Prune all prunable models in the database.
+     *
+     * @param  int  $chunkSize
+     * @return int
+     */
+    public function pruneAll(int $chunkSize = 1000)
+    {
+        $query = tap($this->prunable(), function ($query) use ($chunkSize) {
+            $query->when(! $query->getQuery()->limit, function ($query) use ($chunkSize) {
+                $query->limit($chunkSize);
+            });
+        });
+
+        $total = 0;
+
+        do {
+            $total += $count = $query->delete();
+
+            if ($count > 0) {
+                event(new ModelsPruned(static::class, $total));
+            }
+        } while ($count > 0);
+
+        return $total;
+    }
+
+    /**
+     * Get the prunable model query.
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function prunable()
+    {
+        throw new LogicException('Please implement the prunable method on your model.');
+    }
+}

src/Concerns/SafePrunable.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Kyzegs\Prunable\Concerns;
+
+use Illuminate\Database\Events\ModelsPruned;
+use LogicException;
+
+trait SafePrunable
+{
+    /**
+     * Prune all prunable models in the database.
+     *
+     * @param  int  $chunkSize
+     * @return int
+     */
+    public function pruneAll(int $chunkSize = 1000)
+    {
+        $total = 0;
+
+        $this->prunable()->chunkById($chunkSize, function ($models) use (&$total) {
+            $models->each->prune();
+
+            $total += $models->count();
+
+            event(new ModelsPruned(static::class, $total));
+        });
+
+        return $total;
+    }
+
+    /**
+     * Get the prunable model query.
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function prunable()
+    {
+        throw new LogicException('Please implement the prunable method on your model.');
+    }
+
+    /**
+     * Prune the model in the database.
+     *
+     * @return bool|null
+     */
+    public function prune()
+    {
+        $this->pruning();
+
+        return $this->delete();
+    }
+
+    /**
+     * Prepare the model for pruning.
+     *
+     * @return void
+     */
+    protected function pruning()
+    {
+        //
+    }
+}

src/Console/Commands/PruneCommand.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Kyzegs\Prunable\Console\Commands;
+
+use Illuminate\Database\Eloquent\MassPrunable;
+use Illuminate\Database\Eloquent\Prunable;
+use Kyzegs\Prunable\Concerns\SafeMassPrunable;
+use Kyzegs\Prunable\Concerns\SafePrunable;
+
+class PruneCommand extends \Illuminate\Database\Console\PruneCommand
+{
+    /**
+     * Determine if the given model class is prunable.
+     *
+     * @param  string  $model
+     * @return bool
+     */
+    protected function isPrunable($model)
+    {
+        $uses = class_uses_recursive($model);
+
+        return ! empty(array_intersect($uses, [
+            Prunable::class,
+            MassPrunable::class,
+            SafePrunable::class,
+            SafeMassPrunable::class,
+        ]));
+    }
+}

src/Providers/PrunableProvider.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Kyzegs\Prunable\Providers;
+
+use Illuminate\Support\ServiceProvider;
+use Kyzegs\Prunable\Console\Commands\PruneCommand;
+
+class PrunableProvider extends ServiceProvider
+{
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->extend(\Illuminate\Database\Console\PruneCommand::class, fn () => new PruneCommand());
+    }
+
+    /**
+     * Bootstrap any package services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([PruneCommand::class]);
+        }
+    }
+}