Fix JosephSilber#628 by enabling opt-in to nullable scopes

src/Database/Scope/Scope.php

@@ -34,6 +34,14 @@ class Scope implements ScopeContract
      */
     protected $scopeRoleAbilities = true;
 
+    /**
+     * Determines whether queries should check null scopes
+     * when there is a scope set.
+     *
+     * @var bool
+     */
+    protected $allowNullScope = false;
+
     /**
      * Scope queries to the given tenant ID.
      *
@@ -74,6 +82,18 @@ public function dontScopeRoleAbilities()
         return $this;
     }
 
+    /**
+     * Don't include null scope in queries.
+     *
+     * @return $this
+     */
+    public function allowNullScope()
+    {
+        $this->allowNullScope = true;
+
+        return $this;
+    }
+
     /**
      * Append the tenant ID to the given cache key.
      *
@@ -93,7 +113,7 @@ public function appendToCacheKey($key)
      */
     public function applyToModel(Model $model)
     {
-        if (! $this->onlyScopeRelations && ! is_null($this->scope)) {
+        if ($this->shouldApplyScopeToModel()) {
             $model->scope = $this->scope;
         }
 
@@ -109,7 +129,7 @@ public function applyToModel(Model $model)
      */
     public function applyToModelQuery($query, $table = null)
     {
-        if ($this->onlyScopeRelations) {
+        if ($this->shouldApplyScopeToModelQuery()) {
             return $query;
         }
 
@@ -129,6 +149,10 @@ public function applyToModelQuery($query, $table = null)
      */
     public function applyToRelationQuery($query, $table)
     {
+        if (is_null($this->scope) && $this->allowNullScope) {
+            return $query;
+        }
+
         return $this->applyToQuery($query, $table);
     }
 
@@ -164,7 +188,7 @@ protected function applyToQuery($query, $table)
         return $query->where(function ($query) use ($table) {
             $query->whereNull("{$table}.scope");
 
-            if (! is_null($this->scope)) {
+            if ($this->allowNullScope || ! is_null($this->scope)) {
                 $query->orWhere("{$table}.scope", $this->scope);
             }
         });
@@ -250,4 +274,31 @@ protected function isRoleClass($className)
     {
         return Models::classname(Role::class) === $className;
     }
+
+    /**
+     * Determine of the scope should be applied to the model.
+     *
+     * @return bool
+     */
+    protected function shouldApplyScopeToModel()
+    {
+        return ! $this->onlyScopeRelations &&
+            ($this->allowNullScope || ! is_null($this->scope));
+    }
+
+    /**
+     * Determine if the scope should be applied to the model query.
+     *
+     * @return bool
+     */
+    public function shouldApplyScopeToModelQuery()
+    {
+        return $this->onlyScopeRelations ||
+            ($this->allowNullScope && is_null($this->scope));
+    }
+
+    protected function applyS()
+    {
+        return $this->allowNullScope;
+    }
 }

tests/MultiTenancyTest.php

@@ -156,6 +156,26 @@ function scoped_abilities_do_not_work_when_unscoped($provider)
         $this->assertFalse($bouncer->can('read'));
     }
 
+    /**
+     * @test
+     * @dataProvider bouncerProvider
+     */
+    function scoped_abilities_work_when_unscoped_and_allowed($provider)
+    {
+        list($bouncer, $user) = $provider();
+
+        $bouncer->scope()->to(1)->allowNullScope();
+        $bouncer->allow($user)->to(['write', 'read']);
+
+        $this->assertTrue($bouncer->can('write'));
+        $this->assertTrue($bouncer->can('read'));
+        $this->assertEquals(2, $user->abilities()->count());
+
+        $bouncer->scope()->to(null);
+        $this->assertTrue($bouncer->can('write'));
+        $this->assertTrue($bouncer->can('read'));
+    }
+
     /**
      * @test
      * @dataProvider bouncerProvider
@@ -351,6 +371,31 @@ function assigning_and_retracting_roles_scopes_them_properly($provider)
         $this->assertFalse($bouncer->is($user)->an('admin'));
     }
 
+    /**
+     * @test
+     * @dataProvider bouncerProvider
+     */
+    function assigning_and_retracting_roles_scopes_them_properly_when_allowing_null_scopes($provider)
+    {
+        list($bouncer, $user) = $provider();
+
+        $bouncer->scope()->to(1)->onlyRelations()->allowNullScope();
+        $bouncer->assign('admin')->to($user);
+
+        $bouncer->scope()->to(2);
+        $bouncer->assign('admin')->to($user);
+        $bouncer->retract('admin')->from($user);
+
+        $bouncer->scope()->to(1);
+        $this->assertTrue($bouncer->is($user)->an('admin'));
+
+        $bouncer->scope()->to(2);
+        $this->assertFalse($bouncer->is($user)->an('admin'));
+
+        $bouncer->scope()->to(null);
+        $this->assertTrue($bouncer->is($user)->an('admin'));
+    }
+
     /**
      * @test
      * @dataProvider bouncerProvider