finishing beforeHandler feature

Author: freekmurze

README.md

@@ -122,12 +122,21 @@ public function getActivityDescriptionForEvent($eventName)
 ```
 The result of this function will be logged, unless the result is an empty string.
 
-### Disable logging under certain conditions
-If you want to disable logging under certain conditions, such as for a specific user, create a class in your application namespace that implements the `Spatie\Activitylog\Handlers\BeforeHandlerInterface`. This interface defines an `ignore()` method in which you can code any custom logic to determine whether logging should be ignored or not. Returning `true` from this function will ignore logging, returning `false` will continue with the logging. Add the namespaced class name to the `beforeCallback` field in the configuration file:
+### Using a before handler.
+If you want to disable logging under certain conditions, 
+such as for a specific user, create a class in your application
+namespace that implements the `Spatie\Activitylog\Handlers\BeforeHandlerInterface`. 
+
+This  interface defines an `shouldLog()` method in which you can code any custom logic to determine
+whether logging should be ignored or not. You must return `true` the call should be logged.
+ 
+To en the namespaced class nameto the `beforeHandler` field in the configuration file:
 ```php
-'beforeCallback' => '\App\Handlers\BeforeHandler',
+'beforeHandler' => '\App\Handlers\BeforeHandler',
 ```
-For example, this callback class could look like this to disable logging for the first user:
+
+For example, this callback class could look like this to disable
+logging a user with id of 1:
 ```php
 <?php
 
@@ -137,14 +146,11 @@ use Spatie\Activitylog\Handlers\BeforeHandlerInterface;
 
 class BeforeHandler implements BeforeHandlerInterface
 {
-    public function ignore()
+    public function shouldLog($text, $userId)
 	{
-		if (\Auth::user()->id == 1)
-		{
-			return true;
-		}
-
-		return false;
+		if ($userId == 1) return false;
+		
+		return true;
 	}
 }
 ```

src/Spatie/Activitylog/ActivitylogSupervisor.php

@@ -25,11 +25,10 @@ class ActivitylogSupervisor
      * Also register Laravels Log Handler if needed.
      *
      * @param Handlers\ActivitylogHandlerInterface $logHandler
-     * @param Handlers\BeforeHandlerInterface      $beforeHandler
      * @param Repository                           $config
      * @param Guard                                $auth
      */
-    public function __construct(Handlers\ActivitylogHandlerInterface $logHandler, Handlers\BeforeHandler $beforeHandler, Repository $config, Guard $auth)
+    public function __construct(Handlers\ActivitylogHandlerInterface $logHandler, Repository $config, Guard $auth)
     {
         $this->config = $config;
 
@@ -39,12 +38,6 @@ public function __construct(Handlers\ActivitylogHandlerInterface $logHandler, Ha
             $this->logHandlers[] = new DefaultLaravelHandler();
         }
 
-        if ($beforeCallback = $this->config->get('activitylog.beforeCallback')) {
-            $this->beforeHandler = new $beforeCallback;
-        } else {
-            $this->beforeHandler = $beforeHandler;
-        }
-
         $this->auth = $auth;
     }
 
@@ -58,12 +51,12 @@ public function __construct(Handlers\ActivitylogHandlerInterface $logHandler, Ha
      */
     public function log($text, $userId = '')
     {
-        if ($this->beforeHandler->ignore()) {
+        $userId = $this->normalizeUserId($userId);
+
+        if (! $this->shouldLogCall($text, $userId)) {
             return false;
         }
 
-        $userId = $this->normalizeUserId($userId);
-
         $ipAddress = Request::getClientIp();
 
         foreach ($this->logHandlers as $logHandler) {
@@ -114,4 +107,23 @@ public function normalizeUserId($userId)
 
         return '';
     }
+
+    /**
+     * Determine if this call should be logged.
+     *
+     * @param $text
+     * @param $userId
+     *
+     * @return bool
+     */
+    protected function shouldLogCall($text, $userId)
+    {
+        $beforeHandler = $this->config('activitylog.beforeHandler');
+
+        if (is_null($beforeHandler) || $beforeHandler == '') {
+            return true;
+        }
+
+        return app($beforeHandler)->shouldLog($text, $userId);
+    }
 }

src/Spatie/Activitylog/Handlers/BeforeHandler.php

@@ -5,9 +5,12 @@
 interface BeforeHandlerInterface
 {
     /**
-     * Don't log if this function returns true.
+     * Call to the log will only be made if this function returns true.
+     *
+     * @param string   $text   The text that will be logged
+     * @param int|null $userId The id of the user that is  associated with the log call
      *
      * @return bool
      */
-    public function ignore();
+    public function shouldLog($text, $userId);
 }

src/Spatie/Activitylog/Handlers/BeforeHandlerInterface.php

@@ -45,5 +45,5 @@
     | reference it here.
     |
     */
-    'beforeCallback' => null,
+    'beforeHandler' => null,
 ];

src/config/activitylog.php

@@ -1,6 +1,5 @@
 <?php
 
-use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Auth as Auth;
 use Spatie\Activitylog\ActivitylogSupervisor;
 
@@ -13,12 +12,11 @@ class ActivityLogSupervistorTest extends PHPUnit_Framework_TestCase
     public function setUp()
     {
         $this->logHandler = Mockery::mock('\Spatie\Activitylog\Handlers\EloquentHandler');
-        $this->beforeHandler = Mockery::mock('\Spatie\Activitylog\Handlers\BeforeHandler');
         $this->config = Mockery::mock('\Illuminate\Config\Repository');
         $this->auth = Mockery::mock('Illuminate\Auth\Guard');
 
         $this->config->shouldReceive('get')->andReturn(false);
-        $this->activityLogSupervisor = new ActivitylogSupervisor($this->logHandler, $this->beforeHandler, $this->config, $this->auth);
+        $this->activityLogSupervisor = new ActivitylogSupervisor($this->logHandler, $this->config, $this->auth);
     }
 
     /**