mailwoman 0.2.0

package/test/functional/functional.test.ts

@@ -0,0 +1,80 @@
+/**
+ * @copyright OpenISP, Inc.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import { assert } from "mailwoman/sdk/test/utils"
+// street simple
+assert("main pl", [{ street: "main pl" }])
+
+// street directional
+assert("west main st", [{ street: "west main st" }])
+assert("main st west", [{ street: "main st west" }])
+
+// street ordinal
+assert("10th ave", [{ street: "10th ave" }])
+
+// street cardinal
+assert("10 ave", [{ street: "10 ave" }])
+
+// address simple
+assert("1 main pl", [{ housenumber: "1" }, { street: "main pl" }])
+
+// address with ordinal
+assert("100 10th ave", [{ housenumber: "100" }, { street: "10th ave" }])
+
+// address with cardinal
+assert("100 10 ave", [{ housenumber: "100" }, { street: "10 ave" }])
+
+// address with directional
+assert("1 north main blvd", [{ housenumber: "1" }, { street: "north main blvd" }])
+assert("1 main blvd north", [{ housenumber: "1" }, { street: "main blvd north" }])
+
+// address with directional & ordinal
+assert("30 west 26th street", [{ housenumber: "30" }, { street: "west 26th street" }])
+
+// street with directional, ordinal & admin info
+assert("West 26th Street, New York, NYC, 10010", [
+	{ street: "West 26th Street" },
+	{ locality: "New York" },
+	{ postcode: "10010" },
+])
+
+// do not classify tokens preceeded by a 'place' as
+// an admin classification
+assert("Portland Cafe Portland OR", [{ venue: "Portland Cafe" }, { locality: "Portland" }, { region: "OR" }])
+
+// trailing directional causes issue with autocomplete
+assert("1 Foo St N", [{ housenumber: "1" }, { street: "Foo St" }])
+assert("1 Foo St S", [{ housenumber: "1" }, { street: "Foo St" }])
+assert("1 Foo St E", [{ housenumber: "1" }, { street: "Foo St" }])
+assert("1 Foo St W", [{ housenumber: "1" }, { street: "Foo St" }])
+
+// ...but we allow two letter directionals
+assert("1 Foo St NW", [{ housenumber: "1" }, { street: "Foo St NW" }])
+assert("1 Foo St NE", [{ housenumber: "1" }, { street: "Foo St NE" }])
+assert("1 Foo St SW", [{ housenumber: "1" }, { street: "Foo St SW" }])
+assert("1 Foo St SE", [{ housenumber: "1" }, { street: "Foo St SE" }])
+
+// invalid solutions (because the classification pairings dont make sense logically)
+assert("1 San Francisco", [], false)
+assert("1 California", [], false)
+assert("1 USA", [], false)
+assert("1 San Francisco California", [], false)
+assert("1 San Francisco USA", [], false)
+assert("1 San Francisco California USA", [], false)
+assert("1 California USA", [], false)
+assert("1 90210", [], false)
+
+// unit type specified with no accompanying unit number, unit type should
+// be removed by the OrphanedUnitTypeDeclassifier.
+assert("Apartment", [], false)
+assert("Unit", [], false)
+assert("Space", [], false)
+
+// do not parse 'aus' as a locality if it follows a region
+assert("new south wales aus", [{ region: "new south wales" }, { country: "aus" }])
+
+// test that we don't interpret "ga" as a street suffix
+assert("jasper ga", [{ locality: "jasper" }, { region: "ga" }])

package/test/functional/intersection.test.ts

@@ -0,0 +1,410 @@
+/**
+ * @copyright OpenISP, Inc.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import { assert } from "mailwoman/sdk/test/utils"
+// intersection queries
+
+// intersection tokens as a prefix are currently unsupported
+// assert('Corner of Main St & Second Ave', [
+//   { street: 'Main St' }, { street: 'Second Ave' }
+// ])
+// assert('cnr west st and north ave', [
+//   { street: 'west st' }, { street: 'north ave' }
+// ])
+
+// assert("Main St & Second Ave", [
+// 	// ---
+// 	{ street: "Main St" },
+// 	{ street: "Second Ave" },
+// ])
+
+// assert("Main St @ Second Ave", [
+// 	// ---
+// 	{ street: "Main St" },
+// 	{ street: "Second Ave" },
+// ])
+
+// assert("Main St and Second Ave", [
+// 	// ---
+// 	{ street: "Main St" },
+// 	{ street: "Second Ave" },
+// ])
+
+// assert("12th Avenue and California Street", [
+// 	// ---
+// 	{ street: "12th Avenue" },
+// 	{ street: "California Street" },
+// ])
+
+// assert("15th Avenue and Fulton Street", [
+// 	// ---
+// 	{ street: "15th Avenue" },
+// 	{ street: "Fulton Street" },
+// ])
+
+// assert("17th Avenue & Anza Street", [
+// 	// ---
+// 	{ street: "17th Avenue" },
+// 	{ street: "Anza Street" },
+// ])
+
+// assert("Gleimstraße an der ecke von Schönhauser Allee", [
+// 	// ---
+// 	{ street: "Gleimstraße" },
+// 	{ street: "Schönhauser Allee" },
+// ])
+
+// assert("Gleimstraße und Schönhauserallee", [
+// 	// ---
+// 	{ street: "Gleimstraße" },
+// 	{ street: "Schönhauserallee" },
+// ])
+
+// should not consider intersection tokens for street name
+assert("& b", [], false)
+assert("@ b", [], false)
+assert("at b", [], false)
+assert("a &", [], false)
+assert("a @", [], false)
+assert("a at", [], false)
+assert("& street", [], false)
+// assert("@ street", [], false)
+// assert("carrer &", [], false)
+// assert("carrer @", [], false)
+
+// // should correctly parse street names containing an intersection token
+// assert("at street", [
+// 	// ---
+// 	{ street: "at street" },
+// ])
+// assert("corner street", [
+// 	// ---
+// 	{ street: "corner street" },
+// ])
+// assert("carrer en", [
+// 	// ---
+// 	{ street: "carrer en" },
+// ])
+// assert("carrer con", [
+// 	// ---
+// 	{ street: "carrer con" },
+// ])
+
+// // no street suffix
+// assert("foo & bar", [
+// 	// ---
+// 	{ street: "foo" },
+// 	{ street: "bar" },
+// ])
+// assert("foo and bar", [
+// 	// ---
+// 	{ street: "foo" },
+// 	{ street: "bar" },
+// ])
+// assert("foo at bar", [
+// 	// ---
+// 	{ street: "foo" },
+// 	{ street: "bar" },
+// ])
+// assert("foo @ bar", [
+// 	// ---
+// 	{ street: "foo" },
+// 	{ street: "bar" },
+// ])
+
+// // missing street suffix - alpha
+// assert("main st & side ave", [
+// 	// ---
+// 	{ street: "main st" },
+// 	{ street: "side ave" },
+// ])
+// assert("main st & side", [
+// 	// ---
+// 	{ street: "main st" },
+// 	{ street: "side" },
+// ])
+// assert("main & side ave", [
+// 	// ---
+// 	{ street: "main" },
+// 	{ street: "side ave" },
+// ])
+// assert("main & side", [
+// 	// ---
+// 	{ street: "main" },
+// 	{ street: "side" },
+// ])
+
+// // missing street suffix - ordinal
+// assert("1st st & 2nd ave", [
+// 	// ---
+// 	{ street: "1st st" },
+// 	{ street: "2nd ave" },
+// ])
+// assert("1st st & 2nd", [
+// 	// ---
+// 	{ street: "1st st" },
+// 	{ street: "2nd" },
+// ])
+// assert("1st & 2nd ave", [
+// 	// ---
+// 	{ street: "1st" },
+// 	{ street: "2nd ave" },
+// ])
+// assert("1st & 2nd", [
+// 	// ---
+// 	{ street: "1st" },
+// 	{ street: "2nd" },
+// ])
+
+// // missing street suffix - cardinal
+// assert("1 st & 2 ave", [
+// 	// ---
+// 	{ street: "1 st" },
+// 	{ street: "2 ave" },
+// ])
+// assert("1 st & 2", [
+// 	// ---
+// 	{ street: "1 st" },
+// 	{ street: "2" },
+// ])
+// assert("1 & 2 ave", [
+// 	// ---
+// 	{ street: "1" },
+// 	{ street: "2 ave" },
+// ])
+// assert("1 & 2", [
+// 	// ---
+// 	{ street: "1" },
+// 	{ street: "2" },
+// ])
+
+// assert("SW 6th & Pine", [
+// 	// ---
+// 	{ street: "SW 6th" },
+// 	{ street: "Pine" },
+// ])
+
+// assert("9th and Lambert", [
+// 	// ---
+// 	{ street: "9th" },
+// 	{ street: "Lambert" },
+// ])
+
+// assert("filbert & 32nd", [
+// 	// ---
+// 	{ street: "filbert" },
+// 	{ street: "32nd" },
+// ])
+
+// // Should not detect this as an intersection
+// // assert('University of Hawaii at Hilo', [
+// //   { street: 'SW 6th' }, { street: 'Pine' }
+// // ])
+// assert("national air and space museum", [
+// 	// ---
+// 	{ venue: "national air and space museum" },
+// ])
+
+// // Trimet syntax
+// // assert('9,Lambert', [
+// //   { street: '9' }, { street: 'Lambert' }
+// // ])
+
+// // real-world test cases
+// assert("Oak St At 16th St, Paso Robles, CA 93446, USA", [
+// 	{ street: "Oak St" },
+// 	{ street: "16th St" },
+// 	{ locality: "Paso Robles" },
+// 	{ region: "CA" },
+// 	{ postcode: "93446" },
+// 	{ country: "USA" },
+// ])
+// assert("N State St At E Grand Ave, Chicago, IL 60654, USA", [
+// 	{ street: "N State St" },
+// 	{ street: "E Grand Ave" },
+// 	{ locality: "Chicago" },
+// 	{ region: "IL" },
+// 	{ postcode: "60654" },
+// 	{ country: "USA" },
+// ])
+// assert("E Illinois St At N State St, Chicago, IL 60611, USA", [
+// 	{ street: "E Illinois St" },
+// 	{ street: "N State St" },
+// 	{ locality: "Chicago" },
+// 	{ region: "IL" },
+// 	{ postcode: "60611" },
+// 	{ country: "USA" },
+// ])
+// assert("112th St E At 17th St Sw, Puyallup, WA 98373, USA", [
+// 	{ street: "112th St E" },
+// 	{ street: "17th St Sw" },
+// 	{ locality: "Puyallup" },
+// 	{ region: "WA" },
+// 	{ postcode: "98373" },
+// 	{ country: "USA" },
+// ])
+// assert("Sw 152nd Ave At Sw 280th St, Naranja, FL 33032, USA", [
+// 	{ street: "Sw 152nd Ave" },
+// 	{ street: "Sw 280th St" },
+// 	{ locality: "Naranja" },
+// 	{ region: "FL" },
+// 	{ postcode: "33032" },
+// 	{ country: "USA" },
+// ])
+// assert("Stonecroft Blvd At Westfields Blvd, Chantilly, VA 20152, USA", [
+// 	{ street: "Stonecroft Blvd" },
+// 	{ street: "Westfields Blvd" },
+// 	{ locality: "Chantilly" },
+// 	{ region: "VA" },
+// 	{ postcode: "20152" },
+// 	{ country: "USA" },
+// ])
+// assert("Hennepin Ave At S 3rd St, Minneapolis, MN 55401, USA", [
+// 	{ street: "Hennepin Ave" },
+// 	{ street: "S 3rd St" },
+// 	{ locality: "Minneapolis" },
+// 	{ region: "MN" },
+// 	{ postcode: "55401" },
+// 	{ country: "USA" },
+// ])
+// // assert('S 00 Ew At E 400 S, Kokomo, IN 46902, USA', [
+// //   { street: 'S 00 Ew' }, { street: 'E 400 S' },
+// //   { locality: 'Kokomo' }, { region: 'IN' },
+// //   { postcode: '46902' }, { country: 'USA' }
+// // ])
+// assert("Sylvester Hwy At Branch Rd, Albany, GA 31705, USA", [
+// 	{ street: "Sylvester Hwy" },
+// 	{ street: "Branch Rd" },
+// 	{ locality: "Albany" },
+// 	{ region: "GA" },
+// 	{ postcode: "31705" },
+// 	{ country: "USA" },
+// ])
+// assert("E Riverside Dr At Montopolis Dr, Austin, TX 78741, USA", [
+// 	{ street: "E Riverside Dr" },
+// 	{ street: "Montopolis Dr" },
+// 	{ locality: "Austin" },
+// 	{ region: "TX" },
+// 	{ postcode: "78741" },
+// 	{ country: "USA" },
+// ])
+// assert("E Riverside Dr At Wickersham Ln, Austin, TX 78741, USA", [
+// 	{ street: "E Riverside Dr" },
+// 	{ street: "Wickersham Ln" },
+// 	{ locality: "Austin" },
+// 	{ region: "TX" },
+// 	{ postcode: "78741" },
+// 	{ country: "USA" },
+// ])
+// assert("Red River St At E Cesar Chavez St, Austin, TX 78701, USA", [
+// 	{ street: "Red River St" },
+// 	{ street: "E Cesar Chavez St" },
+// 	{ locality: "Austin" },
+// 	{ region: "TX" },
+// 	{ postcode: "78701" },
+// 	{ country: "USA" },
+// ])
+// assert("N Wells St At W Division St, Chicago, IL 60610, USA", [
+// 	{ street: "N Wells St" },
+// 	{ street: "W Division St" },
+// 	{ locality: "Chicago" },
+// 	{ region: "IL" },
+// 	{ postcode: "60610" },
+// 	{ country: "USA" },
+// ])
+// // assert('Akers Mill Rd At Riverbend Club Dr Se, Atlanta, GA 30339, USA', [
+// // { street: 'Akers Mill Rd' }, { street: 'Riverbend Club Dr Se' },
+// // { locality: 'Atlanta' }, { region: 'GA' },
+// // { postcode: '30339' }, { country: 'USA' }
+// // ])
+// assert("Wiederstein Rd At Fm 3009, Schertz, TX 78154, USA", [
+// 	{ street: "Wiederstein Rd" },
+// 	{ street: "Fm 3009" },
+// 	{ locality: "Schertz" },
+// 	{ region: "TX" },
+// 	{ postcode: "78154" },
+// 	{ country: "USA" },
+// ])
+// assert("Kingston Pike At Granite Dr, Circleville, OH 43113, USA", [
+// 	{ street: "Kingston Pike" },
+// 	{ street: "Granite Dr" },
+// 	{ locality: "Circleville" },
+// 	{ region: "OH" },
+// 	{ postcode: "43113" },
+// 	{ country: "USA" },
+// ])
+// assert("Manor Rd At Airport Blvd, Austin, TX 78722, USA", [
+// 	{ street: "Manor Rd" },
+// 	{ street: "Airport Blvd" },
+// 	{ locality: "Austin" },
+// 	{ region: "TX" },
+// 	{ postcode: "78722" },
+// 	{ country: "USA" },
+// ])
+// assert("S Interstate 35 At E William Cannon Dr, Austin, TX 78744, USA", [
+// 	{ street: "S Interstate 35" },
+// 	{ street: "E William Cannon Dr" },
+// 	{ locality: "Austin" },
+// 	{ region: "TX" },
+// 	{ postcode: "78744" },
+// 	{ country: "USA" },
+// ])
+// assert("E Riverside Dr At Burton Dr, Austin, TX 78741, USA", [
+// 	{ street: "E Riverside Dr" },
+// 	{ street: "Burton Dr" },
+// 	{ locality: "Austin" },
+// 	{ region: "TX" },
+// 	{ postcode: "78741" },
+// 	{ country: "USA" },
+// ])
+// assert("Napier Field Rd At Scott Rd, Dothan, AL 36303, USA", [
+// 	{ street: "Napier Field Rd" },
+// 	{ street: "Scott Rd" },
+// 	{ locality: "Dothan" },
+// 	{ region: "AL" },
+// 	{ postcode: "36303" },
+// 	{ country: "USA" },
+// ])
+// assert("16th St At H St, Sacramento, CA 95814, USA", [
+// 	{ street: "16th St" },
+// 	{ street: "H St" },
+// 	{ locality: "Sacramento" },
+// 	{ region: "CA" },
+// 	{ postcode: "95814" },
+// 	{ country: "USA" },
+// ])
+// assert("N Halsted St At W Lake St, Chicago, IL 60661, USA", [
+// 	{ street: "N Halsted St" },
+// 	{ street: "W Lake St" },
+// 	{ locality: "Chicago" },
+// 	{ region: "IL" },
+// 	{ postcode: "60661" },
+// 	{ country: "USA" },
+// ])
+// assert("College Park Dr At Gosling Rd, Conroe, TX 77384, USA", [
+// 	{ street: "College Park Dr" },
+// 	{ street: "Gosling Rd" },
+// 	{ locality: "Conroe" },
+// 	{ region: "TX" },
+// 	{ postcode: "77384" },
+// 	{ country: "USA" },
+// ])
+// assert("Hall Ave At N Cherry St, Wallingford, CT 06492, USA", [
+// 	{ street: "Hall Ave" },
+// 	{ street: "N Cherry St" },
+// 	{ locality: "Wallingford" },
+// 	{ region: "CT" },
+// 	{ postcode: "06492" },
+// 	{ country: "USA" },
+// ])
+// assert("Pinemont Dr At N Shepherd Dr, Houston, TX 77018, USA", [
+// 	{ street: "Pinemont Dr" },
+// 	{ street: "N Shepherd Dr" },
+// 	{ locality: "Houston" },
+// 	{ region: "TX" },
+// 	{ postcode: "77018" },
+// 	{ country: "USA" },
+// ])

package/test/functional/libpostal.test.ts

@@ -0,0 +1,15 @@
+/**
+ * @copyright OpenISP, Inc.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import { assert } from "mailwoman/sdk/test/utils"
+// https://github.com/openvenues/libpostal/issues/382
+assert("3360 Grand Ave Oakland 94610-2737 CA", [
+	{ housenumber: "3360" },
+	{ street: "Grand Ave" },
+	{ locality: "Oakland" },
+	{ postcode: "94610-2737" },
+	{ region: "CA" },
+])

package/test/functional/place.fra.test.ts

@@ -0,0 +1,107 @@
+/**
+ * @copyright OpenISP, Inc.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import { assert } from "mailwoman/sdk/test/utils"
+
+assert("École Paul Valéry Montpellier", [
+	// ---
+	{ venue: "École Paul Valéry" },
+	{ locality: "Montpellier" },
+])
+
+assert("Université de Montpellier", [
+	// ---
+	{
+		venue: "Université de Montpellier",
+	},
+])
+
+assert("École Jules Vernes Villetaneuse", [
+	// ---
+	{
+		venue: "École Jules Vernes",
+	},
+	{ locality: "Villetaneuse" },
+])
+
+assert("ZAC de la Tuilerie, Villars-les-Dombes, France", [
+	{ venue: "ZAC de la Tuilerie" },
+	{ locality: "Villars-les-Dombes" },
+	{ country: "France" },
+])
+
+assert("Bibliothèque François Mitterrand Paris", [
+	// ---
+	{
+		venue: "Bibliothèque François Mitterrand",
+	},
+	{ locality: "Paris" },
+])
+
+assert("ZI les grasses Péronnas", [
+	// ---
+	{
+		venue: "ZI les grasses",
+	},
+	{ locality: "Péronnas" },
+])
+
+assert("ZAC du Pré Polliat", [
+	// ---
+	{
+		venue: "ZAC du Pré",
+	},
+	{ locality: "Polliat" },
+])
+
+assert("ZAC sous la Combe Lavancia-Epercy", [
+	// ---
+	{
+		venue: "ZAC sous la Combe",
+	},
+	{ locality: "Lavancia-Epercy" },
+])
+
+assert("ZA Entraigues Embrun", [
+	// ---
+	{
+		venue: "ZA Entraigues",
+	},
+	{ locality: "Embrun" },
+])
+
+// This should be street in French, but it's ok
+assert("Place Sohier Vervins", [
+	// ---
+	{
+		street: "Place Sohier",
+	},
+	{ locality: "Vervins" },
+])
+
+// This should be street in French, but it's ok
+assert("CC des Fours à Chaux Montluçon", [
+	// ---
+	{
+		street: "CC des Fours à Chaux",
+	},
+	{ locality: "Montluçon" },
+])
+
+// This should be street in French, but it's ok
+assert("Parc Des Clots Upie", [
+	// ---
+	{
+		street: "Parc Des Clots",
+	},
+	{ locality: "Upie" },
+])
+
+// @todo: the place should be `ZAC du centre Bourg`
+assert("ZAC du centre Bourg Saint-Sébastien-De-Morsent", [
+	{ street: "ZAC du centre" },
+	{ locality: "Saint-Sébastien-De-Morsent" },
+])

package/test/functional/transit.test.ts

@@ -0,0 +1,11 @@
+/**
+ * @copyright OpenISP, Inc.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import { assert } from "mailwoman/sdk/test/utils"
+
+assert("Stop 1", [{ venue: "Stop 1" }])
+
+assert("Stop 10010", [{ venue: "Stop 10010" }])

package/test/functional/venue.usa.test.ts

@@ -0,0 +1,26 @@
+/**
+ * @copyright OpenISP, Inc.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import { assert } from "mailwoman/sdk/test/utils"
+
+assert("Air & Space Museum Washington DC", [
+	{ venue: "Air & Space Museum" },
+	{ locality: "Washington" },
+	{ region: "DC" },
+])
+
+assert("Empire State Building NYC", [{ venue: "Empire State Building" }, { locality: "NYC" }])
+
+// checking that NAME INITIAL NAME works
+assert("Donald W Reynolds Stadium", [{ venue: "Donald W Reynolds Stadium" }])
+
+assert("Donald W. Reynolds Stadium", [{ venue: "Donald W. Reynolds Stadium" }])
+
+// checking that "japan" is interpreted as a country, not a city
+assert("Universal Studios Japan", [{ venue: "Universal Studios" }, { country: "Japan" }])
+
+// checking that "art" is not interpreted as a street suffix
+assert("philadelphia museum of art", [{ venue: "philadelphia museum of art" }])