feat(dot-notation): add pick, parse and parseKey methods

Author: themgoncalves

.circleci/config.yml

@@ -34,17 +34,6 @@ commands:
           name: Running unit tests on Node.js v<< parameters.node_version >> <<# parameters.coverage >>with coverage<</ parameters.coverage >>
           command: yarn test<<# parameters.coverage >>:coverage<</ parameters.coverage >>
 
-  e2e_tests:
-    description: "Run integration tests"
-    steps:
-      - run:
-          name: Installing Cypress binaries
-          command: npx cypress install
-
-      - run:
-          name: Running E2E integration tests
-          command: yarn cypress
-
 jobs:
   install:
     <<: *build-image
@@ -99,7 +88,6 @@ jobs:
       - install_package_dependencies
       - unit_test:
           node_version: 10
-      - e2e_tests
 
   test_node_12:
     docker:
@@ -111,7 +99,6 @@ jobs:
       - unit_test:
           node_version: 12
           coverage: true
-      - e2e_tests
 
   test_node_14:
     docker:
@@ -122,21 +109,6 @@ jobs:
       - install_package_dependencies
       - unit_test:
           node_version: 14
-      - e2e_tests
-
-  end_to_end_tests:
-    <<: *build-image
-    steps:
-      - checkout
-      - attach_workspace:
-          at: .
-      - e2e_tests
-      - store_artifacts:
-          path: cypress/videos
-      - store_artifacts:
-          path: cypress/screenshots
-      - store_test_results:
-          path: results
 
   build:
     <<: *build-image
@@ -160,6 +132,12 @@ jobs:
       - checkout
       - attach_workspace:
           at: .
+      - add_ssh_keys:
+          fingerprints:
+            - $GITHUB_FINGERPRINT
+      - run:
+          name: Set git upstream
+          command: git branch --set-upstream-to origin/${CIRCLE_BRANCH}
       - run:
           name: Running semantic-release workflow
           command: npx semantic-release
@@ -180,22 +158,19 @@ workflows:
       - test_node_10
       - test_node_12
       - test_node_14
-      - end_to_end_tests:
-          requires:
-            - install
       - build:
           requires:
-            - end_to_end_tests
+            - lint
             - test_node_10
             - test_node_12
             - test_node_14
-#      - release:
-#          requires:
-#            - build
-#          filters:
-#            branches:
-#              only:
-#                - master
-#                - next
-#                - pre/rc
-#                - beta
+      - release:
+          requires:
+            - build
+          filters:
+            branches:
+              only:
+                - master
+                - next
+                - pre/rc
+                - beta

AUTHORS.md

@@ -0,0 +1,2 @@
+### @cookbook/dot-notation is authored by: 
+* Marcos Gonçalves <contact@themgoncalves.com>

README.md

@@ -1,4 +1,4 @@
-# @template/typescript-library
+# @cookbook/dot-notation
 > Typescript Library kick-off.
 
 [![NPM Version][npm-image]][npm-url]
@@ -11,20 +11,165 @@
 [![install size][install-size-image]][install-size-url]
 [![gzip size][gzip-size-image]][gzip-size-url]
 
+![](dot-notation.png)
+
+## Demo
+
+Play around with _dot-notation_ and experience **the magic**!
+
+[![Edit @cookbook/dot-notation](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/arg-defdot-notation-td636?fontsize=14&hidenavigation=1&theme=dark)
+
+## Installation
+
+```sh
+npm install @cookbook/dot-notation --save
+#or
+yarn add @cookbook/dot-notation
+```
+
+## How to use
+
+### Picking a value
+
+```js
+import dot from '@cookbook/dot-notation';
+
+const source = {
+  person: {
+    name: {
+      firstName: 'John',
+      lastName: 'Doe'
+    },
+    address: [
+      {
+        street: 'Infinite Loop',
+        city: 'Cupertino',
+        state: 'CA',
+        postalCode: 95014,
+        country: 'United States'
+      },
+    ]
+  }
+};
+
+dot.pick(source, 'person.name');
+//outputs { firstName: 'John', lastName: 'Doe' }
+
+dot.pick(source, 'person.address[0].street');
+//outputs "Infinite Loop"
+```
+
+### Parsing an object
+
+#### Conventional parsing
+
+```js
+import dot from '@cookbook/dot-notation';
+
+const source = {
+  'person.name.firstName': 'John',
+  'person.name.lastName': 'Doe',
+  'person.address[].street': 'Infinite Loop',
+  'person.address[].city': 'Cupertino',
+  'person.address[].postalCode': 95014,
+};
+
+dot.parse(source);
+
+/* outputs
+{
+  person: {
+    name: {
+      firstName: 'John',
+      lastName: 'Doe',
+    },
+    address: [
+      {
+        street: 'Infinite Loop',
+        city: 'Cupertino',
+        postalCode: 95014,
+      },
+    ],
+  },
+}
+*/
+```
+
+#### With nested array
+
+> where `[n]` represents the array index position to insert the element
+
+```js
+import dot from '@cookbook/dot-notation';
+
+const source = {
+  '[0].street': 'Infinite Loop',
+  '[0].city': 'Cupertino',
+  '[0].postalCode': 95014,
+  '[1].street': '1600 Amphitheatre',
+  '[1].city': 'Mountain View',
+  '[1].postalCode': 94043,
+  '[2][0]': 'hobbies',
+  '[2][1][0]': ['coding'],
+  '[2][1][1]': ['gaming'],
+};
+
+dot.parse(source);
+
+/* outputs
+[
+ {
+  "postalCode": 95014,
+  "city": "Cupertino",
+  "street": "Infinite Loop"
+ },
+ {
+  "postalCode": 94043,
+  "city": "Mountain View",
+  "street": "1600 Amphitheatre"
+ },
+ [
+  "hobbies",
+  [["coding"],["gaming"]]
+ ]
+]
+*/
+```
+
+### Parsing single key
+
+
+```js
+import dot from '@cookbook/dot-notation';
+
+const path = 'person.name';
+const value = 'John Doe';
+
+dot.parseKey(path, value);
+
+/* outputs
+{
+  person: {
+    name: 'John Doe',
+  },
+}
+*/
+```
+
 <!-- Markdown link & img dfn's -->
 [npm-image]: https://img.shields.io/npm/v/{PACKAGE_NAMESPACE}.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/{PACKAGE_NAMESPACE}
 [npm-downloads]: https://img.shields.io/npm/dm/{PACKAGE_NAMESPACE}.svg?style=flat-square
-[circleci-image]: https://circleci.com/gh/{GITHUB_REPO_URL}.svg?style=svg
-[circleci-url]: https://circleci.com/gh/{GITHUB_REPO_URL}
-[stars-image]: https://img.shields.io/github/stars/{GITHUB_REPO_URL}.svg
-[stars-url]: https://github.com/{GITHUB_REPO_URL}/stargazers
-[vulnerabilities-image]: https://snyk.io/test/github/{GITHUB_REPO_URL}/badge.svg
-[vulnerabilities-url]: https://snyk.io/test/github/{GITHUB_REPO_URL}
-[issues-image]: https://img.shields.io/github/issues/{GITHUB_REPO_URL}.svg
+[circleci-image]: https://circleci.com/gh/the-cookbook/dot-notation.svg?style=svg
+[circleci-url]: https://circleci.com/gh/the-cookbook/dot-notation
+[stars-image]: https://img.shields.io/github/stars/the-cookbook/dot-notation.svg
+[stars-url]: https://github.com/the-cookbook/dot-notation/stargazers
+[vulnerabilities-image]: https://snyk.io/test/github/the-cookbook/dot-notation/badge.svg
+[vulnerabilities-url]: https://snyk.io/test/github/the-cookbook/dot-notation
+[issues-image]: https://img.shields.io/github/issues/the-cookbook/dot-notation.svg
 [issues-url]: https://github.com/cthe-ookbook/navigator/issues
 [awesome-image]: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg
-[awesome-url]: https://github.com/{GITHUB_REPO_URL}
+[awesome-url]: https://github.com/the-cookbook/dot-notation
 [install-size-image]: https://packagephobia.now.sh/badge?p={PACKAGE_NAMESPACE}
 [install-size-url]: https://packagephobia.now.sh/result?p={PACKAGE_NAMESPACE}
 [gzip-size-image]: http://img.badgesize.io/https://unpkg.com/{PACKAGE_NAMESPACE}/lib/navigator.min.js?compression=gzip

configurations/babel/config.js

@@ -28,6 +28,7 @@ module.exports = function (api) {
         plugins: ['dynamic-import-node'],
       },
       production: {
+        comments: false,
         plugins: [
           [
             'transform-remove-console',

configurations/prettier/config.js

@@ -2,6 +2,7 @@ module.exports = {
   printWidth: 120,
   semi: true,
   trailingComma: 'all',
+  arrowParens:  'always',
   singleQuote: true,
   tabWidth: 2,
   jsxBracketSameLine: false,

configurations/rollup/config.js

@@ -0,0 +1,27 @@
+const resolve = require('rollup-plugin-node-resolve');
+const commonjs = require('rollup-plugin-commonjs');
+const { terser } = require('rollup-plugin-terser');
+
+const pkg = require('../../package.json');
+const pkgName = 'dot';
+const global = [...Object.keys(pkg.dependencies)];
+
+module.exports.pkgName = pkgName;
+module.exports = {
+  input: './lib/index.js',
+  output: {
+    file: `lib/${pkgName}.min.js`,
+    format: 'umd',
+    name: pkgName,
+    sourcemap: true,
+    interop: false,
+  },
+  plugins: [
+    resolve({
+      mainFields: ['module', 'main'],
+    }),
+    commonjs(),
+    terser(),
+  ],
+  external: global,
+};

configurations/rollup/index.js

@@ -1,20 +1 @@
-const resolve = require('rollup-plugin-node-resolve');
-const commonjs = require('rollup-plugin-commonjs');
-const { terser } = require('rollup-plugin-terser');
-
-module.exports = {
-  input: './lib/index.js',
-  output: {
-    file: 'lib/navigator.min.js',
-    format: 'umd',
-    name: 'navigator',
-    sourcemap: true,
-  },
-  plugins: [
-    resolve({
-      mainFields: ['module', 'main'],
-    }),
-    commonjs(),
-    terser(),
-  ],
-};
+module.exports = require('./config');

configurations/semantic-release/config.js

@@ -1,3 +1,5 @@
+const pkgName = require('../rollup').pkgName;
+
 module.exports = {
   branches: [
     { name: 'master' },
@@ -18,7 +20,7 @@ module.exports = {
     [
       '@semantic-release/github',
       {
-        assets: [{ path: 'release/*.tgz' }, { path: 'lib/navigator.min.js*(.map)', label: 'UMD build minified' }],
+        assets: [{ path: 'release/*.tgz' }, { path: `lib/${pkgName}.min.js*(.map)`, label: 'UMD build minified' }],
       },
     ],
     [

configurations/webpack/index.js

@@ -1,3 +1,3 @@
-const merge = require('webpack-merge');
+const merge = require('webpack-merge').merge;
 
 module.exports = merge([require('./setup.dev'), require('./setup.common')]);

configurations/webpack/setup.common.js

@@ -15,7 +15,7 @@ module.exports = {
     extensions: ['.ts', '.tsx', '.js', '.jsx', '.mjs', '.json'],
     modules: [path.resolve(__dirname, '../../', appSource), 'node_modules'],
     alias: {
-      '@cookbook/navigator': path.resolve(__dirname, '../../src'),
+      '@cookbook/dot-notation': path.resolve(__dirname, '../../src'),
     },
   },
   target: 'web',