Sprunjes should not use joins in filters

we need to be able to wrap custom filter methods in orWhere callbacks,
but unfortunately this breaks the usage of joins within those filter
methods

Author: alexweissman

app/sprinkles/admin/src/Sprunje/ActivitySprunje.php

@@ -35,19 +35,14 @@ class ActivitySprunje extends Sprunje
 
     protected $name = 'activities';
 
-    /**
-     * @var bool Keep track of whether the users table has already been joined on the query.
-     */
-    protected $joinedUsers = false;
-
     /**
      * Set the initial query used by your Sprunje.
      */
     protected function baseQuery()
     {
         $query = $this->classMapper->createInstance('activity');
 
-        return $query;
+        return $query->joinUser();
     }
 
     /**
@@ -75,12 +70,6 @@ protected function applyTransformations($collection)
      */
     protected function filterUser($query, $value)
     {
-        if (!$this->joinedUsers) {
-            $query = $query->joinUser();
-        }
-
-        $this->joinedUsers = true;
-
         // Split value on separator for OR queries
         $values = explode($this->orSeparator, $value);
         return $query->where(function ($query) use ($values) {
@@ -102,12 +91,6 @@ protected function filterUser($query, $value)
      */
     protected function sortUser($query, $direction)
     {
-        if (!$this->joinedUsers) {
-            $query = $query->joinUser();
-        }
-
-        $this->joinedUsers = true;
-
         return $query->orderBy('users.last_name', $direction);
     }
 }

app/sprinkles/core/src/Sprunje/Sprunje.php

@@ -267,8 +267,10 @@ protected function applyFilters()
                 $e->addUserMessage('VALIDATE.SPRUNJE.BAD_FILTER', ['name' => $name]);
                 throw $e;
             }
-            // Set orFilter to 'false' to require a match on _all_ fields
-            $this->query = $this->buildFilterQuery($this->query, $name, $value, false);
+            // Since we want to match _all_ of the fields, we wrap the field callback in a 'where' callback
+            $this->query = $this->query->where(function ($fieldQuery) use ($name, $value) {
+                return $this->buildFilterQuery($fieldQuery, $name, $value);
+            });
         }
 
         return $this->query;
@@ -285,7 +287,10 @@ protected function filterAll($query, $value)
     {
         foreach ($this->filterable as $name) {
             if (studly_case($name) != 'all' && !in_array($name, $this->excludeForAll)) {
-                $query = $this->buildFilterQuery($query, $name, $value, true);
+                // Since we want to match _any_ of the fields, we wrap the field callback in a 'orWhere' callback
+                $query = $query->orWhere(function ($fieldQuery) use ($name, $value) {
+                    return $this->buildFilterQuery($fieldQuery, $name, $value);
+                });
             }
         }
 
@@ -300,25 +305,15 @@ protected function filterAll($query, $value)
      * @param mixed $value
      * @return Builder
      */
-    protected function buildFilterQuery($query, $name, $value, $orFilter = true)
+    protected function buildFilterQuery($query, $name, $value)
     {
         $methodName = 'filter'.studly_case($name);
 
         // Determine if a custom filter method has been defined
         if (method_exists($this, $methodName)) {
             $query = $this->$methodName($query, $value);
         } else {
-            if ($orFilter) {
-                // Since we want to match _any_ of the fields, we wrap the field callback in a 'orWhere' callback
-                $query = $query->orWhere(function ($fieldQuery) use ($name, $value) {
-                    return $this->buildFilterDefaultFieldQuery($fieldQuery, $name, $value);
-                });
-            } else {
-                // Since we want to match _all_ of the fields, we wrap the field callback in a 'where' callback
-                $query = $query->where(function ($fieldQuery) use ($name, $value) {
-                    return $this->buildFilterDefaultFieldQuery($fieldQuery, $name, $value);
-                });
-            }
+            return $this->buildFilterDefaultFieldQuery($query, $name, $value);
         }
 
         return $query;