cronli5 0.2.0 → 0.2.1

package/dist/cronli5.js

@@ -107,6 +107,43 @@ function orderWeekdaysForDisplay(segments) {
 function toFieldNumber(token, numberMap) {
   return isNonNegativeInteger(token) ? +token : numberMap[token.toUpperCase()];
 }
+function segmentsOf(ir, field) {
+  return ir.analyses.segments[field] ?? [];
+}
+function stepSegment(ir, field) {
+  return segmentsOf(ir, field)[0];
+}
+function singleValues(segments) {
+  const values = [];
+  for (const segment of segments) {
+    if (segment.kind !== "single") {
+      return null;
+    }
+    values.push(+segment.value);
+  }
+  return values;
+}
+function offsetCleanStride(stride) {
+  return stride.start < stride.interval && 24 % stride.interval === 0;
+}
+function hourListStride(values) {
+  if (values.length < 2) {
+    return null;
+  }
+  const interval = values[1] - values[0];
+  if (interval < 2) {
+    return null;
+  }
+  for (let i = 2; i < values.length; i += 1) {
+    if (values[i] - values[i - 1] !== interval) {
+      return null;
+    }
+  }
+  if (values[0] !== 0 && values.length < 5) {
+    return null;
+  }
+  return { interval, last: values[values.length - 1], start: values[0] };
+}
 
 // src/core/validate.ts
 function validateCronPattern(cronPattern) {
@@ -455,6 +492,9 @@ function isDiscreteList(field) {
 function isDiscreteHours(hourField) {
   return hourField !== "*" && !isPlainRange(hourField) && !isPlainStep(hourField);
 }
+function isOpenStep(field) {
+  return field.indexOf("/") !== -1 && field.indexOf("-") === -1 && field.indexOf(",") === -1;
+}
 
 // src/core/analyze.ts
 function getOccurrences(start, interval, max) {
@@ -591,9 +631,9 @@ function analyze(pattern) {
     segments
   };
   const content = { analyses, pattern, shapes };
-  return { ...content, plan: selectStrategy(content) };
+  return { ...content, plan: selectPlan(content) };
 }
-function selectStrategy(content) {
+function selectPlan(content) {
   const { analyses, pattern, shapes } = content;
   if (pattern.second !== "0") {
     const seconds = planSeconds(pattern, shapes, analyses);
@@ -1026,7 +1066,7 @@ function secondsClause(ir, anchor, opts) {
   }
   if (shape === "step") {
     return stepCycle60(
-      ir.analyses.segments.second[0],
+      stepSegment(ir, "second"),
       "second",
       anchor,
       opts
@@ -1041,12 +1081,12 @@ function secondsClause(ir, anchor, opts) {
     return "at " + getNumber(secondField, opts) + " " + pluralize(secondField, "second") + " past the " + anchor;
   }
   return strideFromSegments(
-    ir.analyses.segments.second,
+    segmentsOf(ir, "second"),
     "second",
     anchor,
     opts
   ) ?? listPastThe(
-    segmentWords(ir.analyses.segments.second, opts),
+    segmentWords(segmentsOf(ir, "second"), opts),
     "second",
     anchor,
     opts
@@ -1063,15 +1103,15 @@ function renderRangeOfMinutes(ir, plan, opts) {
   return minuteRangeLead(ir.pattern.minute, opts) + trailingQualifier(ir, opts);
 }
 function renderMultipleMinutes(ir, plan, opts) {
-  const stride = strideFromSegments(ir.analyses.segments.minute, "minute", "hour", opts);
+  const stride = strideFromSegments(segmentsOf(ir, "minute"), "minute", "hour", opts);
   return (stride ?? listPastThe(segmentWords(
-    ir.analyses.segments.minute,
+    segmentsOf(ir, "minute"),
     opts
   ), "minute", "hour", opts)) + trailingQualifier(ir, opts);
 }
 function renderMinuteFrequency(ir, plan, opts) {
   let phrase = stepCycle60(
-    ir.analyses.segments.minute[0],
+    stepSegment(ir, "minute"),
     "minute",
     "hour",
     opts
@@ -1080,9 +1120,14 @@ function renderMinuteFrequency(ir, plan, opts) {
     const cadence = unevenHourCadence(ir, opts);
     phrase += cadence ? ", " + cadence : " during the " + hourTimesFromPlan(ir, plan.hours.times, false, opts) + " hours";
   } else if (plan.hours.kind === "window") {
-    phrase += " " + hourWindow(plan.hours, opts);
+    phrase += " " + rangeWindow({
+      continuous: false,
+      from: plan.hours.from,
+      throughMinute: plan.hours.last,
+      to: plan.hours.to
+    }, opts);
   } else if (plan.hours.kind === "step") {
-    phrase += " " + everyNthHour(ir.analyses.segments.hour[0], opts);
+    phrase += " " + everyNthHour(stepSegment(ir, "hour"), opts);
   }
   return phrase + trailingQualifier(ir, opts);
 }
@@ -1110,8 +1155,8 @@ function renderMinutesAcrossHours(ir, plan, opts) {
     }
     return lead2 + " during the " + hourTimesFromPlan(ir, plan.times, false, opts) + " hours" + trailingQualifier(ir, opts);
   }
-  const lead = strideFromSegments(ir.analyses.segments.minute, "minute", "hour", opts) ?? listPastThe(
-    segmentWords(ir.analyses.segments.minute, opts),
+  const lead = strideFromSegments(segmentsOf(ir, "minute"), "minute", "hour", opts) ?? listPastThe(
+    segmentWords(segmentsOf(ir, "minute"), opts),
     "minute",
     "hour",
     opts
@@ -1136,12 +1181,12 @@ function everyNthHour(segment, opts) {
   return start === 0 ? base : base + " starting at " + getTime({ hour: start, minute: 0 }, opts);
 }
 function renderMinuteSpanAcrossHourStep(ir, plan, opts) {
-  const segment = ir.analyses.segments.hour[0];
+  const segment = stepSegment(ir, "hour");
   if (plan.form === "wildcard") {
     return "every minute " + everyNthHour(segment, opts) + trailingQualifier(ir, opts);
   }
-  const lead = plan.form === "list" ? strideFromSegments(ir.analyses.segments.minute, "minute", "hour", opts) ?? listPastThe(
-    segmentWords(ir.analyses.segments.minute, opts),
+  const lead = plan.form === "list" ? strideFromSegments(segmentsOf(ir, "minute"), "minute", "hour", opts) ?? listPastThe(
+    segmentWords(segmentsOf(ir, "minute"), opts),
     "minute",
     "hour",
     opts
@@ -1172,12 +1217,12 @@ function rangeMinuteLead(ir, opts) {
     return "every hour";
   }
   return strideFromSegments(
-    ir.analyses.segments.minute,
+    segmentsOf(ir, "minute"),
     "minute",
     "hour",
     opts
   ) ?? listPastThe(
-    segmentWords(ir.analyses.segments.minute, opts),
+    segmentWords(segmentsOf(ir, "minute"), opts),
     "minute",
     "hour",
     opts
@@ -1188,21 +1233,28 @@ function renderHourStep(ir, plan, opts) {
   if (cadence !== null) {
     return cadence + trailingQualifier(ir, opts);
   }
-  return stepHours(ir.analyses.segments.hour[0], opts) + trailingQualifier(ir, opts);
+  return stepHours(stepSegment(ir, "hour"), opts) + trailingQualifier(ir, opts);
 }
 function boundedWindow(plan) {
-  const last = plan.minuteForm === "wildcard" ? plan.boundMinute ?? 0 : 0;
-  return { from: plan.from, last, to: plan.to };
+  const continuous = plan.minuteForm === "wildcard";
+  const closeMinute = continuous ? plan.boundMinute ?? 0 : 0;
+  return { from: plan.from, closeMinute, to: plan.to, continuous };
 }
-function rangeWindow(from, to, throughMinute, opts) {
+function rangeWindow(window, opts) {
+  const { from, to, throughMinute, continuous } = window;
   const open = "from " + getTime({ hour: from, minute: 0 }, opts);
   if (opts.style.untilWindow && !opts.short && from !== to) {
-    return open + " until " + getTime({ hour: (to + 1) % 24, minute: 0 }, opts);
+    return continuous ? open + " until " + getTime({ hour: (to + 1) % 24, minute: 0 }, opts) : open + through(opts) + getTime({ hour: to, minute: 0 }, opts);
   }
   return open + through(opts) + getTime({ hour: to, minute: throughMinute }, opts);
 }
 function hourWindow(window, opts) {
-  return rangeWindow(window.from, window.to, window.last, opts);
+  return rangeWindow({
+    continuous: window.continuous,
+    from: window.from,
+    throughMinute: window.closeMinute,
+    to: window.to
+  }, opts);
 }
 function renderClockTimes(ir, plan, opts) {
   if (ir.shapes.minute === "single") {
@@ -1232,7 +1284,7 @@ function renderCompactClockTimes(ir, plan, opts) {
     if (cadence2 !== null) {
       return cadence2;
     }
-    const hasRange = ir.analyses.segments.hour.some(function range(segment) {
+    const hasRange = segmentsOf(ir, "hour").some(function range(segment) {
       return segment.kind === "range";
     });
     if (hasRange && !ir.analyses.clockSecond) {
@@ -1244,8 +1296,8 @@ function renderCompactClockTimes(ir, plan, opts) {
   const minuteLead = (
     // The non-fold branch is a minute list, which has segments. An
     // offset/uneven step enumerated to that list reads as a stride.
-    strideFromSegments(ir.analyses.segments.minute, "minute", "hour", opts) ?? listPastThe(
-      segmentWords(ir.analyses.segments.minute, opts),
+    strideFromSegments(segmentsOf(ir, "minute"), "minute", "hour", opts) ?? listPastThe(
+      segmentWords(segmentsOf(ir, "minute"), opts),
       "minute",
       "hour",
       opts
@@ -1258,42 +1310,38 @@ function renderCompactClockTimes(ir, plan, opts) {
 function foldedHourWindows(ir, plan, opts) {
   const minute = plan.minute;
   const windows = [];
-  const outliers = collectHourOutliers(ir);
-  const times = outliers.hours.map(function time(hour) {
+  const times = collectHourOutliers(ir).map(function time(hour) {
     return getTime({ hour, minute }, opts);
   });
-  ir.analyses.segments.hour.forEach(function classify(segment) {
+  segmentsOf(ir, "hour").forEach(function classify(segment) {
     if (segment.kind === "range") {
-      windows.push(rangeWindow(
-        +segment.bounds[0],
-        +segment.bounds[1],
-        minute,
-        opts
-      ));
+      windows.push(rangeWindow({
+        continuous: false,
+        from: +segment.bounds[0],
+        throughMinute: minute,
+        to: +segment.bounds[1]
+      }, opts));
     }
   });
   const phrase = rangeMinuteLead(ir, opts) + " " + joinList(windows, opts);
-  return phrase + outlierTail(times, outliers.pureStrays, opts);
+  return phrase + outlierTail(times, opts);
 }
 function collectHourOutliers(ir) {
   const hours = [];
-  let pureStrays = true;
-  ir.analyses.segments.hour.forEach(function classify(segment) {
+  segmentsOf(ir, "hour").forEach(function classify(segment) {
     if (segment.kind === "step") {
       hours.push(...segment.fires);
-      pureStrays = false;
     } else if (segment.kind !== "range") {
       hours.push(+segment.value);
     }
   });
-  return { hours, pureStrays };
+  return hours;
 }
-function outlierTail(times, pureStrays, opts) {
+function outlierTail(times, opts) {
   if (!times.length) {
     return "";
   }
-  const connector = pureStrays && opts.style.untilWindow && !opts.short ? " plus " : " and at ";
-  return connector + joinList(times, opts);
+  return " and at " + joinList(times, opts);
 }
 function isCadenceField(token) {
   return token === "*" || token.startsWith("*/") && token.indexOf("-") === -1;
@@ -1307,7 +1355,7 @@ function leadingCadence(ir, opts) {
     const text = minute === "*" ? "every minute" : (
       // A clean minute step's first segment is a step segment.
       stepCycle60(
-        ir.analyses.segments.minute[0],
+        stepSegment(ir, "minute"),
         "minute",
         "hour",
         opts
@@ -1325,7 +1373,7 @@ function minuteConfinement(ir, opts) {
   if (isCadenceField(minute)) {
     return " of every other minute";
   }
-  const segments = ir.analyses.segments.minute;
+  const segments = segmentsOf(ir, "minute");
   if (ir.shapes.minute === "single") {
     return " during minute :" + pad(minute);
   }
@@ -1359,7 +1407,12 @@ function hourConfinement(ir, opts) {
   }
   if (ir.shapes.hour === "range") {
     const bounds = hour.split("-");
-    return " " + rangeWindow(+bounds[0], +bounds[1], 0, opts);
+    return " " + rangeWindow({
+      continuous: ir.pattern.minute === "*",
+      from: +bounds[0],
+      throughMinute: 0,
+      to: +bounds[1]
+    }, opts);
   }
   return " during the " + hourSegmentTimes(ir, { minute: 0, second: null }, false, opts) + " hours";
 }
@@ -1370,14 +1423,14 @@ function confinableHour(ir) {
   if (ir.shapes.hour !== "step") {
     return true;
   }
-  const segment = ir.analyses.segments.hour[0];
+  const segment = stepSegment(ir, "hour");
   return ir.pattern.hour === "*/2" || segment.startToken.indexOf("-") !== -1;
 }
 function isMinuteStride(ir) {
   if (ir.shapes.minute !== "list") {
     return false;
   }
-  const values = singleValues(ir.analyses.segments.minute);
+  const values = singleValues(segmentsOf(ir, "minute"));
   return values !== null && arithmeticStep(values) !== null;
 }
 function confinementEligible(ir, lead) {
@@ -1447,16 +1500,6 @@ function renderStride(stride, opts) {
   const num = seriesNumber();
   return cadence + " from " + num(start) + through(opts) + num(last) + " " + pluralize(last, unit) + " past the " + anchor;
 }
-function singleValues(segments) {
-  const values = [];
-  for (const segment of segments) {
-    if (segment.kind !== "single") {
-      return null;
-    }
-    values.push(+segment.value);
-  }
-  return values;
-}
 function strideFromSegments(segments, unit, anchor, opts) {
   const values = singleValues(segments);
   const step = values && arithmeticStep(values);
@@ -1505,9 +1548,6 @@ function hourStrideCadence(stride, opts) {
   }
   return cadence + " from " + getTime({ hour: start, minute: 0 }, opts) + through(opts) + getTime({ hour: last, minute: 0 }, opts);
 }
-function offsetCleanStride(stride) {
-  return stride.start < stride.interval && 24 % stride.interval === 0;
-}
 function unevenHourCadence(ir, opts) {
   const stride = hourStride(ir);
   if (!stride || offsetCleanStride(stride)) {
@@ -1515,26 +1555,8 @@ function unevenHourCadence(ir, opts) {
   }
   return hourStrideCadence(stride, opts);
 }
-function hourListStride(values) {
-  if (values.length < 2) {
-    return null;
-  }
-  const interval = values[1] - values[0];
-  if (interval < 2) {
-    return null;
-  }
-  for (let i = 2; i < values.length; i += 1) {
-    if (values[i] - values[i - 1] !== interval) {
-      return null;
-    }
-  }
-  if (values[0] !== 0 && values.length < 5) {
-    return null;
-  }
-  return { interval, last: values[values.length - 1], start: values[0] };
-}
 function hourStride(ir) {
-  const segments = ir.analyses.segments.hour;
+  const segments = segmentsOf(ir, "hour");
   if (segments.length === 1 && segments[0].kind === "step") {
     const segment = segments[0];
     if (segment.fires.length < 2) {
@@ -1581,7 +1603,7 @@ function hourCadence(ir, minute, opts) {
   return hourCadenceLead(ir, minute, opts) + ", " + hourStrideCadence(stride, opts) + trailingQualifier(ir, opts);
 }
 function cleanStrideSegment(ir) {
-  const segments = ir.analyses.segments.hour;
+  const segments = segmentsOf(ir, "hour");
   const segment = segments.length === 1 && segments[0];
   if (!segment || segment.kind !== "step" || segment.startToken.indexOf("-") !== -1 || !(segment.interval in stepOrdinals)) {
     return null;
@@ -1589,28 +1611,28 @@ function cleanStrideSegment(ir) {
   return segment;
 }
 function hasHourWindow(ir) {
-  return ir.analyses.segments.hour.some(function range(segment) {
+  return segmentsOf(ir, "hour").some(function range(segment) {
     return segment.kind === "range";
   });
 }
 function hourRangeWindowTail(ir, opts) {
   const windows = [];
-  const outliers = collectHourOutliers(ir);
-  ir.analyses.segments.hour.forEach(function classify(segment) {
+  const outlierHours = collectHourOutliers(ir);
+  segmentsOf(ir, "hour").forEach(function classify(segment) {
     if (segment.kind === "range") {
-      windows.push(rangeWindow(
-        +segment.bounds[0],
-        +segment.bounds[1],
-        0,
-        opts
-      ));
+      windows.push(rangeWindow({
+        continuous: false,
+        from: +segment.bounds[0],
+        throughMinute: 0,
+        to: +segment.bounds[1]
+      }, opts));
     }
   });
   const phrase = "every hour " + joinList(windows, opts);
-  const times = outliers.hours.map(function time(hour) {
+  const times = outlierHours.map(function time(hour) {
     return getTime({ hour, minute: 0 }, opts);
   });
-  return phrase + outlierTail(times, outliers.pureStrays, opts);
+  return phrase + outlierTail(times, opts);
 }
 function hourRangeCadence(ir, minute, opts) {
   if (minute !== 0 || !hasHourWindow(ir)) {
@@ -1695,7 +1717,7 @@ function segmentHours(segment) {
 }
 function hourSegmentTimes(ir, fold, atContext, opts) {
   const { minute, second } = fold;
-  const segments = ir.analyses.segments.hour;
+  const segments = segmentsOf(ir, "hour");
   const plain = mixedTwelve(segments.flatMap(function entries(segment) {
     return segmentHours(segment).map(function entry(hour) {
       return { hour: +hour, minute, second };
@@ -1815,7 +1837,7 @@ function datePhrase(ir, words, opts) {
 }
 function monthFoldsIntoDate(ir) {
   return !oddEvenMonth(ir.pattern.month) && // Reached only with a restricted month, which has segments.
-  ir.analyses.segments.month.every(function flat(segment) {
+  segmentsOf(ir, "month").every(function flat(segment) {
     return segment.kind !== "range";
   });
 }
@@ -1846,7 +1868,7 @@ function dayUnionDatePieces(ir, opts) {
     return [oddEven];
   }
   const pieces = [];
-  ir.analyses.segments.date.forEach(function expand(segment) {
+  segmentsOf(ir, "date").forEach(function expand(segment) {
     if (segment.kind === "range") {
       pieces.push("from the " + getOrdinal(segment.bounds[0]) + through(opts) + "the " + getOrdinal(segment.bounds[1]));
     } else if (segment.kind === "step") {
@@ -1866,7 +1888,7 @@ function dayUnionWeekdayPieces(ir, opts) {
     return [quartz.replace(/^on /, "")];
   }
   const pieces = [];
-  ir.analyses.segments.weekday.forEach(function expand(segment) {
+  segmentsOf(ir, "weekday").forEach(function expand(segment) {
     if (segment.kind === "range" && segment.bounds[0] === "1" && segment.bounds[1] === "5") {
       pieces.push("a weekday");
     } else if (segment.kind === "range") {
@@ -1947,7 +1969,7 @@ function quartzWeekdayPhrase(weekdayField, opts) {
 function monthDatePhrase(ir, opts) {
   const month = monthName(ir, opts);
   const days = renderSegments(
-    ir.analyses.segments.date,
+    segmentsOf(ir, "date"),
     opts.style.ordinals ? getOrdinal : cardinalDay,
     opts
   );
@@ -1990,14 +2012,14 @@ function stepDates(dateField) {
   return phrase;
 }
 function dateOrdinals(ir, opts) {
-  return renderSegments(ir.analyses.segments.date, getOrdinal, opts);
+  return renderSegments(segmentsOf(ir, "date"), getOrdinal, opts);
 }
 function monthName(ir, opts) {
   const oddEven = oddEvenMonth(ir.pattern.month);
   if (oddEven) {
     return oddEven;
   }
-  return renderSegments(ir.analyses.segments.month, function name(value) {
+  return renderSegments(segmentsOf(ir, "month"), function name(value) {
     return getMonth(value, opts);
   }, opts);
 }
@@ -2015,7 +2037,7 @@ function oddEvenMonth(monthField) {
   return start === "2" ? "every even-numbered month" : null;
 }
 function weekdayPhrase(ir, recurring, opts) {
-  const segments = orderWeekdaysForDisplay(ir.analyses.segments.weekday);
+  const segments = orderWeekdaysForDisplay(segmentsOf(ir, "weekday"));
   const hasRange = segments.some(function range(segment) {
     return segment.kind === "range";
   });
@@ -2043,9 +2065,6 @@ function renderSegments(segments, word, opts) {
   });
   return joinList(pieces, opts);
 }
-function isOpenStep(field) {
-  return field.indexOf("/") !== -1 && field.indexOf("-") === -1 && field.indexOf(",") === -1;
-}
 function applyYear(description, ir, opts) {
   const yearField = ir.pattern.year;
   if (yearField === "*") {
@@ -2179,7 +2198,7 @@ function interpretCronPattern(cronPattern, lang, opts) {
     return lang.reboot;
   }
   const ir = analyze(prepare(cronPattern, opts));
-  const plan = lang.strategy ? lang.strategy(ir, ir.plan) : ir.plan;
+  const plan = lang.plan ? lang.plan(ir, ir.plan) : ir.plan;
   return lang.describe({ ...ir, plan }, opts);
 }
 var cronli5_default = cronli5;