Skip to content

Commit

Permalink
fix!: modified struct name of an error
Browse files Browse the repository at this point in the history
  • Loading branch information
sttk committed Sep 15, 2024
1 parent 5876c96 commit 11a7fb1
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 20 deletions.
10 changes: 5 additions & 5 deletions errors/errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ type InvalidOption interface {
Error() string
}

// OptionHasInvalidChar is the error which indicates that an invalid character
// OptionContainsInvalidChar is the error which indicates that an invalid character
// is found in the option.
type OptionHasInvalidChar struct {
type OptionContainsInvalidChar struct {
Option string
}

// Error is the method to retrieve the message of this error.
func (e OptionHasInvalidChar) Error() string {
return fmt.Sprintf("OptionHasInvalidChar{Option:%s}", e.Option)
func (e OptionContainsInvalidChar) Error() string {
return fmt.Sprintf("OptionContainsInvalidChar{Option:%s}", e.Option)
}

// GetOption is the method to retrieve the name of the option that caused this error.
func (e OptionHasInvalidChar) GetOption() string {
func (e OptionContainsInvalidChar) GetOption() string {
return e.Option
}

Expand Down
6 changes: 3 additions & 3 deletions errors/errors_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ import (
"github.com/sttk/cliargs/errors"
)

func TestErrors_OptionHasInvalidChar(t *testing.T) {
e := errors.OptionHasInvalidChar{Option: "foo"}
func TestErrors_OptionContainsInvalidChar(t *testing.T) {
e := errors.OptionContainsInvalidChar{Option: "foo"}
assert.Equal(t, e.Option, "foo")
assert.Equal(t, e.GetOption(), "foo")
assert.Equal(t, e.Error(), "OptionHasInvalidChar{Option:foo}")
assert.Equal(t, e.Error(), "OptionContainsInvalidChar{Option:foo}")

var ee errors.InvalidOption = e
assert.Equal(t, ee.GetOption(), "foo")
Expand Down
6 changes: 3 additions & 3 deletions parse.go
Original file line number Diff line number Diff line change
Expand Up @@ -147,14 +147,14 @@ L0:
}
if !unicode.Is(rangeOfAlNumMarks, r) {
if firstErr == nil {
firstErr = errors.OptionHasInvalidChar{Option: arg}
firstErr = errors.OptionContainsInvalidChar{Option: arg}
}
continue L0
}
} else {
if !unicode.Is(rangeOfAlphabets, r) {
if firstErr == nil {
firstErr = errors.OptionHasInvalidChar{Option: arg}
firstErr = errors.OptionContainsInvalidChar{Option: arg}
}
continue L0
}
Expand Down Expand Up @@ -213,7 +213,7 @@ L0:
}
if !unicode.Is(rangeOfAlphabets, r) {
if firstErr == nil {
firstErr = errors.OptionHasInvalidChar{Option: string(r)}
firstErr = errors.OptionContainsInvalidChar{Option: string(r)}
}
name = ""
} else {
Expand Down
18 changes: 9 additions & 9 deletions parse_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -328,9 +328,9 @@ func TestParse_illegalLongOptIfIncludingInvalidChar(t *testing.T) {
err := cmd.Parse()

assert.NotNil(t, err)
assert.Equal(t, err.Error(), "OptionHasInvalidChar{Option:abc%def}")
assert.Equal(t, err.Error(), "OptionContainsInvalidChar{Option:abc%def}")
switch e := err.(type) {
case errors.OptionHasInvalidChar:
case errors.OptionContainsInvalidChar:
assert.Equal(t, e.Option, "abc%def")
default:
assert.Fail(t, err.Error())
Expand Down Expand Up @@ -369,9 +369,9 @@ func TestParse_illegalLongOptIfFirstCharIsNumber(t *testing.T) {
err := cmd.Parse()

assert.NotNil(t, err)
assert.Equal(t, err.Error(), "OptionHasInvalidChar{Option:1abc}")
assert.Equal(t, err.Error(), "OptionContainsInvalidChar{Option:1abc}")
switch e := err.(type) {
case errors.OptionHasInvalidChar:
case errors.OptionContainsInvalidChar:
assert.Equal(t, e.Option, "1abc")
default:
assert.Fail(t, err.Error())
Expand Down Expand Up @@ -410,9 +410,9 @@ func TestParse_illegalLongOptIfFirstCharIsHyphen(t *testing.T) {
err := cmd.Parse()

assert.NotNil(t, err)
assert.Equal(t, err.Error(), "OptionHasInvalidChar{Option:-aaa=123}")
assert.Equal(t, err.Error(), "OptionContainsInvalidChar{Option:-aaa=123}")
switch e := err.(type) {
case errors.OptionHasInvalidChar:
case errors.OptionContainsInvalidChar:
assert.Equal(t, e.Option, "-aaa=123")
default:
assert.Fail(t, err.Error())
Expand Down Expand Up @@ -453,9 +453,9 @@ func TestParse_IllegalCharInShortOpt(t *testing.T) {
err := cmd.Parse()

assert.NotNil(t, err)
assert.Equal(t, err.Error(), "OptionHasInvalidChar{Option:@}")
assert.Equal(t, err.Error(), "OptionContainsInvalidChar{Option:@}")
switch e := err.(type) {
case errors.OptionHasInvalidChar:
case errors.OptionContainsInvalidChar:
assert.Equal(t, e.Option, "@")
default:
assert.Fail(t, err.Error())
Expand Down Expand Up @@ -587,7 +587,7 @@ func TestParse_parseAllArgsEvenIfError(t *testing.T) {
err := cmd.Parse()

switch e := err.(type) {
case errors.OptionHasInvalidChar:
case errors.OptionContainsInvalidChar:
assert.Equal(t, e.Option, "1")
default:
assert.Fail(t, err.Error())
Expand Down

0 comments on commit 11a7fb1

Please sign in to comment.