feat: initial commit

Author: jfrosorio

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+### Description
+
+Explain what are you submitting.
+
+### Fixes
+
+Enter the issue you are fixing (e.g. This fixes #1.).
+
+
+
+

.gitignore

@@ -0,0 +1 @@
+/.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 CodeTech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,59 @@
+# Laravel Sluggable
+
+Laravel package for managing models' slugs.
+
+[![Latest version](https://img.shields.io/github/release/CodeTechPt/laravel-sluggable?style=flat-square)](https://github.com/CodeTechPt/laravel-sluggable/releases)
+[![GitHub license](https://img.shields.io/github/license/CodeTechPt/laravel-sluggable?style=flat-square)](https://github.com/CodeTechPt/laravel-sluggable/blob/master/LICENSE)
+
+
+## Installation
+
+Add the package to your Laravel app using composer
+
+```
+composer require codetech/laravel-sluggable
+```
+
+
+### Service Provider
+
+Register the package's service provider in config/app.php. In Laravel versions 5.5 and beyond, this step can be skipped if package auto-discovery is enabled.
+
+```
+'providers' => [
+
+    ...
+    Codetech\Sluggable\Providers\SluggableServiceProvider::class,
+    ...
+
+];
+```
+
+
+## Usage
+
+Use the trait in your models.
+
+```
+
+use CodeTech\Sluggable\Traits\HasSlug;
+
+class Theme extends Model
+{
+    use HasSlug;
+
+    ...
+```
+
+
+---
+
+
+## License
+
+**codetech/laravel-sluggable** is open-sourced software licensed under the [MIT license](https://github.com/CodeTechPt/laravel-sluggable/blob/master/LICENSE).
+
+
+## About CodeTech
+
+[CodeTech](https://www.codetech.pt) is a web development agency based on Matosinhos, Portugal. Oh, and we LOVE Laravel!

composer.json

@@ -0,0 +1,38 @@
+{
+  "name": "codetech/laravel-sluggable",
+  "description": "A Laravel package that allows you to assign settings to your models.",
+  "keywords": [
+    "codetech",
+    "laravel-sluggable",
+    "slug",
+    "laravel",
+    "laravel-package",
+    "eloquent-models"
+  ],
+  "authors": [
+    {
+      "name": "José Osório",
+      "email": "jfrosorio@gmail.com",
+      "role": "Developer"
+    }
+  ],
+  "license": "MIT",
+  "require": {
+    "php": "^7.2",
+    "laravel/framework": "^6.0|^7.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "CodeTech\\Sluggable\\": "src/"
+    }
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "extra": {
+    "laravel": {
+      "providers": [
+        "CodeTech\\Sluggable\\Providers\\SluggableServiceProvider"
+      ]
+    }
+  }
+}

src/HasSlug.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace CodeTech\Sluggable;
+
+use CodeTech\Sluggable\Observers\HasSlugObserver;
+
+trait HasSlug
+{
+    /**
+     * Initializes the trait.
+     */
+    public function initializeHasSlug()
+    {
+        $this->fillable[] = 'slug';
+    }
+
+    /**
+     * Boots the trait
+     *
+     * @return void
+     */
+    public static function bootHasSlug()
+    {
+        static::observe(HasSlugObserver::class);
+    }
+}

src/Http/Controllers/HasSlugController.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace CodeTech\Sluggable\Http\Controllers;
+
+use App\Http\Controllers\Controller;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use Illuminate\Support\Str;
+
+class HasSlugController extends Controller
+{
+
+    /**
+     * Slugifies a text string.
+     *
+     * @param Request $request
+     * @return JsonResponse
+     */
+    public function slugify(Request $request): JsonResponse
+    {
+        $text = $request->get('input') ?? null;
+
+        return response()->json([
+            'text' => $text,
+            'slug' => Str::slug($text)
+        ]);
+    }
+}

src/Observers/HasSlugObserver.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace CodeTech\Sluggable\Observers;
+
+use Illuminate\Support\Str;
+
+class HasSlugObserver
+{
+    /**
+     * Listen to the saved event.
+     *
+     * @param $model
+     */
+    public function saving($model)
+    {
+        $modelSlug = empty($model->slug) ? '' : Str::slug($model->slug);
+
+        $index  = 1;
+        $suffix = '';
+
+        do {
+            $slug = $modelSlug . $suffix;
+
+            $suffix = '-' . $index;
+            $index++;
+
+            $matches = $model::where('slug', $slug);
+
+            if ($model->id !== null) {
+                $matches->where('id', '!=', $model->id);
+            }
+        } while ($matches->count());
+
+        $model->slug = $slug;
+    }
+}