Rename Collection.getById to `getByIdentity'

ivandotv · Jul 1, 2022 · 464fa7d · 464fa7d
1 parent aeaa369
commit 464fa7d
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 17 deletions.
diff --git a/.changeset/ten-lions-enjoy.md b/.changeset/ten-lions-enjoy.md
@@ -0,0 +1,5 @@
+---
+'@fuerte/core': major
+---
+
+Rename `Collection.getById` to `getByIdentity'
diff --git a/packages/core/src/__tests__/collection-add.test.ts b/packages/core/src/__tests__/collection-add.test.ts
@@ -180,7 +180,7 @@ describe('Collection - add #add #collection', () => {
     const model = fixtures.model({ foo: 'foo', bar: 'bar', id: '1' })
 
     collection.add(model)
-    const found = collection.getById(model.identity)
+    const found = collection.getByIdentity(model.identity)
 
     expect(found).toBe(model)
   })
@@ -233,11 +233,11 @@ describe('Collection - add #add #collection', () => {
       const model = new Test()
       collection.add(model)
 
-      expect(collection.getById(newIdentity)).toBeUndefined()
+      expect(collection.getByIdentity(newIdentity)).toBeUndefined()
 
       model.setIdentity(newIdentity)
 
-      expect(collection.getById(newIdentity)).toBe(model)
+      expect(collection.getByIdentity(newIdentity)).toBe(model)
     })
 
     test('When model identity changes, get the model by new identity value', () => {
@@ -258,10 +258,10 @@ describe('Collection - add #add #collection', () => {
       const model = new Test('1')
       collection.add(model)
 
-      expect(collection.getById(model.identity)).toBe(model)
+      expect(collection.getByIdentity(model.identity)).toBe(model)
 
       model.setIdentity(newIdentityValue)
-      expect(collection.getById(newIdentityValue)).toBe(model)
+      expect(collection.getByIdentity(newIdentityValue)).toBe(model)
     })
   })
 })
diff --git a/packages/core/src/__tests__/collection-reset.test.ts b/packages/core/src/__tests__/collection-reset.test.ts
@@ -61,8 +61,8 @@ describe('Collection - reset #reset #collection', () => {
     await collection.reset(fixtures.rawModelData)
 
     expect(collection.models).toHaveLength(fixtures.rawModelData.length)
-    expect(collection.getById(models[0].cid)).toBeUndefined()
-    expect(collection.getById(models[1].cid)).toBeUndefined()
+    expect(collection.getByIdentity(models[0].cid)).toBeUndefined()
+    expect(collection.getByIdentity(models[1].cid)).toBeUndefined()
   })
 
   test('Reset the collection without adding new models', async () => {

diff --git a/packages/core/src/__tests__/collection-save.test.ts b/packages/core/src/__tests__/collection-save.test.ts
@@ -227,7 +227,6 @@ describe('Collection - save #save #collection', () => {
       const modelSaveErrorSpy = jest.spyOn(model, 'onSaveError')
       jest.spyOn(transport, 'save').mockRejectedValue(response)
 
-      // @ts-expect-error collection config
       const result = await collection.save(model, config, transportConfig)
 
       expect(collectionSaveErrorSpy).toHaveBeenCalledWith({

diff --git a/packages/core/src/__tests__/collection.test.ts b/packages/core/src/__tests__/collection.test.ts
@@ -126,7 +126,7 @@ describe('Collection #collection', () => {
 
       collection.add(model)
 
-      const result = collection.getById(id)
+      const result = collection.getByIdentity(id)
 
       expect(result).toBe(model)
     })
@@ -140,7 +140,7 @@ describe('Collection #collection', () => {
 
       collection.add([model, modelTwo])
 
-      const result = collection.getById([id, idTwo])
+      const result = collection.getByIdentity([id, idTwo])
 
       expect(result).toStrictEqual([model, modelTwo])
     })
@@ -149,7 +149,7 @@ describe('Collection #collection', () => {
       const collection = fixtures.collection()
       const id = 'new-id'
 
-      const result = collection.getById(id)
+      const result = collection.getByIdentity(id)
 
       expect(result).toBeUndefined()
     })
@@ -159,7 +159,7 @@ describe('Collection #collection', () => {
       const id = 'new-id'
       const idTwo = 'new-id-2'
 
-      const result = collection.getById([id, idTwo])
+      const result = collection.getByIdentity([id, idTwo])
 
       expect(result).toStrictEqual([])
     })

diff --git a/packages/core/src/__tests__/model-removed.test.ts b/packages/core/src/__tests__/model-removed.test.ts
@@ -15,7 +15,7 @@ describe('Model - remove #remove #model', () => {
 
       collection.remove(model.identity)
 
-      expect(collection.getById(model.identity)).toBeUndefined()
+      expect(collection.getByIdentity(model.identity)).toBeUndefined()
     })
 
     test('Destroy method is called by default', () => {

diff --git a/packages/core/src/__tests__/model.test.ts b/packages/core/src/__tests__/model.test.ts
@@ -50,7 +50,7 @@ describe('Model #model', () => {
 
     expect(transportSaveSpy).toHaveBeenCalledTimes(1)
     expect(transportSaveSpy).toHaveBeenCalledWith(model, transportConfg)
-    expect(collection.getById(model.identity)).toBe(model)
+    expect(collection.getByIdentity(model.identity)).toBe(model)
   })
 
   test('calling model.save will throw if the model is not a part of the collection', async () => {

diff --git a/packages/core/src/collection/Collection.ts b/packages/core/src/collection/Collection.ts
@@ -871,15 +871,15 @@ export class Collection<
     return result as ReturnType<TFactory>
   }
 
-  getById(id: string): TModel | undefined
+  getByIdentity(id: string): TModel | undefined
 
-  getById(id: string[]): TModel[] | undefined
+  getByIdentity(id: string[]): TModel[] | undefined
 
   /**
    * Get model or array of models from the collection by identity key, or model CID.
    * @param id - identity key or CID
    */
-  getById(id: string | string[]): TModel | TModel[] | undefined {
+  getByIdentity(id: string | string[]): TModel | TModel[] | undefined {
     if (Array.isArray(id)) {
       return this.resolveModels(id)
     }