A sizeable refactor making TaggingUtility static and cleaning up other issues

Author: rtconner

composer.json

@@ -27,9 +27,9 @@
     }
   },
   "autoload-dev": {
-    "classmap": [
-      "tests/TestCase.php"
-    ]
+    "psr-4": {
+      "Tests\\": "tests/"
+    }
   },
   "extra": {
     "laravel": {

docs/how-to-override-util.md

@@ -2,7 +2,7 @@
 
 namespace Conner\Tagging\Console\Commands;
 
-use Conner\Tagging\Contracts\TaggingUtility;
+use Conner\Tagging\TaggingUtility;
 use Conner\Tagging\Model\TagGroup;
 use Illuminate\Console\Command;
 
@@ -22,31 +22,21 @@ class GenerateTagGroup extends Command
      */
     protected $description = 'Create a laravel tag group';
 
-    /** @var TaggingUtility $taggingUtility */
-    protected $taggingUtility;
-
-    public function __construct(TaggingUtility $taggingUtility)
-    {
-        parent::__construct();
-
-        $this->taggingUtility = $taggingUtility;
-    }
-
     /**
      * Execute the console command.
      *
      * @return mixed
      */
     public function handle()
     {
-        $group_name = $this->argument('group_name');
+        $groupName = $this->argument('group_name');
 
-        $tag_group = new TagGroup();
-        $tag_group->name = $group_name;
-        $tag_group->slug = $this->taggingUtility->slug($group_name);
+        $tagGroup = new TagGroup();
+        $tagGroup->name = $groupName;
+        $tagGroup->slug = TaggingUtility::normalize($groupName);
 
-        $tag_group->save();
+        $tagGroup->save();
 
-        $this->info('Created tag group: ' . $group_name);
+        $this->info('Created tag group: ' . $groupName);
     }
 }

src/Console/Commands/GenerateTagGroup.php

@@ -1,10 +1,12 @@
-<?php namespace Conner\Tagging\Contracts;
+<?php
+
+namespace Conner\Tagging\Contracts;
 
 /**
  * Interface of utility functions to help with various tagging functionality.
  *
  * @copyright Copyright (C) 2015 Robert Conner
- * @author Rob Conner <[email protected]>
+ * @author Robert Conner <[email protected]>
  */
 interface TaggingUtility
 {
@@ -17,12 +19,20 @@ interface TaggingUtility
     public function makeTagArray($tagNames);
 
     /**
-     * Create a web friendly URL slug from a string.
+     * Normalize a tag string
+     *
+     * @param string $string
+     * @return string
+     */
+    public static function normalize($string);
+
+    /**
+     * Create a web friendly URL slug from a string
      *
-     * @param string $str
+     * @param string $string
      * @return string
      */
-    public static function slug($str);
+    public static function slug($string);
 
     /**
      * Private! Please do not call this function directly, just let the Tag library use it.
@@ -45,7 +55,7 @@ public function incrementCount($tagString, $tagSlug, $count);
     public function decrementCount($tagString, $tagSlug, $count);
 
     /**
-     * Look at the tags table and delete any tags that are no londer in use by any taggable database rows.
+     * Look at the tags table and delete any tags that are no longer in use by any taggable database rows.
      * Does not delete tags where 'suggest' is true
      *
      * @return int
@@ -57,5 +67,5 @@ public function deleteUnusedTags();
      *
      * @return string
      */
-    public function tagModelString();
+    public static function tagModelString();
 }

src/Contracts/TaggingUtility.php

@@ -1,5 +1,6 @@
 <?php namespace Conner\Tagging\Events;
 
+use Conner\Tagging\Taggable;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Database\Eloquent\Model;
 
@@ -13,10 +14,10 @@ class TagAdded
     /**
      * Create a new event instance.
      *
-     * @param  Model  $model
+     * @param Taggable|Model $model
      * @return void
      */
-    public function __construct(Model $model)
+    public function __construct($model)
     {
         $this->model = $model;
     }

src/Events/TagAdded.php

@@ -1,22 +1,25 @@
-<?php namespace Conner\Tagging\Events;
+<?php
 
-use Illuminate\Queue\SerializesModels;
+namespace Conner\Tagging\Events;
+
+use Conner\Tagging\Taggable;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Queue\SerializesModels;
 
 class TagRemoved
 {
     use SerializesModels;
 
-    /** @var \Illuminate\Database\Eloquent\Model **/
+    /** @var \Conner\Tagging\Taggable **/
     public $model;
 
     /**
      * Create a new event instance.
      *
-     * @param  Model  $model
+     * @param Taggable|Model $model
      * @return void
      */
-    public function __construct(Model $model)
+    public function __construct($model)
     {
         $this->model = $model;
     }

src/Events/TagRemoved.php

@@ -1,26 +1,27 @@
-<?php namespace Conner\Tagging\Model;
+<?php
 
-use Conner\Tagging\Contracts\TaggingUtility;
+namespace Conner\Tagging\Model;
+
+use Conner\Tagging\TaggingUtility;
 use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Database\Eloquent\Model as Eloquent;
+use Illuminate\Database\Eloquent\Model;
 
 /**
- * Copyright (C) 2014 Robert Conner
  * @package Conner\Tagging\Model
  * @property string id
  * @property string name
  * @property string slug
  * @property bool suggest
  * @property integer count
  * @property TagGroup group
+ * @method static suggested()
+ * @method static inGroup(string $groupName)
  */
-class Tag extends Eloquent
+class Tag extends Model
 {
     protected $table = 'tagging_tags';
     public $timestamps = false;
-    protected $softDelete = false;
     public $fillable = ['name'];
-    protected $taggingUtility;
 
     /**
      * @param array $attributes
@@ -29,23 +30,20 @@ public function __construct(array $attributes = [])
     {
         parent::__construct($attributes);
 
-        if (function_exists('config') && $connection = config('tagging.connection')) {
-            $this->connection = $connection;
-        }
-
-        $this->taggingUtility = app(TaggingUtility::class);
+        $this->connection = config('tagging.connection');
     }
 
+    /**
+     * @inheritDoc
+     */
     public function save(array $options = [])
     {
         if(strlen($this->name) < 1) {
             throw new \RuntimeException('Cannot save a tag with an empty name');
         }
 
-        $normalizer = config('tagging.normalizer');
-        $normalizer = $normalizer ?: [$this->taggingUtility, 'slug'];
+        $this->slug = TaggingUtility::normalize($this->name);
 
-        $this->slug = call_user_func($normalizer, $this->name);
         return parent::save($options);
     }
 
@@ -56,7 +54,9 @@ public function save(array $options = [])
      */
     public function setGroup($groupName)
     {
-        $tagGroup = TagGroup::where('slug', $this->taggingUtility->slug($groupName))->first();
+        $tagGroup = TagGroup::query()
+            ->where('slug', TaggingUtility::normalize($groupName))
+            ->first();
 
         if ($tagGroup) {
             $this->group()->associate($tagGroup);
@@ -75,7 +75,7 @@ public function setGroup($groupName)
      */
     public function removeGroup(string $groupName)
     {
-        $tagGroup = TagGroup::query()->where('slug', $this->taggingUtility->slug($groupName))->first();
+        $tagGroup = TagGroup::query()->where('slug', TaggingUtility::normalize($groupName))->first();
 
         if ($tagGroup) {
             $this->group()->dissociate($tagGroup);
@@ -94,9 +94,10 @@ public function removeGroup(string $groupName)
      */
     public function isInGroup($groupName): bool
     {
-        if ($this->group && ($this->group->slug == $this->taggingUtility->slug($groupName))) {
+        if ($this->group && ($this->group->slug == TaggingUtility::normalize($groupName))) {
             return true;
         }
+
         return false;
     }
 
@@ -120,11 +121,11 @@ public function scopeSuggested($query)
      * Get suggested tags
      * @param Builder $query
      * @param $groupName
-     * @return
+     * @return Builder
      */
     public function scopeInGroup(Builder $query, $groupName)
     {
-        $groupSlug = $this->taggingUtility->slug($groupName);
+        $groupSlug = TaggingUtility::normalize($groupName);
 
         return $query->whereHas('group', function (Builder $query) use ($groupSlug) {
             $query->where('slug', $groupSlug);
@@ -138,21 +139,18 @@ public function scopeInGroup(Builder $query, $groupName)
      */
     public function setNameAttribute(string $value)
     {
-        $displayer = config('tagging.displayer');
-        $displayer = empty($displayer) ? '\Illuminate\Support\Str::title' : $displayer;
-
-        $this->attributes['name'] = call_user_func($displayer, $value);
+        $this->attributes['name'] = TaggingUtility::displayize($value);
     }
 
     /**
-     * Look at the tags table and delete any tags that are no londer in use by any taggable database rows.
-     * Does not delete tags where 'suggest'value is true
+     * Look at the tags table and delete any tags that are no longer in use by any taggable database rows.
+     * Does not delete tags where 'suggest' value is true
      *
-     * @return int
+     * @return mixed
      */
     public static function deleteUnused()
     {
-        return (new static )->newQuery()
+        return (new static)->newQuery()
             ->where('count', '=', 0)
             ->where('suggest', false)
             ->delete();

src/Model/Tag.php

@@ -1,24 +1,21 @@
 <?php namespace Conner\Tagging\Model;
 
-use Conner\Tagging\Contracts\TaggingUtility;
-use Illuminate\Database\Eloquent\Model as Eloquent;
+use Conner\Tagging\TaggingUtility;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Str;
 
 /**
- * Copyright (C) 2014 Robert Conner
  * @package Conner\Tagging\Model
+ *
  * @property string id
  * @property string slug
  * @property string name
  * @property-read Collection|Tag[] tags
  */
-class TagGroup extends Eloquent
+class TagGroup extends Model
 {
     protected $table = 'tagging_tag_groups';
     public $timestamps = false;
-    protected $softDelete = false;
-    public $fillable = ['name'];
 
     /** @var TaggingUtility $taggingUtility */
     protected $taggingUtility;
@@ -30,31 +27,25 @@ public function __construct(array $attributes = [])
     {
         parent::__construct($attributes);
 
-        if (function_exists('config') && $connection = config('tagging.connection')) {
-            $this->connection = $connection;
-        }
-
-        $this->taggingUtility = app(TaggingUtility::class);
+        $this->connection = config('tagging.connection');
     }
 
     /**
      * Get suggested tags
      */
     public function tags()
     {
-        $model = $this->taggingUtility->tagModelString();
+        $model = TaggingUtility::tagModelString();
 
         return $this->hasMany($model, 'tag_group_id');
     }
 
     /**
-     * sets the slug when setting the group name
-     *
-     * @return void
+     * @param $value
      */
     public function setNameAttribute($value)
     {
         $this->attributes['name'] = $value;
-        $this->attributes['slug'] = Str::slug($value);
+        $this->attributes['slug'] = TaggingUtility::normalize($value);
     }
 }