pkg/math: added MultipleOf

Also:
- add support for Decimal type (internal)
- add correspondng support in openapi package

Change-Id: Idc4b829423bba63380a8edfc1109c345f4248355
Reviewed-on: https://cue-review.googlesource.com/c/cue/+/2640
Reviewed-by: Marcel van Lohuizen <[email protected]>

Author: mpvl

cue/builtin.go

@@ -28,6 +28,7 @@ import (
 	"cuelang.org/go/cue/errors"
 	"cuelang.org/go/cue/parser"
 	"cuelang.org/go/internal"
+	"github.com/cockroachdb/apd/v2"
 )
 
 // A builtin is a builtin function or constant.
@@ -393,6 +394,15 @@ func (c *callCtxt) uintValue(i, bits int, typ string) uint64 {
 	return res
 }
 
+func (c *callCtxt) decimal(i int) *apd.Decimal {
+	x := newValueRoot(c.ctx, c.args[i])
+	if _, err := x.MantExp(nil); err != nil {
+		c.invalidArgType(c.args[i], i, "Decimal", err)
+		return nil
+	}
+	return &c.args[i].(*numLit).v
+}
+
 func (c *callCtxt) float64(i int) float64 {
 	x := newValueRoot(c.ctx, c.args[i])
 	res, err := x.Float64()

cue/builtin_test.go

@@ -89,6 +89,21 @@ func TestBuiltins(t *testing.T) {
 	}, {
 		test("math", `math.Asin(2.0e400)`),
 		`_|_(cannot use 2.0e+400 (type float) as float64 in argument 0 to math.Asin: value was rounded up)`,
+	}, {
+		test("math", `math.MultipleOf(4, 2)`), `true`,
+	}, {
+		test("math", `math.MultipleOf(5, 2)`), `false`,
+	}, {
+		test("math", `math.MultipleOf(5, 0)`),
+		`_|_(error in call to math.MultipleOf: division by zero)`,
+	}, {
+		test("math", `math.MultipleOf(100, 1.00001)`), `false`,
+	}, {
+		test("math", `math.MultipleOf(1, 1)`), `true`,
+	}, {
+		test("math", `math.MultipleOf(5, 2.5)`), `true`,
+	}, {
+		test("math", `math.MultipleOf(100e100, 10)`), `true`,
 	}, {
 		test("encoding/csv", `csv.Decode("1,2,3\n4,5,6")`),
 		`[["1","2","3"],["4","5","6"]]`,

cue/builtins.go

@@ -388,6 +388,8 @@ func (g *generator) goKind(expr ast.Expr) string {
 		return "bigFloat"
 	case "big.Rat":
 		return "bigRat"
+	case "internal.Decimal":
+		return "decimal"
 	case "cue.Value":
 		return "value"
 	case "cue.List":
@@ -419,7 +421,7 @@ func (g *generator) goToCUE(expr ast.Expr) (cueKind string, omitCheck bool) {
 		"uint", "byte", "uint8", "uint16", "uint32", "uint64",
 		"bigInt":
 		cueKind += "intKind"
-	case "float64", "bigRat", "bigFloat":
+	case "float64", "bigRat", "bigFloat", "decimal":
 		cueKind += "numKind"
 	case "list":
 		cueKind += "listKind"

cue/gen.go

@@ -435,7 +435,7 @@ func (b *builder) dispatch(f typeFunc, v cue.Value) {
 
 // object supports the following
 // - maxProperties: maximum allowed fields in this struct.
-// - minProperties: minimum required fields in this struct.a
+// - minProperties: minimum required fields in this struct.
 // - patternProperties: [regexp]: schema
 //   TODO: we can support this once .kv(key, value) allow
 //      foo [=~"pattern"]: type
@@ -599,6 +599,18 @@ func (b *builder) number(v cue.Value) {
 			b.kv("maxItems", i),
 		})
 
+	case cue.CallOp:
+		name := fmt.Sprint(a[0])
+		switch name {
+		case "math.MultipleOf":
+			if len(a) != 2 {
+				b.failf(v, "builtin %v may only be used with single argument", name)
+			}
+			b.setFilter("Schema", "multipleOf", b.int(a[1]))
+		default:
+			b.failf(v, "builtin %v not supported in OpenAPI", name)
+		}
+
 	case cue.NoOp:
 		// TODO: extract format from specific type.
 

encoding/openapi/build.go

@@ -54,6 +54,10 @@ func TestParseDefinitions(t *testing.T) {
 		"strings.cue",
 		"strings.json",
 		defaultConfig,
+	}, {
+		"nums.cue",
+		"nums.json",
+		defaultConfig,
 	}, {
 		"oneof.cue",
 		"oneof.json",

encoding/openapi/openapi_test.go

@@ -0,0 +1,3 @@
+import "math"
+
+mul: math.MultipleOf(5)

encoding/openapi/testdata/nums.cue

@@ -0,0 +1,12 @@
+{
+   "openapi": "3.0.0",
+   "info": {},
+   "components": {
+      "schemas": {
+         "mul": {
+            "type": "number",
+            "multipleOf": 5
+         }
+      }
+   }
+}

encoding/openapi/testdata/nums.json

@@ -16,6 +16,13 @@ package internal // import "cuelang.org/go/internal"
 
 // TODO: refactor packages as to make this package unnecessary.
 
+import "github.com/cockroachdb/apd/v2"
+
+// A Decimal is an arbitrary-precision binary-coded decimal number.
+//
+// Right now Decimal is aliased to apd.Decimal. This may change in the future.
+type Decimal = apd.Decimal
+
 // DebugStr prints a syntax node.
 var DebugStr func(x interface{}) string
 

internal/internal.go

@@ -14,7 +14,12 @@
 
 package math
 
-import "math"
+import (
+	"math"
+
+	"cuelang.org/go/internal"
+	"github.com/cockroachdb/apd/v2"
+)
 
 // TODO: use apd
 
@@ -67,3 +72,12 @@ func Round(x float64) float64 {
 func RoundToEven(x float64) float64 {
 	return math.RoundToEven(x)
 }
+
+var mulContext = apd.BaseContext.WithPrecision(1)
+
+// MultipleOf reports whether x is a multiple of y.
+func MultipleOf(x, y *internal.Decimal) (bool, error) {
+	var d apd.Decimal
+	cond, err := mulContext.Quo(&d, x, y)
+	return !cond.Inexact(), err
+}