Strings cleaner > remove Line/Station auto

[mmathieum]

• String cleaner > English > route long name -> remove ends with "Line" and stop name -> remove "Station" #20

• JSON configs > add stop_name_cleaners, (exclude|keep)_routes & compat w/ mtransitapps/commons-java#22 parser#43

[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 refines the string cleaning utilities by introducing automated removal of common transit-related terms like 'Line' and 'Station' from various string fields. This cleaning is applied conditionally based on the detected language (English) and, for 'Station', the specific route type (subway or train), with the goal of presenting cleaner and more concise transit information to users.

Highlights

• Visibility Update for Regex Patterns: The LINE and STATION regular expression patterns in CleanUtils.java were updated to be static final, making them accessible for use in other classes.
• Enhanced String Cleaning Functions: The cleanRouteLongName, cleanTripHeadsign, and cleanStopName functions in StringsCleaner.kt were modified to accept a routeType parameter, enabling more context-aware cleaning.
• Automatic 'Line' Removal: Implemented logic to automatically remove the word 'Line' from English route long names, improving conciseness.
• Automatic 'Station' Removal: Implemented logic to automatically remove the word 'Station' from English trip headsigns and stop names, specifically for subway and train route types, when applicable.

Changelog

• src/main/java/org/mtransit/commons/CleanUtils.java
  • Made the LINE regex pattern publicly accessible by changing its modifier to static final.
  • Made the STATION regex pattern publicly accessible by changing its modifier to static final.
• src/main/java/org/mtransit/commons/StringsCleaner.kt
  • Imported StringUtils.EMPTY for use in string replacement operations.
  • Added a routeType parameter to the cleanRouteLongName function.
  • Implemented conditional removal of the word 'Line' from English route long names.
  • Added a routeType parameter to the cleanTripHeadsign function.
  • Implemented conditional removal of the word 'Station' from English trip headsigns for subway and train routes.
  • Added a routeType parameter to the cleanStopName function.
  • Implemented conditional removal of the word 'Station' from English stop names for subway and train routes.

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 aims to clean up route, trip, and stop names by removing 'line' and 'station' keywords under certain conditions. The changes in CleanUtils.java expose necessary patterns for this cleaning. In StringsCleaner.kt, I've identified a couple of areas for improvement. Specifically, I've suggested merging redundant conditional checks in cleanTripHeadsign and pointed out code duplication between cleanTripHeadsign and cleanStopName that could be refactored for better maintainability.