[ACS-3217] initial project scaffold for the Folder Rules (#2566)

* initial project scaffold

* visibility rules placeholders

* custom scope for rules evaluators

* unit tests and minor improvements

* update e2e

* add write permission check

* update e2e

* update e2e

* enable the env variable

* fix tests

* update e2e

* fix e2e

projects/aca-folder-rules/src/lib/folder-rules.module.ts

@@ -0,0 +1,43 @@
+/*!
+ * @license
+ * Alfresco Example Content Application
+ *
+ * Copyright (C) 2005 - 2020 Alfresco Software Limited
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { TranslationService } from '@alfresco/adf-core';
+import { ExtensionService, provideExtensionConfig } from '@alfresco/adf-extensions';
+import { NgModule } from '@angular/core';
+import * as rules from './folder-rules.rules';
+
+@NgModule({
+  providers: [provideExtensionConfig(['folder-rules.plugin.json'])]
+})
+export class AcaFolderRulesModule {
+  constructor(translation: TranslationService, extensions: ExtensionService) {
+    translation.addTranslationFolder('aca-folder-rules', 'assets/aca-folder-rules');
+
+    extensions.setEvaluators({
+      'rules.canCreateFolderRule': rules.canCreateFolderRule,
+      'rules.canLinkFolderRule': rules.canLinkFolderRule
+    });
+  }
+}

projects/aca-folder-rules/src/lib/folder-rules.rules.spec.ts

@@ -0,0 +1,119 @@
+/*!
+ * @license
+ * Alfresco Example Content Application
+ *
+ * Copyright (C) 2005 - 2020 Alfresco Software Limited
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { AcaRuleContext } from '@alfresco/aca-shared/rules';
+import { isFolderRulesEnabled, canCreateFolderRule, canLinkFolderRule } from './folder-rules.rules';
+
+describe('Folder Rules', () => {
+  describe('isFolderRulesEnabled', () => {
+    it('should have the feature enabled', () => {
+      const context: any = {
+        appConfig: {
+          get: () => true
+        }
+      };
+
+      const result = isFolderRulesEnabled(context);
+      expect(result).toEqual(true);
+    });
+
+    it('should have the feature disabled', () => {
+      const context: any = {
+        appConfig: {
+          get: () => false
+        }
+      };
+
+      const result = isFolderRulesEnabled(context);
+      expect(result).toEqual(false);
+    });
+  });
+
+  describe('canCreateFolderRule', () => {
+    let context: AcaRuleContext;
+
+    beforeEach(() => {
+      context = {
+        appConfig: {
+          get: () => true
+        },
+        selection: {
+          folder: {} as any
+        },
+        navigation: {
+          url: '/personal-files'
+        },
+        permissions: {
+          check: () => true
+        }
+      } as any;
+    });
+
+    it('should allow creating a rule for the selected folder', () => {
+      const result = canCreateFolderRule(context);
+      expect(result).toEqual(true);
+    });
+
+    it('should not allow creating a rule if no folder selected', () => {
+      context.selection.folder = null;
+
+      const result = canCreateFolderRule(context);
+      expect(result).toEqual(false);
+    });
+  });
+
+  describe('canLinkFolderRule', () => {
+    let context: AcaRuleContext;
+
+    beforeEach(() => {
+      context = {
+        appConfig: {
+          get: () => true
+        },
+        selection: {
+          folder: {} as any
+        },
+        navigation: {
+          url: '/personal-files'
+        },
+        permissions: {
+          check: () => true
+        }
+      } as any;
+    });
+
+    it('should allow linking rule for the selected folder', () => {
+      const result = canLinkFolderRule(context);
+      expect(result).toEqual(true);
+    });
+
+    it('should not allow linking rule if no folder selected', () => {
+      context.selection.folder = null;
+
+      const result = canLinkFolderRule(context);
+      expect(result).toEqual(false);
+    });
+  });
+});

projects/aca-folder-rules/src/lib/folder-rules.rules.ts

@@ -0,0 +1,33 @@
+/*!
+ * @license
+ * Alfresco Example Content Application
+ *
+ * Copyright (C) 2005 - 2020 Alfresco Software Limited
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { AcaRuleContext, hasFolderSelected, canEditFolder } from '@alfresco/aca-shared/rules';
+
+export const isFolderRulesEnabled = (context: AcaRuleContext) => context.appConfig.get<boolean>('plugins.folderRules', false);
+export const isFolderRulesAllowed = (context: AcaRuleContext) =>
+  isFolderRulesEnabled(context) && canEditFolder(context) && hasFolderSelected(context);
+
+export const canCreateFolderRule = (context: AcaRuleContext): boolean => isFolderRulesAllowed(context);
+export const canLinkFolderRule = (context: AcaRuleContext): boolean => isFolderRulesAllowed(context);

projects/aca-folder-rules/src/public-api.ts

@@ -0,0 +1,26 @@
+/*!
+ * @license
+ * Alfresco Example Content Application
+ *
+ * Copyright (C) 2005 - 2020 Alfresco Software Limited
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+export * from './lib/folder-rules.module';

projects/aca-folder-rules/src/test.ts

@@ -0,0 +1,49 @@
+/*!
+ * @license
+ * Alfresco Example Content Application
+ *
+ * Copyright (C) 2005 - 2020 Alfresco Software Limited
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+// This file is required by karma.conf.js and loads recursively all the .spec and framework files
+
+import 'zone.js/dist/zone';
+import 'zone.js/dist/zone-testing';
+import { getTestBed } from '@angular/core/testing';
+import { BrowserDynamicTestingModule, platformBrowserDynamicTesting } from '@angular/platform-browser-dynamic/testing';
+
+declare const require: {
+  context(
+    path: string,
+    deep?: boolean,
+    filter?: RegExp
+  ): {
+    keys(): string[];
+    <T>(id: string): T;
+  };
+};
+
+// First, initialize the Angular testing environment.
+getTestBed().initTestEnvironment(BrowserDynamicTestingModule, platformBrowserDynamicTesting());
+// Then we find all the tests.
+const context = require.context('./', true, /\.spec\.ts$/);
+// And load the modules.
+context.keys().map(context);