added Statistic model and updated readme

Author: mattkingshott

README.md

@@ -37,12 +37,40 @@ IN
     ('articles', 'projects', 'tasks')
 ```
 
+Or, better still, use the Eloquent model to query the data:
+
+```php
+use Statistics\Models\Statistic;
+
+$stats = Statistic::query()
+    ->whereIn('table', ['articles', 'projects', 'tasks'])
+    ->get(['table', 'values']);
+```
+
 | Table     | Values            |
 | --------- | ----------------- |
 | Articles  | `{ "count" : 6 }` |
 | Projects  | `{ "count" : 3 }` |
 | Tasks     | `{ "count" : 2 }` |
 
+This becomes even more powerful when using joins for individual rows:
+
+```php
+$users = User::query()
+    ->join('statistics', function ($join) {
+        $join->on('users.id', '=', 'statistics.id')
+                ->where('statistics.table', 'users');
+    })
+    ->get(['users.name', DB::raw('`values`->"$.post_count" AS `posts`')])
+    ->orderByRaw('`values`->"$.post_count" DESC')
+```
+
+| Name  | Posts |
+| ----- | ----- |
+| John  | 6     |
+| Fred  | 4     |
+| Dave  | 1     |
+
 ## How does it work?
 
 The package will automatically register and migrate a `statistics` table to your database. This table then serves as a repository for aggregated values. You can then easily join records to this table to get the associated metrics you need.

src/Models/Statistic.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types = 1);
+
+namespace Statistics\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Statistic extends Model
+{
+    protected $guarded = [];
+
+    /**
+     * Get the table associated with the model.
+     *
+     */
+    public function getTable() : string
+    {
+        return config('statistics.table', 'statistics');
+    }
+}

tests/Test.php

@@ -2,8 +2,10 @@
 
 namespace Statistics\Tests;
 
+use Statistics\Models\Statistic;
 use Orchestra\Testbench\TestCase;
-use Illuminate\Support\Facades\DB;
+use Statistics\Tests\Models\Post;
+use Statistics\Tests\Models\User;
 use Statistics\Tests\World\Builder;
 
 class Test extends TestCase
@@ -21,51 +23,51 @@ protected function setUp() : void
         $this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
         $this->loadMigrationsFrom(__DIR__ . '/Migrations');
 
-        DB::table('users')->truncate();
-        DB::table('posts')->truncate();
+        User::truncate();
+        Post::truncate();
     }
 
     /** @test */
     public function it_creates_triggers_for_inserted_and_deleted_user_records() : void
     {
-        $this->assertCount(0, DB::table('statistics')->get());
+        $this->assertCount(0, Statistic::get());
 
-        DB::table('users')->insert(['id' => 1, 'name' => 'John Doe']);
+        User::insert(['id' => 1, 'name' => 'John Doe']);
 
-        $this->assertCount(2, DB::table('statistics')->get());
+        $this->assertCount(2, Statistic::get());
 
-        $statistics = DB::table('statistics')
+        $statistics = Statistic::query()
             ->orderBy('table')
             ->orderBy('id')
             ->get();
 
-        $this->assertEquals('', $statistics[0]->id);
+        $this->assertEquals('', $statistics[0]->getRawOriginal('id'));
         $this->assertEquals('users', $statistics[0]->table);
         $this->assertEquals(['count' => 1], json_decode($statistics[0]->values, true));
 
-        $this->assertEquals('1', $statistics[1]->id);
+        $this->assertEquals('1', $statistics[1]->getRawOriginal('id'));
         $this->assertEquals('users', $statistics[1]->table);
         $this->assertEquals(['post_sum_likes' => '', 'post_count' => ''], json_decode($statistics[1]->values, true));
 
-        DB::table('users')->delete();
+        User::query()->delete();
 
-        $this->assertCount(1, DB::table('statistics')->get());
+        $this->assertCount(1, Statistic::get());
 
-        $this->assertEquals('', DB::table('statistics')->first()->id);
-        $this->assertEquals('users', DB::table('statistics')->first()->table);
-        $this->assertEquals(['count' => 0], json_decode(DB::table('statistics')->first()->values, true));
+        $this->assertEquals('', Statistic::first()->getRawOriginal('id'));
+        $this->assertEquals('users', Statistic::first()->table);
+        $this->assertEquals(['count' => 0], json_decode(Statistic::first()->values, true));
     }
 
     /** @test */
     public function it_creates_triggers_and_statistics_for_seeded_records() : void
     {
         Builder::seed();
 
-        $this->assertCount(2, DB::table('users')->get());
-        $this->assertCount(8, DB::table('posts')->get());
-        $this->assertCount(4, DB::table('statistics')->get());
+        $this->assertCount(2, User::get());
+        $this->assertCount(8, Post::get());
+        $this->assertCount(4, Statistic::get());
 
-        $statistics = DB::table('statistics')
+        $statistics = Statistic::query()
             ->orderBy('table')
             ->orderBy('id')
             ->get();
@@ -78,19 +80,19 @@ public function it_creates_triggers_and_statistics_for_seeded_records() : void
             'likes_sum' => 22,
         ];
 
-        $this->assertEquals('', $statistics[0]->id);
+        $this->assertEquals('', $statistics[0]->getRawOriginal('id'));
         $this->assertEquals('posts', $statistics[0]->table);
         $this->assertEquals($expected, json_decode($statistics[0]->values, true));
 
-        $this->assertEquals('', $statistics[1]->id);
+        $this->assertEquals('', $statistics[1]->getRawOriginal('id'));
         $this->assertEquals('users', $statistics[1]->table);
         $this->assertEquals(['count' => 2], json_decode($statistics[1]->values, true));
 
-        $this->assertEquals('1', $statistics[2]->id);
+        $this->assertEquals('1', $statistics[2]->getRawOriginal('id'));
         $this->assertEquals('users', $statistics[2]->table);
         $this->assertEquals(['post_sum_likes' => 8, 'post_count' => 4], json_decode($statistics[2]->values, true));
 
-        $this->assertEquals('2', $statistics[3]->id);
+        $this->assertEquals('2', $statistics[3]->getRawOriginal('id'));
         $this->assertEquals('users', $statistics[3]->table);
         $this->assertEquals(['post_sum_likes' => 14, 'post_count' => 4], json_decode($statistics[3]->values, true));
     }