feat: Support Steps with Ranges #76

BREAKING CHANGE: Rename`CronType` to `FieldPattern`

- Rename `CronType.Empty` to `FieldPattern.Any`.
- Rename `CronType.EveryX` to `FieldPattern.Step`.
- Due to this change, the structure of existing localization objects need adjustments.

Author: abichinger

core/src/__tests__/cron.spec.ts

@@ -41,12 +41,12 @@ describe('segments', () => {
 
     expect(arrayToCron([1, 10], r(1, 10))).toEqual('1,10')
     expect(arrayToCron([1, 2, 3], r(1, 10))).toEqual('1-3')
-    expect(arrayToCron([2, 4, 6], r(1, 10))).toEqual('2,4,6')
+    expect(arrayToCron([2, 4, 7], r(1, 10))).toEqual('2,4,7')
     expect(arrayToCron([], r(1, 3))).toEqual('*')
     expect(arrayToCron([1, 2, 3], r(1, 3))).toEqual('*')
     expect(arrayToCron([0, 5, 10], r(0, 10))).toEqual('*/5')
     expect(arrayToCron([5, 12, 19, 26], r(5, 30))).toEqual('*/7')
-    expect(arrayToCron([0, 5, 10], r(0, 20))).toEqual('0,5,10')
+    expect(arrayToCron([0, 5, 10], r(0, 20))).toEqual('0-10/5')
     expect(arrayToCron([1, 2, 5, 8, 9, 10], r(1, 10))).toEqual('1-2,5,8-10')
   })
 })

core/src/__tests__/locale.spec.ts

@@ -1,5 +1,5 @@
 import { getLocale } from '@/locale'
-import { CronType, TextPosition } from '@/types'
+import { FieldPattern, TextPosition } from '@/types'
 import { describe, expect, it } from 'vitest'
 
 describe('locale', () => {
@@ -60,7 +60,7 @@ describe('locale', () => {
     })
 
     expect(
-      l.render('period', 'field', CronType.Value, TextPosition.Text, {
+      l.render('period', 'field', FieldPattern.Value, TextPosition.Text, {
         start: {
           text: 'foo',
         },

core/src/components/__tests__/cron-core.spec.ts

@@ -57,6 +57,12 @@ describe('useCron', () => {
         period: 'week',
         expected: `Every Week on Sun at 23 : 59`,
       },
+      {
+        format: 'crontab',
+        value: '10,20,30 23 * * 0-4/2',
+        period: 'week',
+        expected: `Every Week on Sun-Thu/2 at 23 : 10-30/10`,
+      },
       {
         format: 'quartz',
         value: '* * * * * *',

core/src/components/cron-core.ts

@@ -1,4 +1,4 @@
-import { AnySegment, EverySegment, NoSpecificSegment, RangeSegment, ValueSegment } from '@/cron'
+import { AnySegment, NoSpecificSegment, RangeSegment, StepSegment, ValueSegment } from '@/cron'
 import type { Localization } from '@/locale/types'
 import {
   computed,
@@ -75,7 +75,7 @@ export class DefaultCronOptions {
           ? [
               AnySegment.fromString,
               NoSpecificSegment.fromString,
-              EverySegment.fromString,
+              StepSegment.fromString,
               RangeSegment.fromString,
               ValueSegment.fromString,
             ]
@@ -90,7 +90,7 @@ export class DefaultCronOptions {
           ? [
               AnySegment.fromString,
               NoSpecificSegment.fromString,
-              EverySegment.fromString,
+              StepSegment.fromString,
               RangeSegment.fromString,
               ValueSegment.fromString,
             ]

core/src/cron.ts

@@ -1,9 +1,9 @@
-import { CronType, FieldWrapper, type CronSegment, type SegmentFromString } from './types'
+import { FieldPattern, FieldWrapper, type CronSegment, type SegmentFromString } from './types'
 import { isSquence, range, unimplemented } from './util'
 
 class NoSpecificSegment implements CronSegment {
   field: FieldWrapper
-  type: CronType = CronType.NoSpecific
+  type: FieldPattern = FieldPattern.NoSpecific
 
   constructor(field: FieldWrapper) {
     this.field = field
@@ -31,7 +31,7 @@ class NoSpecificSegment implements CronSegment {
 
 class AnySegment implements CronSegment {
   field: FieldWrapper
-  type: CronType = CronType.Empty
+  type: FieldPattern = FieldPattern.Any
 
   constructor(field: FieldWrapper) {
     this.field = field
@@ -82,7 +82,7 @@ class RangeSegment implements CronSegment {
   static re = /^\d+-\d+$/
 
   field: FieldWrapper
-  type: CronType = CronType.Range
+  type: FieldPattern = FieldPattern.Range
   start: number
   end: number
 
@@ -128,75 +128,79 @@ class RangeSegment implements CronSegment {
   }
 }
 
-const _every = (n: number, min: number, max: number) => {
+function _rangeWithStep(n: number, min: number, max: number) {
   const res = []
   for (let i = min; i <= max; i += n) {
     res.push(i)
   }
   return res
 }
-
-class EverySegment implements CronSegment {
+class StepSegment implements CronSegment {
   static re = /^(\*|\d+-\d+)\/\d+$/
 
   field: FieldWrapper
-  type: CronType = CronType.EveryX
-  every: number
+  step: number
   start: number
   end: number
 
-  constructor(field: FieldWrapper, every: number, start?: number, end?: number) {
+  constructor(field: FieldWrapper, step: number, start?: number, end?: number) {
     this.field = field
-    this.every = every
+    this.step = step
     this.start = start ?? field.min
     this.end = end ?? field.max
   }
 
+  get type() {
+    const { min, max } = this.field
+    if (this.start !== min || max - this.end >= this.step) {
+      return FieldPattern.RangeStep
+    }
+    return FieldPattern.Step
+  }
+
   toCron() {
-    if (this.start == this.field.min && this.end == this.field.max) {
-      return `*/${this.every}`
+    if (this.type == FieldPattern.RangeStep) {
+      return `${this.start}-${this.end}/${this.step}`
     }
-    return `${this.start}-${this.end}/${this.every}`
+    return `*/${this.step}`
   }
 
   toArray() {
-    return _every(this.every, this.start, this.end)
+    return _rangeWithStep(this.step, this.start, this.end)
   }
 
   get items() {
     return {
-      every: this.field.itemMap[this.every],
+      step: this.field.itemMap[this.step],
       start: this.field.itemMap[this.start],
       end: this.field.itemMap[this.end],
     }
   }
 
   static fromString(str: string, field: FieldWrapper) {
-    if (!EverySegment.re.test(str)) {
+    if (!StepSegment.re.test(str)) {
       return null
     }
 
-    const [rangeStr, everyStr] = str.split('/')
-    const every = parseInt(everyStr)
+    const [rangeStr, stepStr] = str.split('/')
+    const step = parseInt(stepStr)
 
-    if (every > field.items.length) {
+    if (step > field.items.length) {
       return null
     }
 
     const range = str.split('-').map((s) => parseInt(s))
     const min = rangeStr == '*' ? field.min : range[0]
     const max = rangeStr == '*' ? field.max : range[1]
 
-    if (_every(every, min, max).length == 0) {
+    if (_rangeWithStep(step, min, max).length == 0) {
       return null
     }
 
-    return new EverySegment(field, every, min, max)
+    return new StepSegment(field, step, min, max)
   }
 
   static fromArray(arr: number[], field: FieldWrapper) {
-    const { min, max } = field
-
     if (arr.length < 3) {
       return null
     }
@@ -206,28 +210,19 @@ class EverySegment implements CronSegment {
       return null
     }
 
-    // prevent a-b/x segments until localization is ready
-    if (arr[0] != min) {
-      return null
-    }
-    const end = arr[arr.length - 1]
-    if (max - end >= step) {
-      return null
-    }
-
     for (let i = 2; i < arr.length; i++) {
       if (arr[i] - arr[i - 1] != step) {
         return null
       }
     }
 
-    return new EverySegment(field, step, min, max)
+    return new StepSegment(field, step, arr[0], arr[arr.length - 1])
   }
 }
 
 class ValueSegment implements CronSegment {
   field: FieldWrapper
-  type: CronType = CronType.Value
+  type: FieldPattern = FieldPattern.Value
   value: number
 
   constructor(field: FieldWrapper, value: number) {
@@ -276,7 +271,7 @@ class ValueSegment implements CronSegment {
 class CombinedSegment implements CronSegment {
   static segmentFactories: SegmentFromString[] = [
     AnySegment.fromString,
-    EverySegment.fromString,
+    StepSegment.fromString,
     RangeSegment.fromString,
     ValueSegment.fromString,
   ]
@@ -293,7 +288,7 @@ class CombinedSegment implements CronSegment {
     if (this.segments.length == 1) {
       return this.segments[0].type
     }
-    return CronType.Range
+    return FieldPattern.Range
   }
 
   addSegment(segment: CronSegment) {
@@ -377,7 +372,7 @@ function cronToSegment(cron: string, field: FieldWrapper) {
 function arrayToSegment(arr: number[], field: FieldWrapper) {
   for (const fromArray of [
     AnySegment.fromArray,
-    EverySegment.fromArray,
+    StepSegment.fromArray,
     CombinedSegment.fromArray,
   ]) {
     const seg = fromArray(arr, field)
@@ -390,11 +385,11 @@ function arrayToSegment(arr: number[], field: FieldWrapper) {
 
 export {
   AnySegment,
+  arrayToSegment,
   CombinedSegment,
-  EverySegment,
+  cronToSegment,
   NoSpecificSegment,
   RangeSegment,
+  StepSegment,
   ValueSegment,
-  arrayToSegment,
-  cronToSegment,
 }

core/src/index.ts

@@ -22,7 +22,7 @@ export {
 export { Locale, getLocale } from './locale'
 export type * from './locale/types'
 export type * from './types'
-export { CronType, FieldWrapper, TextPosition } from './types'
+export { FieldPattern, FieldWrapper, TextPosition } from './types'
 export { defaultItems, genItems, pad, splitArray, type toText } from './util'
 
 export const CronCorePlugin = {

core/src/locale/cn.ts

@@ -6,20 +6,20 @@ const locale: Localization = {
     suffix: '',
     text: '未知',
     '*': {
-      empty: { text: '每 {{field.id}}' },
+      any: { text: '每 {{field.id}}' },
       value: { text: '{{value.text}}' },
       range: { text: '{{start.text}}-{{end.text}}' },
-      everyX: { text: '每 {{every.value}}' },
+      step: { text: '每 {{step.value}}' },
     },
     month: {
       '*': { prefix: '的' },
-      empty: { text: '每月' },
+      any: { text: '每月' },
       value: { text: '{{value.alt}}' },
       range: { text: '{{start.alt}}-{{end.alt}}' },
     },
     day: {
       '*': { prefix: '的' },
-      empty: { text: '每日' },
+      any: { text: '每日' },
       value: { text: '{{value.alt}}号' },
       range: { text: '{{start.alt}}号-{{end.alt}}号' },
       noSpecific: {
@@ -28,7 +28,7 @@ const locale: Localization = {
     },
     dayOfWeek: {
       '*': { prefix: '的' },
-      empty: { text: '一周的每一天' },
+      any: { text: '一周的每一天' },
       value: { text: '{{value.alt}}' },
       range: { text: '{{start.alt}}-{{end.alt}}' },
       noSpecific: {
@@ -37,15 +37,15 @@ const locale: Localization = {
     },
     hour: {
       '*': { prefix: '的' },
-      empty: { text: '每小时' },
+      any: { text: '每小时' },
     },
     minute: {
       '*': { prefix: ':' },
-      empty: { text: '每分钟' },
+      any: { text: '每分钟' },
     },
     second: {
       '*': { prefix: ':' },
-      empty: { text: '每秒' },
+      any: { text: '每秒' },
     },
   },
   minute: {
@@ -58,7 +58,7 @@ const locale: Localization = {
         prefix: ':',
         suffix: '分钟',
       },
-      empty: { text: '每' },
+      any: { text: '每' },
     },
   },
   day: {
@@ -68,7 +68,7 @@ const locale: Localization = {
     text: '周',
     dayOfWeek: {
       '*': { prefix: '的' },
-      empty: { text: '每天' },
+      any: { text: '每天' },
       value: { text: '{{value.alt}}' },
       range: { text: '{{start.alt}}-{{end.alt}}' },
     },
@@ -100,7 +100,7 @@ const locale: Localization = {
         prefix: ':',
         suffix: '秒',
       },
-      empty: { text: '每' },
+      any: { text: '每' },
     },
   },
   'q-hour': {