improve case documentation #26

Author: codingedgar

documentation/features.md

@@ -23,11 +23,11 @@
 
 ![demo](./images/select_one_key_scenario_2.gif)
 
-### Should do nothing if selecting an already selected key
+### Should deselect all but the selected key
 |  |  |
 | --- | ---|
-| Implemented | ❌ |
-| Has tests | ❌ |
+| Implemented | ✅ |
+| Has tests | ✅ |
 | Hot Key | `click` |
 | Issue | https://github.com/codingedgar/macos-multi-select/issues/26 |
 

documentation/images/select_one_key_scenario_3.gif

@@ -1,6 +1,6 @@
 {
   "name": "macos-multi-select",
-  "version": "0.2.0-rc.0",
+  "version": "0.2.0-rc.1",
   "description": "Given an Index, and an Action, return an array of selected keys with the same behaviour of macOS finder list view selection.",
   "main": "dist/index.js",
   "repository": "[email protected]:codingedgar/macos-multi-select.git",

package.json

@@ -1,5 +1,5 @@
 import fc from 'fast-check';
-import { sort } from 'ramda';
+import { sort, uniq } from 'ramda';
 
 export function subsequentSubarray(arr: string[]) {
   return fc.tuple(fc.nat(arr.length), fc.nat(arr.length))
@@ -83,3 +83,24 @@ export function indexWithAdjacentConnections() {
       })
   )
 }
+
+export function indexWithSelection() {
+  return fc.tuple(
+    fc.set(
+      fc.string(),
+      { minLength: 1 }
+    ),
+    fc.array(fc.nat(), { minLength: 1 }),
+    fc.nat()
+  )
+  .map(([index, selectedIndices, selectOneIndex]) => {
+    const selected = uniq(selectedIndices.map(i => index[i % index.length]));
+    const selectOne = selected[selectOneIndex % selected.length];
+
+    return {
+      index,
+      selected,
+      selectOne
+    }
+  })
+}

src/spec/arbitraries.ts

@@ -1,6 +1,7 @@
 import fc from 'fast-check';
 import { head } from 'ramda';
-import { multiselect } from '../index';
+import { Context, multiselect } from '../index';
+import { indexWithSelection } from './arbitraries';
 
 describe('Select One Key', () => {
   test('should be able to select one key in a non empty index', () => {
@@ -91,4 +92,48 @@ describe('Select One Key', () => {
         )
     )
   });
+
+  test('Should deselect all but the selected key', () => {
+    fc.assert(
+      fc.property(
+        indexWithSelection(),
+        ({
+          index,
+          selected,
+          selectOne,
+        }) => {
+          const context: Context = selected.reduce(
+            (ctx, key) => 
+              multiselect(
+                ctx,
+                {
+                  type: "TOGGLE SELECTION",
+                  id: key,
+                }
+              ),
+              {
+                index,
+                selected: [],
+                adjacentPivot: undefined,
+              } as Context
+          );
+
+          expect(
+            multiselect(
+              context,
+              {
+                type: "SELECT ONE",
+                id: selectOne,
+              }
+            )
+          )
+            .toEqual({
+              index,
+              selected: [selectOne],
+              adjacentPivot: selectOne,
+            })
+        }
+      )
+    )
+  });
 })