Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

small improvements to README and function comments #4

Merged
merged 1 commit into from
Jul 11, 2024
Merged

small improvements to README and function comments #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The command-line program, `dtmate` *(along with the golang package)* allows you
* Command line tool: `go install github.com/jftuga/DateTimeMate/cmd/dtmate@latest`
* * Binaries for all platforms are provided in the [releases](https://github.com/jftuga/DateTimeMate/releases) section.
* Homebrew (MacOS / Linux):
* * `brew tap jftuga/homebrew-tap; brew update; brew install jftuga/tap/DateTimeMate`
* * `brew tap jftuga/homebrew-tap; brew update; brew install jftuga/tap/dtmate`

## Library Usage
<details open>
Expand Down
2 changes: 1 addition & 1 deletion diff.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func (diff *Diff) String() string {
}

// CalculateDiff return the time difference and also set dt.Diff
// first try to parse with carbon, fallback to parsing with now if carbon fails to parse
// first try to parse with carbon, fallback to parsing with parsetime if carbon fails to parse
func (diff *Diff) CalculateDiff() (string, time.Duration, error) {
var start, end time.Time

Expand Down
18 changes: 9 additions & 9 deletions dur.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ type OptionsDur func(*Dur)
const (
expanded string = `(\d+)\s(years?|months?|weeks?|days?|hours?|minutes?|seconds?|milliseconds?|microseconds?|nanoseconds?)`
wordsOnly string = `\b[a-zA-Z]+\b`
dupMsg string = "Hint: duplicate durations not allowed; dates in uppercase; times in lowercase"
hintMsg string = "Hint: duplicate durations not allowed; dates in uppercase; times in lowercase"
)

var carbonFuncs = map[string]interface{}{
Expand Down Expand Up @@ -94,7 +94,6 @@ func DurWithOutputFormat(outputFormat string) OptionsDur {
}

func (dur *Dur) String() string {
//return fmt.Sprintf("From: %v Period:%v Op:%v Repeat:%v Until:%v OutputFormat:%v", dur.From, dur.Period, dur.Op, dur.Repeat, dur.Until, dur.OutputFormat)
return fmt.Sprintf("%v,%v,%v,%v,%v,%v", dur.From, dur.Period, dur.Op, dur.Repeat, dur.Until, dur.OutputFormat)
}

Expand All @@ -106,6 +105,8 @@ func (dur *Dur) Sub() ([]string, error) {
return dur.addOrSub(Sub)
}

// addOrSub - calculates a date/time when given a starting date/time and a duration
// also handle: the repeat and until options, relative dates, output formatting
func (dur *Dur) addOrSub(op int) ([]string, error) {
if dur.Repeat > 0 && dur.Until != "" {
return nil, fmt.Errorf("repeat & until are mutually exclusive")
Expand Down Expand Up @@ -159,7 +160,7 @@ func (dur *Dur) addOrSub(op int) ([]string, error) {
return nil, err
}

if Add == op { // FIXME
if Add == op {
if f.After(u) {
break
}
Expand All @@ -186,10 +187,7 @@ func (dur *Dur) addOrSub(op int) ([]string, error) {
return all, nil
}

//func (dur *Period) Sub() (string, error) {
// return calculate(dur.From, dur.Period, Sub)
//}

// setOutputFormat use a strftime format string for the output date/time
func (dur *Dur) setOutputFormat(arg string) (string, error) {
f, err := strftime.New(dur.OutputFormat)
if err != nil {
Expand All @@ -208,6 +206,8 @@ func (dur *Dur) setOutputFormat(arg string) (string, error) {
return output, nil
}

// calculate given a from date and period duration, compute a new date/time
// when index==0, then add; when index==1, then subtract
func calculate(from, period string, index int) (string, error) {
periodMatches := expandedRegexp.FindAllStringSubmatch(period, -1)
if len(periodMatches) == 0 {
Expand Down Expand Up @@ -348,14 +348,14 @@ func expandPeriod(period string) (string, error) {
// a numeric amount and a duration
words := strings.Fields(p)
if len(words)%2 == 1 {
return "", fmt.Errorf("[expandPeriod] Invalid period: %s. %s", period, dupMsg)
return "", fmt.Errorf("[expandPeriod] Invalid period: %s. %s", period, hintMsg)
}

// check that every other element is a number
for i := 0; i < len(words); i += 2 {
_, err := strconv.Atoi(words[i])
if err != nil {
return "", fmt.Errorf("[expandPeriod] %v. %s", err, dupMsg)
return "", fmt.Errorf("[expandPeriod] %v. %s", err, hintMsg)
}
}
return p, nil
Expand Down