Dates.kt

  1. package com.hexagonkt.core

  3. import java.time.*
  4. import java.util.Date

  6. private const val DATE_OFFSET: Long = 1_000_000_000L
  7. private const val YEAR_OFFSET: Int = 10_000
  8. private const val MONTH_OFFSET: Int = 100
  9. private const val HOUR_OFFSET: Int = 10_000_000
  10. private const val MINUTE_OFFSET: Int = 100_000
  11. private const val SECOND_OFFSET: Int = 1_000
  12. private const val NANO_OFFSET: Int = 1_000_000
  13. private const val DAYS_PER_MONTH: Double = 30.4375

  15. /** GMT zone ID. */
  16. val GMT_ZONE: ZoneId by lazy { ZoneId.of("GMT") }

  18. /**
  19.  * Convert a date time to a number with the following format: `YYYYMMDDHHmmss`.
  20.  *
  21.  * @receiver Date to be converted to a number.
  22.  * @return Numeric representation of the given date.
  23.  */
  24. fun LocalDateTime.toNumber(): Long =
  25.     (this.toLocalDate().toNumber() * DATE_OFFSET) + this.toLocalTime().toNumber()

  27. /**
  28.  * Convert a date to an integer with the following format: `YYYYMMDD`.
  29.  *
  30.  * @receiver Date to be converted to a number.
  31.  * @return Numeric representation of the given date.
  32.  */
  33. fun LocalDate.toNumber(): Int =
  34.     (this.year * YEAR_OFFSET) +
  35.     (this.monthValue * MONTH_OFFSET) +
  36.     this.dayOfMonth

  38. /**
  39.  * Convert a time to an integer with the following format: `HHmmssSSS`.
  40.  *
  41.  * @receiver Time to be converted to a number.
  42.  * @return Numeric representation of the given time.
  43.  */
  44. fun LocalTime.toNumber(): Int =
  45.     (this.hour * HOUR_OFFSET) +
  46.     (this.minute * MINUTE_OFFSET) +
  47.     (this.second * SECOND_OFFSET) +
  48.     (this.nano / NANO_OFFSET) // Nanos to millis

  50. /**
  51.  * Return the date time in a given time zone for a local date time.
  52.  *
  53.  * @receiver Local date time to be moved to another time zone.
  54.  * @param zoneId Id of the target zone of the passed local date time.
  55.  * @return Received date time at the given [zoneId].
  56.  */
  57. fun LocalDateTime.withZone(zoneId: ZoneId = Jvm.timeZone.toZoneId()): ZonedDateTime =
  58.     ZonedDateTime.of(this, zoneId)

  60. /**
  61.  * Parse a date time from a formatted number with this format: `YYYYMMDDHHmmss`.
  62.  *
  63.  * @receiver Number to be converted to a date time.
  64.  * @return Local date time representation of the given number.
  65.  */
  66. fun Long.toLocalDateTime(): LocalDateTime {
  67.     require(this >= 0) { "Number representing timestamp must be positive (format: YYYYMMDDHHmmss)" }
  68.     return (this / DATE_OFFSET)
  69.         .toInt()
  70.         .toLocalDate()
  71.         .atTime((this % DATE_OFFSET).toInt().toLocalTime())
  72. }

  74. /**
  75.  * Parse a date from a formatted integer with this format: `YYYYMMDD`.
  76.  *
  77.  * @receiver Number to be converted to a date.
  78.  * @return Local date representation of the given number.
  79.  */
  80. fun Int.toLocalDate(): LocalDate {
  81.     require(this >= 0) { "Number representing date must be positive (format: YYYYMMDD)" }
  82.     return LocalDate.of(
  83.         this / YEAR_OFFSET,
  84.         (this % YEAR_OFFSET) / MONTH_OFFSET,
  85.         this % MONTH_OFFSET
  86.     )
  87. }

  89. /**
  90.  * Parse a time from a formatted integer with this format: `HHmmssSSS`.
  91.  *
  92.  * @receiver Number to be converted to a time.
  93.  * @return Local time representation of the given number.
  94.  */
  95. fun Int.toLocalTime(): LocalTime {
  96.     require(this >= 0) { "Number representing time must be positive (format: HHmmssSSS)" }
  97.     return LocalTime.of(
  98.         (this / HOUR_OFFSET),
  99.         ((this % HOUR_OFFSET) / MINUTE_OFFSET),
  100.         ((this % MINUTE_OFFSET) / SECOND_OFFSET),
  101.         ((this % SECOND_OFFSET) * NANO_OFFSET) // Millis to nanos
  102.     )
  103. }

  105. /**
  106.  * Convert a zoned date time to a date.
  107.  *
  108.  * @receiver Zoned date time to be converted to a date.
  109.  * @return Date representation of the given zoned date time.
  110.  */
  111. fun ZonedDateTime.toDate(): Date =
  112.     Date.from(this.toInstant())

  114. /**
  115.  * Convert a local date time to a date.
  116.  *
  117.  * @receiver Local date time to be converted to a date.
  118.  * @return Date representation of the given local date time.
  119.  */
  120. fun LocalDateTime.toDate(): Date =
  121.     this.atZone(Jvm.timeZone.toZoneId()).toDate()

  123. /**
  124.  * Convert a local date to a date.
  125.  *
  126.  * @receiver Local date to be converted to a date.
  127.  * @return Date representation of the given local date.
  128.  */
  129. fun LocalDate.toDate(): Date =
  130.     this.atStartOfDay(Jvm.timeZone.toZoneId()).toDate()

  132. /**
  133.  * Convert a date to a local date time.
  134.  *
  135.  * @receiver Date to be converted to a local date time.
  136.  * @return Local date time representation of the given date.
  137.  */
  138. fun Date.toLocalDateTime(): LocalDateTime =
  139.     LocalDateTime.ofInstant(Instant.ofEpochMilli(this.time), ZoneId.systemDefault())

  141. /**
  142.  * Convert a date to a local date.
  143.  *
  144.  * @receiver Date to be converted to a local date.
  145.  * @return Local date representation of the given date.
  146.  */
  147. fun Date.toLocalDate(): LocalDate =
  148.     this.toLocalDateTime().toLocalDate()

  150. /**
  151.  * Calculate the aproximate number of days comprised in a time period.
  152.  *
  153.  * @receiver Period from which calculate the number of days.
  154.  * @return Aproximate number of days of the period.
  155.  */
  156. fun Period.toTotalDays(): Double =
  157.     (toTotalMonths() * DAYS_PER_MONTH) + days

  159. /**
  160.  * Parse a time period allowing a more relaxed format: with spaces or commas, lowercase characters
  161.  * and not forcing the text to start with 'P'.
  162.  *
  163.  * @param text Text to be parsed to a time period.
  164.  * @return Time period parsed from the supplied text.
  165.  */
  166. fun parsePeriod(text: String): Period =
  167.     Period.parse(formatDuration(text))

  169. /**
  170.  * Parse a time duration allowing a more relaxed format: with spaces or commas, lowercase characters
  171.  * and not forcing the text to start with 'P', however, the 'T' is still mandatory to separate date
  172.  * and time durations.
  173.  *
  174.  * @param text Text to be parsed to a time duration.
  175.  * @return Time duration parsed from the supplied text.
  176.  */
  177. fun parseDuration(text: String): Duration =
  178.     Duration.parse(formatDuration(text))

  180. private fun formatDuration(text: String): String =
  181.     text
  182.         .replace(",", "")
  183.         .replace(" ", "")
  184.         .uppercase()
  185.         .let { if (it.startsWith("P")) it else "P$it" }

  187. /**
  188.  * Parse a local date allowing only to specify the year or the year and the month. Missing month and
  189.  * day will be defaulted to january and one respectively.
  190.  *
  191.  * @param text Text to be parsed to a local date.
  192.  * @return Local date parsed from the supplied text.
  193.  */
  194. fun parseLocalDate(text: String): LocalDate =
  195.     when (text.length) {
  196.         4 -> Year.parse(text).atMonth(1).atDay(1)
  197.         7 -> YearMonth.parse(text).atDay(1)
  198.         else -> LocalDate.parse(text)
  199.     }
Created with JaCoCo 0.8.12.202403310830