Idiomatic js length for collections (#180)

* Idiomatic js length for collections * add private to the noop setter
near · Aug 22, 2022 · f30c813 · f30c813
1 parent 663354e
commit f30c813
Show file tree

Hide file tree

Showing 13 changed files with 47 additions and 51 deletions.
diff --git a/README.md b/README.md
@@ -218,8 +218,8 @@ someMethod() {
     this.v.pop()
 
     // len, isEmpty
-    let len = this.v.len()
-    let isEmpty = this.v.isEnpty()
+    let len = this.v.length
+    let isEmpty = this.v.isEmpty()
 
     // iterate
     for (let element of this.v) {
@@ -346,8 +346,8 @@ someMethod() {
     this.m.set('ghi', 'ddd')
 
     // len, isEmpty
-    let len = this.m.len()
-    let isEmpty = this.m.isEnpty()
+    let len = this.m.length
+    let isEmpty = this.m.isEmpty()
 
     // iterate
     for (let [k, v] of this.m) {
@@ -396,8 +396,8 @@ someMethod() {
     this.s.remove('def')
 
     // len, isEmpty
-    let len = this.s.len()
-    let isEmpty = this.s.isEnpty()
+    let len = this.s.length
+    let isEmpty = this.s.isEmpty()
 
     // iterate
     for (let e of this.s) {

diff --git a/lib/collections/unordered-map.d.ts b/lib/collections/unordered-map.d.ts
@@ -1,13 +1,13 @@
 import { Bytes } from "../utils";
 import { Vector } from "./vector";
 export declare class UnorderedMap {
-    readonly length: number;
     readonly prefix: Bytes;
     readonly keyIndexPrefix: Bytes;
     readonly keys: Vector;
     readonly values: Vector;
     constructor(prefix: Bytes);
-    len(): number;
+    get length(): number;
+    private set length(value);
     isEmpty(): boolean;
     get(key: Bytes): unknown | null;
     set(key: Bytes, value: unknown): unknown | null;

diff --git a/lib/collections/unordered-map.js b/lib/collections/unordered-map.js
@@ -19,22 +19,23 @@ function getIndexRaw(keyIndexPrefix, key) {
 }
 export class UnorderedMap {
     constructor(prefix) {
-        this.length = 0;
         this.prefix = prefix;
         this.keyIndexPrefix = prefix + "i";
         let indexKey = prefix + "k";
         let indexValue = prefix + "v";
         this.keys = new Vector(indexKey);
         this.values = new Vector(indexValue);
     }
-    len() {
-        let keysLen = this.keys.len();
-        let valuesLen = this.values.len();
+    get length() {
+        let keysLen = this.keys.length;
+        let valuesLen = this.values.length;
         if (keysLen != valuesLen) {
             throw new Error(ERR_INCONSISTENT_STATE);
         }
         return keysLen;
     }
+    // noop, called by deserialize
+    set length(_l) { }
     isEmpty() {
         let keysIsEmpty = this.keys.isEmpty();
         let valuesIsEmpty = this.values.isEmpty();
@@ -65,7 +66,7 @@ export class UnorderedMap {
             return this.values.replace(index, value);
         }
         else {
-            let nextIndex = this.len();
+            let nextIndex = this.length;
             let nextIndexRaw = serializeIndex(nextIndex);
             near.storageWrite(indexLookup, nextIndexRaw);
             this.keys.push(key);
@@ -77,15 +78,15 @@ export class UnorderedMap {
         let indexLookup = this.keyIndexPrefix + JSON.stringify(key);
         let indexRaw = near.storageRead(indexLookup);
         if (indexRaw) {
-            if (this.len() == 1) {
+            if (this.length == 1) {
                 // If there is only one element then swap remove simply removes it without
                 // swapping with the last element.
                 near.storageRemove(indexLookup);
             }
             else {
                 // If there is more than one element then swap remove swaps it with the last
                 // element.
-                let lastKey = this.keys.get(this.len() - 1);
+                let lastKey = this.keys.get(this.length - 1);
                 if (!lastKey) {
                     throw new Error(ERR_INCONSISTENT_STATE);
                 }

diff --git a/lib/collections/unordered-set.d.ts b/lib/collections/unordered-set.d.ts
@@ -1,12 +1,12 @@
 import { Bytes } from "../utils";
 import { Vector } from "./vector";
 export declare class UnorderedSet {
-    readonly length: number;
     readonly prefix: Bytes;
     readonly elementIndexPrefix: Bytes;
     readonly elements: Vector;
     constructor(prefix: Bytes);
-    len(): number;
+    get length(): number;
+    private set length(value);
     isEmpty(): boolean;
     contains(element: unknown): boolean;
     set(element: unknown): boolean;

diff --git a/lib/collections/unordered-set.js b/lib/collections/unordered-set.js
@@ -14,15 +14,16 @@ function deserializeIndex(rawIndex) {
 }
 export class UnorderedSet {
     constructor(prefix) {
-        this.length = 0;
         this.prefix = prefix;
         this.elementIndexPrefix = prefix + "i";
         let elementsPrefix = prefix + "e";
         this.elements = new Vector(elementsPrefix);
     }
-    len() {
-        return this.elements.len();
+    get length() {
+        return this.elements.length;
     }
+    // noop, called by deserialize
+    set length(_l) { }
     isEmpty() {
         return this.elements.isEmpty();
     }
@@ -36,7 +37,7 @@ export class UnorderedSet {
             return false;
         }
         else {
-            let nextIndex = this.len();
+            let nextIndex = this.length;
             let nextIndexRaw = serializeIndex(nextIndex);
             near.storageWrite(indexLookup, nextIndexRaw);
             this.elements.push(element);
@@ -47,15 +48,15 @@ export class UnorderedSet {
         let indexLookup = this.elementIndexPrefix + JSON.stringify(element);
         let indexRaw = near.storageRead(indexLookup);
         if (indexRaw) {
-            if (this.len() == 1) {
+            if (this.length == 1) {
                 // If there is only one element then swap remove simply removes it without
                 // swapping with the last element.
                 near.storageRemove(indexLookup);
             }
             else {
                 // If there is more than one element then swap remove swaps it with the last
                 // element.
-                let lastElement = this.elements.get(this.len() - 1);
+                let lastElement = this.elements.get(this.length - 1);
                 if (!lastElement) {
                     throw new Error(ERR_INCONSISTENT_STATE);
                 }

diff --git a/lib/collections/vector.d.ts b/lib/collections/vector.d.ts
@@ -3,7 +3,6 @@ export declare class Vector {
     length: number;
     readonly prefix: Bytes;
     constructor(prefix: Bytes);
-    len(): number;
     isEmpty(): boolean;
     get(index: number): unknown | null;
     swapRemove(index: number): unknown | null;

diff --git a/lib/collections/vector.js b/lib/collections/vector.js
@@ -15,9 +15,6 @@ export class Vector {
         this.length = 0;
         this.prefix = prefix;
     }
-    len() {
-        return this.length;
-    }
     isEmpty() {
         return this.length == 0;
     }
@@ -122,7 +119,7 @@ export class VectorIterator {
         this.vector = vector;
     }
     next() {
-        if (this.current < this.vector.len()) {
+        if (this.current < this.vector.length) {
             let value = this.vector.get(this.current);
             this.current += 1;
             return { value, done: false };

diff --git a/src/collections/unordered-map.ts b/src/collections/unordered-map.ts
@@ -24,14 +24,12 @@ function getIndexRaw(keyIndexPrefix: Bytes, key: Bytes): Bytes {
 }
 
 export class UnorderedMap {
-  readonly length: number;
   readonly prefix: Bytes;
   readonly keyIndexPrefix: Bytes;
   readonly keys: Vector;
   readonly values: Vector;
 
   constructor(prefix: Bytes) {
-    this.length = 0;
     this.prefix = prefix;
     this.keyIndexPrefix = prefix + "i";
     let indexKey = prefix + "k";
@@ -40,15 +38,18 @@ export class UnorderedMap {
     this.values = new Vector(indexValue);
   }
 
-  len() {
-    let keysLen = this.keys.len();
-    let valuesLen = this.values.len();
+  get length() {
+    let keysLen = this.keys.length;
+    let valuesLen = this.values.length;
     if (keysLen != valuesLen) {
       throw new Error(ERR_INCONSISTENT_STATE);
     }
     return keysLen;
   }
 
+  // noop, called by deserialize
+  private set length(_l: number) {}
+
   isEmpty(): boolean {
     let keysIsEmpty = this.keys.isEmpty();
     let valuesIsEmpty = this.values.isEmpty();
@@ -79,7 +80,7 @@ export class UnorderedMap {
       let index = deserializeIndex(indexRaw);
       return this.values.replace(index, value);
     } else {
-      let nextIndex = this.len();
+      let nextIndex = this.length;
       let nextIndexRaw = serializeIndex(nextIndex);
       near.storageWrite(indexLookup, nextIndexRaw);
       this.keys.push(key);
@@ -92,14 +93,14 @@ export class UnorderedMap {
     let indexLookup = this.keyIndexPrefix + JSON.stringify(key);
     let indexRaw = near.storageRead(indexLookup);
     if (indexRaw) {
-      if (this.len() == 1) {
+      if (this.length == 1) {
         // If there is only one element then swap remove simply removes it without
         // swapping with the last element.
         near.storageRemove(indexLookup);
       } else {
         // If there is more than one element then swap remove swaps it with the last
         // element.
-        let lastKey = this.keys.get(this.len() - 1);
+        let lastKey = this.keys.get(this.length - 1);
         if (!lastKey) {
           throw new Error(ERR_INCONSISTENT_STATE);
         }

diff --git a/src/collections/unordered-set.ts b/src/collections/unordered-set.ts
@@ -19,23 +19,24 @@ function deserializeIndex(rawIndex: Bytes): number {
 }
 
 export class UnorderedSet {
-  readonly length: number;
   readonly prefix: Bytes;
   readonly elementIndexPrefix: Bytes;
   readonly elements: Vector;
 
   constructor(prefix: Bytes) {
-    this.length = 0;
     this.prefix = prefix;
     this.elementIndexPrefix = prefix + "i";
     let elementsPrefix = prefix + "e";
     this.elements = new Vector(elementsPrefix);
   }
 
-  len(): number {
-    return this.elements.len();
+  get length(): number {
+    return this.elements.length;
   }
 
+  // noop, called by deserialize
+  private set length(_l: number) {}
+
   isEmpty(): boolean {
     return this.elements.isEmpty();
   }
@@ -50,7 +51,7 @@ export class UnorderedSet {
     if (near.storageRead(indexLookup)) {
       return false;
     } else {
-      let nextIndex = this.len();
+      let nextIndex = this.length;
       let nextIndexRaw = serializeIndex(nextIndex);
       near.storageWrite(indexLookup, nextIndexRaw);
       this.elements.push(element);
@@ -62,14 +63,14 @@ export class UnorderedSet {
     let indexLookup = this.elementIndexPrefix + JSON.stringify(element);
     let indexRaw = near.storageRead(indexLookup);
     if (indexRaw) {
-      if (this.len() == 1) {
+      if (this.length == 1) {
         // If there is only one element then swap remove simply removes it without
         // swapping with the last element.
         near.storageRemove(indexLookup);
       } else {
         // If there is more than one element then swap remove swaps it with the last
         // element.
-        let lastElement = this.elements.get(this.len() - 1);
+        let lastElement = this.elements.get(this.length - 1);
         if (!lastElement) {
           throw new Error(ERR_INCONSISTENT_STATE);
         }

diff --git a/src/collections/vector.ts b/src/collections/vector.ts
@@ -23,10 +23,6 @@ export class Vector {
     this.prefix = prefix;
   }
 
-  len(): number {
-    return this.length;
-  }
-
   isEmpty(): boolean {
     return this.length == 0;
   }
@@ -139,7 +135,7 @@ export class VectorIterator {
   }
 
   next(): { value: unknown | null; done: boolean } {
-    if (this.current < this.vector.len()) {
+    if (this.current < this.vector.length) {
       let value = this.vector.get(this.current);
       this.current += 1;
       return { value, done: false };

diff --git a/tests/src/unordered-map.js b/tests/src/unordered-map.js
@@ -21,7 +21,7 @@ class UnorderedMapTestContract extends NearContract {
 
     @view
     len() {
-        return this.unorderedMap.len();
+        return this.unorderedMap.length;
     }
 
     @view

diff --git a/tests/src/unordered-set.js b/tests/src/unordered-set.js
@@ -20,7 +20,7 @@ class UnorderedSetTestContract extends NearContract {
 
     @view
     len() {
-        return this.unorderedSet.len();
+        return this.unorderedSet.length;
     }
 
     @view

diff --git a/tests/src/vector.js b/tests/src/vector.js
@@ -20,7 +20,7 @@ class VectorTestContract extends NearContract {
 
     @view
     len() {
-        return this.vector.len();
+        return this.vector.length;
     }
 
     @view
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,7 +21,7 @@ class UnorderedMapTestContract extends NearContract { @@
         @view
         len() {
-            return this.unorderedMap.len();
+            return this.unorderedMap.length;
         }
         @view
@@ Expand Down @@