JSON config > Add use_stop_id_for_stop_code & "is_word" FR cleaner

[mmathieum]

No description provided.

[Copilot]

Pull request overview

Adds a new JSON-configurable option to derive stop codes from GTFS stop_id, and updates string-cleaner behavior to use language-aware “word” cleaning (French vs non-French) by threading a Locale into RouteConfig cleaning APIs.

Changes:

• Add use_stop_id_for_stop_code (opt-in) to RouteConfig and use it in DefaultAgencyTools.getStopCode().
• Update RouteConfig cleaning entry points to accept a Locale, and route word-cleaning through a French-specific path when applicable.
• Update DefaultAgencyTools to pass the agency’s first language into RouteConfig cleaning calls.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
src/main/java/org/mtransit/parser/config/gtfs/data/RouteConfig.kt	Adds new stop-code config and makes cleaner logic language-aware for is_word replacements.
src/main/java/org/mtransit/parser/DefaultAgencyTools.java	Passes Locale into RouteConfig cleaning methods and applies the new stop-code selection behavior.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the GTFS parsing configuration by introducing a new option to use stop IDs as stop codes, which can be beneficial for agencies with specific data structures. Additionally, it significantly improves the string cleaning mechanism by making it language-aware, starting with a dedicated cleaner for French words. These changes provide greater flexibility and accuracy in processing and presenting transit data.

Highlights

• Stop Code Configuration: Introduced a new configuration option use_stop_id_for_stop_code which allows the system to use the GTFS stop ID as the stop code, providing more flexibility in data processing.
• Language-Aware String Cleaning: Enhanced various string cleaning functions (for route short names, long names, trip headsigns, direction headsigns, and stop names) to accept a Locale parameter, enabling language-specific cleaning rules.
• French Word Cleaner: Implemented a specific word cleaning utility (CleanUtils.cleanWordsFR) for French language strings within the isWord cleaning operations, improving the accuracy of text processing for French content.

Changelog

• src/main/java/org/mtransit/parser/DefaultAgencyTools.java
  • Updated cleanRouteShortName, cleanRouteLongName, cleanTripHeadsign, cleanDirectionHeadsign, and cleanStopName methods to pass the detected language locale to the configuration's cleaning functions.
  • Modified the getStopCode method to conditionally use the stop ID instead of the stop code based on the new use_stop_id_for_stop_code configuration setting.
• src/main/java/org/mtransit/parser/config/gtfs/data/RouteConfig.kt
  • Added java.util.Locale import.
  • Introduced a new boolean property useStopIdForStopCode to the RouteConfig data class, enabling the use of stop IDs for stop codes.
  • Modified cleanRouteShortName, cleanRouteLongName, cleanTripHeadsign, cleanStopName, cleanDirectionHeadsign, and the internal cleanString methods to accept a Locale parameter.
  • Implemented language-specific logic within the cleanString method to apply CleanUtils.cleanWordsFR when the provided locale is French for word-based cleaning operations.

Activity

• No activity has been recorded for this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces language-aware string cleaning for various route and stop-related names and adds a new configuration option for stop code generation. The DefaultAgencyTools.java file was updated to pass the Locale to cleanRouteShortName, cleanRouteLongName, cleanTripHeadsign, cleanDirectionHeadsign, and cleanStopName methods. Correspondingly, RouteConfig.kt was modified to accept a Locale in these cleaning methods and its internal cleanString helper, enabling language-specific word cleaning (e.g., for French). Additionally, a new useStopIdForStopCode boolean property was added to RouteConfig.kt, allowing the getStopCode method in DefaultAgencyTools.java to optionally use a stop's ID as its code.