Added statistics module

UPGRADE.md

@@ -9,7 +9,7 @@ The fastest way to upgrade is to run the following commands from your repos root
 * cp  $ATHENIA_REPO/.env.example ./
 * rsync -arv $ATHENIA_REPO/dockerfiles ./
 * rsync -arv $ATHENIA_REPO/extras ./
-* rsync -arv $ATHENIA_REPO/code ./ --exclude vendor  --exclude storage  --exclude '.env'
+* rsync -arv $ATHENIA_REPO/code ./ --exclude vendor  --exclude storage  --exclude '.env' --exclude code/app/Providers
 
 After that, you always want to make sure you inspect all changes, and you still want to go through the change log to check for moved files and deleted files, as rsync cannot check for deleted files, since it would delete any files created for the child application.
 

code/app/Athenia/Contracts/Models/CanBeAggregatedContract.php

@@ -0,0 +1,20 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Contracts\Models;
+
+/**
+ * Interface CanBeAggregatedContract
+ * @package App\Athenia\Contracts\Models
+ */
+interface CanBeAggregatedContract
+{
+    /**
+     * Returns the relation paths to the models that can be target statistics
+     * For example: ["collectionItem.collection"] would mean this model affects statistics on collections
+     * through the collectionItem relation
+     *
+     * @return string[]
+     */
+    public function getStatisticTargetRelationPath(): array;
+} 

code/app/Athenia/Contracts/Models/CanBeStatisticTargetContract.php

@@ -0,0 +1,21 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Contracts\Models;
+
+use App\Models\Statistics\TargetStatistic;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+
+/**
+ * Interface CanBeStatisticTargetContract
+ * @package App\Athenia\Contracts\Models
+ */
+interface CanBeStatisticTargetContract extends CanBeMorphedToContract
+{
+    /**
+     * Gets all statistics that belong to this model through a morph many relationship
+     *
+     * @return MorphMany
+     */
+    public function targetStatistics(): MorphMany;
+} 

code/app/Athenia/Contracts/Repositories/Statistics/StatisticFilterRepositoryContract.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Athenia\Contracts\Repositories\Statistics;
+
+use App\Athenia\Contracts\Repositories\BaseRepositoryContract;
+
+interface StatisticFilterRepositoryContract extends BaseRepositoryContract
+{} 

code/app/Athenia/Contracts/Repositories/Statistics/StatisticRepositoryContract.php

@@ -0,0 +1,13 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Contracts\Repositories\Statistics;
+
+use App\Athenia\Contracts\Repositories\BaseRepositoryContract;
+
+/**
+ * Interface StatisticRepositoryContract
+ */
+interface StatisticRepositoryContract extends BaseRepositoryContract
+{
+} 

code/app/Athenia/Contracts/Repositories/Statistics/TargetStatisticRepositoryContract.php

@@ -0,0 +1,43 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Contracts\Repositories\Statistics;
+
+use App\Athenia\Contracts\Repositories\BaseRepositoryContract;
+use App\Models\Statistics\TargetStatistic;
+use Illuminate\Database\Eloquent\Model;
+use App\Athenia\Contracts\Models\CanBeStatisticTargetContract;
+use Illuminate\Database\Eloquent\Collection;
+
+/**
+ * Interface TargetStatisticRepositoryContract
+ * @package App\Athenia\Contracts\Repositories\Statistics
+ */
+interface TargetStatisticRepositoryContract extends BaseRepositoryContract
+{
+    /**
+     * Creates a new target statistic model
+     *
+     * @param CanBeStatisticTargetContract $target
+     * @param array $data
+     * @return TargetStatistic
+     */
+    public function createForTarget(CanBeStatisticTargetContract $target, array $data): TargetStatistic;
+
+    /**
+     * Find all statistics for a specific target
+     *
+     * @param CanBeStatisticTargetContract $target
+     * @return Collection
+     */
+    public function findAllForTarget(CanBeStatisticTargetContract $target): Collection;
+
+    /**
+     * Find a specific statistic for a target
+     *
+     * @param CanBeStatisticTargetContract $target
+     * @param int $statisticId
+     * @return TargetStatistic|null
+     */
+    public function findForTarget(CanBeStatisticTargetContract $target, int $statisticId): ?TargetStatistic;
+} 

code/app/Athenia/Contracts/Services/Relations/RelationTraversalServiceContract.php

@@ -0,0 +1,23 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Contracts\Services\Relations;
+
+use App\Athenia\Models\BaseModelAbstract;
+use Illuminate\Database\Eloquent\Collection;
+
+/**
+ * Interface RelationTraversalServiceContract
+ * @package App\Athenia\Contracts\Services\Relations
+ */
+interface RelationTraversalServiceContract
+{
+    /**
+     * Traverses the relations on a model and returns all related models
+     *
+     * @param BaseModelAbstract $model
+     * @param string $relationPath
+     * @return Collection
+     */
+    public function traverseRelations(BaseModelAbstract $model, string $relationPath): Collection;
+} 

code/app/Athenia/Contracts/Services/Statistics/StatisticSynchronizationServiceContract.php

@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Contracts\Services\Statistics;
+
+use App\Athenia\Contracts\Models\CanBeStatisticTargetContract;
+use App\Models\Statistics\TargetStatistic;
+use Illuminate\Database\Eloquent\Collection;
+use App\Models\Statistics\Statistic;
+
+/**
+ * Interface StatisticSynchronizationServiceContract
+ * @package App\Athenia\Contracts\Services\Statistics
+ */
+interface StatisticSynchronizationServiceContract
+{
+    /**
+     * Takes in a model that can be a statistic target, and ensures that all necessary target
+     * statistics exist for that model based on the available statistics for its type
+     *
+     * @param CanBeStatisticTargetContract $model
+     * @return Collection|TargetStatistic[]
+     */
+    public function synchronizeTargetStatistics(CanBeStatisticTargetContract $model): Collection;
+
+    /**
+     * Create target statistics for a newly created statistic.
+     *
+     * @param Statistic $statistic
+     * @return Collection|TargetStatistic[]
+     */
+    public function createTargetStatisticsForStatistic(Statistic $statistic): Collection;
+} 

code/app/Athenia/Contracts/Services/Statistics/TargetStatisticProcessingServiceContract.php

@@ -0,0 +1,21 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Contracts\Services\Statistics;
+
+use App\Models\Statistics\TargetStatistic;
+
+/**
+ * Interface TargetStatisticProcessingServiceContract
+ * @package App\Athenia\Contracts\Services\Statistics
+ */
+interface TargetStatisticProcessingServiceContract
+{
+    /**
+     * Processes a single target statistic and updates its result
+     *
+     * @param TargetStatistic $targetStatistic
+     * @return void
+     */
+    public function processSingleTargetStatistic(TargetStatistic $targetStatistic): void;
+} 

code/app/Athenia/Events/Statistics/StatisticCreatedEvent.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Athenia\Events\Statistics;
+
+use App\Models\Statistics\Statistic;
+
+class StatisticCreatedEvent
+{
+    public function __construct(
+        private readonly Statistic $statistic
+    ) {}
+
+    public function getStatistic(): Statistic
+    {
+        return $this->statistic;
+    }
+} 

code/app/Athenia/Events/Statistics/StatisticDeletedEvent.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Athenia\Events\Statistics;
+
+use App\Models\Statistics\Statistic;
+
+class StatisticDeletedEvent
+{
+    public function __construct(
+        private readonly Statistic $statistic
+    ) {}
+
+    public function getStatistic(): Statistic
+    {
+        return $this->statistic;
+    }
+} 

code/app/Athenia/Events/Statistics/StatisticUpdatedEvent.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Athenia\Events\Statistics;
+
+use App\Models\Statistics\Statistic;
+
+class StatisticUpdatedEvent
+{
+    public function __construct(
+        private readonly Statistic $statistic
+    ) {}
+
+    public function getStatistic(): Statistic
+    {
+        return $this->statistic;
+    }
+} 

code/app/Athenia/Http/Core/Controllers/BaseControllerAbstract.php

@@ -47,10 +47,6 @@
  *     description="Any routes related to foreground asset models."
  * )
  * @SWG\Tag(
- *     name="AudioClips",
- *     description="Any routes related to audio clip asset models."
- * )
- * @SWG\Tag(
  *     name="Users",
  *     description="Any information that is related to the user object of the app"
  * )

code/app/Athenia/Http/Core/Controllers/StatisticControllerAbstract.php

@@ -0,0 +1,93 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Athenia\Http\Core\Controllers;
+
+use App\Athenia\Contracts\Repositories\Statistics\StatisticRepositoryContract;
+use App\Athenia\Http\Core\Controllers\Traits\HasIndexRequests;
+use App\Http\Core\Requests;
+use App\Models\Statistics\Statistic;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class StatisticControllerAbstract
+ * @package App\Athenia\Http\Core\Controllers
+ */
+abstract class StatisticControllerAbstract extends BaseControllerAbstract
+{
+    use HasIndexRequests;
+
+    /**
+     * @var StatisticRepositoryContract
+     */
+    protected $repository;
+
+    /**
+     * StatisticControllerAbstract constructor.
+     * @param StatisticRepositoryContract $repository
+     */
+    public function __construct(StatisticRepositoryContract $repository)
+    {
+        $this->repository = $repository;
+    }
+
+    /**
+     * Display a listing of the resource
+     *
+     * @param Requests\Statistics\IndexRequest $request
+     * @return JsonResponse
+     */
+    public function index(Requests\Statistics\IndexRequest $request)
+    {
+        return $this->repository->findAll($this->filter($request), $this->search($request), $this->order($request), $this->expand($request), $this->limit($request), [], (int)$request->input('page', 1));
+    }
+
+    /**
+     * Creates a Statistic model
+     *
+     * @param Requests\Statistics\StoreRequest $request
+     * @return JsonResponse
+     */
+    public function store(Requests\Statistics\StoreRequest $request)
+    {
+        $model = $this->repository->create($request->json()->all());
+        return response($model, 201);
+    }
+
+    /**
+     * View a single Statistic model
+     *
+     * @param Requests\Statistics\ViewRequest $request
+     * @param Statistic $statistic
+     * @return JsonResponse
+     */
+    public function show(Requests\Statistics\ViewRequest $request, Statistic $statistic)
+    {
+        return $statistic->load($this->expand($request));
+    }
+
+    /**
+     * Updates a Statistic model
+     *
+     * @param Requests\Statistics\UpdateRequest $request
+     * @param Statistic $statistic
+     * @return JsonResponse
+     */
+    public function update(Requests\Statistics\UpdateRequest $request, Statistic $statistic)
+    {
+        return $this->repository->update($statistic, $request->json()->all());
+    }
+
+    /**
+     * Deletes a Statistic model
+     *
+     * @param Requests\Statistics\DeleteRequest $request
+     * @param Statistic $statistic
+     * @return JsonResponse
+     */
+    public function destroy(Requests\Statistics\DeleteRequest $request, Statistic $statistic)
+    {
+        $this->repository->delete($statistic);
+        return response(null, 204);
+    }
+}