DS-371: Refactor Fudis.atLeastOneRequired validator name to Fudis.one…

…Required
funidata · Sep 17, 2024 · abc4528 · abc4528
1 parent 3bdbbb0
commit abc4528
Show file tree

Hide file tree

Showing 19 changed files with 66 additions and 65 deletions.
diff --git a/ngx-fudis/projects/dev/src/app/components/formExamples.component.ts b/ngx-fudis/projects/dev/src/app/components/formExamples.component.ts
@@ -132,7 +132,7 @@ export class AppFormExampleComponent implements OnInit {
         english: new FormControl<string | null>(null),
       },
       [
-        FudisGroupValidators.atLeastOneRequired(
+        FudisGroupValidators.oneRequired(
           this._translocoService.selectTranslate('error_one_required'),
         ),
       ],

diff --git a/...rojects/ngx-fudis/src/lib/components/form/checkbox-group/checkbox-group.component.spec.ts b/...rojects/ngx-fudis/src/lib/components/form/checkbox-group/checkbox-group.component.spec.ts
@@ -29,7 +29,7 @@ const testFormGroup = new FormGroup<FudisCheckboxGroupFormGroup<object>>(
     pineapple: new FormControl<boolean | null | undefined>(null),
     orange: new FormControl<boolean | null | undefined>(null),
   },
-  [FudisGroupValidators.atLeastOneRequired(new BehaviorSubject('No fruit picked! :('))],
+  [FudisGroupValidators.oneRequired(new BehaviorSubject('No fruit picked! :('))],
 );
 
 type TestOption = {

diff --git a/...dis/projects/ngx-fudis/src/lib/components/form/checkbox-group/checkbox-group.component.ts b/...dis/projects/ngx-fudis/src/lib/components/form/checkbox-group/checkbox-group.component.ts
@@ -16,7 +16,7 @@ import {
 } from '../../../types/forms';
 
 import { FieldSetBaseDirective } from '../../../directives/form/fieldset-base/fieldset-base.directive';
-import { hasAtLeastOneRequiredOrMinValidator } from '../../../utilities/form/getValidators';
+import { hasOneRequiredOrMinValidator } from '../../../utilities/form/getValidators';
 import { FormComponent } from '../form/form.component';
 import { FudisIdService } from '../../../services/id/id.service';
 import { FudisTranslationService } from '../../../services/translation/translation.service';
@@ -38,7 +38,7 @@ export class CheckboxGroupComponent extends FieldSetBaseDirective implements OnI
 
     this._updateValueAndValidityTrigger.pipe(takeUntilDestroyed()).subscribe(() => {
       if (this.formGroup) {
-        this._required = hasAtLeastOneRequiredOrMinValidator(this.formGroup);
+        this._required = hasOneRequiredOrMinValidator(this.formGroup);
       }
     });
   }
@@ -99,7 +99,7 @@ export class CheckboxGroupComponent extends FieldSetBaseDirective implements OnI
       /**
        * Validation check can be currently be done only for App provided formGroup
        */
-      this._required = hasAtLeastOneRequiredOrMinValidator(this.formGroup);
+      this._required = hasOneRequiredOrMinValidator(this.formGroup);
     }
 
     this._initialCheck(this.formGroup);

diff --git a/...ojects/ngx-fudis/src/lib/components/form/checkbox-group/checkbox-group.docs.mdx b/...ojects/ngx-fudis/src/lib/components/form/checkbox-group/checkbox-group.docs.mdx
@@ -110,7 +110,7 @@ When Form Group has validation errors, the visual and screen reader attributes a
 
 ### As a Required Fieldset
 
-To mark Checkbox Group as Required field, include validator `FudisGroupValidators.atLeastOneRequired()` or `FudisGroupValidators.min()` in the validators array of `formGroup`.
+To mark Checkbox Group as Required field, include validator `FudisGroupValidators.oneRequired()` or `FudisGroupValidators.min()` in the validators array of `formGroup`.
 
 ```
 // In TypeScript file
@@ -119,7 +119,7 @@ myFormGroup = new FormGroup(
   {
   // controls
   },
-  [FudisGroupValidators.atLeastOneRequired('At least one option must be selected!')]
+  [FudisGroupValidators.oneRequired('At least one option must be selected!')]
 );
 
 

diff --git a/...fudis/projects/ngx-fudis/src/lib/components/form/checkbox-group/checkbox-group.stories.ts b/...fudis/projects/ngx-fudis/src/lib/components/form/checkbox-group/checkbox-group.stories.ts
@@ -76,7 +76,7 @@ const basicFormGroup = new FormGroup<FudisCheckboxGroupFormGroup<object>>(
     pineapple: new FormControl<boolean | null | undefined>(null),
     orange: new FormControl<boolean | null | undefined>(null),
   },
-  [FudisGroupValidators.atLeastOneRequired(new BehaviorSubject('No fruit picked! :('))],
+  [FudisGroupValidators.oneRequired(new BehaviorSubject('No fruit picked! :('))],
 );
 
 const ExampleTemplate: StoryFn<CheckboxGroupComponent> = (args: CheckboxGroupComponent) => ({
@@ -124,7 +124,7 @@ const withDisabledFormGroupOptions = new FormGroup<FudisCheckboxGroupFormGroup<o
     pineapple: new FormControl<boolean | null | undefined | null>(null),
     orange: new FormControl<boolean | null | undefined | null>({ value: null, disabled: true }),
   },
-  [FudisGroupValidators.atLeastOneRequired(new BehaviorSubject('Please pick one! :('))],
+  [FudisGroupValidators.oneRequired(new BehaviorSubject('Please pick one! :('))],
 );
 
 const ExampleWithDisabledTemplate: StoryFn<CheckboxGroupComponent> = (

diff --git a/ngx-fudis/projects/ngx-fudis/src/lib/components/form/fieldset/fieldset.stories.ts b/ngx-fudis/projects/ngx-fudis/src/lib/components/form/fieldset/fieldset.stories.ts
@@ -90,7 +90,7 @@ class FieldsetExampleComponent {
     //     swedish: new FormControl(''),
     //     english: new FormControl(''),
     //   },
-    //   [FudisGroupValidators.atLeastOneRequired(new BehaviorSubject('Course name is missing'))],
+    //   [FudisGroupValidators.oneRequired(new BehaviorSubject('Course name is missing'))],
     // ),
     // description: new FormGroup({
     //   finnish: new FormControl('', [

diff --git a/ngx-fudis/projects/ngx-fudis/src/lib/components/form/form/form-dynamic-validators.stories.ts b/ngx-fudis/projects/ngx-fudis/src/lib/components/form/form/form-dynamic-validators.stories.ts
@@ -156,7 +156,7 @@ import { FudisGroupValidators } from '../../../utilities/form/groupValidators';
                     (handleChange)="
                       toggleRequiredFromOthers([
                         formExample.controls.winter,
-                        formExample.controls.working
+                        formExample.controls.working,
                       ])
                     "
                   />
@@ -171,7 +171,7 @@ import { FudisGroupValidators } from '../../../utilities/form/groupValidators';
                     (handleChange)="
                       toggleRequiredFromOthers([
                         formExample.controls.summer,
-                        formExample.controls.working
+                        formExample.controls.working,
                       ])
                     "
                   />
@@ -186,7 +186,7 @@ import { FudisGroupValidators } from '../../../utilities/form/groupValidators';
                     (handleChange)="
                       toggleRequiredFromOthers([
                         formExample.controls.summer,
-                        formExample.controls.winter
+                        formExample.controls.winter,
                       ])
                     "
                   />
@@ -250,19 +250,19 @@ class DynamicValidatorExampleComponent {
         {
           summer1: new FormControl(null),
         },
-        this._atLeastOneRequiredValidatorInstance,
+        this._oneRequiredValidatorInstance,
       ),
       winter: new FormGroup<FudisCheckboxGroupFormGroup<object>>(
         {
           winter1: new FormControl(null),
         },
-        this._atLeastOneRequiredValidatorInstance,
+        this._oneRequiredValidatorInstance,
       ),
       working: new FormGroup<FudisCheckboxGroupFormGroup<object>>(
         {
           working1: new FormControl(null),
         },
-        this._atLeastOneRequiredValidatorInstance,
+        this._oneRequiredValidatorInstance,
       ),
       sport: new FormControl(null, [this._requiredValidatorInstance]),
     });
@@ -339,8 +339,9 @@ class DynamicValidatorExampleComponent {
     value: new Date(new Date().setDate(new Date().getDate() - 1)),
     message: 'Date cannot be before yesterdays date',
   });
-  private _atLeastOneRequiredValidatorInstance: FudisValidatorFn =
-    FudisGroupValidators.atLeastOneRequired('At least one option must be selected');
+  private _oneRequiredValidatorInstance: FudisValidatorFn = FudisGroupValidators.oneRequired(
+    'At least one option must be selected',
+  );
 
   formExample: FormGroup;
 
@@ -396,14 +397,14 @@ class DynamicValidatorExampleComponent {
 
   toggleRequiredFromOthers(removeControls: FormGroup<FudisCheckboxGroupFormGroup<object>>[]): void {
     removeControls.forEach((control) => {
-      const required = control.hasValidator(this._atLeastOneRequiredValidatorInstance);
+      const required = control.hasValidator(this._oneRequiredValidatorInstance);
 
       if (required) {
         control.disable();
-        control.removeValidators(this._atLeastOneRequiredValidatorInstance);
+        control.removeValidators(this._oneRequiredValidatorInstance);
       } else {
         control.enable();
-        control.addValidators(this._atLeastOneRequiredValidatorInstance);
+        control.addValidators(this._oneRequiredValidatorInstance);
       }
 
       control.updateValueAndValidity();

diff --git a/ngx-fudis/projects/ngx-fudis/src/lib/components/form/form/form.docs.mdx b/ngx-fudis/projects/ngx-fudis/src/lib/components/form/form/form.docs.mdx
@@ -122,7 +122,7 @@ formExample = new FormGroup({
       first: new FormControl(null),
       second: new FormControl(null),
     },
-    [FudisGroupValidators.atLeastOneRequired(new BehaviorSubject('Select at least one checkbox!'))],
+    [FudisGroupValidators.oneRequired(new BehaviorSubject('Select at least one checkbox!'))],
   ),
 });
 

diff --git a/ngx-fudis/projects/ngx-fudis/src/lib/components/form/form/form.stories.ts b/ngx-fudis/projects/ngx-fudis/src/lib/components/form/form/form.stories.ts
@@ -254,7 +254,7 @@ class ExampleWithMultipleFormsComponent {
         pineapple: new FormControl<boolean | null>(null),
         orange: new FormControl<boolean | null | undefined>(null),
       },
-      [FudisGroupValidators.atLeastOneRequired(new BehaviorSubject('No fruit picked! :('))],
+      [FudisGroupValidators.oneRequired(new BehaviorSubject('No fruit picked! :('))],
     ),
     // formFour: new FormGroup({
     //   select: new FormControl<FudisSelectOption<object> | null>(
@@ -460,7 +460,7 @@ class FormContentExampleComponent implements OnInit {
       //     swedish: new FormControl(null),
       //     english: new FormControl(null),
       //   },
-      //   [FudisGroupValidators.atLeastOneRequired(new BehaviorSubject('Course name is missing.'))],
+      //   [FudisGroupValidators.oneRequired(new BehaviorSubject('Course name is missing.'))],
       // ),
       // description: new FormGroup({
       //   finnish: new FormControl(null, [

diff --git a/ngx-fudis/projects/ngx-fudis/src/lib/components/form/guidance/guidance.component.spec.ts b/ngx-fudis/projects/ngx-fudis/src/lib/components/form/guidance/guidance.component.spec.ts
@@ -34,7 +34,7 @@ const testFormGroupWithGroupValidator: FormGroup = new FormGroup(
     swedish: new FormControl<string | null>(null),
     english: new FormControl<string | null>(null),
   },
-  FudisGroupValidators.atLeastOneRequired('There must be one value!'),
+  FudisGroupValidators.oneRequired('There must be one value!'),
 );
 
 const testControl = new FormControl(null, [

diff --git a/.../lib/components/form/input-with-language-options/input-with-language-options.component.ts b/.../lib/components/form/input-with-language-options/input-with-language-options.component.ts
@@ -118,7 +118,7 @@ export class InputWithLanguageOptionsComponent
   /**
    * At least one language input is required
    */
-  private _atLeastOneRequired: boolean = false;
+  private _oneRequired: boolean = false;
 
   /**
    * Property to check that control is not empty
@@ -171,17 +171,17 @@ export class InputWithLanguageOptionsComponent
   initialRequiredCheck(): void {
     this._requiredControls = {};
 
-    // TODO: change this._atLeastOneRequired to be fetched with getValidators
+    // TODO: change this._oneRequired to be fetched with getValidators
 
-    if (this.formGroup.errors?.['atLeastOneRequired']) {
-      this._atLeastOneRequired = true;
+    if (this.formGroup.errors?.['oneRequired']) {
+      this._oneRequired = true;
 
       Object.keys(this.formGroup.controls).forEach((control) => {
         this._requiredControls = {
           ...this._requiredControls,
           [control]: {
             value: this.formGroup.controls[control].value,
-            required: this._atLeastOneRequired,
+            required: this._oneRequired,
           },
         };
       });
@@ -207,9 +207,9 @@ export class InputWithLanguageOptionsComponent
    */
   isControlRequired(value: string, controlKey: string): void {
     // If all controls are invalid run initialRequiredCheck()
-    if (this.formGroup.errors?.['atLeastOneRequired']) {
+    if (this.formGroup.errors?.['oneRequired']) {
       this.initialRequiredCheck();
-    } else if (this._atLeastOneRequired && controlKey) {
+    } else if (this._oneRequired && controlKey) {
       // Check how many controls are empty
       this._requiredControls[controlKey].value = value;
 
@@ -237,7 +237,7 @@ export class InputWithLanguageOptionsComponent
       }
 
       // If two or more controls have a value, remove visible required text unless control has FudisValidators.required() or Validators.required
-      if (this._atLeastOneRequired && this._nonEmptyControls.length > 1) {
+      if (this._oneRequired && this._nonEmptyControls.length > 1) {
         this._requiredControls = {};
         Object.keys(this.formGroup.controls).forEach((control) => {
           const isRequired = hasRequiredValidator(this.formGroup.controls[control]);

diff --git a/...ib/components/form/input-with-language-options/input-with-language-options.stories.hidden b/...ib/components/form/input-with-language-options/input-with-language-options.stories.hidden
@@ -91,7 +91,7 @@
 //         ]),
 //       },
 //       [
-//         FudisGroupValidators.atLeastOneRequired(
+//         FudisGroupValidators.oneRequired(
 //           new BehaviorSubject('Give name in at least in one language'),
 //         ),
 //       ],
@@ -111,4 +111,4 @@
 
 // export const ExampleWithAllRequired = TemplateAllRequired.bind({});
 
-// export const ExampleWithAtleastOneRequired = TemplateOneRequired.bind({});
+// export const ExampleWithOneRequired = TemplateOneRequired.bind({});
diff --git a/.../projects/ngx-fudis/src/lib/directives/form/fieldset-base/fieldset-base.directive.spec.ts b/.../projects/ngx-fudis/src/lib/directives/form/fieldset-base/fieldset-base.directive.spec.ts
@@ -45,7 +45,7 @@ class MockCheckboxGroupComponent {
       blueberry: new FormControl<FudisCheckboxOption<object> | null>(null),
       cloudberry: new FormControl<FudisCheckboxOption<object> | null>(null),
     },
-    FudisGroupValidators.atLeastOneRequired('Choose at least one berry'),
+    FudisGroupValidators.oneRequired('Choose at least one berry'),
   );
 }
 

diff --git a/ngx-fudis/projects/ngx-fudis/src/lib/utilities/form/getValidators.spec.ts b/ngx-fudis/projects/ngx-fudis/src/lib/utilities/form/getValidators.spec.ts
@@ -9,7 +9,7 @@ import {
   getMinFromValidator,
   getMinLengthFromValidator,
   hasRequiredValidator,
-  hasAtLeastOneRequiredOrMinValidator,
+  hasOneRequiredOrMinValidator,
 } from './getValidators';
 import {
   FudisCheckboxGroupFormGroup,
@@ -34,33 +34,33 @@ describe('getValidators utility function', () => {
     });
   });
 
-  describe('hasAtLeastOneRequiredOrMinValidator', () => {
-    it('should return true with atLeastOneRequired validator group with checkbox group', () => {
+  describe('hasOneRequiredOrMinValidator', () => {
+    it('should return true with oneRequired validator group with checkbox group', () => {
       const testFormGroup = new FormGroup<FudisCheckboxGroupFormGroup<object>>(
         {
           apple: new FormControl<boolean | null | undefined>(null),
           fairTradeBanana: new FormControl<boolean | null | undefined>(false),
           pear: new FormControl<boolean | null | undefined>(true),
         },
-        [FudisGroupValidators.atLeastOneRequired('No fruit picked! :(')],
+        [FudisGroupValidators.oneRequired('No fruit picked! :(')],
       );
 
-      const isRequired = hasAtLeastOneRequiredOrMinValidator(testFormGroup);
+      const isRequired = hasOneRequiredOrMinValidator(testFormGroup);
 
       expect(isRequired).toEqual(true);
     });
 
-    it('should return true with atLeastOneRequired validator group with InputWithLanguageOptionsFormGroup', () => {
+    it('should return true with oneRequired validator group with InputWithLanguageOptionsFormGroup', () => {
       const testFormGroup = new FormGroup<FudisInputWithLanguageOptionsFormGroup>(
         {
           finnish: new FormControl<string | null>(null),
           swedish: new FormControl<string | null>(''),
           english: new FormControl<string | null>('Hello there!'),
         },
-        [FudisGroupValidators.atLeastOneRequired('One must have some value!')],
+        [FudisGroupValidators.oneRequired('One must have some value!')],
       );
 
-      const isRequired = hasAtLeastOneRequiredOrMinValidator(testFormGroup);
+      const isRequired = hasOneRequiredOrMinValidator(testFormGroup);
 
       expect(isRequired).toEqual(true);
     });
@@ -75,12 +75,12 @@ describe('getValidators utility function', () => {
         [FudisGroupValidators.min({ value: 1, message: 'Pick one!' })],
       );
 
-      const isRequired = hasAtLeastOneRequiredOrMinValidator(testFormGroup);
+      const isRequired = hasOneRequiredOrMinValidator(testFormGroup);
 
       expect(isRequired).toEqual(true);
     });
 
-    it('should return false when atLeastOneRequired validator is provided or min validator value is 0', () => {
+    it('should return false when oneRequired validator is provided or min validator value is 0', () => {
       const testFormGroup = new FormGroup<FudisCheckboxGroupFormGroup<object>>(
         {
           apple: new FormControl<boolean | null | undefined>(null),
@@ -90,7 +90,7 @@ describe('getValidators utility function', () => {
         [FudisGroupValidators.min({ value: 0, message: 'No need to select any actually' })],
       );
 
-      const isRequired = hasAtLeastOneRequiredOrMinValidator(testFormGroup);
+      const isRequired = hasOneRequiredOrMinValidator(testFormGroup);
 
       expect(isRequired).toEqual(false);
     });

diff --git a/ngx-fudis/projects/ngx-fudis/src/lib/utilities/form/getValidators.ts b/ngx-fudis/projects/ngx-fudis/src/lib/utilities/form/getValidators.ts
@@ -17,7 +17,7 @@ export const hasRequiredValidator = (control: AbstractControl): boolean => {
   return false;
 };
 
-export const hasAtLeastOneRequiredOrMinValidator = (group: FormGroup): boolean => {
+export const hasOneRequiredOrMinValidator = (group: FormGroup): boolean => {
   const validatorFn = group.validator;
 
   if (validatorFn === null) {
@@ -32,7 +32,7 @@ export const hasAtLeastOneRequiredOrMinValidator = (group: FormGroup): boolean =
     }),
   );
 
-  const hasProperErrors: boolean = !!(errors?.['atLeastOneRequired'] || errors?.['min'].value > 0);
+  const hasProperErrors: boolean = !!(errors?.['oneRequired'] || errors?.['min'].value > 0);
 
   return hasProperErrors;
 };