Allow running a callback with a temporary scope

Closes #368

src/Contracts/Scope.php

@@ -49,11 +49,42 @@ public function applyToRelationQuery($query, $table);
      */
     public function applyToRelation(BelongsToMany $relation);
 
+    /**
+     * Get the current scope value.
+     *
+     * @return mixed
+     */
+    public function get();
+
     /**
      * Get the additional attributes for pivot table records.
      *
      * @param  string|null  $authority
      * @return array
      */
     public function getAttachAttributes($authority = null);
+
+    /**
+     * Run the given callback with the given temporary scope.
+     *
+     * @param  mixed   $scope
+     * @param  callable  $callback
+     * @return mixed
+     */
+    public function onceTo($scope, callable $callback);
+
+    /**
+     * Remove the scope completely.
+     *
+     * @return $this
+     */
+    public function remove();
+
+    /**
+     * Run the given callback without the scope applied.
+     *
+     * @param  callable  $callback
+     * @return mixed
+     */
+    public function removeOnce(callable $callback);
 }

src/Database/Scope/Scope.php

@@ -167,6 +167,16 @@ protected function applyToQuery($query, $table)
         });
     }
 
+    /**
+     * Get the current scope value.
+     *
+     * @return mixed
+     */
+    public function get()
+    {
+        return $this->scope;
+    }
+
     /**
      * Get the additional attributes for pivot table records.
      *
@@ -187,6 +197,47 @@ public function getAttachAttributes($authority = null)
         return ['scope' => $this->scope];
     }
 
+    /**
+     * Run the given callback with the given temporary scope.
+     *
+     * @param  mixed   $scope
+     * @param  callable  $callback
+     * @return mixed
+     */
+    public function onceTo($scope, callable $callback)
+    {
+        $mainScope = $this->scope;
+
+        $this->scope = $scope;
+
+        $result = $callback();
+
+        $this->scope = $mainScope;
+
+        return $result;
+    }
+
+    /**
+     * Remove the scope completely.
+     *
+     * @return $this
+     */
+    public function remove()
+    {
+        $this->scope = null;
+    }
+
+    /**
+     * Run the given callback without the scope applied.
+     *
+     * @param  callable  $callback
+     * @return mixed
+     */
+    public function removeOnce(callable $callback)
+    {
+        return $this->onceTo(null, $callback);
+    }
+
     /**
      * Determine whether the given class name is the role model.
      *

tests/MultiTenancyTest.php

@@ -28,6 +28,33 @@ function tearDown()
         parent::tearDown();
     }
 
+    /**
+     * @test
+     */
+    function can_set_and_get_the_current_scope()
+    {
+        $bouncer = $this->bouncer();
+
+        $this->assertNull($bouncer->scope()->get());
+
+        $bouncer->scope()->to(1);
+        $this->assertEquals(1, $bouncer->scope()->get());
+    }
+
+    /**
+     * @test
+     */
+    function can_remove_the_current_scope()
+    {
+        $bouncer = $this->bouncer();
+
+        $bouncer->scope()->to(1);
+        $this->assertEquals(1, $bouncer->scope()->get());
+
+        $bouncer->scope()->remove();
+        $this->assertNull($bouncer->scope()->get());
+    }
+
     /**
      * @test
      * @dataProvider bouncerProvider
@@ -282,6 +309,44 @@ function can_set_custom_scope($provider)
 
         $this->assertTrue($bouncer->can('delete', User::class));
     }
+
+    /**
+     * @test
+     */
+    function can_set_the_scope_temporarily()
+    {
+        $bouncer = $this->bouncer();
+
+        $this->assertNull($bouncer->scope()->get());
+
+        $result = $bouncer->scope()->onceTo(1, function () use ($bouncer) {
+            $this->assertEquals(1, $bouncer->scope()->get());
+
+            return 'result';
+        });
+
+        $this->assertEquals('result', $result);
+        $this->assertNull($bouncer->scope()->get());
+    }
+
+    /**
+     * @test
+     */
+    function can_remove_the_scope_temporarily()
+    {
+        $bouncer = $this->bouncer();
+
+        $bouncer->scope()->to(1);
+
+        $result = $bouncer->scope()->removeOnce(function () use ($bouncer) {
+            $this->assertEquals(null, $bouncer->scope()->get());
+
+            return 'result';
+        });
+
+        $this->assertEquals('result', $result);
+        $this->assertEquals(1, $bouncer->scope()->get());
+    }
 }
 
 
@@ -318,8 +383,28 @@ public function applyToRelation(BelongsToMany $relation)
         return $relation;
     }
 
+    public function get()
+    {
+        return null;
+    }
+
     public function getAttachAttributes($authority = null)
     {
         return [];
     }
+
+    public function onceTo($scope, callable $callback)
+    {
+        //
+    }
+
+    public function remove()
+    {
+        //
+    }
+
+    public function removeOnce(callable $callback)
+    {
+        //
+    }
 }