[ADF-5158] ECM Version Directive (#5779)

* [ADF-5158] ECM Version Directive

* Update version-compatibility.directive.ts

* Update version-compatibility.directive.ts

* Change name from ecm to acs

* Fix unit tests

* Update docs for Version directive

* Fix unit tests

* Fix unit tests

* Linting

* Update apps-process-cloud.service.spec.ts

* Fix Ecm Service initialization

* Fix unit test

Co-authored-by: Eugenio Romano <eromano@users.noreply.github.com>
This commit is contained in:
davidcanonieto
2020-06-23 08:46:17 +01:00
committed by GitHub
parent 1daffc050c
commit 46e4daeef3
17 changed files with 432 additions and 22 deletions

View File

@@ -27,6 +27,7 @@ import { CheckAllowableOperationDirective } from './check-allowable-operation.di
import { NodeRestoreDirective } from './node-restore.directive';
import { UploadDirective } from './upload.directive';
import { NodeDownloadDirective } from './node-download.directive';
import { VersionCompatibilityDirective } from './version-compatibility.directive';
@NgModule({
imports: [
@@ -41,7 +42,8 @@ import { NodeDownloadDirective } from './node-download.directive';
CheckAllowableOperationDirective,
NodeRestoreDirective,
NodeDownloadDirective,
UploadDirective
UploadDirective,
VersionCompatibilityDirective
],
exports: [
HighlightDirective,
@@ -51,7 +53,8 @@ import { NodeDownloadDirective } from './node-download.directive';
CheckAllowableOperationDirective,
NodeRestoreDirective,
NodeDownloadDirective,
UploadDirective
UploadDirective,
VersionCompatibilityDirective
]
})
export class DirectiveModule {}

View File

@@ -23,5 +23,6 @@ export * from './check-allowable-operation.directive';
export * from './node-restore.directive';
export * from './node-download.directive';
export * from './upload.directive';
export * from './version-compatibility.directive';
export * from './directive.module';

View File

@@ -0,0 +1,95 @@
/*!
* @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 { Component } from '@angular/core';
import { By } from '@angular/platform-browser';
import { TranslateModule } from '@ngx-translate/core';
import { TestBed, ComponentFixture } from '@angular/core/testing';
import { setupTestBed } from '../testing/setup-test-bed';
import { CoreTestingModule } from '../testing/core.testing.module';
import { VersionCompatibilityService } from '@alfresco/adf-core';
@Component({
template: `
<div *adf-acs-version="'8'" class="hidden-content-1">
My hidden content 1
</div>
<div *adf-acs-version="'7.1'" class="hidden-content-2">
My hidden content 2
</div>
<div *adf-acs-version="'7.0.2'" class="hidden-content-3">
My hidden content 3
</div>
<div *adf-acs-version="'6.1.5'" class="visible-content-1">
My visible content 1
</div>
<div *adf-acs-version="'6.1'" class="visible-content-2">
My visible content 2
</div>
<div *adf-acs-version="'6'" class="visible-content-3">
My visible content 3
</div>
`
})
class TestComponent { }
describe('VersionCompatibilityDirective', () => {
let fixture: ComponentFixture<TestComponent>;
let versionCompatibilityService: VersionCompatibilityService;
const acsResponceMock = {
display: '7.0.1',
major: '7',
minor: '0',
patch: '1'
};
setupTestBed({
imports: [
TranslateModule.forRoot(),
CoreTestingModule
],
declarations: [TestComponent
]
});
beforeEach(() => {
fixture = TestBed.createComponent(TestComponent);
versionCompatibilityService = TestBed.get(VersionCompatibilityService);
spyOn(versionCompatibilityService, 'getAcsVersion').and.returnValue(acsResponceMock);
});
it('should display component when the version is supported', () => {
fixture.detectChanges();
const element1 = fixture.debugElement.query(By.css('[class="visible-content-1"]'));
const element2 = fixture.debugElement.query(By.css('[class="visible-content-2"]'));
const element3 = fixture.debugElement.query(By.css('[class="visible-content-3"]'));
expect(element1).toBeDefined();
expect(element2).toBeDefined();
expect(element3).toBeDefined();
});
it('should hide component when the version is not supported', () => {
fixture.detectChanges();
const element1 = fixture.debugElement.query(By.css('[class="hidden-content-1"]'));
const element2 = fixture.debugElement.query(By.css('[class="hidden-content-2"]'));
const element3 = fixture.debugElement.query(By.css('[class="hidden-content-3"]'));
expect(element1).toBeNull();
expect(element2).toBeNull();
expect(element3).toBeNull();
});
});

View File

@@ -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 { Directive, Input, ViewContainerRef, TemplateRef } from '@angular/core';
import { VersionCompatibilityService } from '../services/version-compatibility.service';
import { VersionModel } from '../models/product-version.model';
@Directive({
selector: '[adf-acs-version]'
})
export class VersionCompatibilityDirective {
/** Minimum version required for component to work correctly . */
@Input('adf-acs-version')
set version(requiredVersion: string) {
this.validateAcsVersion(requiredVersion);
}
constructor(
private templateRef: TemplateRef<any>,
private viewContainer: ViewContainerRef,
private versionCompatibilityService: VersionCompatibilityService
) {
}
private validateAcsVersion(requiredVersion: string) {
if (requiredVersion && this.isVersionSupported(requiredVersion)) {
this.viewContainer.createEmbeddedView(this.templateRef);
} else {
this.viewContainer.clear();
}
}
private parseVersion(version: string): VersionModel {
const major = version.split('.')[0];
const minor = version.split('.')[1] || '0';
const patch = version.split('.')[2] || '0';
return {
major: major,
minor: minor,
patch: patch
} as VersionModel;
}
private isVersionSupported(requiredVersion: string): boolean {
const parsedRequiredVersion = this.parseVersion(requiredVersion);
const currentVersion = this.versionCompatibilityService.getAcsVersion();
let versionSupported = false;
if (currentVersion) {
if (+currentVersion.major > +parsedRequiredVersion.major) {
versionSupported = true;
} else if (currentVersion.major === parsedRequiredVersion.major &&
+currentVersion.minor > +parsedRequiredVersion.minor) {
versionSupported = true;
} else if (currentVersion.major === parsedRequiredVersion.major &&
currentVersion.minor === parsedRequiredVersion.minor &&
+currentVersion.patch >= +parsedRequiredVersion.patch) {
versionSupported = true;
}
}
return versionSupported;
}
}