gtfs-to-html 2.6.12 → 2.7.0

package/CHANGELOG.md

@@ -5,6 +5,20 @@ 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.7.0] - 2024-07-27
+
+### Fixed
+- Fixes for horizontal orientation labels
+
+### Updated
+- Better date format documentation
+- Better default for timetable_page_label
+- Larger map on desktop
+- Improved button styles
+- Serve static assets from templatePath
+- Move static js and css to views/default
+- Dependency updates
+
 ## [2.6.12] - 2024-07-26
 
 ### Updated

package/app/index.js

@@ -4,9 +4,9 @@ import { readFileSync } from 'node:fs';
 import { map } from 'lodash-es';
 import yargs from 'yargs';
 import { openDb } from 'gtfs';
-
 import express from 'express';
 import logger from 'morgan';
+import untildify from 'untildify';
 
 import { formatTimetableLabel } from '../lib/formatters.js';
 import {
@@ -44,7 +44,7 @@ try {
 } 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.`,
     );
   }
 
@@ -59,14 +59,14 @@ router.get('/', async (request, response, next) => {
     const timetablePages = [];
     const timetablePageIds = map(
       getTimetablePagesForAgency(config),
-      'timetable_page_id'
+      'timetable_page_id',
     );
 
     for (const timetablePageId of timetablePageIds) {
       // eslint-disable-next-line no-await-in-loop
       const timetablePage = await getFormattedTimetablePage(
         timetablePageId,
-        config
+        config,
       );
 
       if (
@@ -74,7 +74,7 @@ router.get('/', async (request, response, next) => {
         timetablePage.consolidatedTimetables.length === 0
       ) {
         console.error(
-          `No timetables found for timetable_page_id=${timetablePage.timetable_page_id}`
+          `No timetables found for timetable_page_id=${timetablePage.timetable_page_id}`,
         );
       }
 
@@ -107,7 +107,7 @@ router.get('/timetables/:timetablePageId', async (request, response, next) => {
   try {
     const timetablePage = await getFormattedTimetablePage(
       timetablePageId,
-      config
+      config,
     );
 
     const html = await generateTimetableHTML(timetablePage, config);
@@ -121,9 +121,14 @@ app.set('views', path.join(fileURLToPath(import.meta.url), '../../views'));
 app.set('view engine', 'pug');
 
 app.use(logger('dev'));
-app.use(
-  express.static(path.join(fileURLToPath(import.meta.url), '../../public'))
-);
+
+// Serve static assets
+const staticAssetPath =
+  config.templatePath === undefined
+    ? path.join(fileURLToPath(import.meta.url), '../../views/default')
+    : untildify(config.templatePath);
+
+app.use(express.static(staticAssetPath));
 
 app.use('/', router);
 app.set('port', process.env.PORT || 3000);

package/lib/file-utils.js

@@ -66,18 +66,12 @@ function getTemplatePath(templateFileName, config) {
     fullTemplateFileName += '_full';
   }
 
-  if (config.templatePath !== undefined) {
-    return path.join(
-      untildify(config.templatePath),
-      `${fullTemplateFileName}.pug`,
-    );
-  }
+  const templatePath =
+    config.templatePath === undefined
+      ? path.join(fileURLToPath(import.meta.url), '../../views/default')
+      : untildify(config.templatePath);
 
-  return path.join(
-    fileURLToPath(import.meta.url),
-    '../../views/default',
-    `${fullTemplateFileName}.pug`,
-  );
+  return path.join(templatePath, `${fullTemplateFileName}.pug`);
 }
 
 /*
@@ -101,11 +95,12 @@ export async function prepDirectory(exportPath) {
 /*
  * Copy needed CSS and JS to export path.
  */
-export function copyStaticAssets(exportPath) {
-  const staticAssetPath = path.join(
-    fileURLToPath(import.meta.url),
-    '../../public',
-  );
+export function copyStaticAssets(config, exportPath) {
+  const staticAssetPath =
+    config.templatePath === undefined
+      ? path.join(fileURLToPath(import.meta.url), '../../views/default')
+      : untildify(config.templatePath);
+
   copydir.sync(path.join(staticAssetPath, 'css'), path.join(exportPath, 'css'));
   copydir.sync(path.join(staticAssetPath, 'js'), path.join(exportPath, 'js'));
 }

package/lib/formatters.js

@@ -247,20 +247,6 @@ export function formatTrip(trip, timetable, calendars, config) {
   return trip;
 }
 
-/*
- * Format a route name.
- */
-export function formatRouteName(route) {
-  let routeName = 'Route ';
-  if (!isNullOrEmpty(route.route_short_name)) {
-    routeName += route.route_short_name;
-  } else if (!isNullOrEmpty(route.route_long_name)) {
-    routeName += route.route_long_name;
-  }
-
-  return routeName;
-}
-
 /*
  * Format a frequency.
  */
@@ -384,7 +370,7 @@ export function formatStopName(stop) {
 }
 
 /*
- * Formats trip "Contines from".
+ * Formats trip "Continues from".
  */
 export function formatTripContinuesFrom(trip) {
   return trip.continues_from_route
@@ -393,7 +379,7 @@ export function formatTripContinuesFrom(trip) {
 }
 
 /*
- * Formats trip "Contines as".
+ * Formats trip "Continues as".
  */
 export function formatTripContinuesAs(trip) {
   return trip.continues_as_route
@@ -500,33 +486,6 @@ export function formatTimetableLabel(timetable) {
   return timetableLabel;
 }
 
-/*
- * Format a label for a timetable page.
- */
-export function formatTimetablePageLabel(timetablePage) {
-  if (!isNullOrEmpty(timetablePage.timetable_page_label)) {
-    return timetablePage.timetable_page_label;
-  }
-
-  if (
-    timetablePage.consolidatedTimetables &&
-    timetablePage.consolidatedTimetables.length > 0
-  ) {
-    // Use route names from all timetables
-    const routes = uniqBy(
-      flatMap(
-        timetablePage.consolidatedTimetables,
-        (timetable) => timetable.routes,
-      ),
-      'route_id',
-    );
-
-    return routes.map((route) => formatRouteName(route)).join(' and ');
-  }
-
-  return 'Unknown';
-}
-
 /*
  * Merge timetables with same `timetable_id`.
  */

package/lib/gtfs-to-html.js

@@ -89,7 +89,7 @@ const gtfsToHtml = async (initialConfig) => {
   await prepDirectory(exportPath);
 
   if (config.noHead !== true && ['html', 'pdf'].includes(config.outputFormat)) {
-    copyStaticAssets(exportPath);
+    copyStaticAssets(config, exportPath);
   }
 
   const bar = progressBar(
@@ -134,7 +134,7 @@ const gtfsToHtml = async (initialConfig) => {
       );
 
       if (config.outputFormat === 'csv') {
-        for (const timetable of timetablePage.timetables) {
+        for (const timetable of timetablePage.consolidatedTimetables) {
           const csv = await generateTimetableCSV(timetable);
           const csvPath = path.join(
             exportPath,

package/lib/utils.js

@@ -58,7 +58,6 @@ import {
   formatStops,
   formatTimetableId,
   formatTimetableLabel,
-  formatTimetablePageLabel,
   formatTrip,
   formatTripContinuesAs,
   formatTripContinuesFrom,
@@ -1505,7 +1504,6 @@ export function getFormattedTimetablePage(timetablePageId, config) {
     timetablePage.timetables,
     config,
   );
-  timetablePage.timetable_page_label = formatTimetablePageLabel(timetablePage);
   timetablePage.dayList = formatDays(
     getDaysFromCalendars(timetablePage.consolidatedTimetables),
     config,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs-to-html",
-  "version": "2.6.12",
+  "version": "2.7.0",
   "private": false,
   "description": "Build human readable transit timetables as HTML, PDF or CSV from GTFS",
   "keywords": [
@@ -40,9 +40,9 @@
     "archiver": "^7.0.1",
     "cli-table": "^0.3.11",
     "copy-dir": "^1.3.0",
-    "csv-stringify": "^6.5.0",
+    "csv-stringify": "^6.5.1",
     "express": "^4.19.2",
-    "gtfs": "^4.13.1",
+    "gtfs": "^4.13.2",
     "insane": "^2.6.2",
     "js-beautify": "^1.15.1",
     "lodash-es": "^4.17.21",

package/{public → views/default}/css/overview_styles.css

@@ -117,7 +117,7 @@ a:hover {
 
 .timetable-overview .btn-blue {
   color: rgb(255 255 255);
-  padding: 0.75rem 2rem;
+  padding: 0.75rem 1.5rem;
   background-color: rgb(37 99 235);
   border-radius: 0.375rem;
   justify-content: center;

package/{public → views/default}/css/timetable_styles.css

@@ -180,7 +180,7 @@ a:hover {
 
 .timetable-page .btn-blue {
   color: rgb(255 255 255);
-  padding: 0.75rem 2rem;
+  padding: 0.75rem 1.5rem;
   background-color: rgb(37 99 235);
   border-radius: 0.375rem;
   justify-content: center;
@@ -197,7 +197,7 @@ a:hover {
 
 .timetable-page .btn-gray {
   color: rgb(75 85 99);
-  padding: 0.75rem 2rem;
+  padding: 0.75rem 1.5rem;
   background-color: rgb(209 213 219);
   border-radius: 0.375rem;
   justify-content: center;
@@ -221,7 +221,7 @@ a:hover {
   margin-bottom: 2.5rem;
 }
 
-.timetable-page .timetable .stop-header {
+.timetable-page .timetable .table-vertical .stop-header {
   text-align: center;
 }
 
@@ -354,7 +354,13 @@ a:hover {
 }
 
 .timetable-page .table-horizontal tbody tr th.stop-name-container {
-  min-width: 250px;
+  min-width: 175px;
+}
+
+@media screen and (min-width: 768px) {
+  .timetable-page .table-horizontal tbody tr th.stop-name-container {
+    min-width: 250px;
+  }
 }
 
 .timetable-page .table-hourly {
@@ -392,18 +398,18 @@ a:hover {
   flex-shrink: 0;
 }
 
-@media screen and (max-width: 767px) {
-  .timetable-page .table-horizontal tbody tr th.stop-name-container {
-    min-width: 175px;
-  }
-}
-
 /* Map Styles */
 
 .timetable-page .map {
   min-height: 350px;
 }
 
+@media screen and (min-width: 768px) {
+  .timetable-page .map {
+    min-height: 450px;
+  }
+}
+
 .timetable-page .map .mapboxgl-popup-content .popup-title {
   margin: 0 20px 5px 0;
   font-size: 1rem;

package/views/default/formatting_functions.pug

@@ -1,11 +1,11 @@
 -
   function getTimetableSummary(timetable) {
     let summary = `This table shows schedules for a selection of key stops on the route for ${timetable.timetable_label} ${timetable.dayList}.`;
-    if (timetable.orientation = 'vertical') {
+    if (timetable.orientation === 'vertical') {
       summary += ' Stops and their schedule times are listed in the columns.';
-    } else if (timetable.orientation = 'horizontal') {
+    } else if (timetable.orientation === 'horizontal') {
       summary += ' Schedule times are listed in rows, starting with the stop name in the first cell of the row.';
-    } else if (timetable.orientation = 'hourly') {
+    } else if (timetable.orientation === 'hourly') {
       summary += ' Schedule times are listed in rows, starting with the stop name in the first cell of the row and the minutes after the hour in the second row.';
     }
     return summary;
@@ -98,3 +98,11 @@
 
     return ''
   }
+
+  function formatRouteName(route) {
+    if (isNullOrEmpty(route.route_long_name)) {
+      return `Route ${route.route_short_name}`;
+    }
+
+    return route.route_long_name;
+  }

package/views/default/overview.pug

@@ -10,10 +10,11 @@ include formatting_functions.pug
         each timetablePage in timetablePageGroup.timetablePages
           if config.allowEmptyTimetables || timetablePage.consolidatedTimetables.length > 0
             a.timetable-page-link(href=`${timetablePage.relativePath}` data-route-ids=`${timetablePage.route_ids ? timetablePage.route_ids.join(',') : ''}`)
-              each route in _.uniqBy(_.flatMap(timetablePage.consolidatedTimetables, timetable => timetable.routes), 'route_id')
+              - const timetableRouteList = _.uniqBy(_.flatMap(timetablePage.consolidatedTimetables, timetable => timetable.routes), 'route_id')
+              each route in timetableRouteList
                 .route-color-swatch-large(style=`background-color: ${formatRouteColor(route)}; color: ${formatRouteTextColor(route)};`)= route.route_short_name || ''
               div
-                .timetable-page-label= timetablePage.timetable_page_label
+                .timetable-page-label= timetablePage.timetable_page_label || timetableRouteList.map(route => formatRouteName(route)).join(' and ')
                 .badge-gray= timetablePage.dayList
     if config.showMap
       #system_map.overview-map

package/views/default/timetablepage.pug

@@ -3,10 +3,11 @@ include formatting_functions.pug
 <!-- Timetable generated on #{new Date().toISOString()} using GTFS-to-HTML version #{config.gtfsToHtmlVersion} -->
 .timetable-page(class=`menu-type-${config.menuType}`)
   if config.showRouteTitle
+    - const timetableRouteList = _.uniqBy(_.flatMap(timetablePage.consolidatedTimetables, timetable => timetable.routes), 'route_id')
     h1
-      each route in _.uniqBy(_.flatMap(timetablePage.consolidatedTimetables, timetable => timetable.routes), 'route_id')
+      each route in timetableRouteList
         .route-color-swatch-large(style=`background-color: ${formatRouteColor(route)}; color: ${formatRouteTextColor(route)};`)= route.route_short_name || ''
-      div= timetablePage.timetable_page_label
+      div= timetablePage.timetable_page_label || timetableRouteList.map(route => formatRouteName(route)).join(' and ')
     if config.effectiveDate
       .effective-date= `Effective ${config.effectiveDate}`
 

package/www/docs/configuration.md

@@ -235,7 +235,7 @@ API along with your API token.
 
 ### endDate
 
-\{String\} A date in ISO 8601 format to use to control which calendars are used for the timetables. Can be used with [startDate](#startdate) configuration options. Can be formatted as `YYYY-MM-DD` or `YYYYMMDD`.
+\{String\} A date in `YYYYMMDD` format to use to control which calendars are used for the timetables. Can be used with [startDate](#startdate) configuration options.
 
 Optional, defaults to using all available calendars if not defined. Overridden by `start_date` and `end_date` defined in `timetables.txt`.
 
@@ -519,7 +519,7 @@ The default trip-sorting algorithm is `common`.
 
 ### startDate
 
-\{String\} A date in ISO 8601 format to use to control which calendars are used for the timetables. Can be used with [endDate](#enddate) configuration options. Can be formatted as `YYYY-MM-DD` or `YYYYMMDD`.
+\{String\} A date in `YYYYMMDD` format to use to control which calendars are used for the timetables. Can be used with [endDate](#enddate) configuration options.
 
 Optional, defaults to using all available calendars if not defined. Overridden by `start_date` and `end_date` defined in `timetables.txt`.
 

package/www/docs/timetables.md

@@ -12,8 +12,8 @@ This is an optional, non-standard file called `timetables.txt` which can be incl
 | `timetable_id`           | A unique ID for the timetable                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 | `route_id`               | The ID of the route the timetable is for from `routes.txt`. For timetables that should include more than one route, see [Multi-route timetables](#multi-route-timetables)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | `direction_id`           | The `direction_id` from `trips.txt` for the timetable. This can be blank.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
-| `start_date`             | The start date for this timetable in `YYYY-MM-DD` format.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
-| `end_date`               | The end date for this timetable in `YYYY-MM-DD` format.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| `start_date`             | The start date for this timetable in `YYYYMMDD` format.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `end_date`               | The end date for this timetable in `YYYYMMDD` format.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | `monday`                 | A binary value that indicates whether this timetable should include service on Mondays. Valid options are `0` and `1`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | `tuesday`                | A binary value that indicates whether this timetable should include service on Tuesdays. Valid options are `0` and `1`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | `wednesday`              | A binary value that indicates whether this timetable should include service on Wednesdays. Valid options are `0` and `1`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |