feat: frequency of month (#159)

* feat: frequency of month

* refactor: change method betweenMonths

* docs: added frequency option everyMonth and betweenMonths

* Update docs/basic-usage.md

---------

Co-authored-by: Lonnie Ezell <lonnieje@gmail.com>

Author: ddevsr

docs/basic-usage.md

@@ -110,6 +110,8 @@ There are a number of ways available to specify how often the task is called.
 | `->saturdays('3:15am')`           | Runs every Saturday at midnight, unless time passed in.               |
 | `->monthly('12:21pm')`            | Runs the first day of every month at 12:00am unless time passed in.   |
 | `->daysOfMonth([1,15])`           | Runs only on days 1 and 15.                                           |
+| `->everyMonth(4)`                 | Runs every 4 months.                                                   |
+| `->betweenMonths(4,7)`            | Runs between months 4 and 7.                                          |
 | `->months([1,7])`                 | Runs only on January and July.                                        |
 | `->quarterly('5:00am')`           | Runs the first day of each quarter (Jan 1, Apr 1, July 1, Oct 1)      |
 | `->yearly('12:34am')`             | Runs the first day of the year.                                       |

src/FrequenciesTrait.php

@@ -352,6 +352,35 @@ public function daysOfMonth($days)
         return $this;
     }
 
+    /**
+     * Set the execution time to every month or every x months.
+     *
+     * @param int|string|null $month When set, specifies that the job will be run every $month months
+     *
+     * @return $this
+     */
+    public function everyMonth($month = null)
+    {
+        $this->expression['month'] = null === $month ? '*' : '*/' . $month;
+
+        return $this;
+    }
+
+    /**
+     * Runs on specific range of months
+     *
+     * @param int $from Month [1-12]
+     * @param int $to   Month [1-12]
+     *
+     * @return $this
+     */
+    public function betweenMonths(int $from, int $to)
+    {
+        $this->expression['month'] = $from . '-' . $to;
+
+        return $this;
+    }
+
     /**
      * Runs on specific months
      *
@@ -381,7 +410,8 @@ public function quarterly(?string $time = null)
         $this->expression['min']        = $min;
         $this->expression['hour']       = $hour;
         $this->expression['dayOfMonth'] = 1;
-        $this->expression['month']      = '*/3';
+
+        $this->everyMonth(3);
 
         return $this;
     }

tests/unit/FrequenciesTraitTest.php

@@ -298,6 +298,20 @@ public function testHours()
         $this->assertSame('* 12,16 * * *', $this->class->getExpression());
     }
 
+    public function testEveryMonth()
+    {
+        $this->class->everyMonth();
+
+        $this->assertSame('* * * * *', $this->class->getExpression());
+    }
+
+    public function testEveryMonthWithParameter()
+    {
+        $this->class->everyMonth(4);
+
+        $this->assertSame('* * * */4 *', $this->class->getExpression());
+    }
+
     public function testEveryMinute()
     {
         $this->class->everyMinute();
@@ -346,4 +360,11 @@ public function testMonths()
 
         $this->assertSame('* * * 1,7 *', $this->class->getExpression());
     }
+
+    public function testBetweenMonths()
+    {
+        $this->class->betweenMonths(1, 7);
+
+        $this->assertSame('* * * 1-7 *', $this->class->getExpression());
+    }
 }