File: vdate.go

package info (click to toggle)
golang-github-rickb777-date 1.20.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 460 kB
  • sloc: sh: 63; makefile: 3
file content (189 lines) | stat: -rw-r--r-- 5,047 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
// Copyright 2015 Rick Beton. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Package view provides a simple API for formatting dates as strings in a manner that is easy to use in view-models,
// especially when using Go templates.
package view

import (
	"github.com/rickb777/date"
)

const (
	// DMYFormat is a typical British representation.
	DMYFormat = "02/01/2006"
	// MDYFormat is a typical American representation.
	MDYFormat = "01/02/2006"
	// ISOFormat is ISO-8601 YYYY-MM-DD.
	ISOFormat = "2006-02-01"
	// DefaultFormat is used by Format() unless a different format is set.
	DefaultFormat = DMYFormat
)

// A VDate holds a Date and provides easy ways to render it, e.g. in Go templates.
type VDate struct {
	d date.Date
	f string
}

// NewVDate wraps a Date.
func NewVDate(d date.Date) VDate {
	return VDate{d, DefaultFormat}
}

// Date returns the underlying date.
func (v VDate) Date() date.Date {
	return v.d
}

// IsYesterday returns true if the date is yesterday's date.
func (v VDate) IsYesterday() bool {
	return v.d.DaysSinceEpoch()+1 == date.Today().DaysSinceEpoch()
}

// IsToday returns true if the date is today's date.
func (v VDate) IsToday() bool {
	return v.d.DaysSinceEpoch() == date.Today().DaysSinceEpoch()
}

// IsTomorrow returns true if the date is tomorrow's date.
func (v VDate) IsTomorrow() bool {
	return v.d.DaysSinceEpoch()-1 == date.Today().DaysSinceEpoch()
}

// IsOdd returns true if the date is an odd number. This is useful for
// zebra striping etc.
func (v VDate) IsOdd() bool {
	return v.d.DaysSinceEpoch()%2 == 0
}

// String formats the date in basic ISO8601 format YYYY-MM-DD.
func (v VDate) String() string {
	if v.d.IsZero() {
		return ""
	}
	return v.d.String()
}

// WithFormat creates a new instance containing the specified format string.
func (v VDate) WithFormat(f string) VDate {
	return VDate{v.d, f}
}

// Format formats the date using the specified format string, or "02/01/2006" by default.
// Use WithFormat to set this up.
func (v VDate) Format() string {
	return v.d.Format(v.f)
}

// Mon returns the day name as three letters.
func (v VDate) Mon() string {
	return v.d.Format("Mon")
}

// Monday returns the full day name.
func (v VDate) Monday() string {
	return v.d.Format("Monday")
}

// Day2 returns the day number without a leading zero.
func (v VDate) Day2() string {
	return v.d.Format("2")
}

// Day02 returns the day number with a leading zero if necessary.
func (v VDate) Day02() string {
	return v.d.Format("02")
}

// Day2nd returns the day number without a leading zero but with the appropriate
// "st", "nd", "rd", "th" suffix.
func (v VDate) Day2nd() string {
	return v.d.Format("2nd")
}

// Month1 returns the month number without a leading zero.
func (v VDate) Month1() string {
	return v.d.Format("1")
}

// Month01 returns the month number with a leading zero if necessary.
func (v VDate) Month01() string {
	return v.d.Format("01")
}

// Jan returns the month name abbreviated to three letters.
func (v VDate) Jan() string {
	return v.d.Format("Jan")
}

// January returns the full month name.
func (v VDate) January() string {
	return v.d.Format("January")
}

// Year returns the four-digit year.
func (v VDate) Year() string {
	return v.d.Format("2006")
}

// Next returns a fluent generator for later dates.
func (v VDate) Next() VDateDelta {
	return VDateDelta{v.d, v.f, 1}
}

// Previous returns a fluent generator for earlier dates.
func (v VDate) Previous() VDateDelta {
	return VDateDelta{v.d, v.f, -1}
}

//-------------------------------------------------------------------------------------------------
// Only lossy transcoding is supported here because the intention is that data exchange should be
// via the main Date type; VDate is only intended for output through view layers.

// MarshalText implements the encoding.TextMarshaler interface.
func (v VDate) MarshalText() ([]byte, error) {
	return v.d.MarshalText()
}

// UnmarshalText implements the encoding.TextUnmarshaler interface.
// Note that the format value gets lost.
func (v *VDate) UnmarshalText(data []byte) (err error) {
	u := &date.Date{}
	err = u.UnmarshalText(data)
	if err == nil {
		v.d = *u
		v.f = DefaultFormat
	}
	return err
}

//-------------------------------------------------------------------------------------------------

// VDateDelta is a VDate with the ability to add or subtract days, weeks, months or years.
type VDateDelta struct {
	d    date.Date
	f    string
	sign date.PeriodOfDays
}

// Day adds or subtracts one day.
func (dd VDateDelta) Day() VDate {
	return VDate{dd.d.Add(dd.sign), dd.f}
}

// Week adds or subtracts one week.
func (dd VDateDelta) Week() VDate {
	return VDate{dd.d.Add(dd.sign * 7), dd.f}
}

// Month adds or subtracts one month.
func (dd VDateDelta) Month() VDate {
	return VDate{dd.d.AddDate(0, int(dd.sign), 0), dd.f}
}

// Year adds or subtracts one year.
func (dd VDateDelta) Year() VDate {
	return VDate{dd.d.AddDate(int(dd.sign), 0, 0), dd.f}
}