[ADF-4713] Add new DecimalNumber Pipe to transform and localize numbers (#4926)

* [ADF-4713] Add new DecimalNumber Pipe to transform and localize numbers

* Unsubscribe from userPreference service

* Make Pipe impure

* Add documentation in localization page

lib/core/app-config/schema.json

@@ -541,6 +541,29 @@
         }
       }
     },
+    "decimalValues": {
+      "description": "Configuration of date formats in the app",
+      "type": "object",
+      "required": [
+        "minIntegerDigits",
+        "minFractionDigits",
+        "maxFractionDigits"
+      ],
+      "properties": {
+        "minIntegerDigits": {
+          "description": "Minimum integer digits in number",
+          "type": "number"
+        },
+        "minFractionDigits": {
+          "description": "Minimum decimal digits in number",
+          "type": "number"
+        },
+        "maxFractionDigits": {
+          "description": "Maximum decimal digits in number",
+          "type": "number"
+        }
+      }
+    },
     "files": {
       "description": "Configuration of rules applied to file upload",
       "type": "object",

lib/core/card-view/models/card-view-floatitem.model.ts

@@ -19,7 +19,7 @@ import { CardViewItem } from '../interfaces/card-view-item.interface';
 import { DynamicComponentModel } from '../../services/dynamic-component-mapper.service';
 import { CardViewTextItemModel } from './card-view-textitem.model';
 import { CardViewTextItemProperties } from '../interfaces/card-view.interfaces';
-import { CardViewItemFloatValidator } from '..//validators/card-view.validators';
+import { CardViewItemFloatValidator } from '../validators/card-view.validators';
 
 export class CardViewFloatItemModel extends CardViewTextItemModel implements CardViewItem, DynamicComponentModel {
     type: string = 'float';

lib/core/form/components/widgets/number/number.widget.html

@@ -8,7 +8,7 @@
                pattern="-?[0-9]*(\.[0-9]+)?"
                [id]="field.id"
                [required]="isRequired()"
-               [value]="field.value"
+               [value]="displayValue"
                [(ngModel)]="field.value"
                (ngModelChange)="onFieldChanged(field)"
                [disabled]="field.readOnly"

lib/core/form/components/widgets/number/number.widget.spec.ts

@@ -22,7 +22,7 @@ describe('NumberWidgetComponent', () => {
     let widget: NumberWidgetComponent;
 
     beforeEach(() => {
-        widget = new NumberWidgetComponent(null);
+        widget = new NumberWidgetComponent(null, null);
     });
 
     it('should exist', () => {

lib/core/form/components/widgets/number/number.widget.ts

@@ -17,9 +17,10 @@
 
  /* tslint:disable:component-selector no-input-rename   */
 
-import { Component, ViewEncapsulation } from '@angular/core';
+import { Component, ViewEncapsulation, OnInit } from '@angular/core';
 import { FormService } from './../../../services/form.service';
 import { baseHost , WidgetComponent } from './../widget.component';
+import { DecimalNumberPipe } from '../../../../pipes/decimal-number.pipe';
 
 @Component({
     selector: 'number-widget',
@@ -28,10 +29,21 @@ import { baseHost , WidgetComponent } from './../widget.component';
     host: baseHost,
     encapsulation: ViewEncapsulation.None
 })
-export class NumberWidgetComponent extends WidgetComponent {
+export class NumberWidgetComponent extends WidgetComponent implements OnInit {
 
-    constructor(public formService: FormService) {
+    displayValue: number;
+
+    constructor(public formService: FormService,
+                private decimalNumberPipe: DecimalNumberPipe) {
          super(formService);
     }
 
+    ngOnInit() {
+        if (this.field.readOnly) {
+            this.displayValue = this.decimalNumberPipe.transform(this.field.value);
+        } else {
+            this.displayValue = this.field.value;
+        }
+    }
+
 }

lib/core/models/decimal-number.model.ts

@@ -0,0 +1,30 @@
+/*!
+ * @license
+ * Copyright 2019 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export class DecimalNumberModel {
+    minIntegerDigits: number;
+    minFractionDigits: number;
+    maxFractionDigits: number;
+
+    constructor(obj?: any) {
+        if (obj) {
+            this.minIntegerDigits = obj.minIntegerDigits;
+            this.minFractionDigits = obj.minFractionDigits;
+            this.maxFractionDigits = obj.maxFractionDigits;
+        }
+    }
+}

lib/core/models/public-api.ts

@@ -27,3 +27,4 @@ export * from './pagination.model';
 export * from './oauth-config.model';
 export * from './request-pagination.model';
 export * from './notification.model';
+export * from './decimal-number.model';

lib/core/pipes/decimal-number.pipe.spec.ts

@@ -0,0 +1,74 @@
+/*!
+ * @license
+ * Copyright 2019 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { async, TestBed } from '@angular/core/testing';
+import { AppConfigService } from '../app-config/app-config.service';
+import { UserPreferencesService } from '../services/user-preferences.service';
+import { of } from 'rxjs';
+import { setupTestBed } from '../testing/setupTestBed';
+import { CoreTestingModule } from '../testing/core.testing.module';
+import { DecimalNumberPipe } from './decimal-number.pipe';
+
+describe('DecimalNumberPipe', () => {
+
+    let pipe: DecimalNumberPipe;
+    let userPreferences: UserPreferencesService;
+
+    setupTestBed({
+        imports: [CoreTestingModule]
+    });
+
+    beforeEach(async(() => {
+        userPreferences = TestBed.get(UserPreferencesService);
+        spyOn(userPreferences, 'select').and.returnValue(of(''));
+        pipe = new DecimalNumberPipe(userPreferences, new AppConfigService(null));
+    }));
+
+    it('should return number localized and rounded following the default config', () => {
+        expect(pipe.transform(1234.567)).toBe('1,234.57');
+    });
+
+    it('should return number with at least the minimum of digints in the integer part', () => {
+        const decimalValues = {
+            minIntegerDigits: 6,
+            minFractionDigits: undefined,
+            maxFractionDigits: undefined
+        };
+
+        expect(pipe.transform(1234.567, decimalValues)).toBe('001,234.57');
+    });
+
+    it('should return number with at least the minimum of digints in the integer part', () => {
+        const decimalValues = {
+            minIntegerDigits: undefined,
+            minFractionDigits: 4,
+            maxFractionDigits: 10
+        };
+
+        expect(pipe.transform(1234.567, decimalValues)).toBe('1,234.5670');
+    });
+
+    it('should return number with at least the minimum of digints in the integer part', () => {
+        const decimalValues = {
+            minIntegerDigits: undefined,
+            minFractionDigits: 0,
+            maxFractionDigits: 1
+        };
+
+        expect(pipe.transform(1234.567, decimalValues)).toBe('1,234.6');
+    });
+});

lib/core/pipes/decimal-number.pipe.ts

@@ -0,0 +1,82 @@
+/*!
+ * @license
+ * Copyright 2019 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { DecimalPipe } from '@angular/common';
+import { Pipe, PipeTransform, OnDestroy } from '@angular/core';
+import { AppConfigService } from '../app-config/app-config.service';
+import { UserPreferencesService, UserPreferenceValues } from '../services/user-preferences.service';
+import { DecimalNumberModel } from '../models/decimal-number.model';
+import { Subject } from 'rxjs';
+import { takeUntil } from 'rxjs/operators';
+
+@Pipe({
+    name: 'adfDecimalNumber',
+    pure: false
+})
+export class DecimalNumberPipe implements PipeTransform, OnDestroy {
+
+    static DEFAULT_LOCALE = 'en-US';
+    static DEFAULT_MIN_INTEGER_DIGITS = 1;
+    static DEFAULT_MIN_FRACTION_DIGITS = 0;
+    static DEFAULT_MAX_FRACTION_DIGITS = 2;
+
+    defaultLocale: string = DecimalNumberPipe.DEFAULT_LOCALE;
+    defaultMinIntegerDigits: number = DecimalNumberPipe.DEFAULT_MIN_INTEGER_DIGITS;
+    defaultMinFractionDigits: number = DecimalNumberPipe.DEFAULT_MIN_FRACTION_DIGITS;
+    defaultMaxFractionDigits: number = DecimalNumberPipe.DEFAULT_MAX_FRACTION_DIGITS;
+
+    onDestroy$: Subject<boolean> = new Subject<boolean>();
+
+    constructor(public userPreferenceService?: UserPreferencesService,
+                public appConfig?: AppConfigService) {
+
+        if (this.userPreferenceService) {
+            this.userPreferenceService.select(UserPreferenceValues.Locale)
+                .pipe(
+                    takeUntil(this.onDestroy$)
+                )
+                .subscribe((locale) => {
+                    if (locale) {
+                        this.defaultLocale = locale;
+                    }
+                });
+        }
+
+        if (this.appConfig) {
+            this.defaultMinIntegerDigits = this.appConfig.get<number>('decimalValues.minIntegerDigits', DecimalNumberPipe.DEFAULT_MIN_INTEGER_DIGITS);
+            this.defaultMinFractionDigits = this.appConfig.get<number>('decimalValues.minFractionDigits', DecimalNumberPipe.DEFAULT_MIN_FRACTION_DIGITS);
+            this.defaultMaxFractionDigits = this.appConfig.get<number>('decimalValues.maxFractionDigits', DecimalNumberPipe.DEFAULT_MAX_FRACTION_DIGITS);
+        }
+    }
+
+    transform(value: any, digitsInfo?: DecimalNumberModel, locale?: string): any {
+        const actualMinIntegerDigits: number = digitsInfo && digitsInfo.minIntegerDigits ? digitsInfo.minIntegerDigits : this.defaultMinIntegerDigits;
+        const actualMinFractionDigits: number = digitsInfo && digitsInfo.minFractionDigits ? digitsInfo.minFractionDigits : this.defaultMinFractionDigits;
+        const actualMaxFractionDigits: number = digitsInfo && digitsInfo.maxFractionDigits ? digitsInfo.maxFractionDigits : this.defaultMaxFractionDigits;
+
+        const actualDigitsInfo = `${actualMinIntegerDigits}.${actualMinFractionDigits}-${actualMaxFractionDigits}`;
+        const actualLocale = locale || this.defaultLocale;
+
+        const datePipe: DecimalPipe = new DecimalPipe(actualLocale);
+        return datePipe.transform(value, actualDigitsInfo);
+    }
+
+    ngOnDestroy(): void {
+        this.onDestroy$.next(true);
+        this.onDestroy$.complete();
+    }
+}

lib/core/pipes/pipe.module.ts

@@ -29,6 +29,7 @@ import { FormatSpacePipe } from './format-space.pipe';
 import { FileTypePipe } from './file-type.pipe';
 import { MultiValuePipe } from './multi-value.pipe';
 import { LocalizedDatePipe } from './localized-date.pipe';
+import { DecimalNumberPipe } from './decimal-number.pipe';
 
 @NgModule({
     imports: [
@@ -45,7 +46,8 @@ import { LocalizedDatePipe } from './localized-date.pipe';
         FormatSpacePipe,
         FileTypePipe,
         MultiValuePipe,
-        LocalizedDatePipe
+        LocalizedDatePipe,
+        DecimalNumberPipe
     ],
     providers: [
         FileSizePipe,
@@ -57,7 +59,8 @@ import { LocalizedDatePipe } from './localized-date.pipe';
         FormatSpacePipe,
         FileTypePipe,
         MultiValuePipe,
-        LocalizedDatePipe
+        LocalizedDatePipe,
+        DecimalNumberPipe
     ],
     exports: [
         FileSizePipe,
@@ -70,7 +73,8 @@ import { LocalizedDatePipe } from './localized-date.pipe';
         FormatSpacePipe,
         FileTypePipe,
         MultiValuePipe,
-        LocalizedDatePipe
+        LocalizedDatePipe,
+        DecimalNumberPipe
     ]
 })
 export class PipeModule {

lib/core/pipes/public-api.ts

@@ -24,5 +24,6 @@ export * from './user-initial.pipe';
 export * from './full-name.pipe';
 export * from './multi-value.pipe';
 export * from './localized-date.pipe';
+export * from './decimal-number.pipe';
 
 export * from './pipe.module';