update

eslint: 7.7.0 ==> 7.8.1 minor

.drone.yml

@@ -0,0 +1,14 @@
+kind: pipeline
+name: default
+
+steps:
+  - name: setup
+    image: registry:5000/node-build
+    commands:
+      - yarn
+      - curl https://git.scode.ovh/Timo/standard/raw/branch/master/ci.js > ci.js
+
+  - name: build
+    image: registry:5000/node-build
+    commands:
+      - node ci.js

.eslintrc.js

@@ -5,20 +5,18 @@
  * Created by Timo Hocker <timo@scode.ovh>, May 2020
  */
 
+'use strict';
+
 module.exports = {
   env: {
     commonjs: true,
-    es6: true,
+    es6:      true,
-    node: true
+    node:     true
   },
-  extends: [
+  extends: [ '@sapphirecode' ],
-    '@scode'
-  ],
   globals: {
-    Atomics: 'readonly',
+    Atomics:           'readonly',
     SharedArrayBuffer: 'readonly'
   },
-  parserOptions: {
+  parserOptions: { ecmaVersion: 2018 }
-    ecmaVersion: 2018
+};
-  }
-}

.npmrc

@@ -1 +0,0 @@
-@scode:registry=https://npm.scode.ovh

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 1.1.0
+
+Adapting ControlModel to be able to use the full Persistent-Type range and use
+observers instead of baked in functions.
+
+## 1.0.0
+
+initial version

Jenkinsfile

@@ -1,23 +0,0 @@
-pipeline {
-    agent any
-
-    environment {
-        VERSION = VersionNumber([
-            versionNumberString:
-                '${BUILDS_ALL_TIME}',
-            versionPrefix: '1.0.',
-            worstResultForIncrement: 'SUCCESS'
-        ])
-    }
-
-    stages {
-        stage('Building') {
-            steps {
-                script {
-                    currentBuild.displayName = env.VERSION
-                }
-                sh 'yarn ci ${VERSION}'
-            }
-        }
-    }
-}

LICENSE

@@ -1,4 +1,4 @@
-MIT License Copyright (c) 2020 Timo Hocker
+MIT License Copyright (c) <year> <author>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -0,0 +1,116 @@
+# @sapphirecode/modelling
+
+version: 1.1.x
+
+base classes for controlling data
+
+## Installation
+
+npm:
+
+> npm i --save @sapphirecode/modelling
+
+yarn:
+
+> yarn add @sapphirecode/modelling
+
+## Usage
+
+### Classes
+
+#### Persistent
+
+Persistent allows easy data transfer between classes that extend Persistent, as
+long as they have overlapping properties.
+
+to create a persistent type, create a class that extends Persistent and in the
+constructor, define all properties you want to store.
+
+Property types can be string, boolean, number or array
+
+```js
+import { Persistent } from '@sapphirecode/modelling';
+
+class Foo extends Persistent {
+  public constructor() {
+    super();
+    this.properties.foo = 'string';
+    this.properties.baz = 'boolean';
+  }
+}
+
+class Bar extends Persistent {
+  public constructor() {
+    super();
+    this.properties.bar = 'string';
+    this.properties.baz = 'boolean';
+  }
+}
+
+const f = new Foo();
+f.set('foo','bar');
+f.set('baz', true);
+
+const b = new Bar();
+b.assign(f); // f.assign_to(b) will do the same
+// now the property 'baz' of b will also be true
+console.log(b.serialize()); // Persistent also implements Serializable
+```
+
+Methods:
+
+- assign, assign_to, assign_object: (implementation of Assignable)
+- to_object: return data as plain object
+- serialize: return data as json string (Implementation of Serializable)
+- set(key, value): set property to a specific value
+- get(key): get a property
+
+#### DatabaseModel
+
+Extends Persistent and has the abstract methods read, write, delete and
+define_properties to allow working with databases
+
+in define_properties, set all the properties you need, id is automatically added
+and has to be a number.
+
+read, write and delete specify the actions needed to interact with the database
+itself
+
+#### ControlModel
+
+The ControlModel is there to verify incoming data and modify it if needed. It
+also extends Persistent.
+
+The method define_properties lets you define the data you will store.
+
+before_change allows you to register observers, that are able to cancel changes.
+the registered observers are called with the following parameters: (new_value,
+old_value, property_name). By returning false they can cancel the change that
+was about to happen.
+
+register_observer does the same thing, but those observers are not able to
+cancel the change and they are called after the change already happened.
+
+### Interfaces
+
+#### Assignable
+
+Base interface of Persistent
+
+Methods:
+
+- assign(b): assign data of another assingable object (b)
+- assign_to(b): assing data to b
+- assign_object(obj): assign data of plain object obj
+
+#### Serializable
+
+Interface to allow serialization of different data structures
+
+Methods:
+
+- serialize: serialize into a string
+
+## License
+
+MIT © Timo Hocker <timo@scode.ovh>

jenkins.js

@@ -1,38 +0,0 @@
-/*
- * Copyright (C) Sapphirecode - All Rights Reserved
- * This file is part of Modelling which is released under MIT.
- * See file 'LICENSE' for full license details.
- * Created by Timo Hocker <timo@scode.ovh>, May 2020
- */
-
-/* eslint-disable no-process-exit */
-/* eslint-disable no-console */
-/* eslint-disable no-sync */
-'use strict';
-
-const fs = require ('fs');
-const child_process = require ('child_process');
-
-const pkg = JSON.parse (fs.readFileSync ('package.json', 'utf-8'));
-[
-  ,, pkg.version
-] = process.argv;
-fs.writeFileSync ('package.json', JSON.stringify (pkg, null, 2));
-
-child_process.execSync ('yarn lint', { stdio: 'inherit' });
-if (typeof pkg.scripts !== 'undefined' && typeof pkg.scripts.test === 'string')
-  child_process.execSync ('yarn test', { stdio: 'inherit' });
-if (
-  typeof pkg.scripts !== 'undefined'
-  && typeof pkg.scripts.compile === 'string'
-)
-  child_process.execSync ('yarn compile', { stdio: 'inherit' });
-
-child_process.exec ('git log -1 | grep \'\\[no publish\\]\'')
-  .addListener ('exit', (code) => {
-    if (code === 0) {
-      console.log ('build not marked for deployment');
-      process.exit (1);
-    }
-    else { child_process.execSync ('yarn publish'); }
-  });

lib/.eslintrc.js

@@ -5,20 +5,20 @@
  * Created by Timo Hocker <timo@scode.ovh>, May 2020
  */
 
+/* eslint-disable */
+
+'use strict';
+
 module.exports = {
   env: {
     commonjs: true,
-    es6: true,
+    es6:      true,
-    node: true
+    node:     true
   },
-  extends: [
+  extends: [ '@sapphirecode/eslint-config-ts' ],
-    '@scode/eslint-config-ts'
-  ],
   globals: {
-    Atomics: 'readonly',
+    Atomics:           'readonly',
     SharedArrayBuffer: 'readonly'
   },
-  parserOptions: {
+  parserOptions: { ecmaVersion: 2018 }
-    ecmaVersion: 2018
+};
-  }
-}

lib/ControlModel.ts

@@ -5,13 +5,47 @@
  * Created by Timo Hocker <timo@scode.ovh>, May 2020
  */
 
-export abstract class ControlModel {
+import { Persistent } from './Persistent';
-  public abstract get object(): Record<string, unknown>;
+import { PersistentType, ControlObserver, Observer } from './Types';
-  public abstract set object(obj: Record<string, unknown>);
 
-  public update (): void {
+export abstract class ControlModel extends Persistent {
-    this.verify ();
+  private _before_change: Record<string, ControlObserver[]> = {};
+  private _observers: Record<string, Observer[]> = {};
+
+  public constructor (obj?: Record<string, PersistentType>) {
+    super ();
+    this.define_properties ();
+    if (typeof obj !== 'undefined')
+      this.assign_object (obj);
   }
 
-  public abstract verify(): void;
+  public set (key: string, value: PersistentType): void {
+    const prev = this.get (key);
+    if (typeof this._before_change[key] !== 'undefined') {
+      for (const obs of this._before_change[key]) {
+        if (!obs (value, prev, key))
+          return;
+      }
+    }
+
+    super.set (key, value);
+    if (typeof this._observers[key] !== 'undefined') {
+      for (const obs of this._observers[key])
+        obs (value, prev, key);
+    }
+  }
+
+  public before_change (key: string, func: ControlObserver): void {
+    if (typeof this._before_change[key] === 'undefined')
+      this._before_change[key] = [];
+    this._before_change[key].push (func);
+  }
+
+  public register_observer (key: string, func: Observer): void {
+    if (typeof this._observers[key] === 'undefined')
+      this._observers[key] = [];
+    this._observers[key].push (func);
+  }
+
+  protected abstract define_properties(): void;
 }

lib/DatabaseModel.ts

@@ -5,28 +5,46 @@
  * Created by Timo Hocker <timo@scode.ovh>, May 2020
  */
 
-export abstract class DatabaseModel {
+import { Persistent } from './Persistent';
-  protected id?: number;
 
-  public static async get<T extends DatabaseModel> (
+export abstract class DatabaseModel extends Persistent {
-    id: number,
+  public get id (): number {
-    constructor: new () => T
+    return this.get ('id') as number;
-  ): Promise<T> {
-    const dbm = (new constructor);
-    dbm.id = id;
-    await dbm.read ();
-    return dbm;
   }
 
-  public get object (): Record<string, number | string | undefined> {
+  public constructor (id?: number) {
-    const obj = { id: this.id };
+    super ();
-    return obj;
+    this.properties.id = 'number';
+    this.define_properties ();
+    for (const prop of Object.keys (this.properties)) {
+      if ([
+        'string',
+        'number',
+        'boolean'
+      ].indexOf (this.properties[prop]) < 0) {
+        throw new Error (
+          'property types have to be either string, number or boolean'
+        );
+      }
+    }
+    if (typeof id !== 'undefined')
+      this.set ('id', id);
   }
 
-  public set object (obj: Record<string, number | string | undefined>) {
+  public get (key: string): string|number|boolean {
-    this.id = obj.id as number | undefined;
+    return super.get (key) as string|number|boolean;
   }
 
-  public abstract read(): Promise<void>;
+  public set (key: string, value: string|number|boolean): void {
-  public abstract write(): Promise<void>;
+    super.set (key, value);
+  }
+
+  public to_object (): Record<string, string|number|boolean> {
+    return super.to_object () as Record<string, string|number|boolean>;
+  }
+
+  public abstract async read(): Promise<boolean>;
+  public abstract async write(): Promise<boolean>;
+  public abstract async delete(): Promise<boolean>;
+  protected abstract define_properties(): void;
 }

lib/Persistent.ts

@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) Sapphirecode - All Rights Reserved
+ * This file is part of Modelling which is released under MIT.
+ * See file 'LICENSE' for full license details.
+ * Created by Timo Hocker <timo@scode.ovh>, May 2020
+ */
+
+import { copy_object } from '@sapphirecode/utilities';
+import { Assignable, Serializable } from './interfaces';
+import { PersistentTypeString, PersistentType } from './Types';
+
+export abstract class Persistent implements Assignable, Serializable {
+  private _data: Record<string, PersistentType> = {};
+  protected readonly properties: Record<string, PersistentTypeString> = {};
+
+  public assign (a: Assignable): void {
+    this.assign_object (a.to_object ());
+  }
+
+  public assign_to (a: Assignable): void {
+    a.assign (this);
+  }
+
+  public assign_object (obj: Record<string, unknown>): void {
+    for (const key of Object.keys (obj)) {
+      const prop = this.properties[key];
+      if (typeof prop !== 'undefined' && typeof obj[key] === prop)
+        this._data[key] = obj[key] as PersistentType;
+    }
+  }
+
+  public to_object (): Record<string, PersistentType> {
+    return copy_object (this._data) as Record<string, PersistentType>;
+  }
+
+  public serialize (formatted = false): string {
+    if (formatted)
+      return JSON.stringify (this._data, null, 2);
+    return JSON.stringify (this._data);
+  }
+
+  private check_type (value: unknown, prop: PersistentTypeString): boolean {
+    if (typeof prop === 'undefined')
+      return false;
+    if (prop === 'array')
+      return Array.isArray (value);
+
+    return typeof value === prop;
+  }
+
+  public set (key: string, value: unknown): void {
+    const prop = this.properties[key];
+    if (this.check_type (value, prop))
+      this._data[key] = value as PersistentType;
+  }
+
+  public get (key: string): PersistentType {
+    return this._data[key];
+  }
+}

lib/Types.ts

@@ -0,0 +1,15 @@
+export type PersistentTypeString = 'string'|'number'|'boolean'|'array';
+export type PersistentPrimitive = string|number|boolean;
+export type PersistentType = PersistentPrimitive|PersistentPrimitive[];
+
+export type Observer = (
+  value: PersistentType,
+   prev: PersistentType,
+   key: string
+) => void;
+
+export type ControlObserver = (
+  value: PersistentType,
+  prev: PersistentType,
+  key: string
+) => boolean;

lib/index.ts

@@ -7,3 +7,5 @@
 
 export { ControlModel } from './ControlModel';
 export { DatabaseModel } from './DatabaseModel';
+export { Persistent } from './Persistent';
+export * from './interfaces';

lib/interfaces/Assignable.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright (C) Sapphirecode - All Rights Reserved
+ * This file is part of Modelling which is released under MIT.
+ * See file 'LICENSE' for full license details.
+ * Created by Timo Hocker <timo@scode.ovh>, May 2020
+ */
+
+export interface Assignable {
+  assign (a: Assignable): void;
+  assign_to (a: Assignable): void;
+  to_object (): Record<string, unknown>;
+}

lib/interfaces/Serializable.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright (C) Sapphirecode - All Rights Reserved
+ * This file is part of Modelling which is released under MIT.
+ * See file 'LICENSE' for full license details.
+ * Created by Timo Hocker <timo@scode.ovh>, May 2020
+ */
+
+export interface Serializable {
+  serialize(): string;
+}

lib/interfaces/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (C) Sapphirecode - All Rights Reserved
+ * This file is part of Modelling which is released under MIT.
+ * See file 'LICENSE' for full license details.
+ * Created by Timo Hocker <timo@scode.ovh>, May 2020
+ */
+
+export { Assignable } from './Assignable';
+export { Serializable } from './Serializable';

package.json

@@ -1,22 +1,37 @@
 {
-  "name": "@scode/modelling",
+  "name": "@sapphirecode/modelling",
-  "version": "1.0.0",
+  "version": "1.1.13",
   "main": "dist/index.js",
-  "author": "Timo Hocker <timo@scode.ovh>",
+  "author": {
+    "name": "Timo Hocker",
+    "email": "timo@scode.ovh"
+  },
+  "bugs": "https://redmine.scode.ovh/projects/modelling",
   "license": "MIT",
+  "description": "base classes for controlling data",
+  "repository": {
+    "type": "git",
+    "url": "https://git.scode.ovh:timo/modelling.git"
+  },
   "devDependencies": {
-    "@scode/eslint-config-ts": "^1.0.27",
+    "@sapphirecode/eslint-config-ts": "^1.1.4",
-    "eslint": "^6.8.0",
+    "eslint": "^7.0.0",
-    "typescript": "^3.8.3"
+    "typescript": "^4.0.2"
   },
   "scripts": {
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx,.vue,.mjs",
     "test": "echo \"no test\"",
-    "ci": "yarn && node jenkins.js",
     "compile": "tsc"
   },
   "files": [
     "/dist/",
     "LICENSE"
+  ],
+  "dependencies": {
+    "@sapphirecode/utilities": "^1.3.2"
+  },
+  "keywords": [
+    "typescript",
+    "data control"
   ]
 }

tsconfig.json

@@ -10,7 +10,7 @@
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
     "declaration": true,                   /* Generates corresponding '.d.ts' file. */
     // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+   "sourceMap": true,                     /* Generates corresponding '.map' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
     "outDir": "./dist",                        /* Redirect output structure to the directory. */
     "rootDir": "./lib",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */