github.com/MontFerret/ferret@v0.18.0/pkg/runtime/values/array_test.go

package values_test

import (
	"context"
	"encoding/json"
	"testing"

	"github.com/MontFerret/ferret/pkg/runtime/core"
	"github.com/MontFerret/ferret/pkg/runtime/values"
	"github.com/MontFerret/ferret/pkg/runtime/values/types"

	. "github.com/smartystreets/goconvey/convey"
)

func TestArray(t *testing.T) {
	Convey("#constructor", t, func() {
		Convey("Should create an empty array", func() {
			arr := values.NewArray(10)

			So(arr.Length(), ShouldEqual, 0)
		})

		Convey("Should create an array, from passed values", func() {
			arr := values.NewArrayWith(
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
			)

			So(arr.Length(), ShouldEqual, 3)
		})
	})

	Convey(".MarshalJSON", t, func() {
		Convey("Should serialize empty array", func() {
			arr := values.NewArray(10)
			marshaled, err := arr.MarshalJSON()

			So(err, ShouldBeNil)

			So(string(marshaled), ShouldEqual, "[]")
		})

		Convey("Should serialize full array", func() {
			arr := values.NewArrayWith(
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
			)
			marshaled, err := json.Marshal(arr)

			So(err, ShouldBeNil)

			So(string(marshaled), ShouldEqual, "[1,2,3]")
		})
	})

	Convey(".Type", t, func() {
		Convey("Should return type", func() {
			arr := values.NewArray(1)

			So(arr.Type().Equals(types.Array), ShouldBeTrue)
		})
	})

	Convey(".Unwrap", t, func() {
		Convey("Should return a an array of unwrapped values", func() {
			arr := values.NewArrayWith(
				values.ZeroInt,
				values.ZeroInt,
			)

			for _, val := range arr.Unwrap().([]interface{}) {
				So(val, ShouldHaveSameTypeAs, 0)
			}
		})
	})

	Convey(".String", t, func() {
		Convey("Should return a string representation ", func() {
			arr := values.NewArrayWith(values.ZeroInt, values.ZeroInt)

			So(arr.String(), ShouldEqual, "[0,0]")
		})
	})

	Convey(".Compare", t, func() {
		Convey("It should return 1 for all non-array and non-object values", func() {
			arr := values.NewArrayWith(values.ZeroInt, values.ZeroInt)

			So(arr.Compare(values.None), ShouldEqual, 1)
			So(arr.Compare(values.ZeroInt), ShouldEqual, 1)
			So(arr.Compare(values.ZeroFloat), ShouldEqual, 1)
			So(arr.Compare(values.EmptyString), ShouldEqual, 1)
		})

		Convey("It should return -1 for all object values", func() {
			arr := values.NewArrayWith(values.ZeroInt, values.ZeroInt)
			obj := values.NewObject()

			So(arr.Compare(obj), ShouldEqual, -1)
		})

		Convey("It should return 0 when both arrays are empty", func() {
			arr1 := values.NewArray(1)
			arr2 := values.NewArray(1)

			So(arr1.Compare(arr2), ShouldEqual, 0)
		})

		Convey("It should return 1 when other array is empty", func() {
			arr1 := values.NewArrayWith(values.ZeroFloat)
			arr2 := values.NewArray(1)

			So(arr1.Compare(arr2), ShouldEqual, 1)
		})

		Convey("It should return 1 when values are bigger", func() {
			arr1 := values.NewArrayWith(values.NewInt(1))
			arr2 := values.NewArrayWith(values.ZeroInt)

			So(arr1.Compare(arr2), ShouldEqual, 1)
		})

		Convey("It should return 0 when arrays are equal", func() {
			Convey("When only simple types are nested", func() {
				arr1 := values.NewArrayWith(
					values.NewInt(0), values.NewString("str"),
				)
				arr2 := values.NewArrayWith(
					values.NewInt(0), values.NewString("str"),
				)

				So(arr1.Compare(arr2), ShouldEqual, 0)
			})

			Convey("When object and array are nested at the same time", func() {
				arr1 := values.NewArrayWith(
					values.NewObjectWith(
						values.NewObjectProperty("one", values.NewInt(1)),
					),
					values.NewArrayWith(
						values.NewInt(2),
					),
				)
				arr2 := values.NewArrayWith(
					values.NewObjectWith(
						values.NewObjectProperty("one", values.NewInt(1)),
					),
					values.NewArrayWith(
						values.NewInt(2),
					),
				)

				So(arr1.Compare(arr2), ShouldEqual, 0)
			})

			Convey("When only objects are nested", func() {
				arr1 := values.NewArrayWith(
					values.NewObjectWith(
						values.NewObjectProperty("one", values.NewInt(1)),
					),
				)
				arr2 := values.NewArrayWith(
					values.NewObjectWith(
						values.NewObjectProperty("one", values.NewInt(1)),
					),
				)

				So(arr1.Compare(arr2), ShouldEqual, 0)
			})

			Convey("When only arrays are nested", func() {
				arr1 := values.NewArrayWith(
					values.NewArrayWith(
						values.NewInt(2),
					),
				)
				arr2 := values.NewArrayWith(
					values.NewArrayWith(
						values.NewInt(2),
					),
				)

				So(arr1.Compare(arr2), ShouldEqual, 0)
			})

			Convey("When simple and complex types at the same time", func() {
				arr1 := values.NewArrayWith(
					values.NewInt(0),
					values.NewObjectWith(
						values.NewObjectProperty("one", values.NewInt(1)),
					),
					values.NewArrayWith(
						values.NewInt(2),
					),
				)
				arr2 := values.NewArrayWith(
					values.NewInt(0),
					values.NewObjectWith(
						values.NewObjectProperty("one", values.NewInt(1)),
					),
					values.NewArrayWith(
						values.NewInt(2),
					),
				)

				So(arr1.Compare(arr2), ShouldEqual, 0)
			})

			Convey("When custom complex type", func() {
				arr1 := values.NewArrayWith(
					values.NewObjectWith(
						values.NewObjectProperty(
							"arr", values.NewArrayWith(values.NewObject()),
						),
					),
				)
				arr2 := values.NewArrayWith(
					values.NewObjectWith(
						values.NewObjectProperty(
							"arr", values.NewArrayWith(values.NewObject()),
						),
					),
				)

				So(arr1.Compare(arr2), ShouldEqual, 0)
			})
		})
	})

	Convey(".Hash", t, func() {
		Convey("It should calculate hash of non-empty array", func() {
			arr := values.NewArrayWith(
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
			)

			h := arr.Hash()

			So(h, ShouldBeGreaterThan, 0)
		})

		Convey("It should calculate hash of empty array", func() {
			arr := values.NewArrayWith()

			h := arr.Hash()

			So(h, ShouldBeGreaterThan, 0)
		})

		Convey("Hash sum should be consistent", func() {
			arr := values.NewArrayWith(
				values.True,
				values.NewInt(1),
				values.NewFloat(1.1),
				values.NewString("foobar"),
				values.NewCurrentDateTime(),
				values.NewArrayWith(values.NewInt(1), values.True),
				values.NewObjectWith(values.NewObjectProperty("foo", values.NewString("bar"))),
			)

			h1 := arr.Hash()
			h2 := arr.Hash()

			So(h1, ShouldEqual, h2)
		})
	})

	Convey(".Length", t, func() {
		Convey("Should return 0 when empty", func() {
			arr := values.NewArray(1)

			So(arr.Length(), ShouldEqual, 0)
		})

		Convey("Should return greater than 0 when not empty", func() {
			arr := values.NewArrayWith(values.ZeroInt, values.ZeroInt)

			So(arr.Length(), ShouldEqual, 2)
		})
	})

	Convey(".ForEach", t, func() {
		Convey("Should iterate over elements", func() {
			arr := values.NewArrayWith(
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
			)
			counter := 0

			arr.ForEach(func(value core.Value, idx int) bool {
				counter++

				return true
			})

			So(counter, ShouldEqual, arr.Length())
		})

		Convey("Should not iterate when empty", func() {
			arr := values.NewArrayWith()
			counter := 0

			arr.ForEach(func(value core.Value, idx int) bool {
				counter++

				return true
			})

			So(counter, ShouldEqual, arr.Length())
		})

		Convey("Should break iteration when false returned", func() {
			arr := values.NewArrayWith(
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
				values.NewInt(4),
				values.NewInt(5),
			)
			threshold := 3
			counter := 0

			arr.ForEach(func(value core.Value, idx int) bool {
				counter++

				return value.Compare(values.NewInt(threshold)) == -1
			})

			So(counter, ShouldEqual, threshold)
		})
	})

	Convey(".Get", t, func() {
		Convey("Should return item by index", func() {
			arr := values.NewArrayWith(
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
				values.NewInt(4),
				values.NewInt(5),
			)

			el := arr.Get(1)

			So(el.Compare(values.NewInt(2)), ShouldEqual, 0)
		})

		Convey("Should return None when no items", func() {
			arr := values.NewArrayWith()

			el := arr.Get(1)

			So(el.Compare(values.None), ShouldEqual, 0)
		})
	})

	Convey(".Set", t, func() {
		Convey("Should set item by index", func() {
			arr := values.NewArrayWith(values.ZeroInt)

			err := arr.Set(0, values.NewInt(1))

			So(err, ShouldBeNil)
			So(arr.Length(), ShouldEqual, 1)
			So(arr.Get(0).Compare(values.NewInt(1)), ShouldEqual, 0)
		})

		Convey("Should return an error when index is out of bounds", func() {
			arr := values.NewArray(10)

			err := arr.Set(0, values.NewInt(1))

			So(err, ShouldNotBeNil)
			So(arr.Length(), ShouldEqual, 0)
		})
	})

	Convey(".Push", t, func() {
		Convey("Should add an item", func() {
			arr := values.NewArray(10)

			src := []core.Value{
				values.ZeroInt,
				values.ZeroInt,
				values.ZeroInt,
				values.ZeroInt,
				values.ZeroInt,
			}

			for _, val := range src {
				arr.Push(val)
			}

			So(arr.Length(), ShouldEqual, len(src))
		})
	})

	Convey(".Slice", t, func() {
		Convey("Should return a slice", func() {
			arr := values.NewArrayWith(
				values.NewInt(0),
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
				values.NewInt(4),
				values.NewInt(5),
			)

			s := arr.Slice(0, 1)

			So(s.Length(), ShouldEqual, 1)
			So(s.Get(0).Compare(values.ZeroInt), ShouldEqual, 0)

			s2 := arr.Slice(2, arr.Length())

			So(s2.Length(), ShouldEqual, arr.Length()-2)
		})
	})

	Convey(".Insert", t, func() {
		Convey("Should insert an item in the middle of an array", func() {
			arr := values.NewArrayWith(
				values.NewInt(0),
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
				values.NewInt(4),
				values.NewInt(5),
			)

			lenBefore := arr.Length()

			arr.Insert(3, values.NewInt(100))

			lenAfter := arr.Length()

			So(lenAfter, ShouldBeGreaterThan, lenBefore)
			So(arr.Get(3), ShouldEqual, 100)
		})
	})

	Convey(".RemoveAt", t, func() {
		Convey("Should remove an item from the middle", func() {
			arr := values.NewArrayWith(
				values.NewInt(0),
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
				values.NewInt(4),
				values.NewInt(5),
			)

			lenBefore := arr.Length()

			arr.RemoveAt(3)

			lenAfter := arr.Length()

			So(lenAfter, ShouldBeLessThan, lenBefore)
			So(arr.Get(3), ShouldEqual, 4)
		})

		Convey("Should remove an item from the end", func() {
			arr := values.NewArrayWith(
				values.NewInt(0),
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
				values.NewInt(4),
				values.NewInt(5),
			)

			lenBefore := arr.Length()

			arr.RemoveAt(5)

			lenAfter := arr.Length()

			So(lenAfter, ShouldBeLessThan, lenBefore)
			So(lenAfter, ShouldEqual, 5)
			So(arr.Get(4), ShouldEqual, 4)
		})

		Convey("Should remove an item from the beginning", func() {
			arr := values.NewArrayWith(
				values.NewInt(0),
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
				values.NewInt(4),
				values.NewInt(5),
			)

			lenBefore := arr.Length()

			arr.RemoveAt(0)

			lenAfter := arr.Length()

			So(lenAfter, ShouldBeLessThan, lenBefore)
			So(arr.Get(0), ShouldEqual, 1)
		})
	})

	Convey(".Clone", t, func() {
		Convey("Cloned array should be equal to source array", func() {
			arr := values.NewArrayWith(
				values.NewInt(0),
				values.NewObjectWith(
					values.NewObjectProperty("one", values.NewInt(1)),
				),
				values.NewArrayWith(
					values.NewInt(2),
				),
			)

			clone := arr.Clone().(*values.Array)

			So(arr.Length(), ShouldEqual, clone.Length())
			So(arr.Compare(clone), ShouldEqual, 0)
		})

		Convey("Cloned array should be independent of the source array", func() {
			arr := values.NewArrayWith(
				values.NewInt(0),
				values.NewInt(1),
				values.NewInt(2),
				values.NewInt(3),
				values.NewInt(4),
				values.NewInt(5),
			)

			clone := arr.Clone().(*values.Array)

			arr.Push(values.NewInt(6))

			So(arr.Length(), ShouldNotEqual, clone.Length())
			So(arr.Compare(clone), ShouldNotEqual, 0)
		})

		Convey("Cloned array must contain copies of the nested objects", func() {
			arr := values.NewArrayWith(
				values.NewArrayWith(
					values.NewInt(0),
					values.NewInt(1),
					values.NewInt(2),
					values.NewInt(3),
					values.NewInt(4),
				),
			)

			clone := arr.Clone().(*values.Array)

			nestedInArr := arr.Get(values.NewInt(0)).(*values.Array)
			nestedInArr.Push(values.NewInt(5))

			nestedInClone := clone.Get(values.NewInt(0)).(*values.Array)

			So(nestedInArr.Compare(nestedInClone), ShouldNotEqual, 0)
		})
	})

	Convey(".GetIn", t, func() {

		ctx := context.Background()

		Convey("Should return the same as .Get when input is correct", func() {

			Convey("Should return item by key", func() {
				key := values.NewInt(0)
				arr := values.NewArrayWith(
					values.NewInt(0),
				)

				el, err := arr.GetIn(ctx, []core.Value{key})
				elGet := arr.Get(key)

				So(err, ShouldBeNil)
				So(el.Compare(elGet), ShouldEqual, 0)
			})

			Convey("Should return None when no items", func() {
				key := values.NewInt(0)
				arr := values.NewArray(0)

				el, err := arr.GetIn(ctx, []core.Value{key})
				elGet := arr.Get(key)

				So(err, ShouldBeNil)
				So(el.Compare(elGet), ShouldEqual, 0)
			})
		})

		Convey("Should error when input is not correct", func() {

			Convey("Should error when path[0] is not an int", func() {
				arr := values.NewArray(0)
				path := []core.Value{values.NewString("")}

				el, err := arr.GetIn(ctx, path)

				So(err, ShouldBeError)
				So(el.Compare(values.None), ShouldEqual, 0)
			})

			Convey("Should error when first received item is not a Getter and len(path) > 1", func() {
				key := values.NewInt(0)
				arr := values.NewArrayWith(
					values.NewInt(1),
				)
				path := []core.Value{key, key}

				el, err := arr.GetIn(ctx, path)

				So(err, ShouldBeError)
				So(el.Compare(values.None), ShouldEqual, 0)
			})
		})

		Convey("Should return None when len(path) == 0", func() {
			arr := values.NewArrayWith(
				values.NewInt(1),
			)

			el, err := arr.GetIn(ctx, nil)

			So(err, ShouldBeNil)
			So(el.Compare(values.None), ShouldEqual, 0)
		})

		Convey("Should call the nested Getter", func() {
			key := values.NewInt(0)
			arr := values.NewArrayWith(
				values.NewObjectWith(
					values.NewObjectProperty("foo", key),
				),
			)

			el, err := arr.GetIn(ctx, []core.Value{
				key,                     // obj[0]
				values.NewString("foo"), // obj[0].foo
			})

			So(err, ShouldBeNil)
			So(el.Compare(key), ShouldEqual, 0)
		})
	})
}