Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new ERROR if a GTFS dataset has GTFS files in sub-folders #1504

Closed
isabelle-dr opened this issue Jun 19, 2023 · 4 comments · Fixed by #1535
Closed

Add new ERROR if a GTFS dataset has GTFS files in sub-folders #1504

isabelle-dr opened this issue Jun 19, 2023 · 4 comments · Fixed by #1535
Assignees
Labels
GTFS Reference Used for Adding or changing rules that belong in the GTFS reference

Comments

@isabelle-dr
Copy link
Contributor

isabelle-dr commented Jun 19, 2023

A Pull Request is currently open to explicitly forbid sub-folders in GTFS.

It seems like there is a consensus on this issue and that the vote will be open shortly.

It would be nice to add this validator rule before the vote opens because the result of the acceptance tests could inform on what practices currently exist around subfolders in GTFS.

The new rule notice has an ERROR severity level, and the pseudo-code is:

The PR to solve this issue should not be merged until #379 passes successfully and is merged.

@isabelle-dr isabelle-dr added GTFS Reference Used for Adding or changing rules that belong in the GTFS reference status: Ready An issue that is ready to be worked on. labels Jun 19, 2023
@isabelle-dr isabelle-dr added this to the Now milestone Jun 19, 2023
@isabelle-dr isabelle-dr moved this to MobilityData Backlog in Schedule Validator Q2 backlog Jun 19, 2023
@isabelle-dr isabelle-dr moved this from MobilityData Backlog (bugs) to MobilityData backlog (new rules) in Schedule Validator Q2 backlog Jun 19, 2023
@emmambd
Copy link
Contributor

emmambd commented Jun 21, 2023

Modified the description based on this clarification. Subfolders are acceptable, but ones that contain GTFS files are not.

@emmambd emmambd changed the title Add new ERROR if a GTFS dataset includes sub-folders Add new ERROR if a GTFS dataset has GTFS files in sub-folders Jun 21, 2023
@qcdyx qcdyx self-assigned this Jul 3, 2023
@qcdyx qcdyx added status: Work in progress A PR that would close this issue has been opened. and removed status: Ready An issue that is ready to be worked on. labels Jul 3, 2023
@qcdyx
Copy link
Contributor

qcdyx commented Jul 3, 2023

Any thoughts on the naming of this error? @isabelle-dr @emmambd

  • invalid_GTFS_input
  • invalid_input_with_subfolders
  • invalid_GTFS_input_GTFS_files_in_subfolders
  • invalid_input_GTFS_files_in_subfolders

@emmambd
Copy link
Contributor

emmambd commented Jul 4, 2023

@qcdyx I think the last one is the most accurate, but also not sure of the typical best practices we use in naming errors cc @isabelle-dr

I've also updated the issue so it's clear that this PR should not be merged until #379 passes.

@qcdyx
Copy link
Contributor

qcdyx commented Jul 12, 2023

Update:
1.invalid_input_files_in_subfolder is used for naming this error. The reason for not using invalid_input_GTFS_files_in_subfolders is that it would be changed to invalid_input_g_t_f_s_files_in_subfolder in the validation report and it's not that user friendly.
2. Mac created zip files reproduce the entire folder, for instance, test.zip contains a "test/" directory that contains the GTFS files and the validator generates missing_required_file notice. A new issue is created for this problem.
#1532
@emmambd @isabelle-dr

@qcdyx qcdyx linked a pull request Jul 17, 2023 that will close this issue
4 tasks
@github-project-automation github-project-automation bot moved this from MobilityData backlog (new rules) to Done in Schedule Validator Q2 backlog Jul 25, 2023
@qcdyx qcdyx removed the status: Work in progress A PR that would close this issue has been opened. label Nov 29, 2023
@emmambd emmambd removed this from the Now milestone Jan 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GTFS Reference Used for Adding or changing rules that belong in the GTFS reference
Projects
Development

Successfully merging a pull request may close this issue.

3 participants