Skip to content

Commit 6b48795

Browse files
RubenVerborghRubenVerborgh
committed
Add initializer with support check.
1 parent b2bd303 commit 6b48795

File tree

5 files changed

+139
-63
lines changed

5 files changed

+139
-63
lines changed

‎.eslintrc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,6 @@
242242
'import/no-namespace': 0,
243243
'import/no-unassigned-import': 2,
244244
'import/order': 2,
245-
'import/prefer-default-export': 2,
245+
'import/prefer-default-export': 0,
246246
},
247247
}

‎src/BaseIRI.js‎

Lines changed: 49 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,64 @@
1+
import { escapeRegex } from './Util';
2+
3+
// Do not handle base IRIs without scheme, and currently unsupported cases:
4+
// - file: IRIs (which could also use backslashes)
5+
// - IRIs containing /. or /.. or //
6+
const INVALID_OR_UNSUPPORTED = /^:?[^:?#]*(?:[?#]|$)|^file:|^[^:]*:\/*[^?#]+?\/(?:\.\.?(?:\/|$)|\/)/i;
7+
18
export default class BaseIRI {
2-
constructor(iri) {
3-
if (iri.startsWith('file://')) {
4-
// Base IRIs starting with file:// are not supported. Silently fail.
5-
return;
6-
}
9+
constructor(base) {
10+
this.base = base;
11+
this._initialized = false;
12+
this._baseLength = 0;
13+
this._baseMatcher = null;
14+
this._pathReplacements = {};
15+
}
16+
17+
static supports(base) {
18+
return !INVALID_OR_UNSUPPORTED.test(base);
19+
}
20+
21+
_init() {
22+
if (this._initialized)
23+
return this.baseMatcher !== null;
24+
this._initialized = true;
25+
26+
if (!BaseIRI.supports(this.base))
27+
return false;
728

829
// Generate regex for baseIRI with optional groups for segments
9-
// Stage 0: find the first scheme delimiter -> stage 1
10-
// Stage 1: find the next /, ?, or #. '/' -> new segment -> stage 1, '?' -> stage 2, '#' -> update end to position before hash -> stage 3, none -> stage 3
11-
// Stage 2: find the next #. '#' -> update end to position before hash -> stage 3, none -> stage 3
12-
// Stage 3: find the end of the string, add '$' to this last segment
13-
this._baseSubstitutions = {};
1430
let baseIRIRegex = '';
1531
let segmentsCount = 0;
1632
let stage = 0;
1733
const slashPositions = [];
1834
let i = 0;
1935
let containsQuery = false;
20-
// Stage 0
21-
const match = /:\/{0,2}/.exec(iri);
22-
if (match) {
23-
baseIRIRegex += escapeRegex(iri.substring(0, match.index + match[0].length));
24-
i = match.index + match[0].length;
25-
stage = 1;
26-
}
27-
else {
28-
// Base IRI should contain a scheme followed by its delimiter (e.g., http://). Silently fail.
29-
return;
30-
}
3136

32-
if (/\/\.{0,2}\//.test(iri.substring(i))) {
33-
// Base IRIs containing `//`, `/./`, or `/../` are not supported. Silently fail.
34-
return;
35-
}
37+
// Stage 0: extract the scheme
38+
const scheme = /^[^:]*:\/*/.exec(this.base)[0];
39+
baseIRIRegex += escapeRegex(scheme);
40+
i = scheme.length;
41+
stage = 1;
3642

37-
let end = iri.length;
43+
// Stage 1: find the next segment until reaching ? or #
44+
let end = this.base.length;
3845
while (stage === 1 && i < end) {
39-
// Stage 1
40-
const match = /[/?#]/.exec(iri.substring(i));
46+
const match = /[/?#]/.exec(this.base.substring(i));
4147
if (match) {
4248
if (match[0] === '#') {
4349
// Stop at this hash.
4450
end = i + match.index;
4551
stage = 3;
4652
}
4753
else {
48-
baseIRIRegex += escapeRegex(iri.substring(i, i + match.index + 1));
54+
baseIRIRegex += escapeRegex(this.base.substring(i, i + match.index + 1));
4955
baseIRIRegex += '(';
5056
segmentsCount++;
5157
if (match[0] === '/') {
5258
slashPositions.push(i + match.index);
5359
}
5460
else {
55-
this._baseSubstitutions[i + match.index] = '?';
61+
this._pathReplacements[i + match.index] = '?';
5662
containsQuery = true;
5763
stage = 2;
5864
}
@@ -63,18 +69,20 @@ export default class BaseIRI {
6369
stage = 3;
6470
}
6571
}
72+
73+
// Stage 2: find any fragment
6674
if (stage === 2) {
67-
// Stage 2
68-
const match = /#/.exec(iri.substring(i));
75+
const match = /#/.exec(this.base.substring(i));
6976
if (match) {
7077
// Stop at this hash.
7178
end = i + match.index;
7279
}
7380
stage = 3;
7481
}
82+
83+
// Stage 3: parse the remainder of the base IRI
7584
if (stage === 3) {
76-
// Stage 3
77-
baseIRIRegex += escapeRegex(iri.substring(i, end));
85+
baseIRIRegex += escapeRegex(this.base.substring(i, end));
7886
if (containsQuery) {
7987
baseIRIRegex += '(#|$)';
8088
}
@@ -88,24 +96,23 @@ export default class BaseIRI {
8896
baseIRIRegex += ')?'.repeat(segmentsCount);
8997

9098
// Precalculate the rest of the substitutions
91-
if (this._baseSubstitutions[end - 1] === undefined) {
92-
this._baseSubstitutions[end - 1] = '';
99+
if (this._pathReplacements[end - 1] === undefined) {
100+
this._pathReplacements[end - 1] = '';
93101
}
94102
for (let i = 0; i < slashPositions.length; i++) {
95-
this._baseSubstitutions[slashPositions[i]] = '../'.repeat(slashPositions.length - i - 1);
103+
this._pathReplacements[slashPositions[i]] = '../'.repeat(slashPositions.length - i - 1);
96104
}
97-
this._baseSubstitutions[slashPositions[slashPositions.length - 1]] = './';
105+
this._pathReplacements[slashPositions[slashPositions.length - 1]] = './';
98106

99107
// Set the baseMatcher
100108
this._baseMatcher = new RegExp(baseIRIRegex);
101109
this._baseLength = end;
102-
this.value = iri.substring(0, end);
110+
return true;
103111
}
104112

105113
toRelative(iri) {
106-
if (iri.startsWith('file://')) {
114+
if (!this._init())
107115
return iri;
108-
}
109116
const delimiterMatch = /:\/{0,2}/.exec(iri);
110117
if (!delimiterMatch || /\/\.{0,2}\//.test(iri.substring(delimiterMatch.index + delimiterMatch[0].length))) {
111118
return iri;
@@ -118,7 +125,7 @@ export default class BaseIRI {
118125
if (length === this._baseLength && length === iri.length) {
119126
return '';
120127
}
121-
let substitution = this._baseSubstitutions[length - 1];
128+
let substitution = this._pathReplacements[length - 1];
122129
if (substitution !== undefined) {
123130
const substr = iri.substring(length);
124131
if (substitution === './' && substr && ((!substr.startsWith('#') && !substr.startsWith('?')) || length === this._baseLength)) {
@@ -130,7 +137,3 @@ export default class BaseIRI {
130137
return iri.substring(length - 1);
131138
}
132139
}
133-
134-
function escapeRegex(regex) {
135-
return regex.replace(/[\]\/\(\)\*\+\?\.\\\$]/g, '\\$&');
136-
}

‎src/N3Writer.js‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import namespaces from './IRIs';
33
import { default as N3DataFactory, Term } from './N3DataFactory';
44
import { isDefaultGraph } from './N3Util';
55
import BaseIRI from './BaseIRI';
6+
import { escapeRegex } from './Util';
67

78
const DEFAULTGRAPH = N3DataFactory.defaultGraph();
89

@@ -394,7 +395,3 @@ function characterReplacer(character) {
394395
}
395396
return result;
396397
}
397-
398-
function escapeRegex(regex) {
399-
return regex.replace(/[\]\/\(\)\*\+\?\.\\\$]/g, '\\$&');
400-
}

‎src/Util.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export function escapeRegex(regex) {
2+
return regex.replace(/[\]\/\(\)\*\+\?\.\\\$]/g, '\\$&');
3+
}

‎test/BaseIRI-test.js‎

Lines changed: 85 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,66 @@
11
import { BaseIRI } from '../src';
22

33
describe('BaseIRI', () => {
4+
it('should advertise support for base IRIs', () => {
5+
expect(BaseIRI.supports('http://example.org/')).toBe(true);
6+
7+
expect(BaseIRI.supports(':')).toBe(false);
8+
expect(BaseIRI.supports('/')).toBe(false);
9+
10+
expect(BaseIRI.supports('a:')).toBe(true);
11+
expect(BaseIRI.supports('abc:')).toBe(true);
12+
expect(BaseIRI.supports('#:')).toBe(false);
13+
expect(BaseIRI.supports('?:')).toBe(false);
14+
expect(BaseIRI.supports('a?b#c:')).toBe(false);
15+
16+
expect(BaseIRI.supports('?abc:')).toBe(false);
17+
expect(BaseIRI.supports('#abc:')).toBe(false);
18+
expect(BaseIRI.supports('/foo/bar?abc:')).toBe(false);
19+
expect(BaseIRI.supports('/foo/bar#abc:')).toBe(false);
20+
21+
expect(BaseIRI.supports('file:')).toBe(false);
22+
expect(BaseIRI.supports('file:abc')).toBe(false);
23+
expect(BaseIRI.supports('file:/abc')).toBe(false);
24+
expect(BaseIRI.supports('file://abc')).toBe(false);
25+
expect(BaseIRI.supports('file:///abc')).toBe(false);
26+
expect(BaseIRI.supports('FILE:abc')).toBe(false);
27+
28+
expect(BaseIRI.supports('http://example.org/foo/')).toBe(true);
29+
expect(BaseIRI.supports('http://example.org/foo//')).toBe(false);
30+
expect(BaseIRI.supports('http://example.org/foo/.')).toBe(false);
31+
expect(BaseIRI.supports('http://example.org/foo/./')).toBe(false);
32+
expect(BaseIRI.supports('http://example.org/foo/..')).toBe(false);
33+
expect(BaseIRI.supports('http://example.org/foo/../')).toBe(false);
34+
expect(BaseIRI.supports('http://example.org/foo//bar')).toBe(false);
35+
expect(BaseIRI.supports('http://example.org/foo/./bar')).toBe(false);
36+
expect(BaseIRI.supports('http://example.org/foo/../bar')).toBe(false);
37+
38+
expect(BaseIRI.supports('http://example.org/foo?/')).toBe(true);
39+
expect(BaseIRI.supports('http://example.org/foo?//')).toBe(true);
40+
expect(BaseIRI.supports('http://example.org/foo?/.')).toBe(true);
41+
expect(BaseIRI.supports('http://example.org/foo?/./')).toBe(true);
42+
expect(BaseIRI.supports('http://example.org/foo?/..')).toBe(true);
43+
expect(BaseIRI.supports('http://example.org/foo?/../')).toBe(true);
44+
expect(BaseIRI.supports('http://example.org/foo?//bar')).toBe(true);
45+
expect(BaseIRI.supports('http://example.org/foo?/./bar')).toBe(true);
46+
expect(BaseIRI.supports('http://example.org/foo?/../bar')).toBe(true);
47+
48+
expect(BaseIRI.supports('http://example.org/foo#/')).toBe(true);
49+
expect(BaseIRI.supports('http://example.org/foo#//')).toBe(true);
50+
expect(BaseIRI.supports('http://example.org/foo#/.')).toBe(true);
51+
expect(BaseIRI.supports('http://example.org/foo#/./')).toBe(true);
52+
expect(BaseIRI.supports('http://example.org/foo#/..')).toBe(true);
53+
expect(BaseIRI.supports('http://example.org/foo#/../')).toBe(true);
54+
expect(BaseIRI.supports('http://example.org/foo#//bar')).toBe(true);
55+
expect(BaseIRI.supports('http://example.org/foo#/./bar')).toBe(true);
56+
expect(BaseIRI.supports('http://example.org/foo#/../bar')).toBe(true);
57+
});
58+
459
describe('A BaseIRI instance', () => {
560
it('should relativize http://', () => {
661
const baseIri = new BaseIRI('http://example.org/foo/');
762

8-
const iri = `${baseIri.value}baz`;
63+
const iri = `${baseIri.base}baz`;
964
const relativized = baseIri.toRelative(iri);
1065

1166
expect(relativized).toBe('baz');
@@ -14,52 +69,70 @@ describe('BaseIRI', () => {
1469
it('should relativize https://', () => {
1570
const baseIri = new BaseIRI('https://example.org/foo/');
1671

17-
const iri = `${baseIri.value}baz`;
72+
const iri = `${baseIri.base}baz`;
1873
const relativized = baseIri.toRelative(iri);
1974

2075
expect(relativized).toBe('baz');
2176
});
2277

23-
it('should not relativize when initializing with a file scheme IRI', () => {
78+
it('should not relativize a base IRI with a file scheme', () => {
2479
const baseIri = new BaseIRI('file:///tmp/foo/bar');
2580

26-
const iri = `${baseIri.value}/baz`;
81+
const iri = `${baseIri.base}/baz`;
2782
const relativized = baseIri.toRelative(iri);
2883

2984
expect(relativized).toBe(iri);
3085
});
3186

32-
it('should not relativize when initializing with a IRI without scheme', () => {
87+
it('should not relativize a base IRI without scheme', () => {
3388
const baseIri = new BaseIRI('/tmp/foo/bar');
3489

35-
const iri = `${baseIri.value}/baz`;
90+
const iri = `${baseIri.base}/baz`;
3691
const relativized = baseIri.toRelative(iri);
3792

3893
expect(relativized).toBe(iri);
3994
});
4095

41-
it('should not relativize when initializing with a IRI containing `//`', () => {
96+
it('should not relativize a base IRI containing `//`', () => {
4297
const baseIri = new BaseIRI('http://example.org/foo//bar');
4398

44-
const iri = `${baseIri.value}/baz`;
99+
const iri = `${baseIri.base}/baz`;
45100
const relativized = baseIri.toRelative(iri);
46101

47102
expect(relativized).toBe(iri);
48103
});
49104

50-
it('should not relativize when initializing with a IRI containing `/./`', () => {
105+
it('should not relativize a base IRI containing `/./`', () => {
51106
const baseIri = new BaseIRI('http://example.org/foo/./bar');
52107

53-
const iri = `${baseIri.value}/baz`;
108+
const iri = `${baseIri.base}/baz`;
54109
const relativized = baseIri.toRelative(iri);
55110

56111
expect(relativized).toBe(iri);
57112
});
58113

59-
it('should not relativize when initializing with a IRI containing `/../`', () => {
114+
it('should not relativize a base IRI containing `/../`', () => {
60115
const baseIri = new BaseIRI('http://example.org/foo/../bar');
61116

62-
const iri = `${baseIri.value}/baz`;
117+
const iri = `${baseIri.base}/baz`;
118+
const relativized = baseIri.toRelative(iri);
119+
120+
expect(relativized).toBe(iri);
121+
});
122+
123+
it('should not relativize a base IRI ending in `/.`', () => {
124+
const baseIri = new BaseIRI('http://example.org/foo/.');
125+
126+
const iri = `${baseIri.base}/baz`;
127+
const relativized = baseIri.toRelative(iri);
128+
129+
expect(relativized).toBe(iri);
130+
});
131+
132+
it('should not relativize a base IRI ending in `/..`', () => {
133+
const baseIri = new BaseIRI('http://example.org/foo/..');
134+
135+
const iri = `${baseIri.base}/baz`;
63136
const relativized = baseIri.toRelative(iri);
64137

65138
expect(relativized).toBe(iri);

0 commit comments

Comments
 (0)