Standards

.gitignore

@@ -1,2 +1,3 @@
-.idea
-composer.lock
+/.idea
+composer.lock
+/vendor

composer.json

@@ -3,24 +3,37 @@
     "description": "A Laravel package for advanced date filtering and manipulation",
     "type": "library",
     "license": "MIT",
-    "autoload": {
-        "psr-4": {
-            "OmarElnaghy\\LaraDateFilters\\": "src/"
-        }
-    },
     "authors": [
         {
             "name": "omarelnaghy",
             "email": "[email protected]"
         }
     ],
     "tag": "1.0.0",
+    "require": {
+        "php": "^8.1",
+        "illuminate/database": "^9.0|^10.0",
+        "illuminate/support": "^9.0|^10.0",
+        "spatie/laravel-package-tools": "^1.16"
+    },
+    "require-dev": {
+        "laravel/pint": "^1.13"
+    },
+    "autoload": {
+        "psr-4": {
+            "OmarElnaghy\\LaraDateFilters\\": "src/"
+        }
+    },
     "extra": {
         "laravel": {
             "providers": [
                 "OmarElnaghy\\LaraDateFilters\\ServiceProvider"
             ]
         }
     },
-    "require": {}
+    "scripts": {
+        "format": "vendor/bin/pint",
+        "format-dirty": "vendor/bin/pint --dirty",
+        "format-dry-run": "vendor/bin/pint --test"
+    }
 }

src/config/lara_date_filter.php → config/lara_date_filter.php

@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 return [
     'custom_date_filter_convention' => [
         'get{duration}{unit}Records',

pint.json

@@ -0,0 +1,10 @@
+{
+    "preset": "laravel",
+    "rules": {
+        "declare_strict_types": true,
+        "single_trait_insert_per_statement": true,
+        "new_with_braces" : {
+            "anonymous_class": false
+        }
+    }
+}

src/Enums/DateRange.php

@@ -1,7 +1,8 @@
 <?php
 
-namespace OmarElnaghy\LaraDateFilters\Enums;
+declare(strict_types=1);
 
+namespace OmarElnaghy\LaraDateFilters\Enums;
 
 enum DateRange: string
 {

src/Enums/SearchDirection.php

@@ -1,7 +1,8 @@
 <?php
 
-namespace OmarElnaghy\LaraDateFilters\Enums;
+declare(strict_types=1);
 
+namespace OmarElnaghy\LaraDateFilters\Enums;
 
 enum SearchDirection: string
 {

src/Exceptions/ConventionException.php

@@ -1,16 +1,18 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OmarElnaghy\LaraDateFilters\Exceptions;
 
 use Exception;
 
-
 class ConventionException extends Exception
 {
     public static function missingDuration(): ConventionException
     {
         return new self('Invalid method call: Duration missing or not in the correct format.');
     }
+
     public static function missingDateUnit(): ConventionException
     {
         return new self('Invalid method call: Unit missing or not in the correct format');
@@ -21,4 +23,3 @@ public static function invalidDateUnit(): ConventionException
         return new self('Invalid method call: Unit is not a valid date unit.');
     }
 }
-

src/Exceptions/DateException.php

@@ -1,15 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OmarElnaghy\LaraDateFilters\Exceptions;
 
 use Exception;
 
-
 class DateException extends Exception
 {
     public static function invalidValue(): DateException
     {
         return new self('The $value parameter must be a positive integer.');
     }
 }
-

src/ServiceProvider.php

@@ -1,26 +1,18 @@
 <?php
 
-namespace OmarElnaghy\LaraDateFilters;
+declare(strict_types=1);
 
+namespace OmarElnaghy\LaraDateFilters;
 
-use Illuminate\Support\ServiceProvider as laravelServiceProvider;
+use Spatie\LaravelPackageTools\Package;
+use Spatie\LaravelPackageTools\PackageServiceProvider;
 
-class ServiceProvider extends laravelServiceProvider
+class ServiceProvider extends PackageServiceProvider
 {
-
-    public function register()
-    {
-
-        $this->mergeConfigFrom(
-            __DIR__ . '/config/lara_date_filter.php', 'lara_date_filter'
-        );
-
-    }
-
-    public function boot()
+    public function configurePackage(Package $package): void
     {
-        $this->publishes([
-            __DIR__ . '/config/lara_date_filter.php'=> config_path('lara_date_filter.php')
-        ]);
+        $package
+            ->name('lara-date-filter')
+            ->hasConfigFile('lara_date_filter');
     }
 }

src/Traits/Builder/PackageBuilder.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace OmarElnaghy\LaraDateFilters\Traits\Builder;
 
 use Illuminate\Database\Eloquent\Builder;

src/Traits/BuilderTrait.php

@@ -1,37 +1,39 @@
 <?php
 
-namespace OmarElnaghy\LaraDateFilters\Traits;
+declare(strict_types=1);
 
+namespace OmarElnaghy\LaraDateFilters\Traits;
 
 use Carbon\Carbon;
+use Exception;
+use Illuminate\Support\Carbon as SupportCarbon;
 use OmarElnaghy\LaraDateFilters\Enums\DateRange;
 use OmarElnaghy\LaraDateFilters\Enums\SearchDirection;
 use OmarElnaghy\LaraDateFilters\Exceptions\ConventionException;
 use OmarElnaghy\LaraDateFilters\Exceptions\DateException;
-use PHPUnit\Exception;
 
 trait BuilderTrait
 {
     public array $dateUnits = ['Seconds', 'Minutes', 'Hours', 'Days', 'Weeks', 'Months'];
 
     public function getClassVars()
     {
-        return $this->getModel()->dateColumn ?? "created_at";
+        return $this->getModel()->dateColumn ?? 'created_at';
     }
 
-    public function FilterByDateRange(int $duration, string $dateUnit, Carbon $date, SearchDirection $direction = SearchDirection::AFTER, DateRange $range = DateRange::INCLUSIVE)
+    public function FilterByDateRange(int $duration, string $dateUnit, Carbon|SupportCarbon $date, SearchDirection $direction = SearchDirection::AFTER, DateRange $range = DateRange::INCLUSIVE)
     {
         $end = clone $date;
         $start = clone $date;
 
-        $addToDateMethod = 'add' . ucfirst($dateUnit);
-        $subFromDateMethod = 'sub' . ucfirst($dateUnit);
-
+        $addToDateMethod = 'add'.ucfirst($dateUnit);
+        $subFromDateMethod = 'sub'.ucfirst($dateUnit);
 
         if ($direction->value === 'after') {
             $end->$addToDateMethod($duration);
             $date = $range->value === 'exclusive' ? $date->$addToDateMethod(1) : $date;
             $end = $range->value === 'exclusive' ? $end->$subFromDateMethod(1) : $end;
+
             return $this->whereBetween($this->getClassVars(), [$date, $end]);
 
         }
@@ -43,57 +45,55 @@ public function FilterByDateRange(int $duration, string $dateUnit, Carbon $date,
             return $this->whereBetween($this->getClassVars(), [$start, $date]);
         }
 
-        DateException::invalidValue();
+        throw DateException::invalidValue();
     }
 
-    public function FilterByDateHoursRange(int $duration, SearchDirection $direction, Carbon $date, DateRange $range = DateRange::INCLUSIVE)
+    public function FilterByDateHoursRange(int $duration, SearchDirection $direction, Carbon|SupportCarbon $date, DateRange $range = DateRange::INCLUSIVE)
     {
         return $this->FilterByDateRange($duration, 'hour', $date, $direction, $range);
     }
 
-    public function FilterByDateMinutesRange(int $duration, SearchDirection $direction, Carbon $date, DateRange $range = DateRange::INCLUSIVE)
+    public function FilterByDateMinutesRange(int $duration, SearchDirection $direction, Carbon|SupportCarbon $date, DateRange $range = DateRange::INCLUSIVE)
     {
         return $this->FilterByDateRange($duration, 'minute', $date, $direction, $range);
     }
 
-    public function FilterByDateSecondsRange(int $duration, SearchDirection $direction, Carbon $date, DateRange $range = DateRange::INCLUSIVE)
+    public function FilterByDateSecondsRange(int $duration, SearchDirection $direction, Carbon|SupportCarbon $date, DateRange $range = DateRange::INCLUSIVE)
     {
         return $this->FilterByDateRange($duration, 'second', $date, $direction, $range);
     }
 
-    public function FilterByDateDaysRange(int $duration, SearchDirection $direction, Carbon $date, DateRange $range = DateRange::INCLUSIVE)
+    public function FilterByDateDaysRange(int $duration, SearchDirection $direction, Carbon|SupportCarbon $date, DateRange $range = DateRange::INCLUSIVE)
     {
         return $this->FilterByDateRange($duration, 'day', $date, $direction, $range);
     }
 
-    public function FilterByDateWeeksRange(int $duration, SearchDirection $direction, Carbon $date, DateRange $range = DateRange::INCLUSIVE)
+    public function FilterByDateWeeksRange(int $duration, SearchDirection $direction, Carbon|SupportCarbon $date, DateRange $range = DateRange::INCLUSIVE)
     {
         return $this->FilterByDateRange($duration, 'week', $date, $direction, $range);
     }
 
-    public function FilterByDateMonthsRange(int $duration, SearchDirection $direction, Carbon $date, DateRange $range = DateRange::INCLUSIVE)
+    public function FilterByDateMonthsRange(int $duration, SearchDirection $direction, Carbon|SupportCarbon $date, DateRange $range = DateRange::INCLUSIVE)
     {
         return $this->FilterByDateRange($duration, 'month', $date, $direction, $range);
     }
 
-    /**
-     * @throws ConventionException
-     */
     public function __call($method, $parameters)
     {
         $matches = [];
         $conventions = config('lara_date_filter.custom_date_filter_convention', []);
         $conventions = array_merge($conventions, ['filterByDate{duration}{unit}Range']);
 
-        if (!empty($conventions)) {
+        if (! empty($conventions)) {
             foreach ($conventions as $convention) {
                 $pattern = str_replace(['{duration}', '{unit}'], ['(\d+)', '([A-Za-z]+)'], $convention);
                 $patternWithoutNumeric = explode('(\d+)', $pattern);
-                $patternWithSlash = $patternWithoutNumeric[0] . '/';
+                $patternWithSlash = $patternWithoutNumeric[0].'/';
                 if (preg_match("/^$pattern$/", $method, $matches) || preg_match("/^$patternWithSlash", $method, $matches)) {
-                    if (isset($matches[1], $matches[2])){
+                    if (isset($matches[1], $matches[2])) {
                         try {
                             $this->validateConvention($matches[1], $matches[2]);
+
                             return $this->filterByDateRange($matches[1], $matches[2], ...$parameters);
                         } catch (Exception $exception) {
                             return parent::__call($method, $parameters);
@@ -102,6 +102,7 @@ public function __call($method, $parameters)
                 }
             }
         }
+
         return parent::__call($method, $parameters);
     }
 
@@ -110,17 +111,15 @@ public function __call($method, $parameters)
      */
     private function validateConvention($duration, $unit): void
     {
-        if (!isset($duration) || !is_numeric($duration)) {
-            throw  ConventionException::missingDuration();
+        if (! isset($duration) || ! is_numeric($duration)) {
+            throw ConventionException::missingDuration();
         }
-        if (!isset($unit) || !is_numeric($duration)) {
-            throw  ConventionException::missingDateUnit();
+        if (! isset($unit) || ! is_numeric($duration)) {
+            throw ConventionException::missingDateUnit();
         }
 
-        if (!in_array($unit, $this->dateUnits)) {
-            throw  ConventionException::invalidDateUnit();
+        if (! in_array($unit, $this->dateUnits)) {
+            throw ConventionException::invalidDateUnit();
         }
     }
-
-
 }