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

Jump to bottom

Cherry pick 'collator' fixes #6598

Merged
merged 3 commits into from
May 2, 2018
Merged

Cherry pick 'collator' fixes #6598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cbb763
Prevent CollatorExpression from evaluating as "constant"
ChrisLoer May 1, 2018
47db8ee
Remove unused literal value serialization of Collator.
ChrisLoer May 2, 2018
49d5706
"case/diacriticSensitive" -> "case/diacritic-sensitive"
ChrisLoer May 2, 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
2 changes: 1 addition & 1 deletion docs/components/expression-metadata.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ const types = {
}],
collator: [{
type: 'collator',
parameters: [ '{ "caseSensitive": boolean, "diacriticSensitive": boolean, "locale": string }' ]
parameters: [ '{ "case-sensitive": boolean, "diacritic-sensitive": boolean, "locale": string }' ]
}]
};

Expand Down
20 changes: 5 additions & 15 deletions src/style-spec/expression/definitions/collator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,6 @@ export class Collator {
return new Intl.Collator(this.locale ? this.locale : [])
.resolvedOptions().locale;
}

serialize() {
const options = {};
options['caseSensitive'] = this.sensitivity === 'variant' || this.sensitivity === 'case';
options['diacriticSensitive'] = this.sensitivity === 'variant' || this.sensitivity === 'accent';
if (this.locale) {
options['locale'] = this.locale;
}
return ["collator", options];
}
}

export class CollatorExpression implements Expression {
Expand All @@ -99,11 +89,11 @@ export class CollatorExpression implements Expression {
return context.error(`Collator options argument must be an object.`);

const caseSensitive = context.parse(
options['caseSensitive'] === undefined ? false : options['caseSensitive'], 1, BooleanType);
options['case-sensitive'] === undefined ? false : options['case-sensitive'], 1, BooleanType);
if (!caseSensitive) return null;

const diacriticSensitive = context.parse(
options['diacriticSensitive'] === undefined ? false : options['diacriticSensitive'], 1, BooleanType);
options['diacritic-sensitive'] === undefined ? false : options['diacritic-sensitive'], 1, BooleanType);
if (!diacriticSensitive) return null;

let locale = null;
Expand Down Expand Up @@ -137,10 +127,10 @@ export class CollatorExpression implements Expression {

serialize() {
const options = {};
options['caseSensitive'] = this.caseSensitive;
options['diacriticSensitive'] = this.diacriticSensitive;
options['case-sensitive'] = this.caseSensitive.serialize();
options['diacritic-sensitive'] = this.diacriticSensitive.serialize();
if (this.locale) {
options['locale'] = this.locale;
options['locale'] = this.locale.serialize();
}
return ["collator", options];
}
Expand Down
6 changes: 1 addition & 5 deletions src/style-spec/expression/definitions/literal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @flow

import assert from 'assert';
import { isValue, typeOf, Color, Collator } from '../values';
import { isValue, typeOf, Color } from '../values';

import type { Type } from '../types';
import type { Value } from '../values';
Expand Down Expand Up @@ -60,10 +60,6 @@ class Literal implements Expression {
// couldn't actually generate with a "literal" expression,
// so we have to implement an equivalent serialization here
return ["rgba"].concat(this.value.toArray());
} else if (this.value instanceof Collator) {
// Same as Color above: literal serialization delegated to
// Collator (not CollatorExpression)
return this.value.serialize();
} else {
assert(this.value === null ||
typeof this.value === 'string' ||
Expand Down
6 changes: 6 additions & 0 deletions src/style-spec/expression/parsing_context.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import ArrayAssertion from './definitions/array';
import Coercion from './definitions/coercion';
import EvaluationContext from './evaluation_context';
import CompoundExpression from './compound_expression';
import { CollatorExpression } from './definitions/collator';
import {isGlobalPropertyConstant, isFeatureConstant} from './is_constant';
import Var from './definitions/var';

Expand Down Expand Up @@ -193,6 +194,11 @@ function isConstant(expression: Expression) {
return isConstant(expression.boundExpression);
} else if (expression instanceof CompoundExpression && expression.name === 'error') {
return false;
} else if (expression instanceof CollatorExpression) {
// Although the results of a Collator expression with fixed arguments
// generally shouldn't change between executions, we can't serialize them
// as constant expressions because results change based on environment.
return false;
}

const isTypeAnnotation = expression instanceof Coercion ||
Expand Down
2 changes: 1 addition & 1 deletion src/style-spec/reference/v8.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2233,7 +2233,7 @@
}
},
"collator": {
"doc": "Returns a `collator` for use in locale-dependent comparison operations. The `caseSensitive` and `diacriticSensitive` options default to `false`. The `locale` argument specifies the IETF language tag of the locale to use. If none is provided, the default locale is used. If the requested locale is not available, the `collator` will use a system-defined fallback locale. Use `resolved-locale` to test the results of locale fallback behavior.",
"doc": "Returns a `collator` for use in locale-dependent comparison operations. The `case-sensitive` and `diacritic-sensitive` options default to `false`. The `locale` argument specifies the IETF language tag of the locale to use. If none is provided, the default locale is used. If the requested locale is not available, the `collator` will use a system-defined fallback locale. Use `resolved-locale` to test the results of locale fallback behavior.",
"group": "Types",
"sdk-support": {
"basic functionality": {
Expand Down
18 changes: 14 additions & 4 deletions test/integration/expression-tests/collator/accent-equals-de/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"resolved-locale",
[
"collator",
{"caseSensitive": true, "diacriticSensitive": false, "locale": "de"}
{"case-sensitive": true, "diacritic-sensitive": false, "locale": "de"}
]
],
"de"
Expand All @@ -18,7 +18,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": false, "locale": "de"}
{"case-sensitive": true, "diacritic-sensitive": false, "locale": "de"}
]
],
["case", ["==", ["get", "rhs"], "ue"], true, false]
Expand All @@ -37,14 +37,24 @@
"outputs": [true, false],
"serialized": [
"case",
false,
[
"==",
[
"resolved-locale",
[
"collator",
{"case-sensitive": true, "diacritic-sensitive": false, "locale": "de"}
]
],
"de"
],
[
"==",
["string", ["get", "lhs"]],
["get", "rhs"],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": false, "locale": "de"}
{"case-sensitive": true, "diacritic-sensitive": false, "locale": "de"}
]
],
["case", ["==", ["get", "rhs"], "ue"], true, false]
Expand Down
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/accent-lt-en/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": false, "locale": "en"}
{"case-sensitive": true, "diacritic-sensitive": false, "locale": "en"}
]
],
"inputs": [
Expand All @@ -27,7 +27,7 @@
["string", ["get", "rhs"]],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": false, "locale": "en"}
{"case-sensitive": true, "diacritic-sensitive": false, "locale": "en"}
]
]
}
Expand Down
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/accent-not-equals-en/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": false, "locale": "en"}
{"case-sensitive": true, "diacritic-sensitive": false, "locale": "en"}
]
]
],
Expand All @@ -32,7 +32,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": false, "locale": "en"}
{"case-sensitive": true, "diacritic-sensitive": false, "locale": "en"}
]
]
]
Expand Down
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/base-default-locale/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"==",
["string", ["get", "lhs"]],
["get", "rhs"],
["collator", {"caseSensitive": false, "diacriticSensitive": false}]
["collator", {"case-sensitive": false, "diacritic-sensitive": false}]
],
"inputs": [
[{}, {"properties": {"lhs": "a", "rhs": "a"}}],
Expand All @@ -22,7 +22,7 @@
"==",
["string", ["get", "lhs"]],
["get", "rhs"],
["collator", {"caseSensitive": false, "diacriticSensitive": false}]
["collator", {"case-sensitive": false, "diacritic-sensitive": false}]
]
}
}
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/base-equals-en/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": false, "diacriticSensitive": false, "locale": "en"}
{"case-sensitive": false, "diacritic-sensitive": false, "locale": "en"}
]
],
"inputs": [
Expand All @@ -27,7 +27,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": false, "diacriticSensitive": false, "locale": "en"}
{"case-sensitive": false, "diacritic-sensitive": false, "locale": "en"}
]
]
}
Expand Down
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/base-gt-en/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": false, "diacriticSensitive": false, "locale": "en"}
{"case-sensitive": false, "diacritic-sensitive": false, "locale": "en"}
]
],
"inputs": [
Expand All @@ -27,7 +27,7 @@
["string", ["get", "rhs"]],
[
"collator",
{"caseSensitive": false, "diacriticSensitive": false, "locale": "en"}
{"case-sensitive": false, "diacritic-sensitive": false, "locale": "en"}
]
]
}
Expand Down
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/case-lteq-en/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": false, "diacriticSensitive": true, "locale": "en"}
{"case-sensitive": false, "diacritic-sensitive": true, "locale": "en"}
]
],
"inputs": [
Expand All @@ -28,7 +28,7 @@
["string", ["get", "rhs"]],
[
"collator",
{"caseSensitive": false, "diacriticSensitive": true, "locale": "en"}
{"case-sensitive": false, "diacritic-sensitive": true, "locale": "en"}
]
]
}
Expand Down
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/case-not-equals-en/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": false, "diacriticSensitive": true, "locale": "en"}
{"case-sensitive": false, "diacritic-sensitive": true, "locale": "en"}
]
]
],
Expand All @@ -32,7 +32,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": false, "diacriticSensitive": true, "locale": "en"}
{"case-sensitive": false, "diacritic-sensitive": true, "locale": "en"}
]
]
]
Expand Down
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/case-omitted-en/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"==",
["string", ["get", "lhs"]],
["get", "rhs"],
["collator", {"diacriticSensitive": true, "locale": "en"}]
["collator", {"diacritic-sensitive": true, "locale": "en"}]
],
"inputs": [
[{}, {"properties": {"lhs": "ä", "rhs": "a"}}],
Expand All @@ -25,7 +25,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": false, "diacriticSensitive": true, "locale": "en"}
{"case-sensitive": false, "diacritic-sensitive": true, "locale": "en"}
]
]
}
Expand Down
2 changes: 1 addition & 1 deletion test/integration/expression-tests/collator/comparison-number-error/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"<",
1,
2,
["collator", {"caseSensitive": false, "diacriticSensitive": false}]
["collator", {"case-sensitive": false, "diacritic-sensitive": false}]
],
"expected": {
"compiled": {
Expand Down
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/diacritic-omitted-en/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"<",
["string", ["get", "lhs"]],
["get", "rhs"],
["collator", {"caseSensitive": ["==", 1, 1], "locale": "en"}]
["collator", {"case-sensitive": ["==", 1, 1], "locale": "en"}]
],
"inputs": [
[{}, {"properties": {"lhs": "a", "rhs": "ä"}}],
Expand All @@ -24,7 +24,7 @@
["string", ["get", "rhs"]],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": false, "locale": "en"}
{"case-sensitive": true, "diacritic-sensitive": false, "locale": "en"}
]
]
}
Expand Down
2 changes: 1 addition & 1 deletion test/integration/expression-tests/collator/equals-non-string-error/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"==",
1,
2,
["collator", {"caseSensitive": false, "diacriticSensitive": false}]
["collator", {"case-sensitive": false, "diacritic-sensitive": false}]
],
"expected": {
"compiled": {
Expand Down
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/variant-equals-en/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": true, "locale": "en"}
{"case-sensitive": true, "diacritic-sensitive": true, "locale": "en"}
]
],
"inputs": [
Expand All @@ -27,7 +27,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": true, "locale": "en"}
{"case-sensitive": true, "diacritic-sensitive": true, "locale": "en"}
]
]
}
Expand Down
4 changes: 2 additions & 2 deletions test/integration/expression-tests/collator/variant-gteq-en/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
["get", "rhs"],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": true, "locale": "en"}
{"case-sensitive": true, "diacritic-sensitive": true, "locale": "en"}
]
],
"inputs": [
Expand All @@ -28,7 +28,7 @@
["string", ["get", "rhs"]],
[
"collator",
{"caseSensitive": true, "diacriticSensitive": true, "locale": "en"}
{"case-sensitive": true, "diacritic-sensitive": true, "locale": "en"}
]
]
}
Expand Down
14 changes: 12 additions & 2 deletions test/integration/expression-tests/resolved-locale/basic/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"resolved-locale",
[
"collator",
{"caseSensitive": true, "diacriticSensitive": true, "locale": "en"}
{"case-sensitive": true, "diacritic-sensitive": true, "locale": "en"}
]
],
"en"
Expand All @@ -19,6 +19,16 @@
"type": "boolean"
},
"outputs": [true],
"serialized": true
"serialized": [
"==",
[
"resolved-locale",
[
"collator",
{"case-sensitive": true, "diacritic-sensitive": true, "locale": "en"}
]
],
"en"
]
}
}