Merge pull request #18 from adhocore/develop

Develop

Author: adhocore

.gitignore

@@ -4,3 +4,4 @@
 /.idea/
 /vendor/
 composer.lock
+coverage.xml

README.md

@@ -56,14 +56,22 @@ $jobs = [
 ];
 
 // The second param $time can be used same as above: null/time()/date string/DateTime
-$dueJobs = Expression::getDues($jobs, '2015-08-10 21:50:00');
+$dues = Expression::getDues($jobs, '2015-08-10 21:50:00');
 // ['job1', 'job4', 'job5']
 
 // Dont like static calls? Below is possible too!
 $expr = new Expression;
-$dueJobs = $expr->filter($jobs, time());
+$dues = $expr->filter($jobs, time());
 ```
 
+### Cron Expression
+
+Cron expression normally consists of 5 segments viz:
+```
+<minute> <hour> <day> <month> <weekday>
+```
+and sometimes there can be 6th segment for `<year>` at the end.
+
 ### Real Abbreviations
 
 You can use real abbreviations for month and week days. eg: `JAN`, `dec`, `fri`, `SUN`
@@ -88,11 +96,11 @@ Following tags are available and they are converted to real cron expressions bef
 Following modifiers supported
 
 - *Day of Month / 3rd segment:*
-	- `L` stands for last day of month (eg: `L` could mean 29th for February in leap year)
-	- `W` stands for closest week day (eg: `10W` is closest week days (MON-FRI) to 10th date)
+    - `L` stands for last day of month (eg: `L` could mean 29th for February in leap year)
+    - `W` stands for closest week day (eg: `10W` is closest week days (MON-FRI) to 10th date)
 - *Day of Week / 5th segment:*
-	- `L` stands for last weekday of month (eg: `2L` is last monday)
-	- `#` stands for nth day of week in the month (eg: `1#2` is second sunday)
+    - `L` stands for last weekday of month (eg: `2L` is last monday)
+    - `#` stands for nth day of week in the month (eg: `1#2` is second sunday)
 
 ## LICENSE
 

composer.json

@@ -23,13 +23,13 @@
         }
     },
     "require": {
-        "php": ">=5.4"
+        "php": ">=7.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8 || ^5.7 || ^6.5"
+        "phpunit/phpunit": "^6.5 || ^7.5"
     },
     "scripts": {
         "test": "vendor/bin/phpunit",
-        "test:cov": "vendor/bin/phpunit --coverage-text --coverage-clover coverage.xml"
+        "test:cov": "vendor/bin/phpunit --coverage-text --coverage-clover coverage.xml --coverage-html vendor/cov"
     }
 }

phpunit.xml.dist

@@ -8,7 +8,6 @@
   convertWarningsToExceptions="true"
   processIsolation="false"
   stopOnFailure="false"
-  syntaxCheck="false"
   bootstrap="vendor/autoload.php"
 >
   <testsuites>

src/Expression.php

@@ -121,14 +121,14 @@ public static function getDues(array $jobs, $time = null): array
      */
     public function isCronDue(string $expr, $time = null): bool
     {
-        list($expr, $times) = $this->process($expr, $time);
+        $this->checker->setReference(new ReferenceTime($time));
 
-        foreach ($expr as $pos => $segment) {
+        foreach (\explode(' ', $this->normalizeExpr($expr)) as $pos => $segment) {
             if ($segment === '*' || $segment === '?') {
                 continue;
             }
 
-            if (!$this->checker->checkDue($segment, $pos, $times)) {
+            if (!$this->checker->checkDue($segment, $pos)) {
                 return false;
             }
         }
@@ -147,7 +147,6 @@ public function isCronDue(string $expr, $time = null): bool
     public function filter(array $jobs, $time = null): array
     {
         $dues = $cache = [];
-        $time = $this->normalizeTime($time);
 
         foreach ($jobs as $name => $expr) {
             $expr = $this->normalizeExpr($expr);
@@ -164,44 +163,6 @@ public function filter(array $jobs, $time = null): array
         return $dues;
     }
 
-    /**
-     * Process and prepare input.
-     *
-     * @param string $expr
-     * @param mixed  $time
-     *
-     * @return array [expr, time]
-     */
-    protected function process(string $expr, $time): array
-    {
-        $expr = $this->normalizeExpr($expr);
-        $expr = \preg_split('~\s+~', $expr); // 14
-
-        if (\count($expr) < 5 || \count($expr) > 6) {
-            throw new \UnexpectedValueException(
-                'Cron $expr should have 5 or 6 segments delimited by space'
-            );
-        }
-
-        $time  = static::normalizeTime($time);
-        $times = \array_map('intval', \explode(' ', \date('i G j n w Y t d m N', $time)));
-
-        return [$expr, $times];
-    }
-
-    protected function normalizeTime($time): int
-    {
-        if (empty($time)) {
-            $time = \time();
-        } elseif (\is_string($time)) {
-            $time = \strtotime($time);
-        } elseif ($time instanceof \DateTime) {
-            $time = $time->getTimestamp();
-        }
-
-        return $time;
-    }
-
     protected function normalizeExpr(string $expr): string
     {
         $expr = \trim($expr);
@@ -210,10 +171,15 @@ protected function normalizeExpr(string $expr): string
             return static::$expressions[$expr];
         }
 
-        return \str_ireplace(
-            \array_keys(static::$literals),
-            \array_values(static::$literals),
-            $expr
-        );
+        $expr  = \preg_replace('~\s+~', ' ', $expr);
+        $count = \substr_count($expr, ' ');
+
+        if ($count < 4 || $count > 5) {
+            throw new \UnexpectedValueException(
+                'Cron $expr should have 5 or 6 segments delimited by space'
+            );
+        }
+
+        return \str_ireplace(\array_keys(static::$literals), \array_values(static::$literals), $expr);
     }
 }

src/ReferenceTime.php

@@ -0,0 +1,99 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the PHP-CRON-EXPR package.
+ *
+ * (c) Jitendra Adhikari <[email protected]>
+ *     <https://github.com/adhocore>
+ *
+ * Licensed under MIT license.
+ */
+
+namespace Ahc\Cron;
+
+/**
+ * @method int minute()
+ * @method int hour()
+ * @method int monthDay()
+ * @method int month()
+ * @method int weekDay()  0 based day of week.
+ * @method int year()
+ * @method int day()
+ * @method int weekDay1() 1 based day of week.
+ * @method int numDays()  Number of days in the month.
+ */
+class ReferenceTime
+{
+    // The cron parts. (Donot change it)
+    const MINUTE   = 0;
+    const HOUR     = 1;
+    const MONTHDAY = 2;
+    const MONTH    = 3;
+    const WEEKDAY  = 4;
+    const YEAR     = 5;
+
+    // Meta data parts.
+    const DAY      = 6;
+    const WEEKDAY1 = 7;
+    const NUMDAYS  = 8;
+
+    /** @var array The data */
+    protected $values = [];
+
+    /** @var array The Magic methods */
+    protected $methods = [];
+
+    public function __construct($time)
+    {
+        $timestamp = $this->normalizeTime($time);
+
+        $this->values  = $this->parse($timestamp);
+        $this->methods = (new \ReflectionClass($this))->getConstants();
+    }
+
+    public function __call(string $method, array $args): int
+    {
+        $method = \preg_replace('/^GET/', '', \strtoupper($method));
+        if (isset($this->methods[$method])) {
+            return $this->values[$this->methods[$method]];
+        }
+
+        // @codeCoverageIgnoreStart
+        throw new \BadMethodCallException("Method '$method' doesnot exist in ReferenceTime.");
+        // @codeCoverageIgnoreEnd
+    }
+
+    public function get(int $segment): int
+    {
+        return $this->values[$segment];
+    }
+
+    public function isAt($value, $segment): bool
+    {
+        return $this->values[$segment] == $value;
+    }
+
+    protected function normalizeTime($time): int
+    {
+        if (empty($time)) {
+            $time = \time();
+        } elseif (\is_string($time)) {
+            $time = \strtotime($time);
+        } elseif ($time instanceof \DateTime) {
+            $time = $time->getTimestamp();
+        }
+
+        return $time;
+    }
+
+    protected function parse(int $timestamp): array
+    {
+        $parts = \date('i G j n w Y d N t', $timestamp);
+        $parts = \explode(' ', $parts);
+        $parts = \array_map('intval', $parts);
+
+        return $parts;
+    }
+}

src/SegmentChecker.php

@@ -22,6 +22,9 @@
  */
 class SegmentChecker
 {
+    /** @var ReferenceTime */
+    protected $reference;
+
     /** @var Validator */
     protected $validator;
 
@@ -30,21 +33,25 @@ public function __construct(Validator $validator = null)
         $this->validator = $validator ?: new Validator;
     }
 
+    public function setReference(ReferenceTime $reference)
+    {
+        $this->reference = $reference;
+    }
+
     /**
      * Checks if a cron segment satisfies given time.
      *
      * @param string $segment
      * @param int    $pos
-     * @param array  $times
      *
      * @return bool
      */
-    public function checkDue(string $segment, int $pos, array $times): bool
+    public function checkDue(string $segment, int $pos): bool
     {
         $offsets = \explode(',', \trim($segment));
 
         foreach ($offsets as $offset) {
-            if ($this->isOffsetDue($offset, $pos, $times)) {
+            if ($this->isOffsetDue($offset, $pos)) {
                 return true;
             }
         }
@@ -57,39 +64,41 @@ public function checkDue(string $segment, int $pos, array $times): bool
      *
      * @param string $offset
      * @param int    $pos
-     * @param array  $times
      *
      * @return bool
      */
-    protected function isOffsetDue(string $offset, int $pos, array $times): bool
+    protected function isOffsetDue(string $offset, int $pos): bool
     {
         if (\strpos($offset, '/') !== false) {
-            return $this->validator->inStep($times[$pos], $offset);
+            return $this->validator->inStep($this->reference->get($pos), $offset);
         }
 
         if (\strpos($offset, '-') !== false) {
-            return $this->validator->inRange($times[$pos], $offset);
+            return $this->validator->inRange($this->reference->get($pos), $offset);
         }
 
         if (\is_numeric($offset)) {
-            return $times[$pos] == $offset;
+            return $this->reference->isAt($offset, $pos);
         }
 
-        return $this->checkModifier($offset, $pos, $times);
+        return $this->checkModifier($offset, $pos);
     }
 
-    protected function checkModifier(string $offset, int $pos, array $times): bool
+    protected function checkModifier(string $offset, int $pos): bool
     {
         $isModifier = \strpbrk($offset, 'LCW#');
 
-        if ($pos === 2 && $isModifier) {
-            return $this->validator->isValidMonthDay($offset, $times);
+        if ($pos === ReferenceTime::MONTHDAY && $isModifier) {
+            return $this->validator->isValidMonthDay($offset, $this->reference);
         }
 
-        if ($pos === 4 && $isModifier) {
-            return $this->validator->isValidWeekDay($offset, $times);
+        if ($pos === ReferenceTime::WEEKDAY && $isModifier) {
+            return $this->validator->isValidWeekDay($offset, $this->reference);
         }
 
         $this->validator->unexpectedValue($pos, $offset);
+        // @codeCoverageIgnoreStart
     }
+
+    // @codeCoverageIgnoreEnd
 }