add scope for models-count

Author: eloquentize

src/Commands/ModelsCount.php

@@ -15,13 +15,13 @@ class ModelsCount extends BaseCommand
 {
     use BuildPeriod, DateArgument, GatherModels, HasVerbose, ModelsOption, PrepareMetricsData, SendMetricsData;
 
-    protected $signature = 'eloquentize:models-count {date?} {--event=created_at} {--periodType=daily} {--dateFormat=} {--M|models=} {--modelsPath=}';
+    protected $signature = 'eloquentize:models-count {date?} {--event=created_at} {--periodType=daily} {--dateFormat=} {--M|models=} {--modelsPath=} {--scope=} {--scopeValue=} ';
 
     protected $description = 'Send to Eloquentize the counts of all models for a given date and event.';
 
     protected $verbose = false;
 
-    public function performModelCount(array $models, CarbonPeriod $period, string $event, ?string $modelsPath = null)
+    public function performModelCount(array $models, CarbonPeriod $period, string $event, ?string $modelsPath = null, ?string $scope = null, ?string $scopeValue = null)
     {
         $metrics = [];
         foreach ($models as $model) {
@@ -30,8 +30,21 @@ public function performModelCount(array $models, CarbonPeriod $period, string $e
             if (! $this->isModelValid($modelClass, $event)) {
                 continue;
             }
+            $query = $modelClass::whereBetween($event, [$period->getStartDate(), $period->getEndDate()]);
+            // check if the model has corresponding scope and apply it
+            if ($scope) {
+                if (method_exists($modelClass, 'scope'.$scope)) {
+                    if ($scope && $scopeValue) {
+                        $query = $query->$scope($scopeValue);
+                    } elseif ($scope) {
+                        $query = $query->$scope();
+                    }
+                } else {
+                    $this->line("Scope $scope does not exist on model $model");
+                }
+            }
 
-            $count = $modelClass::whereBetween($event, [$period->getStartDate(), $period->getEndDate()])->count();
+            $count = $query->count();
             $this->verbose("Counting $model - count: ".$count);
             $metrics[] = (object) ['label' => $model, 'count' => $count];
 
@@ -48,8 +61,22 @@ public function handle()
         $periodType = $this->option('periodType') ?? 'daily';
         $dateFormat = $this->option('dateFormat') ?? $this->defaultDateFormat;
         $modelsPath = $this->option('modelsPath');
+        $scope = $this->option('scope');
+        $scopeValue = $this->option('scopeValue');
         $filteredModels = $this->parseModelsOption($this->option('models'));
 
+        if ($scope && ! $filteredModels) {
+            $this->error('"scope" option requires "--models" option to be set. models provided should have a corresponding scope.');
+
+            return 1;
+        }
+
+        if ($scopeValue && ! $scope) {
+            $this->error('"--scopeValue" option requires "--scope" option to be set.');
+
+            return 1;
+        }
+
         $period = $this->buildPeriod($date, $periodType, $dateFormat);
         $models = $this->gatherModels($filteredModels, $modelsPath);
 
@@ -59,7 +86,7 @@ public function handle()
             return 1;
         }
 
-        $metrics = $this->performModelCount($models, $period, $event, $modelsPath);
+        $metrics = $this->performModelCount($models, $period, $event, $modelsPath, $scope, $scopeValue);
         $metricsData = $this->prepareMetricsData($metrics, $period, $event);
 
         $this->verbose('Sending models count data to eloquentize...'.config('eloquentize.api_url').'/api/metrics/models');

src/app/Testing/Models/Bill.php

@@ -10,4 +10,9 @@ class Bill extends Model
     protected $guarded = [];
 
     use HasFactory;
+
+    public function scopePriceOver($query, $price)
+    {
+        return $query->where('price', '>', $price);
+    }
 }