Renamed isAffectedBy, listAffectedBy

Author: mmhat

code/hsec-tools/app/Main.hs

@@ -21,7 +21,7 @@ import Options.Applicative
 import Security.Advisories
 import qualified Security.Advisories.Convert.OSV as OSV
 import Security.Advisories.Git
-import Security.Advisories.Queries (listAffectedBy, parseVersionRange)
+import Security.Advisories.Queries (listVersionRangeAffectedBy, parseVersionRange)
 import Security.Advisories.Generate.HTML
 
 import qualified Command.Reserve
@@ -119,7 +119,7 @@ commandQuery =
                   T.hPutStrLn stderr $ "Cannot parse '--version-spec': " <> e
                   exitFailure
                 Right versionRange' -> do
-                  affectedAdvisories <- listAffectedBy (fromMaybe "." advisoriesPath) packageName versionRange'
+                  affectedAdvisories <- listVersionRangeAffectedBy (fromMaybe "." advisoriesPath) packageName versionRange'
                   case affectedAdvisories of
                     [] -> putStrLn "Not affected"
                     _ -> do

code/hsec-tools/src/Security/Advisories/Queries.hs

@@ -2,9 +2,9 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 module Security.Advisories.Queries
-  ( isAffectedBy
+  ( listVersionRangeAffectedBy
+  , isVersionRangeAffectedBy
   , parseVersionRange
-  , listAffectedBy
   )
 where
 
@@ -25,8 +25,8 @@ import Security.Advisories.Definition
 import Security.Advisories.Filesystem
 
 -- | Check whether a package and a version range is concerned by an advisory
-isAffectedBy :: Text -> VersionRange -> Advisory -> Bool
-isAffectedBy queryPackageName queryVersionRange =
+isVersionRangeAffectedBy :: Text -> VersionRange -> Advisory -> Bool
+isVersionRangeAffectedBy queryPackageName queryVersionRange =
     any checkAffected . advisoryAffected
     where
         checkAffected :: Affected -> Bool
@@ -47,20 +47,18 @@ isAffectedBy queryPackageName queryVersionRange =
             | [] <- asVersionIntervals range = False
             | otherwise = True
 
--- | Parse 'VersionRange' as given to the CLI
-parseVersionRange :: Maybe Text -> Either Text VersionRange
-parseVersionRange  = maybe (return anyVersion) (first T.pack . eitherParsec . T.unpack)
-
 -- | List the advisories matching package/version range
-listAffectedBy :: FilePath -> Text -> VersionRange -> IO [Advisory]
-listAffectedBy root queryPackageName queryVersionRange = do
-  advisories <-
+listVersionRangeAffectedBy :: FilePath -> Text -> VersionRange -> IO [Advisory]
+listVersionRangeAffectedBy root queryPackageName queryVersionRange =
     listAdvisories root >>= \case
       Failure errors -> do
         T.hPutStrLn stderr "Cannot parse some advisories"
         forM_ errors $
           hPrint stderr
         exitFailure
       Success advisories ->
-        return advisories
-  return $ filter (isAffectedBy queryPackageName queryVersionRange) advisories
+        return $ filter (isVersionRangeAffectedBy queryPackageName queryVersionRange) advisories
+
+-- | Parse 'VersionRange' as given to the CLI
+parseVersionRange :: Maybe Text -> Either Text VersionRange
+parseVersionRange  = maybe (return anyVersion) (first T.pack . eitherParsec . T.unpack)

code/hsec-tools/test/Spec/QueriesSpec.hs

@@ -32,7 +32,7 @@ spec =
          in testCase (title actual query) $
               let query' = versionRange query
                   affectedVersion' = versionRange actual
-              in isAffectedBy packageName query' (mkAdvisory affectedVersion')
+              in isVersionRangeAffectedBy packageName query' (mkAdvisory affectedVersion')
                     @?= expected
   ]