add in'

Author: safareli

src/Pathy.purs

@@ -7,7 +7,7 @@ module Pathy
   , module Pathy.Sandboxed
   ) where
 
-import Pathy.Path (AbsDir, AbsFile, AbsPath, AnyPath, AnyDir, AnyFile, Path, RelDir, RelFile, RelPath, appendPath, currentDir, dir, dir', extendPath, file, file', fileName, foldPath, name, parentAppend, parentOf, peel, peelFile, refine, relativeTo, rename, renameTraverse, rootDir, setExtension, (<..>), (<.>), (</>))
+import Pathy.Path (AbsDir, AbsFile, AbsPath, AnyPath, AnyDir, AnyFile, Path, RelDir, RelFile, RelPath, appendPath, currentDir, dir, dir', extendPath, file, file', in', fileName, foldPath, name, parentAppend, parentOf, peel, peelFile, refine, relativeTo, rename, renameTraverse, rootDir, setExtension, (<..>), (<.>), (</>))
 import Pathy.Name (Name(..), joinName, splitName, alterExtension, extension)
 import Pathy.Printer (Escaper(..), Printer, debugPrintPath, posixPrinter, printPath, unsafePrintPath, windowsPrinter)
 import Pathy.Parser (Parser(..), parseAbsDir, parseAbsFile, parsePath, parseRelDir, parseRelFile, posixParser)

src/Pathy/Path.purs

@@ -15,6 +15,7 @@ module Pathy.Path
   , dir'
   , file
   , file'
+  , in'
   , parentOf
   , extendPath
   , appendPath, (</>)
@@ -118,7 +119,7 @@ file = file' <<< reflectName
 
 -- | Creates a path which points to a relative file of the specified name.
 file' :: Name File -> Path Rel File
-file' = In currentDir
+file' = in'
 
 -- | Creates a path which points to a relative directory of the specified name.
 -- |
@@ -129,7 +130,18 @@ dir = dir' <<< reflectName
 
 -- | Creates a path which points to a relative directory of the specified name.
 dir' :: Name Dir -> Path Rel Dir
-dir' = In currentDir
+dir' = in'
+
+-- | Creates a path which points to a relative directory or file of the specified name.
+-- | In most cases [`dir'`](#v:dir') or [`file'`](#v:file') should be used instead,
+-- | but it's still there in case the segment type is going to be determined based
+-- | on some type variable.
+-- |
+-- | ``` purescript
+-- | p == maybe p (\(Tuple r n) -> r </> in' n) (peel p)
+-- | ```
+in' :: forall a. Name a -> Path Rel a
+in' = In currentDir
 
 -- | Creates a path that points to the parent directory of the specified path.
 -- |

test/Main.purs

@@ -5,14 +5,15 @@ import Prelude
 import Control.Monad.Eff (Eff)
 import Control.Monad.Eff.Console (CONSOLE, info)
 import Control.Monad.Eff.Exception (EXCEPTION, throw)
-import Data.Maybe (Maybe(..))
+import Data.Maybe (Maybe(..), maybe)
 import Data.Newtype (un)
 import Data.NonEmpty ((:|))
 import Data.String as Str
 import Data.String.NonEmpty (NonEmptyString)
 import Data.String.NonEmpty as NES
 import Data.Symbol (SProxy(..))
-import Pathy (class IsDirOrFile, class IsRelOrAbs, Abs, Dir, Name(..), Path, Rel, alterExtension, currentDir, debugPrintPath, dir, extension, file, joinName, parentOf, parseAbsDir, parseAbsFile, parseRelDir, parseRelFile, posixParser, posixPrinter, printPath, relativeTo, rename, rootDir, sandbox, sandboxAny, splitName, unsandbox, windowsPrinter, (<..>), (<.>), (</>))
+import Data.Tuple (Tuple(..))
+import Pathy (class IsDirOrFile, class IsRelOrAbs, Abs, Dir, Name(..), Path, Rel, alterExtension, currentDir, debugPrintPath, dir, extension, file, in', joinName, parentOf, parseAbsDir, parseAbsFile, parseRelDir, parseRelFile, peel, posixParser, posixPrinter, printPath, relativeTo, rename, rootDir, sandbox, sandboxAny, splitName, unsandbox, windowsPrinter, (<..>), (<.>), (</>))
 import Pathy.Gen as PG
 import Pathy.Name (reflectName)
 import Test.QuickCheck ((===))
@@ -95,6 +96,11 @@ checkJoinSplitNameId = do
   n <- genAmbigiousName
   pure $ joinName (splitName n) === id n
 
+checkPeelIn :: forall b. IsDirOrFile b => Gen.Gen (Path Abs b) -> Gen.Gen QC.Result
+checkPeelIn gen = do
+  p <- gen
+  pure $ p === maybe p (\(Tuple r n) -> r </> in' n) (peel p)
+
 checkRelative :: forall b. IsDirOrFile b => Gen.Gen (Path Abs b) -> Gen.Gen QC.Result
 checkRelative gen = do
   p1 <- gen
@@ -120,6 +126,8 @@ main = do
   info "checking `parse <<< print` for `RelFile`" *> QC.quickCheck parsePrintRelFilePath
   info "checking `relativeTo` for `AbsDir`" *> QC.quickCheck (checkRelative PG.genAbsDirPath)
   info "checking `relativeTo` for `AbsFile`" *> QC.quickCheck (checkRelative PG.genAbsFilePath)
+  info "checking `p === maybe p (\\(Tuple r n) -> r </> in' n) (peel p)` for `AbsDir`" *> QC.quickCheck (checkPeelIn PG.genAbsDirPath)
+  info "checking `p === maybe p (\\(Tuple r n) -> r </> in' n) (peel p)` for `AbsFile`" *> QC.quickCheck (checkPeelIn PG.genAbsFilePath)
   info "checking `joinName <<< splitName === id`" *> QC.quickCheck checkJoinSplitNameId
   info "checking `alterExtension id === id`" *> QC.quickCheck checkAlterExtensionId