Improving tests and removing a few bugs from the updates

Author: rtconner

src/Contracts/TaggableContract.php

@@ -1,6 +1,5 @@
 <?php namespace Conner\Tagging\Contracts;
 
-use Illuminate\Support\Facades\Config;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
 

src/Contracts/TaggingUtility.php

@@ -16,9 +16,7 @@ class TagGroup extends Model
 {
     protected $table = 'tagging_tag_groups';
     public $timestamps = false;
-
-    /** @var TaggingUtility $taggingUtility */
-    protected $taggingUtility;
+    protected $fillable = ['name'];
 
     /**
      * @param array $attributes

src/Model/TagGroup.php

@@ -11,9 +11,9 @@
 
 /**
  * @package Conner\Tagging
- * @method withAllTags(array)
- * @method withAnyTags(array)
- * @method withoutTags(array)
+ * @method static withAllTags(array $tags)
+ * @method static withAnyTag(array $tags)
+ * @method static withoutTags(array $tags)
  * @property Collection|Tagged[] tagged
  * @property Collection|Tag[] tags
  * @property string[] tag_names
@@ -181,14 +181,13 @@ public function scopeWithAllTags(Builder $query, $tagNames): Builder
             array_shift($tagNames);
         }
 
-        $tagNames = static::$taggingUtility->makeTagArray($tagNames);
+        $tagNames = TaggingUtility::makeTagArray($tagNames);
 
-        $normalizer = [static::$taggingUtility, 'normalizer'];
         $className = $query->getModel()->getMorphClass();
 
         foreach($tagNames as $tagSlug) {
             $tags = Tagged::query()
-                ->where('tag_slug', call_user_func($normalizer, $tagSlug))
+                ->where('tag_slug', TaggingUtility::normalize($tagSlug))
                 ->where('taggable_type', $className)
                 ->get()
                 ->pluck('taggable_id');
@@ -366,7 +365,7 @@ private function assembleTagsForScoping($query, $tagNames)
 
         $tagNames = TaggingUtility::makeTagArray($tagNames);
 
-        $normalizer = [TaggingUtility::class, 'normalizer'];
+        $normalizer = [TaggingUtility::class, 'normalize'];
 
         $tagNames = array_map($normalizer, $tagNames);
         $className = $query->getModel()->getMorphClass();

src/Taggable.php

@@ -2,14 +2,20 @@
 
 namespace Tests;
 
+use Conner\Tagging\Contracts\TaggableContract;
 use Illuminate\Database\Eloquent\Model as Eloquent;
 use Conner\Tagging\Taggable;
+use Illuminate\Foundation\Testing\WithFaker;
+use Illuminate\Support\Collection;
 
 class CommonUsageTest extends TestCase
 {
+    use WithFaker;
+
     public function setUp(): void
     {
         parent::setUp();
+        $this->setUpFaker();
 
         \Schema::create('books', function ($table) {
             $table->increments('id');
@@ -29,7 +35,7 @@ public function tearDown(): void
 
     public function test_tag_call()
     {
-        $stub = Stub::create(['name'=>123]);
+        $stub = $this->book();
 
         $stub->tag('test123');
         $stub->tag('456');
@@ -40,7 +46,7 @@ public function test_tag_call()
 
     public function test_untag_call()
     {
-        $stub = Stub::create(['name'=>'Stub']);
+        $stub = $this->book();
 
         $stub->tag('one');
         $stub->tag('two');
@@ -56,8 +62,7 @@ public function test_untag_call()
 
     public function test_retag()
     {
-        /** @var Stub $stub */
-        $stub = Stub::create(['name'=>123]);
+        $stub = $this->book();
 
         $stub->tag('first');
         $stub->tag('second');
@@ -69,7 +74,7 @@ public function test_retag()
 
     public function test_tag_names_attribute()
     {
-        $stub = Stub::create(['name'=>123, 'tag_names'=>'foo, bar']);
+        $stub = $this->book(['tag_names'=>'foo, bar']);
 
         $stub->save();
 
@@ -78,8 +83,7 @@ public function test_tag_names_attribute()
 
     public function test_the_tagged_property()
     {
-        /** @var Stub $stub */
-        $stub = Stub::create(['name'=>123]);
+        $stub = $this->book();
 
         $stub->tag('first');
         $stub->tag('second');
@@ -93,8 +97,7 @@ public function test_the_tagged_property()
 
     public function test_calling_tagNames_as_a_property()
     {
-        /** @var Stub $stub */
-        $stub = Stub::create(['name'=>123]);
+        $stub = $this->book();
 
         $stub->tag('first');
         $stub->tag('second');
@@ -105,8 +108,7 @@ public function test_calling_tagNames_as_a_property()
 
     public function test_get_tags()
     {
-        /** @var Stub $stub */
-        $stub = Stub::create(['name'=>123]);
+        $stub = $this->book();
 
         $stub->tag('first');
         $stub->tag('second');
@@ -116,7 +118,7 @@ public function test_get_tags()
 
     public function test_setting_tag_names_array()
     {
-        $stub = new Stub();
+        $stub = new Book();
         $stub->name = 'test';
         $stub->tag_names = ['foo', 'bar'];
         $stub->save();
@@ -129,21 +131,79 @@ public function test_setting_tag_names_array()
 
     public function test_tagging_with_empty_tags()
     {
-        /** @var Stub $stub */
-        $stub = Stub::create(['name'=>123]);
+        $stub = $this->book();
 
         $tagName = "Japan, Asia, Economy, , , , , ";
 
         $stub->retag($tagName);
 
         $this->assertEquals(['Japan', 'Asia', 'Economy'], $stub->tag_names);
     }
+
+    function test_withAllTags()
+    {
+        $one = $this->book();
+        $two = $this->book();
+        $three = $this->book();
+
+        $one->tag(['one']);
+        $two->tag(['b', 'two']);
+        $three->tag(['one', 'two']);
+
+        $list = Book::withAllTags(['one', 'two'])->get();
+
+        $this->assertCount(1, $list);
+        $this->assertEquals($three->id, $list[0]->id);
+    }
+
+    function test_withAnyTags()
+    {
+        $one = $this->book();
+        $two = $this->book();
+        $three = $this->book();
+
+        $one->tag(['one']);
+        $two->tag(['b', 'two']);
+
+        /** @var Collection $list */
+        $list = Book::withAnyTag(['one', 'two'])->get();
+
+        $this->assertCount(2, $list);
+        $indexed = $list->keyBy('id');
+        $this->assertNotEmpty($indexed[$one->id]);
+        $this->assertNotEmpty($indexed[$two->id]);
+    }
+
+    function test_withoutTags()
+    {
+        $one = $this->book();
+        $two = $this->book();
+        $three = $this->book();
+
+        $one->tag(['one']);
+        $two->tag(['b', 'two']);
+
+        /** @var Collection $list */
+        $list = Book::withoutTags(['one', 'two'])->get();
+
+        $this->assertCount(1, $list);
+        $this->assertEquals($three->id, $list[0]->id);
+    }
+
+
+    private function book($attributes = []): Book
+    {
+        $attributes = array_merge(['name'=>$this->faker->name], $attributes);
+
+        return Book::create($attributes);
+    }
 }
 
+
 /**
  * @property string name
  */
-class Stub extends Eloquent
+class Book extends Eloquent implements TaggableContract
 {
     use Taggable;
 

tests/CommonUsageTest.php

@@ -11,6 +11,7 @@ class TaggableContractTest extends TestCase
     public function test_is_implemented_by_taggable_trait()
     {
         $implementation = new TraitImplementation();
+
         $this->assertNotNull($implementation);
     }
 }

tests/TaggableContractTest.php

@@ -6,11 +6,16 @@
 
 class TaggedTest extends TestCase
 {
-    public function test_instantiation()
+    public function test_saving_a_tag_model()
     {
         Tagged::unguard();
 
-        $tagged = new Tagged(['taggable_id'=>'123', 'tag_slug'=> 'foo', 'tag_name'=>'Foo', 'taggable_type'=>'bar']);
+        $tagged = new Tagged([
+            'taggable_id'=>'123',
+            'tag_slug'=> 'foo',
+            'tag_name'=>'Foo',
+            'taggable_type'=>'bar',
+        ]);
 
         $tagged->save();
 

tests/TaggedTest.php

@@ -3,6 +3,7 @@
 namespace Tests;
 
 use Conner\Tagging\TaggingUtility;
+use Illuminate\Support\Str;
 
 class TaggingUtilityTest extends TestCase
 {
@@ -68,6 +69,17 @@ public function test_normalizer()
         $this->assertEquals(TaggingUtility::slug('Sugar Free'), TaggingUtility::normalize('Sugar Free'));
         $this->assertEquals(TaggingUtility::slug('ПЧ�Цщ'), TaggingUtility::normalize('ПЧ�Цщ'));
         $this->assertEquals(TaggingUtility::slug('quiénsí'), TaggingUtility::normalize('quiénsí'));
+
+        config(['tagging.normalizer' => function($str) { return 'aaa'; }]);
+        $this->assertEquals('aaa', TaggingUtility::normalize('some string'));
     }
 
+    public function test_displayize()
+    {
+        $this->assertEquals('Sugar Free', TaggingUtility::displayize('sugar free'));
+        $this->assertEquals(Str::title('ПЧ�Цщ'), TaggingUtility::displayize('ПЧ�Цщ'));
+
+        config(['tagging.displayer' => function($str) { return 'bbb'; }]);
+        $this->assertEquals('bbb', TaggingUtility::displayize('some string'));
+    }
 }