Be consistent in names for importing bloom filter modules

We were using a mix of import qualified as BF, and import as Bloom.

Author: dcoutts

src/Database/LSMTree/Internal/BloomFilter.hs

@@ -5,8 +5,8 @@
 
 module Database.LSMTree.Internal.BloomFilter (
   -- * Types
-  BF.Bloom,
-  BF.MBloom,
+  Bloom.Bloom,
+  Bloom.MBloom,
 
   -- * Bulk query
   bloomQueries,
@@ -36,7 +36,6 @@ import           Control.Monad.ST (ST, runST)
 import           System.FS.API
 
 import           Data.BloomFilter.Blocked (Bloom)
-import qualified Data.BloomFilter.Blocked as BF
 import qualified Data.BloomFilter.Blocked as Bloom
 import           Database.LSMTree.Internal.ByteString (byteArrayToByteString)
 import           Database.LSMTree.Internal.CRC32C (FileCorruptedError (..),
@@ -167,19 +166,19 @@ bloomQueries !filters !keys =
 -- | By writing out the version in host endianness, we also indicate endianness.
 -- During deserialisation, we would discover an endianness mismatch.
 --
--- We base our version number on the 'BF.formatVersion' from the @bloomfilter@
+-- We base our version number on the 'Bloom.formatVersion' from the @bloomfilter@
 -- library, plus our own version here. This accounts both for changes in the
 -- format code here, and changes in the library.
 --
 bloomFilterVersion :: Word32
-bloomFilterVersion = 1 + fromIntegral BF.formatVersion
+bloomFilterVersion = 1 + fromIntegral Bloom.formatVersion
 
-bloomFilterToLBS :: BF.Bloom a -> LBS.ByteString
+bloomFilterToLBS :: Bloom a -> LBS.ByteString
 bloomFilterToLBS bf =
-    let (size, ba, off, len) = BF.serialise bf
+    let (size, ba, off, len) = Bloom.serialise bf
      in header size <> byteArrayToLBS ba off len
   where
-    header BF.BloomSize { sizeBits, sizeHashes } =
+    header Bloom.BloomSize { sizeBits, sizeHashes } =
         -- creates a single 16 byte chunk
         B.toLazyByteStringWith (B.safeStrategy 16 B.smallChunkSize) mempty $
              B.word32Host bloomFilterVersion
@@ -196,14 +195,14 @@ bloomFilterToLBS bf =
 {-# SPECIALISE bloomFilterFromFile ::
      HasFS IO h
   -> Handle h
-  -> IO (BF.Bloom a) #-}
--- | Read a 'BF.Bloom' from a file.
+  -> IO (Bloom a) #-}
+-- | Read a 'Bloom' from a file.
 --
 bloomFilterFromFile ::
      (PrimMonad m, MonadCatch m)
   => HasFS m h
   -> Handle h  -- ^ The open file, in read mode
-  -> m (BF.Bloom a)
+  -> m (Bloom a)
 bloomFilterFromFile hfs h = do
     header <- rethrowEOFError "Doesn't contain a header" $
               hGetByteArrayExactly hfs h 16
@@ -225,10 +224,10 @@ bloomFilterFromFile hfs h = do
 
     -- read the filter data from the file directly into the bloom filter
     bloom <-
-      BF.deserialise
-        BF.BloomSize {
-          BF.sizeBits   = fromIntegral nbits,
-          BF.sizeHashes = fromIntegral nhashes
+      Bloom.deserialise
+        Bloom.BloomSize {
+          Bloom.sizeBits   = fromIntegral nbits,
+          Bloom.sizeHashes = fromIntegral nhashes
         }
         (\buf off len ->
             rethrowEOFError "bloom filter file too short" $

test/Test/Database/LSMTree/Internal/BloomFilter.hs

@@ -23,7 +23,7 @@ import           Test.QuickCheck.Instances ()
 import           Test.Tasty (TestTree, testGroup)
 import           Test.Tasty.QuickCheck hiding ((.&.))
 
-import qualified Data.BloomFilter.Blocked as BF
+import qualified Data.BloomFilter.Blocked as Bloom
 import           Database.LSMTree.Internal.BloomFilter
 import           Database.LSMTree.Internal.Serialise (SerialisedKey,
                      serialiseKey)
@@ -50,9 +50,9 @@ roundtrip_prop (Positive (Small hfN)) (Positive bits) ws =
       Left  err -> counterexample (displayException err) $ property False
       Right rhs -> lhs === rhs
   where
-    sz  = BF.BloomSize { sizeBits   = limitBits bits,
+    sz  = Bloom.BloomSize { sizeBits   = limitBits bits,
                          sizeHashes = hfN }
-    lhs = BF.create sz (\b -> mapM_ (BF.insert b) ws)
+    lhs = Bloom.create sz (\b -> mapM_ (Bloom.insert b) ws)
     bs  = LBS.toStrict (bloomFilterToLBS lhs)
 
 limitBits :: Int -> Int
@@ -67,7 +67,7 @@ prop_total_deserialisation bs =
 
 -- | Write the bytestring to a file in the mock file system and then use
 -- 'bloomFilterFromFile'.
-bloomFilterFromBS :: BS.ByteString -> Either IOSim.Failure (BF.Bloom a)
+bloomFilterFromBS :: BS.ByteString -> Either IOSim.Failure (Bloom a)
 bloomFilterFromBS bs =
     IOSim.runSim $ do
       hfs <- FSSim.simHasFS' MockFS.empty
@@ -115,8 +115,9 @@ prop_bloomQueries1 :: FPR
                    -> [Small Word64]
                    -> Property
 prop_bloomQueries1 (FPR fpr) filters keys =
-    let filters' :: [BF.Bloom SerialisedKey]
-        filters' = map (BF.fromList (BF.policyForFPR fpr) . map (\(Small k) -> serialiseKey k))
+    let filters' :: [Bloom SerialisedKey]
+        filters' = map (Bloom.fromList (Bloom.policyForFPR fpr)
+                        . map (\(Small k) -> serialiseKey k))
                        filters
 
         keys' :: [SerialisedKey]
@@ -127,12 +128,12 @@ prop_bloomQueries1 (FPR fpr) filters keys =
           [ (f_i, k_i)
           | (f, f_i) <- zip filters' [0..]
           , (k, k_i) <- zip keys' [0..]
-          , BF.elem k f
+          , Bloom.elem k f
           ]
 
         filterSets = map (Set.fromList . map (\(Small k) -> serialiseKey k)) filters
         referenceCmp =
-          [ (BF.elem k f, k `Set.member` f')
+          [ (Bloom.elem k f, k `Set.member` f')
           | (f, f') <- zip filters' filterSets
           , k       <- keys'
           ]