From: Steven Baltakatei Sandoval <baltakatei@gmail.com>
Date: Mon, 29 Jun 2020 10:49:09 +0000 (+0000)
Subject: chore(unitproc):Rename secondsUntilMidnight to timeUntilNextDay
X-Git-Tag: 0.2.0~27
X-Git-Url: https://zdv2.bktei.com/gitweb/BK-2020-03.git/commitdiff_plain/2385300ac0dbb85ba90c3a276f5c495946a6b736?ds=inline;hp=--cc

chore(unitproc):Rename secondsUntilMidnight to timeUntilNextDay
---

2385300ac0dbb85ba90c3a276f5c495946a6b736
diff --git a/unitproc/bktemp-secondsUntilMidnight b/unitproc/bktemp-timeUntilNextDay
similarity index 56%
rename from unitproc/bktemp-secondsUntilMidnight
rename to unitproc/bktemp-timeUntilNextDay
index 954afa5..e055a70 100644
--- a/unitproc/bktemp-secondsUntilMidnight
+++ b/unitproc/bktemp-timeUntilNextDay
@@ -1,5 +1,5 @@
 #!/bin/bash
-# Desc: Template to check that apps, files, or dirs exist.
+# Desc: Template to report seconds until beginning of next day
 # Author: Steven Baltaktei Sandoval; License: GPLv3+
 
 #==BEGIN Define script parameters==
@@ -7,31 +7,31 @@
 yell() { echo "$0: $*" >&2; } # Yell, Die, Try Three-Fingered Claw technique; # Ref/Attrib: https://stackoverflow.com/a/25515370
 die() { yell "$*"; exit 111; }
 try() { "$@" || die "cannot $*"; }
-timeUntilMidnight(){
-    # Desc: Report seconds until midnight
-    # Output: stdout: integer seconds until midnight
+timeUntilNextDay(){
+    # Desc: Report seconds until next day.
+    # Output: stdout: integer seconds until next day
     # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
-    # Usage: timeUntilMidnight
-    # Usage: if ! myTTL="$(timeUntilMidnight)"; then yell "ERROR in if statement"; exit 1; fi
+    # Usage: timeUntilNextDay
+    # Usage: if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement"; exit 1; fi
     local returnState
     TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
     TIME_CURRENT_SHORT="$(date -d "$TIME_CURRENT" +%Y%m%dT%H%M%S%z)" # Produce separator-less current timestamp with resolution 1 second.
     DATE_CURRENT="$(date -d "$TIME_CURRENT" --iso-8601=date)" ; # Produce `date`-parsable current timestamp with resolution of 1 day.
     DATE_CURRENT_SHORT="$(date -d "$TIME_CURRENT" +%Y%m%d)" ; # Produce separator-less current timestamp with resolution 1 day.
     DATE_TOMORROW="$(date -d "$TIME_CURRENT next day" --iso-8601=date)" ; # Produce timestamp of tomorrow's date (res. 1 day).
-    TIME_NEXT_MIDNIGHT="$(date -d "$DATE_TOMORROW" --iso-8601=seconds)" ; # Produce `date`-parsable timestamp of closest future midnight (res. 1 second).
-    SECONDS_UNTIL_NEXT_MIDNIGHT="$(( $(date +%s -d "$TIME_NEXT_MIDNIGHT") - $(date +%s -d "$TIME_CURRENT") ))" ; # Calculate seconds until closest future midnight (res. 1 second).
-    if [[ "$SECONDS_UNTIL_NEXT_MIDNIGHT" -gt 0 ]]; then
+    TIME_NEXT_DAY="$(date -d "$DATE_TOMORROW" --iso-8601=seconds)" ; # Produce `date`-parsable timestamp of closest next day (res. 1 second).
+    SECONDS_UNTIL_NEXT_DAY="$(( $(date +%s -d "$TIME_NEXT_DAY") - $(date +%s -d "$TIME_CURRENT") ))" ; # Calculate seconds until closest future midnight (res. 1 second).
+    if [[ "$SECONDS_UNTIL_NEXT_DAY" -gt 0 ]]; then
 	returnState="true";
-    elif [[ "$SECONDS_UNTIL_NEXT_MIDNIGHT" -eq 0 ]]; then
+    elif [[ "$SECONDS_UNTIL_NEXT_DAY" -eq 0 ]]; then
 	returnState="WARNING_ZERO";
-	yell "WARNING:Reported time until midnight exactly zero.";
-    elif [[ "$SECONDS_UNTIL_NEXT_MIDNIGHT" -lt 0 ]]; then
+	yell "WARNING:Reported time until next day exactly zero.";
+    elif [[ "$SECONDS_UNTIL_NEXT_DAY" -lt 0 ]]; then
 	returnState="WARNING_NEGATIVE";
-	yell "WARNING:Reported time until midnight is negative.";
+	yell "WARNING:Reported time until next day is negative.";
     fi
 
-    try echo "$SECONDS_UNTIL_NEXT_MIDNIGHT"; # Report
+    try echo "$SECONDS_UNTIL_NEXT_DAY"; # Report
     
     #===Determine function return code===
     if [[ "$returnState" = "true" ]]; then
@@ -47,7 +47,7 @@ timeUntilMidnight(){
 
 
 #==BEGIN sample code==
-try echo "Time until next midnight (seconds):$(timeUntilMidnight)" # simple report
+try echo "Time until next day (seconds):$(timeUntilNextDay)" # simple report
 
-if ! myTTL="$(timeUntilMidnight)"; then yell "ERROR in if statement for myTTL:$myTTL"; exit 1; fi # Use of exit code to exit early if time <= 0.
+if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement for myTTL:$myTTL"; exit 1; fi # Use of exit code to exit early if time <= 0.
 #==END sample code==