Release package

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: sakanjo

.github/workflows/phpstan.yml

@@ -0,0 +1,27 @@
+name: PHPStan
+
+on:
+  push:
+    paths:
+      - '**.php'
+      - 'phpstan.neon.dist'
+
+jobs:
+  phpstan:
+    name: phpstan
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          coverage: none
+
+      - name: Install composer dependencies
+        uses: ramsey/composer-install@v2
+
+      - name: Run PHPStan
+        run: ./vendor/bin/phpstan --error-format=github
+

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/composer.lock

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Salah Kanjo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,324 @@
+![Easy metrics banner](./art/banner.png)
+
+<p align="center">
+    <a href="https://laravel.com"><img alt="Laravel v10.x" src="https://img.shields.io/badge/Laravel-v10.x-FF2D20?style=for-the-badge&logo=laravel"></a>
+    <a href="https://php.net"><img alt="PHP 8.0" src="https://img.shields.io/badge/PHP-8.0-777BB4?style=for-the-badge&logo=php"></a>
+</p>
+
+<h1 align="center">🔥 Easy metrics</h1>
+
+<p align="center">Easily create metrics for your application.</p>
+
+> ✨ Help support the maintenance of this package by [sponsoring me](https://github.com/sponsors/sakanjo).
+
+> Designed to work out-of-the-box with **Laravel**, **Symfony**, **Filament**, and more.
+
+## 🚀 Supported metrics
+
+- **Bar** metric
+- **Doughnut** metric
+- **Line** metric
+- **Pie** metric
+- **Polar** metric
+- **Trend** metric
+- **Value** metric
+
+Table of contents
+=================
+
+* [Install](#install)
+* [Usage](#usage)
+  * [Value metric](#value-metrics)
+  * [Doughnut metric](#doughnut-metric)
+  * [Trend metric](#trend-metric)
+  * [Other metrics](#other-metrics)
+* [Ranges](#ranges)
+  * [Available custom ranges](#available-custom-ranges)
+* [Practical examples](#practical-examples)
+     * [Filamentphp v3 widgets](#filamentphp-v3-widgets)
+* [Support the development](#support-the-development)
+* [Credits](#credits)
+* [License](#license)
+
+## 📦 Install
+
+```
+composer require sakanjo/laravel-easy-metrics
+```
+
+## 🦄 Usage
+
+### Value metric
+
+```php
+use SaKanjo\EasyMetrics\Metrics\Value;
+use App\Models\User;
+
+$data = Value::make(User::class)
+    ->count();
+```
+
+#### Query types
+
+The currently supported aggregate functions to calculate a given column compared to the previous time interval / range
+
+##### Min
+
+```php
+Value::make(User::class)
+    ->min('age');
+```
+
+##### Max
+
+```php
+Value::make(User::class)
+    ->max('age');
+```
+
+##### Sum
+
+```php
+Value::make(User::class)
+    ->sum('age');
+```
+
+##### Average
+
+```php
+Value::make(User::class)
+    ->average('age');
+```
+
+##### Count
+
+```php
+Value::make(User::class)
+    ->count();
+```
+
+### Doughnut metric
+
+```php
+use SaKanjo\EasyMetrics\Metrics\Doughnut;
+use App\Models\User;
+use App\Enums\Gender;
+
+[$labels, $data] = Doughnut::make(User::class)
+    ->options(Gender::values())
+    ->count('gender');
+```
+
+> It's always better to use the `options` method even though it's optional, since the retrieved data may not include all enum options.
+
+#### Query types
+
+The currently supported aggregate functions to calculate a given column compared to the previous time interval / range
+
+##### Min
+
+```php
+Doughnut::make(User::class)
+    ->min('age', 'gender');
+```
+
+##### Max
+
+```php
+Doughnut::make(User::class)
+    ->max('age', 'gender');
+```
+
+##### Sum
+
+```php
+Doughnut::make(User::class)
+    ->sum('age', 'gender');
+```
+
+##### Average
+
+```php
+Doughnut::make(User::class)
+    ->average('age', 'gender');
+```
+
+##### Count
+
+```php
+Doughnut::make(User::class)
+    ->count('gender');
+```
+
+### Trend metric
+
+```php
+use SaKanjo\EasyMetrics\Metrics\Trend;
+use App\Models\User;
+use App\Enums\Gender;
+
+[$labels, $data] = Trend::make(User::class)
+    ->countByMonths();
+```
+
+
+#### Query types
+
+The currently supported aggregate functions to calculate a given column compared to the previous time interval / range
+
+##### Min
+
+```php
+$trend->minByYears('age'); 
+$trend->minByMonths('age'); 
+$trend->minByWeeks('age');  
+$trend->minByDays('age');  
+$trend->minByHours('age');  
+$trend->minByMinutes('age');  
+```
+
+##### Max
+
+```php
+$trend->maxByYears('age'); 
+$trend->maxByMonths('age'); 
+$trend->maxByWeeks('age');  
+$trend->maxByDays('age');  
+$trend->maxByHours('age');  
+$trend->maxByMinutes('age');  
+```
+
+##### Sum
+
+```php
+$trend->sumByYears('age'); 
+$trend->sumByMonths('age'); 
+$trend->sumByWeeks('age');  
+$trend->sumByDays('age');  
+$trend->sumByHours('age');  
+$trend->sumByMinutes('age');  
+```
+
+##### Average
+
+```php
+$trend->averageByYears('age'); 
+$trend->averageByMonths('age'); 
+$trend->averageByWeeks('age');  
+$trend->averageByDays('age');  
+$trend->averageByHours('age');  
+$trend->averageByMinutes('age');  
+```
+
+##### Count
+
+```php
+$trend->countByYears(); 
+$trend->countByMonths(); 
+$trend->countByWeeks();  
+$trend->countByDays();  
+$trend->countByHours();  
+$trend->countByMinutes();  
+```
+
+### Other metrics
+
+- `Bar extends Trend`
+- `Line extends Trend`
+- `Doughnut extends Pie`
+- `Polar extends Pie`
+
+
+## Ranges
+
+Every metric class contains a ranges method, that will determine the range of the results based on it's date column.
+
+```php
+use SaKanjo\EasyMetrics\Metrics\Trend;
+use SaKanjo\EasyMetrics\Metrics\Enums\Range;
+use App\Models\User;
+
+Value::make(User::class)
+    ->range(30)
+    ->ranges([
+        15, 30, 365,
+        Range::TODAY, // Or 'TODAY'
+    ]);
+```
+
+### Available custom ranges
+
+- `Range::TODAY`
+- `Range::YESTERDAY`
+- `Range::MTD`
+- `Range::QTD`
+- `Range::YTD`
+- `Range::ALL`
+
+## 🔥 Practical examples
+
+#### Filamentphp v3 widgets
+
+```php
+<?php
+
+namespace App\Filament\Widgets\Admin;
+
+use App\Models\User;
+use Filament\Widgets\ChartWidget;
+use SaKanjo\EasyMetrics\Metrics\Trend;
+
+class UsersCountChart extends ChartWidget
+{
+    protected static ?string $heading = 'Users count trend';
+
+    protected function getData(): array
+    {
+        [$labels, $data] = Trend::make(User::class)
+            ->range($this->filter)
+            ->rangesFromOptions($this->getFilters())
+            ->countByMonths();
+
+        return [
+            'datasets' => [
+                [
+                    'label' => 'Users',
+                    'data' => $data,
+                ],
+            ],
+            'labels' => $labels,
+        ];
+    }
+
+    protected function getType(): string
+    {
+        return 'line';
+    }
+
+    protected function getFilters(): ?array
+    {
+        return [
+            15 => '15 Days',
+            30 => '30 Days',
+            60 => '60 Days',
+            365 => '365 Days',
+        ];
+    }
+}
+
+```
+
+## 💖 Support the development
+
+**Do you like this project? Support it by donating**
+
+Click the ["💖 Sponsor"](https://github.com/sponsors/sakanjo) at the top of this repo.
+
+## ©️ Credits
+
+- [Salah Kanjo](https://github.com/sakanjo)
+- [All Contributors](../../contributors)
+
+## 📄 License
+
+[MIT License](https://github.com/sakanjo/laravel-easy-metrics/blob/main/LICENSE) © 2023-PRESENT [Salah Kanjo](https://github.com/sakanjo)