src/test/java/org/apache/commons/codec/language/MatchRatingApproachEncoderTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *      https://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 org.apache.commons.codec.language;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

import org.apache.commons.codec.AbstractStringEncoderTest;
import org.junit.jupiter.api.Test;

/**
 * Series of tests for the Match Rating Approach algorithm.
 *
 * General naming nomenclature for the test is of the form:
 * GeneralMetadataOnTheTestArea_ActualTestValues_ExpectedResult
 *
 * An unusual value is indicated by the term "corner case"
 */
class MatchRatingApproachEncoderTest extends AbstractStringEncoderTest<MatchRatingApproachEncoder> {

    @Override
    protected MatchRatingApproachEncoder createStringEncoder() {
        return new MatchRatingApproachEncoder();
    }

    @Test
    final void testAccentRemoval_AllLower_SuccessfullyRemoved() {
        assertEquals("aeiou", getStringEncoder().removeAccents("áéíóú"));
    }

    @Test
    final void testAccentRemoval_ComprehensiveAccentMix_AllSuccessfullyRemoved() {
        assertEquals("E,E,E,E,U,U,I,I,A,A,O,e,e,e,e,u,u,i,i,a,a,o,c", getStringEncoder().removeAccents("È,É,Ê,Ë,Û,Ù,Ï,Î,À,Â,Ô,è,é,ê,ë,û,ù,ï,î,à,â,ô,ç"));
    }

    @Test
    final void testAccentRemoval_GerSpanFrenMix_SuccessfullyRemoved() {
        assertEquals("aeoußAEOUnNa", getStringEncoder().removeAccents("äëöüßÄËÖÜñÑà"));
    }

    @Test
    final void testAccentRemoval_MixedWithUnusualChars_SuccessfullyRemovedAndUnusualCharactersInvariant() {
        assertEquals("A-e'i.,o&u", getStringEncoder().removeAccents("Á-e'í.,ó&ú"));
    }

    @Test
    final void testAccentRemoval_NINO_NoChange() {
        assertEquals("", getStringEncoder().removeAccents(""));
    }

    @Test
    final void testAccentRemoval_NullValue_ReturnNullSuccessfully() {
        assertNull(getStringEncoder().removeAccents(null));
    }

    @Test
    final void testAccentRemoval_UpperAndLower_SuccessfullyRemovedAndCaseInvariant() {
        assertEquals("AeiOuu", getStringEncoder().removeAccents("ÁeíÓuu"));
    }

    @Test
    final void testAccentRemoval_WithSpaces_SuccessfullyRemovedAndSpacesInvariant() {
        assertEquals("ae io  u", getStringEncoder().removeAccents("áé íó  ú"));
    }

    @Test
    final void testAccentRemovalNormalString_NoChange() {
        assertEquals("Colorless green ideas sleep furiously", getStringEncoder().removeAccents("Colorless green ideas sleep furiously"));
    }

    @Test
    final void testCleanNameSuccessfullyClean() {
        assertEquals("THISISATEST", getStringEncoder().cleanName("This-ís   a t.,es &t"));
    }

    @Test
    final void testCompare_BRIAN_BRYAN_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Brian", "Bryan"));
    }

    @Test
    final void testCompare_BURNS_BOURNE_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Burns", "Bourne"));
    }

    @Test
    final void testCompare_CATHERINE_KATHRYN_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Catherine", "Kathryn"));
    }

    @Test
    final void testCompare_COLM_COLIN_WithAccentsAndSymbolsAndSpaces_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Cólm.   ", "C-olín"));
    }

    @Test
    final void testCompare_Forenames_SEAN_JOHN_MatchExpected() {
        assertTrue(getStringEncoder().isEncodeEquals("Sean", "John"));
    }

    @Test
    final void testCompare_Forenames_SEAN_PETE_NoMatchExpected() {
        assertFalse(getStringEncoder().isEncodeEquals("Sean", "Pete"));
    }

    @Test
    final void testCompare_Forenames_UNA_OONAGH_ShouldSuccessfullyMatchButDoesNot() {
        assertFalse(getStringEncoder().isEncodeEquals("Úna", "Oonagh")); // Disappointing
    }

    @Test
    final void testCompare_FRANCISZEK_FRANCES_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Franciszek", "Frances"));
    }

    @Test
    final void testCompare_KARL_ALESSANDRO_DoesNotMatch() {
        assertFalse(getStringEncoder().isEncodeEquals("Karl", "Alessandro"));
    }

    @Test
    final void testCompare_LongSurnames_MORIARTY_OMUIRCHEARTAIGH_DoesNotSuccessfulMatch() {
        assertFalse(getStringEncoder().isEncodeEquals("Moriarty", "OMuircheartaigh"));
    }

    @Test
    final void testCompare_LongSurnames_OMUIRCHEARTAIGH_OMIREADHAIGH_SuccessfulMatch() {
        assertTrue(getStringEncoder().isEncodeEquals("o'muireadhaigh", "Ó 'Muircheartaigh "));
    }

    @Test
    final void testCompare_MCGOWAN_MCGEOGHEGAN_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("McGowan", "Mc Geoghegan"));
    }

    @Test
    final void testCompare_MICKY_MICHAEL_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Micky", "Michael"));
    }

    @Test
    final void testCompare_OONA_OONAGH_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Oona", "Oonagh"));
    }

    @Test
    final void testCompare_PETERSON_PETERS_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Peterson", "Peters"));
    }

    @Test
    final void testCompare_SAM_SAMUEL_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Sam", "Samuel"));
    }

    @Test
    final void testCompare_SEAN_SHAUN_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Séan", "Shaun"));
    }

    @Test
    final void testCompare_ShortNames_AL_ED_WorksButNoMatch() {
        assertFalse(getStringEncoder().isEncodeEquals("Al", "Ed"));
    }

    @Test
    final void testCompare_SmallInput_CARK_Kl_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Kl", "Karl"));
    }

    @Test
    final void testCompare_SMITH_SMYTH_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("smith", "smyth"));
    }

    @Test
    final void testCompare_SOPHIE_SOFIA_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Sophie", "Sofia"));
    }

    @Test
    final void testCompare_STEPHEN_STEFAN_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Stephen", "Stefan"));
    }

    @Test
    final void testCompare_STEPHEN_STEVEN_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Stephen", "Steven"));
    }

    @Test
    final void testCompare_STEVEN_STEFAN_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Steven", "Stefan"));
    }

    @Test
    final void testCompare_Surname_AUERBACH_UHRBACH_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Auerbach", "Uhrbach"));
    }

    @Test
    final void testCompare_Surname_COOPERFLYNN_SUPERLYN_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Cooper-Flynn", "Super-Lyn"));
    }

    @Test
    final void testCompare_Surname_HAILEY_HALLEY_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Hailey", "Halley"));
    }

    @Test
    final void testCompare_Surname_LEWINSKY_LEVINSKI_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("LEWINSKY", "LEVINSKI"));
    }

    @Test
    final void testCompare_Surname_LIPSHITZ_LIPPSZYC_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("LIPSHITZ", "LIPPSZYC"));
    }

    @Test
    final void testCompare_Surname_MOSKOWITZ_MOSKOVITZ_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Moskowitz", "Moskovitz"));
    }

    @Test
    final void testCompare_Surname_OSULLIVAN_OSUILLEABHAIN_SuccessfulMatch() {
        assertTrue(getStringEncoder().isEncodeEquals("O'Sullivan", "Ó ' Súilleabháin"));
    }

    @Test
    final void testCompare_Surname_PRZEMYSL_PSHEMESHIL_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals(" P rz e m y s l", " P sh e m e sh i l"));
    }

    @Test
    final void testCompare_Surname_ROSOCHOWACIEC_ROSOKHOVATSETS_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("R o s o ch o w a c ie c", " R o s o k ho v a ts e ts"));
    }

    @Test
    final void testCompare_Surname_SZLAMAWICZ_SHLAMOVITZ_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("SZLAMAWICZ", "SHLAMOVITZ"));
    }

    @Test
    final void testCompare_SurnameCornerCase_Nulls_NoMatch() {
        assertFalse(getStringEncoder().isEncodeEquals(null, null));
    }

    @Test
    final void testCompare_Surnames_MURPHY_LYNCH_NoMatchExpected() {
        assertFalse(getStringEncoder().isEncodeEquals("Murphy", "Lynch"));
    }

    @Test
    final void testCompare_SurnamesCornerCase_MURPHY_NoSpace_NoMatch() {
        assertFalse(getStringEncoder().isEncodeEquals("Murphy", ""));
    }

    @Test
    final void testCompare_SurnamesCornerCase_MURPHY_Space_NoMatch() {
        assertFalse(getStringEncoder().isEncodeEquals("Murphy", " "));
    }

    @Test
    final void testCompare_TOMASZ_TOM_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Tomasz", "tom"));
    }

    @Test
    final void testCompare_ZACH_ZAKARIA_SuccessfullyMatched() {
        assertTrue(getStringEncoder().isEncodeEquals("Zach", "Zacharia"));
    }

    @Test
    final void testCompareNameNullSpace_ReturnsFalseSuccessfully() {
        assertFalse(getStringEncoder().isEncodeEquals(null, " "));
    }

    @Test
    final void testCompareNameSameNames_ReturnsFalseSuccessfully() {
        assertTrue(getStringEncoder().isEncodeEquals("John", "John"));
    }

    @Test
    final void testCompareNameToSingleLetter_KARL_C_DoesNotMatch() {
        assertFalse(getStringEncoder().isEncodeEquals("Karl", "C"));
    }

    @Test
    final void testCompareWithWhitespace() {
        // sanity check
        assertTrue(getStringEncoder().isEncodeEquals("Brian", "Bryan"));
        // whitespace
        assertTrue(getStringEncoder().isEncodeEquals(" Brian", "Bryan"));
        assertTrue(getStringEncoder().isEncodeEquals("Brian ", "Bryan"));
        assertTrue(getStringEncoder().isEncodeEquals(" Brian ", "Bryan"));
        assertTrue(getStringEncoder().isEncodeEquals("Brian", " Bryan"));
        assertTrue(getStringEncoder().isEncodeEquals("Brian", "Bryan "));
        assertTrue(getStringEncoder().isEncodeEquals("Brian", " Bryan "));
    }

    @Test
    final void testGetEncoding_HARPER_HRPR() {
        assertEquals("HRPR", getStringEncoder().encode("HARPER"));
    }

    @Test
    final void testGetEncoding_NoSpace_to_Nothing() {
        assertEquals("", getStringEncoder().encode(""));
    }

    @Test
    final void testGetEncoding_Null_to_Nothing() {
        assertEquals("", getStringEncoder().encode(null));
    }

    @Test
    final void testGetEncoding_One_Letter_to_Nothing() {
        assertEquals("", getStringEncoder().encode("E"));
    }

    @Test
    final void testGetEncoding_SMITH_to_SMTH() {
        assertEquals("SMTH", getStringEncoder().encode("Smith"));
    }

    @Test
    final void testGetEncoding_SMYTH_to_SMYTH() {
        assertEquals("SMYTH", getStringEncoder().encode("Smyth"));
    }

    @Test
    final void testGetEncoding_Space_to_Nothing() {
        assertEquals("", getStringEncoder().encode(" "));
    }

    @Test
    final void testGetFirstLast3__ALEXANDER_Returns_Aleder() {
        assertEquals("Aleder", getStringEncoder().getFirst3Last3("Alexzander"));
    }

    @Test
    final void testGetFirstLast3_PETE_Returns_PETE() {
        assertEquals("PETE", getStringEncoder().getFirst3Last3("PETE"));
    }

    @Test
    final void testGetMinRating_1_Returns5_Successfully() {
        assertEquals(5, getStringEncoder().getMinRating(1));
    }

    @Test
    final void testgetMinRating_10_Returns3_Successfully() {
        assertEquals(3, getStringEncoder().getMinRating(10));
    }

    @Test
    final void testgetMinRating_11_Returns_3_Successfully() {
        assertEquals(3, getStringEncoder().getMinRating(11));
    }

    @Test
    final void testGetMinRating_13_Returns_1_Successfully() {
        assertEquals(1, getStringEncoder().getMinRating(13));
    }

    @Test
    final void testGetMinRating_2_Returns5_Successfully() {
        assertEquals(5, getStringEncoder().getMinRating(2));
    }

    @Test
    final void testgetMinRating_5_Returns4_Successfully() {
        assertEquals(4, getStringEncoder().getMinRating(5));
    }

    @Test
    final void testgetMinRating_5_Returns4_Successfully2() {
        assertEquals(4, getStringEncoder().getMinRating(5));
    }

    @Test
    final void testgetMinRating_6_Returns4_Successfully() {
        assertEquals(4, getStringEncoder().getMinRating(6));
    }

    @Test
    final void testGetMinRating_7_Return4_Successfully() {
        assertEquals(4, getStringEncoder().getMinRating(7));
    }

    // ***** Begin Region - Test Get Encoding - Surnames

    @Test
    final void testgetMinRating_7_Returns4_Successfully() {
        assertEquals(4, getStringEncoder().getMinRating(7));
    }

    @Test
    final void testgetMinRating_8_Returns3_Successfully() {
        assertEquals(3, getStringEncoder().getMinRating(8));
    }

    @Test
    final void testIsEncodeEquals_CornerCase_FirstNameJust1Letter_ReturnsFalse() {
        assertFalse(getStringEncoder().isEncodeEquals("t", "test"));
    }

    @Test
    final void testIsEncodeEquals_CornerCase_FirstNameJustSpace_ReturnsFalse() {
        assertFalse(getStringEncoder().isEncodeEquals(" ", "test"));
    }

    @Test
    final void testIsEncodeEquals_CornerCase_FirstNameNothing_ReturnsFalse() {
        assertFalse(getStringEncoder().isEncodeEquals("", "test"));
    }

    @Test
    final void testIsEncodeEquals_CornerCase_FirstNameNull_ReturnsFalse() {
        assertFalse(getStringEncoder().isEncodeEquals(null, "test"));
    }

    @Test
    final void testIsEncodeEquals_CornerCase_SecondNameJustSpace_ReturnsFalse() {
        assertFalse(getStringEncoder().isEncodeEquals("test", " "));
    }

    @Test
    final void testIsEncodeEquals_CornerCase_SecondNameNothing_ReturnsFalse() {
        assertFalse(getStringEncoder().isEncodeEquals("test", ""));
    }

    @Test
    final void testIsEncodeEquals_CornerCase_SecondNameNull_ReturnsFalse() {
        assertFalse(getStringEncoder().isEncodeEquals("test", null));
    }

    @Test
    final void testIsEncodeEqualsSecondNameJust1Letter_ReturnsFalse() {
        assertFalse(getStringEncoder().isEncodeEquals("test", "t"));
    }

    @Test
    final void testIsVowel_CapitalA_ReturnsTrue() {
        assertTrue(getStringEncoder().isVowel("A"));
    }

    @Test
    final void testIsVowel_SingleVowel_ReturnsTrue() {
        assertTrue(getStringEncoder().isVowel("I"));
    }

    @Test
    final void testIsVowel_SmallD_ReturnsFalse() {
        assertFalse(getStringEncoder().isVowel("d"));
    }

    @Test
    final void testLeftToRightThenRightToLeft_ALEXANDER_ALEXANDRA_Returns4() {
        assertEquals(4, getStringEncoder().leftToRightThenRightToLeftProcessing("ALEXANDER", "ALEXANDRA"));
    }

    @Test
    final void testLeftToRightThenRightToLeft_EINSTEIN_MICHAELA_Returns0() {
        assertEquals(0, getStringEncoder().leftToRightThenRightToLeftProcessing("EINSTEIN", "MICHAELA"));
    }

    @Test
    final void testPunctuationOnly() {
        assertEquals(getStringEncoder().encode(".,-"), "");
    }

    @Test
    final void testRemoveDoubleConsonants_MISSISSIPPI_RemovedSuccessfully() {
        assertEquals("MISISIPI", getStringEncoder().removeDoubleConsonants("MISSISSIPPI"));
    }

    @Test
    final void testRemoveDoubleDoubleVowel_BEETLE_NotRemoved() {
        assertEquals("BEETLE", getStringEncoder().removeDoubleConsonants("BEETLE"));
    }

    @Test
    final void testRemoveSingleDoubleConsonants_BUBLE_RemovedSuccessfully() {
        assertEquals("BUBLE", getStringEncoder().removeDoubleConsonants("BUBBLE"));
    }

    @Test
    final void testRemoveVowel__AIDAN_Returns_ADN() {
        assertEquals("ADN", getStringEncoder().removeVowels("AIDAN"));
    }

    @Test
    final void testRemoveVowel__DECLAN_Returns_DCLN() {
        assertEquals("DCLN", getStringEncoder().removeVowels("DECLAN"));
    }

    // ***** END REGION - TEST GET MRA COMPARISONS

    @Test
    final void testRemoveVowel_ALESSANDRA_Returns_ALSSNDR() {
        assertEquals("ALSSNDR", getStringEncoder().removeVowels("ALESSANDRA"));
    }

    @Test
    final void testVowelAndPunctuationOnly() {
        assertEquals(getStringEncoder().encode("uoiea.,-AEIOU"), "U");
    }

    @Test
    final void testVowelOnly() {
        assertEquals(getStringEncoder().encode("aeiouAEIOU"), "A");
    }
}