Implementing Reach Check Permissions. Part 1: Chek Permissions Function

.prettierrc

@@ -0,0 +1,31 @@
+{
+  "arrowParens": "always",
+  "parser": "flow",
+  "printWidth": 90,
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 4,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "overrides": [
+    {
+      "files": [
+        "*.ts",
+        "*.tsx"
+      ],
+      "options": {
+        "parser": "typescript",
+        "endOfLine": "auto"
+      }
+    },
+    {
+      "files": [
+        "*.scss",
+        "*.module.scss"
+      ],
+      "options": {
+        "parser": "scss"
+      }
+    }
+  ]
+}

README.md

@@ -1,46 +1,3 @@
-# Getting Started with Create React App
+# Follow-up repo for Implementing Reach Check Permissions series
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `yarn start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
-
-### `yarn test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `yarn build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+[Implementing Reach Check Permissions series](https://dev.to/bwca/implementing-reach-check-permissions-part-0-intro-1inc)

src/permissions-validation/check-permissions/check-permissions.function.spec.ts

@@ -0,0 +1,51 @@
+import { checkPermissions } from "./check-permissions.function";
+
+describe("Testing permission checking function", () => {
+    it("Result should be positive if no required permissions provided", () => {
+        // Arrange
+        const currentPermissions: string[] = [];
+
+        // Act
+        const hasPermissions = checkPermissions(currentPermissions);
+
+        // Assert
+        expect(hasPermissions).toBeTruthy();
+    });
+    it("Result should be positive if required permissions are present in current permissions", () => {
+        // Arrange
+        const requiredPermission = "some-view-permission";
+        const currentPermissions = [requiredPermission];
+
+        // Act
+        const hasPermissions = checkPermissions(currentPermissions, requiredPermission);
+
+        // Assert
+        expect(hasPermissions).toBeTruthy();
+    });
+    it("Result should be negative if not all required permissions are present", () => {
+        // Arrange
+        const requiredPermission = ["some-view-permission", "some-other-permission"];
+        const currentPermissions = [requiredPermission[0]];
+
+        // Act
+        const hasPermissions = checkPermissions(currentPermissions, requiredPermission);
+
+        // Assert
+        expect(hasPermissions).toBeFalsy();
+    });
+    it("Result should be positive if not all required permissions are present when checkAll parameter is set to false", () => {
+        // Arrange
+        const requiredPermission = ["some-view-permission", "some-other-permission"];
+        const currentPermissions = [requiredPermission[0]];
+
+        // Act
+        const hasPermissions = checkPermissions(
+            currentPermissions,
+            requiredPermission,
+            false
+        );
+
+        // Assert
+        expect(hasPermissions).toBeTruthy();
+    });
+});

src/permissions-validation/check-permissions/check-permissions.function.ts

@@ -0,0 +1,18 @@
+export function checkPermissions(
+    currentPermissions: string[],
+    requiredPermissions?: string[] | string | null,
+    checkAll = true
+): boolean {
+    if (!requiredPermissions) {
+        return true;
+    }
+    if (!Array.isArray(requiredPermissions)) {
+        requiredPermissions = [requiredPermissions];
+    }
+
+    if (checkAll) {
+        return requiredPermissions.every((p) => currentPermissions.includes(p));
+    }
+
+    return requiredPermissions.some((p) => currentPermissions.includes(p));
+}

src/permissions-validation/check-permissions/index.ts

@@ -0,0 +1 @@
+export * from "./check-permissions.function";