Giter VIP home page Giter VIP logo

sutabu's Introduction

sutabu

Build Status

A minimalist AMD stubbing library for use in testing.

This requires ES5 support. Therefore IE8 and prior are not supported.

Usage

The main way to use sutabu is to generate stub functions. Generating a new stub function looks like this:

define([ 'sutabu/stub' ], function (stub) {
	var stubFunc = stub();
	var result = stubFunc();

	console.log(stubFunc.callCount); // outputs: 1
});

Each generated stub function contains 3 non-emurable properties that dictate how the stub behaves. If any of these are set, they will be processed when the function is invoked and returned:

Property Description
.throws If not undefined, this will be thrown when the stub function is called.
.calls Assumed to be a function, it will be called with the same scope and arguments as the stub function.
.returns Whatever is assigned here is returned, which defaults to undefined, which means stub functions return by default undefined

When a new stub function is created, you can pass a single argument that will define how the stub behaves when called. If you pass an instance of Error it will assigned to .throws, if you pass a function, it will be assigned to .calls and if you pass any other type of argument, it is assigned to .returns.

Stubbing Functions

If you want to specifically stub a function, you can call stub.func(). Basic usage is something like this:

define([ 'sutabu/stub' ], function (stub) {
	var obj = {};

	var handle = stub.func(obj, 'foo', function () {
		return 'bar';
	});

	console.log(obj.foo()); // outputs: 'bar'
	console.log(obj.foo.callCount); // outputs: 1

	handle.remove(); // removes the stub
});

Testing

Testing is done via The Intern and uses Grunt for task automation. To run the unit tests, first install the prerequisites via npm:

npm install

To run the unit tests locally, against Node:

grunt test:node

To run the tests using SauceLabs, assuming you have your SauceLabs credentials available in the environment:

grunt test

sutabu's People

Contributors

kitsonk avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.