Merge pull request #37 from hammerstonedev/af-with-sum

Fix selects that include bindings

Author: aarondfrancis

src/FastPaginate.php

@@ -7,7 +7,6 @@
 
 use Closure;
 use Illuminate\Database\Query\Expression;
-use Illuminate\Pagination\Paginator;
 
 class FastPaginate
 {
@@ -55,7 +54,11 @@ protected function paginate(string $paginationMethod, Closure $paginatorOutput)
             $key = $model->getKeyName();
             $table = $model->getTable();
 
-            $innerSelectColumns = FastPaginate::getInnerSelectColumns($this);
+            try {
+                $innerSelectColumns = FastPaginate::getInnerSelectColumns($this);
+            } catch (QueryIncompatibleWithFastPagination $e) {
+                return $this->{$paginationMethod}($perPage, $columns, $pageName, $page);
+            }
 
             // This is the copy of the query that becomes
             // the inner query that selects keys only.
@@ -72,7 +75,7 @@ protected function paginate(string $paginationMethod, Closure $paginatorOutput)
             // Get the key values from the records on the current page without mutating them.
             $ids = $paginator->getCollection()->map->getRawOriginal($key)->toArray();
 
-            if ($model->getKeyType() === 'int') {
+            if (in_array($model->getKeyType(), ['int', 'integer'])) {
                 $this->query->whereIntegerInRaw("$table.$key", $ids);
             } else {
                 $this->query->whereIn("$table.$key", $ids);
@@ -90,6 +93,8 @@ protected function paginate(string $paginationMethod, Closure $paginatorOutput)
     /**
      * @param $builder
      * @return array
+     *
+     * @throws QueryIncompatibleWithFastPagination
      */
     public static function getInnerSelectColumns($builder)
     {
@@ -123,6 +128,11 @@ public static function getInnerSelectColumns($builder)
                 // Otherwise we don't.
                 return false;
             })
+            ->each(function ($column) {
+                if (str_contains($column, '?')) {
+                    throw new QueryIncompatibleWithFastPagination;
+                }
+            })
             ->prepend("$table.$key")
             ->unique()
             ->values()

src/QueryIncompatibleWithFastPagination.php

@@ -0,0 +1,10 @@
+<?php
+/**
+ * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
+ */
+
+namespace Hammerstone\FastPaginate;
+
+class QueryIncompatibleWithFastPagination extends \Exception
+{
+}

tests/Integration/BaseTest.php

@@ -40,6 +40,7 @@ protected function setUp(): void
             $table->id();
             $table->integer('user_id');
             $table->string('name');
+            $table->integer('views');
         });
 
         Schema::create('notifications', function (Blueprint $table) {
@@ -62,6 +63,7 @@ protected function setUp(): void
             DB::table('posts')->insert([[
                 'name' => "Post $i",
                 'user_id' => $i,
+                'views' => 1,
             ]]);
 
             DB::table('notifications')->insert([[

tests/Integration/BuilderTest.php

@@ -351,4 +351,38 @@ public function basic_simple_test_from_relation()
         $this->assertFalse($results->hasMorePages());
         $this->assertEquals(1, $results->currentPage());
     }
+
+    /** @test */
+    public function with_sum_has_the_correct_number_of_parameters()
+    {
+        $queries = $this->withQueriesLogged(function () use (&$fast, &$regular) {
+            $fast = User::query()
+                ->withSum([
+                    'posts as views_count' => function ($query) {
+                        $query->where('views', '>', 0);
+                    },
+                ], 'views')
+                ->orderBy('views_count')
+                ->fastPaginate();
+
+            $regular = User::query()
+                ->withSum([
+                    'posts as views_count' => function ($query) {
+                        $query->where('views', '>', 0);
+                    },
+                ], 'views')
+                ->orderBy('views_count')
+                ->paginate();
+        });
+
+        $this->assertEquals($queries[0]['query'], $queries[2]['query']);
+        $this->assertEquals($queries[0]['bindings'], $queries[2]['bindings']);
+
+        $this->assertEquals($queries[1]['query'], $queries[3]['query']);
+        $this->assertEquals($queries[1]['bindings'], $queries[3]['bindings']);
+
+        $this->assertEquals($fast->toArray(), $regular->toArray());
+
+        $this->assertEquals(get_class($fast), get_class($regular));
+    }
 }