Skip to content

Commit

Permalink
Merge pull request #105 from quite/readability-nits
Browse files Browse the repository at this point in the history 
refactor: fix some readability nits
  • Loading branch information
@arran4
arran4 authored Oct 1, 2024
2 parents 4872343 + 176f16f commit 937429d
Show file tree
Hide file tree
Showing 5 changed files with 204 additions and 201 deletions.
116 changes: 59 additions & 57 deletions calendar.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ const (
CalendarUserTypeUnknown CalendarUserType = "UNKNOWN"
)

func (cut CalendarUserType) KeyValue(s ...interface{}) (string, []string) {
func (cut CalendarUserType) KeyValue(_ ...interface{}) (string, []string) {
return string(ParameterCutype), []string{string(cut)}
}

Expand All @@ -203,7 +203,7 @@ const (
ParticipationStatusInProcess ParticipationStatus = "IN-PROCESS"
)

func (ps ParticipationStatus) KeyValue(s ...interface{}) (string, []string) {
func (ps ParticipationStatus) KeyValue(_ ...interface{}) (string, []string) {
return string(ParameterParticipationStatus), []string{string(ps)}
}

Expand All @@ -220,7 +220,7 @@ const (
ObjectStatusFinal ObjectStatus = "FINAL"
)

func (ps ObjectStatus) KeyValue(s ...interface{}) (string, []string) {
func (ps ObjectStatus) KeyValue(_ ...interface{}) (string, []string) {
return string(PropertyStatus), []string{string(ps)}
}

Expand All @@ -241,7 +241,7 @@ const (
ParticipationRoleNonParticipant ParticipationRole = "NON-PARTICIPANT"
)

func (pr ParticipationRole) KeyValue(s ...interface{}) (string, []string) {
func (pr ParticipationRole) KeyValue(_ ...interface{}) (string, []string) {
return string(ParameterRole), []string{string(pr)}
}

Expand Down Expand Up @@ -298,102 +298,102 @@ func NewCalendarFor(service string) *Calendar {
return c
}

func (calendar *Calendar) Serialize() string {
func (cal *Calendar) Serialize() string {
b := bytes.NewBufferString("")
// We are intentionally ignoring the return value. _ used to communicate this to lint.
_ = calendar.SerializeTo(b)
_ = cal.SerializeTo(b)
return b.String()
}

func (calendar *Calendar) SerializeTo(w io.Writer) error {
func (cal *Calendar) SerializeTo(w io.Writer) error {
_, _ = fmt.Fprint(w, "BEGIN:VCALENDAR", "\r\n")
for _, p := range calendar.CalendarProperties {
for _, p := range cal.CalendarProperties {
p.serialize(w)
}
for _, c := range calendar.Components {
for _, c := range cal.Components {
c.SerializeTo(w)
}
_, _ = fmt.Fprint(w, "END:VCALENDAR", "\r\n")
return nil
}

func (calendar *Calendar) SetMethod(method Method, params ...PropertyParameter) {
calendar.setProperty(PropertyMethod, string(method), params...)
func (cal *Calendar) SetMethod(method Method, params ...PropertyParameter) {
cal.setProperty(PropertyMethod, string(method), params...)
}

func (calendar *Calendar) SetXPublishedTTL(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyXPublishedTTL, s, params...)
func (cal *Calendar) SetXPublishedTTL(s string, params ...PropertyParameter) {
cal.setProperty(PropertyXPublishedTTL, s, params...)
}

func (calendar *Calendar) SetVersion(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyVersion, s, params...)
func (cal *Calendar) SetVersion(s string, params ...PropertyParameter) {
cal.setProperty(PropertyVersion, s, params...)
}

func (calendar *Calendar) SetProductId(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyProductId, s, params...)
func (cal *Calendar) SetProductId(s string, params ...PropertyParameter) {
cal.setProperty(PropertyProductId, s, params...)
}

func (calendar *Calendar) SetName(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyName, s, params...)
calendar.setProperty(PropertyXWRCalName, s, params...)
func (cal *Calendar) SetName(s string, params ...PropertyParameter) {
cal.setProperty(PropertyName, s, params...)
cal.setProperty(PropertyXWRCalName, s, params...)
}

func (calendar *Calendar) SetColor(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyColor, s, params...)
func (cal *Calendar) SetColor(s string, params ...PropertyParameter) {
cal.setProperty(PropertyColor, s, params...)
}

func (calendar *Calendar) SetXWRCalName(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyXWRCalName, s, params...)
func (cal *Calendar) SetXWRCalName(s string, params ...PropertyParameter) {
cal.setProperty(PropertyXWRCalName, s, params...)
}

func (calendar *Calendar) SetXWRCalDesc(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyXWRCalDesc, s, params...)
func (cal *Calendar) SetXWRCalDesc(s string, params ...PropertyParameter) {
cal.setProperty(PropertyXWRCalDesc, s, params...)
}

func (calendar *Calendar) SetXWRTimezone(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyXWRTimezone, s, params...)
func (cal *Calendar) SetXWRTimezone(s string, params ...PropertyParameter) {
cal.setProperty(PropertyXWRTimezone, s, params...)
}

func (calendar *Calendar) SetXWRCalID(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyXWRCalID, s, params...)
func (cal *Calendar) SetXWRCalID(s string, params ...PropertyParameter) {
cal.setProperty(PropertyXWRCalID, s, params...)
}

func (calendar *Calendar) SetDescription(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyDescription, s, params...)
func (cal *Calendar) SetDescription(s string, params ...PropertyParameter) {
cal.setProperty(PropertyDescription, s, params...)
}

func (calendar *Calendar) SetLastModified(t time.Time, params ...PropertyParameter) {
calendar.setProperty(PropertyLastModified, t.UTC().Format(icalTimestampFormatUtc), params...)
func (cal *Calendar) SetLastModified(t time.Time, params ...PropertyParameter) {
cal.setProperty(PropertyLastModified, t.UTC().Format(icalTimestampFormatUtc), params...)
}

func (calendar *Calendar) SetRefreshInterval(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyRefreshInterval, s, params...)
func (cal *Calendar) SetRefreshInterval(s string, params ...PropertyParameter) {
cal.setProperty(PropertyRefreshInterval, s, params...)
}

func (calendar *Calendar) SetCalscale(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyCalscale, s, params...)
func (cal *Calendar) SetCalscale(s string, params ...PropertyParameter) {
cal.setProperty(PropertyCalscale, s, params...)
}

func (calendar *Calendar) SetUrl(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyUrl, s, params...)
func (cal *Calendar) SetUrl(s string, params ...PropertyParameter) {
cal.setProperty(PropertyUrl, s, params...)
}

func (calendar *Calendar) SetTzid(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyTzid, s, params...)
func (cal *Calendar) SetTzid(s string, params ...PropertyParameter) {
cal.setProperty(PropertyTzid, s, params...)
}

func (calendar *Calendar) SetTimezoneId(s string, params ...PropertyParameter) {
calendar.setProperty(PropertyTimezoneId, s, params...)
func (cal *Calendar) SetTimezoneId(s string, params ...PropertyParameter) {
cal.setProperty(PropertyTimezoneId, s, params...)
}

func (calendar *Calendar) setProperty(property Property, value string, params ...PropertyParameter) {
for i := range calendar.CalendarProperties {
if calendar.CalendarProperties[i].IANAToken == string(property) {
calendar.CalendarProperties[i].Value = value
calendar.CalendarProperties[i].ICalParameters = map[string][]string{}
func (cal *Calendar) setProperty(property Property, value string, params ...PropertyParameter) {
for i := range cal.CalendarProperties {
if cal.CalendarProperties[i].IANAToken == string(property) {
cal.CalendarProperties[i].Value = value
cal.CalendarProperties[i].ICalParameters = map[string][]string{}
for _, p := range params {
k, v := p.KeyValue()
calendar.CalendarProperties[i].ICalParameters[k] = v
cal.CalendarProperties[i].ICalParameters[k] = v
}
return
}
Expand All @@ -409,7 +409,7 @@ func (calendar *Calendar) setProperty(property Property, value string, params ..
k, v := p.KeyValue()
r.ICalParameters[k] = v
}
calendar.CalendarProperties = append(calendar.CalendarProperties, r)
cal.CalendarProperties = append(cal.CalendarProperties, r)
}

func ParseCalendar(r io.Reader) (*Calendar, error) {
Expand Down Expand Up @@ -516,13 +516,14 @@ func (cs *CalendarStream) ReadLine() (*ContentLine, error) {
for c {
var b []byte
b, err = cs.b.ReadBytes('\n')
if len(b) == 0 {
switch {
case len(b) == 0:
if err == nil {
continue
} else {
c = false
}
} else if b[len(b)-1] == '\n' {
case b[len(b)-1] == '\n':
o := 1
if len(b) > 1 && b[len(b)-2] == '\r' {
o = 2
Expand All @@ -532,14 +533,15 @@ func (cs *CalendarStream) ReadLine() (*ContentLine, error) {
if err == io.EOF {
c = false
}
if len(p) == 0 {
switch {
case len(p) == 0:
c = false
} else if p[0] == ' ' || p[0] == '\t' {
case p[0] == ' ' || p[0] == '\t':
_, _ = cs.b.Discard(1) // nolint:errcheck
} else {
default:
c = false
}
} else {
default:
r = append(r, b...)
}
switch err {
Expand Down
4 changes: 2 additions & 2 deletions calendar_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ END:VCALENDAR
c := NewCalendar()
c.SetDescription(tc.input)
// we're not testing for encoding here so lets make the actual output line breaks == expected line breaks
text := strings.Replace(c.Serialize(), "\r\n", "\n", -1)
text := strings.ReplaceAll(c.Serialize(), "\r\n", "\n")

assert.Equal(t, tc.output, text)
assert.True(t, utf8.ValidString(text), "Serialized .ics calendar isn't valid UTF-8 string")
Expand Down Expand Up @@ -377,7 +377,7 @@ END:VCALENDAR
}

// we're not testing for encoding here so lets make the actual output line breaks == expected line breaks
text := strings.Replace(c.Serialize(), "\r\n", "\n", -1)
text := strings.ReplaceAll(c.Serialize(), "\r\n", "\n")
if !assert.Equal(t, tc.output, text) {
return
}
Expand Down
Loading

0 comments on commit 937429d

Please sign in to comment.