feat(context-pad): allow to remove and update entries

tomsue · Nov 11, 2019 · ffa0c6b · ffa0c6b
1 parent c189016
commit ffa0c6b
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 6 deletions.
diff --git a/lib/features/context-pad/ContextPad.js b/lib/features/context-pad/ContextPad.js
@@ -126,11 +126,15 @@ ContextPad.prototype.getEntries = function(element) {
   // loop through all providers and their entries.
   // group entries by id so that overriding an entry is possible
   forEach(this._providers, function(provider) {
-    var e = provider.getContextPadEntries(element);
+    var entriesOrUpdater = provider.getContextPadEntries(element);
 
-    forEach(e, function(entry, id) {
-      entries[id] = entry;
-    });
+    if (isFunction(entriesOrUpdater)) {
+      entries = entriesOrUpdater(entries);
+    } else {
+      forEach(entriesOrUpdater, function(entry, id) {
+        entries[id] = entry;
+      });
+    }
   });
 
   return entries;

diff --git a/test/spec/features/context-pad/ContextPadSpec.js b/test/spec/features/context-pad/ContextPadSpec.js
@@ -10,6 +10,8 @@ import {
   inject
 } from 'test/TestHelper';
 
+import { assign } from 'min-dash';
+
 import {
   query as domQuery,
   queryAll as domQueryAll,
@@ -55,9 +57,9 @@ describe('features/context-pad', function() {
     beforeEach(bootstrapDiagram({ modules: [ contextPadModule, initPadModule ] }));
 
 
-    function Provider(entries) {
+    function Provider(entriesOrUpdater) {
       this.getContextPadEntries = function(element) {
-        return entries || {};
+        return entriesOrUpdater || {};
       };
     }
 
@@ -95,6 +97,74 @@ describe('features/context-pad', function() {
     }));
 
 
+    describe('with updater', function() {
+
+      it('should allow to add entries', inject(function(contextPad) {
+
+        // given
+        function updater(entries) {
+          return assign(entries, { entryB: {} });
+        }
+
+        var plainProvider = new Provider({ entryA: { action: function() {} } }),
+            updatingProvider = new Provider(updater);
+
+        contextPad.registerProvider(plainProvider);
+        contextPad.registerProvider(updatingProvider);
+
+        // when
+        var entries = contextPad.getEntries();
+
+        // then
+        expect(entries.entryA).to.exist;
+        expect(entries.entryB).to.exist;
+      }));
+
+
+      it('should allow to update entries', inject(function(contextPad) {
+
+        // given
+        function updater(entries) {
+          return assign(entries, { entryA: { alt: 'text' } });
+        }
+
+        var plainProvider = new Provider({ entryA: { action: function() {} } }),
+            updatingProvider = new Provider(updater);
+
+        contextPad.registerProvider(plainProvider);
+        contextPad.registerProvider(updatingProvider);
+
+        // when
+        var entries = contextPad.getEntries();
+
+        // then
+        expect(entries.entryA).to.exist;
+        expect(entries.entryA).to.have.property('alt');
+      }));
+
+
+      it('should allow to remove entries', inject(function(contextPad) {
+
+        // given
+        function updater(entries) {
+          return {};
+        }
+
+        var plainProvider = new Provider({ entryA: { action: function() {} } }),
+            updatingProvider = new Provider(updater);
+
+        contextPad.registerProvider(plainProvider);
+        contextPad.registerProvider(updatingProvider);
+
+        // when
+        var entries = contextPad.getEntries();
+
+        // then
+        expect(entries.entryA).to.not.exist;
+      }));
+    });
+
+
     describe('entry className', function() {
 
       function testClassName(options) {