ferret/pkg/stdlib/testing/include.go

package testing

import (
	"context"
	"fmt"

	"github.com/MontFerret/ferret/pkg/runtime/core"
	"github.com/MontFerret/ferret/pkg/runtime/values"
	"github.com/MontFerret/ferret/pkg/stdlib/collections"
	"github.com/MontFerret/ferret/pkg/stdlib/testing/base"
)

// Include asserts that haystack includes needle.
// @params actual (String|Array|Object|Iterable) - Haystack value.
// @params expected (Mixed) - Expected value.
// @params message (String, optional) - Message to display on error.
var Include = base.Assertion{
	DefaultMessage: func(args []core.Value) string {
		return fmt.Sprintf("include %s", base.FormatValue(args[1]))
	},
	MinArgs: 2,
	MaxArgs: 3,
	Fn: func(ctx context.Context, args []core.Value) (bool, error) {
		haystack := args[0]
		needle := args[1]

		out, err := collections.Includes(ctx, haystack, needle)

		if err != nil {
			return false, err
		}

		return out.Compare(values.True) == 0, nil
	},
}