feat(quartz): Steps starting from x #76

Author: abichinger

core/src/__tests__/cron.spec.ts

@@ -1,10 +1,10 @@
 import { arrayToSegment, cronToSegment } from '@/cron'
-import { FieldWrapper } from '@/types'
+import { FieldWrapper, type CronFormat } from '@/types'
 import { genItems } from '@/util'
 import { describe, expect, it } from 'vitest'
 
-const r = (min: number, max: number) => {
-  return new FieldWrapper({ id: 'fieldId', items: genItems(min, max) })
+const r = (min: number, max: number, format: CronFormat = 'crontab') => {
+  return new FieldWrapper({ id: 'fieldId', items: genItems(min, max) }, { format })
 }
 
 describe('segments', () => {
@@ -23,6 +23,7 @@ describe('segments', () => {
     expect(cronToArray('*/10', r(1, 10))).toEqual([1])
     expect(cronToArray('2-6/2', r(1, 10))).toEqual([2, 4, 6])
     expect(cronToArray('3-5/10', r(1, 10))).toEqual([3])
+    expect(cronToArray('5/2', r(1, 10, 'quartz'))).toEqual([5, 7, 9])
 
     expect(cronToArray('x', r(0, 59))).toBe(null)
     expect(cronToArray('1-60', r(0, 59))).toBe(null)
@@ -32,6 +33,7 @@ describe('segments', () => {
     expect(cronToArray('*/90', r(1, 10))).toBe(null)
     expect(cronToArray('*/11', r(1, 10))).toBe(null)
     expect(cronToArray('2-6/11', r(1, 10))).toBe(null)
+    expect(cronToArray('5/2', r(1, 10))).toEqual(null)
   })
 
   it('arrayToSegment', () => {
@@ -48,5 +50,7 @@ describe('segments', () => {
     expect(arrayToCron([5, 12, 19, 26], r(5, 30))).toEqual('*/7')
     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')
+    expect(arrayToCron([5, 7, 9], r(1, 10, 'quartz'))).toEqual('5/2')
+    expect(arrayToCron([5, 7, 9], r(1, 10))).toEqual('5-9/2')
   })
 })

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

@@ -7,10 +7,13 @@ import { nextTick, ref } from 'vue'
 import { useCronSegment } from '../cron-segment'
 
 const f = () => {
-  const fieldDesc = new FieldWrapper({
-    id: 'month',
-    items: defaultItems('en').monthItems,
-  })
+  const fieldDesc = new FieldWrapper(
+    {
+      id: 'month',
+      items: defaultItems('en').monthItems,
+    },
+    { format: 'crontab' },
+  )
 
   const period = { id: 'year', value: [] }
 

core/src/components/cron-core.ts

@@ -161,7 +161,7 @@ export function useCron(options: CronOptions) {
   const periodPrefix = ref('')
   const periodSuffix = ref('')
   const segments = fields.map((f) => {
-    return useCronSegment({ field: new FieldWrapper(f), l10n, period })
+    return useCronSegment({ field: new FieldWrapper(f, { format: format }), l10n, period })
   })
 
   const segmentMap = new Map(segments.map((s) => [s.id, s]))

core/src/cron.ts

@@ -135,8 +135,20 @@ function _rangeWithStep(n: number, min: number, max: number) {
   }
   return res
 }
+
+function parseRange(s: string, field: FieldWrapper): [number, number] {
+  if (s === '*') {
+    return [field.min, field.max]
+  }
+  const range = s.split('-').map((s) => parseInt(s))
+  if (range.length === 1 && field.ctx.format !== 'crontab') {
+    return [range[0], field.max]
+  }
+  return [range[0], range[1]]
+}
+
 class StepSegment implements CronSegment {
-  static re = /^(\*|\d+-\d+)\/\d+$/
+  static re = /^(\*|\d+(-\d+)?)\/\d+$/
 
   field: FieldWrapper
   step: number
@@ -152,14 +164,20 @@ class StepSegment implements CronSegment {
 
   get type() {
     const { min, max } = this.field
+    if (this.field.ctx.format !== 'crontab' && this.start !== min && max - this.end < this.step) {
+      return FieldPattern.StepFrom
+    }
     if (this.start !== min || max - this.end >= this.step) {
       return FieldPattern.RangeStep
     }
     return FieldPattern.Step
   }
 
   toCron() {
-    if (this.type == FieldPattern.RangeStep) {
+    if (this.type === FieldPattern.StepFrom) {
+      return `${this.start}/${this.step}`
+    }
+    if (this.type === FieldPattern.RangeStep) {
       return `${this.start}-${this.end}/${this.step}`
     }
     return `*/${this.step}`
@@ -189,9 +207,7 @@ class StepSegment implements CronSegment {
       return null
     }
 
-    const range = str.split('-').map((s) => parseInt(s))
-    const min = rangeStr == '*' ? field.min : range[0]
-    const max = rangeStr == '*' ? field.max : range[1]
+    const [min, max] = parseRange(rangeStr, field)
 
     if (_rangeWithStep(step, min, max).length == 0) {
       return null

core/src/locale/en.ts

@@ -11,12 +11,14 @@ const locale: Localization = {
       range: { text: '{{start.text}}-{{end.text}}' },
       step: { text: 'every {{step.value}}' },
       rangeStep: { text: '{{start.text}}-{{end.text}}/{{step.value}}' },
+      stepFrom: { text: '{{start.text}}/{{step.value}}' },
     },
     month: {
       '*': { prefix: 'in' },
       value: { text: '{{value.alt}}' },
       range: { text: '{{start.alt}}-{{end.alt}}' },
       rangeStep: { text: '{{start.alt}}-{{end.alt}}/{{step.value}}' },
+      stepFrom: { text: '{{start.alt}}/{{step.value}}' },
     },
     day: {
       '*': { prefix: 'on' },
@@ -30,6 +32,7 @@ const locale: Localization = {
       value: { text: '{{value.alt}}' },
       range: { text: '{{start.alt}}-{{end.alt}}' },
       rangeStep: { text: '{{start.alt}}-{{end.alt}}/{{step.value}}' },
+      stepFrom: { text: '{{start.alt}}/{{step.value}}' },
       noSpecific: {
         text: 'no specific day of the week',
       },

core/src/types.ts

@@ -15,13 +15,14 @@ export type SegmentFromArray = (arr: number[], field: FieldWrapper) => CronSegme
 export type SegmentFromString = (str: string, field: FieldWrapper) => CronSegment | null
 
 export enum FieldPattern {
-  Any = 'any',
-  Value = 'value',
-  Range = 'range',
-  Step = 'step',
-  RangeStep = 'rangeStep',
+  Any = 'any', // *
+  Value = 'value', // a
+  Range = 'range', // a-b
+  Step = 'step', // */x
+  StepFrom = `stepFrom`, // a/x
+  RangeStep = 'rangeStep', // a-b/x
   Combined = 'combined',
-  NoSpecific = 'noSpecific',
+  NoSpecific = 'noSpecific', // ?
 }
 
 export enum TextPosition {
@@ -61,12 +62,17 @@ export interface Period {
   text?: string
 }
 
+interface FieldContext {
+  format: CronFormat
+}
 export class FieldWrapper {
   field: Field
   itemMap: Record<number, FieldItem>
+  ctx: FieldContext
 
-  constructor(field: Field) {
+  constructor(field: Field, ctx: FieldContext) {
     this.field = field
+    this.ctx = ctx
 
     this.itemMap = this.field.items.reduce(
       (acc, item) => {