packages feed

fuzzyset-0.2.0: test/Spec.hs

{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE UnicodeSyntax #-}

import Control.Exception (evaluate)
import Control.Monad (zipWithM_)
import Data.AEq
import Data.Function ((&))
import Data.FuzzySet hiding (fromList)
import Data.FuzzySet.Internal
import Data.FuzzySet.Types
import Data.FuzzySet.Util
import Data.HashMap.Strict (HashMap, fromList)
import Data.List (sortOn, sortBy)
import Data.Maybe (fromJust)
import Data.Maybe (fromMaybe)
import Data.Ord (compare)
import Data.Text (Text, unpack)
import Data.Vector ((!), (!?))
import Helpers
import Test.Hspec
import qualified Data.FuzzySet as FuzzySet
import qualified Data.HashMap.Strict as HashMap
import qualified Data.Text as Text


compareLists :: [( Double, Text )] -> [( Double, Text )] -> Bool
compareLists xs ys =
    and (fmap f (zip xs ys))
  where
    f ( ( a1, b1 ), ( a2, b2 ) ) =
        (b1 == b2) && (a1 ~== a2)


lookup0 :: Text -> HashMap Text Int -> Int
lookup0 =
    HashMap.lookupDefault 0


checkGramsCount ∷ Text → Int → SpecWith ()
checkGramsCount input n = it message $ do
    length list `shouldBe` expectedLen
    shouldBeTrue $ all (==n) (Text.length <$> list)
  where
    list = grams input n
    message = "should return a list of length "
            <> show expectedLen
            <> ", given the input \""
            <> unpack input <> "\" and n = " <> show n
    expectedLen = s - n + 3
    s = Text.length input


checkMapKey ∷ HashMap Text Int → Text → Int → SpecWith ()
checkMapKey grams key value =
    it message (lookup0 key grams `shouldBe` value)
  where
    message = "should map they key \""
            <> unpack key <> "\" to "
            <> show value


vectorMagnitudeOfItem ∷ FuzzySet → Int → Int → Maybe Double
vectorMagnitudeOfItem set n p =
    vectorMagnitude <$> (fromJust (n `HashMap.lookup` items set) !? p)


checkMagnitude ∷ FuzzySet → Int → Int → Double → SpecWith ()
checkMagnitude set n p r =
    it message $ fromMaybe 0 (vectorMagnitudeOfItem set n p) `shouldBeCloseTo` r
  where
    message = "should return vectorMagnitude = " <> show r
            <> " for the " <> show n <> "-grams entry (index " <> show p <> ")"


checkMatchDictEntry ∷ FuzzySet → Text → [GramInfo] → SpecWith ()
checkMatchDictEntry set gram entry =
    it message (sortBy srt result `shouldBe` sortBy srt entry)
  where
    result = fromMaybe [] (gram `HashMap.lookup` matchDict set)
    message = "should return a match dict entry "
            <> show entry <> " for " <> show gram
    srt (GramInfo a1 b1) (GramInfo a2 b2) =
        compare ( a1, b1 ) ( a2, b2 )


checkExactSet ∷ FuzzySet → [(Text, Text)] → SpecWith ()
checkExactSet set xs =
    it ("should have exactSet = " <> show xs) $
      exactSet set `shouldBe` fromList xs


checkGrams ∷ Text → Int → [Text] → SpecWith ()
checkGrams txt size r =
    describe msg $ it ("should return " <> show r) (grams txt size `shouldBe` r)
  where
    msg = "grams " <> show txt <> " " <> show size


checkGramMap ∷ Text → Int → [(Text, Int)] → SpecWith ()
checkGramMap txt size r =
    describe msg $ it ("should return " <> show r)
                      (gramVector txt size `shouldBe` fromList r)
  where
    msg = "gramVector " <> show txt <> " " <> show size


checkGramMapKeys ∷ Text → Int → [(Text, Int)] → SpecWith ()
checkGramMapKeys txt size keys =
    describe msg $ mapM_ (uncurry $ checkMapKey grams) keys
  where
    msg = "gramVector " <> show txt <> " " <> show size
    grams = gramVector txt size


checkMatches ∷ FuzzySet → Text → Int → [(Text, Int)] → SpecWith ()
checkMatches set txt size r =
    describe msg $ it ("should return " <> show r) (sortOn fst res `shouldBe` sortOn fst r)
  where
    res = fmap f $ HashMap.toList $ matches set (gramVector txt size)
    f (a, b) =
          ( normalizedEntry ((fromJust (size `HashMap.lookup` items set)) ! a), b )
    msg = "matches "  <> show (exactSet set) <> " "
        <> "(gramVector " <> show txt <> " " <> show size <> ")"


checkGet ∷ FuzzySet → Text → [( Double, Text )] → SpecWith ()
checkGet set val rs =
    describe msg $ do
      it "should return a sorted list" (sorted $ fst <$> xs)
      it ("should return " <> show (length rs) <> " match(es)")
         (length rs `shouldBe` length xs)
      zipWithM_ ξ rs xs -- (sortOn snd rs) (sortOn snd xs)
  where
    xs = get set val
    ξ (a, b) (a', b') = do
      it ("should return a match for the string " <> show b) (b `shouldBe` b')
      it ("having a score close to " <> show a) (a `shouldBeCloseTo` a')
    msg = "get (" <> show (exactSet set) <> ") " <> show val


checkDistance ∷ Text → Text → Double → SpecWith ()
checkDistance s t d =
    describe msg $
      it ("should be approximately " <> show d)
         (distance s t `shouldBeCloseTo` d)
  where
    msg = "edit distance between " <> show s <> " and " <> show t


sorted ∷ Ord a ⇒ [a] → Bool
sorted [ ] = True
sorted [_] = True
sorted (x:xs) = x >= head xs && sorted xs


main :: IO ()
main =
    let
        detectives = defaultSet `add` "Bruce Wayne" `add` "Charlie Chan" `add` "Frank Columbo" `add` "Hercule Poirot" `add` "Jane Marple" `add` "Lisbeth Salander" `add` "Nancy Drew" `add` "Nero Wolfe" `add` "Perry Mason" `add` "Philip Marlowe" `add` "Sherlock Holmes"
        detectivesDict = matchDict detectives
        Just map1 = HashMap.lookup "olm" detectivesDict
        Just map2 = HashMap.lookup "-n" detectivesDict
        Just map3 = HashMap.lookup "y " detectivesDict
        Just map4 = HashMap.lookup "wa" detectivesDict
        Just map5 = HashMap.lookup "ne" detectivesDict
        Just map6 = HashMap.lookup "ch" detectivesDict
        Just map7 = HashMap.lookup "cha" detectivesDict

        scores1 =
            [ ( 0.17677669529663687, "Sherlock Holmes" )
            , ( 0.10660035817780521, "Nero Wolfe" )
            , ( 0.10206207261596574, "Bruce Wayne" )
            , ( 0.10206207261596574, "Jane Marple" )
            , ( 0.0944911182523068, "Frank Columbo" )
            , ( 0.09128709291752767, "Philip Marlowe" )
            ]

        scores2 =
            [ ( 0.2142857142857143, "Philip Marlowe" )
            , ( 0.19999999999999996, "Sherlock Holmes" )
            , ( 0.19999999999999996, "Nero Wolfe" )
            , ( 0.18181818181818177, "Bruce Wayne" )
            , ( 0.18181818181818177, "Jane Marple" )
            , ( 0.07692307692307687, "Frank Columbo" )
            ]

    in
    hspec $ do
        describe "Large set" $ do
            it "" $ do
                let
                    names = (FuzzySet.fromList . take 132 . repeat) "John Smith"
                 in
                 length (getWithMinScore 0.72 (names `add` "Joseph Dombrowski") "Joe Dombrowski") `shouldBe` 1

            it "" $ do
                let
                    names = (FuzzySet.fromList . take 133 . repeat) "John Smith"
                 in
                 length (getWithMinScore 0.72 (names `add` "Joseph Dombrowski") "Joe Dombrowski") `shouldBe` 1

        describe "getMatches (Detectives test data)" $ do
            it "with Levenshtein" $ do
                shouldBeTrue (scores2 `compareLists` getMatches detectives "Gumshoe" 0 2)

            it "without Levenshtein" $ do
                let
                    detectives' = detectives{ useLevenshtein = False }
                 in
                 shouldBeTrue (scores1 `compareLists` getMatches detectives' "Gumshoe" 0 2)

        describe "matches" $ do
            it "Watson" $ do
                HashMap.fromList [(0,1),(1,1),(8,3)] `shouldBe` matches detectives (gramVector "Watson" 2)
                HashMap.fromList [(8,2)] `shouldBe` matches detectives (gramVector "Watson" 3)

            it "Gumshoe" $ do
                HashMap.fromList [(0,1),(2,1),(4,1),(7,1),(9,1),(10,2)] `shouldBe` matches detectives (gramVector "Gumshoe" 2)

        describe "matchDict" $ do
            it "lookup \"olm\"" $ do
                GramInfo 10 1 `shouldBeIn` map1

            it "lookup \"-n\"" $ do
                GramInfo 6 1 `shouldBeIn` map2
                GramInfo 7 1 `shouldBeIn` map2

            it "lookup \"y \"" $ do
                GramInfo 6 1 `shouldBeIn`  map3
                GramInfo 8 1 `shouldBeIn`  map3

            it "lookup \"wa\"" $ do
                GramInfo 0 1 `shouldBeIn` map4

            it "lookup \"ne\"" $ do
                GramInfo 0 1 `shouldBeIn` map5
                GramInfo 4 1 `shouldBeIn` map5
                GramInfo 7 1 `shouldBeIn` map5

            it "lookup \"ch\"" $ do
                GramInfo 1 2 `shouldBeIn` map6

            it "lookup \"cha\"" $ do
                GramInfo 1 2 `shouldBeIn` map7

        describe "norm" $ do
            it "[2, 4, 3, 3, 3, 3, 2, 3, 2, 2, 2] should equal 9" $
                9 `shouldBeCloseTo` norm [2, 4, 3, 3, 3, 3, 2, 3, 2, 2, 2]

        describe "enclosedIn" $ do
            it "\"covfefe\" 'o' should return ocovfefeo" $
                "ocovfefeo" `shouldBe` ("covfefe" `enclosedIn` 'o')

        describe "grams" $ do
          mapM_ (checkGramsCount "charade") [2..6]
          it "should throw an error if n < 2" $
            evaluate (grams "anything" 1) `shouldThrow` anyException

        checkGrams "charade" 2 ["-c", "ch", "ha", "ar", "ra", "ad", "de", "e-"]
        checkGrams "charade" 2 ["-c", "ch", "ha", "ar", "ra", "ad", "de", "e-"]
        checkGrams "charade" 3 ["-ch", "cha", "har", "ara", "rad", "ade", "de-"]
        checkGrams "aFl1pP!.,nG FL0^ppy+" 2
            [ "-a", "af", "fl", "l1", "1p", "pp", "p,", ",n", "ng", "g ", " f"
            , "fl", "l0", "0p", "pp", "py", "y-" ]

        checkGramMap "xxx" 2 [("-x", 1),("xx", 2),("x-", 1)]
        checkGramMap "xxx" 3 [("-xx", 1), ("xx-", 1), ("xxx", 1)]
        checkGramMap "xxxxxxx" 4 [("-xxx", 1), ("xxxx", 4), ("xxx-", 1)]
        checkGramMap "bananasananas" 2
            [ ("-b", 1), ("ba", 1), ("an", 4), ("na", 4), ("as", 2)
            , ("sa", 1), ("s-", 1) ]
        checkGramMap "bananasananas" 3
            [ ("-ba", 1), ("ban", 1), ("ana", 4), ("nan", 2), ("nas", 2)
            , ("asa", 1), ("san", 1), ("as-", 1) ]

        checkGramMapKeys "trentsauntsrestaurant" 2
          [ ("nt", 3)
          , ("au", 2)
          , ("ts", 2)
          , ("re", 2)
          , ("st", 1)
          , ("en", 1) ]
        checkGramMapKeys "trentsauntsrestaurant" 3
          [ ("res", 1)
          , ("nts", 2) ]
        checkGramMapKeys "trentsantwantstorentpants" 3
          [ ("pan", 1)
          , ("twa", 1)
          , ("ant", 3)
          , ("ren", 2)
          , ("ent", 2)
          , ("nts", 3) ]
        checkGramMapKeys "trentsantwantstorentpantstostartrestaurant" 3
          [ ("ant", 4)
          , ("nts", 3)
          , ("sto", 2)
          , ("sta", 2)
          , ("ren", 2)
          , ("tre", 2) ]
        checkGramMapKeys "trentsantwantstorentpantstostartrestaurant" 2
          [ ("an", 4)
          , ("st", 4)
          , ("re", 3)
          , ("ts", 3)
          , ("en", 2)
          , ("to", 2)
          , ("tr", 2)
          , ("or", 1)
          , ("au", 1)
          , ("ur", 1) ]
        checkGramMapKeys "antsintrentspantswanttrentsauntsrestaurant" 3
          [ ("nts", 5)
          , ("ant", 4)
          , ("ent", 2) ]
        checkGramMapKeys "asmartantintrentspantswantstorenttrentsauntsrestaurant" 3
          [ ("nts", 5)
          , ("ant", 4)
          , ("ent", 3) ]
        checkGramMapKeys "buffalo buffalo buffalo buffalo buffalo buffalo" 7
          [ ("buffalo", 6) ]

        describe "addToSet defaultSet \"aFl1pP!.,nG FL0^ppy+\"" $
          let (set, changed) = addToSet defaultSet "aFl1pP!.,nG FL0^ppy+"
           in do
            it "should return changed status True" $ shouldBeTrue changed
            checkExactSet set [("afl1pp!.,ng fl0^ppy+", "aFl1pP!.,nG FL0^ppy+")]
            checkMagnitude set 2 0 4.58257569495584
            checkMagnitude set 3 0 4.0
            checkMatchDictEntry set "-a" [GramInfo 0 1]
            checkMatchDictEntry set "ng" [GramInfo 0 1]
            checkMatchDictEntry set "fl" [GramInfo 0 2]
            checkMatchDictEntry set "pp" [GramInfo 0 2]
            checkMatchDictEntry set "g " [GramInfo 0 1]
            checkMatchDictEntry set "xx" []

        describe "addToSet defaultSet \"Trent\"" $
          let (set, changed) = addToSet defaultSet "Trent"
           in do
            it "should return changed status True" $ shouldBeTrue changed
            checkExactSet set [("trent", "Trent")]
            checkMagnitude set 2 0 2.449489742783178
            checkMagnitude set 3 0 2.23606797749979
            checkMatchDictEntry set "en" [GramInfo 0 1]

        describe "defaultSet `add` \"Trent\" `add` \"tent\"" $
          let set = defaultSet `add` "Trent" `add` "tent"
           in do
            checkExactSet set [("trent", "Trent"), ("tent", "tent")]
            checkMagnitude set 2 0 2.449489742783178
            checkMagnitude set 2 1 2.23606797749979
            checkMagnitude set 3 0 2.23606797749979
            checkMagnitude set 3 1 2.0
            checkMatchDictEntry set "en"  [GramInfo 0 1, GramInfo 1 1]
            checkMatchDictEntry set "ent" [GramInfo 0 1, GramInfo 1 1]
            checkMatchDictEntry set "ten" [GramInfo 1 1]
            checkMatchDictEntry set "-t"  [GramInfo 0 1, GramInfo 1 1]

        describe "defaultSet `add` \"Trent\" `add` \"tent\" `add` \"restaurant\"" $
          let set = defaultSet `add` "Trent" `add` "tent" `add` "restaurant"
           in do
            checkExactSet set
              [ ("trent"      , "Trent")
              , ("tent"       , "tent")
              , ("restaurant" , "restaurant") ]
            checkMagnitude set 2 0 2.449489742783178
            checkMagnitude set 2 1 2.23606797749979
            checkMagnitude set 2 2 3.3166247903554
            checkMagnitude set 3 0 2.23606797749979
            checkMagnitude set 3 1 2.0
            checkMagnitude set 3 2 3.1622776601683795
            checkMatchDictEntry set "tau" [GramInfo 2 1]
            checkMatchDictEntry set "en"  [GramInfo 0 1, GramInfo 1 1]
            checkMatchDictEntry set "ten" [GramInfo 1 1]
            checkMatchDictEntry set "ran" [GramInfo 2 1]
            checkMatchDictEntry set "an"  [GramInfo 2 1]
            checkMatchDictEntry set "ant" [GramInfo 2 1]
            checkMatchDictEntry set "nt-" [GramInfo 0 1, GramInfo 1 1, GramInfo 2 1]
            checkMatchDictEntry set "st"  [GramInfo 2 1]
            checkMatchDictEntry set "es"  [GramInfo 2 1]
            checkMatchDictEntry set "est" [GramInfo 2 1]
            checkMatchDictEntry set "re"  [GramInfo 0 1, GramInfo 2 1]
            checkMatchDictEntry set "-tr" [GramInfo 0 1]
            checkMatchDictEntry set "res" [GramInfo 2 1]
            checkMatchDictEntry set "tr"  [GramInfo 0 1]
            checkMatchDictEntry set "-t"  [GramInfo 0 1, GramInfo 1 1]
            checkMatchDictEntry set "aur" [GramInfo 2 1]
            checkMatchDictEntry set "ent" [GramInfo 0 1, GramInfo 1 1]
            checkMatchDictEntry set "ra"  [GramInfo 2 1]
            checkMatchDictEntry set "-r"  [GramInfo 2 1]
            checkMatchDictEntry set "ren" [GramInfo 0 1]
            checkMatchDictEntry set "te"  [GramInfo 1 1]
            checkMatchDictEntry set "nt"  [GramInfo 0 1, GramInfo 1 1, GramInfo 2 1]

        describe "defaultSet `add` \"Trent\" `add` \"tent\" `add` \"restaurant\" `add` \"xRftAntnt,!tnRant\"" $
          let set = defaultSet `add` "Trent" `add` "tent" `add` "restaurant" `add` "xRftAntnt,!tnRant"
           in do
            checkExactSet set
              [ ("trent"             , "Trent")
              , ("tent"              , "tent")
              , ("restaurant"        , "restaurant")
              , ("xrftantnt,!tnrant" , "xRftAntnt,!tnRant") ]
            checkMagnitude set 2 0 2.449489742783178
            checkMagnitude set 2 1 2.23606797749979
            checkMagnitude set 2 2 3.3166247903554
            checkMagnitude set 2 3 5.196152422706632
            checkMagnitude set 3 0 2.23606797749979
            checkMagnitude set 3 1 2.0
            checkMagnitude set 3 2 3.1622776601683795
            checkMagnitude set 3 3 4.242640687119285
            checkMatchDictEntry set "tau" [GramInfo 2 1]
            checkMatchDictEntry set "en"  [GramInfo 0 1, GramInfo 1 1]
            checkMatchDictEntry set "ten" [GramInfo 1 1]
            checkMatchDictEntry set "ran" [GramInfo 2 1, GramInfo 3 1]
            checkMatchDictEntry set "ntn" [GramInfo 3 1]
            checkMatchDictEntry set "-xr" [GramInfo 3 1]
            checkMatchDictEntry set "an"  [GramInfo 2 1, GramInfo 3 2]
            checkMatchDictEntry set "ant" [GramInfo 2 1, GramInfo 3 2]
            checkMatchDictEntry set "t,t" [GramInfo 3 1]
            checkMatchDictEntry set "nt-" [GramInfo 0 1, GramInfo 1 1, GramInfo 2 1, GramInfo 3 1]
            checkMatchDictEntry set "nt," [GramInfo 3 1]
            checkMatchDictEntry set "xr"  [GramInfo 3 1]
            checkMatchDictEntry set "tan" [GramInfo 3 1]
            checkMatchDictEntry set "st"  [GramInfo 2 1]
            checkMatchDictEntry set "es"  [GramInfo 2 1]
            checkMatchDictEntry set "fta" [GramInfo 3 1]
            checkMatchDictEntry set "est" [GramInfo 2 1]
            checkMatchDictEntry set "re"  [GramInfo 0 1, GramInfo 2 1]
            checkMatchDictEntry set "-tr" [GramInfo 0 1]
            checkMatchDictEntry set "res" [GramInfo 2 1]
            checkMatchDictEntry set "xrf" [GramInfo 3 1]
            checkMatchDictEntry set "tr"  [GramInfo 0 1]
            checkMatchDictEntry set ",t"  [GramInfo 3 1]
            checkMatchDictEntry set "tn"  [GramInfo 3 2]
            checkMatchDictEntry set "-t"  [GramInfo 0 1, GramInfo 1 1]
            checkMatchDictEntry set "rf"  [GramInfo 3 1]
            checkMatchDictEntry set "aur" [GramInfo 2 1]
            checkMatchDictEntry set "ent" [GramInfo 0 1, GramInfo 1 1]
            checkMatchDictEntry set "ra"  [GramInfo 2 1, GramInfo 3 1]
            checkMatchDictEntry set "-r"  [GramInfo 2 1]
            checkMatchDictEntry set "-r"  [GramInfo 2 1]
            checkMatchDictEntry set "ren" [GramInfo 0 1]
            checkMatchDictEntry set "nr"  [GramInfo 3 1]
            checkMatchDictEntry set "te"  [GramInfo 1 1]
            checkMatchDictEntry set "nt"  [GramInfo 0 1, GramInfo 1 1, GramInfo 2 1, GramInfo 3 3]
            checkMatchDictEntry set "-x"  [GramInfo 3 1]
            checkMatchDictEntry set "ta"  [GramInfo 2 1, GramInfo 3 1]
            checkMatchDictEntry set "ft"  [GramInfo 3 1]
            checkMatchDictEntry set "nra" [GramInfo 3 1]
            checkMatchDictEntry set ",tn" [GramInfo 3 1]
            checkMatchDictEntry set "-re" [GramInfo 2 1]
            checkMatchDictEntry set "ura" [GramInfo 2 1]
            checkMatchDictEntry set "tnt" [GramInfo 3 1]
            checkMatchDictEntry set "sta" [GramInfo 2 1]
            checkMatchDictEntry set "tnr" [GramInfo 3 1]
            checkMatchDictEntry set "rft" [GramInfo 3 1]
            checkMatchDictEntry set "tre" [GramInfo 0 1]
            checkMatchDictEntry set "ur"  [GramInfo 2 1]
            checkMatchDictEntry set "t,"  [GramInfo 3 1]
            checkMatchDictEntry set "t-"  [GramInfo 0 1, GramInfo 1 1, GramInfo 2 1, GramInfo 3 1]
            checkMatchDictEntry set "au"  [GramInfo 2 1]
            checkMatchDictEntry set "-te" [GramInfo 1 1]

        describe "FuzzySet 3 4 True mempty mempty mempty `add` ..." $
          let set = FuzzySet mempty mempty mempty 3 4 True
                                `add` "Trent"
                                `add` "pants"
                                `add` "restaurant"
                                `add` "XrF,!TNrATaNTNTNT"
           in do
            checkExactSet set
              [ ("trent"             , "Trent")
              , ("pants"             , "pants")
              , ("restaurant"        , "restaurant")
              , ("xrf,!tnratantntnt" , "XrF,!TNrATaNTNTNT") ]
            checkMagnitude set 3 0 2.23606797749979
            checkMagnitude set 3 1 2.23606797749979
            checkMagnitude set 3 2 3.1622776601683795
            checkMagnitude set 3 3 4.47213595499958
            checkMagnitude set 4 0 2.0
            checkMagnitude set 4 1 2.0
            checkMagnitude set 4 2 3.0
            checkMagnitude set 4 3 4.123105625617661
            checkMatchDictEntry set "ntnt" [GramInfo 3 2]
            checkMatchDictEntry set "tau"  [GramInfo 2 1]
            checkMatchDictEntry set "xrf"  [GramInfo 3 1]
            checkMatchDictEntry set "esta" [GramInfo 2 1]
            checkMatchDictEntry set "-pa"  [GramInfo 1 1]
            checkMatchDictEntry set "ran"  [GramInfo 2 1]
            checkMatchDictEntry set "ntn"  [GramInfo 3 2]
            checkMatchDictEntry set "-xr"  [GramInfo 3 1]
            checkMatchDictEntry set "ants" [GramInfo 1 1]
            checkMatchDictEntry set "-xrf" [GramInfo 3 1]
            checkMatchDictEntry set "ant"  [GramInfo 1 1, GramInfo 2 1, GramInfo 3 1]
            checkMatchDictEntry set "rant" [GramInfo 2 1]
            checkMatchDictEntry set "rat"  [GramInfo 3 1]
            checkMatchDictEntry set "antn" [GramInfo 3 1]
            checkMatchDictEntry set "nt-"  [GramInfo 0 1, GramInfo 2 1, GramInfo 3 1]
            checkMatchDictEntry set "rent" [GramInfo 0 1]
            checkMatchDictEntry set "rata" [GramInfo 3 1]
            checkMatchDictEntry set "tan"  [GramInfo 3 1]
            checkMatchDictEntry set "tant" [GramInfo 3 1]
            checkMatchDictEntry set "-tre" [GramInfo 0 1]
            checkMatchDictEntry set "est"  [GramInfo 2 1]
            checkMatchDictEntry set "-tr"  [GramInfo 0 1]

        describe "FuzzySet 2 5 True mempty mempty mempty `add` ..." $
          let set = FuzzySet mempty mempty mempty 2 5 True
                                `add` "Trent"
                                `add` "restaurant"
                                `add` "aunt"
                                `add` "Smarty Pants"
                                `add` "XrF,!TNrATaNTNTNT"
           in do
            checkExactSet set
              [ ("trent"             , "Trent")
              , ("restaurant"        , "restaurant")
              , ("aunt"              , "aunt")
              , ("smarty pants"      , "Smarty Pants")
              , ("xrf,!tnratantntnt" , "XrF,!TNrATaNTNTNT") ]
            checkMagnitude set 2 0 2.449489742783178
            checkMagnitude set 2 1 3.3166247903554
            checkMagnitude set 2 2 2.23606797749979
            checkMagnitude set 2 3 3.605551275463989
            checkMagnitude set 2 4 5.385164807134504
            checkMagnitude set 3 0 2.23606797749979
            checkMagnitude set 3 1 3.1622776601683795
            checkMagnitude set 3 2 2.0
            checkMagnitude set 3 3 3.4641016151377544
            checkMagnitude set 3 4 4.47213595499958
            checkMagnitude set 4 0 2.0
            checkMagnitude set 4 1 3.0
            checkMagnitude set 4 2 1.7320508075688772
            checkMagnitude set 4 3 3.3166247903554
            checkMagnitude set 4 4 4.123105625617661
            checkMagnitude set 5 0 1.7320508075688772
            checkMagnitude set 5 1 2.8284271247461903
            checkMagnitude set 5 2 1.4142135623730951
            checkMagnitude set 5 3 3.1622776601683795
            checkMagnitude set 5 4 3.7416573867739413
            checkMatchDictEntry set "pant"  [GramInfo 3 1]
            checkMatchDictEntry set "y "    [GramInfo 3 1]
            checkMatchDictEntry set "-xr"   [GramInfo 4 1]
            checkMatchDictEntry set "rest"  [GramInfo 1 1]
            checkMatchDictEntry set " p"    [GramInfo 3 1]
            checkMatchDictEntry set "ty p"  [GramInfo 3 1]
            checkMatchDictEntry set "rty"   [GramInfo 3 1]
            checkMatchDictEntry set "-tre"  [GramInfo 0 1]
            checkMatchDictEntry set "-a"    [GramInfo 2 1]
            checkMatchDictEntry set "ty"    [GramInfo 3 1]
            checkMatchDictEntry set "tntnt" [GramInfo 4 1]
            checkMatchDictEntry set "tr"    [GramInfo 0 1]
            checkMatchDictEntry set "ts"    [GramInfo 3 1]
            checkMatchDictEntry set "aun"   [GramInfo 2 1]
            checkMatchDictEntry set "tn"    [GramInfo 4 3]
            checkMatchDictEntry set "-t"    [GramInfo 0 1]
            checkMatchDictEntry set "aur"   [GramInfo 1 1]
            checkMatchDictEntry set "-s"    [GramInfo 3 1]
            checkMatchDictEntry set "-r"    [GramInfo 1 1]
            checkMatchDictEntry set "rty"   [GramInfo 3 1]
            checkMatchDictEntry set "tnra"  [GramInfo 4 1]
            checkMatchDictEntry set "nt"    [GramInfo 0 1, GramInfo 1 1, GramInfo 2 1, GramInfo 3 1, GramInfo 4 3]

        describe "values (defaultSet `add` ...)" $ do
          let set = defaultSet `add` "Trent" `add` "restaurant"
                               `add` "aunt"  `add` "Smarty Pants"
                               `add` "XrF,!TNrATaNTNTNT"
          it "should contain the added elements" $ do
            values set `shouldContain` ["Trent"]
            values set `shouldContain` ["restaurant"]
            values set `shouldContain` ["aunt"]
            values set `shouldContain` ["Smarty Pants"]
            values set `shouldContain` ["XrF,!TNrATaNTNTNT"]

        describe "size (defaultSet `add` ...)" $ do
          let set = defaultSet `add` "Trent" `add` "restaurant"
                               `add` "aunt"  `add` "Smarty Pants"
                               `add` "XrF,!TNrATaNTNTNT"
          it "should be 5" $ size set `shouldBe` 5

        describe "isEmpty (defaultSet `add` ...)" $ do
          let set = defaultSet `add` "Trent" `add` "restaurant"
                               `add` "aunt"  `add` "Smarty Pants"
                               `add` "XrF,!TNrATaNTNTNT"
          it "should be False" $ isEmpty set `shouldBe` False

        describe "isEmpty defaultSet" $ do
          let set = defaultSet
          it "should be True" $ isEmpty set `shouldBe` True

        describe "snd $ (defaultSet `add` \"again\") `addToSet` \"again\"" $ do
          let set = (defaultSet `add` "again") `add` "again"
          it "should return False" $
            snd ((defaultSet `add` "again") `addToSet` "again") `shouldBe` False

        describe "get (defaultSet `add` \"xxx\")" $ do
          let set = defaultSet `add` "xxx"
          it "should return [(1, \"xxx\")]" $
            get set "xxx" `shouldBe` [(1, "xxx")]

        checkMatches testset_1 "ant"   3 [("trent", 1), ("restaurant", 2), ("aunt", 1), ("smarty pants", 1)]
        checkMatches testset_1 "pant"  3 [("trent", 1), ("restaurant", 2), ("aunt", 1), ("smarty pants", 2)]
        checkMatches testset_1 "pants" 3 [("restaurant", 1), ("smarty pants", 4)]
        checkMatches testset_1 "tre"   3 [("trent", 2)]
        checkMatches testset_1 "xxx"   3 []
        checkMatches testset_1 "xxx"   2 []
        checkMatches testset_1 "tsap"  3 []
        checkMatches testset_1 "tsap"  2 [("trent", 1), ("smarty pants", 1)]
        checkMatches testset_2 "hat"   3 [("cat", 1)]
        checkMatches testset_2 "anthropology" 3 [("restaurant", 1), ("smarty pants", 1)]
        checkMatches testset_2 "spot"  3 []
        checkMatches testset_2 "spot"  2 [("trent", 1), ("restaurant", 1), ("aunt", 1), ("smarty pants", 1), ("cat", 1)]
        checkMatches testset_2 "axiom" 3 []
        checkMatches testset_2 "axiom" 2 [("aunt", 1)]
        checkMatches testset_3 "moped" 2 [("polymorphic", 1)]
        checkMatches (defaultSet `add` "bananas") "ananas" 3 [("bananas", 7)]
        checkMatches (defaultSet `add` "banana")  "ananas" 3 [("banana", 5)]
        checkMatches testset_6  "ia" 3 [("california", 1), ("district of columbia", 1), ("georgia", 1), ("pennsylvania", 1), ("virginia", 1), ("west virginia", 1)]
        checkMatches testset_6  "was" 3 [("arkansas", 1), ("kansas", 1), ("texas", 1), ("washington", 2)]
        checkMatches testset_6  "ton" 3 [("oregon", 1), ("washington", 2)]
        checkMatches testset_6  "ing" 3 [("indiana", 1), ("washington", 1), ("wyoming", 2)]
        checkMatches testset_6  "land" 3 [("maryland", 3), ("northern marianas islands", 2), ("rhode island", 3), ("virgin islands", 2)]
        checkMatches testset_6  "sas" 3 [("arkansas", 2), ("kansas", 2), ("texas", 1)]
        checkMatches testset_6  "sin" 3 [("wisconsin", 2)]
        checkMatches testset_6  "new" 3 [("nebraska", 1), ("nevada", 1), ("new hampshire", 2), ("new jersey", 2), ("new mexico", 2), ("new york", 2)]

      -- Tests where useLevenshtein == False
        checkGet testset_4 "flask"    [(0.3651483716701107, "Alaska")]
        checkGet testset_4 "lambda"   [(0.40089186286863654, "Alabama")]
        checkGet testset_4 "lambada"  [(0.49999999999999999, "Alabama")]
        checkGet testset_4 "alabama"  [(1, "Alabama")]
        checkGet testset_4 "al"       [(0.4364357804719848, "Alaska"), (0.40824829046386296, "Alabama")]
        checkGet testset_4 "albama"   [(0.6172133998483676, "Alabama")]
        checkGet testset_4 "Alabaska" [ (0.7216878364870323, "Alaska")
                                      , (0.5345224838248487, "Alabama") ]
        checkGet testset_5 "homeland"     [(0.37499999999999994, "Maryland")]
        checkGet testset_5 "connectedcut" [(0.6963106238227914, "Connecticut")]
        checkGet testset_5 "oregano"      [(0.4629100498862757, "Oregon")]
        checkGet testset_5 "akeloxasas"   [(0.4622501635210243, "Arkansas"), (0.45291081365783836, "Texas"), (0.4193139346887673, "Kansas")]
        checkGet testset_5 "alaskansas"   [ (0.6454972243679029, "Kansas")
                                          , (0.6454972243679029, "Alaska")
                                          , (0.5590169943749475, "Arkansas") ]
        checkGet testset_5 "South"        [ (0.5163977794943222, "South Dakota" )
                                          , (0.47809144373375745, "South Carolina") ]
        checkGet testset_5 "penicillivania" [ (0.46291004988627577, "Pennsylvania") ]
        checkGet testset_5 "Michisota"    [ (0.4714045207910316, "Michigan")
                                          , (0.4444444444444444, "Minnesota") ]
        checkGet testset_5 "New Mix"      [ (0.47809144373375745, "New Mexico")
                                          , (0.40089186286863654, "New York")
                                          , (0.35856858280031806, "New Jersey") ]
        checkGet testset_5 "Waioming"     [ (0.5345224838248487, "Wyoming")]
        checkGet testset_5 "Landland"     [ (0.5103103630798287, "Maryland")
                                          , (0.41666666666666674, "Rhode Island") ]

        checkDistance "hello" "yello" 0.8
        checkDistance "fellow" "yello" 0.6666666666666667
        checkDistance "fellow" "yellow" 0.8333333333333334
        checkDistance "propeller" "yellow" 0.33333333333333337
        checkDistance "propeller" "teller" 0.5555555555555556
        checkDistance "balloon" "spoon" 0.4285714285714286
        checkDistance "balloon" "electron" 0.25
        checkDistance "spectrum" "electron" 0.5
        checkDistance "spectrum" "techno" 0.25
        checkDistance "technology" "techno" 0.6
        checkDistance "technology" "logic" 0.19999999999999996
        checkDistance "toxic" "logic" 0.6
        checkDistance "sawa" "sawa" 1
        checkDistance "fez" "baz" 0.33333333333333337
        -- Just a sanity check
        describe "edit distance between \"fez\" and \"baz\"" $
          it ("should not be close to 0.123")
             (distance "fez" "baz" `shouldNotBeCloseTo` 0.123)

        -- Tests where useLevenshtein == True
        checkGet testset_6 "wyome" [ (0.5714285714285714, "Wyoming") ]
        checkGet testset_6 "Louisianaland" [ ( 0.6923076923076923, "Louisiana" )
                                           , ( 0.3846153846153846, "Maryland" )
                                           , ( 0.3846153846153846, "Rhode Island" )
                                           , ( 0.36, "Northern Marianas Islands" ) ]
        checkGet testset_6 "ia" [ (0.5, "Iowa"), (0.4, "Idaho") ]
        checkGet testset_6 "flaska" [ (0.8333333333333334, "Alaska")
                                    , (0.5, "Nebraska")
                                    , (0.4285714285714286, "Florida") ]
        checkGet testset_7 "Alaskansas" [ (0.7, "Arkansas")
                                        , (0.6, "Kansas")
                                        , (0.6, "Alaska")
                                        , (0.5, "Alabama") ]
        checkGet testset_7 "Transylvania" [ (0.75, "Pennsylvania")
                                          , (0.33333333333333337, "California") ]




testset_1 ∷ FuzzySet
testset_1 = defaultSet `add` "Trent" `add` "restaurant"
                       `add` "aunt"  `add` "Smarty Pants"
testset_2 ∷ FuzzySet
testset_2 = testset_1 `add` "cat"

testset_3 ∷ FuzzySet
testset_3 = testset_2 `add` "polymorphic"

testset_4 ∷ FuzzySet
testset_4 = FuzzySet mempty mempty mempty 2 3 False
  `add` "Alaska" `add` "Alabama" `add` "Guam"

testset_5 ∷ FuzzySet
testset_5 = addMany (FuzzySet mempty mempty mempty 2 3 False) states

testset_6 ∷ FuzzySet
testset_6 = addMany defaultSet states

testset_7 ∷ FuzzySet
testset_7 = addMany (FuzzySet mempty mempty mempty 2 4 True) states

states ∷ [Text]
states =
  [ "Alabama"
  , "Alaska"
  , "American Samoa"
  , "Arizona"
  , "Arkansas"
  , "California"
  , "Colorado"
  , "Connecticut"
  , "Delaware"
  , "District of Columbia"
  , "Florida"
  , "Georgia"
  , "Guam"
  , "Hawaii"
  , "Idaho"
  , "Illinois"
  , "Indiana"
  , "Iowa"
  , "Kansas"
  , "Kentucky"
  , "Louisiana"
  , "Maine"
  , "Maryland"
  , "Massachusetts"
  , "Michigan"
  , "Minnesota"
  , "Mississippi"
  , "Missouri"
  , "Montana"
  , "Nebraska"
  , "Nevada"
  , "New Hampshire"
  , "New Jersey"
  , "New Mexico"
  , "New York"
  , "North Carolina"
  , "North Dakota"
  , "Northern Marianas Islands"
  , "Ohio"
  , "Oklahoma"
  , "Oregon"
  , "Pennsylvania"
  , "Puerto Rico"
  , "Rhode Island"
  , "South Carolina"
  , "South Dakota"
  , "Tennessee"
  , "Texas"
  , "Utah"
  , "Vermont"
  , "Virginia"
  , "Virgin Islands"
  , "Washington"
  , "West Virginia"
  , "Wisconsin"
  , "Wyoming" ]