Skip to content

Commit 787c41b

Browse files
author
Wanasit Tanakitrungruang
committedApr 9, 2023
New: (En) Disallow timeunit abbreviations in strict mode
·
v2.7.9v2.6.3
1 parent 665bda6 commit 787c41b

11 files changed

+143
-23
lines changed
 

‎src/locales/en/constants.ts

+30
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,25 @@ export const ORDINAL_WORD_DICTIONARY: { [word: string]: number } = {
134134
"thirty-first": 31,
135135
};
136136

137+
export const TIME_UNIT_DICTIONARY_NO_ABBR: { [word: string]: OpUnitType | QUnitType } = {
138+
second: "second",
139+
seconds: "second",
140+
minute: "minute",
141+
minutes: "minute",
142+
hour: "hour",
143+
hours: "hour",
144+
day: "d",
145+
days: "d",
146+
week: "week",
147+
weeks: "week",
148+
month: "month",
149+
months: "month",
150+
quarter: "quarter",
151+
quarters: "quarter",
152+
year: "year",
153+
years: "year",
154+
};
155+
137156
export const TIME_UNIT_DICTIONARY: { [word: string]: OpUnitType | QUnitType } = {
138157
s: "second",
139158
sec: "second",
@@ -167,6 +186,9 @@ export const TIME_UNIT_DICTIONARY: { [word: string]: OpUnitType | QUnitType } =
167186
yr: "year",
168187
year: "year",
169188
years: "year",
189+
// Also, merge the entries from the full-name dictionary.
190+
// We leave the duplicated entries for readability.
191+
...TIME_UNIT_DICTIONARY_NO_ABBR,
170192
};
171193

172194
//-----------------------------
@@ -238,7 +260,15 @@ export function parseYear(match: string): number {
238260
const SINGLE_TIME_UNIT_PATTERN = `(${NUMBER_PATTERN})\\s{0,3}(${matchAnyPattern(TIME_UNIT_DICTIONARY)})`;
239261
const SINGLE_TIME_UNIT_REGEX = new RegExp(SINGLE_TIME_UNIT_PATTERN, "i");
240262

263+
const SINGLE_TIME_UNIT_NO_ABBR_PATTERN = `(${NUMBER_PATTERN})\\s{0,3}(${matchAnyPattern(
264+
TIME_UNIT_DICTIONARY_NO_ABBR
265+
)})`;
266+
241267
export const TIME_UNITS_PATTERN = repeatedTimeunitPattern(`(?:(?:about|around)\\s{0,3})?`, SINGLE_TIME_UNIT_PATTERN);
268+
export const TIME_UNITS_NO_ABBR_PATTERN = repeatedTimeunitPattern(
269+
`(?:(?:about|around)\\s{0,3})?`,
270+
SINGLE_TIME_UNIT_NO_ABBR_PATTERN
271+
);
242272

243273
export function parseTimeUnits(timeunitText): TimeUnits {
244274
const fragments = {};

‎src/locales/en/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export function createConfiguration(strictMode = true, littleEndian = false): Co
8282
{
8383
parsers: [
8484
new SlashDateFormatParser(littleEndian),
85-
new ENTimeUnitWithinFormatParser(),
85+
new ENTimeUnitWithinFormatParser(strictMode),
8686
new ENMonthNameLittleEndianParser(),
8787
new ENMonthNameMiddleEndianParser(),
8888
new ENWeekdayParser(),

‎src/locales/en/parsers/ENTimeUnitAgoFormatParser.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import { ParsingContext } from "../../../chrono";
2-
import { parseTimeUnits, TIME_UNITS_PATTERN } from "../constants";
2+
import { parseTimeUnits, TIME_UNITS_NO_ABBR_PATTERN, TIME_UNITS_PATTERN } from "../constants";
33
import { ParsingComponents } from "../../../results";
44
import { AbstractParserWithWordBoundaryChecking } from "../../../common/parsers/AbstractParserWithWordBoundary";
55
import { reverseTimeUnits } from "../../../utils/timeunits";
66

7-
const PATTERN = new RegExp(`(${TIME_UNITS_PATTERN})\\s{0,5}(?:ago|before|earlier)(?=(?:\\W|$))`, "i");
8-
const STRICT_PATTERN = new RegExp(`(${TIME_UNITS_PATTERN})\\s{0,5}ago(?=(?:\\W|$))`, "i");
7+
const PATTERN = new RegExp(`(${TIME_UNITS_PATTERN})\\s{0,5}(?:ago|before|earlier)(?=\\W|$)`, "i");
8+
const STRICT_PATTERN = new RegExp(`(${TIME_UNITS_NO_ABBR_PATTERN})\\s{0,5}(?:ago|before|earlier)(?=\\W|$)`, "i");
99

1010
export default class ENTimeUnitAgoFormatParser extends AbstractParserWithWordBoundaryChecking {
1111
constructor(private strictMode: boolean) {

‎src/locales/en/parsers/ENTimeUnitCasualRelativeFormatParser.ts

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
1-
import { TIME_UNITS_PATTERN, parseTimeUnits } from "../constants";
1+
import { TIME_UNITS_PATTERN, parseTimeUnits, TIME_UNITS_NO_ABBR_PATTERN } from "../constants";
22
import { ParsingContext } from "../../../chrono";
33
import { ParsingComponents } from "../../../results";
44
import { AbstractParserWithWordBoundaryChecking } from "../../../common/parsers/AbstractParserWithWordBoundary";
55
import { reverseTimeUnits } from "../../../utils/timeunits";
66

77
const PATTERN = new RegExp(`(this|last|past|next|after|\\+|-)\\s*(${TIME_UNITS_PATTERN})(?=\\W|$)`, "i");
8+
const PATTERN_NO_ABBR = new RegExp(
9+
`(this|last|past|next|after|\\+|-)\\s*(${TIME_UNITS_NO_ABBR_PATTERN})(?=\\W|$)`,
10+
"i"
11+
);
812

913
export default class ENTimeUnitCasualRelativeFormatParser extends AbstractParserWithWordBoundaryChecking {
14+
constructor(private allowAbbreviations: boolean = true) {
15+
super();
16+
}
17+
1018
innerPattern(): RegExp {
11-
return PATTERN;
19+
return this.allowAbbreviations ? PATTERN : PATTERN_NO_ABBR;
1220
}
1321

1422
innerExtract(context: ParsingContext, match: RegExpMatchArray): ParsingComponents {

‎src/locales/en/parsers/ENTimeUnitLaterFormatParser.ts

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { ParsingContext } from "../../../chrono";
2-
import { parseTimeUnits, TIME_UNITS_PATTERN } from "../constants";
2+
import { parseTimeUnits, TIME_UNITS_NO_ABBR_PATTERN, TIME_UNITS_PATTERN } from "../constants";
33
import { ParsingComponents } from "../../../results";
44
import { AbstractParserWithWordBoundaryChecking } from "../../../common/parsers/AbstractParserWithWordBoundary";
55

@@ -8,7 +8,10 @@ const PATTERN = new RegExp(
88
"i"
99
);
1010

11-
const STRICT_PATTERN = new RegExp("" + "(" + TIME_UNITS_PATTERN + ")" + "(later|from now)" + "(?=(?:\\W|$))", "i");
11+
const STRICT_PATTERN = new RegExp(
12+
"" + "(" + TIME_UNITS_NO_ABBR_PATTERN + ")" + "(later|from now)" + "(?=(?:\\W|$))",
13+
"i"
14+
);
1215
const GROUP_NUM_TIMEUNITS = 1;
1316

1417
export default class ENTimeUnitLaterFormatParser extends AbstractParserWithWordBoundaryChecking {

‎src/locales/en/parsers/ENTimeUnitWithinFormatParser.ts

+16-3
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
1-
import { TIME_UNITS_PATTERN, parseTimeUnits } from "../constants";
1+
import { TIME_UNITS_PATTERN, parseTimeUnits, TIME_UNITS_NO_ABBR_PATTERN } from "../constants";
22
import { ParsingContext } from "../../../chrono";
33
import { ParsingComponents } from "../../../results";
44
import { AbstractParserWithWordBoundaryChecking } from "../../../common/parsers/AbstractParserWithWordBoundary";
55

6+
const PATTERN_WITHOUT_PREFIX = new RegExp(
7+
`(?:(?:about|around|roughly|approximately|just)\\s*(?:~\\s*)?)?(${TIME_UNITS_PATTERN})(?=\\W|$)`,
8+
"i"
9+
);
10+
611
const PATTERN_WITH_PREFIX = new RegExp(
712
`(?:within|in|for)\\s*` +
813
`(?:(?:about|around|roughly|approximately|just)\\s*(?:~\\s*)?)?(${TIME_UNITS_PATTERN})(?=\\W|$)`,
914
"i"
1015
);
1116

12-
const PATTERN_WITHOUT_PREFIX = new RegExp(
13-
`(?:(?:about|around|roughly|approximately|just)\\s*(?:~\\s*)?)?(${TIME_UNITS_PATTERN})(?=\\W|$)`,
17+
const PATTERN_WITH_PREFIX_STRICT = new RegExp(
18+
`(?:within|in|for)\\s*` +
19+
`(?:(?:about|around|roughly|approximately|just)\\s*(?:~\\s*)?)?(${TIME_UNITS_NO_ABBR_PATTERN})(?=\\W|$)`,
1420
"i"
1521
);
1622

1723
export default class ENTimeUnitWithinFormatParser extends AbstractParserWithWordBoundaryChecking {
24+
constructor(private strictMode: boolean) {
25+
super();
26+
}
27+
1828
innerPattern(context: ParsingContext): RegExp {
29+
if (this.strictMode) {
30+
return PATTERN_WITH_PREFIX_STRICT;
31+
}
1932
return context.option.forwardDate ? PATTERN_WITHOUT_PREFIX : PATTERN_WITH_PREFIX;
2033
}
2134

‎test/en/en_time_units_ago.test.ts

+12
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,18 @@ test("Test - Before with reference", () => {
300300
});
301301
});
302302

303+
test("Test - Strict mode", function () {
304+
testSingleCase(chrono.strict, "5 minutes ago", new Date(2012, 7, 10, 12, 14), (result, text) => {
305+
expect(result.start.get("hour")).toBe(12);
306+
expect(result.start.get("minute")).toBe(9);
307+
expect(result.start).toBeDate(new Date(2012, 7, 10, 12, 9));
308+
});
309+
310+
testUnexpectedResult(chrono.strict, "5m ago", new Date(2012, 7, 10, 12, 14));
311+
testUnexpectedResult(chrono.strict, "5hr before", new Date(2012, 7, 10, 12, 14));
312+
testUnexpectedResult(chrono.strict, "5 h ago", new Date(2012, 7, 10, 12, 14));
313+
});
314+
303315
test("Test - Negative cases", function () {
304316
testUnexpectedResult(chrono, "15 hours 29 min");
305317
testUnexpectedResult(chrono, "a few hour");

‎test/en/en_time_units_casual_relative.test.ts

+18
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import * as chrono from "../../src";
22
import { testSingleCase, testUnexpectedResult } from "../test_util";
3+
import ENTimeUnitCasualRelativeFormatParser from "../../src/locales/en/parsers/ENTimeUnitCasualRelativeFormatParser";
34

45
test("Test - Positive time units", () => {
56
testSingleCase(chrono, "next 2 weeks", new Date(2016, 10 - 1, 1, 12), (result, text) => {
@@ -141,6 +142,23 @@ test("Test - Minus '-' sign", () => {
141142
});
142143
});
143144

145+
test("Test - Without custom parser without abbreviations", function () {
146+
const custom = chrono.en.strict.clone();
147+
custom.parsers.push(new ENTimeUnitCasualRelativeFormatParser(false));
148+
149+
testUnexpectedResult(custom, "-3y");
150+
testUnexpectedResult(custom, "last 2m");
151+
152+
testSingleCase(custom, "-2 hours 5 minutes", new Date(2016, 10 - 1, 1, 12), (result, text) => {
153+
expect(result.text).toBe(text);
154+
expect(result.start.get("year")).toBe(2016);
155+
expect(result.start.get("month")).toBe(10);
156+
expect(result.start.get("day")).toBe(1);
157+
expect(result.start.get("hour")).toBe(9);
158+
expect(result.start.get("minute")).toBe(55);
159+
});
160+
});
161+
144162
test("Test - Negative cases", () => {
145163
testUnexpectedResult(chrono.casual, "3y", new Date(2015, 7 - 1, 10, 12, 14));
146164
testUnexpectedResult(chrono.casual, "1 m", new Date(2015, 7 - 1, 10, 12, 14));

‎test/en/en_time_units_later.test.ts

+13-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import * as chrono from "../../src/";
2-
import { testSingleCase } from "../test_util";
2+
import { testSingleCase, testUnexpectedResult } from "../test_util";
33
import { Meridiem } from "../../src/";
44

55
test("Test - Later Expression", function () {
@@ -262,6 +262,16 @@ test("Test - From now Expression", () => {
262262
});
263263

264264
test("Test - Strict mode", function () {
265+
testSingleCase(chrono, "the min after", new Date(2012, 7, 10, 12, 14), (result) => {
266+
expect(result.index).toBe(0);
267+
expect(result.text).toBe("the min after");
268+
expect(result.start.get("hour")).toBe(12);
269+
expect(result.start.get("minute")).toBe(15);
270+
expect(result.start.get("meridiem")).toBe(Meridiem.PM);
271+
272+
expect(result.start).toBeDate(new Date(2012, 7, 10, 12, 15));
273+
});
274+
265275
testSingleCase(chrono.strict, "15 minutes from now", new Date(2012, 7, 10, 12, 14), (result, text) => {
266276
expect(result.text).toBe(text);
267277
expect(result.start.get("hour")).toBe(12);
@@ -279,15 +289,8 @@ test("Test - Strict mode", function () {
279289
expect(result.start).toBeDate(new Date(2012, 7, 10, 13, 5));
280290
});
281291

282-
testSingleCase(chrono, "the min after", new Date(2012, 7, 10, 12, 14), (result) => {
283-
expect(result.index).toBe(0);
284-
expect(result.text).toBe("the min after");
285-
expect(result.start.get("hour")).toBe(12);
286-
expect(result.start.get("minute")).toBe(15);
287-
expect(result.start.get("meridiem")).toBe(Meridiem.PM);
288-
289-
expect(result.start).toBeDate(new Date(2012, 7, 10, 12, 15));
290-
});
292+
testUnexpectedResult(chrono.strict, "15m from now");
293+
testUnexpectedResult(chrono.strict, "15s later");
291294
});
292295

293296
test("Test - After with reference", () => {

‎test/en/en_time_units_within.test.ts

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import * as chrono from "../../src";
2-
import { testSingleCase } from "../test_util";
2+
import { testSingleCase, testUnexpectedResult } from "../test_util";
3+
import { Meridiem } from "../../src";
34

45
test("Test - The normal within expression", () => {
56
testSingleCase(chrono, "we have to make something in 5 days.", new Date(2012, 7, 10), (result) => {
@@ -327,3 +328,13 @@ test("Test - Time units' certainty", () => {
327328
expect(result.start.isCertain("minute")).toBeFalsy();
328329
});
329330
});
331+
332+
test("Test - Strict mode", function () {
333+
testSingleCase(chrono, "in 2hour", new Date(2016, 10 - 1, 1, 14, 52), (result, text) => {
334+
expect(result.start.get("hour")).toBe(16);
335+
expect(result.start.get("minute")).toBe(52);
336+
});
337+
338+
testUnexpectedResult(chrono.strict, "in 15m");
339+
testUnexpectedResult(chrono.strict, "within 5hr");
340+
});

‎test/system.test.ts

+23-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
import * as chrono from "../src/";
2-
import { testSingleCase } from "./test_util";
2+
import { testSingleCase, testUnexpectedResult } from "./test_util";
33
import { Meridiem } from "../src";
44
import UnlikelyFormatFilter from "../src/common/refiners/UnlikelyFormatFilter";
55
import SlashDateFormatParser from "../src/common/parsers/SlashDateFormatParser";
6+
import ENWeekdayParser from "../src/locales/en/parsers/ENWeekdayParser";
7+
import ENTimeUnitCasualRelativeFormatParser from "../src/locales/en/parsers/ENTimeUnitCasualRelativeFormatParser";
68

79
//-------------------------------------
810

@@ -146,6 +148,26 @@ test("Test - Remove a refiner example", () => {
146148
});
147149
});
148150

151+
test("Test - Replace a parser example", () => {
152+
const custom = chrono.en.casual.clone();
153+
testSingleCase(custom, "next 5m", new Date(2016, 10 - 1, 1, 14, 52), (result, text) => {
154+
expect(result.start.get("hour")).toBe(14);
155+
expect(result.start.get("minute")).toBe(57);
156+
});
157+
testSingleCase(custom, "next 5 minutes", new Date(2016, 10 - 1, 1, 14, 52), (result, text) => {
158+
expect(result.start.get("hour")).toBe(14);
159+
expect(result.start.get("minute")).toBe(57);
160+
});
161+
162+
const index = custom.parsers.findIndex((r) => r instanceof ENTimeUnitCasualRelativeFormatParser);
163+
custom.parsers[index] = new ENTimeUnitCasualRelativeFormatParser(false);
164+
testUnexpectedResult(custom, "next 5m");
165+
testSingleCase(custom, "next 5 minutes", new Date(2016, 10 - 1, 1, 14, 52), (result, text) => {
166+
expect(result.start.get("hour")).toBe(14);
167+
expect(result.start.get("minute")).toBe(57);
168+
});
169+
});
170+
149171
test("Test - Compare with native js", () => {
150172
const testByCompareWithNative = (text) => {
151173
const expectedDate = new Date(text);

0 commit comments

Comments
 (0)
Please sign in to comment.