feat: Add metadata to report

[briandonahue]

Summary:

Closes #1363.

Add a metadata / overview section to the HTML report.

Expected behavior:

Explain and/or show screenshots for how you expect the pull request to work in your testing (in case other devices exhibit different behavior).

Please make sure these boxes are checked before submitting your pull request - thanks!

• Run the unit tests with gradle test to make sure you didn't break anything
• Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
• Linked all relevant issues
• Include screenshot(s) showing how this pull request works and fixes the issue(s)

[github-actions]

This contribution does not follow the conventions set by the Google Java style guide. Please run the following command line at the root of the project to fix formatting errors: ./gradlew goJF.

[github-actions]

✅ Rule acceptance tests passed.
New Errors: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1425 sources (~0 %) are corrupted.
Commit: 1c4c312
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

[github-actions]

✅ Rule acceptance tests passed.
New Errors: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1425 sources (~0 %) are corrupted.
Commit: ab06617
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

[github-actions]

✅ Rule acceptance tests passed.
New Errors: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1425 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1425 sources (~0 %) are corrupted.
Commit: 25ade0c
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

[github-actions]

This contribution does not follow the conventions set by the Google Java style guide. Please run the following command line at the root of the project to fix formatting errors: ./gradlew goJF.

[briandonahue]

@isabelle-dr This is still a work in progress, and obviously the report needs better organization, but wanted to show you the data as it's currently being output and see if you had any specific requests for organizing it on the report:

[briandonahue]

@bdferris-v2 @davidgamez Leaving this a draft for now, but looking for any feedback/suggestions on the approach and/or the report organization/layout

[github-actions]

This contribution does not follow the conventions set by the Google Java style guide. Please run the following command line at the root of the project to fix formatting errors: ./gradlew goJF.

[isabelle-dr]

As linked to the GitHub issue, here is a scoping doc for this PR.

[briandonahue]

Getting a little closer. May need to call in some CSS support for a more responsive design :)

[isabelle-dr]

This is beautiful (and why so many shapes in this dataset? 😅 is 1171 the number of unique shape_ids or the number of records?)
You can remove the section at the end (starting at "parameters used")

[github-actions]

✅ Rule acceptance tests passed.
New Errors: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1426 sources (~0 %) are corrupted.
Commit: 9897205
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

[briandonahue]

Yes, we want the # of unique ID fields for the counts. It shouldn't make a difference for the others because each record should have a unique ID, but we could have duplicates so I'd rather look at the unique IDs all the time.

@isabelle-dr I've updated it to always count unique IDs and simplified the code a bit to use generics (@davidgamez open to feedback on this if there is a cleaner, more concise approach).

[github-actions]

✅ Rule acceptance tests passed.
New Errors: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1426 sources (~0 %) are corrupted.
Commit: 4ed7028
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

[isabelle-dr]

@briandonahue we're getting there!
In order to test this PR, could you share the dataset you've been using to generate these reports?

Another question I have is: under the "Files included", are you listing all of them or only the official GTFS files?
Maybe it wasn't clear in the Requirements doc, we want all files listed there.

[davidgamez]

LGTM!

[briandonahue]

@briandonahue we're getting there! In order to test this PR, could you share the dataset you've been using to generate these reports?

Yes, these were 2 I was testing with:
Westchester_County_Bee_Line.zip
alhambra-ca-us.zip

Another question I have is: under the "Files included", are you listing all of them or only the official GTFS files? Maybe it wasn't clear in the Requirements doc, we want all files listed there.

I was not, but I've updated it now to do so.

/cc @davidgamez

[github-actions]

✅ Rule acceptance tests passed.
New Errors: 0 out of 1427 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1427 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1427 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1427 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1427 sources (~0 %) are corrupted.
Commit: e604495
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

[isabelle-dr]

@briandonahue can you share a screenshot of your latest version for alhambra-ca-us.zip?

[github-actions]

✅ Rule acceptance tests passed.
New Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1428 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1428 sources (~0 %) are corrupted.
Commit: 0c197fc
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

[briandonahue]

@briandonahue can you share a screenshot of your latest version for alhambra-ca-us.zip?

@isabelle-dr Here you go 😄

[isabelle-dr]

Perfect! Merging