feat: add mock for places service (#390)

Author: BiniCodes

src/index.ts

@@ -17,6 +17,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 import { LatLng, LatLngBounds } from "./maps/coordinates/latlng";
+import { PlacesService } from "./places/places-service/places-service";
 import { DirectionsService } from "./routes/directions-service/directions-service";
 import { Geocoder } from "./places/geocoder/geocoder";
 import { Autocomplete } from "./places/autocomplete";
@@ -80,6 +81,7 @@ const initialize = function (): void {
       places: {
         Autocomplete: Autocomplete,
         SearchBox: SearchBox,
+        PlacesService,
         AutocompleteService,
       },
       Geocoder,
@@ -101,6 +103,7 @@ const initialize = function (): void {
 
 export {
   Autocomplete,
+  PlacesService,
   AutocompleteService,
   Geocoder,
   Circle,

src/places/places-service/places-service.test.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 { PlacesService, initialize, mockInstances } from "../../index";
+
+beforeEach(() => {
+  initialize();
+});
+
+test("register mocks", () => {
+  const placesService = new google.maps.places.PlacesService(null);
+
+  expect(placesService).toBeTruthy();
+});
+
+test("places service is mocked", () => {
+  const placesService = new google.maps.places.PlacesService(null);
+
+  const callback = jest.fn();
+
+  placesService.findPlaceFromPhoneNumber(null, callback);
+  placesService.findPlaceFromQuery(null, callback);
+  placesService.getDetails(null, callback);
+  placesService.nearbySearch(null, callback);
+  placesService.textSearch(null, callback);
+
+  const mocks = mockInstances.get(PlacesService);
+
+  expect(mocks).toHaveLength(1);
+
+  expect(
+    mockInstances.get(PlacesService)[0].findPlaceFromPhoneNumber
+  ).toHaveBeenCalledWith(null, callback);
+
+  expect(
+    mockInstances.get(PlacesService)[0].findPlaceFromQuery
+  ).toHaveBeenCalledWith(null, callback);
+
+  expect(mockInstances.get(PlacesService)[0].getDetails).toHaveBeenCalledWith(
+    null,
+    callback
+  );
+
+  expect(mockInstances.get(PlacesService)[0].nearbySearch).toHaveBeenCalledWith(
+    null,
+    callback
+  );
+
+  expect(mockInstances.get(PlacesService)[0].textSearch).toHaveBeenCalledWith(
+    null,
+    callback
+  );
+});

src/places/places-service/places-service.ts

@@ -0,0 +1,83 @@
+/**
+ * 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.
+ */
+
+/* eslint-disable @typescript-eslint/no-empty-function */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+import { __registerMockInstance } from "../../registry";
+
+export class PlacesService implements google.maps.places.PlacesService {
+  public findPlaceFromPhoneNumber = jest.fn().mockImplementation(
+    (
+      request: google.maps.places.FindPlaceFromPhoneNumberRequest,
+      callback: (
+        placesResult?: Array<google.maps.places.PlaceResult>,
+        // @ts-expect-error
+        placeServiceStatus: google.maps.places.PlacesServiceStatus
+      ) => void
+    ): void => {}
+  );
+
+  public findPlaceFromQuery = jest.fn().mockImplementation(
+    (
+      request: google.maps.places.FindPlaceFromQueryRequest,
+      callback: (
+        placeResult?: Array<google.maps.places.PlaceResult>,
+        // @ts-expect-error
+        placeServiceStatus: google.maps.places.PlacesServiceStatus
+      ) => void
+    ): void => {}
+  );
+
+  public getDetails = jest.fn().mockImplementation(
+    (
+      request: google.maps.places.PlaceDetailsRequest,
+      callback: (
+        placeResult?: Array<google.maps.places.PlaceResult>,
+        // @ts-expect-error
+        placeServiceStatus: google.maps.places.PlacesServiceStatus
+      ) => void
+    ): void => {}
+  );
+
+  public nearbySearch = jest.fn().mockImplementation(
+    (
+      request: google.maps.places.PlaceSearchRequest,
+      callback: (
+        placeResult?: Array<google.maps.places.PlaceResult>,
+        // @ts-expect-error
+        placesServiceStatus: google.maps.places.PlacesServiceStatus,
+        pagination?: google.maps.places.PlaceSearchPagination
+      ) => void
+    ): void => {}
+  );
+
+  public textSearch = jest.fn().mockImplementation(
+    (
+      request: google.maps.places.TextSearchRequest,
+      callback: (
+        placeResult?: Array<google.maps.places.PlaceResult>,
+        // @ts-expect-error
+        placesServiceStatus: google.maps.places.PlacesServiceStatus,
+        pagination?: google.maps.places.PlaceSearchPagination
+      ) => void
+    ): void => {}
+  );
+
+  constructor(attrContainer: HTMLDivElement | null) {
+    __registerMockInstance(this.constructor, this);
+  }
+}