module Issue ( Issue (..), Provenance (..), fromComment, id, getIssues, ) where import Control.Arrow qualified as W import Control.Exception (handle) import Data.Binary (Binary) import Data.List (find) import Data.Maybe (catMaybes) import Data.Text (Text) import Data.Text qualified as T import Exception qualified as E import GHC.Generics (Generic) import Issue.Provenance (Provenance (..), commitFromHEAD) import Issue.Tag (Tag (..)) import Issue.Tag qualified as I import Issue.Text qualified as I import TreeGrepper.Comment (Comment (..)) import TreeGrepper.Comment qualified as G import TreeGrepper.Match qualified as G import Prelude hiding (id) data Issue = Issue { title :: Text, description :: Maybe Text, file :: String, -- TODO Make provenance obligatory -- -- I cannot think of instances where an issue exists without a provenance.. -- -- @difficulty easy provenance :: Maybe Provenance, start :: G.Position, end :: G.Position, tags :: [Tag], internalTags :: [Tag] } deriving (Show, Binary, Generic, Eq) id :: Issue -> Maybe String id issue = (\(Tag _ v) -> T.unpack <$> v) =<< find (\(Tag k _) -> k == "id") (issue.tags ++ issue.internalTags) -- TODO Refactor non-issues -- -- This does not return an issue, as provenance is not computed over its -- history. Maybe this should return a different type, or be internal to -- `History`? Also, `internalTags` suffer. fromComment :: FilePath -> Comment -> IO (Maybe Issue) fromComment cwd comment = do commit <- commitFromHEAD cwd let provenance = Provenance commit commit pure ( if any (\marker -> T.isPrefixOf marker title') issueMarkers then Just Issue { title = title, description = description, file = comment.file, provenance = Just provenance, start = comment.start, end = comment.end, tags = maybe [] I.extractTags description, internalTags = I.internalTags title (Just provenance) markers } else Nothing ) where (title', description) = I.extractText comment.file_type comment.text (markers, title) = stripIssueMarkers title' issueMarkers :: [Text] issueMarkers = [ "TODO", "FIXME", "QUESTION" ] stripIssueMarkers :: Text -> ([Text], Text) stripIssueMarkers text = case [marker | marker <- issueMarkers, T.isPrefixOf marker text] of (marker : _) -> W.first (marker :) . stripIssueMarkers $ T.stripStart (T.drop (T.length marker) text) [] -> ([], text) -- | Get all issues in the given directory and file. getIssues :: FilePath -> FilePath -> IO [Issue] getIssues cwd filename = handle (\(_ :: E.UnknownFileExtension) -> pure []) $ fmap catMaybes . mapM (fromComment cwd) =<< G.getComments cwd filename