add support files for new even optional parameter

Author: mschuchard

CHANGELOG.md

@@ -1,5 +1,6 @@
 ### 2.3.0 (Next)
 - Add `truncate` function.
+- Add `even` optional parameter to `round` function.
 
 ### 2.2.2
 - Update `exp`, `mod`, and `sqrt` functions' input parameter type from `float64` to `number`.

examples/functions/round/function.tf

@@ -8,4 +8,12 @@ provider::stdlib::round(1.8)
 
 # Return the rounding of 1.5:
 provider::stdlib::round(1.5)
-# result => 2
+# result => 2
+
+# Return the even tiebreak rounding of 2.5:
+provider::stdlib::round(2.5, true)
+# result => 2
+
+# Return the normal tiebreak rounding of 2.5:
+provider::stdlib::round(2.5, false)
+# result => 3

examples/functions/sort_list_number/function.tf

@@ -1,7 +1,7 @@
 # Return the sorted list of integers:
-provider::stdlib::sort_list_string([0, 4, -10, 8])
+provider::stdlib::sort_list_number([0, 4, -10, 8])
 # result => [-10, 0, 4, 8]
 
 # Return the sorted list of floats:
-provider::stdlib::sort_list_string([9.0, 45.5, 123.4, -0.5])
+provider::stdlib::sort_list_number([9.0, 45.5, 123.4, -0.5])
 # result => [-0.5, 9.0, 45.5, 123.4]

stdlib/number/round.go

@@ -38,7 +38,7 @@ func (*roundFunction) Definition(_ context.Context, _ function.DefinitionRequest
 		},
 		VariadicParameter: function.BoolParameter{
 			Name:                "even",
-			MarkdownDescription: "If true then round to the nearest even integer instead. Specifying `false` is the same as not providing an input value for this parameter (default behavior).",
+			MarkdownDescription: "If true then round 'ties' (i.e. `.5`) to the nearest even integer instead. Specifying `false` is the same as not providing an input value for this parameter (default behavior).",
 		},
 		Return: function.Int64Return{},
 	}

stdlib/number/round_test.go

@@ -19,31 +19,47 @@ func TestRoundFunction(test *testing.T) {
 	testCases := util.TestCases{
 		"round-down": {
 			Request: function.RunRequest{
-				Arguments: function.NewArgumentsData([]attr.Value{types.Float64Value(1.2)}),
+				Arguments: function.NewArgumentsData([]attr.Value{types.Float64Value(1.2), types.TupleValueMust([]attr.Type{}, []attr.Value{})}),
 			},
 			Expected: function.RunResponse{
 				Result: function.NewResultData(types.Int64Value(1)),
 			},
 		},
 		"round-up": {
 			Request: function.RunRequest{
-				Arguments: function.NewArgumentsData([]attr.Value{types.Float64Value(1.8)}),
+				Arguments: function.NewArgumentsData([]attr.Value{types.Float64Value(1.8), types.TupleValueMust([]attr.Type{}, []attr.Value{})}),
 			},
 			Expected: function.RunResponse{
 				Result: function.NewResultData(types.Int64Value(2)),
 			},
 		},
 		"round-half": {
 			Request: function.RunRequest{
-				Arguments: function.NewArgumentsData([]attr.Value{types.Float64Value(1.5)}),
+				Arguments: function.NewArgumentsData([]attr.Value{types.Float64Value(1.5), types.TupleValueMust([]attr.Type{}, []attr.Value{})}),
 			},
 			Expected: function.RunResponse{
 				Result: function.NewResultData(types.Int64Value(2)),
 			},
 		},
+		"round-half-even-true": {
+			Request: function.RunRequest{
+				Arguments: function.NewArgumentsData([]attr.Value{types.Float64Value(2.5), types.TupleValueMust([]attr.Type{types.BoolType}, []attr.Value{types.BoolValue(true)})}),
+			},
+			Expected: function.RunResponse{
+				Result: function.NewResultData(types.Int64Value(2)),
+			},
+		},
+		"round-half-even-false": {
+			Request: function.RunRequest{
+				Arguments: function.NewArgumentsData([]attr.Value{types.Float64Value(2.5), types.TupleValueMust([]attr.Type{types.BoolType}, []attr.Value{types.BoolValue(false)})}),
+			},
+			Expected: function.RunResponse{
+				Result: function.NewResultData(types.Int64Value(3)),
+			},
+		},
 		"beyond-upper-limit": {
 			Request: function.RunRequest{
-				Arguments: function.NewArgumentsData([]attr.Value{types.NumberValue(func() *big.Float { f := new(big.Float); f.SetString("1e+310"); return f }())}),
+				Arguments: function.NewArgumentsData([]attr.Value{types.NumberValue(func() *big.Float { f := new(big.Float); f.SetString("1e+310"); return f }()), types.TupleValueMust([]attr.Type{}, []attr.Value{})}),
 			},
 			Expected: function.RunResponse{
 				Result: resultData,
@@ -52,7 +68,7 @@ func TestRoundFunction(test *testing.T) {
 		},
 		"overflow": {
 			Request: function.RunRequest{
-				Arguments: function.NewArgumentsData([]attr.Value{types.Float64Value(9.223372036854777e+18)}), // math.MaxInt64 + 1
+				Arguments: function.NewArgumentsData([]attr.Value{types.Float64Value(9.223372036854777e+18), types.TupleValueMust([]attr.Type{}, []attr.Value{})}), // math.MaxInt64 + 1
 			},
 			Expected: function.RunResponse{
 				Result: resultData,