Add proper type support (#47)

* Add proper type support

* Fix Style CI

* Fix Style CI and insights

* Rework into syncTagsWithType and add tests

* Fix StyleCI

Author: jodiedunlop

README.md

@@ -33,6 +33,14 @@ $newsItem->detachTags(['tag4', 'tag5']);
 //syncing tags
 $newsItem->syncTags(['tag1', 'tag2']); // all other tags on this model will be detached
 
+//syncing tags with a type
+$newsItem->syncTagsWithType(['tag1', 'tag2'], 'typeA'); 
+$newsItem->syncTagsWithType(['tag1', 'tag2'], 'typeB'); 
+
+//retrieving tags with a type
+$newsItem->tagsWithType('typeA'); 
+$newsItem->tagsWithType('typeB'); 
+
 //retrieving models that have any of the given tags
 NewsItem::withAnyTags(['tag1', 'tag2']);
 

src/HasTags.php

@@ -159,12 +159,29 @@ public function syncTags($tags)
         return $this;
     }
 
+    /**
+     * @param array|\ArrayAccess $tags
+     * @param string|null $type
+     *
+     * @return $this
+     */
+    public function syncTagsWithType($tags, string $type = null)
+    {
+        $className = static::getTagClassName();
+
+        $tags = collect($className::findOrCreate($tags, $type));
+
+        $this->syncTagIds($tags->pluck('id')->toArray(), $type);
+
+        return $this;
+    }
+
     protected static function convertToTags($values, $type = null, $locale = null)
     {
         return collect($values)->map(function ($value) use ($type, $locale) {
             if ($value instanceof Tag) {
                 if (isset($type) && $value->type != $type) {
-                    new \InvalidArgumentException("Type was set to {$type} but tag is of type {$value->type}");
+                    throw new \InvalidArgumentException("Type was set to {$type} but tag is of type {$value->type}");
                 }
 
                 return $value;
@@ -175,4 +192,55 @@ protected static function convertToTags($values, $type = null, $locale = null)
             return $className::findFromString($value, $type, $locale);
         });
     }
+
+    /**
+     * Use in place of eloquent's sync() method so that the tag type may be optionally specified.
+     * @param $ids
+     * @param string|null $type
+     * @param bool $detaching
+     */
+    protected function syncTagIds($ids, string $type = null, $detaching = true)
+    {
+        $isUpdated = false;
+
+        // Get a list of tag_ids for all current tags
+        $current = $this->tags()
+            ->newPivotStatement()
+            ->where('taggable_id', $this->getKey())
+            ->when($type !== null, function ($query) use ($type) {
+                $tagModel = $this->tags()->getRelated();
+                $query->join(
+                    $tagModel->getTable(),
+                    'taggables.tag_id',
+                    '=',
+                    $tagModel->getTable().'.'.$tagModel->getKeyName()
+                )
+                    ->where('tags.type', $type);
+            })
+            ->pluck('tag_id')
+            ->all();
+
+        // Compare to the list of ids given to find the tags to remove
+        $detach = array_diff($current, $ids);
+        if ($detaching && count($detach) > 0) {
+            $this->tags()->detach($detach);
+            $isUpdated = true;
+        }
+
+        // Attach any new ids
+        $attach = array_diff($ids, $current);
+        if (count($attach) > 0) {
+            collect($attach)->each(function ($id) {
+                $this->tags()->attach($id, []);
+            });
+            $isUpdated = true;
+        }
+
+        // Once we have finished attaching or detaching the records, we will see if we
+        // have done any attaching or detaching, and if we have we will touch these
+        // relationships if they are configured to touch on any database updates.
+        if ($isUpdated) {
+            $this->tags()->touchIfTouching();
+        }
+    }
 }

tests/HasTagsTest.php

@@ -185,4 +185,17 @@ public function it_can_sync_multiple_tags()
 
         $this->assertEquals(['tag3', 'tag4'], $this->testModel->tags->pluck('name')->toArray());
     }
+
+    /** @test */
+    public function it_can_sync_tags_with_different_types()
+    {
+        $this->testModel->syncTagsWithType(['tagA1', 'tagA2', 'tagA3'], 'typeA');
+        $this->testModel->syncTagsWithType(['tagB1', 'tagB2'], 'typeB');
+
+        $tagsOfTypeA = $this->testModel->tagsWithType('typeA');
+        $this->assertEquals(['tagA1', 'tagA2', 'tagA3'], $tagsOfTypeA->pluck('name')->toArray());
+
+        $tagsOfTypeB = $this->testModel->tagsWithType('typeB');
+        $this->assertEquals(['tagB1', 'tagB2'], $tagsOfTypeB->pluck('name')->toArray());
+    }
 }