Added support for scopes

Signed-off-by: Gertjan Roke <[email protected]>

Author: GertjanRoke

.github/FUNDING.yml

@@ -1 +1 @@
-github: :vendor_name
+github: GertjanRoke

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,8 @@
 blank_issues_enabled: false
 contact_links:
-    - name: Ask a question
-      url: https://github.com/:vendor_slug/:package_slug/discussions/new?category=q-a
-      about: Ask the community for help
     - name: Request a feature
-      url: https://github.com/:vendor_slug/:package_slug/discussions/new?category=ideas
+      url: https://github.com/GertjanRoke/laravel-db-model/issues/new
       about: Share ideas for new features
     - name: Report a bug
-      url: https://github.com/:vendor_slug/:package_slug/issues/new
+      url: https://github.com/GertjanRoke/laravel-db-model/issues/new
       about: Report a reproducable bug

.github/SECURITY.md

@@ -1,3 +1,3 @@
 # Security Policy
 
-If you discover any security related issues, please email author@domain.com instead of using the issue tracker.
+If you discover any security related issues, please email g.a.roke90@gmail.com instead of using the issue tracker.

README.md

@@ -26,10 +26,68 @@ use GertjanRoke\LaravelDbModel\DBModel;
 
 class Post extends DBModel
 {
-    public $table = 'posts';
+    // public $table = 'posts';
 
     // public $connection = 'mysql';
 }
+```
+If no table name was given it will guess it based on the class name just like the Eloquent model those.  
+Same for the connection, if none is set it will use the default connection.
+
+## How to extend custom scopes
+It's basically the same as for Eloquent models, you would need to prefix the methods with `scope`  
+```php
+...
+
+class Post extends DBModel
+{
+    public function scopeActive()
+    {
+        $this->db->where('active', true);
+
+        return $this;
+    }
+}
+```
+
+## Some examples
+
+You can easly create short functions for basic where's or even more complex queries so you have it always in one location instead of everywhere in your code base.
+```php
+<?php
+
+namespace App\Models;
+
+use App\Models\Comment;
+use GertjanRoke\LaravelDbModel\DBModel;
+
+class Post extends DBModel
+{
+    public function scopeActive(): self
+    {
+        $this->db->where('active', true);
+
+        return $this;
+    }
+    
+    public function scopeWithLatestComment(): self
+    {
+        $postTable = $this->getTable();
+        $commentTable = (new Comment())->getTable();
+        
+        $this->db->join($commentTable, "{$commentTable}.post_id", '=', "{$postTable}.id")
+            ->addSelect("{$commentTable}.body");
+
+        return $this;
+    }
+}
+
+// Inside your controller
+$post = Post::active()->withLatestComment()->latest()->first();
+
+// Keep in mind the order of calling methods doesn't matter as long as the method before returned the builder instance.
+// Like this example will return the same result as the query above.
+$post = Post::active()->latest()->withLatestComment()->first();
 
 ```
 

composer.json

@@ -40,7 +40,7 @@
     },
     "scripts": {
         "test": "./vendor/bin/pest --no-coverage",
-        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+        "test-coverage": "./vendor/bin/pest --coverage-html coverage"
     },
     "config": {
         "sort-packages": true

src/DBModel.php

@@ -50,6 +50,11 @@ public function getDB(): Builder
      */
     public function __call($method, $parameters)
     {
+        $scopeMethod = (string) Str::of($method)->ucfirst()->prepend('scope');
+        if (method_exists(static::class, $scopeMethod)) {
+            return $this->$scopeMethod(...$parameters);
+        }
+
         $response = $this->db->$method(...$parameters);
 
         return ($response instanceof Builder) ? $this : $response;

tests/MethodCallingTest.php

@@ -21,3 +21,15 @@
 
     expect($returned)->toBeInstanceOf(Collection::class);
 });
+
+it("doesn't matter in which order you call the query methods", function () {
+    $grammer = (new Model())->getDB()->grammar;
+
+    $query = Model::where('title', 'Hello World')->active()->toSql();
+
+    expect($query)->toEndWith($grammer->wrap('title') . ' = ? and ' . $grammer->wrap('active') . ' = ?');
+
+    $query = Model::active()->where('title', 'Hello World')->toSql();
+
+    expect($query)->toEndWith($grammer->wrap('active') . ' = ? and ' . $grammer->wrap('title') . ' = ?');
+});

tests/Models/Model.php

@@ -6,5 +6,10 @@
 
 class Model extends DBModel
 {
-    public $table = 'models';
+    public function scopeActive(): self
+    {
+        $this->db->where('active', true);
+
+        return $this;
+    }
 }

tests/migrations/ModelTableMigration.php

@@ -12,6 +12,7 @@ public function up()
         Schema::create('models', function(Blueprint $table) {
             $table->id();
             $table->string('title')->nullable();
+            $table->boolean('active')->default(false);
             $table->timestamps();
         });
     }