aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--src/content/controllers/SettingController.ts6
-rw-r--r--src/settings/components/index.tsx4
-rw-r--r--src/shared/SettingData.ts13
-rw-r--r--src/shared/Settings.ts21
-rw-r--r--src/shared/blacklists.ts13
-rw-r--r--src/shared/settings/Blacklist.ts39
-rw-r--r--src/shared/utils/re.ts6
-rw-r--r--test/shared/SettingData.test.ts11
-rw-r--r--test/shared/Settings.test.ts30
-rw-r--r--test/shared/blacklists.test.ts49
-rw-r--r--test/shared/settings/Blacklist.test.ts77
-rw-r--r--test/shared/utils/re.test.ts19
12 files changed, 139 insertions, 149 deletions
diff --git a/src/content/controllers/SettingController.ts b/src/content/controllers/SettingController.ts
index 7fb045b..06273a0 100644
--- a/src/content/controllers/SettingController.ts
+++ b/src/content/controllers/SettingController.ts
@@ -1,8 +1,6 @@
import { injectable } from 'tsyringe';
import AddonEnabledUseCase from '../usecases/AddonEnabledUseCase';
import SettingUseCase from '../usecases/SettingUseCase';
-import * as blacklists from '../../shared/blacklists';
-
import * as messages from '../../shared/messages';
@injectable()
@@ -17,9 +15,7 @@ export default class SettingController {
async initSettings(): Promise<void> {
try {
let current = await this.settingUseCase.reload();
- let disabled = blacklists.includes(
- current.blacklist, window.location.href,
- );
+ let disabled = current.blacklist.includes(window.location.href);
if (disabled) {
this.addonEnabledUseCase.disable();
} else {
diff --git a/src/settings/components/index.tsx b/src/settings/components/index.tsx
index e86d765..bd99d52 100644
--- a/src/settings/components/index.tsx
+++ b/src/settings/components/index.tsx
@@ -11,8 +11,8 @@ import SettingData, {
FormKeymaps, FormSearch, FormSettings, JSONTextSettings,
} from '../../shared/SettingData';
import { State as AppState } from '../reducers/setting';
-import * as settings from '../../shared/Settings';
import Properties from '../../shared/settings/Properties';
+import Blacklist from '../../shared/settings/Blacklist';
const DO_YOU_WANT_TO_CONTINUE =
'Some settings in JSON can be lost when migrating. ' +
@@ -143,7 +143,7 @@ class SettingsComponent extends React.Component<Props> {
let data = new SettingData({
source: this.props.source,
form: (this.props.form as FormSettings).buildWithBlacklist(
- settings.blacklistValueOf(value)),
+ Blacklist.fromJSON(value)),
});
this.props.dispatch(settingActions.set(data));
}
diff --git a/src/shared/SettingData.ts b/src/shared/SettingData.ts
index aa4e382..8ef8385 100644
--- a/src/shared/SettingData.ts
+++ b/src/shared/SettingData.ts
@@ -3,6 +3,7 @@ import Settings, * as settings from './Settings';
import Keymaps from './settings/Keymaps';
import Search from './settings/Search';
import Properties from './settings/Properties';
+import Blacklist from './settings/Blacklist';
export class FormKeymaps {
private data: {[op: string]: string};
@@ -146,13 +147,13 @@ export class FormSettings {
private properties: Properties;
- private blacklist: string[];
+ private blacklist: Blacklist;
constructor(
keymaps: FormKeymaps,
search: FormSearch,
properties: Properties,
- blacklist: string[],
+ blacklist: Blacklist,
) {
this.keymaps = keymaps;
this.search = search;
@@ -187,7 +188,7 @@ export class FormSettings {
);
}
- buildWithBlacklist(blacklist: string[]): FormSettings {
+ buildWithBlacklist(blacklist: Blacklist): FormSettings {
return new FormSettings(
this.keymaps,
this.search,
@@ -201,7 +202,7 @@ export class FormSettings {
keymaps: this.keymaps.toKeymaps().toJSON(),
search: this.search.toSearchSettings().toJSON(),
properties: this.properties.toJSON(),
- blacklist: this.blacklist,
+ blacklist: this.blacklist.toJSON(),
});
}
@@ -215,7 +216,7 @@ export class FormSettings {
keymaps: this.keymaps.toJSON(),
search: this.search.toJSON(),
properties: this.properties.toJSON(),
- blacklist: this.blacklist,
+ blacklist: this.blacklist.toJSON(),
};
}
@@ -229,7 +230,7 @@ export class FormSettings {
FormKeymaps.valueOf(o.keymaps),
FormSearch.valueOf(o.search),
Properties.fromJSON(o.properties),
- settings.blacklistValueOf(o.blacklist),
+ Blacklist.fromJSON(o.blacklist),
);
}
diff --git a/src/shared/Settings.ts b/src/shared/Settings.ts
index 6250aae..2767820 100644
--- a/src/shared/Settings.ts
+++ b/src/shared/Settings.ts
@@ -1,26 +1,15 @@
import Keymaps from './settings/Keymaps';
import Search from './settings/Search';
import Properties from './settings/Properties';
+import Blacklist from './settings/Blacklist';
export default interface Settings {
keymaps: Keymaps;
search: Search;
properties: Properties;
- blacklist: string[];
+ blacklist: Blacklist;
}
-export const blacklistValueOf = (o: any): string[] => {
- if (!Array.isArray(o)) {
- throw new TypeError(`"blacklist" is not an array of string`);
- }
- for (let x of o) {
- if (typeof x !== 'string') {
- throw new TypeError(`"blacklist" is not an array of string`);
- }
- }
- return o as string[];
-};
-
export const valueOf = (o: any): Settings => {
let settings = { ...DefaultSetting };
for (let key of Object.keys(o)) {
@@ -35,7 +24,7 @@ export const valueOf = (o: any): Settings => {
settings.properties = Properties.fromJSON(o.properties);
break;
case 'blacklist':
- settings.blacklist = blacklistValueOf(o.blacklist);
+ settings.blacklist = Blacklist.fromJSON(o.blacklist);
break;
default:
throw new TypeError('unknown setting: ' + key);
@@ -49,7 +38,7 @@ export const toJSON = (settings: Settings): any => {
keymaps: settings.keymaps.toJSON(),
search: settings.search.toJSON(),
properties: settings.properties.toJSON(),
- blacklist: settings.blacklist,
+ blacklist: settings.blacklist.toJSON(),
};
};
@@ -134,5 +123,5 @@ export const DefaultSetting: Settings = {
smoothscroll: false,
complete: 'sbh'
}),
- blacklist: []
+ blacklist: Blacklist.fromJSON([]),
};
diff --git a/src/shared/blacklists.ts b/src/shared/blacklists.ts
deleted file mode 100644
index 61ee4de..0000000
--- a/src/shared/blacklists.ts
+++ /dev/null
@@ -1,13 +0,0 @@
-import * as re from './utils/re';
-
-const includes = (blacklist: string[], url: string): boolean => {
- let u = new URL(url);
- return blacklist.some((item) => {
- if (!item.includes('/')) {
- return re.fromWildcard(item).test(u.host);
- }
- return re.fromWildcard(item).test(u.host + u.pathname);
- });
-};
-
-export { includes };
diff --git a/src/shared/settings/Blacklist.ts b/src/shared/settings/Blacklist.ts
new file mode 100644
index 0000000..a95b606
--- /dev/null
+++ b/src/shared/settings/Blacklist.ts
@@ -0,0 +1,39 @@
+export type BlacklistJSON = string[];
+
+const fromWildcard = (pattern: string): RegExp => {
+ let regexStr = '^' + pattern.replace(/\*/g, '.*') + '$';
+ return new RegExp(regexStr);
+};
+
+export default class Blacklist {
+ constructor(
+ private blacklist: string[],
+ ) {
+ }
+
+ static fromJSON(json: any): Blacklist {
+ if (!Array.isArray(json)) {
+ throw new TypeError(`"blacklist" is not an array of string`);
+ }
+ for (let x of json) {
+ if (typeof x !== 'string') {
+ throw new TypeError(`"blacklist" is not an array of string`);
+ }
+ }
+ return new Blacklist(json);
+ }
+
+ toJSON(): BlacklistJSON {
+ return this.blacklist;
+ }
+
+ includes(url: string): boolean {
+ let u = new URL(url);
+ return this.blacklist.some((item) => {
+ if (!item.includes('/')) {
+ return fromWildcard(item).test(u.host);
+ }
+ return fromWildcard(item).test(u.host + u.pathname);
+ });
+ }
+}
diff --git a/src/shared/utils/re.ts b/src/shared/utils/re.ts
deleted file mode 100644
index 34f4fa6..0000000
--- a/src/shared/utils/re.ts
+++ /dev/null
@@ -1,6 +0,0 @@
-const fromWildcard = (pattern: string): RegExp => {
- let regexStr = '^' + pattern.replace(/\*/g, '.*') + '$';
- return new RegExp(regexStr);
-};
-
-export { fromWildcard };
diff --git a/test/shared/SettingData.test.ts b/test/shared/SettingData.test.ts
index b5bf70e..4391e73 100644
--- a/test/shared/SettingData.test.ts
+++ b/test/shared/SettingData.test.ts
@@ -6,6 +6,7 @@ import { expect } from 'chai';
import Keymaps from '../../src/shared/settings/Keymaps';
import Search from '../../src/shared/settings/Search';
import Properties from '../../src/shared/settings/Properties';
+import Blacklist from '../../src/shared/settings/Blacklist'
describe('shared/SettingData', () => {
describe('FormKeymaps', () => {
@@ -64,7 +65,7 @@ describe('shared/SettingData', () => {
keymaps: settings.keymaps.toJSON(),
search: settings.search.toJSON(),
properties: settings.properties.toJSON(),
- blacklist: settings.blacklist,
+ blacklist: settings.blacklist.toJSON(),
}).to.deep.equal(JSON.parse(o));
});
});
@@ -84,7 +85,7 @@ describe('shared/SettingData', () => {
smoothscroll: false,
complete: "sbh"
}),
- blacklist: [],
+ blacklist: Blacklist.fromJSON([]),
};
let json = JSONTextSettings.fromSettings(o).toJSONText();
@@ -92,7 +93,7 @@ describe('shared/SettingData', () => {
keymaps: o.keymaps.toJSON(),
search: o.search.toJSON(),
properties: o.properties.toJSON(),
- blacklist: o.blacklist,
+ blacklist: o.blacklist.toJSON(),
});
});
});
@@ -125,7 +126,7 @@ describe('shared/SettingData', () => {
keymaps: settings.keymaps.toJSON(),
search: settings.search.toJSON(),
properties: settings.properties.toJSON(),
- blacklist: settings.blacklist,
+ blacklist: settings.blacklist.toJSON(),
}).to.deep.equal({
keymaps: {
'j': { type: 'scroll.vertically', count: 1 },
@@ -165,7 +166,7 @@ describe('shared/SettingData', () => {
smoothscroll: false,
complete: "sbh"
}),
- blacklist: []
+ blacklist: Blacklist.fromJSON([]),
};
let json = FormSettings.fromSettings(data).toJSON();
diff --git a/test/shared/Settings.test.ts b/test/shared/Settings.test.ts
index 6360bab..9688798 100644
--- a/test/shared/Settings.test.ts
+++ b/test/shared/Settings.test.ts
@@ -2,32 +2,6 @@ import * as settings from '../../src/shared/Settings';
import {expect} from 'chai';
describe('Settings', () => {
-
- describe('#blacklistValueOf', () => {
- it('returns empty array by empty settings', () => {
- let blacklist = settings.blacklistValueOf([]);
- expect(blacklist).to.be.empty;
- });
-
- it('returns blacklist by valid settings', () => {
- let blacklist = settings.blacklistValueOf([
- "github.com",
- "circleci.com",
- ]);
-
- expect(blacklist).to.deep.equal([
- "github.com",
- "circleci.com",
- ]);
- });
-
- it('throws a TypeError by invalid settings', () => {
- expect(() => settings.blacklistValueOf(null)).to.throw(TypeError);
- expect(() => settings.blacklistValueOf({})).to.throw(TypeError);
- expect(() => settings.blacklistValueOf([1,2,3])).to.throw(TypeError);
- });
- });
-
describe('#valueOf', () => {
it('returns settings by valid settings', () => {
let x = settings.valueOf({
@@ -46,7 +20,7 @@ describe('Settings', () => {
keymaps: x.keymaps.toJSON(),
search: x.search.toJSON(),
properties: x.properties.toJSON(),
- blacklist: x.blacklist,
+ blacklist: x.blacklist.toJSON(),
}).to.deep.equal({
keymaps: {},
search: {
@@ -70,7 +44,7 @@ describe('Settings', () => {
expect(value.properties.toJSON()).to.not.be.empty;
expect(value.search.defaultEngine).to.be.a('string');
expect(value.search.engines).to.be.an('object');
- expect(value.blacklist).to.be.empty;
+ expect(value.blacklist.toJSON()).to.be.empty;
});
it('throws a TypeError with an unknown field', () => {
diff --git a/test/shared/blacklists.test.ts b/test/shared/blacklists.test.ts
deleted file mode 100644
index 289ea0f..0000000
--- a/test/shared/blacklists.test.ts
+++ /dev/null
@@ -1,49 +0,0 @@
-import { includes } from 'shared/blacklists';
-
-describe("shared/blacklist", () => {
- it('matches by *', () => {
- let blacklist = ['*'];
-
- expect(includes(blacklist, 'https://github.com/abc')).to.be.true;
- })
-
- it('matches by hostname', () => {
- let blacklist = ['github.com'];
-
- expect(includes(blacklist, 'https://github.com')).to.be.true;
- expect(includes(blacklist, 'https://gist.github.com')).to.be.false;
- expect(includes(blacklist, 'https://github.com/ueokande')).to.be.true;
- expect(includes(blacklist, 'https://github.org')).to.be.false;
- expect(includes(blacklist, 'https://google.com/search?q=github.org')).to.be.false;
- })
-
- it('matches by hostname with wildcard', () => {
- let blacklist = ['*.github.com'];
-
- expect(includes(blacklist, 'https://github.com')).to.be.false;
- expect(includes(blacklist, 'https://gist.github.com')).to.be.true;
- })
-
- it('matches by path', () => {
- let blacklist = ['github.com/abc'];
-
- expect(includes(blacklist, 'https://github.com/abc')).to.be.true;
- expect(includes(blacklist, 'https://github.com/abcdef')).to.be.false;
- expect(includes(blacklist, 'https://gist.github.com/abc')).to.be.false;
- })
-
- it('matches by path with wildcard', () => {
- let blacklist = ['github.com/abc*'];
-
- expect(includes(blacklist, 'https://github.com/abc')).to.be.true;
- expect(includes(blacklist, 'https://github.com/abcdef')).to.be.true;
- expect(includes(blacklist, 'https://gist.github.com/abc')).to.be.false;
- })
-
- it('matches address and port', () => {
- let blacklist = ['127.0.0.1:8888'];
-
- expect(includes(blacklist, 'http://127.0.0.1:8888/')).to.be.true;
- expect(includes(blacklist, 'http://127.0.0.1:8888/hello')).to.be.true;
- })
-});
diff --git a/test/shared/settings/Blacklist.test.ts b/test/shared/settings/Blacklist.test.ts
new file mode 100644
index 0000000..fbacf5d
--- /dev/null
+++ b/test/shared/settings/Blacklist.test.ts
@@ -0,0 +1,77 @@
+import Blacklist from '../../../src/shared/settings/Blacklist';
+import { expect } from 'chai';
+
+describe('Blacklist', () => {
+ describe('fromJSON', () => {
+ it('returns empty array by empty settings', () => {
+ let blacklist = Blacklist.fromJSON([]);
+ expect(blacklist.toJSON()).to.be.empty;
+ });
+
+ it('returns blacklist by valid settings', () => {
+ let blacklist = Blacklist.fromJSON([
+ 'github.com',
+ 'circleci.com',
+ ]);
+
+ expect(blacklist.toJSON()).to.deep.equal([
+ 'github.com',
+ 'circleci.com',
+ ]);
+ });
+
+ it('throws a TypeError by invalid settings', () => {
+ expect(() => Blacklist.fromJSON(null)).to.throw(TypeError);
+ expect(() => Blacklist.fromJSON({})).to.throw(TypeError);
+ expect(() => Blacklist.fromJSON([1,2,3])).to.throw(TypeError);
+ });
+ });
+
+ describe('#includes', () => {
+ it('matches by *', () => {
+ let blacklist = new Blacklist(['*']);
+
+ expect(blacklist.includes('https://github.com/abc')).to.be.true;
+ });
+
+ it('matches by hostname', () => {
+ let blacklist = new Blacklist(['github.com']);
+
+ expect(blacklist.includes('https://github.com')).to.be.true;
+ expect(blacklist.includes('https://gist.github.com')).to.be.false;
+ expect(blacklist.includes('https://github.com/ueokande')).to.be.true;
+ expect(blacklist.includes('https://github.org')).to.be.false;
+ expect(blacklist.includes('https://google.com/search?q=github.org')).to.be.false;
+ });
+
+ it('matches by hostname with wildcard', () => {
+ let blacklist = new Blacklist(['*.github.com']);
+
+ expect(blacklist.includes('https://github.com')).to.be.false;
+ expect(blacklist.includes('https://gist.github.com')).to.be.true;
+ })
+
+ it('matches by path', () => {
+ let blacklist = new Blacklist(['github.com/abc']);
+
+ expect(blacklist.includes('https://github.com/abc')).to.be.true;
+ expect(blacklist.includes('https://github.com/abcdef')).to.be.false;
+ expect(blacklist.includes('https://gist.github.com/abc')).to.be.false;
+ })
+
+ it('matches by path with wildcard', () => {
+ let blacklist = new Blacklist(['github.com/abc*']);
+
+ expect(blacklist.includes('https://github.com/abc')).to.be.true;
+ expect(blacklist.includes('https://github.com/abcdef')).to.be.true;
+ expect(blacklist.includes('https://gist.github.com/abc')).to.be.false;
+ })
+
+ it('matches address and port', () => {
+ let blacklist = new Blacklist(['127.0.0.1:8888']);
+
+ expect(blacklist.includes('http://127.0.0.1:8888/')).to.be.true;
+ expect(blacklist.includes('http://127.0.0.1:8888/hello')).to.be.true;
+ })
+ })
+});
diff --git a/test/shared/utils/re.test.ts b/test/shared/utils/re.test.ts
deleted file mode 100644
index d12ceb7..0000000
--- a/test/shared/utils/re.test.ts
+++ /dev/null
@@ -1,19 +0,0 @@
-import * as re from 'shared/utils/re';
-
-describe("re util", () => {
- it('matches by pattern', () => {
- let regex = re.fromWildcard('*.example.com/*');
- expect('foo.example.com/bar').to.match(regex);
- expect('foo.example.com').not.to.match(regex);
- expect('example.com/bar').not.to.match(regex);
-
- regex = re.fromWildcard('example.com/*')
- expect('example.com/foo').to.match(regex);
- expect('example.com/').to.match(regex);
-
- regex = re.fromWildcard('example.com/*bar')
- expect('example.com/foobar').to.match(regex);
- expect('example.com/bar').to.match(regex);
- expect('example.com/foobarfoo').not.to.match(regex);
- })
-});
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-01 06:18:20 +0000