Natural language

util/time.go

@@ -0,0 +1,95 @@
+package util
+
+import (
+	"errors"
+	"github.com/olebedev/when"
+	"regexp"
+	"strconv"
+	"strings"
+	"time"
+)
+
+var (
+	errUnparsableTime = errors.New("unable to parse time")
+	durationStrRegex  = regexp.MustCompile(`(?i)^(\d+)\s*(d|days?|h|hours?|m|mins?|minutes?|s|secs?|seconds?)$`)
+)
+
+func ParseFutureTime(s string, now time.Time) (time.Time, error) {
+	s = strings.TrimSpace(s)
+	t, err := parseUnixTime(s, now)
+	if err == nil {
+		return t, nil
+	}
+	t, err = parseFromDuration(s, now)
+	if err == nil {
+		return t, nil
+	}
+	t, err = parseNaturalTime(s, now)
+	if err == nil {
+		return t, nil
+	}
+	return time.Time{}, errUnparsableTime
+}
+
+func parseFromDuration(s string, now time.Time) (time.Time, error) {
+	d, err := parseDuration(s)
+	if err == nil {
+		return now.Add(d), nil
+	}
+	return time.Time{}, errUnparsableTime
+}
+
+func parseDuration(s string) (time.Duration, error) {
+	d, err := time.ParseDuration(s)
+	if err == nil {
+		return d, nil
+	}
+	matches := durationStrRegex.FindStringSubmatch(s)
+	if matches != nil {
+		number, err := strconv.Atoi(matches[1])
+		if err != nil {
+			return 0, errUnparsableTime
+		}
+		switch unit := matches[2][0:1]; unit {
+		case "d":
+			return time.Duration(number) * 24 * time.Hour, nil
+		case "h":
+			return time.Duration(number) * time.Hour, nil
+		case "m":
+			return time.Duration(number) * time.Minute, nil
+		case "s":
+			return time.Duration(number) * time.Second, nil
+		default:
+			return 0, errUnparsableTime
+		}
+	}
+	return 0, errUnparsableTime
+}
+
+func parseUnixTime(s string, now time.Time) (time.Time, error) {
+	t, err := strconv.Atoi(s)
+	if err != nil {
+		return time.Time{}, err
+	} else if int64(t) < now.Unix() {
+		return time.Time{}, errUnparsableTime
+	}
+	return time.Unix(int64(t), 0), nil
+}
+
+func parseNaturalTime(s string, now time.Time) (time.Time, error) {
+	r, err := when.EN.Parse(s, now) // returns "nil, nil" if no matches!
+	if err != nil || r == nil {
+		return time.Time{}, errUnparsableTime
+	} else if r.Time.After(now) {
+		return r.Time, nil
+	}
+	// Hack: If the time is parsable, but not in the future,
+	// simply append "tomorrow, " to it.
+	r, err = when.EN.Parse("tomorrow, "+s, now) // returns "nil, nil" if no matches!
+	if err != nil || r == nil {
+		return time.Time{}, errUnparsableTime
+	} else if r.Time.After(now) {
+		return r.Time, nil
+	}
+	return time.Time{}, errUnparsableTime
+}

util/time_test.go

@@ -0,0 +1,60 @@
+package util
+
+import (
+	"github.com/stretchr/testify/require"
+	"testing"
+	"time"
+)
+
+var (
+	// 2021-12-10 10:17:23 (Friday)
+	base = time.Date(2021, 12, 10, 10, 17, 23, 0, time.UTC)
+)
+
+func TestParseFutureTime_11am_FutureTime(t *testing.T) {
+	d, err := ParseFutureTime("11am", base)
+	require.Nil(t, err)
+	require.Equal(t, time.Date(2021, 12, 10, 11, 0, 0, 0, time.UTC), d) // Same day
+}
+
+func TestParseFutureTime_9am_PastTime(t *testing.T) {
+	d, err := ParseFutureTime("9am", base)
+	require.Nil(t, err)
+	require.Equal(t, time.Date(2021, 12, 11, 9, 0, 0, 0, time.UTC), d) // Next day
+}
+
+func TestParseFutureTime_Monday_10_30pm_FutureTime(t *testing.T) {
+	d, err := ParseFutureTime("Monday, 10:30pm", base)
+	require.Nil(t, err)
+	require.Equal(t, time.Date(2021, 12, 13, 22, 30, 0, 0, time.UTC), d)
+}
+
+func TestParseFutureTime_30m(t *testing.T) {
+	d, err := ParseFutureTime("30m", base)
+	require.Nil(t, err)
+	require.Equal(t, time.Date(2021, 12, 10, 10, 47, 23, 0, time.UTC), d)
+}
+
+func TestParseFutureTime_30min(t *testing.T) {
+	d, err := ParseFutureTime("30min", base)
+	require.Nil(t, err)
+	require.Equal(t, time.Date(2021, 12, 10, 10, 47, 23, 0, time.UTC), d)
+}
+
+func TestParseFutureTime_3h(t *testing.T) {
+	d, err := ParseFutureTime("3h", base)
+	require.Nil(t, err)
+	require.Equal(t, time.Date(2021, 12, 10, 13, 17, 23, 0, time.UTC), d)
+}
+
+func TestParseFutureTime_1day(t *testing.T) {
+	d, err := ParseFutureTime("1 day", base)
+	require.Nil(t, err)
+	require.Equal(t, time.Date(2021, 12, 11, 10, 17, 23, 0, time.UTC), d)
+}
+
+func TestParseFutureTime_UnixTime(t *testing.T) {
+	d, err := ParseFutureTime("1639183911", base)
+	require.Nil(t, err)
+	require.Equal(t, time.Date(2021, 12, 10, 19, 51, 51, 0, time.Local), d)
+}