feat: Add some convenient methods

Author: Ruben Bridgewater

README.md

@@ -21,14 +21,20 @@ var Parser = require('redis-parser');
 var myParser = new Parser(options);
 ```
 
-### Possible options
+### Options
 
 * `returnReply`: *function*; mandatory
 * `returnError`: *function*; mandatory
 * `returnFatalError`: *function*; optional, defaults to the returnError function
 * `returnBuffers`: *boolean*; optional, defaults to false
 * `stringNumbers`: *boolean*; optional, defaults to false
 
+### Functions
+
+* `reset()`: reset the parser to it's initial state
+* `setReturnBuffers(boolean)`: (JSParser only) set the returnBuffers option on/off without resetting the parser
+* `setStringNumbers(boolean)`: (JSParser only) set the stringNumbers option on/off without resetting the parser
+
 ### Example
 
 ```js

changelog.md

@@ -1,5 +1,11 @@
 ## v.2.4.0 - xx Jan, 2017
 
+Features
+
+-  Added `reset` function to reset the parser to it's initial values
+-  Added `setReturnBuffers` function to reset the returnBuffers option (Only for the JSParser)
+-  Added `setStringNumbers` function to reset the stringNumbers option (Only for the JSParser)
+
 Bugfixes
 
 -  Parsing time for big nested arrays is now linear

lib/hiredis.js

@@ -49,4 +49,13 @@ HiredisReplyParser.prototype.execute = function (data) {
   }
 }
 
+/**
+ * Reset the parser values to the initial state
+ *
+ * @returns {undefined}
+ */
+HiredisReplyParser.prototype.reset = function () {
+  this.reader = new hiredis.Reader(this.options)
+}
+
 module.exports = HiredisReplyParser

lib/parser.js

@@ -340,6 +340,15 @@ function JavascriptRedisParser (options) {
   this.returnFatalError = options.returnFatalError || options.returnError
   this.returnReply = options.returnReply
   this.name = 'javascript'
+  this.reset()
+}
+
+/**
+ * Reset the parser values to the initial state
+ *
+ * @returns {undefined}
+ */
+JavascriptRedisParser.prototype.reset = function () {
   this.offset = 0
   this.buffer = null
   this.bigStrSize = 0
@@ -350,6 +359,32 @@ function JavascriptRedisParser (options) {
   this.arrayPos = []
 }
 
+/**
+ * Set the returnBuffers option
+ *
+ * @param returnBuffers
+ * @returns {undefined}
+ */
+JavascriptRedisParser.prototype.setReturnBuffers = function (returnBuffers) {
+  if (typeof returnBuffers !== 'boolean') {
+    throw new TypeError('The returnBuffers argument has to be a boolean')
+  }
+  this.optionReturnBuffers = returnBuffers
+}
+
+/**
+ * Set the stringNumbers option
+ *
+ * @param stringNumbers
+ * @returns {undefined}
+ */
+JavascriptRedisParser.prototype.setStringNumbers = function (stringNumbers) {
+  if (typeof stringNumbers !== 'boolean') {
+    throw new TypeError('The stringNumbers argument has to be a boolean')
+  }
+  this.optionStringNumbers = stringNumbers
+}
+
 /**
  * Concat a bulk string containing multiple chunks
  *

test/parsers.spec.js

@@ -54,6 +54,79 @@ describe('parsers', function () {
         bla: 6
       })
     })
+
+    it('reset returnBuffers option', function () {
+      var res = 'test'
+      var replyCount = 0
+      function checkReply (reply) {
+        if (replyCount === 0) {
+          assert.strictEqual(reply, res)
+        } else {
+          assert.strictEqual(reply.inspect(), Buffer(res).inspect())
+        }
+        replyCount++
+      }
+      var parser = JavascriptParser({
+        returnReply: checkReply,
+        returnError: returnError
+      })
+      parser.execute(new Buffer('+test\r\n'))
+      parser.execute(new Buffer('+test'))
+      parser.setReturnBuffers(true)
+      assert.strictEqual(replyCount, 1)
+      parser.execute(new Buffer('\r\n'))
+      assert.strictEqual(replyCount, 2)
+    })
+
+    it('reset returnBuffers option with wrong input', function () {
+      var parser = JavascriptParser({
+        returnReply: returnReply,
+        returnError: returnError
+      })
+      assert.throws(function () {
+        parser.setReturnBuffers(null)
+      }, function (err) {
+        assert.strictEqual(err.message, 'The returnBuffers argument has to be a boolean')
+        assert(err instanceof TypeError)
+        return true
+      })
+    })
+
+    it('reset stringNumbers option', function () {
+      var res = 123
+      var replyCount = 0
+      function checkReply (reply) {
+        if (replyCount === 0) {
+          assert.strictEqual(reply, res)
+        } else {
+          assert.strictEqual(reply, String(res))
+        }
+        replyCount++
+      }
+      var parser = JavascriptParser({
+        returnReply: checkReply,
+        returnError: returnError
+      })
+      parser.execute(new Buffer(':123\r\n'))
+      assert.strictEqual(replyCount, 1)
+      parser.setStringNumbers(true)
+      parser.execute(new Buffer(':123\r\n'))
+      assert.strictEqual(replyCount, 2)
+    })
+
+    it('reset stringNumbers option with wrong input', function () {
+      var parser = JavascriptParser({
+        returnReply: returnReply,
+        returnError: returnError
+      })
+      assert.throws(function () {
+        parser.setStringNumbers(null)
+      }, function (err) {
+        assert.strictEqual(err.message, 'The stringNumbers argument has to be a boolean')
+        assert(err instanceof TypeError)
+        return true
+      })
+    })
   })
 
   parsers.forEach(function (Parser) {
@@ -100,6 +173,18 @@ describe('parsers', function () {
         replyCount = 0
       })
 
+      it('reset parser', function () {
+        function checkReply (reply) {
+          assert.strictEqual(reply, 'test')
+          replyCount++
+        }
+        var parser = newParser(checkReply)
+        parser.execute(new Buffer('$123\r\naaa'))
+        parser.reset()
+        parser.execute(new Buffer('+test\r\n'))
+        assert.strictEqual(replyCount, 1)
+      })
+
       it('should not set the bufferOffset to a negative value', function (done) {
         if (Parser.name === 'HiredisReplyParser') {
           return this.skip()