Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding address unit attribute to api output and queries #1052

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Adding address unit attribute to api output and queries #1052

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a832292
Adding unit attribute for addresses in api output
sweco-semhul Nov 2, 2017
9d1c507
Adding unit attribute for addresses in api search
sweco-semhul Nov 2, 2017
761c295
Adding dependencies for model, query and analyzer to adding-address-u…
sweco-semhul Nov 2, 2017
6b8c9f6
Switching unit attribute to always be last also for standard and chan…
sweco-semhul Nov 20, 2017
c7b5baf
Merge branch 'master' into adding-address-unit
Dec 1, 2017
66a458f
Moving libpostal unit configuration into updated logic
sweco-semhul Jan 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions helper/diffPlaces.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,11 @@ function assertAddressMatch(item1, item2) {
propMatch(item1.address_parts, item2.address_parts, 'zip');
}

// only compare unit if both records have it, otherwise just ignore and assume it's the same
if (item1.address_parts.hasOwnProperty('unit') && item2.address_parts.hasOwnProperty('unit')) {
propMatch(item1.address_parts, item2.address_parts, 'unit');
}

return false;
}

Expand Down
1 change: 1 addition & 0 deletions helper/geojsonify_place_details.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const _ = require('lodash');
// If a property is identified as a single string, assume it should be presented as a string in response
// If something other than string is desired, use the following structure: { name: 'category', type: 'array' }
const DETAILS_PROPS = [
{ name: 'unit', type: 'string' },
{ name: 'housenumber', type: 'string' },
{ name: 'street', type: 'string' },
{ name: 'postalcode', type: 'string' },
Expand Down
8 changes: 6 additions & 2 deletions middleware/localNamingConventions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,12 @@ function applyLocalNamingConventions(req, res, next) {
// flip the housenumber and street name
// eg. '101 Grolmanstraße' -> 'Grolmanstraße 101'
function flipNumberAndStreet(place) {
var standard = ( place.address_parts.number + ' ' + place.address_parts.street ),
flipped = ( place.address_parts.street + ' ' + place.address_parts.number );
var unit = '';
if(place.address_parts.hasOwnProperty('unit')) {
unit = ' ' + place.address_parts.unit;
}
var standard = ( place.address_parts.number + unit + ' ' + place.address_parts.street ),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line should be changed so that the unit is last. Also, the string concatenation approach is getting a bit messy here. It would be great if you updated the code to use Array.join. It can handle putting in appropriate whitespace pretty nicely

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clarification!
Yeah I agree on that. Will change the order and get it a bit less messy 😃

flipped = ( place.address_parts.street + ' ' + place.address_parts.number + unit );

// flip street name and housenumber
if( place.name.default === standard ){
Expand Down
1 change: 1 addition & 0 deletions middleware/renamePlacenames.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ const _ = require('lodash');
const PARENT_PROPS = require('../helper/placeTypes');

const ADDRESS_PROPS = [
{ name: 'unit', newName: 'unit' },
{ name: 'number', newName: 'housenumber' },
{ name: 'zip', newName: 'postalcode', transform: (value) => { return [value]; } },
{ name: 'street', newName: 'street' }
Expand Down
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@
"pelias-labels": "1.7.0",
"pelias-logger": "0.3.0",
"pelias-microservice-wrapper": "1.2.1",
"pelias-model": "5.2.0",
"pelias-query": "9.1.0",
"pelias-model": "sweco-semhul/model#adding-address-unit",
"pelias-query": "sweco-semhul/query#adding-address-unit",
"pelias-sorting": "1.0.1",
"pelias-text-analyzer": "1.10.0",
"pelias-text-analyzer": "sweco-semhul/text-analyzer#adding-address-unit",
"predicates": "^2.0.0",
"retry": "^0.10.1",
"stats-lite": "^2.0.4",
Expand Down
4 changes: 4 additions & 0 deletions query/autocomplete_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ module.exports = _.merge({}, peliasQuery.defaults, {
'function_score:score_mode': 'avg',
'function_score:boost_mode': 'replace',

'address:unit:analyzer': 'peliasUnit',
'address:unit:field': 'address_parts.unit',
'address:unit:boost': 2,

'address:housenumber:analyzer': 'peliasHousenumber',
'address:housenumber:field': 'address_parts.number',
'address:housenumber:boost': 2,
Expand Down
4 changes: 4 additions & 0 deletions query/reverse_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ module.exports = _.merge({}, peliasQuery.defaults, {
'function_score:score_mode': 'avg',
'function_score:boost_mode': 'replace',

'address:unit:analyzer': 'peliasUnit',
'address:unit:field': 'address_parts.unit',
'address:unit:boost': 2,

'address:housenumber:analyzer': 'peliasHousenumber',
'address:housenumber:field': 'address_parts.number',
'address:housenumber:boost': 2,
Expand Down
4 changes: 4 additions & 0 deletions query/search_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ module.exports = _.merge({}, peliasQuery.defaults, {
'function_score:score_mode': 'avg',
'function_score:boost_mode': 'replace',

'address:unit:analyzer': 'peliasUnit',
'address:unit:field': 'address_parts.unit',
'address:unit:boost': 2,

'address:housenumber:analyzer': 'peliasHousenumber',
'address:housenumber:field': 'address_parts.number',
'address:housenumber:boost': 2,
Expand Down
1 change: 1 addition & 0 deletions query/search_original.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ query.score( peliasQuery.view.popularity( peliasQuery.view.phrase ) );
query.score( peliasQuery.view.population( peliasQuery.view.phrase ) );

// address components
query.score( peliasQuery.view.address('unit') );
query.score( peliasQuery.view.address('housenumber') );
query.score( peliasQuery.view.address('street') );
query.score( peliasQuery.view.address('postcode') );
Expand Down
5 changes: 5 additions & 0 deletions query/text_parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ function addParsedVariablesToQueryVariables( parsed_text, vs ){
vs.var( 'input:address', parsed_text.address );
}

// unit - an apartment, unit, office, lot, or other secondary unit designator
if( ! _.isEmpty(parsed_text.unit) ){
vs.var( 'input:unit', parsed_text.unit );
}

// house number
if( ! _.isEmpty(parsed_text.number) ){
vs.var( 'input:housenumber', parsed_text.number );
Expand Down
5 changes: 5 additions & 0 deletions query/text_parser_addressit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ function addParsedVariablesToQueryVariables( parsed_text, vs ){

// ==== add parsed matches [address components] ====

// unit
if( parsed_text.hasOwnProperty('unit') ){
vs.var( 'input:unit', parsed_text.unit );
}

// house number
if( parsed_text.hasOwnProperty('number') ){
vs.var( 'input:housenumber', parsed_text.number );
Expand Down
1 change: 1 addition & 0 deletions sanitizer/_text_addressit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ function parse(query) {
_.extend(addressWithAdminParts, addressWithAddressParts);

var address_parts = [ 'name',
'unit',
'number',
'street',
'city',
Expand Down
6 changes: 5 additions & 1 deletion service/configurations/Interpolation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@ class Language extends ServiceConfiguration {
}

getParameters(req, hit) {
return {
let res = {
number: req.clean.parsed_text.number,
street: hit.address_parts.street || req.clean.parsed_text.street,
lat: hit.center_point.lat,
lon: hit.center_point.lon
};
if(req.clean.parsed_text.hasOwnProperty('unit')) {
res.unit = req.clean.parsed_text.unit;
}
return res;

}

Expand Down
161 changes: 161 additions & 0 deletions test/unit/fixture/search_full_address_original_with_unit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
var vs = require('../../../query/search_defaults');

module.exports = {
'query': {
'bool': {
'must': [
{
'match': {
'name.default': {
'analyzer': 'peliasQueryFullToken',
'boost': 1,
'query': '431 St Kilda Rd'
}
}
}
],
'should': [
{
'match': {
'phrase.default': {
'analyzer': 'peliasPhrase',
'type': 'phrase',
'boost': 1,
'slop': 2,
'query': '431 St Kilda Rd'
}
}
},
{
'function_score': {
'query': {
'match': {
'phrase.default': {
'analyzer': 'peliasPhrase',
'type': 'phrase',
'boost': 1,
'slop': 2,
'query': '431 St Kilda Rd'
}
}
},
'max_boost': 20,
'functions': [
{
'field_value_factor': {
'modifier': 'log1p',
'field': 'popularity',
'missing': 1
},
'weight': 1
}
],
'score_mode': 'first',
'boost_mode': 'replace'
}
},
{
'function_score': {
'query': {
'match': {
'phrase.default': {
'analyzer': 'peliasPhrase',
'type': 'phrase',
'boost': 1,
'slop': 2,
'query': '431 St Kilda Rd'
}
}
},
'max_boost': 20,
'functions': [
{
'field_value_factor': {
'modifier': 'log1p',
'field': 'population',
'missing': 1
},
'weight': 2
}
],
'score_mode': 'first',
'boost_mode': 'replace'
}
},
{
'match': {
'address_parts.unit': {
'analyzer': vs['address:unit:analyzer'],
'boost': vs['address:unit:boost'],
'query': '8'
}
}
},
{
'match': {
'address_parts.number': {
'analyzer': vs['address:housenumber:analyzer'],
'boost': vs['address:housenumber:boost'],
'query': '431'
}
}
},
{
'match': {
'address_parts.street': {
'analyzer': vs['address:street:analyzer'],
'boost': vs['address:street:boost'],
'query': 'St Kilda Rd'
}
}
},
{
'match': {
'parent.region_a': {
'analyzer': vs['admin:region_a:analyzer'],
'boost': vs['admin:region_a:boost'],
'query': 'Melbourne'
}
}
},
{
'multi_match': {
'fields': [
'parent.country^1',
'parent.region^1',
'parent.county^1',
'parent.localadmin^1',
'parent.locality^1',
'parent.borough^1',
'parent.neighbourhood^1',
'parent.region_a^1'
],
'query': 'Melbourne',
'analyzer': 'peliasAdmin'
}
}
],
'filter': [
{
'terms': {
'layer': [
'address',
'venue',
'country',
'region',
'county',
'neighbourhood',
'locality',
'localadmin'
]
}
}
]
}
},
'size': 10,
'track_scores': true,
'sort': [
'_score'
]
};
44 changes: 44 additions & 0 deletions test/unit/helper/diffPlaces.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,50 @@ module.exports.tests.dedupe = function(test, common) {
t.false(isDifferent(item1, item2), 'should be the same');
t.end();
});

test('catch diff address by unit', function(t) {
var item1 = {
'address_parts': {
'unit': 'A',
'number': '1',
'street': 'Main Street',
'zip': '90210'
}
};
var item2 = {
'address_parts': {
'unit': 'B',
'number': '1',
'street': 'Main Street',
'zip': '90210'
}
};

t.true(isDifferent(item1, item2), 'should be different');
t.end();
});

test('catch diff address by unit', function(t) {
var item1 = {
'address_parts': {
'unit': 'A',
'number': '1',
'street': 'Main Street',
'zip': '90210'
}
};
var item2 = {
'address_parts': {
'unit': 'A',
'number': '1',
'street': 'Main Street',
'zip': '90210'
}
};

t.false(isDifferent(item1, item2), 'should be the same');
t.end();
});
};

module.exports.all = function (tape, common) {
Expand Down
Loading