Fork chrisdone's path library
I wasn't happy with the way it dealt with Dir vs File things. In his
version of the library, a `Path b Dir` always ends with a trailing
path separator and `Path b File` never ends with a trailing path separator.
IMO, it is nonsensical to make a Dir vs File distinction on path level,
although it first seems nice.
Some of the reasons are:
* a path is just that: a path. It is completely disconnected from IO level
and even if a `Dir`/`File` type theoretically allows us to say "this path
ought to point to a file", there is literally zero guarantee that it will
hold true at runtime. So this basically gives a false feeling of a
type-safe file distinction.
* it's imprecise about Dir vs File distinction, which makes it even worse,
because a directory is also a file (just not a regular file). Add symlinks
to that and the confusion is complete.
* it makes the API oddly complicated for use cases where we basically don't
care (yet) whether something turns out to be a directory or not
Still, it comes also with a few perks:
* it simplifies some functions, because they now have guarantees whether a
path ends in a trailing path separator or not
* it may be safer for interaction with other library functions, which behave
differently depending on a trailing path separator (like probably shelly)
Not limited to, but also in order to fix my remarks without breaking any
benefits, I did:
* rename the `Dir`/`File` types to `TPS`/`NoTPS`, so it's clear we are only
giving information about trailing path separators and not actual file
types we don't know about yet
* add a `MaybeTPS` type, which does not mess with trailing path separators
and also gives no guarantees about them... then added `toNoTPS` and
`toTPS` to allow type-safe conversion
* make some functions accept more general types, so we don't unnecessarily
force paths with trailing separators for `(</>)` for example... instead
these functions now examine the paths to still have correct behavior.
This is really minor overhead. You might say now "but then I can append
filepath to filepath". Well, as I said... we don't know whether it's a
"filepath" at all.
* merge `filename` and `dirname` into `basename` and make `parent` be
`dirname`, so the function names match the name of the POSIX ones,
which do (almost) the same...
* fix a bug in `basename` (formerly `dirname`) which broke the type
guarantees
* add a pattern synonym for easier pattern matching without exporting
the internal Path constructor
2016-03-08 21:53:42 +00:00
|
|
|
|
name: hpath
|
|
|
|
|
|
version: 0.5.8
|
2016-01-28 11:47:15 +00:00
|
|
|
|
synopsis: Support for well-typed paths
|
|
|
|
|
|
description: Support for will-typed paths.
|
2015-05-07 18:14:23 +00:00
|
|
|
|
license: BSD3
|
|
|
|
|
|
license-file: LICENSE
|
Fork chrisdone's path library
I wasn't happy with the way it dealt with Dir vs File things. In his
version of the library, a `Path b Dir` always ends with a trailing
path separator and `Path b File` never ends with a trailing path separator.
IMO, it is nonsensical to make a Dir vs File distinction on path level,
although it first seems nice.
Some of the reasons are:
* a path is just that: a path. It is completely disconnected from IO level
and even if a `Dir`/`File` type theoretically allows us to say "this path
ought to point to a file", there is literally zero guarantee that it will
hold true at runtime. So this basically gives a false feeling of a
type-safe file distinction.
* it's imprecise about Dir vs File distinction, which makes it even worse,
because a directory is also a file (just not a regular file). Add symlinks
to that and the confusion is complete.
* it makes the API oddly complicated for use cases where we basically don't
care (yet) whether something turns out to be a directory or not
Still, it comes also with a few perks:
* it simplifies some functions, because they now have guarantees whether a
path ends in a trailing path separator or not
* it may be safer for interaction with other library functions, which behave
differently depending on a trailing path separator (like probably shelly)
Not limited to, but also in order to fix my remarks without breaking any
benefits, I did:
* rename the `Dir`/`File` types to `TPS`/`NoTPS`, so it's clear we are only
giving information about trailing path separators and not actual file
types we don't know about yet
* add a `MaybeTPS` type, which does not mess with trailing path separators
and also gives no guarantees about them... then added `toNoTPS` and
`toTPS` to allow type-safe conversion
* make some functions accept more general types, so we don't unnecessarily
force paths with trailing separators for `(</>)` for example... instead
these functions now examine the paths to still have correct behavior.
This is really minor overhead. You might say now "but then I can append
filepath to filepath". Well, as I said... we don't know whether it's a
"filepath" at all.
* merge `filename` and `dirname` into `basename` and make `parent` be
`dirname`, so the function names match the name of the POSIX ones,
which do (almost) the same...
* fix a bug in `basename` (formerly `dirname`) which broke the type
guarantees
* add a pattern synonym for easier pattern matching without exporting
the internal Path constructor
2016-03-08 21:53:42 +00:00
|
|
|
|
author: Julian Ospald <hasufell@posteo.de>
|
|
|
|
|
|
maintainer: Julian Ospald <hasufell@posteo.de>
|
|
|
|
|
|
copyright: 2015–2016 FP Complete, Julian Ospald 2016
|
2015-05-07 18:14:23 +00:00
|
|
|
|
category: Filesystem
|
|
|
|
|
|
build-type: Simple
|
2016-05-09 11:31:20 +00:00
|
|
|
|
cabal-version: >=1.14
|
|
|
|
|
|
extra-source-files: README.md
|
|
|
|
|
|
CHANGELOG
|
|
|
|
|
|
cbits/dirutils.h
|
|
|
|
|
|
doctests.hs
|
|
|
|
|
|
benchmarks/*.hs
|
2015-05-07 18:14:23 +00:00
|
|
|
|
|
|
|
|
|
|
library
|
|
|
|
|
|
hs-source-dirs: src/
|
2016-05-09 11:31:20 +00:00
|
|
|
|
default-language: Haskell2010
|
2015-05-07 18:14:23 +00:00
|
|
|
|
ghc-options: -Wall -O2
|
2016-05-09 11:31:20 +00:00
|
|
|
|
c-sources: cbits/dirutils.c
|
|
|
|
|
|
exposed-modules: HPath,
|
|
|
|
|
|
HPath.Internal,
|
|
|
|
|
|
System.Posix.Directory.Foreign,
|
|
|
|
|
|
System.Posix.Directory.Traversals,
|
|
|
|
|
|
System.Posix.FilePath
|
|
|
|
|
|
build-depends: base >= 4.2 && <5
|
|
|
|
|
|
, bytestring >= 0.9.2.0
|
2016-01-15 01:07:27 +00:00
|
|
|
|
, deepseq
|
2016-04-16 16:17:44 +00:00
|
|
|
|
, exceptions
|
|
|
|
|
|
, hspec
|
2016-05-09 11:31:20 +00:00
|
|
|
|
, unix >= 2.5
|
2016-04-16 16:17:44 +00:00
|
|
|
|
, utf8-string
|
2016-04-04 16:46:25 +00:00
|
|
|
|
, word8
|
2015-05-07 18:14:23 +00:00
|
|
|
|
|
2016-04-16 16:17:44 +00:00
|
|
|
|
|
2016-05-09 11:31:20 +00:00
|
|
|
|
test-suite doctests-hpath
|
|
|
|
|
|
default-language: Haskell2010
|
2016-04-16 16:17:44 +00:00
|
|
|
|
type: exitcode-stdio-1.0
|
|
|
|
|
|
ghc-options: -threaded
|
2016-05-09 11:31:20 +00:00
|
|
|
|
main-is: doctests-hpath.hs
|
2016-04-16 16:17:44 +00:00
|
|
|
|
build-depends: base
|
|
|
|
|
|
, HUnit
|
2016-05-09 11:31:20 +00:00
|
|
|
|
, QuickCheck
|
2016-04-16 16:17:44 +00:00
|
|
|
|
, doctest >= 0.8
|
|
|
|
|
|
, hpath
|
2016-05-09 11:31:20 +00:00
|
|
|
|
|
|
|
|
|
|
test-suite doctests-posix
|
|
|
|
|
|
default-language: Haskell2010
|
|
|
|
|
|
type: exitcode-stdio-1.0
|
|
|
|
|
|
ghc-options: -threaded
|
|
|
|
|
|
main-is: doctests-posix.hs
|
|
|
|
|
|
build-depends: base,
|
|
|
|
|
|
bytestring,
|
|
|
|
|
|
unix,
|
|
|
|
|
|
hpath,
|
|
|
|
|
|
doctest >= 0.8,
|
|
|
|
|
|
HUnit,
|
|
|
|
|
|
QuickCheck
|
|
|
|
|
|
|
|
|
|
|
|
benchmark bench.hs
|
|
|
|
|
|
default-language: Haskell2010
|
|
|
|
|
|
type: exitcode-stdio-1.0
|
|
|
|
|
|
hs-source-dirs: benchmarks
|
|
|
|
|
|
main-is: Bench.hs
|
|
|
|
|
|
|
|
|
|
|
|
build-depends:
|
|
|
|
|
|
base,
|
|
|
|
|
|
hpath,
|
|
|
|
|
|
bytestring,
|
|
|
|
|
|
unix,
|
|
|
|
|
|
directory >= 1.1 && < 1.3,
|
|
|
|
|
|
filepath >= 1.2 && < 1.4,
|
|
|
|
|
|
process >= 1.0 && < 1.3,
|
|
|
|
|
|
criterion >= 0.6 && < 0.9
|
|
|
|
|
|
ghc-options: -O2
|
2015-05-14 15:47:04 +00:00
|
|
|
|
|
|
|
|
|
|
source-repository head
|
2016-04-16 16:17:44 +00:00
|
|
|
|
type: git
|
|
|
|
|
|
location: https://github.com/hasufell/hpath
|
|
|
|
|
|
|
