Merge pull request #124 from mdrewt/issue_123

Added support for remove in ArrayList and Map
shepherdwind · Aug 27, 2019 · 9ddb4d7 · 9ddb4d7
2 parents 9a9319f + c214d01
commit 9ddb4d7
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 0 deletions.
diff --git a/src/compile/references.js b/src/compile/references.js
@@ -269,6 +269,30 @@ module.exports = function(Velocity, utils) {
         return baseRef[this.getLiteral(property.args[0])] = this.getLiteral(property.args[1]);
       } else if (id === 'add' && !baseRef[id] && typeof baseRef.push === 'function') {
         return baseRef.push(this.getLiteral(property.args[0]));
+      } else if (id === 'remove') {
+
+        if (utils.isArray(baseRef)) {
+
+          if (typeof index === 'number') {
+            var index = this.getLiteral(property.args[0]);
+          } else {
+            var index = baseRef.indexOf(this.getLiteral(property.args[0]));
+          }
+
+          ret = baseRef[index];
+          baseRef.splice(index, 1);
+          return ret;
+
+        } else if (utils.isObject(baseRef)) {
+
+          ret = baseRef[this.getLiteral(property.args[0])];
+          delete baseRef[this.getLiteral(property.args[0])];
+          return ret; 
+
+        }
+
+        return undefined;
+
       } else if (id === 'subList' && !baseRef[id]) {
         return baseRef.slice(this.getLiteral(property.args[0]), this.getLiteral(property.args[1]));
       } else {

diff --git a/tests/compile.js b/tests/compile.js
@@ -738,6 +738,48 @@ describe('Compile', function() {
     });
   });
 
+  describe('deletion via .remove', function () {
+    it('should remove a key from an object', function() {
+      var vm = `
+        #set($test = {'foo': 'bar'})
+        #set($baz = $test.remove('foo'))
+        $test
+      `;
+      var expected = '{}';
+      assert.equal(render(vm).trim(), expected);
+    });
+
+    it('should return the value of the removed key', function () {
+      var vm = `
+        #set($test = {'foo': 'bar'})
+        #set($baz = $test.remove('foo'))
+        $baz
+      `;
+      var expected = 'bar';
+      assert.equal(render(vm).trim(), expected);
+    });
+
+    it('should remove a value from an array', function () {
+      var vm = `
+        #set($test = ['foo', 'bar'])
+        #set($baz = $test.remove('bar'))
+        $test
+      `;
+      var expected = '[foo]';
+      assert.equal(render(vm).trim(), expected);
+    });
+
+    it('should return the removed value', function () {
+      var vm = `
+        #set($test = ['foo', 'bar'])
+        #set($baz = $test.remove('bar'))
+        $baz
+      `;
+      var expected = 'bar';
+      assert.equal(render(vm).trim(), expected);
+    });
+  });
+
   describe('Add into empty array', function () {
     it('should add item to array', function() {
       var vm = `