`;
}
}
diff --git a/src/components/sh-taglist.ts b/src/components/sh-taglist.ts
index 393d7f4..6ed6c5f 100644
--- a/src/components/sh-taglist.ts
+++ b/src/components/sh-taglist.ts
@@ -46,9 +46,9 @@ export class TagList extends LitElement {
return "No links";
}
let counter = new Counter();
- this.links.filtered.forEach((element) => {
+ for (let element of this.links) {
counter.addAll(element.tags);
- });
+ }
let unfilterTags = this.links.searchedTags.map(
this.renderUnfilterTag,
this
diff --git a/src/core/settings.ts b/src/core/settings.ts
index f4b4a7e..3df296d 100644
--- a/src/core/settings.ts
+++ b/src/core/settings.ts
@@ -1,27 +1,6 @@
// @ts-ignore
import * as browser from "webextension-polyfill";
-import {
- BookmarkSource,
- IStorageBackend,
- TBookmarkSource,
- TSettings,
-} from "../types";
-
-const DEFAULT_SETTINGS: TSettings = {
- sources: [
- {
- type: BookmarkSource.HTTP,
- settings: {
- url: "https://raw.githubusercontent.com/exhuma/schmackhaft/c4bbbe94856a1bdb5f88812ca5679327dcbddadc/docs/examples/external-file.json",
- },
- },
- {
- type: BookmarkSource.BROWSER,
- settings: {},
- },
- ],
- version: 3,
-};
+import { IStorageBackend, TSettings } from "../types";
/**
* A bridge to a "storage" for application settings.
@@ -30,25 +9,6 @@ export class SettingsBridge {
backend: any;
static async default() {
let settings = new SettingsBridge(browser.storage.local);
- let current = await settings.getAll();
- if (current.version === undefined) {
- // We have no settings yet. Let's start with a sensible default as
- // example.
- await settings.replace(DEFAULT_SETTINGS);
- return settings;
- }
- // TODO ideally this would loop over all migrations and apply everything
- // that's necessary.
- let migrationName = `migrate_${current.version}_to_${current.version + 1}`;
- let migrator = new Migrator();
-
- // @ts-ignore
- let migrationFunction = migrator[migrationName];
- if (migrationFunction) {
- await settings.replace(migrationFunction(current));
- } else {
- console.debug(`No migration function ${migrationName} is defined!`);
- }
return settings;
}
@@ -86,47 +46,3 @@ export class SettingsBridge {
});
}
}
-
-class Migrator {
- migrate_1_to_2(settings: any): any {
- if (settings.version !== 1) {
- throw new Error(
- `Expected to version 1 for the migration to 2, but got ${settings.version} instead`
- );
- }
- let newData = {
- remoteUrls: [settings.remoteUrl],
- enableBrowserBookmarks: true,
- version: 2,
- };
- return newData;
- }
-
- migrate_2_to_3(settings: any): any {
- if (settings.version !== 2) {
- throw new Error(
- `Expected to version 2 for the migration to 3, but got ${settings.version} instead`
- );
- }
- let sources: TBookmarkSource[] = [];
- if (settings.enableBrowserBookmarks) {
- sources.push({
- type: BookmarkSource.BROWSER,
- settings: {},
- });
- }
- settings.remoteUrls.forEach((item: string) => {
- sources.push({
- type: BookmarkSource.HTTP,
- settings: {
- url: item,
- },
- });
- });
- let newData: TSettings = {
- sources: sources,
- version: 3,
- };
- return newData;
- }
-}
diff --git a/src/model/link-collection.ts b/src/model/link-collection.ts
index cba3a82..9d47497 100644
--- a/src/model/link-collection.ts
+++ b/src/model/link-collection.ts
@@ -8,9 +8,14 @@ import { Link } from "../model/link";
import { intersection } from "../collections";
/**
- * A colelction of links.
+ * A collection of links.
*
* This is the main implementation for working and search for links.
+ *
+ * Instances of this class support the iterator protocol and can be used in a
+ * "for ... of" loop. When used this way, the iterated links will be filtered
+ * according to the current state and sorted according to the link's
+ * "compString" argument
*/
export class Links {
links: Array;
@@ -56,24 +61,6 @@ export class Links {
return JSON.stringify(this.links.map((item): Bookmark => item.toObject()));
}
- /**
- * Return a new list of links acording to the specified filter(s) in this class.
- * The returned list will also be sorted according to the link's "compString"
- * argument
- *
- * @todo Is it not possible to make objects comparable in JS? It should be?
- * @returns Return only links matching the current filters
- */
- get filtered() {
- const output = this.links.filter((link) => {
- return this.isMatchingOnTags(link) && this.isMatchingOnSearchString(link);
- });
- output.sort((a: Link, b: Link) => {
- return a.compString.localeCompare(b.compString);
- });
- return output;
- }
-
/**
* Determines whether a user searching for the string stored in this "Links"
* class should see the given link.
@@ -237,4 +224,65 @@ export class Links {
clearSearch() {
this.searchString = "";
}
+
+ /**
+ * Return the length/count of *filtered* links. For a total length see
+ * "totalLenght"
+ *
+ * @returns The count of filtered links
+ */
+ get filteredLength() {
+ return new Array(...this).length;
+ }
+
+ /**
+ * Return the length/count of all links encapsulated by this class. For a
+ * "filtered" length see "filteredLength"
+ *
+ * @returns The count of all (unfiltered) links encapsulated by this class
+ */
+ get totalLength() {
+ return this.links.length;
+ }
+
+ /**
+ * Return a single link by position after filtering and sorting has been
+ * applied.
+ * j
+ *
+ * @param index The position of the link (after filtering and sorting)
+ * @returns The link at the given position
+ */
+ getFromFiltered(index: number): Link {
+ return new Array(...this)[index];
+ }
+
+ /**
+ * Return a single link by position before filtering and sorting has been
+ * applied.
+ *
+ * @param index The position of the link (before filtering and sorting)
+ * @returns The link at the given position
+ */
+ getFromAll(index: number): Link {
+ return this.links[index];
+ }
+
+ /**
+ * Provide the "iterator protocol"
+ *
+ * @yields link objects as filtered and sorted by this collection
+ * @todo Is it not possible to make objects comparable in JS? It should be?
+ */
+ *[Symbol.iterator](): Generator {
+ const output = this.links.filter((link) => {
+ return this.isMatchingOnTags(link) && this.isMatchingOnSearchString(link);
+ });
+ output.sort((a: Link, b: Link) => {
+ return a.compString.localeCompare(b.compString);
+ });
+ for (let item of output) {
+ yield item;
+ }
+ }
}
diff --git a/src/model/settings.ts b/src/model/settings.ts
index 93de7e6..3a12b74 100644
--- a/src/model/settings.ts
+++ b/src/model/settings.ts
@@ -1,5 +1,12 @@
-import { TBookmarkSource } from "../types";
+import { BookmarkSource, TBookmarkSource, TSettings } from "../types";
+const LATEST_VERSION = 3;
+
+/**
+ * A simple data-class representing application settings.
+ *
+ * It provides convenience functions to convert to/from JSON
+ */
export class Settings {
sources: TBookmarkSource[];
version: number;
@@ -7,7 +14,7 @@ export class Settings {
constructor(
sources: TBookmarkSource[] = [],
- version: number = 3,
+ version: number = LATEST_VERSION,
favIconTemplate: string = ""
) {
this.sources = sources;
@@ -21,6 +28,20 @@ export class Settings {
static fromJson(data: string): Settings {
let dataObject = JSON.parse(data);
+ if (
+ dataObject &&
+ Object.keys(dataObject).length === 0 &&
+ Object.getPrototypeOf(dataObject) === Object.prototype
+ ) {
+ console.debug("Initialised empty settings object");
+ return new Settings();
+ }
+ dataObject = Migrator.upgrade(dataObject);
+ if (dataObject.version !== LATEST_VERSION) {
+ throw new Error(
+ `Settings version ${dataObject.version} is currently unsupported. Required version = ${LATEST_VERSION}`
+ );
+ }
return new Settings(
dataObject.sources,
dataObject.version,
@@ -28,3 +49,70 @@ export class Settings {
);
}
}
+
+/**
+ * The Migrator class encapsulates the logic to "upgrade" old settings
+ * structures to newer versions without losing any data.
+ */
+class Migrator {
+ /**
+ * Upgrade the *settings* object to the latest version and return the
+ * resulting object
+ *
+ * @param settings The current settings object
+ * @returns The upgraded settings object
+ */
+ static upgrade(settings: any): any {
+ // @ts-ignore
+ let func =
+ Migrator[`migrate_${settings.version}_to_${settings.version + 1}`];
+ while (func !== undefined) {
+ settings = func(settings);
+ // @ts-ignore
+ func = Migrator[`migrate_${settings.version}_to_${settings.version + 1}`];
+ }
+ return settings;
+ }
+
+ static migrate_1_to_2(settings: any): any {
+ if (settings.version !== 1) {
+ throw new Error(
+ `Expected to version 1 for the migration to 2, but got ${settings.version} instead`
+ );
+ }
+ let newData = {
+ remoteUrls: [settings.remoteUrl],
+ enableBrowserBookmarks: true,
+ version: 2,
+ };
+ return newData;
+ }
+
+ static migrate_2_to_3(settings: any): any {
+ if (settings.version !== 2) {
+ throw new Error(
+ `Expected to version 2 for the migration to 3, but got ${settings.version} instead`
+ );
+ }
+ let sources: TBookmarkSource[] = [];
+ if (settings.enableBrowserBookmarks) {
+ sources.push({
+ type: BookmarkSource.BROWSER,
+ settings: {},
+ });
+ }
+ settings.remoteUrls.forEach((item: string) => {
+ sources.push({
+ type: BookmarkSource.HTTP,
+ settings: {
+ url: item,
+ },
+ });
+ });
+ let newData: TSettings = {
+ sources: sources,
+ version: 3,
+ };
+ return newData;
+ }
+}
diff --git a/src/types.ts b/src/types.ts
index 9fd70d4..acfdf32 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -19,7 +19,7 @@
* @param value The value we want to convert
* @returns the enum value
*/
-export function getEnumByValue(cls: any, value: string): any {
+export function getEnumByValue(cls: any, value: string | number): any {
const typeIndex = Object.values(cls).indexOf(value);
if (typeIndex < 0) {
throw new Error(`Unknown enum value: ${value} for enum ${cls}`);
diff --git a/src/views/sh-settings.ts b/src/views/sh-settings.ts
index 0571666..3277e19 100644
--- a/src/views/sh-settings.ts
+++ b/src/views/sh-settings.ts
@@ -1,14 +1,15 @@
import "@material/mwc-textfield";
import "@material/mwc-button";
import "../components/sh-http-settings";
-import { BookmarkSource, TSettings, getEnumByValue } from "../types";
+import { BookmarkSource, getEnumByValue } from "../types";
import { LitElement, css, html } from "lit";
import { customElement, property, state } from "lit/decorators.js";
+import { Settings } from "../model/settings";
// @ts-ignore
import tailwind from "../tailwind.css";
@customElement("sh-settings")
-export class Settings extends LitElement {
+export class SettingsElement extends LitElement {
static styles = [
// @ts-ignore
css([tailwind]),
@@ -30,24 +31,21 @@ export class Settings extends LitElement {
`,
];
- private _settings: TSettings = { sources: [], version: 3 };
+ private _settings: Settings = new Settings();
@state()
private _newStorageType = "http";
- @state()
- private _isVersionSupported = false;
+ private supportedVersion = 3;
set settings(value: string) {
- let data = JSON.parse(value);
- this._isVersionSupported = data?.version === 3;
- this._settings = data;
+ this._settings = Settings.fromJson(value);
this.requestUpdate();
}
@property({ type: String })
get settings() {
- return JSON.stringify(this._settings);
+ return this._settings.toJson();
}
onSaveClick() {
@@ -144,7 +142,7 @@ export class Settings extends LitElement {
clip-rule="evenodd"
/>
- Icon description
+ Delete this source
${configBlock}
`;
@@ -177,14 +175,15 @@ export class Settings extends LitElement {
}
override render() {
- if (!this._isVersionSupported) {
+ if (this._settings.version !== this.supportedVersion) {
return html`
Settings version is not supported
The current version of the settings
(${this._settings?.version}) is not supported by the settings
- editor. This should have been automatically handled. If the
- problem persists please open a bug-report, including (if possible your
+ editor (expected version ${this.supportedVersion}). This
+ should have been automatically handled. If the problem
+ persists please open a bug-report, including (if possible your
settings object shown below). Your current settings object: