gtfs-to-chart 2.0.12 → 2.1.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.0] - 2025-06-06
+
+### Added
+
+- Support for frequencies.txt
+
 ## [2.0.12] - 2025-02-25
 
 ### Updated

package/app/index.js

@@ -1,6 +1,5 @@
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
-
 import express from 'express';
 import logger from 'morgan';
 import slashes from 'connect-slashes';
@@ -8,61 +7,63 @@ import slashes from 'connect-slashes';
 import routes from './routes.js';
 
 const app = express();
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 // View engine setup
-app.set('views', path.join(fileURLToPath(import.meta.url), '../views'));
+app.set('views', path.join(__dirname, './views'));
 app.set('view engine', 'pug');
 
+// Middleware
 app.use(logger('dev'));
-app.use(express.static(path.join(fileURLToPath(import.meta.url), '../../public')));
+app.use(express.static(path.join(__dirname, '../public')));
 app.use(slashes());
 
+// Routes
 app.use('/', routes);
 
 // Error handlers
-
-// 404 error handler
 app.use((request, response) => {
   const error = {
     message: 'Not Found',
-    status: 404
+    status: 404,
   };
   response.status(404);
   if (request.xhr) {
-    response.send({
+    response.json({
       message: error.message,
-      error
+      error,
     });
   } else {
     response.render('error', {
       message: error.message,
-      error
+      error,
     });
   }
 });
 
 // Development error handler: will print stacktrace
 if (process.env.NODE_ENV === 'development') {
-  app.use((error, request, response) => {
+  app.use((error, request, response, next) => {
     response.status(error.status || 500);
     response.render('error', {
       message: error.message,
-      error
+      error,
     });
   });
 }
 
 // Production error handler: no stacktraces leaked to user
-app.use((error, request, response) => {
+app.use((error, request, response, next) => {
   response.status(error.status || 500);
   response.render('error', {
     message: error.message,
-    error: {}
+    error: {},
   });
 });
 
-app.set('port', process.env.PORT || 3000);
+const port = process.env.PORT || 3000;
+app.set('port', port);
 
-const server = app.listen(app.get('port'), () => {
+const server = app.listen(port, () => {
   console.log(`Express server listening on port ${server.address().port}`);
 });

package/config-sample.json

@@ -5,5 +5,6 @@
       "url": "http://www.bart.gov/dev/schedules/google_transit.zip"
     }
   ],
+  "chartDate": "20250606",
   "sqlitePath": "/tmp/gtfs"
 }

package/lib/utils.js

@@ -1,7 +1,17 @@
 import path from 'node:path';
 import { readFileSync } from 'node:fs';
 
-import { max, map, maxBy, size, every, uniq, groupBy, first, sortBy } from 'lodash-es';
+import {
+  max,
+  map,
+  maxBy,
+  size,
+  every,
+  uniq,
+  groupBy,
+  first,
+  sortBy,
+} from 'lodash-es';
 import { getStops, openDb, getStoptimes, getAgencies, getRoutes } from 'gtfs';
 import sanitize from 'sanitize-filename';
 import moment from 'moment';
@@ -10,7 +20,29 @@ import sqlString from 'sqlstring';
 import { renderTemplate } from './file-utils.js';
 import { formatRouteName } from './formatters.js';
 
-const { version } = JSON.parse(readFileSync(new URL('../package.json', import.meta.url)));
+const { version } = JSON.parse(
+  readFileSync(new URL('../package.json', import.meta.url)),
+);
+
+/*
+ * Convert a GTFS formatted time string into a moment less than 24 hours.
+ */
+export function fromGTFSTime(timeString) {
+  const duration = moment.duration(timeString);
+
+  return moment({
+    hour: duration.hours(),
+    minute: duration.minutes(),
+    second: duration.seconds(),
+  });
+}
+
+/*
+ * Convert a moment into a GTFS formatted time string.
+ */
+export function toGTFSTime(time) {
+  return time.format('HH:mm:ss');
+}
 
 /*
  * Calculate the distance between two coordinates.
@@ -20,17 +52,19 @@ function calculateDistanceMi(lat1, lon1, lat2, lon2) {
     return 0;
   }
 
-  const radlat1 = Math.PI * lat1 / 180;
-  const radlat2 = Math.PI * lat2 / 180;
+  const radlat1 = (Math.PI * lat1) / 180;
+  const radlat2 = (Math.PI * lat2) / 180;
   const theta = lon1 - lon2;
-  const radtheta = Math.PI * theta / 180;
-  let dist = (Math.sin(radlat1) * Math.sin(radlat2)) + (Math.cos(radlat1) * Math.cos(radlat2) * Math.cos(radtheta));
+  const radtheta = (Math.PI * theta) / 180;
+  let dist =
+    Math.sin(radlat1) * Math.sin(radlat2) +
+    Math.cos(radlat1) * Math.cos(radlat2) * Math.cos(radtheta);
   if (dist > 1) {
     dist = 1;
   }
 
   dist = Math.acos(dist);
-  dist = dist * 180 / Math.PI;
+  dist = (dist * 180) / Math.PI;
   dist = dist * 60 * 1.1515;
   return dist;
 }
@@ -42,7 +76,9 @@ const reverseStationDistances = (stations, oppositeDirectionDistance) => {
   const tripDistance = max(map(stations, 'distance'));
   for (const station of stations) {
     // Scale distances to match opposite direction total distance
-    station.distance = (tripDistance - station.distance) * oppositeDirectionDistance / tripDistance;
+    station.distance =
+      ((tripDistance - station.distance) * oppositeDirectionDistance) /
+      tripDistance;
   }
 };
 
@@ -65,7 +101,7 @@ const isTimepoint = (stoptime) => {
 const getStationsFromTrip = (trip) => {
   const stops = trip.stoptimes.map((stoptime) => {
     const stops = getStops({
-      stop_id: stoptime.stop_id
+      stop_id: stoptime.stop_id,
     });
 
     if (stops.length === 0) {
@@ -78,20 +114,29 @@ const getStationsFromTrip = (trip) => {
   let previousStationCoordinates;
   return trip.stoptimes.map((stoptime, index) => {
     const stop = stops[index];
-    const hasShapeDistance = every(trip.stoptimes, (stoptime) => stoptime.shape_dist_traveled !== null);
+    const hasShapeDistance = every(
+      trip.stoptimes,
+      (stoptime) => stoptime.shape_dist_traveled !== null,
+    );
 
     if (!hasShapeDistance) {
       if (index === 0) {
         stoptime.shape_dist_traveled = 0;
       } else {
         const previousStopTime = trip.stoptimes[index - 1];
-        const distanceFromPreviousStation = calculateDistanceMi(stop.stop_lat, stop.stop_lon, previousStationCoordinates.stop_lat, previousStationCoordinates.stop_lon);
-        stoptime.shape_dist_traveled = previousStopTime.shape_dist_traveled + distanceFromPreviousStation;
+        const distanceFromPreviousStation = calculateDistanceMi(
+          stop.stop_lat,
+          stop.stop_lon,
+          previousStationCoordinates.stop_lat,
+          previousStationCoordinates.stop_lon,
+        );
+        stoptime.shape_dist_traveled =
+          previousStopTime.shape_dist_traveled + distanceFromPreviousStation;
       }
 
       previousStationCoordinates = {
         stop_lat: stop.stop_lat,
-        stop_lon: stop.stop_lon
+        stop_lon: stop.stop_lon,
       };
     }
 
@@ -99,7 +144,7 @@ const getStationsFromTrip = (trip) => {
       stop_id: stop.stop_id,
       name: stop.stop_name,
       distance: stoptime.shape_dist_traveled,
-      direction_id: trip.direction_id
+      direction_id: trip.direction_id,
     };
   });
 };
@@ -110,20 +155,32 @@ const getStationsFromTrip = (trip) => {
 const getDataforChart = (config, routeId) => {
   const db = openDb(config);
   const notes = [];
-  const dayOfWeek = moment(config.chartDate, 'YYYYMMDD').format('dddd').toLowerCase();
-  const calendars = db.prepare(`SELECT DISTINCT service_id FROM calendar WHERE start_date <= $date AND end_date >= $date AND ${sqlString.escapeId(dayOfWeek)} = 1`).all({ date: config.chartDate });
+  const dayOfWeek = moment(config.chartDate, 'YYYYMMDD')
+    .format('dddd')
+    .toLowerCase();
+  const calendars = db
+    .prepare(
+      `SELECT DISTINCT service_id FROM calendar WHERE start_date <= $date AND end_date >= $date AND ${sqlString.escapeId(dayOfWeek)} = 1`,
+    )
+    .all({ date: config.chartDate });
 
   if (calendars.length === 0) {
-    throw new Error(`No calendars found for route ${routeId} on ${moment(config.chartDate, 'YYYYMMDD').format('MMM D, YYYY')}`);
+    throw new Error(
+      `No calendars found for route ${routeId} on ${moment(config.chartDate, 'YYYYMMDD').format('MMM D, YYYY')}. Try changing the chartDate in your config.json file to a date that has service.`,
+    );
   }
 
   const serviceIds = calendars.map((calendar) => calendar.service_id);
-  const trips = db.prepare(`SELECT service_id, trip_id, trip_headsign, direction_id, shape_id FROM trips where route_id = ? AND service_id IN (${serviceIds.map(() => '?').join(', ')})`).all(
-    routeId,
-    ...serviceIds);
+  let trips = db
+    .prepare(
+      `SELECT service_id, trip_id, trip_headsign, direction_id, shape_id FROM trips where route_id = ? AND service_id IN (${serviceIds.map(() => '?').join(', ')})`,
+    )
+    .all(routeId, ...serviceIds);
 
   if (trips.length === 0) {
-    throw new Error(`No trips found for route ${routeId} on ${moment(config.chartDate, 'YYYYMMDD').format('MMM D, YYYY')}`);
+    throw new Error(
+      `No trips found for route ${routeId} on ${moment(config.chartDate, 'YYYYMMDD').format('MMM D, YYYY')}`,
+    );
   }
 
   const shapeIds = uniq(map(trips, 'shape_id'));
@@ -135,23 +192,83 @@ const getDataforChart = (config, routeId) => {
   for (const trip of trips) {
     const stoptimes = getStoptimes(
       {
-        trip_id: trip.trip_id
+        trip_id: trip.trip_id,
       },
       [
         'arrival_time',
         'departure_time',
         'stop_id',
         'shape_dist_traveled',
-        'timepoint'
+        'timepoint',
       ],
-      [
-        ['stop_sequence', 'ASC']
-      ]
+      [['stop_sequence', 'ASC']],
     );
 
     trip.stoptimes = stoptimes.filter((stoptime) => isTimepoint(stoptime));
   }
 
+  const frequencies = db
+    .prepare(
+      `SELECT * FROM frequencies WHERE trip_id IN (${trips.map((trip) => '?').join(', ')})`,
+    )
+    .all(...trips.map((trip) => trip.trip_id));
+
+  // Create trips from frequencies.txt
+  if (frequencies.length > 0) {
+    for (const frequency of frequencies) {
+      const exampleTrip = trips.find(
+        (trip) => trip.trip_id === frequency.trip_id,
+      );
+      if (!exampleTrip) {
+        console.log(`No example trip found for frequency ${frequency.trip_id}`);
+        continue;
+      }
+
+      const stoptimesOffsets = exampleTrip.stoptimes.map((stoptime, index) => ({
+        departure_offset: fromGTFSTime(stoptime.departure_time).diff(
+          fromGTFSTime(exampleTrip.stoptimes[0].departure_time),
+          'seconds',
+        ),
+        arrival_offset: fromGTFSTime(stoptime.arrival_time).diff(
+          fromGTFSTime(exampleTrip.stoptimes[0].arrival_time),
+          'seconds',
+        ),
+      }));
+
+      for (
+        let offset = 0;
+        fromGTFSTime(frequency.start_time)
+          .add(offset, 'seconds')
+          .isBefore(fromGTFSTime(frequency.end_time));
+        offset += frequency.headway_secs
+      ) {
+        trips.push({
+          ...exampleTrip,
+          trip_id: `${exampleTrip.trip_id}_${toGTFSTime(fromGTFSTime(frequency.start_time).add(offset, 'seconds'))}`,
+          stoptimes: exampleTrip.stoptimes.map((stoptime, index) => ({
+            ...stoptime,
+            arrival_time: toGTFSTime(
+              fromGTFSTime(frequency.start_time)
+                .add(offset, 'seconds')
+                .add(stoptimesOffsets[index].arrival_offset, 'seconds'),
+            ),
+            departure_time: toGTFSTime(
+              fromGTFSTime(frequency.start_time)
+                .add(offset, 'seconds')
+                .add(stoptimesOffsets[index].departure_offset, 'seconds'),
+            ),
+          })),
+        });
+      }
+    }
+
+    // Remove the example trips from the trips array
+    trips = trips.filter(
+      (trip) =>
+        !frequencies.some((frequency) => frequency.trip_id === trip.trip_id),
+    );
+  }
+
   const longestTrip = findLongestTrip(trips);
   let stations = getStationsFromTrip(longestTrip);
   const tripDistance = max(map(stations, 'distance'));
@@ -160,15 +277,22 @@ const getDataforChart = (config, routeId) => {
   // If there are two directions, get stops in other direction
   if (size(directionGroups) > 1) {
     const oppositeDirection = longestTrip.direction_id === 1 ? '0' : '1';
-    const longestTripOppositeDirection = findLongestTrip(directionGroups[oppositeDirection]);
-    const stationsOppositeDirection = getStationsFromTrip(longestTripOppositeDirection);
+    const longestTripOppositeDirection = findLongestTrip(
+      directionGroups[oppositeDirection],
+    );
+    const stationsOppositeDirection = getStationsFromTrip(
+      longestTripOppositeDirection,
+    );
 
     reverseStationDistances(stationsOppositeDirection, tripDistance);
 
     stations = [...stations, ...stationsOppositeDirection];
   }
 
-  const hasShapeDistance = every(longestTrip.stoptimes, (stoptime) => stoptime.shape_dist_traveled !== null);
+  const hasShapeDistance = every(
+    longestTrip.stoptimes,
+    (stoptime) => stoptime.shape_dist_traveled !== null,
+  );
   if (!hasShapeDistance) {
     notes.push('Distance between stops calculated assuming a straight line.');
   }
@@ -176,7 +300,7 @@ const getDataforChart = (config, routeId) => {
   return {
     trips,
     stations,
-    notes
+    notes,
   };
 };
 
@@ -188,7 +312,7 @@ export function setDefaultConfig(initialConfig) {
     beautify: false,
     gtfsToChartVersion: version,
     chartDate: moment().format('YYYYMMDD'),
-    skipImport: false
+    skipImport: false,
   };
 
   return { ...defaults, ...initialConfig };
@@ -206,13 +330,15 @@ export async function generateOverviewHTML(config, routes) {
   const agency = first(agencies);
 
   for (const route of routes) {
-    route.relativePath = config.isLocal ? path.join('charts', sanitize(route.route_id)) : path.join('charts', sanitize(`${formatRouteName(route)}.html`));
+    route.relativePath = config.isLocal
+      ? path.join('charts', sanitize(route.route_id))
+      : path.join('charts', sanitize(`${formatRouteName(route)}.html`));
   }
 
   const templateVars = {
     agency,
     config,
-    routes: sortBy(routes, (r) => Number.parseInt(r.route_short_name, 10))
+    routes: sortBy(routes, (r) => Number.parseInt(r.route_short_name, 10)),
   };
   return renderTemplate('overview_page', templateVars, config);
 }
@@ -222,7 +348,7 @@ export async function generateOverviewHTML(config, routes) {
  */
 export async function generateChartHTML(config, routeId) {
   const routes = getRoutes({
-    route_id: routeId
+    route_id: routeId,
   });
 
   if (routes.length === 0) {
@@ -231,10 +357,14 @@ export async function generateChartHTML(config, routeId) {
 
   const chartData = getDataforChart(config, routeId);
 
-  return renderTemplate('chart_page', {
-    route: routes[0],
-    chartData,
+  return renderTemplate(
+    'chart_page',
+    {
+      route: routes[0],
+      chartData,
+      config,
+      moment,
+    },
     config,
-    moment
-  }, config);
+  );
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs-to-chart",
-  "version": "2.0.12",
+  "version": "2.1.0",
   "private": false,
   "description": "Generate stringline charts of a transit routes from GTFS",
   "keywords": [
@@ -32,9 +32,9 @@
     "better-copy": "^1.0.4",
     "chalk": "^5.4.1",
     "connect-slashes": "^1.4.0",
-    "express": "^4.21.2",
-    "gtfs": "^4.15.15",
-    "js-beautify": "^1.15.3",
+    "express": "^5.1.0",
+    "gtfs": "^4.17.4",
+    "js-beautify": "^1.15.4",
     "lodash-es": "^4.17.21",
     "moment": "^2.30.1",
     "morgan": "^1.10.0",
@@ -45,12 +45,12 @@
     "sqlstring": "^2.3.3",
     "timer-machine": "^1.1.0",
     "untildify": "^5.0.0",
-    "yargs": "^17.7.2"
+    "yargs": "^18.0.0"
   },
   "devDependencies": {
     "husky": "^9.1.7",
-    "lint-staged": "^15.4.3",
-    "prettier": "^3.5.2"
+    "lint-staged": "^16.1.0",
+    "prettier": "^3.5.3"
   },
   "engines": {
     "node": ">= 20.11.0"