0.0.0 • Published 8 years ago

must-sinon v0.0.0

Weekly downloads
61
License
AGPL-3.0
Repository
github
Last release
8 years ago

must-sinon logo

Build Status Code Climate Test Coverage

must-sinon adds SinonJS related assertion matchers to Must.js.

Requirements

The current version of must-sinon requires Must.js 0.13.0 and SinonJS 1.15.0.

must-sinonRequiresMust.jsRequiresSinonJS
1.x.x^0.13.0^1.15.0

Back to Top

Installation

npm

must-sinon will be available soon on npm.

npm install --save-dev must-sinon

Back to Top

Usage

var must = require('must');
var mustSinon = require('must-sinon');
mustSinon(must);

Back to Top

Assertion Matchers

must-sinon adds the following assertion matchers to Must.js.

MatcherUsage
spyspy.must.be.a.spy()
stubstub.must.be.a.stub()
calledspy.must.have.been.called()
calledOncespy.must.have.been.calledOnce()
calledTwicespy.must.have.been.calledTwice()
calledThricespy.must.have.been.calledThrice()
calledCountspy.must.have.calledCount(3)
calledBeforespy1.must.have.been.calledBefore(spy2)
calledAfterspy2.must.have.been.calledBefore(spy1)
calledOninstance.spy.must.have.been.calledOn(instance)
calledWithspy.must.have.been.calledWith(1, 2)
calledWithExactlyspy.must.have.been.calledWithExactly(1, 2, 3)
calledWithNewConstructor.must.have.been.calledWithNew()
returnedstub.must.have.returned('OK')

Back to Top

Chainable Properties

must-sinon adds the following chainable properties to Must.js.

HelperTypeUsage
beenPassthroughspy.must.have.been.called()
neverPassthrough Negatorspy.must.have.never.been.called()
alwaysPassthrough Modifierspy.must.have.always.been.calledWith(1, 2)spy.must.have.always.been.calledWithExactly(1, 2)spy.must.have.always.been.calledOn(1, 2)spy.must.have.always.been.calledWithNew(1, 2)spy.must.have.always.returned(1)

Back to Top

Unit Testing

To run unit tests simply:

git clone https://github.com/JohnnyEstilles/must-sinon.git
cd must-sinon
npm install
npm test

Back to Top

License

must-sinon is free and open source under the AGPL-3.0 License.

Copyright (c) 2015 Johnny Estilles, http://www.agentia.asia

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Back to Top