Updates to work with node-gtfs 1.0.0

version bump

Author: brendannee

README.md

@@ -9,11 +9,14 @@
 
 `gtfs-to-html` converts transit data in [GTFS format](https://developers.google.com/transit/gtfs/) into user-friendly HTML schedules. Many transit agencies have schedule data in GTFS format but need to show each route's schedule to users on a website. This project aims to automate the process of creating these schedules. Automating HTML schedule generation makes it easy to keep schedules up to date when data changes and reduces the likelihood of errors.
 
+Additionally, a map showing the route and all stops can be included in the HTML schedule page. See the `showMap` configuration option below.
+
 `gtfs-to-html` uses the [`node-gtfs`](https://github.com/blinktaginc/node-gtfs) library to handle importing and querying GTFS data.
 
-`gtfs-to-html` is currently used by [Sonoma Country Transit](http://sctransit.com/) to generate schedule pages for each route.
+`gtfs-to-html` is currently used by [Sonoma Country Transit](http://sctransit.com/) to generate the schedules pages used on their website.
+
+<img width="1265" src="https://user-images.githubusercontent.com/96217/28296063-aed45568-6b1a-11e7-9794-94b3d915d668.png">
 
-<img width="1265" src="https://cloud.githubusercontent.com/assets/96217/10262598/87674f70-6983-11e5-8150-15b6372c989c.png">
 
 ## Installation
 
@@ -54,6 +57,7 @@ Copy `config-sample.json` to `config.json` and then add your projects configurat
 | [`beautify`](#beautify) | boolean | Whether or not to beautify the HTML output. |
 | [`coordinatePrecision`](#coordinatePrecision) | integer | Number of decimal places to include in geoJSON map output. |
 | [`effectiveDate`](#effectivedate) | string | A date to print at the top of the timetable |
+| [`mapboxAccessToken`](#mapboxAccessToken) | string | The Mapbox access token for generating a map of the route. |
 | [`menuType`](#menuType) | string | The type of menu to use for selecting timetables on a timetable page. |
 | [`mongoUrl`](#mongoUrl) | string | The URL of the MongoDB database to import to. |
 | [`noHead`](#noHead) | boolean | Whether or not to skip the header and footer of the HTML document. |
@@ -166,6 +170,14 @@ API along with your API token.
     "effectiveDate": "July 8, 2015"
 ```
 
+### mapboxAccessToken
+
+{String} The [Mapbox access token](https://www.mapbox.com/help/define-access-token/) for generating a map of the route.
+
+```
+    "mapboxAccessToken": "pk.eyXaX5F8oCJSYedim3yCnTGsVBfnRjsoXdy4Ej7ZZZydrCn2WMDXha5bPj5.bPj5xsBo8u8N8GJqJh"
+```
+
 ### menuType
 
 {String} The type of menu to use for selecting or navigating to timetables on timetable pages with multiple timetables. Valid choices are `none`, `jump` and `radio`. Defaults to `jump`.

bin/gtfs-to-html.js

@@ -34,21 +34,25 @@ function handleError(err) {
   process.exit(1);
 }
 
-// Read config JSON file and merge confiruration file with command-line arguments
-fs.readFile(resolve(argv.configPath), 'utf8')
-.then(data => JSON.parse(data))
-.then(config => _.merge(config, argv))
+const getConfig = async () => {
+  const data = await fs.readFile(resolve(argv.configPath), 'utf8');
+  return _.merge(JSON.parse(data), argv);
+};
+
+getConfig()
 .catch(err => {
   console.error(new Error(`Cannot find configuration file at \`${argv.configPath}\`. Use config-sample.json as a starting point, pass --configPath option`));
   handleError(err);
 })
-.then(config => {
+.then(async config => {
+  const log = (config.verbose === false) ? _.noop : console.log;
+
   mongoose.Promise = global.Promise;
   mongoose.connect(config.mongoUrl);
-  return gtfsToHtml(config);
-})
-.then(() => {
-  console.log('Completed Generating HTML schedules');
+
+  await gtfsToHtml(config);
+
+  log('Completed Generating HTML schedules');
   process.exit();
 })
 .catch(handleError);

lib/formatters.js

@@ -105,14 +105,6 @@ exports.formatDays = calendar => {
   return dayString;
 };
 
-exports.formatCalendars = calendars => {
-  return calendars.map(item => {
-    const calendar = item.toObject();
-    calendar.dayList = exports.formatDays(calendar);
-    return calendar;
-  });
-};
-
 exports.formatRouteName = route => {
   if (route.route_short_name !== '' && route.route_short_name !== undefined) {
     return route.route_short_name;

lib/gtfs-to-html.js

@@ -64,7 +64,7 @@ module.exports = selectedConfig => {
 
         // Make directory, if it doesn't exist
         return fs.ensureDir(path.join(exportPath, datePath))
-        .then(() => utils.generateHTML(agencyKey, timetablePage, config))
+        .then(() => utils.generateHTML(timetablePage, config))
         .then(results => {
           _.each(outputStats, (stat, key) => {
             if (results.stats[key]) {

lib/utils.js

@@ -93,7 +93,7 @@ const getSpecialDates = async timetable => {
   };
 };
 
-const processStops = async (agencyKey, timetable, config) => {
+const processStops = async (timetable, config) => {
   timetable.showDayList = false;
   timetable.noServiceSymbolUsed = false;
   timetable.requestStopSymbolUsed = false;
@@ -119,13 +119,14 @@ const processStops = async (agencyKey, timetable, config) => {
         }
         return false;
       });
-      if (!stop) {
-        return;
-      }
-      stop.trips.push(formatters.formatStopTime(stoptime, timetable, config));
 
-      if (stop.type === 'arrival') {
-        timetable.stops[stopIndex + 1].trips.push(formatters.formatStopTime(stoptime, timetable, config));
+      if (stop) {
+        stop.trips.push(formatters.formatStopTime(stoptime, timetable, config));
+
+        // If showing arrival and departure times, add trip to the departure stop
+        if (stop.type === 'arrival') {
+          timetable.stops[stopIndex + 1].trips.push(formatters.formatStopTime(stoptime, timetable, config));
+        }
       }
     });
 
@@ -141,7 +142,7 @@ const processStops = async (agencyKey, timetable, config) => {
   const stopIds = _.map(timetable.stops, 'stop_id');
 
   const stopDatas = await gtfs.getStops({
-    agency_key: agencyKey,
+    agency_key: timetable.agency_key,
     stop_id: {
       $in: stopIds
     }
@@ -155,7 +156,7 @@ const processStops = async (agencyKey, timetable, config) => {
   // If `showStopCity` is true, look up stop attributes.
   if (config.showStopCity) {
     const stopAttributes = await gtfs.getStopAttributes({
-      agency_key: agencyKey,
+      agency_key: timetable.agency_key,
       stop_id: {
         $in: stopIds
       }
@@ -213,8 +214,20 @@ function getDaysFromCalendars(calendars) {
   return days;
 }
 
-const convertRouteToTimetablePage = async (agencyKey, route, direction) => {
+const convertTimetableToTimetablePage = async timetable => {
+  const filename = await generateFileName(timetable);
+  return {
+    agency_key: timetable.agency_key,
+    timetable_page_id: timetable.timetable_id,
+    timetable_page_label: timetable.timetable_label,
+    timetables: [timetable],
+    filename
+  };
+};
+
+const convertRouteToTimetablePage = async (route, direction) => {
   const timetable = {
+    agency_key: route.agency_key,
     timetable_id: `${route.route_id}_${direction.direction_id}`,
     timetable_label: `${formatters.formatRouteName(route)} to ${direction.trip_headsign}`,
     route_id: route.route_id,
@@ -223,20 +236,14 @@ const convertRouteToTimetablePage = async (agencyKey, route, direction) => {
     end_date: parseInt(formatters.toGTFSDate(moment().add(1, 'week')), 10)
   };
 
-  const trips = gtfs.getTrips({
-    agency_key: agencyKey,
+  const serviceIds = await gtfs.getTrips({
+    agency_key: route.agency_key,
     route_id: route.route_id,
     direction_id: direction.direction_id
-  });
-
-  if (trips.length === 0) {
-    return;
-  }
-
-  const serviceIds = _.uniq(_.map(trips, 'service_id'));
+  }).distinct('service_id');
 
   const calendars = await gtfs.getCalendars({
-    agency_key: agencyKey,
+    agency_key: route.agency_key,
     service_id: {
       $in: serviceIds
     }
@@ -248,17 +255,6 @@ const convertRouteToTimetablePage = async (agencyKey, route, direction) => {
   return convertTimetableToTimetablePage(timetable);
 };
 
-const convertTimetableToTimetablePage = async timetable => {
-  const filename = await generateFileName(timetable);
-  return {
-    agency_key: timetable.agency_key,
-    timetable_page_id: timetable.timetable_id,
-    timetable_page_label: timetable.timetable_label,
-    timetables: [timetable],
-    filename
-  };
-};
-
 const convertRoutesToTimetablePages = async agencyKey => {
   const routes = await gtfs.getRoutes({agency_key: agencyKey});
   const timetablePages = await Promise.all(routes.map(async route => {
@@ -269,7 +265,7 @@ const convertRoutesToTimetablePages = async agencyKey => {
     const directionGroups = _.groupBy(results, direction => direction.direction_id);
     return Promise.all(_.map(directionGroups, directionGroup => {
       const direction = directionGroup[0];
-      return convertRouteToTimetablePage(agencyKey, route, direction);
+      return convertRouteToTimetablePage(route, direction);
     }));
   }));
 
@@ -327,7 +323,24 @@ const formatTimetablePage = async timetablePage => {
   }
 
   return timetablePage;
-}
+};
+
+const getTimetableGeoJSON = async (timetable, config) => {
+  const shapesGeojson = await gtfs.getShapesAsGeoJSON({
+    agency_key: timetable.agency_key,
+    route_id: timetable.route_id,
+    direction_id: timetable.direction_id
+  });
+
+  const stopsGeojson = await gtfs.getStopsAsGeoJSON({
+    agency_key: timetable.agency_key,
+    route_id: timetable.route_id,
+    direction_id: timetable.direction_id
+  });
+
+  const geojson = await geojsonMerge.merge([shapesGeojson, stopsGeojson]);
+  return simplifyGeoJSON(geojson, config.coordinatePrecision);
+};
 
 function simplifyGeoJSON(geojson, coordinatePrecision) {
   if (coordinatePrecision === undefined) {
@@ -362,7 +375,7 @@ exports.setDefaultConfig = config => {
   return Object.assign(defaults, config);
 };
 
-exports.generateHTML = async (agencyKey, timetablePage, config) => {
+exports.generateHTML = async (timetablePage, config) => {
   const stats = {
     stops: 0,
     trips: 0,
@@ -378,7 +391,7 @@ exports.generateHTML = async (agencyKey, timetablePage, config) => {
   // Format Timetables
   await Promise.all(timetablePage.timetables.map(async timetable => {
     const query = {
-      agency_key: agencyKey,
+      agency_key: timetablePage.agency_key,
       start_date: {$lt: timetable.end_date},
       end_date: {$gte: timetable.start_date}
     };
@@ -401,20 +414,19 @@ exports.generateHTML = async (agencyKey, timetablePage, config) => {
       }
     });
 
-    const calendars = await gtfs.getCalendars(query);
-    if (calendars.length === 0) {
+    timetable.calendars = await gtfs.getCalendars(query);
+    if (timetable.calendars.length === 0) {
       throw new Error(`No calendars found for start_date=${timetable.start_date}, end_date=${timetable.end_date}, timetable_id=${timetable.timetable_id}`);
     }
-    // Get Calendars
-    timetable.calendars = formatters.formatCalendars(calendars);
+
     timetable.serviceIds = _.map(timetable.calendars, 'service_id');
     timetable.serviceIds.forEach(serviceId => {
       stats.serviceIds[serviceId] = true;
     });
     stats.routeIds[timetable.route_id] = true;
     timetable.dayList = formatters.formatDays(timetable);
     const routes = await gtfs.getRoutes({
-      agency_key: agencyKey,
+      agency_key: timetablePage.agency_key,
       route_id: timetable.route_id
     });
 
@@ -424,7 +436,7 @@ exports.generateHTML = async (agencyKey, timetablePage, config) => {
     timetable.route = routes[0];
 
     timetable.trips = await gtfs.getTrips({
-      agency_key: agencyKey,
+      agency_key: timetablePage.agency_key,
       route_id: timetable.route_id,
       direction_id: timetable.direction_id,
       service_id: {
@@ -440,7 +452,7 @@ exports.generateHTML = async (agencyKey, timetablePage, config) => {
     stats.trips += timetable.trips.length;
 
     const timetableStopOrders = await gtfs.getTimetableStopOrders({
-      agency_key: agencyKey,
+      agency_key: timetablePage.agency_key,
       timetable_id: timetable.timetable_id
     });
 
@@ -452,7 +464,7 @@ exports.generateHTML = async (agencyKey, timetablePage, config) => {
       trip.dayList = formatters.formatDays(trip.calendar);
 
       const stoptimes = await gtfs.getStoptimes({
-        agency_key: agencyKey,
+        agency_key: timetablePage.agency_key,
         trip_id: trip.trip_id
       });
 
@@ -465,38 +477,17 @@ exports.generateHTML = async (agencyKey, timetablePage, config) => {
 
       return trip;
     }));
+    timetable.orderedTrips = sortTrips(trips);
 
     timetable.stops = getStops(timetableStopOrders, longestTrip.stoptimes);
     stats.stops += timetable.stops.length;
 
-    if (!trips || trips.length === 0) {
-      throw new Error(`No trips found for timetable_id=${timetable.timetable_id}`);
-    }
-
-    timetable.orderedTrips = sortTrips(trips);
-
-    await processStops(agencyKey, timetable, config);
+    await processStops(timetable, config);
 
     timetable.specialDates = await getSpecialDates(timetable);
 
     if (config.showMap) {
-      const shapesGeojson = await gtfs.getShapesAsGeoJSON({
-        agency_key: agencyKey,
-        route_id: timetable.route_id,
-        direction_id: timetable.direction_id
-      });
-
-      const stopsGeojson = await gtfs.getStopsAsGeoJSON({
-        agency_key: agencyKey,
-        route_id: timetable.route_id,
-        direction_id: timetable.direction_id
-      });
-
-      const geojson = await geojsonMerge.merge([shapesGeojson, stopsGeojson]);
-      timetable.geojson = await simplifyGeoJSON(geojson, config.coordinatePrecision);
-      timetable.hasShapes = _.some(geojson.features, feature => {
-        return feature.geometry.type === 'LineString';
-      });
+      timetable.geojson = await getTimetableGeoJSON(timetable, config);
     }
   }));
 
@@ -567,20 +558,22 @@ exports.getTimetablePage = async (agencyKey, timetablePageId) => {
     const directionId = parseInt(parts.pop(), 10);
     const routeId = parts.join('_');
     const routes = await gtfs.getRoutes({
-      agenct_key: agencyKey,
+      agency_key: agencyKey,
       route_id: routeId
     });
 
     if (routes.length === 0) {
       throw new Error(`No route found for route_id=${routeId}`);
     }
+
+    const route = routes[0];
     const directions = await gtfs.getDirectionsByRoute({
       agency_key: agencyKey,
-      route_id: routeId,
+      route_id: routeId
     });
 
     const direction = _.find(directions, direction => direction.direction_id === directionId);
-    timetablePages = await convertRouteToTimetablePage(agencyKey, result, direction);
+    timetablePages = [await convertRouteToTimetablePage(route, direction)];
   } else if (timetablePages.length === 0) {
     // If no timetablepage, use timetable
     const timetable = _.find(timetables, {timetable_id: timetablePageId});