From cf27135daba0a42e5e54d1a32d7164a4512790af Mon Sep 17 00:00:00 2001
From: Leonard Ehrenfried <mail@leonard.io>
Date: Sun, 8 Dec 2024 22:30:48 +0100
Subject: [PATCH] Set bogus name to false when updating a StreetEdge's name

---
 .../opentripplanner/street/model/edge/Edge.java    | 12 +++++++-----
 .../street/model/edge/StreetEdge.java              | 14 +++++++++-----
 .../module/osm/naming/SidewalkNamerTest.java       |  1 +
 .../mapping/StatesToWalkStepsMapperTest.java       |  6 +++---
 4 files changed, 20 insertions(+), 13 deletions(-)

diff --git a/application/src/main/java/org/opentripplanner/street/model/edge/Edge.java b/application/src/main/java/org/opentripplanner/street/model/edge/Edge.java
index 31bff5b1e15..8e4126b4e59 100644
--- a/application/src/main/java/org/opentripplanner/street/model/edge/Edge.java
+++ b/application/src/main/java/org/opentripplanner/street/model/edge/Edge.java
@@ -145,15 +145,17 @@ public String getDefaultName() {
    */
   public abstract I18NString getName();
 
-  // TODO Add comments about what a "bogus name" is.
+  /**
+   * Returns true if this edge has a generated name that is derived from its properties,
+   * like "path", "stairs" or "tunnel".
+   * <p>
+   * Returns false if the field reflects the real world name, like "Fifth Avenue",
+   * "Hauptstraße" or "Øvre Holmegate".
+   */
   public boolean hasBogusName() {
     return false;
   }
 
-  // The next few functions used to live in EdgeNarrative, which has now been
-  // removed
-  // @author mattwigway
-
   public LineString getGeometry() {
     return null;
   }
diff --git a/application/src/main/java/org/opentripplanner/street/model/edge/StreetEdge.java b/application/src/main/java/org/opentripplanner/street/model/edge/StreetEdge.java
index ee24e87f07c..468da359e0a 100644
--- a/application/src/main/java/org/opentripplanner/street/model/edge/StreetEdge.java
+++ b/application/src/main/java/org/opentripplanner/street/model/edge/StreetEdge.java
@@ -9,9 +9,6 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
-import java.util.Set;
-import java.util.stream.Stream;
-import javax.annotation.Nullable;
 import org.locationtech.jts.geom.LineString;
 import org.locationtech.jts.geom.impl.PackedCoordinateSequence;
 import org.opentripplanner.framework.geometry.CompactLineStringUtils;
@@ -82,14 +79,14 @@ public class StreetEdge
 
   /**
    * bicycleSafetyWeight = length * bicycleSafetyFactor. For example, a 100m street with a safety
-   * factor of 2.0 will be considered in term of safety cost as the same as a 200m street with a
+   * factor of 2.0 will be considered in terms of safety cost as the same as a 200m street with a
    * safety factor of 1.0.
    */
   private float bicycleSafetyFactor;
 
   /**
    * walkSafetyFactor = length * walkSafetyFactor. For example, a 100m street with a safety
-   * factor of 2.0 will be considered in term of safety cost as the same as a 200m street with a
+   * factor of 2.0 will be considered in terms of safety cost as the same as a 200m street with a
    * safety factor of 1.0.
    */
   private float walkSafetyFactor;
@@ -446,8 +443,15 @@ public I18NString getName() {
     return this.name;
   }
 
+  /**
+   * Update the name of the edge after it has been constructed. This method also sets the bogusName
+   * property to false, indicating to the code that maps from edges to steps that this is a real
+   * street name.
+   * @see Edge#hasBogusName()
+   */
   public void setName(I18NString name) {
     this.name = name;
+    this.flags = BitSetUtils.set(flags, HASBOGUSNAME_FLAG_INDEX, false);
   }
 
   public boolean hasBogusName() {
diff --git a/application/src/test/java/org/opentripplanner/graph_builder/module/osm/naming/SidewalkNamerTest.java b/application/src/test/java/org/opentripplanner/graph_builder/module/osm/naming/SidewalkNamerTest.java
index 465eeb32ba2..cbfb7b76c6f 100644
--- a/application/src/test/java/org/opentripplanner/graph_builder/module/osm/naming/SidewalkNamerTest.java
+++ b/application/src/test/java/org/opentripplanner/graph_builder/module/osm/naming/SidewalkNamerTest.java
@@ -58,6 +58,7 @@ void postprocess() {
     assertNotEquals(sidewalk.edge.getName(), pryorStreet.edge.getName());
     builder.postProcess(new SidewalkNamer());
     assertEquals(sidewalk.edge.getName(), pryorStreet.edge.getName());
+    assertFalse(sidewalk.edge.hasBogusName());
   }
 
   private static class ModelBuilder {
diff --git a/application/src/test/java/org/opentripplanner/routing/algorithm/mapping/StatesToWalkStepsMapperTest.java b/application/src/test/java/org/opentripplanner/routing/algorithm/mapping/StatesToWalkStepsMapperTest.java
index 6e41f6ddf2b..de9fe21718a 100644
--- a/application/src/test/java/org/opentripplanner/routing/algorithm/mapping/StatesToWalkStepsMapperTest.java
+++ b/application/src/test/java/org/opentripplanner/routing/algorithm/mapping/StatesToWalkStepsMapperTest.java
@@ -42,7 +42,7 @@ void enterStation() {
     var walkSteps = buildWalkSteps(builder);
     assertEquals(2, walkSteps.size());
     var enter = walkSteps.get(1);
-    assertEquals(enter.getRelativeDirection(), ENTER_STATION);
+    assertEquals(ENTER_STATION, enter.getRelativeDirection());
   }
 
   @Test
@@ -54,7 +54,7 @@ void exitStation() {
     var walkSteps = buildWalkSteps(builder);
     assertEquals(3, walkSteps.size());
     var enter = walkSteps.get(2);
-    assertEquals(enter.getRelativeDirection(), EXIT_STATION);
+    assertEquals(EXIT_STATION, enter.getRelativeDirection());
   }
 
   @Test
@@ -64,7 +64,7 @@ void signpostedPathway() {
     var walkSteps = buildWalkSteps(builder);
     assertEquals(2, walkSteps.size());
     var step = walkSteps.get(1);
-    assertEquals(step.getRelativeDirection(), FOLLOW_SIGNS);
+    assertEquals(FOLLOW_SIGNS, step.getRelativeDirection());
     assertEquals(sign, step.getDirectionText().toString());
   }