Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A wrapper around QUnit that has a similar style to RSpec

branch: master
README.markdown

SpecIt

There's some RSpec in your QUnit

Let's face it: QUnit is pretty awesome, but just doesn't seem to read correctly.

I don't have the patience to write my own JS testing framework so I figured I'd piggyback off of what QUnit provides.

Example

describe("SpecIt", function() {
  var john, cachedItems = [], something = false;

  before(function() {
    john = {name: "John Doe", age: 26};
  });

  after(function() {
    cachedItems = [];
  });

  it("should match on inclusion", function() {
    assert([1, 2]).should(include, 1, 2);
    assert({one: 1, two: 2}).should(include, "one");
    assert("string").should(include, "str");
    cachedItems.push(1);
    assert(cachedItems).should(include, 1);
  });

  it("should match by type comparison", function() {
    assert("string").should(beA, String);
    assert(function() {}).should(beA, Function);
    assert(true).should(beA, Boolean);
    assert({}).should(beAn, Object);
  });

  it("allows overriding variables", function() {
    john = {};
    assert(john).shouldNot(include, "name");
  });

  it("should use before blocks", function() {
    assert(john.name).should(eql, "John Doe");
    assert(john.age).should(beLessThan, 30);
  });

  it("should run after callbacks", function() {
    assert(cachedItems).should(beSimilarTo, []);
  });

  asyncIt("runs async tests correctly", function() {
    setTimeout(function() {
      something = true;
    }, 50);

    setTimeout(function() {
      assert(something).should(be);
      start();
    }, 100);
  });
});

Supported Matchers

  • include (checks presence within an object)
  • eql (checks equality with QUnit's equal)
  • beSimilarTo (checks equality with QUnit's deepEqual)
  • be (asserts true)
  • beA, beAn (checks type)
  • match (checks against a regular expression)
  • respondTo (checks that a function exists)
  • beLessThan (checks a number is less than another)
  • beLessThanOrEqualTo (checks a number is less than or equal to another)
  • beGreaterThan (checks a number is greater than another)
  • beGreaterThanOrEqualTo (checks a number is greater than or equal to another)
  • beEmpty (checks if an array, object literal, or string is empty)
  • beOnThePage (checks that an element is present on a page)
  • beToTheLeftOf (checks that an element is to the left of another element)
  • beToTheRightOf (checks that an element is to the right of another element)
  • beAbove (checks that an element is above another element)

Other supported features

  • Before callbacks
  • After callbacks

What's it do?

I wrote some matchers and used QUnit's module and test methods, that's all. The test file is a great form of documentation and demonstrates everything SpecIt can do currently.

Running the tests

Open test.html in your favorite web browser. Qunit is a git submodule, so you'll want to grab it first.

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Commit, do not mess with version or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright (c) 2010 Josh Clayton. Check the LICENSE for details.

Something went wrong with that request. Please try again.