Merge pull request #6 from yabhq/feat/slugify

Slugify trait

Author: chrisblackwell

.gitignore

@@ -1 +1,3 @@
 /vendor/
+.phpunit.result.cache
+build/report.junit.xml

.phpunit.result.cache

@@ -0,0 +1,75 @@
+<?php
+
+namespace Yab\Mint\Traits;
+
+use Illuminate\Support\Str;
+use Illuminate\Database\Query\Builder;
+
+trait Slugify
+{
+    public static function bootSlugify()
+    {
+        static::creating(function ($model) {
+            if (is_null($model->slug)) {
+                $model->slug = Str::slug($model->name);
+            }
+            $model->slug = self::checkModelSlug($model->slug);
+        });
+
+        static::updating(function ($model) {
+            if ($model->getOriginal('slug') !== $model->slug) {
+                $model->slug = self::checkModelSlug($model->slug);
+            }
+        });
+    }
+
+    /**
+     * Check that the slug doesn't already exist if updating
+     *
+     * @param string $slug
+     *
+     * @return string
+     */
+    public static function checkModelSlug(string $slug): string
+    {
+        if (self::slugExists($slug)) {
+            return $slug . '-' . uniqid();
+        }
+        return $slug;
+    }
+
+    /**
+     * Check if the slug exists
+     *
+     * @param string $slug
+     *
+     * @return bool
+     */
+    public static function slugExists(string $slug): bool
+    {
+        return self::withoutGlobalScopes()->where('slug', $slug)->exists();
+    }
+
+    /**
+     * Return the model by the slug
+     *
+     * @param \Illuminate\Database\Query\Builder $scope
+     * @param string $slug
+     *
+     * @return \Illuminate\Database\Query\Builder
+     */
+    public function scopeBySlug(Builder $scope, string $slug): Builder
+    {
+        return $scope->where('slug', $slug);
+    }
+
+    /**
+     * Get the route key for the model.
+     *
+     * @return string
+     */
+    public function getRouteKeyName()
+    {
+        return 'slug';
+    }
+}

build/report.junit.xml

@@ -0,0 +1,9 @@
+<?php
+
+use Yab\Mint\Tests\Models\SlugModel;
+
+$factory->define(SlugModel::class, function () {
+    return [
+        'name' => 'Sample Name'
+    ];
+});

src/Traits/Slugify.php

@@ -0,0 +1,33 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateSlugModelsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('slug_models', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('name');
+            $table->string('slug');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('slug_models');
+    }
+}

tests/Factories/SlugModelFactory.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Yab\Mint\Tests\Models;
+
+use Yab\Mint\Traits\Slugify;
+use Illuminate\Database\Eloquent\Model;
+
+class SlugModel extends Model
+{
+    use Slugify;
+
+    protected $fillable = [
+        'name',
+    ];
+}

tests/Migrations/2020_06_23_000000_create_slug_models_table.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Yab\Mint\Tests;
+
+use Yab\Mint\Tests\TestCase;
+use Yab\Mint\Tests\Models\SlugModel;
+
+class SlugifyTest extends TestCase
+{
+    /** @test */
+    public function a_newly_created_model_has_a_slug_automatically_computed()
+    {
+        $model = factory(SlugModel::class)->create([
+            'name' => 'Slugify Me'
+        ]);
+
+        $this->assertDatabaseHas('slug_models', [
+            'id' => $model->id,
+            'name' => 'Slugify Me',
+            'slug' => 'slugify-me',
+        ]);
+    }
+
+    /** @test */
+    public function duplicate_slugs_are_handled_gracefully()
+    {
+        $model = factory(SlugModel::class)->create([
+            'name' => 'Sample Name'
+        ]);
+
+        $modelSameName = factory(SlugModel::class)->create([
+            'name' => 'Sample Name'
+        ]);
+
+        $this->assertDatabaseHas('slug_models', [
+            'id' => $model->id,
+            'name' => 'Sample Name',
+            'slug' => 'sample-name',
+        ]);
+
+        $this->assertDatabaseHas('slug_models', [
+            'id' => $modelSameName->id,
+            'name' => 'Sample Name',
+        ]);
+
+        $this->assertTrue(str_contains($modelSameName->slug, 'sample-name-'));
+        $this->assertEquals(25, strlen($modelSameName->slug));
+    }
+}