From ec20e777a16836763e34ab1d0999e012a5c7e314 Mon Sep 17 00:00:00 2001 From: Oleksandr Redko Date: Fri, 15 Nov 2024 13:34:06 +0200 Subject: [PATCH] refactor: reduce indentation for AddConstantRule.configure --- rule/add_constant.go | 111 +++++++++++++++---------------- test/add_constant_test.go | 20 +++--- testdata/add_constant_default.go | 12 ++++ 3 files changed, 78 insertions(+), 65 deletions(-) create mode 100644 testdata/add_constant_default.go diff --git a/rule/add_constant.go b/rule/add_constant.go index a766b5177..bf822e7a5 100644 --- a/rule/add_constant.go +++ b/rule/add_constant.go @@ -202,65 +202,64 @@ func (w *lintAddConstantRule) isStructTag(n *ast.BasicLit) bool { } func (r *AddConstantRule) configure(arguments lint.Arguments) { - if r.allowList == nil { - r.strLitLimit = defaultStrLitLimit - r.allowList = newAllowList() - if len(arguments) > 0 { - args, ok := arguments[0].(map[string]any) + r.strLitLimit = defaultStrLitLimit + r.allowList = newAllowList() + if len(arguments) == 0 { + return + } + args, ok := arguments[0].(map[string]any) + if !ok { + panic(fmt.Sprintf("Invalid argument to the add-constant rule, expecting a k,v map. Got %T", arguments[0])) + } + for k, v := range args { + kind := "" + switch k { + case "allowFloats": + kind = kindFLOAT + fallthrough + case "allowInts": + if kind == "" { + kind = kindINT + } + fallthrough + case "allowStrs": + if kind == "" { + kind = kindSTRING + } + list, ok := v.(string) + if !ok { + panic(fmt.Sprintf("Invalid argument to the add-constant rule, string expected. Got '%v' (%T)", v, v)) + } + r.allowList.add(kind, list) + case "maxLitCount": + sl, ok := v.(string) if !ok { - panic(fmt.Sprintf("Invalid argument to the add-constant rule. Expecting a k,v map, got %T", arguments[0])) + panic(fmt.Sprintf("Invalid argument to the add-constant rule, expecting string representation of an integer. Got '%v' (%T)", v, v)) } - for k, v := range args { - kind := "" - switch k { - case "allowFloats": - kind = kindFLOAT - fallthrough - case "allowInts": - if kind == "" { - kind = kindINT - } - fallthrough - case "allowStrs": - if kind == "" { - kind = kindSTRING - } - list, ok := v.(string) - if !ok { - panic(fmt.Sprintf("Invalid argument to the add-constant rule, string expected. Got '%v' (%T)", v, v)) - } - r.allowList.add(kind, list) - case "maxLitCount": - sl, ok := v.(string) - if !ok { - panic(fmt.Sprintf("Invalid argument to the add-constant rule, expecting string representation of an integer. Got '%v' (%T)", v, v)) - } - - limit, err := strconv.Atoi(sl) - if err != nil { - panic(fmt.Sprintf("Invalid argument to the add-constant rule, expecting string representation of an integer. Got '%v'", v)) - } - r.strLitLimit = limit - case "ignoreFuncs": - excludes, ok := v.(string) - if !ok { - panic(fmt.Sprintf("Invalid argument to the ignoreFuncs parameter of add-constant rule, string expected. Got '%v' (%T)", v, v)) - } - - for _, exclude := range strings.Split(excludes, ",") { - exclude = strings.Trim(exclude, " ") - if exclude == "" { - panic("Invalid argument to the ignoreFuncs parameter of add-constant rule, expected regular expression must not be empty.") - } - - exp, err := regexp.Compile(exclude) - if err != nil { - panic(fmt.Sprintf("Invalid argument to the ignoreFuncs parameter of add-constant rule: regexp %q does not compile: %v", exclude, err)) - } - - r.ignoreFunctions = append(r.ignoreFunctions, exp) - } + + limit, err := strconv.Atoi(sl) + if err != nil { + panic(fmt.Sprintf("Invalid argument to the add-constant rule, expecting string representation of an integer. Got '%v'", v)) + } + r.strLitLimit = limit + case "ignoreFuncs": + excludes, ok := v.(string) + if !ok { + panic(fmt.Sprintf("Invalid argument to the ignoreFuncs parameter of add-constant rule, string expected. Got '%v' (%T)", v, v)) + } + + for _, exclude := range strings.Split(excludes, ",") { + exclude = strings.Trim(exclude, " ") + if exclude == "" { + panic("Invalid argument to the ignoreFuncs parameter of add-constant rule, expected regular expression must not be empty.") } + + exp, err := regexp.Compile(exclude) + if err != nil { + panic(fmt.Sprintf("Invalid argument to the ignoreFuncs parameter of add-constant rule: regexp %q does not compile: %v", exclude, err)) + } + + r.ignoreFunctions = append(r.ignoreFunctions, exp) } } } diff --git a/test/add_constant_test.go b/test/add_constant_test.go index 6480ed562..1f2091301 100644 --- a/test/add_constant_test.go +++ b/test/add_constant_test.go @@ -7,16 +7,18 @@ import ( "github.com/mgechev/revive/rule" ) -func TestAddConstant(t *testing.T) { - args := []any{map[string]any{ - "maxLitCount": "2", - "allowStrs": "\"\"", - "allowInts": "0,1,2", - "allowFloats": "0.0,1.0", - "ignoreFuncs": "os\\.(CreateFile|WriteFile|Chmod|FindProcess),\\.Println,ignoredFunc,\\.Info", - }} +func TestAddConstantWithDefaultArguments(t *testing.T) { + testRule(t, "add_constant_default", &rule.AddConstantRule{}, &lint.RuleConfig{}) +} +func TestAddConstantWithArguments(t *testing.T) { testRule(t, "add_constant", &rule.AddConstantRule{}, &lint.RuleConfig{ - Arguments: args, + Arguments: []any{map[string]any{ + "maxLitCount": "2", + "allowStrs": "\"\"", + "allowInts": "0,1,2", + "allowFloats": "0.0,1.0", + "ignoreFuncs": "os\\.(CreateFile|WriteFile|Chmod|FindProcess),\\.Println,ignoredFunc,\\.Info", + }}, }) } diff --git a/testdata/add_constant_default.go b/testdata/add_constant_default.go new file mode 100644 index 000000000..2580f39dc --- /dev/null +++ b/testdata/add_constant_default.go @@ -0,0 +1,12 @@ +package fixtures + +func foo() { + a = "ignore" + b = "ignore" + + c = "match" + d = "match" + e = "match" // MATCH /string literal "match" appears, at least, 3 times, create a named constant for it/ + + f = 5 // MATCH /avoid magic numbers like '5', create a named constant for it/ +}