jasmine-expect

Jasmine-Matchers

Readable tests.

The Jasmine testing framework from Pivotal Labs comes with this default set of matchers;

expect(fn).toThrow(e);
expect(instance).toBe(instance);
expect(mixed).toBeDefined();
expect(mixed).toBeFalsy();
expect(number).toBeGreaterThan(number);
expect(number).toBeLessThan(number);
expect(mixed).toBeNull();
expect(mixed).toBeTruthy();
expect(mixed).toBeUndefined();
expect(array).toContain(member);
expect(string).toContain(substring);
expect(mixed).toEqual(mixed);
expect(mixed).toMatch(pattern);

Using the default Matchers your tests and failure output might look something like this;

it('should expose the expected API', function() {
  expect(typeof record.save).toEqual('function');
});

Expected "undefined" to equal "function"

it('should distribute evenly', function() {
  expect(basket.items % 2 === 0).toEqual(true);
});

Expected false to equal true

Using Jasmine-Matchers the same tests and failure output can be written like this;

it('should expose the expected API', function() {
  expect(record).toHaveMethod('save');
});

Expected member "save" of { save : undefined } to be function.

it('should distribute evenly', function() {
  expect(basket).toHaveEvenNumber('items');
});

Expected member "items" of { items : 25 } to be even number.

Installation

npm

npm install jasmine-expect --save-dev

Bower

bower install jasmine-expect --save-dev

Manual

Downloads are available on the releases page.

Integration

Browser

Include Jasmine Matchers after Jasmine but before your tests.

<script src="/path/to/jasmine-matchers.js"></script>

Karma

Integration is easy with the karma-jasmine-matchers plugin.

Node.js

When using jasmine-node 1.x, provide the path to where Jasmine Matchers is installed as the value for --requireJsSetup.

jasmine-node --requireJsSetup node_modules/jasmine-expect/index.js test

jasmine-node 2.x has no such hooks that I'm aware of for loading helpers, in this case the following call is needed before the first test in your suite.

require('jasmine-expect');

Sublime Text

Jasmine-Matchers-Snippets can be installed with Package Control to ease development with Jasmine Matchers in Sublime Text.

Available Matchers

Arrays

expect(array).toBeArray();
expect(array).toBeArrayOfBooleans();
expect(array).toBeArrayOfNumbers();
expect(array).toBeArrayOfObjects();
expect(array).toBeArrayOfSize(size);
expect(array).toBeArrayOfStrings();
expect(array).toBeEmptyArray();
expect(array).toBeNonEmptyArray();
expect(object).toHaveArray(memberName);
expect(object).toHaveArrayOfBooleans(memberName);
expect(object).toHaveArrayOfNumbers(memberName);
expect(object).toHaveArrayOfObjects(memberName);
expect(object).toHaveArrayOfSize(memberName, size);
expect(object).toHaveArrayOfStrings(memberName);
expect(object).toHaveEmptyArray(memberName);
expect(object).toHaveNonEmptyArray(memberName);

Booleans

expect(boolean).toBeBoolean();
expect(boolean).toBeFalse();
expect(boolean).toBeTrue();
expect(object).toHaveBoolean(memberName);
expect(object).toHaveFalse(memberName);
expect(object).toHaveTrue(memberName);

Dates

expect(date).toBeAfter(date);
expect(date).toBeBefore(date);
expect(date).toBeDate();
expect(string).toBeIso8601();
expect(object).toHaveDate(memberName);
expect(object).toHaveDateAfter(memberName, date);
expect(object).toHaveDateBefore(memberName, date);
expect(object).toHaveIso8601(memberName);

Functions and Errors

expect(function).toBeFunction();
expect(function).toThrowError();
expect(function).toThrowErrorOfType(type);
expect(object).toHaveMethod(memberName);

Numbers

expect(mixed).toBeCalculable();
expect(number).toBeEvenNumber();
expect(number).toBeNumber();
expect(number).toBeOddNumber();
expect(number).toBeWholeNumber();
expect(number).toBeWithinRange(floor, ceiling);
expect(object).toHaveCalculable(memberName);
expect(object).toHaveEvenNumber(memberName);
expect(object).toHaveNumber(memberName);
expect(object).toHaveNumberWithinRange(memberName, floor, ceiling);
expect(object).toHaveOddNumber(memberName);
expect(object).toHaveWholeNumber(memberName);

Objects

expect(object).toBeEmptyObject();
expect(object).toBeNonEmptyObject();
expect(object).toBeObject();
expect(object).toHaveEmptyObject(memberName);
expect(object).toHaveMember(memberName);
expect(object).toHaveNonEmptyObject(memberName);
expect(object).toHaveObject(memberName);
expect(object).toImplement(other);

Strings

expect(string).toBeEmptyString();
expect(string).toBeHtmlString();
expect(string).toBeJsonString();
expect(string).toBeLongerThan(other);
expect(string).toBeNonEmptyString();
expect(string).toBeSameLengthAs(other);
expect(string).toBeShorterThan(other);
expect(string).toBeString();
expect(string).toBeWhitespace();
expect(string).toEndWith(expected);
expect(string).toStartWith(expected);
expect(object).toHaveEmptyString(memberName);
expect(object).toHaveHtmlString(memberName);
expect(object).toHaveJsonString(memberName);
expect(object).toHaveNonEmptyString(memberName);
expect(object).toHaveString(memberName);
expect(object).toHaveStringLongerThan(memberName, other);
expect(object).toHaveStringSameLengthAs(memberName, other);
expect(object).toHaveStringShorterThan(memberName, other);
expect(object).toHaveWhitespaceString(memberName);

Supported Devices

Jasmine-Matchers has been tested against the following environments.

• Chrome 40.0.2214 (Mac OS X 10.10.1)
• Firefox 33.0.0 (Mac OS X 10.10)
• IE 10.0.0 (Windows 7)
• IE 9.0.0 (Windows 7)
• Opera 27.0.1689 (Mac OS X 10.10.1)
• PhantomJS 1.9.8 (Mac OS X)
• Safari 8.0.2 (Mac OS X 10.10.1)