Merge pull request #2 from dutchenkoOleg/master

0.0.3-prealpha

Author: OlehDutchenko

README.md

@@ -7,6 +7,6 @@
 
 ## Coverage
 
-| Statements | Branches | Functions | Lines |
-| --- | --- | --- | --- |
-| ![Statements](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg) | ![Branches](https://img.shields.io/badge/Coverage-93.33%25-brightgreen.svg) | ![Functions](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg) | ![Lines](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg) |
+| Statements                                                                  | Branches                                                                    | Functions                                                                  | Lines                                                                  |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| ![Statements](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg) | ![Branches](https://img.shields.io/badge/Coverage-95.24%25-brightgreen.svg) | ![Functions](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg) | ![Lines](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg) |

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "plain-object-helpers",
-  "version": "0.0.1-prealpha",
+  "version": "0.0.3-prealpha",
   "description": "description",
   "main": "dist/index.js",
   "files": [

package.json

@@ -0,0 +1,91 @@
+// -----------------------------------------------------------------------------
+// Deps
+// -----------------------------------------------------------------------------
+
+import { getIn } from './get-in';
+
+// -----------------------------------------------------------------------------
+// Tests
+// -----------------------------------------------------------------------------
+
+const testCases: {
+	parameters: Parameters<typeof getIn>;
+	result: ReturnType<typeof getIn>;
+}[] = [
+	{
+		parameters: [{ key: 'value' }, 'key'],
+		result: 'value'
+	},
+	{
+		parameters: [{ key: 'value' }, 'ZZZ'],
+		result: undefined
+	},
+	{
+		parameters: [{ key: 'value' }, 'ZZZ', 'fallbackValue'],
+		result: 'fallbackValue'
+	},
+	{
+		parameters: [
+			{
+				key1: {
+					key2: {
+						key3: 'value'
+					}
+				}
+			},
+			'key1.key2.key3'
+		],
+		result: 'value'
+	},
+	{
+		parameters: [
+			{
+				key1: ['value0', 'value1', 'value2']
+			},
+			'key1[1]'
+		],
+		result: 'value1'
+	},
+	{
+		parameters: [
+			{
+				key1: ['value0', 'value1', 'value2']
+			},
+			'key1[10]',
+			'fallbackValue'
+		],
+		result: 'fallbackValue'
+	},
+	{
+		parameters: [
+			{
+				key1: [
+					{
+						x: 777
+					},
+					{
+						x: 888
+					},
+					{
+						x: 999
+					}
+				]
+			},
+			'key1[2].x'
+		],
+		result: 999
+	},
+	{
+		parameters: [['value0', 'value1', 'value2'], '[1]'],
+		result: 'value1'
+	}
+];
+
+describe('getIn tool', () => {
+	testCases.forEach(({ parameters, result }, i) => {
+		test(`test #${i + 1}: ${parameters.join(', ')}`, () => {
+			const value = getIn(...parameters);
+			expect(value).toStrictEqual(result);
+		});
+	});
+});

src/get-in.test.ts

@@ -0,0 +1,42 @@
+// -----------------------------------------------------------------------------
+// Deps
+// -----------------------------------------------------------------------------
+
+import { toPath } from './to-path';
+import { isPlainObject } from './is-plain-object';
+
+// -----------------------------------------------------------------------------
+// Helper
+// -----------------------------------------------------------------------------
+
+/**
+ * Convert string sample in to the path (array)
+ * Inspired by final-form's `getIn` helper
+ * {@link https://github.com/final-form/final-form/blob/master/src/structure/getIn.js}
+ * @param {*} sample
+ * @param {string} keyPath
+ * @param {*} fallback
+ */
+export function getIn<GReturnValue = any>(
+	sample: any | any[],
+	keyPath: string,
+	fallback?: GReturnValue
+): GReturnValue {
+	const path = toPath(keyPath);
+	const pathLength = path.length;
+
+	let current: any = sample;
+	for (let i = 0; i < pathLength; i++) {
+		const key: string = path[i];
+		const index = parseInt(key, 10);
+		if (isPlainObject(current) && current.hasOwnProperty(key)) {
+			current = current[key];
+		} else if (Array.isArray(current) && !Number.isNaN(index) && index > -1) {
+			current = current[index];
+		} else {
+			current = undefined;
+			break;
+		}
+	}
+	return current === undefined ? fallback : current;
+}

src/get-in.ts

@@ -2,7 +2,7 @@
 // Deps
 // -----------------------------------------------------------------------------
 
-import toPath from './to-path';
+import { toPath } from './to-path';
 
 // -----------------------------------------------------------------------------
 // Tests

src/to-path.test.ts

@@ -1,14 +1,22 @@
+// -----------------------------------------------------------------------------
+// Private
+// -----------------------------------------------------------------------------
+
 const cache: Record<string, string[]> = {};
 const regex = /(\[(?=\d+])|(?<=\[\d+)])|\.+/;
 
+// -----------------------------------------------------------------------------
+// Helper
+// -----------------------------------------------------------------------------
+
 /**
  * Convert string sample in to the path (array)
  * Inspired by final-form's `toPath` helper
  * {@link https://github.com/final-form/final-form/blob/master/src/structure/toPath.js}
  * @param {string|null} [sample]
  * @returns {string[]}
  */
-export default (sample?: string | null): string[] => {
+export const toPath = (sample?: string | null): string[] => {
 	if (typeof sample === 'string' && sample.length > 0 && sample !== 'hasOwnProperty') {
 		if (!cache.hasOwnProperty(sample)) {
 			cache[sample] = sample