Timetable label functions, version bump

Author: brendannee

README.md

@@ -297,7 +297,7 @@ An example of this file is located in [examples/timetables.txt](examples/timetab
 | `friday` | A binary value that indicates whether this timetable should include service on Fridays.  Valid options are `0` and `1`. |
 | `saturday` | A binary value that indicates whether this timetable should include service on Saturdays.  Valid options are `0` and `1`. |
 | `sunday` | A binary value that indicates whether this timetable should include service on Sundays.  Valid options are `0` and `1`. |
-| `timetable_label` | A short text label describing the timetable, for instance "Route 4 Northbound Mon-Fri". Optional, defaults to route name. |
+| `timetable_label` | A short text label describing the timetable, for instance "Route 4 Northbound Mon-Fri". Optional, defaults to route name and first and last stops. |
 | `service_notes` | Text shown on the timetable about the service represented. Optional. |
 | `orientation` | Determines if the top row should be a list of trips or stops. Valid options are `vertical`, `horizontal` or `hourly`. `vertical` shows stops across the top row with each row being a list of stop times for each trip. `horizontal` shows trips across the top row with each row being stop times for a specific stop. `hourly` is for routes that run the same time each hour and will print a simplified schedule showing minutes after the hour for each stop. `horizontal` orientation is best for routes with lots of stops and fewer trips while `vertical` orientation is best for routes with lots of trips and a smaller number of stops. Default is `vertical` |
 | `timetable_page_id` | The timetable page to include this timetable on |

bin/gtfs-to-html.js

@@ -29,6 +29,7 @@ const argv = require('yargs')
     .argv;
 
 const gtfsToHtml = require('../');
+const logUtils = require('../lib/log-utils');
 const utils = require('../lib/utils');
 
 function handleError(err) {
@@ -57,7 +58,7 @@ getConfig()
   handleError(err);
 })
 .then(async config => {
-  const log = utils.log(config);
+  const log = logUtils.log(config);
 
   mongoose.Promise = global.Promise;
   mongoose.connect(config.mongoUrl, {useMongoClient: true});

lib/formatters.js

@@ -112,18 +112,3 @@ exports.formatTimetableId = (route, direction) => {
   }
   return timetableId;
 };
-
-exports.formatTimetableLabel = (route, direction) => {
-  const timetableLabelParts = [];
-  if (route.route_short_name !== '' && route.route_short_name !== undefined) {
-    timetableLabelParts.push(route.route_short_name);
-  }
-  if (route.route_long_name !== '' && route.route_long_name !== undefined) {
-    timetableLabelParts.push(route.route_long_name);
-  }
-
-  if (direction) {
-    timetableLabelParts.push(`to ${direction.trip_headsign}`);
-  }
-  return timetableLabelParts.join(' ');
-};

lib/gtfs-to-html.js

@@ -9,10 +9,11 @@ const Timer = require('timer-machine');
 
 const fileUtils = require('./file-utils');
 const formatters = require('./formatters');
+const logUtils = require('./log-utils');
 const utils = require('./utils');
 
 module.exports = config => {
-  const log = utils.log(config);
+  const log = logUtils.log(config);
 
   if (!config.agencies || config.agencies.length === 0) {
     throw new Error('No agencies defined in `config.json`');
@@ -76,7 +77,7 @@ module.exports = config => {
     const html = await utils.generateOverviewHTML(agencyKey, timetablePages, config);
     await fs.writeFile(path.join(exportPath, 'index.html'), html);
 
-    const logText = await utils.generateLogText(agency, outputStats);
+    const logText = await logUtils.generateLogText(agency, outputStats);
     await fs.writeFile(path.join(exportPath, 'log.txt'), logText.join('\n'));
 
     // Zip output, if specified

lib/log-utils.js

@@ -0,0 +1,36 @@
+const _ = require('lodash');
+const gtfs = require('gtfs');
+
+exports.generateLogText = async (agency, outputStats) => {
+  const results = await gtfs.getFeedInfo({agency_key: agency.agency_key});
+  const feedVersion = results ? results.feed_version : 'Unknown';
+
+  const logText = [
+    `Feed Version: ${feedVersion}`,
+    `Date Generated: ${new Date()}`,
+    `Timetable Page Count ${outputStats.timetablePages}`,
+    `Timetable Count: ${outputStats.timetables}`,
+    `Calendar Service ID Count: ${outputStats.calendars}`,
+    `Route Count: ${outputStats.routes}`,
+    `Trip Count: ${outputStats.trips}`,
+    `Stop Count: ${outputStats.stops}`
+  ];
+
+  if (agency.url) {
+    logText.push(`Source: ${agency.url}`);
+  } else if (agency.path) {
+    logText.push(`Source: ${agency.path}`);
+  }
+
+  return logText;
+};
+
+exports.log = config => {
+  if (config.verbose === false) {
+    return _.noop;
+  }
+
+  return (text, overwrite) => {
+    return process.stdout.write(`${overwrite !== true ? '\n' : ''}${text}`);
+  };
+};

lib/utils.js

@@ -55,15 +55,6 @@ function filterAndSortCalendarDates(calendarDates, startDate, endDate) {
   return _.sortBy(filteredDates, 'date');
 }
 
-function filterAndSortTimetables(timetables, timetablePageId) {
-  const selectedTimetables = _.filter(timetables, {timetable_page_id: timetablePageId});
-  if (!selectedTimetables || selectedTimetables.length === 0) {
-    throw new Error(`No timetables found for timetable_page_id=${timetablePageId}`);
-  }
-
-  return _.sortBy(selectedTimetables, 'timetable_sequence');
-}
-
 function sortTrips(trips) {
   // Find the first stop_id that all trips have in common, otherwise use the first stoptime
   const longestTrip = _.maxBy(trips, trip => _.size(trip.stoptimes));
@@ -115,6 +106,26 @@ function filterStoptimes(stoptimes) {
   });
 }
 
+const filterAndSortTimetables = async (timetables, timetablePageId) => {
+  const selectedTimetables = _.filter(timetables, {timetable_page_id: timetablePageId});
+  if (!selectedTimetables || selectedTimetables.length === 0) {
+    throw new Error(`No timetables found for timetable_page_id=${timetablePageId}`);
+  }
+
+  for (const timetable of selectedTimetables) {
+    const routes = await gtfs.getRoutes({
+      agency_key: timetable.agency_key,
+      route_id: timetable.route_id
+    });
+    if (!routes || routes.length === 0) {
+      throw new Error(`No route found for route_id=${timetable.route_id}, timetable_id=${timetable.timetable_id}`);
+    }
+    timetable.route = _.first(routes);
+  }
+
+  return _.sortBy(selectedTimetables, 'timetable_sequence');
+};
+
 const getSpecialDates = async timetable => {
   const results = await gtfs.getCalendarDates({
     agency_key: timetable.agency_key,
@@ -215,48 +226,7 @@ const processStops = async timetable => {
   }
 };
 
-const formatTimetable = async timetable => {
-  if (!timetable.timetable_label) {
-    const routes = await gtfs.getRoutes({
-      agency_key: timetable.agency_key,
-      route_id: timetable.route_id
-    });
-    if (!routes || routes.length === 0) {
-      throw new Error(`No route found for route_id=${timetable.route_id}, timetable_id=${timetable.timetable_id}`);
-    }
-    let direction;
-    if (timetable.direction_id !== null && timetable.direction_id !== '') {
-      const directions = await gtfs.getDirectionsByRoute({
-        agency_key: timetable.agency_key,
-        route_id: timetable.route_id,
-        direction_id: timetable.direction_id
-      });
-      direction = _.first(directions);
-    }
-    timetable.timetable_label = formatters.formatTimetableLabel(routes[0], direction);
-  }
-  return timetable;
-};
-
 const formatTimetablePage = async timetablePage => {
-  // If timetable_page_label not set, use first route to name it
-  if (timetablePage.timetable_page_label === '' || timetablePage.timetable_page_label === undefined) {
-    const routes = await gtfs.getRoutes({
-      agency_key: timetablePage.agency_key,
-      route_id: timetablePage.timetables[0].route_id
-    });
-
-    if (routes.length === 0) {
-      throw new Error(`No route found for route_id=${timetablePage.timetables[0].route_id}, timetable_id=${timetablePage.timetables[0].timetable_id}`);
-    }
-    const route = routes[0];
-
-    timetablePage.timetable_page_label = formatters.formatTimetableLabel(route);
-  }
-
-  // Format each timetable in timetable_page
-  timetablePage.timetables = await Promise.all(timetablePage.timetables.map(timetable => formatTimetable(timetable)));
-
   // Summarize timetables in timetablePage
   timetablePage.dayList = formatters.formatDays(getDaysFromCalendars(timetablePage.timetables));
   timetablePage.dayLists = _.uniq(timetablePage.timetables.map(timetable => timetable.dayList));
@@ -279,12 +249,13 @@ const convertTimetableToTimetablePage = async timetable => {
 
   const route = routes[0];
   const filename = await fileUtils.generateFileName(timetable, route);
-  const formattedTimetable = await formatTimetable(timetable);
+  timetable.route = route;
+
   return {
-    agency_key: formattedTimetable.agency_key,
-    timetable_page_id: formattedTimetable.timetable_id,
-    timetable_page_label: formattedTimetable.timetable_label,
-    timetables: [formattedTimetable],
+    agency_key: timetable.agency_key,
+    timetable_page_id: timetable.timetable_id,
+    timetable_page_label: timetable.timetable_label,
+    timetables: [timetable],
     filename
   };
 };
@@ -293,11 +264,11 @@ const convertRouteToTimetablePage = async (route, direction) => {
   const timetable = {
     agency_key: route.agency_key,
     timetable_id: formatters.formatTimetableId(route, direction),
-    timetable_label: formatters.formatTimetableLabel(route, direction),
     route_id: route.route_id,
     direction_id: direction.direction_id,
     start_date: parseInt(formatters.toGTFSDate(moment()), 10),
-    end_date: parseInt(formatters.toGTFSDate(moment().add(1, 'week')), 10)
+    end_date: parseInt(formatters.toGTFSDate(moment().add(1, 'week')), 10),
+    route: route
   };
 
   const tripQuery = {
@@ -581,30 +552,6 @@ exports.generateOverviewHTML = async (agencyKey, timetablePages, config) => {
   return html;
 };
 
-exports.generateLogText = async (agency, outputStats) => {
-  const results = await gtfs.getFeedInfo({agency_key: agency.agency_key});
-  const feedVersion = results ? results.feed_version : 'Unknown';
-
-  const logText = [
-    `Feed Version: ${feedVersion}`,
-    `Date Generated: ${new Date()}`,
-    `Timetable Page Count ${outputStats.timetablePages}`,
-    `Timetable Count: ${outputStats.timetables}`,
-    `Calendar Service ID Count: ${outputStats.calendars}`,
-    `Route Count: ${outputStats.routes}`,
-    `Trip Count: ${outputStats.trips}`,
-    `Stop Count: ${outputStats.stops}`
-  ];
-
-  if (agency.url) {
-    logText.push(`Source: ${agency.url}`);
-  } else if (agency.path) {
-    logText.push(`Source: ${agency.path}`);
-  }
-
-  return logText;
-};
-
 exports.getTimetablePage = async (agencyKey, timetablePageId) => {
   let timetables = await gtfs.getTimetables({agency_key: agencyKey});
   timetables = timetables.map(timetable => timetable.toObject());
@@ -654,7 +601,7 @@ exports.getTimetablePage = async (agencyKey, timetablePageId) => {
     timetablePages = [await convertTimetableToTimetablePage(timetable)];
   } else {
     for (const timetablePage of timetablePages) {
-      timetablePage.timetables = filterAndSortTimetables(timetables, timetablePage.timetable_page_id);
+      timetablePage.timetables = await filterAndSortTimetables(timetables, timetablePage.timetable_page_id);
     }
   }
 
@@ -679,21 +626,11 @@ exports.getTimetablePages = async agencyKey => {
     }));
   } else {
     // Otherwise, use timetable pages provided
-    timetablePages = timetablePages.map(timetablePage => {
-      timetablePage.timetables = filterAndSortTimetables(timetables, timetablePage.timetable_page_id);
+    timetablePages = await Promise.all(timetablePages.map(async timetablePage => {
+      timetablePage.timetables = await filterAndSortTimetables(timetables, timetablePage.timetable_page_id);
       return timetablePage;
-    });
+    }));
   }
 
   return Promise.all(timetablePages.map(timetablePage => formatTimetablePage(timetablePage)));
 };
-
-exports.log = config => {
-  if (config.verbose === false) {
-    return _.noop;
-  }
-
-  return (text, overwrite) => {
-    return process.stdout.write(`${overwrite !== true ? '\n' : ''}${text}`);
-  };
-};

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "gtfs-to-html",
   "description": "Build transit timetables in HTML from a GTFS file",
-  "version": "0.11.1",
+  "version": "0.11.2",
   "keywords": [
     "transit",
     "gtfs",

package.json

@@ -0,0 +1,49 @@
+- function getTimetableLabel(timetable) {
+-   if (timetable.timetable_label !== '' && timetable.timetable_label !== undefined) {
+-     return timetable.timetable_label;
+-   }
+-   var timetableLabel = `Route `;
+-   if (timetable.route.route_short_name !== '' && timetable.route.route_short_name !== undefined) {
+-     timetableLabel += timetable.route.route_short_name;
+-   } else if (timetable.route.route_long_name !== '' && timetable.route.route_long_name !== undefined) {
+-     timetableLabel += timetable.route.route_long_name;
+-   }
+-   timetableLabel += ` - ${timetable.stops[0].stop_name} to ${timetable.stops[timetable.stops.length - 1].stop_name}`;
+-   return timetableLabel;
+- }
+
+- function getTimetablePageLabel(timetablePage) {
+-   if (timetablePage.timetable_page_label !== '' && timetablePage.timetable_page_label !== undefined) {
+-     return timetablePage.timetable_page_label;
+-   }
+-   // Get route info from first timetable
+-   var route = timetablePage.timetables[0].route;
+-   var timetableLabel = 'Route ';
+-   if (route.route_short_name !== '' && route.route_short_name !== undefined) {
+-     timetableLabel += `${route.route_short_name} - `;
+-   }
+-   if (route.route_long_name !== '' && route.route_long_name !== undefined) {
+-     timetableLabel += route.route_long_name;
+-   }
+-   return timetableLabel;
+- }
+
+- function getTimetableSummary(timetable) {
+-   var summary = `This table shows schedules for a selection of key stops on the route for ${getTimetableLabel(timetable)} ${timetable.dayList}.`;
+-   if (timetable.orientation = 'vertical') {
+-     summary += ' Stops and their schedule times are listed in the columns.';
+-   } 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') {
+-     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;
+- }
+
+- function formatStopName(stop) {
+-   return `${stop.stop_name}${stop.type === 'arrival' ? ' (Arrival)' : stop.type === 'departure' ? ' (Departure)' : ''}`;
+- }
+
+- function formatTripName(trip, idx, showDayList) {
+-   return `${trip.trip_short_name || `Run #${idx + 1}`}${showDayList ? ` ${trip.dayList}` : ''}`;
+- }

views/timetable/formatting_functions.pug

@@ -1,3 +1,5 @@
+include formatting_functions.pug
+
 .row
   .col-md-12
     h1.overview-label= `${agency.agency_name} Routes`
@@ -13,7 +15,7 @@
             h4.list-group-item-heading
               if timetablePage.routeColors.length === 1
                 .route-color-swatch(style=`background-color: #${timetablePage.routeColors[0]}`)
-              span= timetablePage.timetable_page_label
+              span= getTimetablePageLabel(timetablePage)
             .list-group-item-text= timetablePage.dayList
     if config.showMap
       .col-md-9

views/timetable/overview.pug

@@ -1,6 +1,6 @@
 .table-container
   table.table.table-striped.table-horizontal(summary= getTimetableSummary(timetable))
-    caption.sr-only= `${timetable.timetable_label} | ${timetable.dayList}`
+    caption.sr-only= `${getTimetableLabel(timetable)} | ${timetable.dayList}`
     colgroup
       col
       each trip, idx in timetable.orderedTrips

views/timetable/timetable_horizontal.pug

@@ -5,7 +5,7 @@
 
 .table-container
   table.table.table-striped.table-hourly(summary= getTimetableSummary(timetable))
-    caption.sr-only= `${timetable.timetable_label} | ${timetable.dayList}`
+    caption.sr-only= `${getTimetableLabel(timetable)} | ${timetable.dayList}`
     thead
       tr
         th.stop-header(scope="col") Stop