com.wa9nnn.wa9nnnutil.DurationHelpers.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wa9nnnutil_3 Show documentation
Utils for scala3 and playframework 3.x.
The newest version!
/*
 * Copyright (C) 2021  Dick Lieber, WA9NNN
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 *
 */

package com.wa9nnn.wa9nnnutil

import java.time
import java.time.Instant
import java.util.concurrent.TimeUnit
import scala.concurrent.duration.Duration

//import scala.language.implicitConversions

/**
 * Format a Java 1.8 [[Duration]] to nice human readable, scaled string.
 */
object DurationHelpers {

  val ONE_SECOND = 1000L
  val ONE_MINUTE = 60000L
  val ONE_HOUR = 3600000L
  val ONE_DAY = 86400000L


  /**
   *
   * @return string e.g. "59 min 2 sec" or "999 ms"
   */
  given Conversion[Duration, String] = duration =>
    duration.toMillis match {
      case ms if ms < ONE_SECOND => f"${duration.toMillis} ms"
      case ms if ms == ONE_SECOND => "1 sec"
      case ms if ms < ONE_MINUTE =>
        val remaininMs = ms % ONE_SECOND
        f"${ms / ONE_SECOND}%d sec $remaininMs%d ms"
      case ms if ms == ONE_MINUTE => "1 min"
      case ms if ms < ONE_HOUR =>
        val minutes = duration.toMinutes
        val remaininSecs = (ms - minutes * ONE_MINUTE) / ONE_SECOND
        f"$minutes%d min $remaininSecs%d sec"
      case ms if ms < ONE_DAY =>
        val hours = ms / ONE_HOUR
        val minutes = (ms - hours * ONE_HOUR) / ONE_MINUTE
        f"$hours%d hours $minutes%d min"
      case ms =>
        val days = ms / ONE_DAY
        val hours = (ms - days * ONE_DAY) / ONE_HOUR
        val mins = (ms - (hours * ONE_HOUR + days * ONE_DAY)) / ONE_MINUTE
        if (mins == 0) {
          f"$days%d day $hours%d hour"
        } else {
          f"$days%d day $hours%d hour $mins%d min"
        }
    }


  /**
   * Durationon between two [[Instant]]s or one [[Instant]] and now.
   *
   * @param instant
   * @param now
   * @return
   */
  def between(instant: Instant, now: Instant = Instant.now()): Duration = {
    val javaDuration: time.Duration = java.time.Duration.between(instant, now)
    Duration(javaDuration.toMillis, TimeUnit.MILLISECONDS)
  }


}