Added the ability to pass raw values for the order by functions

Author: luisdalmolin

README.md

@@ -258,6 +258,12 @@ You can also sort your query results using a column from another table using the
 User::orderByPowerJoins('profile.city');
 ```
 
+If you need to pass some raw values for the order by function, you can do like this:
+
+```php
+User::orderByPowerJoins(['profile', DB::raw('concat(city, ", ", state)']);
+```
+
 This query will sort the results based on the `city` column on the `user_profiles` table. You can also sort your results by aggregations (`COUNT`, `SUM`, `AVG`, `MIN` or `MAX`).
 
 For instance, to sort users with the highest number of posts, you can do this:

src/PowerJoins.php

@@ -3,10 +3,11 @@
 namespace Kirschbaum\PowerJoins;
 
 use Closure;
+use Illuminate\Support\Str;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Query\Expression;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasManyThrough;
-use Illuminate\Support\Str;
 
 trait PowerJoins
 {
@@ -165,9 +166,15 @@ public function scopeJoinNestedRelationship(Builder $query, $relations, $callbac
      */
     public function scopeOrderByPowerJoins(Builder $query, $sort, $direction = 'asc', $aggregation = null, $joinType = 'join'): void
     {
-        $relationships = explode('.', $sort);
-        $column = array_pop($relationships);
-        $latestRelationshipName = $relationships[count($relationships) - 1];
+        if (is_array($sort)) {
+            $relationships = explode('.', $sort[0]);
+            $column = $sort[1];
+            $latestRelationshipName = $relationships[count($relationships) - 1];
+        } else {
+            $relationships = explode('.', $sort);
+            $column = array_pop($relationships);
+            $latestRelationshipName = $relationships[count($relationships) - 1];
+        }
 
         $query->joinRelationship(implode('.', $relationships), null, $joinType);
 
@@ -188,7 +195,15 @@ public function scopeOrderByPowerJoins(Builder $query, $sort, $direction = 'asc'
                 ->groupBy(sprintf('%s.%s', $this->getModel()->getTable(), $this->getModel()->getKeyName()))
                 ->orderBy(sprintf('%s_aggregation', $latestRelationshipName), $direction);
         } else {
-            $query->orderBy(sprintf('%s.%s', $latestRelationshipModel->getTable(), $column), $direction);
+            if ($column instanceof Expression) {
+                // dd($column);
+                $query->orderBy($column, $direction);
+            } else {
+                $query->orderBy(
+                    sprintf('%s.%s', $latestRelationshipModel->getTable(), $column),
+                    $direction
+                );
+            }
         }
     }
 

tests/OrderByTest.php

@@ -2,9 +2,10 @@
 
 namespace Kirschbaum\PowerJoins\Tests;
 
-use Kirschbaum\PowerJoins\Tests\Models\Comment;
+use Illuminate\Support\Facades\DB;
 use Kirschbaum\PowerJoins\Tests\Models\Post;
 use Kirschbaum\PowerJoins\Tests\Models\User;
+use Kirschbaum\PowerJoins\Tests\Models\Comment;
 use Kirschbaum\PowerJoins\Tests\Models\UserProfile;
 
 class OrderByTest extends TestCase
@@ -24,7 +25,7 @@ public function test_order_by_relationship()
         $users = User::with('profile')->orderByPowerJoins('profile.city')->get();
 
         // making sure left join do not throw exceptions
-        User::with('profile')->OrderByLeftPowerJoins('profile.city')->get();
+        User::with('profile')->orderByLeftPowerJoins('profile.city')->get();
 
         $this->assertEquals('Atlanta', $users->get(0)->profile->city);
         $this->assertEquals('Los Angeles', $users->get(1)->profile->city);
@@ -33,6 +34,21 @@ public function test_order_by_relationship()
         $this->assertEquals('Veneza', $users->get(4)->profile->city);
     }
 
+    /** @test */
+    public function test_order_by_relationship_with_concat()
+    {
+        User::with('profile')
+            ->select('user_profiles.*', DB::raw('printf("%s, %s", user_profiles.city, user_profiles.state) as locale'))
+            ->orderByPowerJoins(['profile', DB::raw('locale')])
+            ->get();
+
+        User::with('profile')
+            ->orderByPowerJoins(['profile', DB::raw('printf("%s, %s", user_profiles.city, user_profiles.state)')])
+            ->get();
+
+        $this->expectNotToPerformAssertions();
+    }
+
     /** @test */
     public function test_can_call_twice_in_a_row()
     {

tests/database/migrations/2020_03_16_000000_create_tables.php

@@ -25,6 +25,7 @@ public function up()
             $table->increments('id');
             $table->unsignedInteger('user_id');
             $table->string('city')->nullable();
+            $table->string('state')->nullable();
             $table->timestamps();
         });