feat: implement mocks registry (#194)

eegli · web-flow · commit 40db691ff74b · 2022-02-10T08:42:38.000-07:00
diff --git a/README.md b/README.md
@@ -19,18 +19,56 @@ Jest mocks for Google Maps in TypeScript.
 
 Available via NPM as the package `@googlemaps/jest-mocks`
 
-## Example
+## Inspecting mocks
 
-```typescript
-import { initialize, Map } from "@googlemaps/jest-mocks";
+You can inspect what happens with the created mock instances (e.g. `Map` or `Marker`) via the `mockInstances` object.
+
+```ts
+import { initialize, Map, Marker, mockInstances } from "@googlemaps/jest-mocks";
 
 beforeEach(() => {
   initialize();
 });
 
-// access the object instances if the object isn't easily accessible
 test("my test", () => {
-  expect(Map.mockInstances[0].fitBounds).toHaveBeenCalled();
+  const map = new google.maps.Map(null);
+  const markerOne = new google.maps.Marker();
+  const markerTwo = new google.maps.Marker();
+
+  map.setHeading(8);
+  markerOne.setMap(map);
+  markerTwo.setLabel("My marker");
+
+  const mapMocks = mockInstances.get(Map);
+  const markerMocks = mockInstances.get(Marker);
+
+  expect(mapMocks).toHaveLength(1);
+  expect(markerMocks).toHaveLength(2);
+  expect(mapMocks[0].setHeading).toHaveBeenCalledWith(8);
+  expect(markerMocks[0].setMap).toHaveBeenCalledTimes(1);
+  expect(markerMocks[1].setLabel).toHaveBeenCalledWith("My marker");
+});
+```
+
+## Cleaning up mocks
+
+Whenever `initialize()` is called, the captured mocks are automatically cleaned. Using any of Jest's methods, you can clean the mock instances at any time:
+
+```ts
+import { initialize, Map, Marker, mockInstances } from "@googlemaps/jest-mocks";
+
+beforeAll(() => {
+  initialize();
+});
+
+// Clear all mocks
+beforeEach(() => {
+  mockInstances.clearAll();
+});
+
+// Clear specific mocks
+beforeEach(() => {
+  mockInstances.clear(Map, Marker);
 });
 ```
 
diff --git a/src/drawing/DOM/mapcanvasprojection.ts b/src/drawing/DOM/mapcanvasprojection.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/drawing/DOM/mappanes.ts b/src/drawing/DOM/mappanes.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/drawing/DOM/overlayview.ts b/src/drawing/DOM/overlayview.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/drawing/data/data.feature.test.ts b/src/drawing/data/data.feature.test.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/drawing/data/data.feature.ts b/src/drawing/data/data.feature.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/drawing/data/data.test.ts b/src/drawing/data/data.test.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/drawing/data/data.ts b/src/drawing/data/data.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/drawing/marker/marker.ts b/src/drawing/marker/marker.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/drawing/polygons/circle.test.ts b/src/drawing/polygons/circle.test.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/drawing/polygons/circle.ts b/src/drawing/polygons/circle.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/drawing/polygons/polyline.ts b/src/drawing/polygons/polyline.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/index.ts b/src/index.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -45,8 +45,10 @@ import { StreetViewService } from "./street-view/service/service";
 import { ControlPosition } from "./maps/controls/controlposition";
 import { MapTypeId } from "./maps/maps/constants";
 import { event } from "./maps/event/event";
+import { mockInstances } from "./registry";
 
 const initialize = function (): void {
+  mockInstances.clearAll();
   (global as any).google = {
     maps: {
       ImageMapType: jest.fn(),
@@ -103,5 +105,6 @@ export {
   StreetViewPanorama,
   StreetViewService,
   VisibleRegion,
+  mockInstances,
   initialize,
 };
diff --git a/src/maps/controls/controlposition.ts b/src/maps/controls/controlposition.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/maps/coordinates/latlng.ts b/src/maps/coordinates/latlng.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/maps/coordinates/point.ts b/src/maps/coordinates/point.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/maps/coordinates/size.ts b/src/maps/coordinates/size.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/maps/event/event.ts b/src/maps/event/event.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2022 Google LLC. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 export const MapsEventListener: google.maps.MapsEventListener = {
   remove: jest.fn(),
 };
diff --git a/src/maps/event/mvcarray.ts b/src/maps/event/mvcarray.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/maps/event/mvcobject.test.ts b/src/maps/event/mvcobject.test.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2022 Google LLC. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import { initialize } from "../../index";
 import { Map_ } from "../maps/map";
 import { MVCObject } from "./mvcobject";
diff --git a/src/maps/event/mvcobject.ts b/src/maps/event/mvcobject.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import { __registerMockInstance } from "../../registry";
 import { MapsEventListener } from "./event";
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -25,6 +26,8 @@ export class MVCObject implements google.maps.MVCObject {
   public constructor() {
     const ctor = this.constructor as typeof MVCObject;
 
+    __registerMockInstance(ctor, this);
+
     if (ctor.mockInstances === undefined) {
       ctor.mockInstances = [];
     }
diff --git a/src/maps/maps/constants.ts b/src/maps/maps/constants.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/maps/maps/map.test.ts b/src/maps/maps/map.test.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@
 import { initialize } from "../../index";
 import { ControlPosition } from "../controls/controlposition";
 import { Map_ } from "./map";
+import { mockInstances } from "../../registry";
 
 test("can initialize", () => {
   initialize();
@@ -35,3 +36,14 @@ test("mockInstances available", () => {
   const map = new google.maps.Map(null);
   expect(Map_.mockInstances).toMatchObject([map]);
 });
+
+test("registers mocks", () => {
+  initialize();
+  const map = new google.maps.Map(null);
+  expect(Map_.mockInstances).toMatchObject([map]);
+  map.fitBounds(null);
+  map.data.get(null);
+  expect(mockInstances.get(Map_)).toHaveLength(1);
+  expect(mockInstances.get(Map_)[0].fitBounds).toHaveBeenCalledWith(null);
+  expect(mockInstances.get(Map_)[0].data.get).toHaveBeenCalledWith(null);
+});
diff --git a/src/maps/maps/map.ts b/src/maps/maps/map.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/maps/maps/visibleregion.ts b/src/maps/maps/visibleregion.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/places/autocomplete.test.ts b/src/places/autocomplete.test.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/places/autocomplete.ts b/src/places/autocomplete.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/places/searchbox.test.ts b/src/places/searchbox.test.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/places/searchbox.ts b/src/places/searchbox.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Google LLC. All Rights Reserved.
+ * Copyright 2022 Google LLC. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/registry.test.ts b/src/registry.test.ts
@@ -0,0 +1,56 @@
+/**
+ * Copyright 2022 Google LLC. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { initialize, Marker } from ".";
+import { MVCObject, Map } from ".";
+import { mockInstances, MOCKS_REGISTRY } from "./registry";
+
+beforeEach(() => {
+  initialize();
+});
+
+test("mocks registry", () => {
+  expect(MOCKS_REGISTRY.size).toBe(0);
+  const mvc1 = new google.maps.MVCObject();
+  const mvc2 = new google.maps.MVCObject();
+  expect(MOCKS_REGISTRY.size).toBe(1);
+  expect(mockInstances.get(MVCObject)).toStrictEqual([mvc1, mvc2]);
+  const map = new google.maps.Map(null);
+  mockInstances.clear(MVCObject);
+  expect(mockInstances.get(MVCObject)).toStrictEqual([]);
+  expect(mockInstances.get(Map)).toStrictEqual([map]);
+  mockInstances.clearAll();
+  expect(MOCKS_REGISTRY.size).toBe(0);
+});
+
+test("readme example 1", () => {
+  const map = new google.maps.Map(null);
+  const markerOne = new google.maps.Marker();
+  const markerTwo = new google.maps.Marker();
+
+  map.setHeading(8);
+  markerOne.setMap(map);
+  markerTwo.setLabel("My marker");
+
+  const mapMocks = mockInstances.get(Map);
+  const markerMocks = mockInstances.get(Marker);
+
+  expect(mapMocks).toHaveLength(1);
+  expect(markerMocks).toHaveLength(2);
+  expect(mapMocks[0].setHeading).toHaveBeenCalledWith(8);
+  expect(markerMocks[0].setMap).toHaveBeenCalledTimes(1);
+  expect(markerMocks[1].setLabel).toHaveBeenCalledWith("My marker");
+});
diff --git a/src/registry.ts b/src/registry.ts
diff --git a/src/street-view/rendering/coverage.test.ts b/src/street-view/rendering/coverage.test.ts
diff --git a/src/street-view/rendering/coverage.ts b/src/street-view/rendering/coverage.ts
diff --git a/src/street-view/rendering/panorama.test.ts b/src/street-view/rendering/panorama.test.ts
diff --git a/src/street-view/rendering/panorama.ts b/src/street-view/rendering/panorama.ts
diff --git a/src/street-view/service/constants.test.ts b/src/street-view/service/constants.test.ts
diff --git a/src/street-view/service/constants.ts b/src/street-view/service/constants.ts
diff --git a/src/street-view/service/service.test.ts b/src/street-view/service/service.test.ts
diff --git a/src/street-view/service/service.ts b/src/street-view/service/service.ts

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/**`
`2`		`- * Copyright 2019 Google LLC. All Rights Reserved.`
	`2`	`+ * Copyright 2022 Google LLC. All Rights Reserved.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`