gtfs-to-html 2.7.2 → 2.8.0

package/lib/gtfs-to-html.js

@@ -1,214 +0,0 @@
-import path from 'node:path';
-import { mkdir, writeFile } from 'node:fs/promises';
-
-import { map } from 'lodash-es';
-import { openDb, importGtfs } from 'gtfs';
-import sanitize from 'sanitize-filename';
-import Timer from 'timer-machine';
-
-import {
-  prepDirectory,
-  copyStaticAssets,
-  generateFolderName,
-  renderPdf,
-  zipFolder,
-  generateFileName,
-} from './file-utils.js';
-import {
-  log,
-  logWarning,
-  logError,
-  progressBar,
-  generateLogText,
-  logStats,
-} from './log-utils.js';
-import {
-  setDefaultConfig,
-  getTimetablePagesForAgency,
-  getFormattedTimetablePage,
-  generateTimetableHTML,
-  generateTimetableCSV,
-  generateOverviewHTML,
-  generateStats,
-} from './utils.js';
-
-/*
- * Generate HTML timetables from GTFS.
- */
-/* eslint-disable complexity */
-const gtfsToHtml = async (initialConfig) => {
-  const config = setDefaultConfig(initialConfig);
-  const timer = new Timer();
-
-  config.log = log(config);
-  config.logWarning = logWarning(config);
-  config.logError = logError(config);
-
-  timer.start();
-
-  try {
-    openDb(config);
-  } 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.`,
-      );
-    }
-
-    throw error;
-  }
-
-  if (!config.agencies || config.agencies.length === 0) {
-    throw new Error('No agencies defined in `config.json`');
-  }
-
-  if (!config.skipImport) {
-    // Import GTFS
-    await importGtfs(config);
-  }
-
-  const agencyKey = config.agencies
-    .map((agency) => agency.agency_key ?? 'unknown')
-    .join('-');
-  const exportPath = path.join(process.cwd(), 'html', sanitize(agencyKey));
-  const outputStats = {
-    timetables: 0,
-    timetablePages: 0,
-    calendars: 0,
-    trips: 0,
-    routes: 0,
-    stops: 0,
-    warnings: [],
-  };
-
-  const timetablePages = [];
-  const timetablePageIds = map(
-    getTimetablePagesForAgency(config),
-    'timetable_page_id',
-  );
-  await prepDirectory(exportPath);
-
-  if (config.noHead !== true && ['html', 'pdf'].includes(config.outputFormat)) {
-    copyStaticAssets(config, exportPath);
-  }
-
-  const bar = progressBar(
-    `${agencyKey}: Generating ${config.outputFormat.toUpperCase()} timetables {bar} {value}/{total}`,
-    timetablePageIds.length,
-    config,
-  );
-
-  /* eslint-disable no-await-in-loop */
-  for (const timetablePageId of timetablePageIds) {
-    try {
-      const timetablePage = await getFormattedTimetablePage(
-        timetablePageId,
-        config,
-      );
-
-      for (const timetable of timetablePage.timetables) {
-        for (const warning of timetable.warnings) {
-          outputStats.warnings.push(warning);
-          bar.interrupt(warning);
-        }
-      }
-
-      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;
-
-      const datePath = generateFolderName(timetablePage);
-
-      // Make directory if it doesn't exist
-      await mkdir(path.join(exportPath, datePath), { recursive: true });
-      config.assetPath = '../';
-
-      timetablePage.relativePath = path.join(
-        datePath,
-        sanitize(timetablePage.filename),
-      );
-
-      if (config.outputFormat === 'csv') {
-        for (const timetable of timetablePage.consolidatedTimetables) {
-          const csv = await generateTimetableCSV(timetable);
-          const csvPath = path.join(
-            exportPath,
-            datePath,
-            generateFileName(timetable, config, 'csv'),
-          );
-          await writeFile(csvPath, csv);
-        }
-      } else {
-        const html = await generateTimetableHTML(timetablePage, config);
-        const htmlPath = path.join(
-          exportPath,
-          datePath,
-          sanitize(timetablePage.filename),
-        );
-        await writeFile(htmlPath, html);
-
-        if (config.outputFormat === 'pdf') {
-          await renderPdf(htmlPath);
-        }
-      }
-
-      timetablePages.push(timetablePage);
-      const timetableStats = generateStats(timetablePage);
-
-      for (const key of Object.keys(outputStats)) {
-        if (timetableStats[key]) {
-          outputStats[key] += timetableStats[key];
-        }
-      }
-    } catch (error) {
-      outputStats.warnings.push(error.message);
-      bar.interrupt(error.message);
-    }
-
-    bar.increment();
-  }
-  /* eslint-enable no-await-in-loop */
-
-  if (config.outputFormat === 'html') {
-    // Generate route summary index.html
-    config.assetPath = '';
-    const html = await generateOverviewHTML(timetablePages, config);
-    await writeFile(path.join(exportPath, 'index.html'), html);
-  }
-
-  // Generate output log.txt
-  const logText = generateLogText(outputStats, config);
-  await writeFile(path.join(exportPath, 'log.txt'), logText);
-
-  // Zip output, if specified
-  if (config.zipOutput) {
-    await zipFolder(exportPath);
-  }
-
-  const fullExportPath = path.join(
-    exportPath,
-    config.zipOutput ? '/timetables.zip' : '',
-  );
-
-  // Print stats
-  config.log(
-    `${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`,
-  );
-
-  timer.stop();
-};
-/* eslint-enable complexity */
-
-export default gtfsToHtml;

package/lib/log-utils.js

@@ -1,215 +0,0 @@
-import { clearLine, cursorTo } from 'node:readline';
-import { noop } from 'lodash-es';
-import * as colors from 'yoctocolors';
-import { getFeedInfo } from 'gtfs';
-import Table from 'cli-table';
-
-/*
- * Creates text for a log of output details.
- */
-export function generateLogText(outputStats, config) {
-  const feedInfo = getFeedInfo();
-  const feedVersion =
-    feedInfo.length > 0 && feedInfo[0].feed_version
-      ? feedInfo[0].feed_version
-      : 'Unknown';
-
-  const logText = [
-    `Feed Version: ${feedVersion}`,
-    `GTFS-to-HTML Version: ${config.gtfsToHtmlVersion}`,
-    `Date Generated: ${new Date().toISOString()}`,
-    `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}`,
-  ];
-
-  for (const agency of config.agencies) {
-    if (agency.url) {
-      logText.push(`Source: ${agency.url}`);
-    } else if (agency.path) {
-      logText.push(`Source: ${agency.path}`);
-    }
-  }
-
-  if (outputStats.warnings.length > 0) {
-    logText.push('', 'Warnings:', ...outputStats.warnings);
-  }
-
-  return logText.join('\n');
-}
-
-/*
- * Returns a log function based on config settings
- */
-export function log(config) {
-  if (config.verbose === false) {
-    return noop;
-  }
-
-  if (config.logFunction) {
-    return config.logFunction;
-  }
-
-  return (text, overwrite) => {
-    if (overwrite === true && process.stdout.isTTY) {
-      clearLine(process.stdout, 0);
-      cursorTo(process.stdout, 0);
-    } else {
-      process.stdout.write('\n');
-    }
-
-    process.stdout.write(text);
-  };
-}
-
-/*
- * Returns an warning log function based on config settings
- */
-export function logWarning(config) {
-  if (config.logFunction) {
-    return config.logFunction;
-  }
-
-  return (text) => {
-    process.stdout.write(`\n${formatWarning(text)}\n`);
-  };
-}
-
-/*
- * Returns an error log function based on config settings
- */
-export function logError(config) {
-  if (config.logFunction) {
-    return config.logFunction;
-  }
-
-  return (text) => {
-    process.stdout.write(`\n${formatError(text)}\n`);
-  };
-}
-
-/*
- * Format console warning text
- */
-export function formatWarning(text) {
-  const warningMessage = `${colors.underline('Warning')}: ${text}`;
-  return colors.yellow(warningMessage);
-}
-
-/*
- * Format console error text
- */
-export function formatError(error) {
-  const messageText = error instanceof Error ? error.message : error;
-  const errorMessage = `${colors.underline('Error')}: ${messageText.replace(
-    'Error: ',
-    '',
-  )}`;
-  return colors.red(errorMessage);
-}
-
-/*
- * Print a table of stats to the console.
- */
-export function logStats(stats, config) {
-  // Hide stats table from custom log functions
-  if (config.logFunction) {
-    return;
-  }
-
-  const table = new Table({
-    colWidths: [40, 20],
-    head: ['Item', 'Count'],
-  });
-
-  table.push(
-    ['📄 Timetable Pages', stats.timetablePages],
-    ['🕑 Timetables', stats.timetables],
-    ['📅 Calendar Service IDs', stats.calendars],
-    ['🔄 Routes', stats.routes],
-    ['🚍 Trips', stats.trips],
-    ['🛑 Stops', stats.stops],
-    ['⛔️ Warnings', stats.warnings.length],
-  );
-
-  config.log(table.toString());
-}
-
-/*
- * Create progress bar text string
- */
-const generateProgressBarString = (barTotal, barProgress, size = 40) => {
-  const line = '-';
-  const slider = '=';
-  if (!barTotal) {
-    throw new Error('Total value is either not provided or invalid');
-  }
-
-  if (!barProgress && barProgress !== 0) {
-    throw new Error('Current value is either not provided or invalid');
-  }
-
-  if (isNaN(barTotal)) {
-    throw new Error('Total value is not an integer');
-  }
-
-  if (isNaN(barProgress)) {
-    throw new Error('Current value is not an integer');
-  }
-
-  if (isNaN(size)) {
-    throw new Error('Size is not an integer');
-  }
-
-  if (barProgress > barTotal) {
-    return slider.repeat(size + 2);
-  }
-
-  const percentage = barProgress / barTotal;
-  const progress = Math.round(size * percentage);
-  const emptyProgress = size - progress;
-  const progressText = slider.repeat(progress);
-  const emptyProgressText = line.repeat(emptyProgress);
-  return progressText + emptyProgressText;
-};
-
-/*
- * Print a progress bar to the console.
- */
-export function progressBar(formatString, barTotal, config) {
-  let barProgress = 0;
-
-  if (config.verbose === false) {
-    return {
-      increment: noop,
-      interrupt: noop,
-    };
-  }
-
-  if (barTotal === 0) {
-    return null;
-  }
-
-  const renderProgressString = () =>
-    formatString
-      .replace('{value}', barProgress)
-      .replace('{total}', barTotal)
-      .replace('{bar}', generateProgressBarString(barTotal, barProgress));
-
-  config.log(renderProgressString(), true);
-
-  return {
-    interrupt(text) {
-      // Log two lines to avoid overwrite by progress bar
-      config.logWarning(text);
-      config.log('');
-    },
-    increment() {
-      barProgress += 1;
-      config.log(renderProgressString(), true);
-    },
-  };
-}

package/lib/template-functions.js

@@ -1,192 +0,0 @@
-import { every } from 'lodash-es';
-
-/*
- * Format an id to be used as an HTML attribute.
- */
-export function formatHtmlId(id) {
-  return id.replace(/([^\w[\]{}.:-])\s?/g, '');
-}
-
-/*
- * Discern if a day list should be shown for a specific timetable (if some
- * trips happen on different days).
- */
-export function timetableHasDifferentDays(timetable) {
-  return !every(timetable.orderedTrips, (trip, idx) => {
-    if (idx === 0) {
-      return true;
-    }
-
-    return trip.dayList === timetable.orderedTrips[idx - 1].dayList;
-  });
-}
-
-/*
- * Discern if a day list should be shown for a specific timetable page's menu (if some
- * timetables are for different days).
- */
-export function timetablePageHasDifferentDays(timetablePage) {
-  return !every(timetablePage.consolidatedTimetables, (timetable, idx) => {
-    if (idx === 0) {
-      return true;
-    }
-
-    return (
-      timetable.dayListLong ===
-      timetablePage.consolidatedTimetables[idx - 1].dayListLong
-    );
-  });
-}
-
-/*
- * Discern if individual timetable labels should be shown (if some
- * timetables have different labels).
- */
-export function timetablePageHasDifferentLabels(timetablePage) {
-  return !every(timetablePage.consolidatedTimetables, (timetable, idx) => {
-    if (idx === 0) {
-      return true;
-    }
-
-    return (
-      timetable.timetable_label ===
-      timetablePage.consolidatedTimetables[idx - 1].timetable_label
-    );
-  });
-}
-
-/*
- * Discern if a timetable has any notes or notices to display.
- */
-export function hasNotesOrNotices(timetable) {
-  return (
-    timetable.requestPickupSymbolUsed ||
-    timetable.noPickupSymbolUsed ||
-    timetable.requestDropoffSymbolUsed ||
-    timetable.noDropoffSymbolUsed ||
-    timetable.noServiceSymbolUsed ||
-    timetable.interpolatedStopSymbolUsed ||
-    timetable.notes.length > 0
-  );
-}
-
-/*
- * Return an array of all timetable notes that relate to the entire timetable or route.
- */
-export function getNotesForTimetableLabel(notes) {
-  return notes.filter((note) => !note.stop_id && !note.trip_id);
-}
-
-/*
- * Return an array of all timetable notes for a specific stop and stop_sequence.
- */
-export function getNotesForStop(notes, stop) {
-  return notes.filter((note) => {
-    // Don't show if note applies only to a specific trip.
-    if (note.trip_id) {
-      return false;
-    }
-
-    // Don't show if note applies only to a specific stop_sequence that is not found.
-    if (
-      note.stop_sequence &&
-      !stop.trips.some((trip) => trip.stop_sequence === note.stop_sequence)
-    ) {
-      return false;
-    }
-
-    return note.stop_id === stop.stop_id;
-  });
-}
-
-/*
- * Return an array of all timetable notes for a specific trip.
- */
-export function getNotesForTrip(notes, trip) {
-  return notes.filter((note) => {
-    // Don't show if note applies only to a specific stop.
-    if (note.stop_id) {
-      return false;
-    }
-
-    return note.trip_id === trip.trip_id;
-  });
-}
-
-/*
- * Return an array of all timetable notes for a specific stoptime.
- */
-export function getNotesForStoptime(notes, stoptime) {
-  return notes.filter((note) => {
-    // Show notes that apply to all trips at this stop if `show_on_stoptime` is true.
-    if (
-      !note.trip_id &&
-      note.stop_id === stoptime.stop_id &&
-      note.show_on_stoptime === 1
-    ) {
-      return true;
-    }
-
-    // Show notes that apply to all stops of this trip if `show_on_stoptime` is true.
-    if (
-      !note.stop_id &&
-      note.trip_id === stoptime.trip_id &&
-      note.show_on_stoptime === 1
-    ) {
-      return true;
-    }
-
-    return (
-      note.trip_id === stoptime.trip_id && note.stop_id === stoptime.stop_id
-    );
-  });
-}
-
-/*
- * Formats a trip name.
- */
-export function formatTripName(trip, index, timetable) {
-  let tripName;
-  if (timetable.routes.length > 1) {
-    tripName = trip.route_short_name;
-  } else if (timetable.orientation === 'horizontal') {
-    // Only add this to horizontal timetables.
-    if (trip.trip_short_name) {
-      tripName = trip.trip_short_name;
-    } else {
-      tripName = `Run #${index + 1}`;
-    }
-  }
-
-  if (timetableHasDifferentDays(timetable)) {
-    tripName += ` ${trip.dayList}`;
-  }
-
-  return tripName;
-}
-
-/*
- * Formats a trip name.
- */
-export function formatTripNameForCSV(trip, timetable) {
-  let tripName = '';
-  if (timetable.routes.length > 1) {
-    tripName += `${trip.route_short_name} - `;
-  }
-
-  if (trip.trip_short_name) {
-    tripName += trip.trip_short_name;
-  } else {
-    tripName += trip.trip_id;
-  }
-
-  if (trip.trip_headsign) {
-    tripName += ` - ${trip.trip_headsign}`;
-  }
-
-  if (timetableHasDifferentDays(timetable)) {
-    tripName += ` - ${trip.dayList}`;
-  }
-
-  return tripName;
-}

package/lib/time-utils.js

@@ -1,90 +0,0 @@
-import moment from 'moment';
-
-/*
- * 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');
-}
-
-/*
- * Convert a GTFS formatted date string into a moment.
- */
-export function fromGTFSDate(gtfsDate) {
-  return moment(gtfsDate, 'YYYYMMDD');
-}
-
-/*
- * Convert a moment date into a GTFS formatted date string.
- */
-export function toGTFSDate(date) {
-  return moment(date).format('YYYYMMDD');
-}
-
-/*
- * Convert a object of weekdays into a a string containing 1s and 0s.
- */
-export function calendarToCalendarCode(c) {
-  if (c.service_id) {
-    return c.service_id;
-  }
-
-  return `${c.monday}${c.tuesday}${c.wednesday}${c.thursday}${c.friday}${c.saturday}${c.sunday}`;
-}
-
-/*
- * Convert a string of 1s and 0s representing a weekday to an object.
- */
-export function calendarCodeToCalendar(code) {
-  const days = [
-    'monday',
-    'tuesday',
-    'wednesday',
-    'thursday',
-    'friday',
-    'saturday',
-    'sunday',
-  ];
-  const calendar = {};
-
-  for (const [index, day] of days.entries()) {
-    calendar[day] = code[index];
-  }
-
-  return calendar;
-}
-
-/*
- * Get number of seconds after midnight of a GTFS formatted time string.
- */
-export function secondsAfterMidnight(timeString) {
-  return moment.duration(timeString).asSeconds();
-}
-
-/*
- * Get number of minutes after midnight of a GTFS formatted time string.
- */
-export function minutesAfterMidnight(timeString) {
-  return moment.duration(timeString).asMinutes();
-}
-
-/*
- * Add specified number of seconds to a GTFS formatted time string.
- */
-export function updateTimeByOffset(timeString, offsetSeconds) {
-  const newTime = fromGTFSTime(timeString);
-  return toGTFSTime(newTime.add(offsetSeconds, 'seconds'));
-}