feat: localDate/localTime/semver2 min/max to allow undefined inputs

kirillgroshkov · kirillgroshkov · commit 89bea6f4140d · 2024-06-06T13:04:49.000+02:00
diff --git a/src/datetime/localDate.test.ts b/src/datetime/localDate.test.ts
@@ -101,6 +101,9 @@ test('sort', () => {
 
   expect(localDate.min(items).toString()).toBe('2022-01-01')
   expect(localDate.max(items).toString()).toBe('2022-01-03')
+
+  // Test that undefined values are allowed
+  expect(localDate.max([...items, undefined]).toString()).toBe('2022-01-03')
 })
 
 test('add basic', () => {
diff --git a/src/datetime/localDate.ts b/src/datetime/localDate.ts
@@ -1,4 +1,5 @@
 import { _assert } from '../error/assert'
+import { _isTruthy } from '../is.util'
 import { Iterable2 } from '../iter/iterable2'
 import type {
   Inclusiveness,
@@ -18,6 +19,7 @@ const MDAYS = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
 const DATE_REGEX = /^(\d\d\d\d)-(\d\d)-(\d\d)$/
 
 export type LocalDateInput = LocalDate | Date | IsoDateString
+export type LocalDateInputNullable = LocalDateInput | null | undefined
 export type LocalDateFormatter = (ld: LocalDate) => string
 
 /**
@@ -517,7 +519,7 @@ class LocalDateFactory {
    * Tries to construct LocalDate from LocalDateInput, returns null otherwise.
    * Does not throw (returns null instead).
    */
-  parseOrNull(d: LocalDateInput | undefined | null): LocalDate | null {
+  parseOrNull(d: LocalDateInputNullable): LocalDate | null {
     if (!d) return null
     if (d instanceof LocalDate) return d
     if (d instanceof Date) {
@@ -619,35 +621,39 @@ class LocalDateFactory {
   /**
    * Returns the earliest (min) LocalDate from the array, or undefined if the array is empty.
    */
-  minOrUndefined(items: LocalDateInput[]): LocalDate | undefined {
+  minOrUndefined(items: LocalDateInputNullable[]): LocalDate | undefined {
     return items.length ? this.min(items) : undefined
   }
 
   /**
    * Returns the earliest LocalDate from the array.
    * Throws if the array is empty.
    */
-  min(items: LocalDateInput[]): LocalDate {
-    _assert(items.length, 'localDate.min called on empty array')
+  min(items: LocalDateInputNullable[]): LocalDate {
+    const items2 = items.filter(_isTruthy)
+    _assert(items2.length, 'localDate.min called on empty array')
 
-    return items.map(i => this.of(i)).reduce((min, item) => (min.isSameOrBefore(item) ? min : item))
+    return items2
+      .map(i => this.of(i))
+      .reduce((min, item) => (min.isSameOrBefore(item) ? min : item))
   }
 
   /**
    * Returns the latest (max) LocalDate from the array, or undefined if the array is empty.
    */
-  maxOrUndefined(items: LocalDateInput[]): LocalDate | undefined {
+  maxOrUndefined(items: LocalDateInputNullable[]): LocalDate | undefined {
     return items.length ? this.max(items) : undefined
   }
 
   /**
    * Returns the latest LocalDate from the array.
    * Throws if the array is empty.
    */
-  max(items: LocalDateInput[]): LocalDate {
-    _assert(items.length, 'localDate.max called on empty array')
+  max(items: LocalDateInputNullable[]): LocalDate {
+    const items2 = items.filter(_isTruthy)
+    _assert(items2.length, 'localDate.max called on empty array')
 
-    return items.map(i => this.of(i)).reduce((max, item) => (max.isSameOrAfter(item) ? max : item))
+    return items2.map(i => this.of(i)).reduce((max, item) => (max.isSameOrAfter(item) ? max : item))
   }
 
   /**
@@ -711,14 +717,14 @@ class LocalDateFactory {
    *
    * Similar to `localDate.orToday`, but that will instead return Today on falsy input.
    */
-  orUndefined(d: LocalDateInput | null | undefined): LocalDate | undefined {
+  orUndefined(d: LocalDateInputNullable): LocalDate | undefined {
     return d ? this.of(d) : undefined
   }
 
   /**
    * Creates a LocalDate from the input, unless it's falsy - then returns localDate.today.
    */
-  orToday(d: LocalDateInput | null | undefined): LocalDate {
+  orToday(d: LocalDateInputNullable): LocalDate {
     return d ? this.of(d) : this.today()
   }
 }
diff --git a/src/datetime/localTime.ts b/src/datetime/localTime.ts
@@ -1,4 +1,5 @@
 import { _assert } from '../error/assert'
+import { _isTruthy } from '../is.util'
 import { _ms } from '../time/time.util'
 import type {
   Inclusiveness,
@@ -27,6 +28,7 @@ export enum ISODayOfWeek {
 }
 
 export type LocalTimeInput = LocalTime | Date | IsoDateTimeString | UnixTimestampNumber
+export type LocalTimeInputNullable = LocalTimeInput | null | undefined
 export type LocalTimeFormatter = (ld: LocalTime) => string
 
 export type DateTimeObject = DateObject & TimeObject
@@ -711,7 +713,7 @@ class LocalTimeFactory {
   /**
    * Returns null if invalid
    */
-  parseOrNull(d: LocalTimeInput | undefined | null): LocalTime | null {
+  parseOrNull(d: LocalTimeInputNullable): LocalTime | null {
     if (!d) return null
     if (d instanceof LocalTime) return d
 
@@ -768,7 +770,7 @@ class LocalTimeFactory {
     return date.valueOf() / 1000
   }
 
-  isValid(d: LocalTimeInput | undefined | null): boolean {
+  isValid(d: LocalTimeInputNullable): boolean {
     return this.parseOrNull(d) !== null
   }
 
@@ -800,14 +802,14 @@ class LocalTimeFactory {
    *
    * `localTime` function will instead return LocalTime of `now` for falsy input.
    */
-  orUndefined(d: LocalTimeInput | null | undefined): LocalTime | undefined {
+  orUndefined(d: LocalTimeInputNullable): LocalTime | undefined {
     return d ? this.of(d) : undefined
   }
 
   /**
    * Creates a LocalTime from the input, unless it's falsy - then returns LocalTime.now
    */
-  orNow(d: LocalTimeInput | null | undefined): LocalTime {
+  orNow(d: LocalTimeInputNullable): LocalTime {
     return d ? this.of(d) : this.now()
   }
 
@@ -827,26 +829,28 @@ class LocalTimeFactory {
     })
   }
 
-  minOrUndefined(items: LocalTimeInput[]): LocalTime | undefined {
+  minOrUndefined(items: LocalTimeInputNullable[]): LocalTime | undefined {
     return items.length ? this.min(items) : undefined
   }
 
-  min(items: LocalTimeInput[]): LocalTime {
-    _assert(items.length, 'localTime.min called on empty array')
+  min(items: LocalTimeInputNullable[]): LocalTime {
+    const items2 = items.filter(_isTruthy)
+    _assert(items2.length, 'localTime.min called on empty array')
 
-    return items
+    return items2
       .map(i => this.of(i))
       .reduce((min, item) => (min.$date.valueOf() <= item.$date.valueOf() ? min : item))
   }
 
-  maxOrUndefined(items: LocalTimeInput[]): LocalTime | undefined {
+  maxOrUndefined(items: LocalTimeInputNullable[]): LocalTime | undefined {
     return items.length ? this.max(items) : undefined
   }
 
-  max(items: LocalTimeInput[]): LocalTime {
-    _assert(items.length, 'localTime.max called on empty array')
+  max(items: LocalTimeInputNullable[]): LocalTime {
+    const items2 = items.filter(_isTruthy)
+    _assert(items2.length, 'localTime.max called on empty array')
 
-    return items
+    return items2
       .map(i => this.of(i))
       .reduce((max, item) => (max.$date.valueOf() >= item.$date.valueOf() ? max : item))
   }
diff --git a/src/semver.test.ts b/src/semver.test.ts
@@ -27,8 +27,9 @@ test('basic', () => {
   )
 })
 
-test('min, max', () => {
+test('min, max, sort', () => {
   expect(semver2.min(['1.2.3', '1.2.4']).toString()).toBe('1.2.3')
+  expect(semver2.min(['1.2.3', undefined]).toString()).toBe('1.2.3')
   expect(semver2.minOrUndefined(['1.2.3', '1.2.4'])?.toString()).toBe('1.2.3')
   expect(semver2.minOrUndefined(['1.2.5'])?.toString()).toBe('1.2.5')
   expect(semver2.minOrUndefined([])).toBeUndefined()
@@ -37,6 +38,16 @@ test('min, max', () => {
   expect(semver2.maxOrUndefined(['1.2.3', '1.2.4'])?.toString()).toBe('1.2.4')
   expect(semver2.maxOrUndefined(['1.2.5'])?.toString()).toBe('1.2.5')
   expect(semver2.maxOrUndefined([])).toBeUndefined()
+
+  expect(semver2.sort(['1.2.4', '1.2.5', '1.1.9', '1.7.7'].map(semver2)).map(s => s.toString()))
+    .toMatchInlineSnapshot(`
+[
+  "1.1.9",
+  "1.2.4",
+  "1.2.5",
+  "1.7.7",
+]
+`)
 })
 
 test.each([
diff --git a/src/semver.ts b/src/semver.ts
@@ -1,7 +1,10 @@
 import { _range } from './array/range'
 import { _assert } from './error/assert'
+import { _isTruthy } from './is.util'
+import { SortDirection } from './types'
 
 export type SemverInput = string | Semver
+export type SemverInputNullable = SemverInput | null | undefined
 export type SemverTokens = [major: number, minor: number, patch: number]
 
 /**
@@ -72,7 +75,7 @@ class SemverFactory {
     return s
   }
 
-  parseOrNull(input: SemverInput | undefined | null): Semver | null {
+  parseOrNull(input: SemverInputNullable): Semver | null {
     if (!input) return null
     if (input instanceof Semver) return input
 
@@ -83,33 +86,45 @@ class SemverFactory {
   /**
    * Returns the highest (max) Semver from the array, or undefined if the array is empty.
    */
-  maxOrUndefined(items: SemverInput[]): Semver | undefined {
+  maxOrUndefined(items: SemverInputNullable[]): Semver | undefined {
     return items.length ? this.max(items) : undefined
   }
 
   /**
    * Returns the highest Semver from the array.
    * Throws if the array is empty.
    */
-  max(items: SemverInput[]): Semver {
-    _assert(items.length, 'semver.max called on empty array')
-    return items.map(i => this.of(i)).reduce((max, item) => (max.isSameOrAfter(item) ? max : item))
+  max(items: SemverInputNullable[]): Semver {
+    const items2 = items.filter(_isTruthy)
+    _assert(items2.length, 'semver.max called on empty array')
+    return items2.map(i => this.of(i)).reduce((max, item) => (max.isSameOrAfter(item) ? max : item))
   }
 
   /**
    * Returns the lowest (min) Semver from the array, or undefined if the array is empty.
    */
-  minOrUndefined(items: SemverInput[]): Semver | undefined {
+  minOrUndefined(items: SemverInputNullable[]): Semver | undefined {
     return items.length ? this.min(items) : undefined
   }
 
   /**
    * Returns the lowest Semver from the array.
    * Throws if the array is empty.
    */
-  min(items: SemverInput[]): Semver {
-    _assert(items.length, 'semver.min called on empty array')
-    return items.map(i => this.of(i)).reduce((min, item) => (min.isSameOrBefore(item) ? min : item))
+  min(items: SemverInputNullable[]): Semver {
+    const items2 = items.filter(_isTruthy)
+    _assert(items2.length, 'semver.min called on empty array')
+    return items2
+      .map(i => this.of(i))
+      .reduce((min, item) => (min.isSameOrBefore(item) ? min : item))
+  }
+
+  /**
+   * Sorts an array of Semvers in `dir` order (ascending by default).
+   */
+  sort(items: Semver[], dir: SortDirection = 'asc', mutate = false): Semver[] {
+    const mod = dir === 'desc' ? -1 : 1
+    return (mutate ? items : [...items]).sort((a, b) => a.cmp(b) * mod)
   }
 }
 
