io.github.imsejin.common.assertion.array.ArrayAssert Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2021 Sejin Im
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.github.imsejin.common.assertion.array;

import io.github.imsejin.common.assertion.Asserts;
import io.github.imsejin.common.assertion.object.AbstractObjectAssert;
import io.github.imsejin.common.assertion.primitive.NumberAssert;
import io.github.imsejin.common.util.ArrayUtils;

import java.util.Arrays;
import java.util.Objects;

public class ArrayAssert> extends AbstractObjectAssert {

    public ArrayAssert(Object[] actual) {
        super(actual);
    }

    @Override
    public SELF isEqualTo(Object[] expected) {
        if (!Objects.deepEquals(actual, expected)) {
            setDefaultDescription("They are expected to be equal, but they aren't. (expected: '{0}', actual: '{1}')",
                    Arrays.toString(expected), Arrays.toString(actual));
            throw getException();
        }

        return self;
    }

    @Override
    public SELF isNotEqualTo(Object[] expected) {
        if (Objects.deepEquals(actual, expected)) {
            setDefaultDescription("They are expected to be not equal, but they are. (expected: '{0}', actual: '{1}')",
                    Arrays.toString(expected), Arrays.toString(actual));
            throw getException();
        }

        return self;
    }

    public SELF isEmpty() {
        if (actual.length > 0) {
            setDefaultDescription("It is expected to be empty, but it isn't. (actual: '{0}')",
                    Arrays.toString(actual));
            throw getException();
        }

        return self;
    }

    public SELF hasElement() {
        if (actual.length == 0) {
            setDefaultDescription("It is expected to have element, but it isn't. (actual: '[]')");
            throw getException();
        }

        return self;
    }

    public SELF doesNotContainNull() {
        for (Object element : actual) {
            if (element != null) continue;

            setDefaultDescription("It is expected not to contain null, but it isn't. (actual: '{0}')",
                    Arrays.toString(actual));
            throw getException();
        }

        return self;
    }

    public SELF hasLengthOf(int expected) {
        if (actual.length != expected) {
            setDefaultDescription("It is expected to be the same length, but it isn't. (expected: '{0}', actual: '{1}')",
                    expected, actual.length);
            throw getException();
        }

        return self;
    }

    public SELF isSameLength(Object[] expected) {
        if (expected == null || actual.length != expected.length) {
            setDefaultDescription("They are expected to be the same length, but they aren't. (expected: '{0}', actual: '{1}')",
                    expected == null ? "null" : expected.length, actual.length);
            throw getException();
        }

        return self;
    }

    public SELF isNotSameLength(Object[] expected) {
        if (expected == null || actual.length == expected.length) {
            setDefaultDescription("They are expected to be not the same length, but they are. (expected: '{0}', actual: '{1}')",
                    expected == null ? "null" : expected.length, actual.length);
            throw getException();
        }

        return self;
    }

    public SELF contains(Object expected) {
        for (Object element : actual) {
            if (Objects.deepEquals(element, expected)) return self;
        }

        setDefaultDescription("It is expected to contain the given element, but it doesn't. (expected: '{0}', actual: '{1}')",
                ArrayUtils.toString(expected), Arrays.toString(actual));
        throw getException();
    }

    /**
     * Verifies this contains the given elements at least 1.
     * 
     * This is faster about 10% than the below code.
     *
     * 

     *     if (expected.length == 0) return self;
     *     if (actual.length == 0 && expected.length == 0) return self;
     *
     *     if (!IntStream.range(0, Math.min(actual.length, expected.length))
     *             .anyMatch(i -> Objects.deepEquals(actual[i], expected[i]))) {
     *         throw getException();
     *     }
     *
     *     return self;
     * 
     *
     * @param first  expected first value
     * @param others expected other values
     * @return self
     */
    public SELF containsAny(Object first, Object... others) {
        Object[] expected = ArrayUtils.prepend(others, first);

        for (Object item : expected) {
            for (Object element : actual) {
                if (Objects.deepEquals(element, item)) return self;
            }
        }

        setDefaultDescription("It is expected to contain the given elements, but it doesn't. (expected: '{0}', actual: '{1}')",
                Arrays.toString(expected), Arrays.toString(actual));
        throw getException();
    }

    public SELF containsAll(Object[] expected) {
        if (ArrayUtils.isNullOrEmpty(expected)) return self;

        for (Object element : expected) {
            contains(element);
        }

        return self;
    }

    ///////////////////////////////////////////////////////////////////////////////////////

    public NumberAssert asLength() {
        return Asserts.that(actual.length);
    }

}