feat: Add flag to set the timezone on reports

By default all the dates are in UTC, this commit adds a new flag: '--time-zone'
or '-z' that allows the user to pass a timezone.

This is a breaking change, now, by default the used timezone is 'local', meaning
the value returned by 'time.local'.

Examples:

- Madrid Timezone:  -z Europe/Madrid
- Current timezone: -z local

A full list of timezones can be found here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

This can fix some issues reported in #135.

Signed-off-by: Arturo Volpe <[email protected]>

Author: aVolpe

pkg/cmd/time-entry/report/util/report.go

@@ -50,7 +50,7 @@ func (rf ReportFlags) Check() error {
 // NewReportFlags helps creating a util.ReportFlags for report commands
 func NewReportFlags() ReportFlags {
 	return ReportFlags{
-		OutputFlags: util.OutputFlags{TimeFormat: timehlp.FullTimeFormat},
+		OutputFlags: util.OutputFlags{TimeFormat: timehlp.FullTimeFormat, TimeZone: "local"},
 	}
 }
 

pkg/cmd/time-entry/report/util/reportwithrange_test.go

@@ -246,6 +246,7 @@ func TestReportWithRange(t *testing.T) {
 			},
 			flags: func(t *testing.T) util.ReportFlags {
 				rf := util.NewReportFlags()
+				rf.TimeZone = "UTC"
 				rf.FillMissingDates = true
 				rf.Format = "{{.ID}};{{ .TimeInterval.Start.Format " +
 					`"2006-01-02"` +

pkg/cmd/time-entry/util/report.go

@@ -2,6 +2,7 @@ package util
 
 import (
 	"io"
+	"time"
 
 	"github.com/lucassabreu/clockify-cli/api"
 	"github.com/lucassabreu/clockify-cli/api/dto"
@@ -19,20 +20,29 @@ type OutputFlags struct {
 	Markdown          bool
 	DurationFormatted bool
 	DurationFloat     bool
-
-	TimeFormat string
+	TimeFormat        string
+	TimeZone          string
 }
 
 func (of OutputFlags) Check() error {
-	return cmdutil.XorFlag(map[string]bool{
+
+	if err := cmdutil.XorFlag(map[string]bool{
 		"format":             of.Format != "",
 		"json":               of.JSON,
 		"csv":                of.CSV,
 		"quiet":              of.Quiet,
 		"md":                 of.Markdown,
 		"duration-float":     of.DurationFloat,
 		"duration-formatted": of.DurationFormatted,
-	})
+	}); err != nil {
+		return err
+	}
+
+	if of.TimeZone != "local" && of.TimeFormat != "" {
+		_, err := time.LoadLocation(of.TimeZone)
+		return err
+	}
+	return nil
 }
 
 // AddPrintMultipleTimeEntriesFlags add flags to print multiple time entries
@@ -45,6 +55,8 @@ func AddPrintMultipleTimeEntriesFlags(cmd *cobra.Command) {
 func AddPrintTimeEntriesFlags(cmd *cobra.Command, of *OutputFlags) {
 	cmd.Flags().StringVarP(&of.Format, "format", "f", "",
 		"golang text/template format to be applied on each time entry")
+	cmd.Flags().StringVarP(&of.TimeZone, "time-zone", "z", "local",
+		"time zone to be used on the time entries")
 	cmd.Flags().BoolVarP(&of.JSON, "json", "j", false, "print as JSON")
 	cmd.Flags().BoolVarP(&of.CSV, "csv", "v", false, "print as CSV")
 	cmd.Flags().BoolVarP(&of.Quiet, "quiet", "q", false, "print only ID")
@@ -91,18 +103,45 @@ func PrintTimeEntry(
 	b := config.GetBool(cmdutil.CONF_SHOW_TOTAL_DURATION)
 	config.SetBool(cmdutil.CONF_SHOW_TOTAL_DURATION, false)
 
-	err := PrintTimeEntries(ts, out, config, of)
+	err := PrintTimeEntries(updateTimeZone(ts, of), out, config, of)
 
 	config.SetBool(cmdutil.CONF_SHOW_TOTAL_DURATION, b)
 
 	return err
 }
 
+func updateTimeZone(tes []dto.TimeEntry, of OutputFlags) []dto.TimeEntry {
+
+	if of.TimeZone == "" {
+		return tes
+	}
+
+	var loc *time.Location = time.UTC
+
+	if of.TimeZone == "local" || of.TimeFormat == "" {
+		loc = time.Local
+	} else {
+		loc, _ = time.LoadLocation(of.TimeZone)
+	}
+
+	// iterate tes and set the end/start time to the timezone
+	for i := range tes {
+		// parses of.TimeZone as a time.Location
+		tes[i].TimeInterval.Start = tes[i].TimeInterval.Start.In(loc)
+		if tes[i].TimeInterval.End != nil {
+			end := tes[i].TimeInterval.End.In(loc)
+			tes[i].TimeInterval.End = &end
+		}
+	}
+	return tes
+}
+
 // PrintTimeEntries will print out a list of time entries using parameters and
 // flags
 func PrintTimeEntries(
 	tes []dto.TimeEntry, out io.Writer, config cmdutil.Config, of OutputFlags,
 ) error {
+	tes = updateTimeZone(tes, of)
 	switch {
 	case of.Markdown:
 		return output.TimeEntriesMarkdownPrint(tes, out)