From: Steven Baltakatei Sandoval <baltakatei@gmail.com>
Date: Thu, 2 Jul 2020 20:01:54 +0000 (+0000)
Subject: style(unitproc):timeUntilNextDay: lowercase returnStates; version
X-Git-Tag: 0.2.0~4
X-Git-Url: https://zdv2.bktei.com/gitweb/BK-2020-03.git/commitdiff_plain/96716339c09aef0877825dafa92302dafcdb46c2?ds=sidebyside;hp=-c

style(unitproc):timeUntilNextDay: lowercase returnStates; version
---

96716339c09aef0877825dafa92302dafcdb46c2
diff --git a/unitproc/bktemp-timeUntilNextDay b/unitproc/bktemp-timeUntilNextDay
index 98ef929..35c4893 100644
--- a/unitproc/bktemp-timeUntilNextDay
+++ b/unitproc/bktemp-timeUntilNextDay
@@ -1,6 +1,5 @@
 #!/bin/bash
 # Desc: Template to report seconds until beginning of next day
-# Author: Steven Baltaktei Sandoval; License: GPLv3+
 
 #==BEGIN Define script parameters==
 #===BEGIN Declare local script functions===
@@ -9,32 +8,36 @@ die() { yell "$*"; exit 111; }
 try() { "$@" || die "cannot $*"; }
 timeUntilNextDay(){
     # Desc: Report seconds until next day.
+    # Version: 1.0.0
     # Output: stdout: integer seconds until next day
     # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
     # Usage: timeUntilNextDay
     # Usage: if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement"; exit 1; fi
+    # Depends: date 8, echo 8, yell, try
+    
     local returnState TIME_CURRENT TIME_NEXT_DAY SECONDS_UNTIL_NEXT_DAY
+
     TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
     TIME_NEXT_DAY="$(date -d "$TIME_CURRENT next day" --iso-8601=date)"; # Produce timestamp of beginning of tomorrow with resolution of 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_DAY" -eq 0 ]]; then
-	returnState="WARNING_ZERO";
+	returnState="warning_zero";
 	yell "WARNING:Reported time until next day exactly zero.";
     elif [[ "$SECONDS_UNTIL_NEXT_DAY" -lt 0 ]]; then
-	returnState="WARNING_NEGATIVE";
+	returnState="warning_negative";
 	yell "WARNING:Reported time until next day is negative.";
     fi
 
     try echo "$SECONDS_UNTIL_NEXT_DAY"; # Report
     
-    #===Determine function return code===
+    # Determine function return code
     if [[ "$returnState" = "true" ]]; then
 	return 0;
-    elif [[ "$returnState" = "WARNING_ZERO" ]]; then
+    elif [[ "$returnState" = "warning_zero" ]]; then
 	return 1;
-    elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then
+    elif [[ "$returnState" = "warning_negative" ]]; then
 	return 2;
     fi
 } # Report seconds until next day
@@ -47,3 +50,6 @@ try echo "Time until next day (seconds):$(timeUntilNextDay)" # simple report
 
 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==
+
+# Author: Steven Baltaktei Sandoval
+# License: GPLv3+