@transportme/load-ptv-gtfs 1.2.6 → 1.3.0

package/lib/gtfs-parser/GTFSStop.mjs

@@ -3,8 +3,16 @@ import { STOP_UTILS } from '@transportme/transportvic-utils'
 
 const { processName, getPrimaryStopName, getSecondaryStopName } = STOP_UTILS
 
+export const STOP_TYPE = {
+  0: 'stop',
+  1: 'station',
+  2: 'entrance',
+  3: 'generic',
+  4: 'boarding',
+}
+
 export class GTFSStop {
- 
+
   stopGTFSID
   originalName
   rawStopName
@@ -13,12 +21,19 @@ export class GTFSStop {
   location
   suburb
 
+  location
+  parentStopGTFSID
+
   #isInterstate = false
   #suburbInFrontMatch
 
-  constructor({ stopGTFSID, stopName, stopLat, stopLon }, suburbs) {
+  constructor({ stopGTFSID, stopName, stopLat, stopLon, locationType, parentStopGTFSID }, suburbs) {
     this.stopGTFSID = stopGTFSID
     this.originalName = stopName.replace(/ \(\w+\.\.\. #/, ' #').replace(/  +/g, ' ').trim()
+
+    this.locationType = locationType || '0'
+    this.parentStopGTFSID = parentStopGTFSID || null
+
     this.location = {
       type: 'Point',
       coordinates: [parseFloat(stopLon), parseFloat(stopLat)]
@@ -181,7 +196,8 @@ export class GTFSStop {
       mode,
       suburb: this.suburb,
       services: [],
-      screenServices: []
+      screenServices: [],
+      stopType: STOP_TYPE[this.locationType]
     }
   }
 
@@ -228,7 +244,7 @@ export class GTFSRRBStop extends GTFSPlatformStop {
   }
 
   static canProcess(data) {
-    return super.canProcess(data) && data.platform === 'R-Bus'
+    return super.canProcess(data) && data.platform.toLowerCase().includes('bus')
   }
 
 }

package/lib/gtfs-parser/readers/GTFSStopsReader.mjs

@@ -28,7 +28,9 @@ export default class GTFSStopsReader extends GTFSReader {
       stopName: data.stop_name,
       stopLat: data.stop_lat,
       stopLon: data.stop_lon,
-      platform: data.platform_code
+      platform: data.platform_code,
+      locationType: data.location_type,
+      parentStopGTFSID: data.parent_station
     }
 
     return GTFSStop.create(stopData, this.#suburbData)

package/lib/loader/StopsLoader.mjs

@@ -1,5 +1,5 @@
 import { STOP_UTILS } from '@transportme/transportvic-utils'
-import { GTFSStop } from '../gtfs-parser/GTFSStop.mjs'
+import { GTFSStop, STOP_TYPE } from '../gtfs-parser/GTFSStop.mjs'
 import GTFSStopsReader from '../gtfs-parser/readers/GTFSStopsReader.mjs'
 
 const { getPrimaryStopName, isStreetStop, sanitiseName } = STOP_UTILS
@@ -10,6 +10,8 @@ export default class StopsLoader {
   #mode
   #stopsReader
 
+  #parentHolding = {}
+
   /**
    * Creates a new Stop Loader.
    * 
@@ -42,6 +44,12 @@ export default class StopsLoader {
     })
   }
 
+  async findParentStop(stop) {
+    return await this.#stops.findDocument({
+      'bays.stopGTFSID': stop.parentStopGTFSID
+    })
+  }
+
   generateDBStopData(stop, mergeName) {
     let cleanName = sanitiseName(stop.fullStopName)
 
@@ -68,6 +76,7 @@ export default class StopsLoader {
 
   updateStopName(stop) {
     stop.cleanNames = stop.bays
+      .filter(bay => bay.stopType === STOP_TYPE[0])
       .map(bay => sanitiseName(bay.fullStopName))
       .filter((e, i, a) => a.indexOf(e) === i)
 
@@ -84,10 +93,12 @@ export default class StopsLoader {
 
   updateStopSuburb(stop) {
     stop.cleanSuburbs = stop.bays
+      .filter(bay => bay.stopType === STOP_TYPE[0])
       .map(bay => sanitiseName(bay.suburb))
       .filter((e, i, a) => a.indexOf(e) === i)
 
     stop.suburb = stop.bays
+      .filter(bay => bay.stopType === STOP_TYPE[0])
       .map(bay => bay.suburb)
       .filter((e, i, a) => a.indexOf(e) === i)
       .sort()
@@ -129,6 +140,18 @@ export default class StopsLoader {
   async loadStop(stop, { processStop, getMergeName } = {}) {
     let processedData = processStop ? processStop(stop) : stop
 
+    if (processedData.parentStopGTFSID) {
+      let parentStop = await this.findParentStop(processedData)
+      if (!parentStop) {
+        if (!this.#parentHolding[processedData.parentStopGTFSID]) this.#parentHolding[processedData.parentStopGTFSID] = []
+        this.#parentHolding[processedData.parentStopGTFSID].push(processedData)
+        return
+      }
+
+      let stopData = this.generateDBStopData(processedData, parentStop.mergeName)
+      return await this.mergeStops(parentStop, stopData)
+    }
+
     let defaultMergeName = this.getMergeName(processedData)
     let mergeName = getMergeName ? (getMergeName(processedData) || defaultMergeName) : defaultMergeName
 
@@ -140,6 +163,14 @@ export default class StopsLoader {
     } else {
       await this.#stops.createDocument(stopData)
     }
+
+    if (this.#parentHolding[stop.stopGTFSID]) {
+      for (let childStop of this.#parentHolding[stop.stopGTFSID]) {
+        let childStopData = this.generateDBStopData(childStop, stopData.mergeName)
+        await this.mergeStops(stopData, childStopData)
+      }
+      delete this.#parentHolding[stop.stopGTFSID]
+    }
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transportme/load-ptv-gtfs",
-  "version": "1.2.6",
+  "version": "1.3.0",
   "description": "",
   "main": "index.mjs",
   "scripts": {

package/test/gtfs-stop-loader.test.mjs

@@ -26,6 +26,8 @@ const specialHeader = path.join(__dirname, 'sample-data', 'gtfs-splitting', 'spe
 
 const unionWithSpaces = path.join(__dirname, 'sample-data', 'gtfs-splitting', 'union_with_spaces.txt')
 
+const parentStopsFile = path.join(__dirname, 'sample-data', 'parent-stop', 'stops.txt')
+
 describe('The GTFS Stops Loader', () => {
   it('Should process the stops and add them to the database', async () => {
     let database = new LokiDatabaseConnection('test-db')
@@ -320,4 +322,21 @@ describe('The GTFS Stops Loader', () => {
     expect(await stops.countDocuments({})).to.equal(1)
     expect((await stops.findDocument({ 'bays.stopGTFSID': '26535' })).bays.length).to.equal(4) // Union Station
   })
+
+  it('Should merge stops into their designated parent stops even if the names do not match', async () => {
+    let database = new LokiDatabaseConnection('test-db')
+    let stops = await database.createCollection('stops')
+
+    await (new StopsLoader(parentStopsFile, suburbs, TRANSIT_MODES.metroTrain, database)).loadStops()
+
+    expect(await stops.countDocuments({})).to.equal(1)
+    let stopData = await stops.findDocument({})
+    expect(stopData.bays.find(bay => bay.stopGTFSID === '14331').stopType).to.equal('stop')
+    expect(stopData.bays.find(bay => bay.stopGTFSID === 'vic:rail:CHL').stopType).to.equal('station')
+    expect(stopData.bays.find(bay => bay.stopGTFSID === 'vic:rail:CHL_DP3').stopType).to.equal('generic')
+    expect(stopData.bays.find(bay => bay.stopGTFSID === 'vic:rail:CHL_EN1').stopType).to.equal('entrance')
+
+    // TODO: Find out what the Connex stop is for
+    expect(stopData.cleanNames).to.equal(['clifton-hill-railway-station', 'connex'])
+  })
 })

package/test/gtfs-stops.test.mjs

@@ -9,6 +9,8 @@ const __dirname = path.dirname(__filename)
 
 const stopsFile = path.join(__dirname, 'sample-data', 'gtfs-splitting', 'line_reader_test.txt')
 
+const parentStopsFile = path.join(__dirname, 'sample-data', 'parent-stop', 'stops.txt')
+
 let stopInput = {
   stop_id: '1000',
   stop_name: 'Dole Ave/Cheddar Rd (Reservoir)',
@@ -52,6 +54,16 @@ describe('The GTFSStopReader class', () => {
       expect(stopData.suburb).to.equal('Kings Park')
       expect(stopData.stopNumber).to.equal('51A')
     })
+
+    it('Should return the parent stop data if available', async () => {
+      let stopReader = new GTFSStopsReader(parentStopsFile, suburbs)
+      await stopReader.open()
+
+      let stopData = await stopReader.getNextEntity()
+      expect(stopData.rawStopName).to.equal('Clifton Hill Station')
+      expect(stopData.stopGTFSID).to.equal('14330')
+      expect(stopData.parentStopGTFSID).to.equal('vic:rail:CHL')
+    })
   })
 
   describe('The getNextEntity function', () => {

package/test/sample-data/parent-stop/stops.txt

@@ -0,0 +1,15 @@
+stop_id,stop_name,stop_lat,stop_lon,location_type,parent_station,wheelchair_boarding,level_id,platform_code
+"14330","Clifton Hill Station","-37.78847865","144.99550102","","vic:rail:CHL","1","Level 0","1"
+"14331","Clifton Hill Station","-37.78868312","144.99533652","","vic:rail:CHL","1","Level 0","2"
+"26140","Clifton Hill Rail Replacement Bus Stop","-37.78899337","144.99503289","","vic:rail:CHL","1","Level 0","Replacement bus"
+"vic:rail:CHL","Clifton Hill Railway Station","-37.78865745","144.99541670","1","","1","",""
+"vic:rail:CHL_BR1","Bike & Ride","-37.78862432","144.99558793","3","vic:rail:CHL","","Level 0",""
+"vic:rail:CHL_ConX","Connex","-37.78865745","144.99541670","","vic:rail:CHL","","Level 0",""
+"vic:rail:CHL_DP1","Ramp","-37.78814003","144.99572593","3","vic:rail:CHL","","Level -1",""
+"vic:rail:CHL_DP2","Underpass","-37.78810586","144.99530670","3","vic:rail:CHL","","Level -1",""
+"vic:rail:CHL_DP3","Ramp","-37.78805406","144.99491065","3","vic:rail:CHL","","Level -1",""
+"vic:rail:CHL_EN1","John St","-37.78849918","144.99564809","2","vic:rail:CHL","1","Level 0",""
+"vic:rail:CHL_EN2","Hoddle St","-37.78860913","144.99522496","2","vic:rail:CHL","1","Level 0",""
+"vic:rail:CHL_EN3","Hoddle St","-37.78877108","144.99520923","2","vic:rail:CHL","1","Level 0",""
+"vic:rail:CHL_PR1","Park & Ride 1","-37.78928973","144.99550182","3","vic:rail:CHL","","Level 0",""
+"vic:rail:CHL_PR2","Park & Ride 2","-37.78785120","144.99569967","3","vic:rail:CHL","","Level 0",""