change structure of the AttributeModel

Author: MacondoExpress

packages/graphql/src/schema-model/attribute/Attribute.ts

@@ -117,15 +117,17 @@ export class Attribute {
     public readonly name: string;
     public readonly annotations: Partial<Annotations> = {};
     public readonly type: AttributeType;
-    public isCypherField = false;
     private _attributeModel: AttributeModel | undefined;
 
-    constructor({ name, annotations, type }: { name: string; annotations: Annotation[]; type: AttributeType }) {
+    constructor({ name, annotations = {}, type }: { name: string; annotations: Annotation[] | Partial<Annotations>; type: AttributeType }) {
         this.name = name;
         this.type = type;
-
-        for (const annotation of annotations) {
-            this.addAnnotation(annotation);
+        if (annotations instanceof Array) {
+            for (const annotation of annotations) {
+                this.addAnnotation(annotation);
+            }
+        } else {
+            this.annotations = annotations;
         }
     }
 
@@ -143,15 +145,13 @@ export class Attribute {
             throw new Neo4jGraphQLSchemaValidationError(`Annotation ${annotationKey} already exists in ${this.name}`);
         }
 
-        if (annotationKey === AnnotationsKey.cypher) {
-            this.isCypherField = true;
-        }
         // We cast to any because we aren't narrowing the Annotation type here.
         // There's no reason to narrow either, since we care more about performance.
         this.annotations[annotationKey] = annotation as any;
     }
 
-    get attributeModel(): AttributeModel {
+    get attributeModel(): AttributeModel { 
+        // factory method, this started with the assumption that Attribute is immutable.
         if (!this._attributeModel) {
             this._attributeModel = new AttributeModel(this);
         }
@@ -217,10 +217,9 @@ type MutableField =
     | PointField
     | CypherField;
 
-class AttributeModel {
-    readonly attribute: Attribute;
+class AttributeModel extends Attribute {
     constructor(attribute: Attribute) {
-        this.attribute = attribute;
+        super({name: attribute.name, annotations: attribute.annotations, type: attribute.type});
     }
 
     isMutable(): boolean {
@@ -250,65 +249,6 @@ class AttributeModel {
         return new MathModel(this);
     }
 
-    /**
-     * The following are just proxy methods to the attribute methods for convenience.
-     * the idea is to improve the ergonomic for the client for case when they want to access information about the Attribute model,
-     * and they are forced to switch between the attribute and the attribute model.
-     *
-     **/
-    /**
-     * START OF PROXY METHODS
-     **/
-    isCustomScalar(): boolean {
-        return this.attribute.isCustomScalar();
-    }
-
-    isInt(): boolean {
-        return this.attribute.isInt();
-    }
-
-    isBigInt(): boolean {
-        return this.attribute.isBigInt();
-    }
-
-    isFloat(): boolean {
-        return this.attribute.isFloat();
-    }
-
-    isList(): boolean {
-        return this.attribute.isList();
-    }
-
-    isRequired(): boolean {
-        return this.attribute.isRequired();
-    }
-
-    isScalar(): boolean {
-        return this.attribute.isScalar();
-    }
-
-    isGraphQLBuiltInScalar(): boolean {
-        return this.attribute.isGraphQLBuiltInScalar();
-    }
-
-    isSpatial(): boolean {
-        return this.attribute.isSpatial();
-    }
-
-    isTemporal(): boolean {
-        return this.attribute.isSpatial();
-    }
-
-    isObject(): boolean {
-        return this.attribute.isObject();
-    }
-
-    isEnum(): boolean {
-        return this.attribute.isEnum();
-    }
-    /**
-     * END OF PROXY METHODS
-     **/
 }
 
 class MathModel {
@@ -325,9 +265,9 @@ class MathModel {
     }
 
     getAdd(): string {
-        return this.attributeModel.attribute.isInt() || this.attributeModel.attribute.isBigInt()
-            ? `${this.attributeModel.attribute.name}_ADD`
-            : `${this.attributeModel.attribute.name}_INCREMENT`;
+        return this.attributeModel.isInt() || this.attributeModel.isBigInt()
+            ? `${this.attributeModel.name}_ADD`
+            : `${this.attributeModel.name}_INCREMENT`;
     }
 }
 
@@ -346,19 +286,22 @@ class AggregationModel {
 
     getAverageMethods(): string[] {
         return AGGREGATION_COMPARISON_OPERATORS.map(
-            (operator) => `${this.attributeModel.attribute.name}_AVERAGE_${operator}`
+            (operator) => `${this.attributeModel.name}_AVERAGE_${operator}`
         );
     }
-    isAggregate(string): boolean {
-        
+    /**
+     *  Returns true if the given string is an aggregate method, for instance name_AVERAGE_GT returns true but name or name_GT do not
+     **/
+    isAggregate(fieldName: string): boolean {
+        throw new Error("Not implemented");
     } 
 }
 
 class ListModel {
     readonly attributeModel: AttributeModel;
 
     constructor(attributeModel: AttributeModel) {
-        if (!attributeModel.attribute.isList()) {
+        if (!attributeModel.isList()) {
             throw new Error("Attribute is not a list");
         }
         this.attributeModel = attributeModel;
@@ -369,10 +312,17 @@ class ListModel {
     }
 
     getPush(): string {
-        return `${this.attributeModel.attribute.name}_PUSH`;
+        return `${this.attributeModel.name}_PUSH`;
     }
 
     getPop(): string {
-        return `${this.attributeModel.attribute.name}_POP`;
+        return `${this.attributeModel.name}_POP`;
     }
+
+    /**
+     *  Returns true if the given string is an list method, for instance names_PUSH returns true but name or name_GT do not
+     **/
+    isArrayMethod(fieldName: string): boolean {
+        throw new Error("Not implemented");
+    } 
 }