added methods whereCurrentYear, whereCurrentMonth, whereCurrentDay

Author: Alexmg86

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-sub-query` will be documented in this file
 
+## [v1.9.9 (2021-04-14)](https://github.com/Alexmg86/laravel-sub-query/compare/v1.9.8...v1.9.9)
+### Added
+- methods whereCurrentYear, whereCurrentMonth, whereCurrentDay
+
 ## [v1.9.8 (2021-04-14)](https://github.com/Alexmg86/laravel-sub-query/compare/v1.9.7...v1.9.8)
 ### Fixed
 - fixed some methods for laravel version 8.*

README.md

@@ -133,6 +133,15 @@ $items = Item::withMath(['invoice_id', 'price', 'price2'], '*', 'new_column')->g
 echo $items[0]->new_column;
 ```
 
+### Working with dates
+
+A more convenient way to select by dates. By default, sorting is by `created_at`.
+```php
+$invoices = Invoice::whereCurrentYear('column_name')->get();
+$invoices = Invoice::whereCurrentMonth()->get();
+$invoices = Invoice::whereCurrentDay()->get();
+```
+
 ### Load latest or oldest relation
 
 Imagine you want to get a list of 50 accounts, each with 100 items. By default, you will get 5000 positions and select the first ones for each account. PHP smokes nervously on the sidelines.  

src/Traits/LaravelSubQuerySugar.php

@@ -101,4 +101,34 @@ public function forceIndex($column)
     {
         return $this->query->from(\DB::raw($this->query->from . ' FORCE INDEX (' . $column . ')'));
     }
+
+    /**
+     * Find items for current year
+     * @param  string $column
+     * @return $this
+     */
+    public function whereCurrentYear($column = 'created_at')
+    {
+        return $this->whereRaw("$column between date_format(now() ,'%Y-01-01') and now()");
+    }
+
+    /**
+     * Find items for current year
+     * @param  string $column
+     * @return $this
+     */
+    public function whereCurrentMonth($column = 'created_at')
+    {
+        return $this->whereRaw("$column between date_format(now() ,'%Y-%m-01') and now()");
+    }
+
+    /**
+     * Find items for current day
+     * @param  string $column
+     * @return $this
+     */
+    public function whereCurrentDay($column = 'created_at')
+    {
+        return $this->whereRaw("$column between date_format(now() ,'%Y-%m-%d') and now()");
+    }
 }

tests/DatabaseTestCase.php

@@ -37,6 +37,7 @@ protected function createInvoicesTable(): void
         Schema::create('invoices', function (Blueprint $table) {
             $table->increments('id');
             $table->string('name', 100);
+            $table->timestamps();
         });
     }
 

tests/LaravelSubQuerySugarTest.php

@@ -91,8 +91,38 @@ public function testForceIndex()
     {
         $this->createBasic();
 
-        $result = Invoice::forceIndex('name')->toSql();
+        $results = Invoice::forceIndex('name')->toSql();
 
-        $this->assertEquals('select * from invoices FORCE INDEX (name)', $result);
+        $this->assertEquals('select * from invoices FORCE INDEX (name)', $results);
+    }
+
+    public function testCurrentYear()
+    {
+        $this->createBasic();
+
+        $results = Invoice::whereCurrentYear()->toSql();
+
+        $need = "select * from \"invoices\" where created_at between date_format(now() ,'%Y-01-01') and now()";
+        $this->assertEquals($need, $results);
+    }
+
+    public function testCurrentMonth()
+    {
+        $this->createBasic();
+
+        $results = Invoice::whereCurrentMonth()->toSql();
+
+        $need = "select * from \"invoices\" where created_at between date_format(now() ,'%Y-%m-01') and now()";
+        $this->assertEquals($need, $results);
+    }
+
+    public function testCurrentDay()
+    {
+        $this->createBasic();
+
+        $results = Invoice::whereCurrentDay()->toSql();
+
+        $need = "select * from \"invoices\" where created_at between date_format(now() ,'%Y-%m-%d') and now()";
+        $this->assertEquals($need, $results);
     }
 }

tests/Models/Invoice.php

@@ -10,9 +10,11 @@ class Invoice extends Model
     use LaravelSubQueryTrait;
 
     public $table = 'invoices';
-    public $timestamps = false;
+
     protected $guarded = ['id'];
 
+    protected $hidden = ['created_at', 'updated_at'];
+
     public function items()
     {
         return $this->hasMany(Item::class, 'invoice_id');