feat: optionally allow to pass options for updateAttributes

Author: rahulbile

README.md

@@ -31,7 +31,7 @@ When a model method that is controlled by the Finite State Machine is called it
     "StateMachine": {
       "stateProperty": "status",
       "events": [
-        { "name": "activate", "from": "none", "to": "active" },
+        { "name": "activate", "from": "none", "to": "active", "transitionOptions": { "skipBeforeSave" : true } },
         { "name": "cancel", "from": "active", "to": "canceled" },
         { "name": "reactivate", "from": "canceled", "to": "active" },
         { "name": "expire", "from": [ "active", "canceled" ], "to": "expired" }

lib/mixins/state-machine.js

@@ -24,7 +24,14 @@ module.exports = function StateMachine(Model, settings) {
       // Persist the updated state in the database.
       onenter: function onenter(options) {
         debug(`Finalizing state: ${options.to}`)
-        return options.instance.updateAttribute(stateProperty, options.to)
+        let transitionOptions = null
+        const eventOptions = _.find(settings.events, { 'name': options.name })
+
+        if (eventOptions && eventOptions.transitionOptions) {
+          transitionOptions = eventOptions.transitionOptions
+        }
+
+        return options.instance.updateAttribute(stateProperty, options.to, transitionOptions)
           .then(result => {
             options.instance = result
             return Model.notifyObserversOf('fsm:onenter', options)

test/fullcube-state-machine/common/models/subscription.json

@@ -72,7 +72,7 @@
       "stateProperty": "status",
       "events": [
         { "name": "activate", "from": "none", "to": "active" },
-        { "name": "cancel", "from": "active", "to": "canceled" },
+        { "name": "cancel", "from": "active", "to": "canceled", "transitionOptions": { "skipBeforeSave" : true }   },
         { "name": "reactivate", "from": "canceled", "to": "active" },
         { "name": "expire", "from": [ "active", "canceled" ], "to": "expired" }
       ]

test/test.js

@@ -78,6 +78,36 @@ describe('State changes', function() {
   })
 })
 
+describe('Transition Options', function() {
+  before(function() {
+    return Subscription.create({ status: 'active' })
+      .then(subscription => {
+        this.subscription = subscription
+      })
+  })
+
+  before(function() {
+    sinon.spy(Subscription.prototype, 'updateAttribute')
+  })
+
+  it('Should have called updateAttribute with transitionOptions', function() {
+    return this.subscription.cancel()
+      .then(subscription => {
+        this.subscription = subscription
+        expect(subscription).to.have.property('status', 'canceled')
+        expect(Subscription.prototype.updateAttribute).to.be.calledWith('status', 'canceled', { skipBeforeSave: true })
+      })
+  })
+
+  it('Should have not called updateAttribute with skipBeforeSave transitionOptions', function() {
+    return this.subscription.expire()
+      .then(subscription => {
+        expect(subscription).to.have.property('status', 'expired')
+        expect(Subscription.prototype.updateAttribute).to.be.calledWith('status', 'expired')
+      })
+  })
+})
+
 describe('Observers', function() {
   const event = 'cancel'
   const fromState = 'active'