Safe Haskell	None
Language	Haskell2010

Dojang.Types.Context

Synopsis

data CandidateRoute = CandidateRoute {
- route :: RouteResult
- specificity :: Int
- sourceFilePath :: OsPath
- sourceExists :: Bool
}
data MonadFileSystem m => Context (m :: Type -> Type) = Context {
- repository :: Repository
- environment :: Environment
- environmentVariableGetter :: EnvironmentVariable -> m (Maybe OsString)
}
data FileCorrespondence = FileCorrespondence {
- source :: FileEntry
- sourceDelta :: FileDeltaKind
- intermediate :: FileEntry
- destination :: FileEntry
- destinationDelta :: FileDeltaKind
}
data FileDeltaKind
- = Unchanged
- | Added
- | Removed
- | Modified
data FileEntry = FileEntry {
- path :: OsPath
- stat :: FileStat
}
data FileStat
- = Missing
- | Directory
- | File Integer
- | Symlink OsPath
data IgnoredFile = IgnoredFile {
- routeName :: OsPath
- sourcePath :: OsPath
- destinationPath :: OsPath
- pattern :: FilePattern
}
data RouteMatch
- = NoMatch
- | SingleMatch RouteResult
- | AmbiguousMatch (NonEmpty CandidateRoute)
data RouteState
- = Routed OsPath
- | Ignored OsPath FilePattern
- | NotRouted
data UnregisteredFile = UnregisteredFile {
- filePath :: OsPath
- candidateRoutes :: [RouteResult]
}
calculateSpecificity :: OsPath -> RouteResult -> Int
filterBySpecificity :: OsPath -> [RouteResult] -> [RouteResult]
findCandidateRoutesFor :: MonadFileSystem m => Context m -> OsPath -> m [RouteResult]
findMatchingRoutes :: MonadFileSystem m => Context m -> OsPath -> m (RouteMatch, [RouteMapWarning])
getIgnoredFiles :: (HasCallStack, MonadFileSystem m) => Context m -> m [IgnoredFile]
getRouteState :: (HasCallStack, MonadFileSystem m, MonadIO m) => Context m -> OsPath -> m (RouteState, [RouteMapWarning])
getUnregisteredFiles :: (HasCallStack, MonadFileSystem m) => Context m -> m [UnregisteredFile]
listFiles :: MonadFileSystem m => OsPath -> [FilePattern] -> m [FileEntry]
makeCorrespond :: (HasCallStack, MonadFileSystem m) => Context m -> m ([FileCorrespondence], [RouteMapWarning])
makeCorrespondBetweenThreeDirs :: (HasCallStack, MonadFileSystem m) => OsPath -> OsPath -> OsPath -> [FilePattern] -> m [FileCorrespondence]
makeCorrespondBetweenThreeFiles :: (HasCallStack, MonadFileSystem m) => OsPath -> OsPath -> OsPath -> m FileCorrespondence
makeCorrespondBetweenTwoDirs :: (HasCallStack, MonadFileSystem m) => OsPath -> OsPath -> [FilePattern] -> m (Map OsPath (FileEntry, FileEntry))
makeCorrespondWithDestination :: MonadFileSystem m => Context m -> OsPath -> m (Maybe FileCorrespondence, [RouteMapWarning])
routePaths :: MonadFileSystem m => Context m -> m ([RouteResult], [RouteMapWarning])

Documentation

data CandidateRoute Source #

A candidate route with computed metadata for disambiguation.

Constructors

CandidateRoute

Fields

route :: RouteResult
The route result.
specificity :: Int
The specificity of the route, i.e., the number of path components from the route's destination to the target path. Lower is more specific.
sourceFilePath :: OsPath
The computed source file path (combining route source path with relative path from destination to target).
sourceExists :: Bool
Whether the source file for this route already exists.

Instances

Instances details

Show CandidateRoute Source #
Instance details Defined in Dojang.Types.Context Methods showsPrec :: Int -> CandidateRoute -> ShowS # show :: CandidateRoute -> String # showList :: [CandidateRoute] -> ShowS #
Eq CandidateRoute Source #
Instance details Defined in Dojang.Types.Context Methods (==) :: CandidateRoute -> CandidateRoute -> Bool # (/=) :: CandidateRoute -> CandidateRoute -> Bool #

data MonadFileSystem m => Context (m :: Type -> Type) Source #

The context in which repository operations are performed.

Constructors

Context
Fields repository :: Repository The repository. environment :: Environment The environment. environmentVariableGetter :: EnvironmentVariable -> m (Maybe OsString) A function to look up an environment variable.

data FileCorrespondence Source #

A correspondence between a source file, an intermediate file, and a destination file.

Constructors

FileCorrespondence
Fields source :: FileEntry The source file. sourceDelta :: FileDeltaKind The kind of change that was made to the source file. intermediate :: FileEntry The intermediate file. destination :: FileEntry The destination file. destinationDelta :: FileDeltaKind The kind of change that was made to the destination file.

Instances

Instances details

Show FileCorrespondence Source #
Instance details Defined in Dojang.Types.Context Methods showsPrec :: Int -> FileCorrespondence -> ShowS # show :: FileCorrespondence -> String # showList :: [FileCorrespondence] -> ShowS #
Eq FileCorrespondence Source #
Instance details Defined in Dojang.Types.Context Methods (==) :: FileCorrespondence -> FileCorrespondence -> Bool # (/=) :: FileCorrespondence -> FileCorrespondence -> Bool #
Ord FileCorrespondence Source #
Instance details Defined in Dojang.Types.Context Methods compare :: FileCorrespondence -> FileCorrespondence -> Ordering # (<) :: FileCorrespondence -> FileCorrespondence -> Bool # (<=) :: FileCorrespondence -> FileCorrespondence -> Bool # (>) :: FileCorrespondence -> FileCorrespondence -> Bool # (>=) :: FileCorrespondence -> FileCorrespondence -> Bool # max :: FileCorrespondence -> FileCorrespondence -> FileCorrespondence # min :: FileCorrespondence -> FileCorrespondence -> FileCorrespondence #

data FileDeltaKind Source #

The kind of change that was made to a file.

Constructors

Unchanged
Added
Removed
Modified

Instances

Instances details

Show FileDeltaKind Source #
Instance details Defined in Dojang.Types.Context Methods showsPrec :: Int -> FileDeltaKind -> ShowS # show :: FileDeltaKind -> String # showList :: [FileDeltaKind] -> ShowS #
Eq FileDeltaKind Source #
Instance details Defined in Dojang.Types.Context Methods (==) :: FileDeltaKind -> FileDeltaKind -> Bool # (/=) :: FileDeltaKind -> FileDeltaKind -> Bool #
Ord FileDeltaKind Source #
Instance details Defined in Dojang.Types.Context Methods compare :: FileDeltaKind -> FileDeltaKind -> Ordering # (<) :: FileDeltaKind -> FileDeltaKind -> Bool # (<=) :: FileDeltaKind -> FileDeltaKind -> Bool # (>) :: FileDeltaKind -> FileDeltaKind -> Bool # (>=) :: FileDeltaKind -> FileDeltaKind -> Bool # max :: FileDeltaKind -> FileDeltaKind -> FileDeltaKind # min :: FileDeltaKind -> FileDeltaKind -> FileDeltaKind #

data FileEntry Source #

A file/directory in the repository or the destination directory.

Constructors

FileEntry
Fields path :: OsPath The path to the file. stat :: FileStat Whether the file is a file, a directory, or missing.

Instances

Instances details

Show FileEntry Source #
Instance details Defined in Dojang.Types.Context Methods showsPrec :: Int -> FileEntry -> ShowS # show :: FileEntry -> String # showList :: [FileEntry] -> ShowS #
Eq FileEntry Source #
Instance details Defined in Dojang.Types.Context Methods (==) :: FileEntry -> FileEntry -> Bool # (/=) :: FileEntry -> FileEntry -> Bool #
Ord FileEntry Source #
Instance details Defined in Dojang.Types.Context Methods compare :: FileEntry -> FileEntry -> Ordering # (<) :: FileEntry -> FileEntry -> Bool # (<=) :: FileEntry -> FileEntry -> Bool # (>) :: FileEntry -> FileEntry -> Bool # (>=) :: FileEntry -> FileEntry -> Bool # max :: FileEntry -> FileEntry -> FileEntry # min :: FileEntry -> FileEntry -> FileEntry #

data FileStat Source #

The small stat of a file.

Constructors

Missing	The file is missing.
Directory	The file is a directory.
File Integer	The file is a regular file, and this is its size in bytes.
Symlink OsPath	The file is a symlink, and this is the path to the symlink target.

Instances

Instances details

Show FileStat Source #
Instance details Defined in Dojang.Types.Context Methods showsPrec :: Int -> FileStat -> ShowS # show :: FileStat -> String # showList :: [FileStat] -> ShowS #
Eq FileStat Source #
Instance details Defined in Dojang.Types.Context Methods (==) :: FileStat -> FileStat -> Bool # (/=) :: FileStat -> FileStat -> Bool #
Ord FileStat Source #
Instance details Defined in Dojang.Types.Context Methods compare :: FileStat -> FileStat -> Ordering # (<) :: FileStat -> FileStat -> Bool # (<=) :: FileStat -> FileStat -> Bool # (>) :: FileStat -> FileStat -> Bool # (>=) :: FileStat -> FileStat -> Bool # max :: FileStat -> FileStat -> FileStat # min :: FileStat -> FileStat -> FileStat #

data IgnoredFile Source #

Represents a file that is ignored by a route's ignore patterns.

Constructors

IgnoredFile
Fields routeName :: OsPath The name of the route that contains the ignore pattern. sourcePath :: OsPath The path to the source file (in the repository). destinationPath :: OsPath The path to the destination file. pattern :: FilePattern The ignore pattern that matched the file.

Instances

Instances details

Show IgnoredFile Source #
Instance details Defined in Dojang.Types.Context Methods showsPrec :: Int -> IgnoredFile -> ShowS # show :: IgnoredFile -> String # showList :: [IgnoredFile] -> ShowS #
Eq IgnoredFile Source #
Instance details Defined in Dojang.Types.Context Methods (==) :: IgnoredFile -> IgnoredFile -> Bool # (/=) :: IgnoredFile -> IgnoredFile -> Bool #

data RouteMatch Source #

Result of finding routes for a destination path.

Constructors

NoMatch	No matching routes found.
SingleMatch RouteResult	A single unambiguous route was found.
AmbiguousMatch (NonEmpty CandidateRoute)	Multiple routes match with the same specificity.

Instances

Instances details

Show RouteMatch Source #
Instance details Defined in Dojang.Types.Context Methods showsPrec :: Int -> RouteMatch -> ShowS # show :: RouteMatch -> String # showList :: [RouteMatch] -> ShowS #
Eq RouteMatch Source #
Instance details Defined in Dojang.Types.Context Methods (==) :: RouteMatch -> RouteMatch -> Bool # (/=) :: RouteMatch -> RouteMatch -> Bool #

data RouteState Source #

Represents the route state of a (potential) destination file in the repository.

Constructors

Routed OsPath	The file is routed. The `OsPath` is the name of the relevant route name.
Ignored OsPath FilePattern	The file is routed but ignored. The `OsPath` is the name of the relevant route name, and the `FilePattern` is the ignore pattern that matched the file.
NotRouted	The file is not routed at all.

Instances

Instances details

Show RouteState Source #
Instance details Defined in Dojang.Types.Context Methods showsPrec :: Int -> RouteState -> ShowS # show :: RouteState -> String # showList :: [RouteState] -> ShowS #
Eq RouteState Source #
Instance details Defined in Dojang.Types.Context Methods (==) :: RouteState -> RouteState -> Bool # (/=) :: RouteState -> RouteState -> Bool #
Ord RouteState Source #
Instance details Defined in Dojang.Types.Context Methods compare :: RouteState -> RouteState -> Ordering # (<) :: RouteState -> RouteState -> Bool # (<=) :: RouteState -> RouteState -> Bool # (>) :: RouteState -> RouteState -> Bool # (>=) :: RouteState -> RouteState -> Bool # max :: RouteState -> RouteState -> RouteState # min :: RouteState -> RouteState -> RouteState #

data UnregisteredFile Source #

Represents a file that is not registered in any route.

Constructors

UnregisteredFile
Fields filePath :: OsPath The path to the unregistered file in the destination. candidateRoutes :: [RouteResult] The candidate routes that could contain this file (based on path prefix).

Instances

Instances details

Show UnregisteredFile Source #
Instance details Defined in Dojang.Types.Context Methods showsPrec :: Int -> UnregisteredFile -> ShowS # show :: UnregisteredFile -> String # showList :: [UnregisteredFile] -> ShowS #
Eq UnregisteredFile Source #
Instance details Defined in Dojang.Types.Context Methods (==) :: UnregisteredFile -> UnregisteredFile -> Bool # (/=) :: UnregisteredFile -> UnregisteredFile -> Bool #

calculateSpecificity Source #

Arguments

:: OsPath	The target path.
-> RouteResult	The route result.
-> Int	The specificity (number of path components from route destination to target).

Calculate the specificity of a route relative to a target path. Returns the number of path components between the route's destination and the target path. Lower values indicate more specific routes.

Examples

>>> calculateSpecificity "/foo/bar/baz" route  -- route.destinationPath = "/foo"
2  -- bar/baz

>>> calculateSpecificity "/foo" route  -- route.destinationPath = "/foo"
0  -- exact match

filterBySpecificity Source #

Arguments

:: OsPath	The target path.
-> [RouteResult]	The list of routes to filter.
-> [RouteResult]	The routes with the lowest specificity.

Filter routes by specificity, keeping only those with the lowest (most specific) specificity value.

findCandidateRoutesFor Source #

Arguments

:: MonadFileSystem m
=> Context m	The context in which to perform the operation.
-> OsPath	The path to the unregistered file.
-> m [RouteResult]	The list of candidate routes.

Finds candidate routes for an unregistered file. Returns routes whose destination path is a prefix of the file path.

findMatchingRoutes Source #

Arguments

:: MonadFileSystem m
=> Context m	The context in which to perform route matching.
-> OsPath	The target path.
-> m (RouteMatch, [RouteMapWarning])	The route match result, along with any warnings that were generated.

Find matching routes for a destination path. Returns a RouteMatch indicating whether no routes, a single route, or multiple ambiguous routes match.

getIgnoredFiles Source #

Arguments

:: (HasCallStack, MonadFileSystem m)
=> Context m	The context in which to perform the operation.
-> m [IgnoredFile]	The list of ignored files.

Gets a list of files that are ignored by the repository's ignore patterns. This function scans all directory routes for files that would be excluded by their ignore patterns.

getRouteState Source #

Arguments

:: (HasCallStack, MonadFileSystem m, MonadIO m)
=> Context m	The context in which to perform path routing.
-> OsPath	The path (which is a potential destination) to get the route state of.
-> m (RouteState, [RouteMapWarning])	The route state of the path, along with any warnings that were generated.

Gets the route state of the given path (which is a potential destination).

getUnregisteredFiles Source #

Arguments

:: (HasCallStack, MonadFileSystem m)
=> Context m	The context in which to perform the operation.
-> m [UnregisteredFile]	The list of unregistered files.

Gets a list of files in destination directories that are not registered in any route. These are files that exist in destination directories but are not part of the repository.

listFiles Source #

Arguments

:: MonadFileSystem m
=> OsPath	The path to the directory to list entries in.
-> [FilePattern]	The file patterns to ignore. If a directory matches one of these patterns, then its contents will not be listed either.
-> m [FileEntry]	The list of `FileEntry` values in the directory.

Lists all FilEntry values in the given directory. Throws an IOError if the directory cannot be read.

makeCorrespond Source #

Arguments

:: (HasCallStack, MonadFileSystem m)
=> Context m	The context in which to perform file correspondence.
-> m ([FileCorrespondence], [RouteMapWarning])	The file correspondences, along with a list of warnings that occurred during path routing (if any). The file paths in the returned `FileCorrespondence` values are absolute, or relative to the current working directory at least.

Creates a list of file correspondences between the source files, the intermediate files, and the destination files. Throws an IOError if any of the files cannot be read.

makeCorrespondBetweenThreeDirs :: (HasCallStack, MonadFileSystem m) => OsPath -> OsPath -> OsPath -> [FilePattern] -> m [FileCorrespondence] Source #

makeCorrespondBetweenThreeFiles :: (HasCallStack, MonadFileSystem m) => OsPath -> OsPath -> OsPath -> m FileCorrespondence Source #

makeCorrespondBetweenTwoDirs :: (HasCallStack, MonadFileSystem m) => OsPath -> OsPath -> [FilePattern] -> m (Map OsPath (FileEntry, FileEntry)) Source #

makeCorrespondWithDestination Source #

Arguments

:: MonadFileSystem m
=> Context m	The context in which to perform file correspondence.
-> OsPath	The path to the destination file.
-> m (Maybe FileCorrespondence, [RouteMapWarning])	The file correspondence, along with a list of warnings that occurred during path routing (if any). The file paths in the returned `FileCorrespondence` value are absolute, or relative to the current working directory at least.

Creates a FileCorrespondence from a single destination file.

routePaths Source #

Arguments

:: MonadFileSystem m
=> Context m	The context in which to perform path routing.
-> m ([RouteResult], [RouteMapWarning])	The expanded paths, along with any warnings that were generated.

Route the paths in the repository. This will return a list of expanded paths, along with any warnings that were generated. Null routes will be ignored.