feat: remove lodash (#8)

* feat: remove lodash

* feat: run ci on pr

* test: remove clone

* ci: separate steps

Author: oscar-guerin

.github/workflows/ngx-form-ci.yml

@@ -1,43 +1,136 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
 name: build
 
 on:
   push:
     branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
 
 jobs:
-  build_and_test:
-
+  build:
+    name: Build NgxForm
     runs-on: ubuntu-latest
-
     strategy:
       matrix:
         node-version: [ 18.19.1 ]
 
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
+
       - name: Installation
         run: npm ci
+
       - name: Build NgxForm
         run: npm run build:ngx-form
         env:
           CI: true
-      - name: Linter
+
+      - name: Archive build artifact
+        uses: actions/upload-artifact@master
+        with:
+          name: ngx-form-build
+          path: ./dist/ngx-form
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ 18.19.1 ]
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Installation
+        run: npm ci
+
+      - name: Run Linter
         run: npm run lint
-      - name: Test
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ 18.19.1 ]
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Installation
+        run: npm ci
+
+      - name: Run Tests
         run: npm run test:ci
+
+      - name: Archive Coverage Artifact
+        uses: actions/upload-artifact@master
+        with:
+          name: ngx-form-coverage
+          path: ./coverage
+
+  coverall:
+    name: Coverall
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+    strategy:
+      matrix:
+        node-version: [ 18.19.1 ]
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Download Coverage Artifact
+        uses: actions/download-artifact@master
+        with:
+          name: ngx-form-coverage
+          path: ./coverage
+
       - name: Send coverage to Coverall
         uses: coverallsapp/github-action@v1.0.1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           path-to-lcov: ./coverage/ngx-form/lcov.info
 
+  deploy_paddls:
+    name: Deploy NgxForm @paddls
+    needs: [ build, lint, test ]
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ 18.19.1 ]
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Download Build Artifact
+        uses: actions/download-artifact@master
+        with:
+          name: ngx-form-build
+          path: ./dist/ngx-form
+
       - name: "Publish @paddls/ngx-form"
         uses: pascalgn/npm-publish-action@1.3.9
         with:
@@ -49,12 +142,33 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN_PADDLS }}
+
+  deploy_witty:
+    name: Deploy NgxForm @witty-services
+    needs: [ build, lint, test ]
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ 18.19.1 ]
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Download Build Artifact
+        uses: actions/download-artifact@master
+        with:
+          name: ngx-form-build
+          path: ./dist/ngx-form
+
       - name: "PrePublish @witty-services/ngx-form"
         uses: jossef/action-set-json-field@v1
         with:
           file: "./dist/ngx-form/package.json"
           field: name
           value: "@witty-services/ngx-form"
+
       - name: "Publish @witty-services/ngx-form"
         uses: pascalgn/npm-publish-action@1.3.9
         with:

README.md

@@ -211,7 +211,6 @@ properties are available. Just specify the properties directly in the context if
 ```typescript
 import {FormControl, FormGroup, UpdateOn, Validator, AsyncValidator} from '@paddls/ngx-form';
 import {AddressForm} from './address.form';
-import {clone} from 'lodash';
 import {Validators} from '@angular/forms';
 
 @UpdateOn('change')
@@ -229,7 +228,7 @@ export class UserForm {
   @Validator([Validators.required, Validators.min(0)])
   public age: number;
 
-  @FormGroup({type: () => AddressForm, defaultValue: clone(defaultAddress)})
+  @FormGroup({type: () => AddressForm, defaultValue: structuredClone(defaultAddress)})
   @UpdateOn('submit')
   public personalAddress: AddressForm;
 }

package-lock.json

@@ -22,7 +22,6 @@
     "@angular/platform-browser": "^18.0.2",
     "@angular/platform-browser-dynamic": "^18.0.2",
     "@angular/router": "^18.0.2",
-    "lodash.set": "^4.3.2",
     "rxjs": "~7.5.3",
     "tslib": "^2.4.0",
     "zone.js": "~0.14.2"
@@ -49,7 +48,6 @@
     "karma-coverage": "~2.2.1",
     "karma-jasmine": "~5.1.0",
     "karma-jasmine-html-reporter": "^2.1.0",
-    "lodash.clone": "^4.5.0",
     "ng-packagr": "^18.0.0",
     "protractor": "~7.0.0",
     "reflect-metadata": "^0.2.2",

package.json

@@ -3,8 +3,5 @@
   "dest": "../../dist/ngx-form",
   "lib": {
     "entryFile": "src/public-api.ts"
-  },
-  "allowedNonPeerDependencies": [
-    "lodash.set"
-  ]
+  }
 }

projects/ngx-form/ng-package.json

@@ -7,7 +7,6 @@
     "reflect-metadata": "^0.2.2"
   },
   "dependencies": {
-    "lodash.set": "^4.3.2",
     "tslib": "^2.0.0"
   },
   "repository": {

projects/ngx-form/package.json

@@ -4,9 +4,9 @@ import {FORM_GROUP_SUFFIX_METADATA_KEY, FormGroupContext} from '../decorator/for
 import {FORM_ARRAY_SUFFIX_METADATA_KEY, FormArrayContext} from '../decorator/form-array.decorator';
 import {NgxFormArray} from '../model/ngx-form-array.model';
 import {FORM_GROUP_INSTANCE_METADATA_KEY, NgxFormGroup} from '../model/ngx-form-group.model';
-import set from 'lodash.set';
 import {Observable} from 'rxjs';
 import {NgxFormControl} from '../model/ngx-form-control.model';
+import {set} from './functions/set';
 
 export interface Handler {
 
@@ -41,7 +41,7 @@ export function transformValueToSmartValue<V>(formGroup: NgxFormGroup<V>, parent
     }
   });
 
-  const groupContexts: { [key: string]: FormContextCommon<V> } = findPropertyFormContexts(formGroupContext.type().prototype, FORM_GROUP_SUFFIX_METADATA_KEY);
+  const groupContexts: {[key: string]: FormContextCommon<V>} = findPropertyFormContexts(formGroupContext.type().prototype, FORM_GROUP_SUFFIX_METADATA_KEY);
   Object.keys(groupContexts).forEach((key: string) => {
     const groupContext: FormGroupContext<V> = groupContexts[key] as FormGroupContext<V>;
     set(value, key, (formGroup.get(groupContext.name) as unknown as NgxFormArray<V>)?.getValue(parent + key))
@@ -53,14 +53,14 @@ export function transformValueToSmartValue<V>(formGroup: NgxFormGroup<V>, parent
 export function transformSmartValueToValue<V>(value: V): any {
   const obj: any = {};
 
-  const controlContexts: { [key: string]: FormContextCommon<V> } = {};
+  const controlContexts: {[key: string]: FormContextCommon<V>} = {};
   Object.assign(controlContexts, {
     ...findPropertyFormContexts(value.constructor.prototype, FORM_CONTROL_SUFFIX_METADATA_KEY),
     ...findPropertyFormContexts(value.constructor.prototype, FORM_GROUP_SUFFIX_METADATA_KEY)
   });
   Object.keys(controlContexts).forEach((key: string) => {
     const controlContext: FormContextCommon<V> = controlContexts[key];
-    if(value[key] !== undefined) {
+    if (value[key] !== undefined) {
       set(obj, controlContext.name, value[key]);
     }
   });
@@ -103,6 +103,6 @@ type IterableElement<TargetIterable> =
       never;
 
 export type DataToFormType<V, K extends keyof V = keyof V> = {
-  [key in K]: V[key] extends Primitive ?  NgxFormControl<V[key]> : V[key] extends Arrayable<IterableElement<V[key]>> ? NgxFormArray<IterableElement<V[key]>> : NgxFormGroup<V[key]>
+  [key in K]: V[key] extends Primitive ? NgxFormControl<V[key]> : V[key] extends Arrayable<IterableElement<V[key]>> ? NgxFormArray<IterableElement<V[key]>> : NgxFormGroup<V[key]>
 };
 export type DataFormType<V> = Partial<V> & {[key: string]: any};

projects/ngx-form/src/lib/common/common.ts

@@ -0,0 +1,39 @@
+import {set} from './set';
+
+describe('set', () => {
+  it('should set a value at a given path with dot notation', () => {
+    const obj = {a: {b: undefined}};
+    set(obj, 'a.b.c', 42);
+    expect(obj).toEqual({a: {b: {c: 42}}});
+  });
+
+  it('should set a value at a given path with array notation', () => {
+    const obj = {a: {b: undefined}};
+    set(obj, ['a', 'b', 'c'], 42);
+    expect(obj).toEqual({a: {b: {c: 42}}});
+  });
+
+  it('should create nested objects if they do not exist', () => {
+    const obj = {};
+    set(obj, 'x.y.z', 'test');
+    expect(obj).toEqual({x: {y: {z: 'test'}}});
+  });
+
+  it('should overwrite existing values at the given path', () => {
+    const obj = {a: {b: {c: 10}}};
+    set(obj, 'a.b.c', 42);
+    expect(obj).toEqual({a: {b: {c: 42}}});
+  });
+
+  it('should handle empty path array correctly', () => {
+    const obj = {a: 1};
+    set(obj, [], 42);
+    expect(obj).toEqual({a: 1});
+  });
+
+  it('should handle empty path string correctly', () => {
+    const obj = {a: 1};
+    set(obj, '', 42);
+    expect(obj).toEqual({a: 1});
+  });
+});

projects/ngx-form/src/lib/common/functions/set.spec.ts

@@ -0,0 +1,14 @@
+export const set = (obj: {[key: string]: any}, path: string | string[], value: any): void => {
+  const pathArray = Array.isArray(path) ? path : path.match(/([^[.\]])+/g);
+
+  if (pathArray === null) {
+    return;
+  }
+
+  pathArray.reduce((acc: {[key: string]: any}, key, i) => {
+    if (acc[key] === undefined) acc[key] = {};
+    if (i === pathArray.length - 1) acc[key] = value;
+
+    return acc[key];
+  }, obj);
+};

projects/ngx-form/src/lib/common/functions/set.ts

@@ -6,7 +6,6 @@ import {FormGroup, FormGroupContext} from '../decorator/form-group.decorator';
 import {NgxFormGroup} from '../model/ngx-form-group.model';
 import {Validator} from '../decorator/validator.decorator';
 import {Validators} from '@angular/forms';
-import clone from 'lodash.clone';
 import {TestBed} from '@angular/core/testing';
 import {provideNgxForm} from '../ngx-form.module';
 import {AsyncValidator} from '../decorator/async-validator.decorator';
@@ -81,7 +80,7 @@ class UserForm {
   @FormArray(() => CompanyForm)
   public companies: CompanyForm[];
 
-  @FormGroup({type: () => AddressForm, defaultValue: clone(defaultAddress)})
+  @FormGroup({type: () => AddressForm, defaultValue: structuredClone(defaultAddress)})
   @UpdateOn('submit')
   public personalAddress: AddressForm;