Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better Route Search Remark #182

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 138 additions & 7 deletions src/components/route-board/RouteTerminus.tsx
Original file line number Diff line number Diff line change
@@ -1,28 +1,159 @@
import { useContext, useMemo } from "react";
import { useTranslation } from "react-i18next";
import { Box, SxProps, Theme, Typography } from "@mui/material";
import { toProperCase } from "../../utils";
import { RouteListEntry } from "hk-bus-eta";
import useLanguage from "../../hooks/useTranslation";
import DbContext from "../../context/DbContext";

interface RouteTerminus {
terminus: RouteListEntry;
}

const RouteTerminus = ({ terminus }: RouteTerminus) => {
const { t } = useTranslation();
const language = useLanguage();
const { t, i18n } = useTranslation();
const {
db: { routeList, stopList },
} = useContext(DbContext);
const { route, co, orig, dest, stops, bound, gtfsId } = terminus;

const firstLastDiff = (arr: string[]) => {
if (arr.length < 2) return arr;
return [arr[0], arr[arr.length - 1]];
};
const diffConsecutive = (array: string[], sequence: string[]) => {
for (let i = 0; i <= array.length - sequence.length; i++) {
let j;
for (j = 0; j < sequence.length; j++) {
if (array[i + j] !== sequence[j]) {
break;
}
}
if (j === sequence.length) {
return true;
}
}
return false;
};

let routeRemark = useMemo(() => {
let remark = "";
if (Number(terminus.serviceType) >= 2) {
for (let [, data] of Object.entries(routeList)) {
if (
Number(data.serviceType) === 1 &&
route === data.route &&
JSON.stringify(bound) === JSON.stringify(data.bound) &&
(co[0] === "gmb"
? gtfsId === data.gtfsId
: JSON.stringify(co) === JSON.stringify(data.co))
) {
if (
stopList[data.stops[co[0]][data.stops[co[0]].length - 1]].name
.zh !== stopList[stops[co[0]][stops[co[0]].length - 1]].name.zh
) {
remark = t("開往") + dest[i18n.language];
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use optional chaining to safely access properties.

- remark = t("開往") + dest[i18n.language];
- remark = t("從") + orig[i18n.language] + t("開出");
+ remark = t("開往") + dest?.[i18n.language];
+ remark = t("從") + orig?.[i18n.language] + t("開出");

Ensure that the code does not throw runtime errors when the language key is not found in the dest or orig objects.

Also applies to: 60-60, 70-70, 73-73

} else if (
stopList[data.stops[co[0]][0]].name.zh !==
stopList[stops[co[0]][0]].name.zh
) {
if (!terminus.nlbId) {
remark = t("從") + orig[i18n.language] + t("開出");
}
} else {
let mainRouteFirstStop = stopList[data.stops[co][0]].name;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Address the issue where Company[] type cannot be used as an index type.

Consider using a different approach to index or retrieve data from these arrays, as direct indexing with a type that is not supported will lead to runtime errors.

Also applies to: 65-65, 66-66, 67-67

Tools
GitHub Check: build (21.x)

[failure] 63-63:
Type 'Company[]' cannot be used as an index type.

GitHub Check: build (20.x)

[failure] 63-63:
Type 'Company[]' cannot be used as an index type.

let mainRouteLastStop =
stopList[data.stops[co[0]][data.stops[co[0]].length - 1]].name;
let routeFirstStop = stopList[stops[co[0]][0]].name;
let routeLastStop =
stopList[stops[co[0]][stops[co[0]].length - 1]].name;

if (mainRouteLastStop.zh !== routeLastStop.zh) {
remark = t("開往") + routeLastStop[i18n.language];
} else if (mainRouteFirstStop.zh !== routeFirstStop.zh) {
if (!terminus.nlbId) {
remark = t("從") + routeFirstStop[i18n.language] + t("開出");
}
} else {
let difference = stops[co[0]].filter(
(x) => !data.stops[co[0]].includes(x)
);
let diffName = difference.map(
(x) => stopList[x].name[i18n.language]
);
if (difference.length > 0) {
remark =
t("經") +
firstLastDiff(diffName).join(
t(
diffConsecutive(data.stops[co[0]], difference)
? "至"
: "及"
)
);
} else {
let difference = data.stops[co[0]].filter(
(x) => !stops[co[0]].includes(x)
);
let diffName = difference.map(
(x) => stopList[x].name[i18n.language]
);
if (difference.length > 0) {
remark =
t("不經") +
firstLastDiff(diffName).join(
t(
diffConsecutive(data.stops[co[0]], difference)
? "至"
: "及"
)
);
}
}
}
}
break;
}
}
}
remark =
t("從") +
toProperCase(terminus.orig[i18n.language]) +
t("開出") +
" " +
remark;
return remark;
}, [
terminus,
routeList,
i18n.language,
bound,
co,
dest,
gtfsId,
orig,
route,
stopList,
stops,
t,
]);
Comment on lines +38 to +138
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The memoization of routeRemark is implemented to enhance performance.

However, the complexity of this function is quite high due to multiple nested conditions and loops. Consider refactoring to simplify logic and improve readability.

- let remark = "";
- // existing complex logic
+ const remark = generateRemark(terminus, routeList, stopList, co, i18n);

Create a separate function generateRemark to handle the remark generation logic.

Committable suggestion was skipped due to low confidence.


return (
<Box sx={rootSx}>
<Box sx={fromToWrapperSx}>
<span>{`${t("往")} `}</span>
<Typography component="h3" variant="h6" sx={destinationSx}>
{toProperCase(terminus.dest[language])}
<Typography
component="h3"
variant="h6"
sx={destinationSx}
textOverflow="ellipsis"
overflow="hidden"
>
{toProperCase(terminus.dest[i18n.language])}
</Typography>
</Box>
<Box sx={fromWrapperSx}>
<Typography variant="body2">
{toProperCase(terminus.orig[language])}
<Typography variant="body2" textOverflow="ellipsis" overflow="hidden">
{routeRemark}
</Typography>
</Box>
</Box>
Expand Down
6 changes: 3 additions & 3 deletions src/components/route-eta/RouteHeader.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { useContext } from "react";
import { Box, Paper, SxProps, Theme, Typography } from "@mui/material";
import RouteNo from "../route-board/RouteNo";
import { toProperCase } from "../../utils";
import { toProperCase, langSpace } from "../../utils";
import { useTranslation } from "react-i18next";
import ReverseButton from "./ReverseButton";
import TimetableButton from "./TimeTableButton";
Expand All @@ -26,8 +26,8 @@ const RouteHeader = ({ routeId, stopId }: RouteHeaderProps) => {
<Paper id="route-eta-header" sx={PaperSx} elevation={0}>
<RouteNo routeNo={t(route)} component="h1" align="center" />
<Typography component="h2" variant="caption" align="center">
{t("往")} {toProperCase(dest[language])}{" "}
{nlbId ? t("由") + " " + toProperCase(orig[language]) : ""}
{`${t("往")}${langSpace(language)}${toProperCase(dest[language])} `}
{nlbId ? `${t("從")}${toProperCase(orig[language])}${t("開出")}` : ""}
</Typography>
<ReverseButton routeId={routeId} stopId={stopId} />
<Box sx={rightBtnGroupSx}>
Expand Down
9 changes: 8 additions & 1 deletion src/i18n/translation.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,14 @@ const resources = {
設定: "Settings",
取消: "Clear",
路線: "Route",
你的位置: "Your Location",
從: "From ",
開出: "",
開往: "To ",
經: "Via ",
不經: "Skipping ",
至: " to ",
及: " and ",
你的位置: "Your location",
目的地: "Destination",
已複製到剪貼簿: "Copied to clipboard",
資料更新中: "Data updating",
Expand Down
4 changes: 4 additions & 0 deletions src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ import type { TransportType } from "./@types/types";
import { ServiceIds, isRouteAvaliable } from "./timetable";
import { TFunction } from "i18next";

export const langSpace = (language) => {
return language === "en" ? " " : "";
};

export const getDistance = (a: GeoLocation, b: GeoLocation) => {
const R = 6371e3; // metres
const φ1 = (a.lat * Math.PI) / 180; // φ, λ in radians
Expand Down