feat: Add scopes to Analytics, add AnalyticsRepostiory.

Author: owenconti

src/Models/Analytics.php

@@ -2,6 +2,7 @@
 
 namespace OhSeeSoftware\LaravelServerAnalytics\Models;
 
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use OhSeeSoftware\LaravelServerAnalytics\ServerAnalytics;
 
@@ -49,6 +50,52 @@ public function addMeta(string $key, $value): AnalyticsMeta
         return $meta;
     }
 
+    /**
+     * Scopes the query to include Analytics records
+     * that are related to the given Model.
+     *
+     * @param Builder $builder
+     * @param Model $model
+     * @return void
+     */
+    public function scopeRelatedTo(Builder $builder, Model $model)
+    {
+        $builder->whereHas('relations', function ($query) use ($model) {
+            $query->where('relation_type', get_class($model))->where('relation_id', $model->id);
+        });
+    }
+
+    /**
+     * Scopes the query to include Analytics records
+     * that have meta data with the given key/value.
+     *
+     * @param Builder $builder
+     * @param string $key
+     * @param mixed $value
+     * @return void
+     */
+    public function scopeWithMetaValue(Builder $builder, string $key, $value)
+    {
+        $builder->whereHas('meta', function ($query) use ($key, $value) {
+            $query->where('key', $key)->where('value', $value);
+        });
+    }
+
+    /**
+     * Scopes the query to include Analytics records
+     * that have meta records with the given key.
+     *
+     * @param Builder $builder
+     * @param string $key
+     * @return void
+     */
+    public function scopeHasMeta(Builder $builder, string $key)
+    {
+        $builder->whereHas('meta', function ($query) use ($key) {
+            $query->where('key', $key);
+        });
+    }
+
     public function relations()
     {
         return $this->hasMany(AnalyticsRelation::class);

src/Repositories/AnalyticsRepository.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace OhSeeSoftware\LaravelServerAnalytics\Repositories;
+
+use Illuminate\Database\Eloquent\Builder;
+use OhSeeSoftware\LaravelServerAnalytics\Models\Analytics;
+
+class AnalyticsRepository
+{
+    /**
+     * Returns a new Eloquent query builder
+     * instance for Analytics records.
+     *
+     * @return Builder
+     */
+    public function query(): Builder
+    {
+        return Analytics::query();
+    }
+
+    /**
+     * Method to find Analytics records by
+     * the given column/value.
+     *
+     * @param string $column
+     * @param mixed $value
+     * @return Builder
+     */
+    public function findBy(string $column, $value, string $comparator = '='): Builder
+    {
+        return $this->query()->where($column, $comparator, $value);
+    }
+}

tests/Models/AnalyticsModelTest.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace OhSeeSoftware\LaravelServerAnalytics\Tests\Models;
+
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use OhSeeSoftware\LaravelServerAnalytics\Models\Analytics;
+use OhSeeSoftware\LaravelServerAnalytics\Repositories\AnalyticsRepository;
+use OhSeeSoftware\LaravelServerAnalytics\Tests\TestCase;
+
+class AnalyticsModelTest extends TestCase
+{
+    use RefreshDatabase;
+
+    /** @var Analytics */
+    public $analytics;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->analytics = factory(Analytics::class)->create();
+    }
+
+    /** @test */
+    public function it_scopes_related_entities()
+    {
+        $relatedAnalytics = factory(Analytics::class)->create();
+
+        $this->assertCount(0, Analytics::relatedTo($relatedAnalytics)->get());
+
+        $this->analytics->addRelation($relatedAnalytics);
+        $this->assertCount(1, Analytics::relatedTo($relatedAnalytics)->get());
+    }
+
+    /** @test */
+    public function it_scopes_analytics_that_have_meta_with_key()
+    {
+        $this->analytics->addMeta('foo', 'bar');
+
+        $this->assertCount(0, Analytics::hasMeta('bar')->get());
+        $this->assertCount(1, Analytics::hasMeta('foo')->get());
+    }
+
+    /** @test */
+    public function it_scopes_analytics_that_have_specific_meta_value()
+    {
+        $this->analytics->addMeta('foo', 'bar');
+
+        $this->assertCount(0, Analytics::withMetaValue('foo', 'invalid')->get());
+        $this->assertCount(1, Analytics::withMetaValue('foo', 'bar')->get());
+    }
+}

tests/Repositories/AnalyticsRepositoryTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace OhSeeSoftware\LaravelServerAnalytics\Tests\Repositories;
+
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use OhSeeSoftware\LaravelServerAnalytics\Models\Analytics;
+use OhSeeSoftware\LaravelServerAnalytics\Repositories\AnalyticsRepository;
+use OhSeeSoftware\LaravelServerAnalytics\Tests\TestCase;
+
+class AnalyticsRepositoryTest extends TestCase
+{
+    use RefreshDatabase;
+
+    /** @var Analytics */
+    public $analytics;
+
+    /** @var AnalyticsRepository */
+    public $repository;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->analytics = factory(Analytics::class)->create();
+        $this->repository = resolve(AnalyticsRepository::class);
+    }
+
+    /** @test */
+    public function it_finds_analytics()
+    {
+        $this->assertCount(1, $this->repository->findBy('path', $this->analytics->path)->get());
+        $this->assertCount(1, $this->repository->findBy('method', $this->analytics->method)->get());
+        $this->assertCount(1, $this->repository->findBy('status_code', $this->analytics->status_code)->get());
+    }
+
+    /** @test */
+    public function it_finds_analytics_with_custom_comparator()
+    {
+        $this->analytics->update(['duration_ms' => 500]);
+
+        $this->assertCount(0, $this->repository->findBy('duration_ms', 250, '<=')->get());
+        $this->assertCount(1, $this->repository->findBy('duration_ms', 250, '>=')->get());
+    }
+}