Skip to content

Implement PathStruct and pass to _ishidden functions#23

Merged
jakewilliami merged 8 commits intomasterfrom
path-struct
Apr 25, 2023
Merged

Implement PathStruct and pass to _ishidden functions#23
jakewilliami merged 8 commits intomasterfrom
path-struct

Conversation

@jakewilliami
Copy link
Copy Markdown
Owner

@jakewilliami jakewilliami commented Sep 27, 2022

Instead of keeping track of both the file given by the user and the real path of the file (which some internal functions require, and others necessarily don't), we can construct a PathStruct object and pass that around internally. This also allows us to perform error checking within the PathStruct object, rather than in the ishidden function.

Related: #19.

To do:

  • Write implementation of PathStruct
  • Ensure all _ishidden_* functions take PathStruct parameter
  • Implement custom error(s) for realpath-related injuries
  • Write documentation for PathStruct and custom exceptions
  • Write further tests
  • Refine error checking for PathStruct constructor with method PathStruct(path::AbstractString, rp::AbstractString)

Instead of keeping track of both the file given by the user _and_ the
real path of the file (which some internal functions require, and
others necessarily don't), we can construct a PathStruct object and
pass that around internally.  This also allows us to perform error
checking within the PathStruct object, rather than in the ishidden
function.

Related: #19.

Still to do:
  - Write documentation for PathStruct and InvaliidRealPathError
  - Implement further tests
  - Refine error checking for PathStruct constructor with method
    PathStruct(path::AbstractString, rp::AbstractString)
@jakewilliami jakewilliami changed the title Implement PathStruct and pass to _ishidden functions Draft: Implement PathStruct and pass to _ishidden functions Sep 27, 2022
@jakewilliami jakewilliami changed the title Draft: Implement PathStruct and pass to _ishidden functions Implement PathStruct and pass to _ishidden functions Apr 25, 2023
@jakewilliami jakewilliami merged commit 12ff92e into master Apr 25, 2023
@jakewilliami jakewilliami deleted the path-struct branch April 25, 2023 02:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant