hasufell/hpath
1
1
Fork 0
Code Issues 8 Pull Requests Releases Wiki Activity

Prettify doctests

Browse Source
This commit is contained in:
Julian Ospald 2016-05-23 00:52:27 +02:00
parent 47dd729e8a
commit 908513da2b
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28
1 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
src/HPath.hs
View File

@ -106,19 +106,19 @@ pattern Path x <- (MkPath x)
-- --
-- Throws: 'PathParseException' -- Throws: 'PathParseException'
-- --
-- >>> parseAbs "/abc" :: Maybe (Path Abs) -- >>> parseAbs "/abc" :: Maybe (Path Abs)
-- Just "/abc" -- Just "/abc"
-- >>> parseAbs "/" :: Maybe (Path Abs) -- >>> parseAbs "/" :: Maybe (Path Abs)
-- Just "/" -- Just "/"
-- >>> parseAbs "/abc/def" :: Maybe (Path Abs) -- >>> parseAbs "/abc/def" :: Maybe (Path Abs)
-- Just "/abc/def" -- Just "/abc/def"
-- >>> parseAbs "/abc/def/.///" :: Maybe (Path Abs) -- >>> parseAbs "/abc/def/.///" :: Maybe (Path Abs)
-- Just "/abc/def/" -- Just "/abc/def/"
-- >>> parseAbs "abc" :: Maybe (Path Abs) -- >>> parseAbs "abc" :: Maybe (Path Abs)
-- Nothing -- Nothing
-- >>> parseAbs "" :: Maybe (Path Abs) -- >>> parseAbs "" :: Maybe (Path Abs)
-- Nothing -- Nothing
-- >>> parseAbs "/abc/../foo" :: Maybe (Path Abs) -- >>> parseAbs "/abc/../foo" :: Maybe (Path Abs)
-- Nothing -- Nothing
parseAbs :: MonadThrow m parseAbs :: MonadThrow m
=> ByteString -> m (Path Abs) => ByteString -> m (Path Abs)
@ -138,23 +138,23 @@ parseAbs filepath =
-- --
-- Throws: 'PathParseException' -- Throws: 'PathParseException'
-- --
-- >>> parseRel "abc" :: Maybe (Path Rel) -- >>> parseRel "abc" :: Maybe (Path Rel)
-- Just "abc" -- Just "abc"
-- >>> parseRel "def/" :: Maybe (Path Rel) -- >>> parseRel "def/" :: Maybe (Path Rel)
-- Just "def/" -- Just "def/"
-- >>> parseRel "abc/def" :: Maybe (Path Rel) -- >>> parseRel "abc/def" :: Maybe (Path Rel)
-- Just "abc/def" -- Just "abc/def"
-- >>> parseRel "abc/def/." :: Maybe (Path Rel) -- >>> parseRel "abc/def/." :: Maybe (Path Rel)
-- Just "abc/def/" -- Just "abc/def/"
-- >>> parseRel "/abc" :: Maybe (Path Rel) -- >>> parseRel "/abc" :: Maybe (Path Rel)
-- Nothing -- Nothing
-- >>> parseRel "" :: Maybe (Path Rel) -- >>> parseRel "" :: Maybe (Path Rel)
-- Nothing -- Nothing
-- >>> parseRel "abc/../foo" :: Maybe (Path Rel) -- >>> parseRel "abc/../foo" :: Maybe (Path Rel)
-- Nothing -- Nothing
-- >>> parseRel "." :: Maybe (Path Rel) -- >>> parseRel "." :: Maybe (Path Rel)
-- Nothing -- Nothing
-- >>> parseRel ".." :: Maybe (Path Rel) -- >>> parseRel ".." :: Maybe (Path Rel)
-- Nothing -- Nothing
parseRel :: MonadThrow m parseRel :: MonadThrow m
=> ByteString -> m (Path Rel) => ByteString -> m (Path Rel)
@ -173,25 +173,25 @@ parseRel filepath =
-- --
-- Throws: 'PathParseException' -- Throws: 'PathParseException'
-- --
-- >>> parseFn "abc" :: Maybe (Path Fn) -- >>> parseFn "abc" :: Maybe (Path Fn)
-- Just "abc" -- Just "abc"
-- >>> parseFn "..." :: Maybe (Path Fn) -- >>> parseFn "..." :: Maybe (Path Fn)
-- Just "..." -- Just "..."
-- >>> parseFn "def/" :: Maybe (Path Fn) -- >>> parseFn "def/" :: Maybe (Path Fn)
-- Nothing -- Nothing
-- >>> parseFn "abc/def" :: Maybe (Path Fn) -- >>> parseFn "abc/def" :: Maybe (Path Fn)
-- Nothing -- Nothing
-- >>> parseFn "abc/def/." :: Maybe (Path Fn) -- >>> parseFn "abc/def/." :: Maybe (Path Fn)
-- Nothing -- Nothing
-- >>> parseFn "/abc" :: Maybe (Path Fn) -- >>> parseFn "/abc" :: Maybe (Path Fn)
-- Nothing -- Nothing
-- >>> parseFn "" :: Maybe (Path Fn) -- >>> parseFn "" :: Maybe (Path Fn)
-- Nothing -- Nothing
-- >>> parseFn "abc/../foo" :: Maybe (Path Fn) -- >>> parseFn "abc/../foo" :: Maybe (Path Fn)
-- Nothing -- Nothing
-- >>> parseFn "." :: Maybe (Path Fn) -- >>> parseFn "." :: Maybe (Path Fn)
-- Nothing -- Nothing
-- >>> parseFn ".." :: Maybe (Path Fn) -- >>> parseFn ".." :: Maybe (Path Fn)
-- Nothing -- Nothing
parseFn :: MonadThrow m parseFn :: MonadThrow m
=> ByteString -> m (Path Fn) => ByteString -> m (Path Fn)
@ -234,13 +234,13 @@ fromRel = toFilePath
-- because this library is IO-agnostic and makes no assumptions about -- because this library is IO-agnostic and makes no assumptions about
-- file types. -- file types.
-- --
-- >>> (MkPath "/") </> (MkPath "file" :: Path Rel) -- >>> (MkPath "/") </> (MkPath "file" :: Path Rel)
-- "/file" -- "/file"
-- >>> (MkPath "/path/to") </> (MkPath "file" :: Path Rel) -- >>> (MkPath "/path/to") </> (MkPath "file" :: Path Rel)
-- "/path/to/file" -- "/path/to/file"
-- >>> (MkPath "/") </> (MkPath "file/lal" :: Path Rel) -- >>> (MkPath "/") </> (MkPath "file/lal" :: Path Rel)
-- "/file/lal" -- "/file/lal"
-- >>> (MkPath "/") </> (MkPath "file/" :: Path Rel) -- >>> (MkPath "/") </> (MkPath "file/" :: Path Rel)
-- "/file/" -- "/file/"
(</>) :: RelC r => Path b -> Path r -> Path b (</>) :: RelC r => Path b -> Path r -> Path b
(</>) (MkPath a) (MkPath b) = MkPath (a' `BS.append` b) (</>) (MkPath a) (MkPath b) = MkPath (a' `BS.append` b)
@ -254,15 +254,15 @@ fromRel = toFilePath
-- --
-- The bases must match. -- The bases must match.
-- --
-- >>> (MkPath "/lal/lad") `stripDir` (MkPath "/lal/lad/fad") :: Maybe (Path Rel) -- >>> (MkPath "/lal/lad") `stripDir` (MkPath "/lal/lad/fad") :: Maybe (Path Rel)
-- Just "fad" -- Just "fad"
-- >>> (MkPath "lal/lad") `stripDir` (MkPath "lal/lad/fad") :: Maybe (Path Rel) -- >>> (MkPath "lal/lad") `stripDir` (MkPath "lal/lad/fad") :: Maybe (Path Rel)
-- Just "fad" -- Just "fad"
-- >>> (MkPath "/") `stripDir` (MkPath "/") :: Maybe (Path Rel) -- >>> (MkPath "/") `stripDir` (MkPath "/") :: Maybe (Path Rel)
-- Nothing -- Nothing
-- >>> (MkPath "/lal/lad/fad") `stripDir` (MkPath "/lal/lad") :: Maybe (Path Rel) -- >>> (MkPath "/lal/lad/fad") `stripDir` (MkPath "/lal/lad") :: Maybe (Path Rel)
-- Nothing -- Nothing
-- >>> (MkPath "fad") `stripDir` (MkPath "fad") :: Maybe (Path Rel) -- >>> (MkPath "fad") `stripDir` (MkPath "fad") :: Maybe (Path Rel)
-- Nothing -- Nothing
stripDir :: MonadThrow m stripDir :: MonadThrow m
=> Path b -> Path b -> m (Path Rel) => Path b -> Path b -> m (Path Rel)
@ -278,15 +278,15 @@ stripDir (MkPath p) (MkPath l) =
-- | Is p a parent of the given location? Implemented in terms of -- | Is p a parent of the given location? Implemented in terms of
-- 'stripDir'. The bases must match. -- 'stripDir'. The bases must match.
-- --
-- >>> (MkPath "/lal/lad") `isParentOf` (MkPath "/lal/lad/fad") -- >>> (MkPath "/lal/lad") `isParentOf` (MkPath "/lal/lad/fad")
-- True -- True
-- >>> (MkPath "lal/lad") `isParentOf` (MkPath "lal/lad/fad") -- >>> (MkPath "lal/lad") `isParentOf` (MkPath "lal/lad/fad")
-- True -- True
-- >>> (MkPath "/") `isParentOf` (MkPath "/") -- >>> (MkPath "/") `isParentOf` (MkPath "/")
-- False -- False
-- >>> (MkPath "/lal/lad/fad") `isParentOf` (MkPath "/lal/lad") -- >>> (MkPath "/lal/lad/fad") `isParentOf` (MkPath "/lal/lad")
-- False -- False
-- >>> (MkPath "fad") `isParentOf` (MkPath "fad") -- >>> (MkPath "fad") `isParentOf` (MkPath "fad")
-- False -- False
isParentOf :: Path b -> Path b -> Bool isParentOf :: Path b -> Path b -> Bool
isParentOf p l = isJust (stripDir p l :: Maybe (Path Rel)) isParentOf p l = isJust (stripDir p l :: Maybe (Path Rel))
@ -330,7 +330,7 @@ dirname (MkPath fp) = MkPath (takeDirectory $ dropTrailingPathSeparator fp)
-- --
-- >>> basename (MkPath "/abc/def/dod") :: Maybe (Path Fn) -- >>> basename (MkPath "/abc/def/dod") :: Maybe (Path Fn)
-- Just "dod" -- Just "dod"
-- >>> basename (MkPath "/") :: Maybe (Path Fn) -- >>> basename (MkPath "/") :: Maybe (Path Fn)
-- Nothing -- Nothing
basename :: MonadThrow m => Path b -> m (Path Fn) basename :: MonadThrow m => Path b -> m (Path Fn)
basename (MkPath l) basename (MkPath l)