Add functions: resetTable, getNumberOfItemInTable, resetFrequencies, …

…resetAgencies, resetStops, resetTransfers

.gitignore

@@ -58,3 +58,6 @@ typings/
 .env
 
 .idea/
+
+# VS code configuration
+.vscode

gtfs.js

@@ -41,7 +41,6 @@ function addItems(gtfs, tableName, items) {
     });
   }
 }
-
 /**
  * Table-generic function to get an indexed table of a GTFS. The indexation depends of the table, and is defined in
  * the schema (see schema.js).
@@ -150,6 +149,35 @@ function getSizeOfMap(map) {
   return (map instanceof Map) ? map.size : 0;
 }
 
+/**
+ * Table-generic function to reset a table of a GTFS (ie, create a new Map)
+ *
+ * @param {Gtfs}           gtfs      GTFS object containing the table to be reset.
+ * @param {string}         tableName Name of the table to be reset.
+ */
+function resetTable(gtfs, tableName) {
+  gtfs._tables.set(tableName, new Map());
+}
+
+/**
+ * Table-generic function to get the number of items in the provided GTFS table
+ *
+ * @param {Gtfs}           gtfs      GTFS object containing the table.
+ * @param {string}         tableName Name of the table to be get the number of item from.
+ */
+function getNumberOfItemsInTable(gtfs, tableName) {
+  const deepness = gtfs._schema.deepnessByTableName[tableName];
+
+  if (deepness !== 1) {
+    throw new Error(`'${tableName}' has a deepness of ${deepness}. \
+      getNumberOfItemsInTable can only apply on a first level table.`);
+  }
+
+  const indexedTable = gtfs.getIndexedTable(tableName);
+
+  return getSizeOfMap(indexedTable);
+}
+
 class Gtfs {
   /**
    * Constructor of the GTFS
@@ -335,6 +363,13 @@ class Gtfs {
    */
   getActualKeysForTable(tableName) { return getters.getActualKeysForTable(this, tableName); }
 
+  /**
+   * Table-generic function returning the number of items in the provided GTFS table.
+   *
+   * @param  {string}         tableName Name of the table of the GTFS
+   */
+  getNumberOfItemsInTable(tableName) { return getNumberOfItemsInTable(this, tableName); }
+
   /**
    * Get the parent item using one of its child.
    *
@@ -360,6 +395,14 @@ class Gtfs {
    */
   removeItemsInTable(items, tableName) { removeItems(this, tableName, items); }
 
+  /**
+   * Table-generic function to reset a GTFS table (ie, create a new Map)
+   *
+   * @param {Gtfs}           gtfs      GTFS object containing the table to be reset.
+   * @param {string}         tableName Name of the table to be reset.
+   */
+  resetTable(tableName) { resetTable(this, tableName); }
+
   /**
    * Table-generic function to set an indexed table in the GTFS.
    *
@@ -368,7 +411,6 @@ class Gtfs {
    */
   setIndexedItemsAsTable(indexedItems, tableName) { setIndexedItems(this, tableName, indexedItems); }
 
-
   /* agency.txt */
 
   /**
@@ -439,6 +481,11 @@ class Gtfs {
    */
   removeAgencies(agencies) { removeItems(this, 'agency', agencies); }
 
+  /**
+   * Reset the map of indexed agencies.
+   */
+  resetAgencies() { resetTable(this, 'agency'); }
+
   /**
    * Set the map of indexed agencies.
    *
@@ -519,6 +566,11 @@ class Gtfs {
    */
   removeStops(stops) { removeItems(this, 'stops', stops); }
 
+  /**
+   * Reset the map of indexed stops.
+   */
+  resetStops() { resetTable(this, 'stops'); }
+
   /**
    * Set the map of indexed stops.
    *
@@ -564,7 +616,7 @@ class Gtfs {
    *
    * @returns {number}
    */
-  getNumberOfRoutes() { return getIndexedTable(this, 'routes').size; }
+  getNumberOfRoutes() { return getNumberOfItemsInTable(this, 'routes'); }
 
   /**
    * Get the route using one of its grand child stopTime.
@@ -623,6 +675,11 @@ class Gtfs {
    */
   removeRoutes(routes) { removeItems(this, 'routes', routes); }
 
+  /**
+   * Reset the map of indexed routes.
+   */
+  resetRoutes() { resetTable(this, 'routes'); }
+
   /**
    * Set the map of indexed routes.
    *
@@ -632,12 +689,6 @@ class Gtfs {
    */
   setIndexedRoutes(indexedRoutes) { setIndexedItems(this, 'routes', indexedRoutes); }
 
-  /**
-   * Reset the map of indexed routes.
-   */
-  resetRoutes() { setIndexedItems(this, 'routes', new Map()); }
-
-
   /* trips.txt */
 
   /**
@@ -736,7 +787,7 @@ class Gtfs {
   /**
    * Reset the map of indexed trips.
    */
-  resetTrips() { setIndexedItems(this, 'trips', new Map()); }
+  resetTrips() { resetTable(this, 'trips'); }
 
 
   /* stop_times.txt */
@@ -865,7 +916,7 @@ class Gtfs {
   /**
    * Reset the map of indexed stop times.
    */
-  resetStopTimes() { setIndexedItems(this, 'stop_times', new Map()); }
+  resetStopTimes() { resetTable(this, 'stop_times'); }
 
 
   /* calendar.txt */
@@ -949,7 +1000,7 @@ class Gtfs {
   /**
    * Reset the map of indexed calendars.
    */
-  resetCalendars() { setIndexedItems(this, 'calendar', new Map()); }
+  resetCalendars() { resetTable(this, 'calendar'); }
 
   /**
    * Set the map of indexed calendars.
@@ -990,7 +1041,7 @@ class Gtfs {
    * @param {Object}   trip     Trip scoping the calendar dates in which to enumerate.
    * @param {function} iterator Function which will be applied on every calendar dates of the trip.
    */
-  forEachGtfsCalendarDateOfTrip(trip, iterator) {
+  forEachCalendarDateOfTrip(trip, iterator) {
     const calendarDateByDate = this.getCalendarDateByDateOfTrip(trip);
 
     if (calendarDateByDate instanceof Map) {
@@ -1004,7 +1055,7 @@ class Gtfs {
    * @param {string}   serviceId  Service id scoping the calendar dates in which to enumerate.
    * @param {function} iterator   Function which will be applied on every calendar dates of the service.
    */
-  forEachGtfsCalendarDateWithServiceId(serviceId, iterator) {
+  forEachCalendarDateWithServiceId(serviceId, iterator) {
     const calendarDateByDateByServiceId = this.getIndexedCalendarDates();
     const calendarDateByDate = calendarDateByDateByServiceId.get(serviceId);
 
@@ -1055,7 +1106,7 @@ class Gtfs {
    * @param {string}   serviceId  Service id to for which to check if calendar dates are defined.
    * @returns {boolean}
    */
-  hasGtfsCalendarDatesWithServiceId(serviceId) {
+  hasCalendarDatesWithServiceId(serviceId) {
     const calendarDateByDateByServiceId = this.getIndexedCalendarDates();
     const calendarDateByDate = calendarDateByDateByServiceId.get(serviceId);
 
@@ -1077,9 +1128,9 @@ class Gtfs {
   removeCalendarDates(calendarDates) { removeItems(this, 'calendar_dates', calendarDates); }
 
   /**
-   * Reset the map of indexed calendars.
+   * Reset the map of indexed calendars dates.
    */
-  resetCalendarDates() { setIndexedItems(this, 'calendar_dates', new Map()); }
+  resetCalendarDates() { resetTable(this, 'calendar_dates'); }
 
   /**
    * Set the map of indexed calendarDates.
@@ -1130,7 +1181,7 @@ class Gtfs {
    * @param {string}   shapeId  Service id scoping the calendar dates in which to enumerate.
    * @param {function} iterator   Function which will be applied on every calendar dates of the service.
    */
-  forEachGtfsShapePointOfShapeId(shapeId, iterator) {
+  forEachShapePointOfShapeId(shapeId, iterator) {
     const shapePointByShapePointSequenceByShapeId = this.getIndexedShapePoints();
     const shapePointByShapePointSequence = shapePointByShapePointSequenceByShapeId.get(shapeId);
 
@@ -1192,7 +1243,7 @@ class Gtfs {
   /**
    * Reset the shape points.
    */
-  resetShapePoints() { setIndexedItems(this, 'shapes', new Map()); }
+  resetShapePoints() { resetTable(this, 'shapes'); }
 
   /**
    * Set the map of indexed shapePoints.
@@ -1259,6 +1310,11 @@ class Gtfs {
    */
   removeFrequencies(frequencies) { removeItems(this, 'frequencies', frequencies); }
 
+  /**
+   * Reset the map of indexed frequencies.
+   */
+  resetFrequencies() { resetTable(this, 'frequencies'); }
+
   /**
    * Set the map of indexed frequencies.
    *
@@ -1324,6 +1380,11 @@ class Gtfs {
    */
   removeTransfers(transfers) { removeItems(this, 'transfers', transfers); }
 
+  /**
+   * Reset the map of indexed transfers.
+   */
+  resetTransfers() { resetTable(this, 'transfers'); }
+
   /**
    * Set the map of indexed transfers.
    *

tests/test_calendar_dates.js

@@ -110,10 +110,10 @@ describe('Tests on GTFS calendar dates', () => {
     done();
   });
 
-  it('Tests on gtfs.forEachCalendarDateWithServiceId(serviceId, iterator)', (done) => {
+  it('Tests on gtfs.hasCalendarDatesWithServiceId(serviceId, iterator)', (done) => {
     const gtfs = new Gtfs(`${__dirname}/samples/1`);
 
-    expect(gtfs.hasGtfsCalendarDatesWithServiceId('service_1')).to.equal(false);
+    expect(gtfs.hasCalendarDatesWithServiceId('service_1')).to.equal(false);
 
     gtfs.setIndexedCalendarDates(new Map([
       ['service_0', new Map([
@@ -126,7 +126,7 @@ describe('Tests on GTFS calendar dates', () => {
       ])],
     ]));
 
-    expect(gtfs.forEachCalendarDateWithServiceId('service_1')).to.equal(true);
+    expect(gtfs.hasCalendarDatesWithServiceId('service_1')).to.equal(true);
 
     done();
   });

tests/test_generic_table_functions.js

@@ -83,7 +83,6 @@ describe('Tests on GTFS generic table functions', () => {
     expect(() => gtfs.getNumberOfItemsInTable('stop_times')).to.throw();
 
     done();
-    done();
   });
 });
 

tests/test_shapes.js

@@ -76,7 +76,7 @@ describe('Tests on GTFS shapes', () => {
 
     const shapePointSequencesForShape1 = [];
     gtfs.forEachShapePointOfShapeId('shape_1', (calendarDates) => {
-      shapePointSequencesForShape1.push(calendarDates.exception_type);
+      shapePointSequencesForShape1.push(calendarDates.shape_pt_sequence);
     });
     expect(shapePointSequencesForShape1.sort()).to.deep.equal(['6', '7']);