LexerTokenTest.java

/*
 * The MIT License
 *
 * Copyright 2012-2024 Zafar Khaja <zafarkhaja@gmail.com>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.github.zafarkhaja.semver.expr;

import com.github.zafarkhaja.semver.expr.Lexer.Token;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import static com.github.zafarkhaja.semver.expr.Lexer.Token.Type.*;
import static org.junit.jupiter.api.Assertions.*;

/**
 *
 * @author Zafar Khaja {@literal <zafarkhaja@gmail.com>}
 */
class LexerTokenTest {

    @Nested
    class EqualsMethod {

        @Test
        void shouldBeReflexive() {
            Token token = new Token(NUMERIC, "1", 0);
            assertTrue(token.equals(token));
        }

        @Test
        void shouldBeSymmetric() {
            Token t1 = new Token(EQUAL, "=", 0);
            Token t2 = new Token(EQUAL, "=", 0);
            assertTrue(t1.equals(t2));
            assertTrue(t2.equals(t1));
        }

        @Test
        void shouldBeTransitive() {
            Token t1 = new Token(GREATER, ">", 0);
            Token t2 = new Token(GREATER, ">", 0);
            Token t3 = new Token(GREATER, ">", 0);
            assertTrue(t1.equals(t2));
            assertTrue(t2.equals(t3));
            assertTrue(t1.equals(t3));
        }

        @Test
        void shouldBeConsistent() {
            Token t1 = new Token(HYPHEN, "-", 0);
            Token t2 = new Token(HYPHEN, "-", 0);
            assertTrue(t1.equals(t2));
            assertTrue(t1.equals(t2));
            assertTrue(t1.equals(t2));
        }

        @Test
        void shouldReturnFalseIfOtherVersionIsOfDifferentType() {
            Token t1 = new Token(DOT, ".", 0);
            assertFalse(t1.equals(new String(".")));
        }

        @Test
        void shouldReturnFalseIfOtherVersionIsNull() {
            Token t1 = new Token(AND, "&", 0);
            Token t2 = null;
            assertFalse(t1.equals(t2));
        }

        @Test
        void shouldReturnFalseIfTypesAreDifferent() {
            Token t1 = new Token(EQUAL, "=", 0);
            Token t2 = new Token(NOT_EQUAL, "!=", 0);
            assertFalse(t1.equals(t2));
        }

        @Test
        void shouldReturnFalseIfLexemesAreDifferent() {
            Token t1 = new Token(NUMERIC, "1", 0);
            Token t2 = new Token(NUMERIC, "2", 0);
            assertFalse(t1.equals(t2));
        }

        @Test
        void shouldReturnFalseIfPositionsAreDifferent() {
            Token t1 = new Token(NUMERIC, "1", 1);
            Token t2 = new Token(NUMERIC, "1", 2);
            assertFalse(t1.equals(t2));
        }
    }

    @Nested
    class HashCodeMethod {

        @Test
        void shouldReturnSameHashCodeIfTokensAreEqual() {
            Token t1 = new Token(NUMERIC, "1", 0);
            Token t2 = new Token(NUMERIC, "1", 0);
            assertTrue(t1.equals(t2));
            assertEquals(t1.hashCode(), t2.hashCode());
        }
    }
}