Merge pull request #5 from cybercog/feature/is-not-owned-by

Add isNotOwnedBy method

Author: Pe Ell

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to `laravel-ownership` will be documented in this file.
 
+## 2.1.0 - 2016-12-21
+
+### Added
+
+- `isNotOwnedBy($owner)` to check if model not owned by concrete owner.
+
 ## 2.0.0 - 2016-12-17
 
 ### Added

README.md

@@ -165,6 +165,12 @@ $article->hasOwner();
 $article->isOwnedBy($owner);
 ```
 
+#### Check not owned by owner
+
+```php
+$article->isNotOwnedBy($owner);
+```
+
 #### Manually define default owner on model creation
 
 ```php

src/Contracts/HasOwner.php

@@ -101,6 +101,14 @@ public function hasOwner();
      */
     public function isOwnedBy(CanBeOwnerContract $owner);
 
+    /**
+     * Checks if model not owned by given owner.
+     *
+     * @param \Cog\Ownership\Contracts\CanBeOwner $owner
+     * @return bool
+     */
+    public function isNotOwnedBy(CanBeOwnerContract $owner);
+
     /**
      * Scope a query to only include models by owner.
      *

src/Traits/HasMorphOwner.php

@@ -168,6 +168,17 @@ public function isOwnedBy(CanBeOwnerContract $owner)
         return $owner->getKey() === $this->getOwner()->getKey() && $owner->getMorphClass() === $this->getOwner()->getMorphClass();
     }
 
+    /**
+     * Checks if model not owned by given owner.
+     *
+     * @param \Cog\Ownership\Contracts\CanBeOwner $owner
+     * @return bool
+     */
+    public function isNotOwnedBy(CanBeOwnerContract $owner)
+    {
+        return !$this->isOwnedBy($owner);
+    }
+
     /**
      * Scope a query to only include models by owner.
      *

src/Traits/HasOwner.php

@@ -173,6 +173,17 @@ public function isOwnedBy(CanBeOwnerContract $owner)
         return $owner->getKey() === $this->getOwner()->getKey();
     }
 
+    /**
+     * Checks if model not owned by given owner.
+     *
+     * @param \Cog\Ownership\Contracts\CanBeOwner $owner
+     * @return bool
+     */
+    public function isNotOwnedBy(CanBeOwnerContract $owner)
+    {
+        return !$this->isOwnedBy($owner);
+    }
+
     /**
      * Scope a query to only include models by owner.
      *

tests/unit/Traits/HasCustomizedOwnerTest.php

@@ -96,7 +96,7 @@ public function it_can_check_if_dont_have_owner()
     }
 
     /** @test */
-    public function it_can_check_if_owned_by()
+    public function it_can_return_true_from_is_owned_by()
     {
         $group = factory(Group::class)->create();
         $entity = factory(EntityWithCustomizedOwner::class)->create([
@@ -107,7 +107,7 @@ public function it_can_check_if_owned_by()
     }
 
     /** @test */
-    public function it_can_check_if_not_group_id()
+    public function it_can_return_false_from_is_owned_by()
     {
         $group = factory(Group::class)->create();
         $entity = factory(EntityWithCustomizedOwner::class)->create([
@@ -118,6 +118,29 @@ public function it_can_check_if_not_group_id()
         $this->assertFalse($entity->isOwnedBy($notOwnerUser));
     }
 
+    /** @test */
+    public function it_can_return_true_from_is_not_owned_by()
+    {
+        $group = factory(Group::class)->create();
+        $entity = factory(EntityWithCustomizedOwner::class)->create([
+            'group_id' => $group->getKey(),
+        ]);
+        $notOwner = factory(Group::class)->create();
+
+        $this->assertTrue($entity->isNotOwnedBy($notOwner));
+    }
+
+    /** @test */
+    public function it_can_return_false_from_is_not_owned_by()
+    {
+        $group = factory(Group::class)->create();
+        $entity = factory(EntityWithCustomizedOwner::class)->create([
+            'group_id' => $group->getKey(),
+        ]);
+
+        $this->assertFalse($entity->isNotOwnedBy($group));
+    }
+
     /** @test */
     public function it_can_scope_models_by_owner()
     {

tests/unit/Traits/HasMorphOwnerTest.php

@@ -112,7 +112,7 @@ public function it_can_check_if_dont_have_owner()
     }
 
     /** @test */
-    public function it_can_check_if_owned_by()
+    public function it_can_return_true_from_is_owned_by()
     {
         $character = factory(Character::class)->create();
         $entity = factory(EntityWithMorphOwner::class)->create([
@@ -124,7 +124,7 @@ public function it_can_check_if_owned_by()
     }
 
     /** @test */
-    public function it_can_check_if_not_owned_by()
+    public function it_can_return_false_from_is_owned_by()
     {
         $character = factory(Character::class)->create();
         $entity = factory(EntityWithMorphOwner::class)->create([
@@ -136,6 +136,31 @@ public function it_can_check_if_not_owned_by()
         $this->assertFalse($entity->isOwnedBy($notOwnerUser));
     }
 
+    /** @test */
+    public function it_can_return_true_from_is_not_owned_by()
+    {
+        $character = factory(Character::class)->create();
+        $entity = factory(EntityWithMorphOwner::class)->create([
+            'owned_by_id' => $character->getKey(),
+            'owned_by_type' => $character->getMorphClass(),
+        ]);
+        $notOwnerUser = factory(Character::class)->create();
+
+        $this->assertTrue($entity->isNotOwnedBy($notOwnerUser));
+    }
+
+    /** @test */
+    public function it_can_return_false_from_is_not_owned_by()
+    {
+        $character = factory(Character::class)->create();
+        $entity = factory(EntityWithMorphOwner::class)->create([
+            'owned_by_id' => $character->getKey(),
+            'owned_by_type' => $character->getMorphClass(),
+        ]);
+
+        $this->assertFalse($entity->isNotOwnedBy($character));
+    }
+
     /** @test */
     public function it_can_scope_models_by_owner()
     {

tests/unit/Traits/HasOwnerTest.php

@@ -96,7 +96,7 @@ public function it_can_check_if_dont_have_owner()
     }
 
     /** @test */
-    public function it_can_check_if_owned_by()
+    public function it_can_return_true_from_is_owned_by()
     {
         $user = factory(User::class)->create();
         $entity = factory(EntityWithOwner::class)->create([
@@ -107,7 +107,7 @@ public function it_can_check_if_owned_by()
     }
 
     /** @test */
-    public function it_can_check_if_not_owned_by()
+    public function it_can_return_false_from_is_owned_by()
     {
         $user = factory(User::class)->create();
         $entity = factory(EntityWithOwner::class)->create([
@@ -118,6 +118,29 @@ public function it_can_check_if_not_owned_by()
         $this->assertFalse($entity->isOwnedBy($notOwnerUser));
     }
 
+    /** @test */
+    public function it_can_return_true_from_is_not_owned_by()
+    {
+        $user = factory(User::class)->create();
+        $entity = factory(EntityWithOwner::class)->create([
+            'owned_by' => $user->getKey(),
+        ]);
+        $notOwnerUser = factory(User::class)->create();
+
+        $this->assertTrue($entity->isNotOwnedBy($notOwnerUser));
+    }
+
+    /** @test */
+    public function it_can_return_false_from_is_not_owned_by()
+    {
+        $user = factory(User::class)->create();
+        $entity = factory(EntityWithOwner::class)->create([
+            'owned_by' => $user->getKey(),
+        ]);
+
+        $this->assertFalse($entity->isNotOwnedBy($user));
+    }
+
     /** @test */
     public function it_can_scope_models_by_owner()
     {