fuzzyfind 2.1.0 → 2.2.0

raw patch · 4 files changed

+59/−25 lines, 4 filesdep +QuickCheckdep +hspecPVP ok

version bump matches the API change (PVP)

Dependencies added: QuickCheck, hspec

API changes (from Hackage documentation)

Files

• fuzzyfind.cabal +14/−1
• src/Text/FuzzyFind.hs +27/−24
• tests/FuzzyFindSpec.hs +16/−0
• tests/Spec.hs +2/−0

@@ -1,6 +1,6 @@ cabal-version:       2.2 name:                fuzzyfind-version:             2.1.0+version:             2.2.0 license:             MIT license-file:        LICENSE author:        Rúnar Bjarnason@@ -41,3 +41,16 @@     criterion ==1.5.*,     deepseq ==1.4.*,     fuzzyfind++test-suite spec+  type: exitcode-stdio-1.0+  default-language: Haskell2010+  hs-source-dirs: tests+  ghc-options: -Wall+  main-is: Spec.hs+  other-modules: FuzzyFindSpec+  build-depends: base == 4.*+               , hspec == 2.7.*+               , containers == 0.6.*+               , QuickCheck == 2.*+               , fuzzyfind

@@ -36,6 +36,10 @@ import Data.Foldable (maximumBy, toList, foldl') import Data.Function (on) import Data.Maybe (fromMaybe)+import GHC.Generics (Generic)+import Data.Text (Text)+import qualified Data.Text as Text+import Control.Monad.ST (runST) import Data.Sequence   ( Seq (..),     ViewL (..),@@ -45,11 +49,8 @@     (<|)   ) import qualified Data.Sequence as Seq-import GHC.Generics (Generic)-import Data.Text (Text)-import qualified Data.Text as Text-import Control.Monad.ST (runST) + -- | @bestMatch query string@ will return 'Nothing' if @query@ is not a -- subsequence of @string@. Otherwise, it will return the "best" way to line up -- the characters in @query@ with the characters in @string@. Lower-case@@ -182,19 +183,21 @@ defaultConsecutiveBonus :: Int defaultConsecutiveBonus = 11 +segmentToString :: ResultSegment -> String+segmentToString (Gap   xs) = xs+segmentToString (Match xs) = xs+ -- | Renders an 'Alignment' as a pair of lines with "*" on the lower line -- indicating the location of pattern matches.--- highlight' :: Alignment -> Text--- highlight' (Alignment s (Result segments)) =---   foldMap prettySegment segments <> "\n" <> foldMap showGaps segments---  where---   prettySegment (Gap   xs) = xs---   prettySegment (Match xs) = xs---   showGaps (Gap   xs) = Text.pack $ replicate (Text.length xs) ' '---   showGaps (Match xs) = Text.pack $ replicate (Text.length xs) '*'+highlight :: Alignment -> String+highlight (Alignment s (Result segments)) =+  foldMap segmentToString segments <> "\n" <> foldMap showGaps segments+ where+  showGaps (Gap   xs) = replicate (length xs) ' '+  showGaps (Match xs) = replicate (length xs) '*' --- highlight :: Alignment -> String--- highlight = Text.unpack . highlight'+highlight' :: Alignment -> Text+highlight' = Text.pack . highlight  -- | A highly configurable version of 'bestMatch'. bestMatch'@@ -211,7 +214,7 @@   -> String -- ^ The input string.   -> Maybe Alignment bestMatch' matchScore mismatchScore gapPenalty boundaryBonus camelCaseBonus firstCharBonusMultiplier consecutiveBonus query str-  = Alignment (totalScore m nx) . Result <$> traceback+  = Alignment (totalScore m nx) . (Result . Seq.fromList) <$> traceback  where   totalScore i j =     if i > m then 0 else (A.index' hs (i :. j)) + (A.index' bonuses (i :. j))@@ -223,23 +226,23 @@   --   ]   similarity a b =     if a == b || a == toLower b then matchScore else mismatchScore-  traceback :: Maybe (Seq ResultSegment)-  traceback = (<> gaps (drop nx str)) <$> go [] [] (-1) m nx-  go r m currOp 0 j = (gaps (take j str) <>) <$> case m of+  traceback :: Maybe [ResultSegment]+  traceback = go [Gap $ drop nx str] [] (-1) m nx+  go r m currOp 0 j = (Gap (take j str) :) <$> case m of     [] -> Just r     _  -> case currOp of-      1  -> Just (r :|> Match (reverse m))-      0  -> Just (r :|> Gap (reverse m))+      1  -> Just (Match m : r)+      0  -> Just (Gap m : r)       -1 -> Nothing   go _ _ _ _ 0 = Nothing   go r m currOp i j =     if similarity (A.index' query' (i - 1)) (A.index' str' (j - 1)) > 0       then case currOp of         0 ->-          go (r :|> Gap (reverse m)) [A.index' str' (j - 1)] 1 (i - 1) (j - 1)+          go (Gap m : r) [A.index' str' (j - 1)] 1 (i - 1) (j - 1)         _ -> go r (A.index' str' (j - 1) : m) 1 (i - 1) (j - 1)       else case currOp of-        1 -> go (r :|> Match (reverse m)) [A.index' str' (j - 1)] 0 i (j - 1)+        1 -> go (Match m : r) [A.index' str' (j - 1)] 0 i (j - 1)         _ -> go r (A.index' str' (j - 1) : m) 0 i (j - 1)   nx = localMax m n 1 0 0   localMax m n j r s = if j > n@@ -311,8 +314,8 @@       in         if similar && (afterMatch || beforeMatch) then consecutiveBonus else 0 -gaps :: String -> Seq ResultSegment-gaps s = [Gap s]+-- gaps :: String -> Seq ResultSegment+-- gaps s = [Gap s]  data ResultSegment = Gap !String | Match !String   deriving (Eq, Ord, Show, Generic)

@@ -0,0 +1,16 @@+module FuzzyFindSpec (spec) where++import Test.Hspec+import Test.Hspec.QuickCheck+import Text.FuzzyFind+import Data.Sequence()++spec :: Spec+spec = do+  describe "FuzzyFind" $ do+    modifyMaxSuccess (const 1000)+      $ prop "Alignment contains original"+      $ \q d -> case bestMatch q d of+          Nothing                       -> True+          Just (Alignment _ (Result r)) -> foldMap segmentToString r == d+

@@ -0,0 +1,2 @@+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}+