gtfs-to-html 2.5.7 → 2.5.9

package/CHANGELOG.md

@@ -5,6 +5,32 @@ 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.5.9] - 2024-01-24
+
+### Updated
+
+- Move stop markers above map labels
+- Update to Mapbox GL JS v3
+- Dependency updates
+
+### Fixed
+
+- Handle routes with no route_short_name in map marker popups
+
+## [2.5.8] - 2024-01-02
+
+### Fixed
+
+- Improved warning logging
+
+### Added
+
+- Handle case where a calendar_date is both included and excluded
+
+### Updated
+
+- Dependency updates
+
 ## [2.5.7] - 2023-11-07
 
 ### Updated

package/lib/gtfs-to-html.js

@@ -51,7 +51,7 @@ const gtfsToHtml = async (initialConfig) => {
   } catch (error) {
     if (error instanceof Error && error.code === 'SQLITE_CANTOPEN') {
       config.logError(
-        `Unable to open sqlite database "${config.sqlitePath}" defined as \`sqlitePath\` config.json. Ensure the parent directory exists or remove \`sqlitePath\` from config.json.`
+        `Unable to open sqlite database "${config.sqlitePath}" defined as \`sqlitePath\` config.json. Ensure the parent directory exists or remove \`sqlitePath\` from config.json.`,
       );
     }
 
@@ -84,7 +84,7 @@ const gtfsToHtml = async (initialConfig) => {
   const timetablePages = [];
   const timetablePageIds = map(
     getTimetablePagesForAgency(config),
-    'timetable_page_id'
+    'timetable_page_id',
   );
   await prepDirectory(exportPath);
 
@@ -95,7 +95,7 @@ const gtfsToHtml = async (initialConfig) => {
   const bar = progressBar(
     `${agencyKey}: Generating ${config.outputFormat.toUpperCase()} timetables {bar} {value}/{total}`,
     timetablePageIds.length,
-    config
+    config,
   );
 
   /* eslint-disable no-await-in-loop */
@@ -103,15 +103,9 @@ const gtfsToHtml = async (initialConfig) => {
     try {
       const timetablePage = await getFormattedTimetablePage(
         timetablePageId,
-        config
+        config,
       );
 
-      if (timetablePage.consolidatedTimetables.length === 0) {
-        throw new Error(
-          `No timetables found for timetable_page_id=${timetablePage.timetable_page_id}`
-        );
-      }
-
       for (const timetable of timetablePage.timetables) {
         for (const warning of timetable.warnings) {
           outputStats.warnings.push(warning);
@@ -119,6 +113,12 @@ const gtfsToHtml = async (initialConfig) => {
         }
       }
 
+      if (timetablePage.consolidatedTimetables.length === 0) {
+        throw new Error(
+          `No timetables found for timetable_page_id=${timetablePage.timetable_page_id}`,
+        );
+      }
+
       outputStats.timetables += timetablePage.consolidatedTimetables.length;
       outputStats.timetablePages += 1;
 
@@ -130,7 +130,7 @@ const gtfsToHtml = async (initialConfig) => {
 
       timetablePage.relativePath = path.join(
         datePath,
-        sanitize(timetablePage.filename)
+        sanitize(timetablePage.filename),
       );
 
       if (config.outputFormat === 'csv') {
@@ -139,7 +139,7 @@ const gtfsToHtml = async (initialConfig) => {
           const csvPath = path.join(
             exportPath,
             datePath,
-            generateCSVFileName(timetable, timetablePage)
+            generateCSVFileName(timetable, timetablePage),
           );
           await writeFile(csvPath, csv);
         }
@@ -148,7 +148,7 @@ const gtfsToHtml = async (initialConfig) => {
         const htmlPath = path.join(
           exportPath,
           datePath,
-          sanitize(timetablePage.filename)
+          sanitize(timetablePage.filename),
         );
         await writeFile(htmlPath, html);
 
@@ -192,19 +192,19 @@ const gtfsToHtml = async (initialConfig) => {
 
   const fullExportPath = path.join(
     exportPath,
-    config.zipOutput ? '/timetables.zip' : ''
+    config.zipOutput ? '/timetables.zip' : '',
   );
 
   // Print stats
   config.log(
-    `${agencyKey}: ${config.outputFormat.toUpperCase()} timetables created at ${fullExportPath}`
+    `${agencyKey}: ${config.outputFormat.toUpperCase()} timetables created at ${fullExportPath}`,
   );
 
   logStats(outputStats, config);
 
   const seconds = Math.round(timer.time() / 1000);
   config.log(
-    `${agencyKey}: ${config.outputFormat.toUpperCase()} timetable generation required ${seconds} seconds`
+    `${agencyKey}: ${config.outputFormat.toUpperCase()} timetable generation required ${seconds} seconds`,
   );
 
   timer.stop();

package/lib/log-utils.js

@@ -110,7 +110,7 @@ export function formatError(error) {
   const messageText = error instanceof Error ? error.message : error;
   const errorMessage = `${colors.underline('Error')}: ${messageText.replace(
     'Error: ',
-    ''
+    '',
   )}`;
   return colors.red(errorMessage);
 }
@@ -136,7 +136,7 @@ export function logStats(stats, config) {
     ['🔄 Routes', stats.routes],
     ['🚍 Trips', stats.trips],
     ['🛑 Stops', stats.stops],
-    ['⛔️ Warnings', stats.warnings.length]
+    ['⛔️ Warnings', stats.warnings.length],
   );
 
   config.log(table.toString());
@@ -209,7 +209,7 @@ export function progressBar(formatString, barTotal, config) {
     interrupt(text) {
       // Log two lines to avoid overwrite by progress bar
       config.logWarning(text);
-      config.logWarning('');
+      config.log('');
     },
     increment() {
       barProgress += 1;

package/lib/utils.js

@@ -292,26 +292,32 @@ const getCalendarDatesForTimetable = (timetable, config) => {
   );
   const start = fromGTFSDate(timetable.start_date);
   const end = fromGTFSDate(timetable.end_date);
-  const filteredCalendarDates = {
-    excludedDates: [],
-    includedDates: [],
-  };
+  const excludedDates = [];
+  const includedDates = [];
 
   for (const calendarDate of calendarDates) {
     if (moment(calendarDate.date, 'YYYYMMDD').isBetween(start, end)) {
       if (calendarDate.exception_type === 1) {
-        filteredCalendarDates.includedDates.push(
-          formatDate(calendarDate, config.dateFormat),
-        );
+        includedDates.push(formatDate(calendarDate, config.dateFormat));
       } else if (calendarDate.exception_type === 2) {
-        filteredCalendarDates.excludedDates.push(
-          formatDate(calendarDate, config.dateFormat),
-        );
+        excludedDates.push(formatDate(calendarDate, config.dateFormat));
       }
     }
   }
 
-  return filteredCalendarDates;
+  // Remove dates that are both included and excluded from both lists
+  const includedAndExcludedDates = excludedDates.filter((date) =>
+    includedDates.includes(date),
+  );
+
+  return {
+    excludedDates: excludedDates.filter(
+      (date) => !includedAndExcludedDates.includes(date),
+    ),
+    includedDates: includedDates.filter(
+      (date) => !includedAndExcludedDates.includes(date),
+    ),
+  };
 };
 
 /*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs-to-html",
-  "version": "2.5.7",
+  "version": "2.5.9",
   "private": false,
   "description": "Build human readable transit timetables as HTML, PDF or CSV from GTFS",
   "keywords": [
@@ -40,16 +40,16 @@
     "archiver": "^6.0.1",
     "cli-table": "^0.3.11",
     "copy-dir": "^1.3.0",
-    "csv-stringify": "^6.4.4",
+    "csv-stringify": "^6.4.5",
     "express": "^4.18.2",
-    "gtfs": "^4.5.0",
+    "gtfs": "^4.6.0",
     "js-beautify": "^1.14.11",
     "lodash-es": "^4.17.21",
-    "moment": "^2.29.4",
+    "moment": "^2.30.1",
     "morgan": "^1.10.0",
     "pretty-error": "^4.0.0",
     "pug": "^3.0.2",
-    "puppeteer": "^21.5.0",
+    "puppeteer": "^21.9.0",
     "sanitize-filename": "^1.6.3",
     "sqlstring": "^2.3.3",
     "timer-machine": "^1.1.0",
@@ -60,8 +60,8 @@
   },
   "devDependencies": {
     "husky": "^8.0.3",
-    "lint-staged": "^15.0.2",
-    "prettier": "^3.0.3"
+    "lint-staged": "^15.2.0",
+    "prettier": "^3.2.4"
   },
   "engines": {
     "node": ">= 18.0.0"

package/public/js/system-map.js

@@ -3,6 +3,17 @@
 
 const maps = {};
 
+function formatRouteName(route) {
+  let routeName = '';
+  if (route.route_short_name !== undefined) {
+    routeName += route.route_short_name;
+  } else if (route.route_long_name !== undefined) {
+    routeName += route.route_long_name;
+  }
+
+  return routeName;
+}
+
 function formatRoute(route) {
   const html = route.route_url
     ? $('<a>').attr('href', route.route_url)
@@ -17,9 +28,7 @@ function formatRoute(route) {
       .appendTo(html);
   }
 
-  $('<span>')
-    .text(`${route.route_short_name} ${route.route_long_name}`)
-    .appendTo(html);
+  $('<span>').text(formatRouteName(route)).appendTo(html);
 
   return html.prop('outerHTML');
 }
@@ -107,10 +116,10 @@ function createSystemMap(id, geojson) {
       duration: 0,
     });
 
-    // Turn of Points of Interest labels
+    // Turn off Points of Interest labels
     map.setLayoutProperty('poi-label', 'visibility', 'none');
 
-    // Find the index of the first symbol layer in the map style
+    // Find the index of the first symbol layer in the map style to put the route lines underneath
     let firstSymbolId;
     for (const layer of map.getStyle().layers) {
       if (layer.type === 'symbol') {
@@ -149,7 +158,7 @@ function createSystemMap(id, geojson) {
         layout: lineLayout,
         filter: ['!has', 'stop_id'],
       },
-      firstSymbolId
+      firstSymbolId,
     );
 
     // Add highlighted route drop shadow outlines next
@@ -182,7 +191,7 @@ function createSystemMap(id, geojson) {
         layout: lineLayout,
         filter: ['==', ['get', 'route_id'], 'none'],
       },
-      firstSymbolId
+      firstSymbolId,
     );
 
     // Add white outlines to routes next
@@ -208,7 +217,7 @@ function createSystemMap(id, geojson) {
         layout: lineLayout,
         filter: ['has', 'route_id'],
       },
-      firstSymbolId
+      firstSymbolId,
     );
 
     // Add highlighted route white outlines next
@@ -234,7 +243,7 @@ function createSystemMap(id, geojson) {
         layout: lineLayout,
         filter: ['==', ['get', 'route_id'], 'none'],
       },
-      firstSymbolId
+      firstSymbolId,
     );
 
     // Add route lines next
@@ -260,7 +269,7 @@ function createSystemMap(id, geojson) {
         layout: lineLayout,
         filter: ['has', 'route_id'],
       },
-      firstSymbolId
+      firstSymbolId,
     );
 
     // Add highlighted route lines next
@@ -286,96 +295,74 @@ function createSystemMap(id, geojson) {
         layout: lineLayout,
         filter: ['==', ['get', 'route_id'], 'none'],
       },
-      firstSymbolId
+      firstSymbolId,
     );
 
     // Add stops when zoomed in
-    map.addLayer(
-      {
-        id: 'stops',
-        type: 'circle',
-        source: {
-          type: 'geojson',
-          data: geojson,
-        },
-        paint: {
-          'circle-color': '#fff',
-          'circle-radius': {
-            base: 1.75,
-            stops: [
-              [12, 4],
-              [22, 100],
-            ],
-          },
-          'circle-stroke-color': '#3F4A5C',
-          'circle-stroke-width': 2,
-          'circle-opacity': [
-            'interpolate',
-            ['linear'],
-            ['zoom'],
-            13,
-            0,
-            13.5,
-            1,
-          ],
-          'circle-stroke-opacity': [
-            'interpolate',
-            ['linear'],
-            ['zoom'],
-            13,
-            0,
-            13.5,
-            1,
+    map.addLayer({
+      id: 'stops',
+      type: 'circle',
+      source: {
+        type: 'geojson',
+        data: geojson,
+      },
+      paint: {
+        'circle-color': '#fff',
+        'circle-radius': {
+          base: 1.75,
+          stops: [
+            [12, 4],
+            [22, 100],
           ],
         },
-        filter: ['has', 'stop_id'],
+        'circle-stroke-color': '#3F4A5C',
+        'circle-stroke-width': 2,
+        'circle-opacity': ['interpolate', ['linear'], ['zoom'], 13, 0, 13.5, 1],
+        'circle-stroke-opacity': [
+          'interpolate',
+          ['linear'],
+          ['zoom'],
+          13,
+          0,
+          13.5,
+          1,
+        ],
       },
-      firstSymbolId
-    );
+      filter: ['has', 'stop_id'],
+    });
 
     // Layer for highlighted stops
-    map.addLayer(
-      {
-        id: 'stops-highlighted',
-        type: 'circle',
-        source: {
-          type: 'geojson',
-          data: geojson,
-        },
-        paint: {
-          'circle-color': '#fff',
-          'circle-radius': {
-            base: 1.75,
-            stops: [
-              [12, 5],
-              [22, 125],
-            ],
-          },
-          'circle-stroke-width': 2,
-          'circle-stroke-color': '#3f4a5c',
-          'circle-opacity': [
-            'interpolate',
-            ['linear'],
-            ['zoom'],
-            13,
-            0,
-            13.5,
-            1,
-          ],
-          'circle-stroke-opacity': [
-            'interpolate',
-            ['linear'],
-            ['zoom'],
-            13,
-            0,
-            13.5,
-            1,
+    map.addLayer({
+      id: 'stops-highlighted',
+      type: 'circle',
+      source: {
+        type: 'geojson',
+        data: geojson,
+      },
+      paint: {
+        'circle-color': '#fff',
+        'circle-radius': {
+          base: 1.75,
+          stops: [
+            [12, 5],
+            [22, 125],
           ],
         },
-        filter: ['==', 'stop_id', ''],
+        'circle-stroke-width': 2,
+        'circle-stroke-color': '#3f4a5c',
+        'circle-opacity': ['interpolate', ['linear'], ['zoom'], 13, 0, 13.5, 1],
+        'circle-stroke-opacity': [
+          'interpolate',
+          ['linear'],
+          ['zoom'],
+          13,
+          0,
+          13.5,
+          1,
+        ],
       },
-      firstSymbolId
-    );
+      filter: ['==', 'stop_id', ''],
+    });
 
     // Add labels
     map.addLayer({
@@ -406,14 +393,14 @@ function createSystemMap(id, geojson) {
         map.getCanvas().style.cursor = 'pointer';
         highlightRoutes(
           _.compact(
-            _.uniq(features.map((feature) => feature.properties.route_id))
-          )
+            _.uniq(features.map((feature) => feature.properties.route_id)),
+          ),
         );
 
         if (features.some((feature) => feature.layer.id === 'stops')) {
           highlightStop(
             features.find((feature) => feature.layer.id === 'stops').properties
-              .stop_id
+              .stop_id,
           );
         }
       } else {
@@ -451,10 +438,10 @@ function createSystemMap(id, geojson) {
           const routes = _.orderBy(
             _.uniqBy(
               routeFeatures,
-              (feature) => feature.properties.route_short_name
+              (feature) => feature.properties.route_short_name,
             ),
             (feature) =>
-              Number.parseInt(feature.properties.route_short_name, 10)
+              Number.parseInt(feature.properties.route_short_name, 10),
           );
 
           new mapboxgl.Popup()
@@ -505,11 +492,11 @@ function createSystemMap(id, geojson) {
       map.setPaintProperty(
         'route-line-shadows',
         'line-opacity',
-        routeLineOpacity
+        routeLineOpacity,
       );
 
       const highlightedFeatures = geojson.features.filter((feature) =>
-        routeIds.includes(feature.properties.route_id)
+        routeIds.includes(feature.properties.route_id),
       );
 
       if (highlightedFeatures.length > 0 && zoom) {
@@ -546,7 +533,7 @@ function createSystemMap(id, geojson) {
       map.setPaintProperty(
         'route-line-shadows',
         'line-opacity',
-        routeLineOpacity
+        routeLineOpacity,
       );
 
       if (zoom) {
@@ -566,7 +553,7 @@ function createSystemMap(id, geojson) {
 
       $('.overview-list').hover(
         () => {},
-        () => unHighlightRoutes(true)
+        () => unHighlightRoutes(true),
       );
     });
   });