feat: add recommended field notice #1157

KClough · 2022-05-18T15:36:53Z

Summary:

Related #885

Expected behavior:

Adds the recommended field notice.

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 · 2022-05-18T15:46:11Z

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 · 2022-05-18T16:27:55Z

Thank you for this contribution! 🍰✨🦄

Information about source corruption

0 out of 1248 sources are corrupted.

Acceptance test details

The changes in this pull request did not trigger any new errors on known GTFS datasets from the MobilityDatabase.
Download the full acceptance test report for commit 5632971 here (report will disappear after 90 days).

github-actions · 2022-05-20T04:10:42Z

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 · 2022-05-20T04:43:55Z

Thank you for this contribution! 🍰✨🦄

Information about source corruption

0 out of 1248 sources are corrupted.

Acceptance test details

The changes in this pull request did not trigger any new errors on known GTFS datasets from the MobilityDatabase.
Download the full acceptance test report for commit 0af3983 here (report will disappear after 90 days).

github-actions · 2022-06-24T02:35:20Z

Thank you for this contribution! 🍰✨🦄

Information about source corruption

0 out of 1248 sources are corrupted.

Acceptance test details

The changes in this pull request did not trigger any new errors on known GTFS datasets from the MobilityDatabase.
Download the full acceptance test report for commit 8adedf5 here (report will disappear after 90 days).

github-actions · 2022-06-28T17:44:17Z

Thank you for this contribution! 🍰✨🦄

Information about source corruption

0 out of 1248 sources are corrupted.

Acceptance test details

The changes in this pull request did not trigger any new errors on known GTFS datasets from the MobilityDatabase.
Download the full acceptance test report for commit b1eab8f here (report will disappear after 90 days).

maximearmstrong

Thanks @KClough! A few things before approval.

maximearmstrong · 2022-06-28T18:48:06Z

core/src/main/java/org/mobilitydata/gtfsvalidator/notice/MissingRecommendedFieldNotice.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2020 Google LLC


Same as in #1151: you can update the copyright if you'd like.

core/src/main/java/org/mobilitydata/gtfsvalidator/parsing/RowParser.java

maximearmstrong · 2022-06-28T18:53:39Z

core/src/main/java/org/mobilitydata/gtfsvalidator/notice/MissingRecommendedFieldNotice.java

+ *
+ * <p>Severity: {@code SeverityLevel.ERROR}
+ */
+public class MissingRecommendedFieldNotice extends ValidationNotice {


We would need the changes to RULES.md to be done in this PR if possible.

maximearmstrong · 2022-06-28T19:07:02Z

core/src/main/java/org/mobilitydata/gtfsvalidator/parsing/RowParser.java

@@ -112,6 +113,14 @@ public String asString(int columnIndex, FieldLevelEnum level) {
      noticeContainer.addValidationNotice(
          new MissingRequiredFieldNotice(
              fileName, row.getRowNumber(), header.getColumnName(columnIndex)));
+    } else if (level == FieldLevelEnum.RECOMMENDED && s == null) {


Also, I think we would need unit tests in RowParserTest.java to test the behavior of asString() depending on FieldLevelEnum value.

Good call. I've added some unit tests for both Recommended and Required. Let me know if you'd like me to cover any additional cases.

github-actions · 2022-06-29T20:25:04Z

Thank you for this contribution! 🍰✨🦄

Information about source corruption

0 out of 1248 sources are corrupted.

Acceptance test details

The changes in this pull request did not trigger any new errors on known GTFS datasets from the MobilityDatabase.
Download the full acceptance test report for commit 5974c59 here (report will disappear after 90 days).

…arser.java Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>

github-actions · 2022-06-29T20:46:52Z

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 · 2022-06-29T21:25:35Z

Thank you for this contribution! 🍰✨🦄

Information about source corruption

0 out of 1248 sources are corrupted.

Acceptance test details

The changes in this pull request did not trigger any new errors on known GTFS datasets from the MobilityDatabase.
Download the full acceptance test report for commit 9fd785c here (report will disappear after 90 days).

maximearmstrong

LGTM, thank you @KClough!

KClough changed the title ~~**Summary:**~~ feat: apply recommended field-annotation-to-feed-info May 18, 2022

KClough changed the title ~~feat: apply recommended field-annotation-to-feed-info~~ feat: add recommended field notice May 18, 2022

KClough force-pushed the feat/recommended-field-notice branch from 440a6ae to cbef9f8 Compare May 20, 2022 04:09

maximearmstrong mentioned this pull request May 26, 2022

feat: recommended annotation #1149

Merged

3 tasks

KClough marked this pull request as draft June 24, 2022 00:12

KClough force-pushed the feat/recommended-field-notice branch from cbef9f8 to 3b2cef9 Compare June 24, 2022 01:18

KClough requested a review from maximearmstrong June 24, 2022 01:48

KClough marked this pull request as ready for review June 24, 2022 01:48

KClough marked this pull request as draft June 24, 2022 01:52

KClough force-pushed the feat/recommended-field-notice branch 2 times, most recently from 980541c to 4ee2769 Compare June 24, 2022 02:05

KClough marked this pull request as ready for review June 24, 2022 02:10

maximearmstrong suggested changes Jun 28, 2022

View reviewed changes

maximearmstrong reviewed Jun 28, 2022

View reviewed changes

KClough force-pushed the feat/recommended-field-notice branch from 82edfbb to 3ad06de Compare June 29, 2022 19:42

KClough marked this pull request as draft June 29, 2022 19:43

KClough and others added 3 commits June 29, 2022 16:45

feat: recommended field notice

d9ddb51

chore: apply Jarvus copyright

3263a24

Update core/src/main/java/org/mobilitydata/gtfsvalidator/parsing/RowP…

66dcbd8

…arser.java Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>

KClough force-pushed the feat/recommended-field-notice branch from c7156af to 2330794 Compare June 29, 2022 20:46

KClough marked this pull request as ready for review June 29, 2022 20:47

test: additional row parser tests

507e50d

KClough force-pushed the feat/recommended-field-notice branch from 2330794 to 507e50d Compare June 29, 2022 20:49

maximearmstrong approved these changes Jun 29, 2022

View reviewed changes

maximearmstrong merged commit cc78161 into master Jun 29, 2022

maximearmstrong deleted the feat/recommended-field-notice branch June 29, 2022 21:27

KClough mentioned this pull request Jul 25, 2022

Best Practice: feed_info should include start_date, end_date, version, email, url (WARNING) #885

Closed

takohei mentioned this pull request May 1, 2023

Only warn if feed_contact_email or url are both unset. #1423

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add recommended field notice #1157

feat: add recommended field notice #1157

KClough commented May 18, 2022 •

edited

Loading

github-actions bot commented May 18, 2022

github-actions bot commented May 18, 2022

github-actions bot commented May 20, 2022

github-actions bot commented May 20, 2022

github-actions bot commented Jun 24, 2022

github-actions bot commented Jun 28, 2022

maximearmstrong left a comment

maximearmstrong Jun 28, 2022

maximearmstrong Jun 28, 2022

maximearmstrong Jun 28, 2022

KClough Jun 29, 2022

github-actions bot commented Jun 29, 2022

github-actions bot commented Jun 29, 2022

github-actions bot commented Jun 29, 2022

maximearmstrong left a comment

feat: add recommended field notice #1157

feat: add recommended field notice #1157

Conversation

KClough commented May 18, 2022 • edited Loading

github-actions bot commented May 18, 2022

github-actions bot commented May 18, 2022

Information about source corruption

Acceptance test details

github-actions bot commented May 20, 2022

github-actions bot commented May 20, 2022

Information about source corruption

Acceptance test details

github-actions bot commented Jun 24, 2022

Information about source corruption

Acceptance test details

github-actions bot commented Jun 28, 2022

Information about source corruption

Acceptance test details

maximearmstrong left a comment

Choose a reason for hiding this comment

maximearmstrong Jun 28, 2022

Choose a reason for hiding this comment

maximearmstrong Jun 28, 2022

Choose a reason for hiding this comment

maximearmstrong Jun 28, 2022

Choose a reason for hiding this comment

KClough Jun 29, 2022

Choose a reason for hiding this comment

github-actions bot commented Jun 29, 2022

Information about source corruption

Acceptance test details

github-actions bot commented Jun 29, 2022

github-actions bot commented Jun 29, 2022

Information about source corruption

Acceptance test details

maximearmstrong left a comment

Choose a reason for hiding this comment

KClough commented May 18, 2022 •

edited

Loading