@opentripplanner/core-utils 13.0.0-alpha.4 → 13.0.0

package/src/__tests__/__snapshots__/route.js.snap

@@ -1,73 +1,85 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`util > route routeComparator should prioritize routes with integer shortNames over alphabetic shortNames 1`] = `
+exports[`util > route routeComparator should prioritize OTP1 routes with valid sortOrder 1`] = `
 Array [
   Object {
-    "longName": "A-line",
+    "agencyId": "bcd",
+    "longName": "Around town",
     "mode": "BUS",
-    "shortName": "A",
-    "sortOrder": -999,
+    "shortName": "20",
+    "sortOrder": 2,
   },
   Object {
-    "longName": "Loop route",
-    "mode": "BUS",
-    "shortName": "2",
+    "agencyId": "bcd",
+    "longName": "Around another town",
+    "shortName": "3",
     "sortOrder": -999,
+    "type": 3,
   },
 ]
 `;
 
-exports[`util > route routeComparator should prioritize routes with shortNames over those with just longNames 1`] = `
+exports[`util > route routeComparator should prioritize OTP2 routes with valid sortOrder 1`] = `
 Array [
   Object {
-    "longName": "B-line",
+    "longName": "Loop route",
     "mode": "BUS",
-    "shortName": "B",
+    "shortName": "2",
     "sortOrder": -999,
   },
   Object {
-    "longName": "A meandering route",
+    "longName": "Across town",
     "mode": "BUS",
-    "sortOrder": -999,
+    "shortName": "10",
+    "sortOrder": 10,
+  },
+  Object {
+    "longName": "Around another town",
+    "shortName": "3",
+    "sortOrder": null,
+    "type": 3,
   },
 ]
 `;
 
-exports[`util > route routeComparator should prioritize routes with valid sortOrder 1`] = `
+exports[`util > route routeComparator should prioritize routes with alphabetic shortNames over integer shortNames 1`] = `
 Array [
   Object {
-    "longName": "Around another town",
-    "shortName": "3",
+    "agencyId": "bcd",
+    "longName": "A-line",
+    "mode": "BUS",
+    "shortName": "A",
     "sortOrder": -999,
-    "type": 3,
   },
   Object {
-    "longName": "Around town",
+    "agencyId": "bcd",
+    "longName": "Loop route",
     "mode": "BUS",
-    "shortName": "20",
-    "sortOrder": 2,
+    "shortName": "2",
+    "sortOrder": -999,
   },
 ]
 `;
 
-exports[`util > route routeComparator should sort based off of route type 1`] = `
+exports[`util > route routeComparator should prioritize routes with shortNames over those with just longNames 1`] = `
 Array [
   Object {
-    "longName": "Yellow line Subway",
-    "mode": "SUBWAY",
-    "shortName": "Yellow",
-    "sortOrder": 2,
+    "agencyId": "bcd",
+    "longName": "B-line",
+    "mode": "BUS",
+    "shortName": "B",
+    "sortOrder": -999,
   },
   Object {
-    "longName": "Intercity Train",
-    "mode": "RAIL",
-    "shortName": "IC",
-    "sortOrder": 2,
+    "agencyId": "bcd",
+    "longName": "A meandering route",
+    "mode": "BUS",
+    "sortOrder": -999,
   },
 ]
 `;
 
-exports[`util > route routeComparator should sort routes based off of agencyName 1`] = `
+exports[`util > route routeComparator should sort OTP1 routes on all of the criteria at once 1`] = `
 Array [
   Object {
     "agencyId": "abc",
@@ -76,6 +88,7 @@ Array [
     "mode": "BUS",
     "routeId": "2:erx",
     "shortName": "30X",
+    "sortOrder": 10,
   },
   Object {
     "agencyId": "abc",
@@ -84,110 +97,135 @@ Array [
     "mode": "RAIL",
     "routeId": "1:it2",
     "shortName": "IC",
+    "sortOrder": 10,
   },
-]
-`;
-
-exports[`util > route routeComparator should sort routes based off of integer shortName 1`] = `
-Array [
   Object {
-    "longName": "Loop route",
+    "agencyId": "bcd",
+    "longName": "Yellow line Subway",
+    "mode": "SUBWAY",
+    "shortName": "Yellow",
+    "sortOrder": 2,
+  },
+  Object {
+    "agencyId": "bcd",
+    "longName": "Intercity Train",
+    "mode": "RAIL",
+    "shortName": "IC",
+    "sortOrder": 2,
+  },
+  Object {
+    "agencyId": "bcd",
+    "longName": "Local route",
     "mode": "BUS",
-    "shortName": "2",
-    "sortOrder": -999,
+    "shortName": "6",
+    "sortOrder": 2,
   },
   Object {
-    "longName": "Around another town",
-    "shortName": "3",
-    "sortOrder": -999,
-    "type": 3,
+    "agencyId": "bcd",
+    "longName": "Around town",
+    "mode": "BUS",
+    "shortName": "20",
+    "sortOrder": 2,
   },
-]
-`;
-
-exports[`util > route routeComparator should sort routes based off of longNames 1`] = `
-Array [
   Object {
+    "agencyId": "bcd",
     "longName": "Express route",
     "mode": "BUS",
     "shortName": "30",
     "sortOrder": 2,
   },
   Object {
+    "agencyId": "bcd",
     "longName": "Variation of express route",
     "mode": "BUS",
     "shortName": "30",
     "sortOrder": 2,
   },
-]
-`;
-
-exports[`util > route routeComparator should sort routes based off of shortNames 1`] = `
-Array [
   Object {
+    "agencyId": "bcd",
+    "longName": "Zig-zagging route",
+    "mode": "BUS",
+    "shortName": "30",
+    "sortOrder": 2,
+  },
+  Object {
+    "agencyId": "bcd",
+    "longName": "Xpress route C",
+    "mode": "BUS",
+    "shortName": "30C",
+    "sortOrder": 2,
+  },
+  Object {
+    "agencyId": "bcd",
+    "longName": "Across town",
+    "mode": "BUS",
+    "shortName": "10",
+    "sortOrder": 10,
+  },
+  Object {
+    "agencyId": "bcd",
     "longName": "A-line",
     "mode": "BUS",
     "shortName": "A",
     "sortOrder": -999,
   },
   Object {
+    "agencyId": "bcd",
     "longName": "B-line",
     "mode": "BUS",
     "shortName": "B",
     "sortOrder": -999,
   },
-]
-`;
-
-exports[`util > route routeComparator should sort routes based off of sortOrder 1`] = `
-Array [
-  Object {
-    "longName": "Around town",
-    "mode": "BUS",
-    "shortName": "20",
-    "sortOrder": 2,
-  },
   Object {
-    "longName": "Across town",
+    "agencyId": "bcd",
+    "longName": "Loop route",
     "mode": "BUS",
-    "shortName": "10",
-    "sortOrder": 10,
+    "shortName": "2",
+    "sortOrder": -999,
   },
-]
-`;
-
-exports[`util > route routeComparator should sort routes based off of transitOperators sort value when a match is found 1`] = `
-Array [
   Object {
-    "agencyId": "abc",
-    "agencyName": "Agency 1",
-    "longName": "Intercity Train 2",
-    "mode": "RAIL",
-    "routeId": "1:it2",
-    "shortName": "IC",
+    "agencyId": "bcd",
+    "longName": "Around another town",
+    "shortName": "3",
+    "sortOrder": -999,
+    "type": 3,
   },
   Object {
-    "agencyId": "abc",
-    "agencyName": "Acclaimed agency 1",
+    "agencyId": "bcd",
     "longName": "Express route X",
     "mode": "BUS",
-    "routeId": "2:erx",
     "shortName": "30X",
   },
+  Object {
+    "agencyId": "bcd",
+    "longName": "A meandering route",
+    "mode": "BUS",
+    "sortOrder": -999,
+  },
 ]
 `;
 
-exports[`util > route routeComparator should sort routes on all of the criteria at once 1`] = `
+exports[`util > route routeComparator should sort OTP2 routes on all of the criteria at once 1`] = `
 Array [
   Object {
-    "longName": "Yellow line Subway",
-    "mode": "SUBWAY",
-    "shortName": "Yellow",
+    "agency": Object {
+      "id": "abc",
+      "name": "Acclaimed agency 1",
+    },
+    "longName": "Express route X",
+    "mode": "BUS",
+    "routeId": "2:erx",
+    "shortName": "30X",
     "sortOrder": 2,
   },
   Object {
-    "longName": "Intercity Train",
+    "agency": Object {
+      "id": "abc",
+      "name": "Agency 1",
+    },
+    "longName": "Intercity Train 2",
     "mode": "RAIL",
+    "routeId": "1:it2",
     "shortName": "IC",
     "sortOrder": 2,
   },
@@ -197,12 +235,6 @@ Array [
     "shortName": "A",
     "sortOrder": -999,
   },
-  Object {
-    "longName": "B-line",
-    "mode": "BUS",
-    "shortName": "B",
-    "sortOrder": -999,
-  },
   Object {
     "longName": "Loop route",
     "mode": "BUS",
@@ -210,10 +242,16 @@ Array [
     "sortOrder": -999,
   },
   Object {
-    "longName": "Around another town",
-    "shortName": "3",
-    "sortOrder": -999,
-    "type": 3,
+    "longName": "Yellow line Subway",
+    "mode": "SUBWAY",
+    "shortName": "Yellow",
+    "sortOrder": 2,
+  },
+  Object {
+    "longName": "Intercity Train",
+    "mode": "RAIL",
+    "shortName": "IC",
+    "sortOrder": 2,
   },
   Object {
     "longName": "Local route",
@@ -263,27 +301,179 @@ Array [
     "shortName": "10",
     "sortOrder": 10,
   },
+  Object {
+    "longName": "B-line",
+    "mode": "BUS",
+    "shortName": "B",
+  },
+  Object {
+    "longName": "Around another town",
+    "shortName": "3",
+    "sortOrder": null,
+    "type": 3,
+  },
   Object {
     "longName": "A meandering route",
     "mode": "BUS",
+  },
+]
+`;
+
+exports[`util > route routeComparator should sort based off of route type 1`] = `
+Array [
+  Object {
+    "agencyId": "bcd",
+    "longName": "Yellow line Subway",
+    "mode": "SUBWAY",
+    "shortName": "Yellow",
+    "sortOrder": 2,
+  },
+  Object {
+    "agencyId": "bcd",
+    "longName": "Intercity Train",
+    "mode": "RAIL",
+    "shortName": "IC",
+    "sortOrder": 2,
+  },
+]
+`;
+
+exports[`util > route routeComparator should sort routes based off of agencyName if no transitOperators are defined 1`] = `
+Array [
+  Object {
+    "agencyId": "abc",
+    "agencyName": "Acclaimed agency 1",
+    "longName": "Express route X",
+    "mode": "BUS",
+    "routeId": "2:erx",
+    "shortName": "30X",
+    "sortOrder": 10,
+  },
+  Object {
+    "agencyId": "abc",
+    "agencyName": "Agency 1",
+    "longName": "Intercity Train 2",
+    "mode": "RAIL",
+    "routeId": "1:it2",
+    "shortName": "IC",
+    "sortOrder": 10,
+  },
+]
+`;
+
+exports[`util > route routeComparator should sort routes based off of integer shortName 1`] = `
+Array [
+  Object {
+    "agencyId": "bcd",
+    "longName": "Loop route",
+    "mode": "BUS",
+    "shortName": "2",
     "sortOrder": -999,
   },
+  Object {
+    "agencyId": "bcd",
+    "longName": "Around another town",
+    "shortName": "3",
+    "sortOrder": -999,
+    "type": 3,
+  },
+]
+`;
+
+exports[`util > route routeComparator should sort routes based off of longNames 1`] = `
+Array [
+  Object {
+    "agencyId": "bcd",
+    "longName": "Express route",
+    "mode": "BUS",
+    "shortName": "30",
+    "sortOrder": 2,
+  },
+  Object {
+    "agencyId": "bcd",
+    "longName": "Variation of express route",
+    "mode": "BUS",
+    "shortName": "30",
+    "sortOrder": 2,
+  },
+]
+`;
+
+exports[`util > route routeComparator should sort routes based off of shortNames 1`] = `
+Array [
+  Object {
+    "agencyId": "bcd",
+    "longName": "A-line",
+    "mode": "BUS",
+    "shortName": "A",
+    "sortOrder": -999,
+  },
+  Object {
+    "agencyId": "bcd",
+    "longName": "B-line",
+    "mode": "BUS",
+    "shortName": "B",
+    "sortOrder": -999,
+  },
+]
+`;
+
+exports[`util > route routeComparator should sort routes based off of sortOrder 1`] = `
+Array [
+  Object {
+    "agencyId": "bcd",
+    "longName": "Around town",
+    "mode": "BUS",
+    "shortName": "20",
+    "sortOrder": 2,
+  },
+  Object {
+    "agencyId": "bcd",
+    "longName": "Across town",
+    "mode": "BUS",
+    "shortName": "10",
+    "sortOrder": 10,
+  },
+]
+`;
+
+exports[`util > route routeComparator should sort routes based off of transitOperators sort value when a match is found 1`] = `
+Array [
+  Object {
+    "agencyId": "abc",
+    "agencyName": "Agency 1",
+    "longName": "Intercity Train 2",
+    "mode": "RAIL",
+    "routeId": "1:it2",
+    "shortName": "IC",
+    "sortOrder": 10,
+  },
+  Object {
+    "agencyId": "abc",
+    "agencyName": "Acclaimed agency 1",
+    "longName": "Express route X",
+    "mode": "BUS",
+    "routeId": "2:erx",
+    "shortName": "30X",
+    "sortOrder": 10,
+  },
 ]
 `;
 
 exports[`util > route routeComparator should sort routes with alphanumeric shortNames 1`] = `
 Array [
   Object {
+    "agencyId": "bcd",
     "longName": "Xpress route C",
     "mode": "BUS",
     "shortName": "30C",
     "sortOrder": 2,
   },
   Object {
+    "agencyId": "bcd",
     "longName": "Express route X",
     "mode": "BUS",
     "shortName": "30X",
-    "sortOrder": 2,
   },
 ]
 `;

package/src/__tests__/route.js

@@ -5,25 +5,7 @@ import {
   makeRouteComparator
 } from "../route";
 
-const {
-  route1,
-  route2,
-  route3,
-  route4,
-  route5,
-  route6,
-  route7,
-  route8,
-  route9,
-  route10,
-  route11,
-  route12,
-  route13,
-  route14,
-  route15,
-  route16,
-  route17
-} = require("./__mocks__/routes.json");
+const { otp1Routes, otp2Routes } = require("./__mocks__/routes.json");
 
 function sortRoutes(...routes) {
   routes.sort(makeRouteComparator());
@@ -47,7 +29,7 @@ describe("util > route", () => {
     });
   });
 
-  describe("getTransitOperatorFromOtpRoute", () => {
+  describe("getTransitOperatorFromOtp1Route", () => {
     const otpRoute = { agencyId: "abc", id: "1:abc" };
     it("should get a transit operator", () => {
       const expectedTransitOperator = { agencyId: "abc", feedId: "1" };
@@ -65,8 +47,8 @@ describe("util > route", () => {
   });
 
   describe("routeComparator", () => {
-    it("should sort routes based off of agencyName", () => {
-      expect(sortRoutes(route16, route17)).toMatchSnapshot();
+    it("should sort routes based off of agencyName if no transitOperators are defined", () => {
+      expect(sortRoutes(otp1Routes[15], otp1Routes[16])).toMatchSnapshot();
     });
 
     it("should sort routes based off of transitOperators sort value when a match is found", () => {
@@ -74,66 +56,56 @@ describe("util > route", () => {
         { agencyId: "abc", feedId: "1", order: 2 },
         { agencyId: "abc", feedId: "2", order: 1 }
       ]);
-      const routes = [route16, route17];
+      const routes = [otp1Routes[15], otp1Routes[16]];
       expect(routes.sort(comparatorWithTransitOperators)).toMatchSnapshot();
     });
 
     it("should sort routes based off of sortOrder", () => {
-      expect(sortRoutes(route1, route2)).toMatchSnapshot();
+      expect(sortRoutes(otp1Routes[0], otp1Routes[1])).toMatchSnapshot();
     });
 
-    it("should prioritize routes with valid sortOrder", () => {
-      expect(sortRoutes(route2, route3)).toMatchSnapshot();
+    it("should prioritize OTP1 routes with valid sortOrder", () => {
+      expect(sortRoutes(otp1Routes[1], otp1Routes[2])).toMatchSnapshot();
+    });
+
+    it("should prioritize OTP2 routes with valid sortOrder", () => {
+      expect(
+        sortRoutes(otp2Routes[0], otp2Routes[2], otp2Routes[3])
+      ).toMatchSnapshot();
     });
 
     it("should sort routes based off of integer shortName", () => {
-      expect(sortRoutes(route3, route4)).toMatchSnapshot();
+      expect(sortRoutes(otp1Routes[2], otp1Routes[3])).toMatchSnapshot();
     });
 
-    it("should prioritize routes with integer shortNames over alphabetic shortNames", () => {
-      expect(sortRoutes(route4, route5)).toMatchSnapshot();
+    it("should prioritize routes with alphabetic shortNames over integer shortNames", () => {
+      expect(sortRoutes(otp1Routes[3], otp1Routes[4])).toMatchSnapshot();
     });
 
     it("should sort routes based off of shortNames", () => {
-      expect(sortRoutes(route5, route6)).toMatchSnapshot();
+      expect(sortRoutes(otp1Routes[4], otp1Routes[5])).toMatchSnapshot();
     });
 
     it("should sort routes with alphanumeric shortNames", () => {
-      expect(sortRoutes(route14, route15)).toMatchSnapshot();
+      expect(sortRoutes(otp1Routes[13], otp1Routes[14])).toMatchSnapshot();
     });
 
     it("should prioritize routes with shortNames over those with just longNames", () => {
-      expect(sortRoutes(route6, route7)).toMatchSnapshot();
+      expect(sortRoutes(otp1Routes[5], otp1Routes[6])).toMatchSnapshot();
     });
 
     it("should sort routes based off of longNames", () => {
-      expect(sortRoutes(route9, route10)).toMatchSnapshot();
+      expect(sortRoutes(otp1Routes[8], otp1Routes[9])).toMatchSnapshot();
     });
-
-    it("should sort routes on all of the criteria at once", () => {
-      expect(
-        sortRoutes(
-          route1,
-          route2,
-          route3,
-          route4,
-          route5,
-          route6,
-          route7,
-          route8,
-          route9,
-          route10,
-          route11,
-          route12,
-          route13,
-          route14,
-          route15
-        )
-      ).toMatchSnapshot();
+    it("should sort OTP1 routes on all of the criteria at once", () => {
+      expect(sortRoutes(...otp1Routes)).toMatchSnapshot();
+    });
+    it("should sort OTP2 routes on all of the criteria at once", () => {
+      expect(sortRoutes(...otp2Routes)).toMatchSnapshot();
     });
 
     it("should sort based off of route type", () => {
-      expect(sortRoutes(route12, route13)).toMatchSnapshot();
+      expect(sortRoutes(otp1Routes[11], otp1Routes[12])).toMatchSnapshot();
     });
   });