Merge pull request #4 from taigrr/cd/lint-fixes

fix(msp): resolve staticcheck warning and fix typo

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: taigrr # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

go.mod

@@ -1,3 +1,3 @@
 module github.com/taigrr/most-specific-period
 
-go 1.18
+go 1.26

main.go

@@ -41,7 +41,7 @@ func warnMessage() {
 }
 
 func helpMessage() {
-	fmt.Print("\nmost-significant-period [-h][-d]\n\nGenerates a timeline of periods and will provide a most significant period if available.\n\n-h\tShows this help menut\n-d\tProvide a RFC 3339 time to provide an alternate point for calculating MSP.")
+	fmt.Print("\nmost-specific-period [-h][-d]\n\nGenerates a timeline of periods and will provide a most specific period if available.\n\n-h\tShows this help menu\n-d\tProvide an RFC 3339 time to provide an alternate point for calculating MSP.")
 }
 
 func main() {

msp/changeover_test.go

@@ -1,7 +1,6 @@
 package msp
 
 import (
-	"fmt"
 	"testing"
 	"time"
 )
@@ -148,7 +147,7 @@ func TestGetChangeOvers(t *testing.T) {
 		},
 	}
 	for _, tc := range testCases {
-		t.Run(fmt.Sprintf("%s", tc.testID), func(t *testing.T) {
+		t.Run(tc.testID, func(t *testing.T) {
 			changeovers := GetChangeOvers(tc.periods...)
 			if !slicesEqual(changeovers, tc.result) {
 				t.Errorf("Expected %v but got %v", tc.result, changeovers)
@@ -320,7 +319,7 @@ func TestFlattenPeriods(t *testing.T) {
 	}
 
 	for _, tc := range testCases {
-		t.Run(fmt.Sprintf("%s", tc.testID), func(t *testing.T) {
+		t.Run(tc.testID, func(t *testing.T) {
 			changeovers := FlattenPeriods(tc.periods...)
 			if !slicesEqual(changeovers, tc.result) {
 				t.Errorf("Expected %v but got %v", tc.result, changeovers)
@@ -468,7 +467,7 @@ func TestGetNextChangeOver(t *testing.T) {
 		},
 	}
 	for _, tc := range testCases {
-		t.Run(fmt.Sprintf("%s", tc.testID), func(t *testing.T) {
+		t.Run(tc.testID, func(t *testing.T) {
 			ts, err := GetNextChangeOver(now, tc.periods...)
 			if tc.err != err {
 				t.Errorf("Error %v does not match expected %v", tc.err, err)

msp/errors.go

@@ -5,9 +5,9 @@ import (
 )
 
 var (
-	// ErrEndAfterStart occurs when a period given has an end time after its start time
+	// ErrEndAfterStart occurs when a period's start time is after its end time
 	ErrEndAfterStart = errors.New("error: start time is after end time")
-	// ErrNoValidPeriods occurs when an empty set of periods is passed or when ll periods are invalid
+	// ErrNoValidPeriods occurs when an empty set of periods is passed or when all periods are invalid
 	ErrNoValidPeriods = errors.New("error: no valid periods available")
 	// ErrNoNextChangeover occurs when GetNextChangeover is called but there are no changeovers after t
 	ErrNoNextChangeover = errors.New("error: no valid changeovers available")

msp/msp.go

@@ -12,7 +12,7 @@ func MostSpecificPeriod(ts time.Time, periods ...Period) (id string, err error)
 		return "", ErrNoValidPeriods
 	}
 	// find the shortest duration
-	d, err := GetDuration(periods[0].GetStartTime(), periods[0].GetEndTime())
+	d, _ := GetDuration(periods[0].GetStartTime(), periods[0].GetEndTime())
 	for _, x := range periods {
 		p, err := GetDuration(x.GetStartTime(), x.GetEndTime())
 		if err == nil && p < d {
@@ -34,7 +34,7 @@ func MostSpecificPeriod(ts time.Time, periods ...Period) (id string, err error)
 			newest = x.GetStartTime()
 		}
 	}
-	// Determine whichever of these periods have the same start time in addtion to duration
+	// Determine whichever of these periods have the same start time in addition to duration
 	var matchingDurationsAndStartTimes []Period
 	for _, x := range matchingDurations {
 		if x.GetStartTime() == newest {

msp/msp_test.go

@@ -1,7 +1,6 @@
 package msp
 
 import (
-	"fmt"
 	"testing"
 	"time"
 )
@@ -146,7 +145,7 @@ func TestMostSpecificPeriod(t *testing.T) {
 		},
 	}
 	for _, tc := range testCases {
-		t.Run(fmt.Sprintf("%s", tc.testID), func(t *testing.T) {
+		t.Run(tc.testID, func(t *testing.T) {
 			id, err := MostSpecificPeriod(tc.ts, tc.periods...)
 			if id != tc.result {
 				t.Errorf("ID '%s' does not match expected '%s'", id, tc.result)

msp/timeline_test.go

@@ -263,7 +263,7 @@ func TestGenerateTime(t *testing.T) {
 	}
 
 	for _, tc := range testCases {
-		t.Run(fmt.Sprintf("%s", tc.testID), func(t *testing.T) {
+		t.Run(tc.testID, func(t *testing.T) {
 			timeline := GenerateTimeline(tc.periods...)
 			if len(timeline) != len(tc.result) {
 				t.Fatalf("Time line had %d results, expected %d", len(timeline), len(tc.result))

msp/types.go

@@ -2,6 +2,9 @@ package msp
 
 import "time"
 
+// Compile-time interface check.
+var _ Period = TimeWindow{}
+
 type Period interface {
 	GetStartTime() time.Time
 	GetEndTime() time.Time