mirror of
https://github.com/joshuaclayton/unused.git
synced 2024-09-11 04:45:28 +03:00
Use regex in ag for simple words
Why? ==== ag supports using regular expressions for searches; however, the -Q flag, which was previously always used, resulted in literal search results. By searching literal matches, it would potentially return too many results. For example, with a `me` method in a controller, it'd match words like `awesome` or `method`. This introduces a check where, if the token being searched is only composed of word characters (`[A-Za-z0-9_]`), it'll switch over to use regular expressions with ag and surround the token with non-word matches on either end. The goal here is to reduce false-positives in matches.
This commit is contained in:
parent
3851c98d59
commit
97f083fc2c
@ -3,6 +3,7 @@ module Unused.TermSearch
|
|||||||
) where
|
) where
|
||||||
|
|
||||||
import System.Process
|
import System.Process
|
||||||
|
import Unused.TermSearch.Internal (commandLineOptions)
|
||||||
|
|
||||||
search :: String -> IO [String]
|
search :: String -> IO [String]
|
||||||
search t = do
|
search t = do
|
||||||
@ -19,5 +20,5 @@ linesMap f =
|
|||||||
|
|
||||||
ag :: String -> IO String
|
ag :: String -> IO String
|
||||||
ag t = do
|
ag t = do
|
||||||
(_, results, _) <- readProcessWithExitCode "ag" [t, ".", "-c", "-Q", "--ackmate"] ""
|
(_, results, _) <- readProcessWithExitCode "ag" (commandLineOptions t) ""
|
||||||
return results
|
return results
|
||||||
|
15
src/Unused/TermSearch/Internal.hs
Normal file
15
src/Unused/TermSearch/Internal.hs
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
module Unused.TermSearch.Internal
|
||||||
|
( commandLineOptions
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Unused.Regex
|
||||||
|
|
||||||
|
commandLineOptions :: String -> [String]
|
||||||
|
commandLineOptions t =
|
||||||
|
case regexSafeTerm t of
|
||||||
|
True -> ["\\W" ++ t ++ "\\W", ".", "-c", "--ackmate"]
|
||||||
|
False -> [t, ".", "-c", "-Q", "--ackmate"]
|
||||||
|
|
||||||
|
regexSafeTerm :: String -> Bool
|
||||||
|
regexSafeTerm =
|
||||||
|
matchRegex "^[[:word:]]+$"
|
22
test/Unused/TermSearch/InternalSpec.hs
Normal file
22
test/Unused/TermSearch/InternalSpec.hs
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
module Unused.TermSearch.InternalSpec
|
||||||
|
( main
|
||||||
|
, spec
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Test.Hspec
|
||||||
|
import Unused.TermSearch.Internal
|
||||||
|
|
||||||
|
main :: IO ()
|
||||||
|
main = hspec spec
|
||||||
|
|
||||||
|
spec :: Spec
|
||||||
|
spec = parallel $
|
||||||
|
describe "commandLineOptions" $ do
|
||||||
|
it "does not use regular expressions when the term contains non-word characters" $ do
|
||||||
|
commandLineOptions "can_do_things?" `shouldBe` ["can_do_things?", ".", "-c", "-Q", "--ackmate"]
|
||||||
|
commandLineOptions "no_way!" `shouldBe` ["no_way!", ".", "-c", "-Q", "--ackmate"]
|
||||||
|
commandLineOptions "[]=" `shouldBe` ["[]=", ".", "-c", "-Q", "--ackmate"]
|
||||||
|
commandLineOptions "window.globalOverride" `shouldBe` ["window.globalOverride", ".", "-c", "-Q", "--ackmate"]
|
||||||
|
|
||||||
|
it "uses regular expression match with surrounding non-word matches for accuracy" $
|
||||||
|
commandLineOptions "awesome_method" `shouldBe` ["\\Wawesome_method\\W", ".", "-c", "--ackmate"]
|
@ -16,6 +16,7 @@ cabal-version: >=1.10
|
|||||||
library
|
library
|
||||||
hs-source-dirs: src
|
hs-source-dirs: src
|
||||||
exposed-modules: Unused.TermSearch
|
exposed-modules: Unused.TermSearch
|
||||||
|
, Unused.TermSearch.Internal
|
||||||
, Unused.Parser
|
, Unused.Parser
|
||||||
, Unused.Parser.Internal
|
, Unused.Parser.Internal
|
||||||
, Unused.Types
|
, Unused.Types
|
||||||
@ -71,6 +72,7 @@ test-suite unused-test
|
|||||||
, Unused.TypesSpec
|
, Unused.TypesSpec
|
||||||
, Unused.LikelihoodCalculatorSpec
|
, Unused.LikelihoodCalculatorSpec
|
||||||
, Unused.Grouping.InternalSpec
|
, Unused.Grouping.InternalSpec
|
||||||
|
, Unused.TermSearch.InternalSpec
|
||||||
ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall -Werror
|
ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall -Werror
|
||||||
default-language: Haskell2010
|
default-language: Haskell2010
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user