Merge pull request #120 from maxatome/style

maxatome · web-flow · commit e6858f2ebf9d · 2020-12-12T11:47:41.000+01:00
style: avoid redundant types in functions signatures
diff --git a/internal/util/json_pointer_test.go b/internal/util/json_pointer_test.go
@@ -46,7 +46,7 @@ func TestJSONPointer(t *testing.T) {
 		}
 	}
 
-	checkErr := func(pointer string, errExpected string) {
+	checkErr := func(pointer, errExpected string) {
 		t.Helper()
 
 		got, err := util.JSONPointer(ref, pointer)
diff --git a/internal/util/string.go b/internal/util/string.go
@@ -58,13 +58,13 @@ func ToString(val interface{}) string {
 
 // IndentString indents str lines (from 2nd one = 1st line is not
 // indented) by indent.
-func IndentString(str string, indent string) string {
+func IndentString(str, indent string) string {
 	return strings.Replace(str, "\n", "\n"+indent, -1) //nolint: gocritic
 }
 
 // IndentStringIn indents str lines (from 2nd one = 1st line is not
 // indented) by indent and write it to w.
-func IndentStringIn(w io.Writer, str string, indent string) {
+func IndentStringIn(w io.Writer, str, indent string) {
 	repl := strings.NewReplacer("\n", "\n"+indent)
 	repl.WriteString(w, str) //nolint: errcheck
 }
diff --git a/td/cmp_funcs.go b/td/cmp_funcs.go
diff --git a/td/t.go b/td/t.go
diff --git a/td/t_struct.go b/td/t_struct.go
@@ -586,7 +586,7 @@ func (t *T) Run(name string, f func(t *T)) bool {
 // The "assert" and "require" params of "f" inherit the configuration
 // of the self-reference, except that a failure is never fatal using
 // "assert" and always fatal using "require".
-func (t *T) RunAssertRequire(name string, f func(assert *T, require *T)) bool {
+func (t *T) RunAssertRequire(name string, f func(assert, require *T)) bool {
 	t.Helper()
 
 	vfuncs, ok := t.getRunFunc()
diff --git a/td/t_struct_test.go b/td/t_struct_test.go
@@ -161,12 +161,12 @@ func TestRunAssertRequire(t *testing.T) {
 		requireIsFatal := false
 
 		ok := t.RunAssertRequire("Test level1",
-			func(assert *td.T, require *td.T) {
+			func(assert, require *td.T) {
 				assertIsFatal = assert.Config.FailureIsFatal
 				requireIsFatal = require.Config.FailureIsFatal
 
 				ok := assert.RunAssertRequire("Test level2",
-					func(assert *td.T, require *td.T) {
+					func(assert, require *td.T) {
 						runPassed = assert.True(true)               // test succeeds!
 						runPassed = runPassed && require.True(true) // test succeeds!
 
@@ -177,7 +177,7 @@ func TestRunAssertRequire(t *testing.T) {
 				require.True(ok)
 
 				ok = require.RunAssertRequire("Test level2",
-					func(assert *td.T, require *td.T) {
+					func(assert, require *td.T) {
 						runPassed = runPassed && assert.True(true)  // test succeeds!
 						runPassed = runPassed && require.True(true) // test succeeds!
 
@@ -202,12 +202,12 @@ func TestRunAssertRequire(t *testing.T) {
 		requireIsFatal := false
 
 		ok := t.RunAssertRequire("Test level1",
-			func(assert *td.T, require *td.T) {
+			func(assert, require *td.T) {
 				assertIsFatal = assert.Config.FailureIsFatal
 				requireIsFatal = require.Config.FailureIsFatal
 
 				ok := assert.RunAssertRequire("Test level2",
-					func(assert *td.T, require *td.T) {
+					func(assert, require *td.T) {
 						runPassed = assert.True(true)               // test succeeds!
 						runPassed = runPassed && require.True(true) // test succeeds!
 
@@ -218,7 +218,7 @@ func TestRunAssertRequire(t *testing.T) {
 				require.True(ok)
 
 				ok = require.RunAssertRequire("Test level2",
-					func(assert *td.T, require *td.T) {
+					func(assert, require *td.T) {
 						runPassed = runPassed && assert.True(true)  // test succeeds!
 						runPassed = runPassed && require.True(true) // test succeeds!
 
diff --git a/td/td_between.go b/td/td_between.go
@@ -82,7 +82,7 @@ var _ TestDeep = &tdBetweenTime{}
 //   tc.Cmp(t, 17, td.Between(17, 20, BoundsOutOut)) // fails
 //
 // TypeBehind method returns the reflect.Type of "from" (same as the "to" one.)
-func Between(from interface{}, to interface{}, bounds ...BoundsKind) TestDeep {
+func Between(from, to interface{}, bounds ...BoundsKind) TestDeep {
 	b := tdBetween{
 		expectedMin: reflect.ValueOf(from),
 		expectedMax: reflect.ValueOf(to),
diff --git a/td/td_catch.go b/td/td_catch.go
@@ -57,7 +57,7 @@ var _ TestDeep = &tdCatch{}
 //     td.JSON(`{"id": $1, "name": "test"}`, td.Catch(&id, td.Ignore()))) {
 //     t.Logf("Created record ID is %d", id)
 //   }
-func Catch(target interface{}, expectedValue interface{}) TestDeep {
+func Catch(target, expectedValue interface{}) TestDeep {
 	vt := reflect.ValueOf(target)
 	if vt.Kind() != reflect.Ptr || vt.IsNil() || !vt.Elem().CanSet() {
 		panic(color.BadUsage("Catch(NON_NIL_PTR, EXPECTED_VALUE)", target, 1, true))
diff --git a/td/td_json.go b/td/td_json.go
@@ -111,7 +111,7 @@ func jsonCaller() string {
 	}
 }
 
-func unmarshal(expectedJSON interface{}, target interface{}) {
+func unmarshal(expectedJSON, target interface{}) {
 	var (
 		err error
 		b   []byte
diff --git a/td/td_re.go b/td/td_re.go
@@ -103,7 +103,7 @@ func Re(reg interface{}, capture ...interface{}) TestDeep {
 //     td.ReAll(`(\w+)(?: |\z)`, []string{"John", "Doe"})) // succeeds
 //   td.Cmp(t, "John Doe",
 //     td.ReAll(`(\w+)(?: |\z)`, td.Bag("Doe", "John"))) // succeeds
-func ReAll(reg interface{}, capture interface{}) TestDeep {
+func ReAll(reg, capture interface{}) TestDeep {
 	r := newRe(reg, capture)
 	r.numMatches = -1
 	return r
diff --git a/td/td_smuggle.go b/td/td_smuggle.go
@@ -293,7 +293,7 @@ func buildStructFieldFn(path string) (func(interface{}) (smuggleValue, error), e
 // TypeBehind method returns the reflect.Type of only parameter of
 // "fn". For the case where "fn" is a fields-path, it is always
 // interface{}, as the type can not be known in advance.
-func Smuggle(fn interface{}, expectedValue interface{}) TestDeep {
+func Smuggle(fn, expectedValue interface{}) TestDeep {
 	vfn := reflect.ValueOf(fn)
 
 	const usage = "Smuggle(FUNC|FIELDS_PATH, TESTDEEP_OPERATOR|EXPECTED_VALUE)"
diff --git a/tools/gen_funcs.pl b/tools/gen_funcs.pl
@@ -146,7 +146,8 @@
             {
                 my %arg;
                 @arg{qw(name type)} = split(/ /, $arg, 2);
-                if ($arg{variadic} = $arg{type} =~ s/^\.{3}//)
+                if (defined $arg{type}
+                    and $arg{variadic} = $arg{type} =~ s/^\.{3}//)
                 {
                     if (exists $IGNORE_VARIADIC{$func})
                     {
@@ -157,6 +158,18 @@
 
                 push(@args, \%arg);
             }
+            my $last_type;
+            foreach my $arg (reverse @args)
+            {
+                if (defined(my $arg_type = $arg->{type}) and not $arg->{variadic})
+                {
+                    if (defined $last_type and $arg_type eq $last_type)
+                    {
+                        delete $arg->{type};
+                    }
+                    $last_type = $arg_type;
+                }
+            }
 
 	    $funcs{$func}{args} = \@args unless $ONLY_OPERATORS{$func};
 
@@ -212,7 +225,26 @@ package td
     my $func_name = "Cmp$func";
     my $method_name = $RENAME_METHOD{$func} // $func;
 
-    my $cmp_args = 'got interface{}';
+    my $cmp_args = 'got';
+    if (@{$funcs{$func}{args}})
+    {
+        foreach my $arg (@{$funcs{$func}{args}})
+        {
+            if (defined $arg->{type})
+            {
+                if ($arg->{type} ne 'interface{}' or $arg->{variadic})
+                {
+                    $cmp_args .= ' interface{}';
+                }
+                last
+            }
+        }
+    }
+    else
+    {
+        $cmp_args .= ' interface{}';
+    }
+
     my $call_args = '';
     my @cmpt_args;
 
@@ -230,7 +262,7 @@ package td
             $cmp_args .= '[]';
         }
 
-        $cmp_args .= $arg->{type};
+        $cmp_args .= $arg->{type} if defined $arg->{type};
     }
 
     my $cmp_doc = <<EOF;

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ func TestJSONPointer(t *testing.T) {`
`46`	`46`	`}`
`47`	`47`	`}`
`48`	`48`
`49`		`- checkErr := func(pointer string, errExpected string) {`
	`49`	`+ checkErr := func(pointer, errExpected string) {`
`50`	`50`	`t.Helper()`
`51`	`51`
`52`	`52`	`got, err := util.JSONPointer(ref, pointer)`
Original file line number	Diff line number	Diff line change
`@@ -58,13 +58,13 @@ func ToString(val interface{}) string {`
`58`	`58`
`59`	`59`	`// IndentString indents str lines (from 2nd one = 1st line is not`
`60`	`60`	`// indented) by indent.`
`61`		`-func IndentString(str string, indent string) string {`
	`61`	`+func IndentString(str, indent string) string {`
`62`	`62`	`return strings.Replace(str, "\n", "\n"+indent, -1) //nolint: gocritic`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`// IndentStringIn indents str lines (from 2nd one = 1st line is not`
`66`	`66`	`// indented) by indent and write it to w.`
`67`		`-func IndentStringIn(w io.Writer, str string, indent string) {`
	`67`	`+func IndentStringIn(w io.Writer, str, indent string) {`
`68`	`68`	`repl := strings.NewReplacer("\n", "\n"+indent)`
`69`	`69`	`repl.WriteString(w, str) //nolint: errcheck`
`70`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ func jsonCaller() string {`
`111`	`111`	`}`
`112`	`112`	`}`
`113`	`113`
`114`		`-func unmarshal(expectedJSON interface{}, target interface{}) {`
	`114`	`+func unmarshal(expectedJSON, target interface{}) {`
`115`	`115`	`var (`
`116`	`116`	`err error`
`117`	`117`	`b []byte`