Remove eloquent-sluggable package and create Slug class + HasSlug trait (#4)

* Remove eloquent-sluggable package and create Simple HasSlug trait

* some fixes + add uniqueness feature and reserved values

* create Sluggable directory and put all logic here

Author: MPur

app/Article.php

@@ -3,13 +3,15 @@
 namespace App;
 
 use App\Filters\Filterable;
+use App\Sluggable\HasSlug;
 use App\Traits\FavoritedTrait;
-use Cviebrock\EloquentSluggable\Sluggable;
 use Illuminate\Database\Eloquent\Model;
 
 class Article extends Model
 {
-    use Filterable, FavoritedTrait, Sluggable;
+    use Filterable,
+        FavoritedTrait,
+        HasSlug;
 
     /**
      * The attributes that are mass assignable.
@@ -87,26 +89,32 @@ public function tags()
     }
 
     /**
-     * Return the sluggable configuration array for this model.
+     * Get the key name for route model binding.
      *
-     * @return array
+     * @return string
      */
-    public function sluggable()
+    public function getRouteKeyName()
     {
-        return [
-            'slug' => [
-                'source' => 'title'
-            ]
-        ];
+        return 'slug';
     }
 
     /**
-     * Get the key name for route model binding.
+     * Get the attribute name to slugify.
      *
      * @return string
      */
-    public function getRouteKeyName()
+    public function getSlugSourceColumn()
     {
-        return 'slug';
+        return 'title';
+    }
+
+    /**
+     * Get list of values which are not allowed for this resource
+     *
+     * @return array
+     */
+    public function getBannedSlugValues()
+    {
+        return ['feed'];
     }
 }

app/Sluggable/HasSlug.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace App\Sluggable;
+
+trait HasSlug
+{
+    /**
+     * Adding or updating slug when attribute to "slugify" is set.
+     *
+     * @param string $key
+     * @param mixed $value
+     * @return $this
+     */
+    public function setAttribute($key, $value)
+    {
+        if($key == $this->getSlugSourceColumn()) {
+            $slug = (new Slug($value))
+                ->uniqueFor($this)
+                ->without($this->getBannedSlugValues())
+                ->generate();
+
+            $this->attributes[$this->getSlugSourceColumn()] = $value;
+            $this->attributes[$this->getSlugColumn()] = $slug;
+        }
+
+        return parent::setAttribute($key, $value);
+    }
+
+    /**
+     * Get the attribute name to slugify.
+     *
+     * @return string
+     */
+    abstract public function getSlugSourceColumn();
+
+
+    /**
+     * Get the name of the slug column
+     *
+     * @return string
+     */
+    public function getSlugColumn()
+    {
+        return 'slug';
+    }
+
+    /**
+     * Get list of values wich are not allowed
+     *
+     * @return array
+     */
+    public function getBannedSlugValues()
+    {
+        return [];
+    }
+
+}

app/Sluggable/Slug.php

@@ -0,0 +1,136 @@
+<?php
+
+namespace App\Sluggable;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Slug
+{
+    /**
+     * Eloquent model used for example for uniqueness
+     *
+     * @var Model
+     */
+    protected $model;
+
+    /**
+     * Banned values for slug generation
+     *
+     * @var array
+     */
+    protected $banned = [];
+
+    /**
+     * Initial value to slugify
+     *
+     * @var string
+     */
+    private $initialValue;
+
+    /**
+     * Separator use to generate slugs
+     *
+     * @var string
+     */
+    const SEPARATOR = '-';
+
+    /**
+     * Slug constructor.
+     *
+     * @param string $value
+     */
+    public function __construct($value)
+    {
+        $this->initialValue = $value;
+    }
+
+    /**
+     * Generate a unique slug
+     *
+     * @return string
+     */
+    public function generate()
+    {
+        $slug = str_slug($this->initialValue, static::SEPARATOR);
+
+        $notAllowed = $this->getSimilarSlugs($slug)->merge($this->banned);
+
+        if ($notAllowed->isEmpty() || !$notAllowed->contains($slug)) {
+            return $slug;
+        }
+
+        $suffix = $this->generateSuffix($slug, $notAllowed);
+
+        return "{$slug}-{$suffix}";
+
+    }
+
+    /**
+     * Generate suffix for unique slug
+     *
+     * @param string $slug
+     * @param array $notAllowed
+     * @return string
+     */
+    public function generateSuffix($slug, $notAllowed)
+    {
+        /** @var Collection $notAllowed */
+        $notAllowed->transform(function ($item, $key) use ($slug) {
+
+            if ($slug == $item) {
+                return 0;
+            }
+
+            return (int)str_replace($slug . static::SEPARATOR, '', $item);
+        });
+
+        return $notAllowed->max() + 1;
+    }
+
+    /**
+     * Set eloquent model to check uniqueness on.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @return $this
+     */
+    public function uniqueFor(Model $model)
+    {
+        $this->model = $model;
+
+        return $this;
+    }
+
+    /**
+     * Set array of values which are not allowed.
+     *
+     * @param $values
+     * @return $this
+     */
+    public function without($values)
+    {
+        $this->banned = $values;
+
+        return $this;
+    }
+
+    /**
+     * Get collection of similar slugs based on database
+     *
+     * @param $slug
+     * @return \Illuminate\Support\Collection
+     */
+    private function getSimilarSlugs($slug)
+    {
+        if (!$this->model instanceof Model || !method_exists($this->model, 'getSlugColumn')) {
+            return collect([]);
+        }
+        $slugColumn = $this->model->getSlugColumn();
+
+        return $this->model->newQuery()
+            ->where($slugColumn, $slug)
+            ->orWhere($slugColumn, 'LIKE', "{$slug}-%")
+            ->get()
+            ->pluck($slugColumn);
+    }
+
+}

composer.json

@@ -7,7 +7,6 @@
     "require": {
         "php": ">=5.6.4",
         "barryvdh/laravel-cors": "^0.9.2",
-        "cviebrock/eloquent-sluggable": "^4.2",
         "laravel/framework": "5.4.*",
         "laravel/tinker": "~1.0",
         "tymon/jwt-auth": "0.5.*"