Remove lodash get

UNRELEASED.md

@@ -48,5 +48,6 @@ Use [the changelog guidelines](https://git.io/polaris-changelog-guidelines) to f
 - Update `create-react-app` example dependencies ([#1010](https://github.com/Shopify/polaris-react/pull/1010))
 - Replace all occurrences of `_.capitalize` with a custom `capitalize` function ([#1015](https://github.com/Shopify/polaris-react/pull/1015))
 - Replace all occurrences of `_.isObject` with a custom `isObject` function ([#1011](https://github.com/Shopify/polaris-react/pull/1011))
+- Replace all occurrences of `_.get` with a custom `get` function ([#1013](https://github.com/Shopify/polaris-react/pull/1013))
 
 ### Deprecations

src/components/AppProvider/utilities/Intl/Intl.ts

@@ -1,6 +1,6 @@
 import merge from 'lodash/merge';
-import get from 'lodash/get';
 import {autobind} from '@shopify/javascript-utilities/decorators';
+import {get} from '../../../../utilities/get';
 import defaultTranslation from '../../../../locales';
 import {
   TranslationDictionary,

src/components/AppProvider/utilities/Intl/translate.ts

@@ -1,4 +1,4 @@
-import get from 'lodash/get';
+import {get} from '../../../../utilities/get';
 import {
   TranslationDictionary,
   PrimitiveReplacementDictionary,

src/test-utilities/enzyme.tsx

@@ -8,8 +8,8 @@ import {
   ShallowRendererProps,
 } from 'enzyme';
 import * as React from 'react';
-import get from 'lodash/get';
 import merge from 'lodash/merge';
+import {get} from '../utilities/get';
 import {PolarisContext} from '../components/types';
 
 // eslint-disable-next-line shopify/strict-component-boundaries

src/types.ts

@@ -252,3 +252,7 @@ export enum TypeOf {
   Symbol = 'symbol',
   Function = 'function',
 }
+
+export interface GeneralObject {
+  [key: string]: any;
+}

src/utilities/get.ts

@@ -0,0 +1,32 @@
+import {GeneralObject} from '../types';
+
+const OBJECT_NOTATION_MATCHER = /\[(.*?)\]|(\w+)/g;
+
+export function get<T>(
+  obj: GeneralObject | undefined,
+  keypath: string | string[],
+  defaultValue?: T,
+): T | any {
+  if (obj == null) return undefined;
+
+  const keys = Array.isArray(keypath) ? keypath : getKeypath(keypath);
+  let acc = obj;
+  for (let i = 0; i < keys.length; i++) {
+    const val = acc[keys[i]];
+    if (val === undefined) return defaultValue;
+    acc = val;
+  }
+
+  return acc;
+}
+
+function getKeypath(str: string) {
+  const path = [];
+  let result: RegExpExecArray | null;
+  while ((result = OBJECT_NOTATION_MATCHER.exec(str))) {
+    const [, first, second] = result;
+    path.push(first || second);
+  }
+
+  return path;
+}

src/utilities/tests/get.test.ts

@@ -0,0 +1,37 @@
+import {get} from '../get';
+
+describe('get', () => {
+  it('returns undefined when the path does not exist', () => {
+    expect(get({}, 'a')).toBeUndefined();
+  });
+
+  it('returns a value for a single keypath', () => {
+    expect(get({hello: 'polaris'}, 'hello')).toBe('polaris');
+  });
+
+  it('returns the value for a complex keypath', () => {
+    expect(get({keyA: {keyB: {keyC: 'polaris'}}}, 'keyA.keyB.keyC')).toBe(
+      'polaris',
+    );
+  });
+
+  it('returns undefined when the object is not provided', () => {
+    expect(get(undefined, 'keyA.keyB.keyC')).toBeUndefined();
+  });
+
+  it('accepts a array of keys for keypath', () => {
+    expect(
+      get({keyA: [{keyB: {keyC: 3}}]}, ['keyA', '0', 'keyB', 'keyC']),
+    ).toBe(3);
+  });
+
+  it('accepts string keypath with square bracket notation', () => {
+    expect(get({keyA: [{keyB: {keyC: 3}}]}, 'keyA[0].keyB.keyC')).toBe(3);
+  });
+
+  it('returns the default value for undefined results', () => {
+    expect(
+      get({keyA: [{keyB: {keyC: 3}}]}, ['keyA', '0', 'keyB', 'keyC', 'not']),
+    ).toBeUndefined();
+  });
+});