Evaluate.hs

{-# LANGUAGE NamedFieldPuns #-}

module Dojang.Types.FileRouteMap.Evaluate
  ( evaluateRoutes
  , evaluateRoutesWithFileTypes
  ) where

import Data.Map.Strict (Map, fromList, mapWithKey, toList, (!?))
import System.OsPath (OsPath)

import Dojang.MonadFileSystem (FileType (..))
import Dojang.Types.Environment (Environment)
import Dojang.Types.EnvironmentPredicate.Evaluate (EvaluationWarning)
import Dojang.Types.FilePathExpression (FilePathExpression)
import Dojang.Types.FileRoute (FileRoute (..), dispatch)
import Dojang.Types.FileRouteMap (FileRouteMap)


-- | Evaluates the 'FileRouteMap' against an 'Environment'.
evaluateRoutes
  :: FileRouteMap
  -- ^ The 'FileRouteMap' to evaluate.
  -> Environment
  -- ^ The 'Environment' to evaluate against.
  -> (Map OsPath FilePathExpression, [EvaluationWarning])
  -- ^ The evaluated routes and the warnings that occurred during evaluation.
  -- Unmatched routes or null routes will not be included in the result.
evaluateRoutes fileRoutes env =
  (evaluated, warnings)
 where
  results :: [(OsPath, FilePathExpression, [EvaluationWarning])]
  results =
    [ (filePath, match, warnings')
    | (filePath, route) <- toList fileRoutes
    , let (matches, warnings') = dispatch env route
    , Just match : _ <- [matches]
    ]
  warnings :: [EvaluationWarning]
  warnings = concatMap (\(_, _, w) -> w) results
  evaluated :: Map OsPath FilePathExpression
  evaluated = fromList [(filePath, match) | (filePath, match, _) <- results]


-- | Similar to 'evaluateRoutes', but also includes the 'FileType' of each
-- evaluated route.
evaluateRoutesWithFileTypes
  :: FileRouteMap
  -- ^ The 'FileRouteMap' to evaluate.
  -> Environment
  -- ^ The 'Environment' to evaluate against.
  -> (Map OsPath (FilePathExpression, FileType), [EvaluationWarning])
  -- ^ The evaluated routes and the warnings that occurred during evaluation.
  -- Unmatched routes or null routes will not be included in the result.
evaluateRoutesWithFileTypes fileRoutes env =
  (evaluatedRoutesWithFileTypes, warnings)
 where
  evaluatedRoutes :: Map OsPath FilePathExpression
  warnings :: [EvaluationWarning]
  (evaluatedRoutes, warnings) = evaluateRoutes fileRoutes env
  evaluatedRoutesWithFileTypes :: Map OsPath (FilePathExpression, FileType)
  evaluatedRoutesWithFileTypes = mapWithKey addFileType evaluatedRoutes
  addFileType :: OsPath -> FilePathExpression -> (FilePathExpression, FileType)
  addFileType path expr =
    ( expr
    , maybe File (\FileRoute{fileType} -> fileType) (fileRoutes !? path)
    )