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 an option to map-match to accept a GeoJSON feature collection #4

Open
8 tasks
thehoneymad opened this issue Sep 22, 2024 · 0 comments
Open
8 tasks
Labels
good first issue Good for newcomers

Comments

@thehoneymad
Copy link
Member

Description:
We will enhance the MapMatch command to accept one or more GeoJSON files as input. Each GeoJSON file must be a Feature Collection, containing only LineString or MultiLineString Features. Any other types of Features will be ignored during processing.

The system will validate the file extension, ensuring only GeoJSON files are accepted. Files with no eligible features (i.e., no LineStrings or MultiLineStrings) will pass validation but will not trigger any map matching.


Acceptance Criteria:

  • The MapMatch command should accept one or more GeoJSON files as input.
  • Each GeoJSON file must be a valid Feature Collection.
  • The command should:
    • Process only LineString and MultiLineString Features in the Feature Collection.
    • Ignore any other feature types without throwing errors.
  • Add validation for file extension:
    • Only accept files with the .geojson extension.
    • Invalid file types must fail validation with an appropriate error message.
  • If no eligible features (LineStrings or MultiLineStrings) are found in a file, the validation should succeed, but a message should indicate that no features will be map matched.
  • Ensure that appropriate logging and feedback are provided to the user regarding the number of eligible features being processed.
  • Update the README to document the usage of the MapMatch command, including the expected input format (GeoJSON Feature Collections) and validation behavior.
  • Add automated tests to:
    • Verify that only LineString and MultiLineString features are processed.
    • Test the validation logic for accepting valid GeoJSON files and rejecting invalid ones.
    • Ensure correct handling of files with no eligible features.

Additional Resources:

@thehoneymad thehoneymad converted this from a draft issue Sep 22, 2024
@thehoneymad thehoneymad changed the title Add an option to MapMatch to accept a GeoJSON feature collection Add an option to map-match to accept a GeoJSON feature collection Sep 22, 2024
@thehoneymad thehoneymad added the good first issue Good for newcomers label Sep 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Development

No branches or pull requests

1 participant