[IMP] Core: Separate EventMixin/VersionableObject

Author: Goaman

packages/core/src/Modifier.ts

@@ -1,6 +1,7 @@
 import { Constructor } from '../../utils/src/utils';
 import { VNode } from './VNodes/VNode';
 import { EventMixin } from '../../utils/src/EventMixin';
+import { makeVersionable } from './Memory/Versionable';
 
 export enum ModifierLevel {
     LOW,
@@ -24,6 +25,11 @@ export class Modifier extends EventMixin {
     preserveAfterLineBreak = true; // True to preserve modifier after a line break.
     level = ModifierLevel.MEDIUM;
 
+    constructor() {
+        super();
+        return makeVersionable(this);
+    }
+
     get name(): string {
         return '';
     }

packages/core/src/Modifiers.ts

@@ -2,6 +2,7 @@ import { Modifier } from './Modifier';
 import { Constructor, isConstructor } from '../../utils/src/utils';
 import { EventMixin } from '../../utils/src/EventMixin';
 import { VersionableArray } from './Memory/VersionableArray';
+import { makeVersionable } from './Memory/Versionable';
 
 export class Modifiers extends EventMixin {
     private _contents: Modifier[];
@@ -11,6 +12,7 @@ export class Modifiers extends EventMixin {
             return mod instanceof Modifier ? mod.clone() : mod;
         });
         this.append(...clonedModifiers);
+        return makeVersionable(this);
     }
 
     //--------------------------------------------------------------------------

packages/core/src/VNodes/AbstractNode.ts

@@ -11,6 +11,7 @@ import { Modifiers } from '../Modifiers';
 import { EventMixin } from '../../../utils/src/EventMixin';
 import { Modifier } from '../Modifier';
 import { markAsDiffRoot } from '../Memory/Memory';
+import { makeVersionable } from '../Memory/Versionable';
 
 export interface AbstractNodeParams {
     modifiers?: Modifiers | Array<Modifier | Constructor<Modifier>>;
@@ -80,7 +81,9 @@ export abstract class AbstractNode extends EventMixin {
                 this.modifiers.append(...params.modifiers);
             }
         }
-        markAsDiffRoot(this);
+        const node = makeVersionable(this);
+        markAsDiffRoot(node);
+        return node;
     }
 
     get modifiers(): Modifiers {

packages/plugin-odoo-field/src/OdooField.ts

@@ -4,7 +4,7 @@ import { Parser } from '../../plugin-parser/src/Parser';
 import { Renderer } from '../../plugin-renderer/src/Renderer';
 import { OdooFieldDomObjectRenderer } from './OdooFieldDomObjectRenderer';
 import { OdooFieldXmlDomParser } from './OdooFieldXmlDomParser';
-import { ReactiveValue } from '../../utils/src/ReactiveValue';
+import { ReactiveValueVersionable } from '../../utils/src/ReactiveValueVersionable';
 import { OdooFieldMap } from './OdooFieldMap';
 import { OdooMonetaryFieldXmlDomParser } from './OdooMonetaryFieldXmlDomParser';
 import { OdooMonetaryFieldDomObjectRenderer } from './OdooMonetaryFieldDomObjectRenderer';
@@ -18,8 +18,8 @@ export interface OdooFieldDefinition {
 
 export interface OdooFieldInfo extends OdooFieldDefinition {
     readonly originalValue: string;
-    value: ReactiveValue<string>;
-    isValid: ReactiveValue<boolean>;
+    value: ReactiveValueVersionable<string>;
+    isValid: ReactiveValueVersionable<boolean>;
 }
 
 /**
@@ -53,8 +53,8 @@ export class OdooField<T extends JWPluginConfig = JWPluginConfig> extends JWPlug
     register(field: OdooFieldDefinition, type: string, value: string): OdooFieldInfo {
         if (!this._registry.get(field)) {
             // TODO: Retrieve the field from Odoo through RPC.
-            const reactiveValue = new ReactiveValue<string>();
-            const isValid = new ReactiveValue(true);
+            const reactiveValue = new ReactiveValueVersionable<string>();
+            const isValid = new ReactiveValueVersionable<boolean>(true);
             if (Object.keys(fieldValidators).includes(type)) {
                 reactiveValue.on('set', (newValue: string): void => {
                     isValid.set(!!newValue.match(fieldValidators[type]));

packages/plugin-xml/src/ClassList.ts

@@ -1,5 +1,6 @@
 import { VersionableObject } from '../../core/src/Memory/VersionableObject';
 import { EventMixin } from '../../utils/src/EventMixin';
+import { makeVersionable } from '../../core/src/Memory/Versionable';
 
 export class ClassList extends EventMixin {
     private _classList: Record<string, boolean>;
@@ -8,6 +9,7 @@ export class ClassList extends EventMixin {
         for (const className of classList) {
             this.add(className);
         }
+        return makeVersionable(this);
     }
 
     //--------------------------------------------------------------------------

packages/plugin-xml/src/CssStyle.ts

@@ -8,6 +8,7 @@ export class CssStyle extends EventMixin {
         if (style) {
             this.reset(style);
         }
+        return makeVersionable(this);
     }
 
     //--------------------------------------------------------------------------

packages/utils/src/EventMixin.ts

@@ -1,12 +1,11 @@
-import { VersionableObject } from '../../core/src/Memory/VersionableObject';
 import { VersionableArray } from '../../core/src/Memory/VersionableArray';
 import { makeVersionable } from '../../core/src/Memory/Versionable';
 import { VersionableSet } from '../../core/src/Memory/VersionableSet';
 
 /**
  * Abstract class to add event mechanism.
  */
-export class EventMixin extends VersionableObject {
+export class EventMixin {
     _eventCallbacks: Record<string, Function[]>;
     _callbackWorking: Set<Function>;
 

packages/utils/src/ReactiveValueVersionable.ts

@@ -0,0 +1,10 @@
+import { makeVersionable } from '../../core/src/Memory/Versionable';
+import { Constructor } from './utils';
+import { ReactiveValue } from './ReactiveValue';
+
+export class ReactiveValueVersionable<T> extends ReactiveValue<T> {
+    constructor(...args: ConstructorParameters<Constructor<ReactiveValue<T>>>) {
+        super(...args);
+        return makeVersionable(this);
+    }
+}

packages/utils/test/ReactiveValue.test.ts

@@ -1,6 +1,6 @@
-import { ReactiveValue } from '../src/ReactiveValue';
 import { fake } from 'sinon';
 import { expect } from 'chai';
+import { ReactiveValue } from '../src/ReactiveValue';
 describe('utils', () => {
     describe('ReactiveValue', () => {
         it('should set/get a value and fire', () => {