Newton's Poleless Magnet
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    mimuspublic

    mimus Circle CI score-badge coverage-badge dependency-badge NPM version

    A stubbing library with a focus on having:

    • A simple API.
    • Dependency injection and auto stubbing.
    • A decoupled relationship with test runners.

    Note: Currently this project is using Sinon and Rewire. Check them out!

    Installation

    npm install mimus
    

    Usage

      var mimus = require('mimus')

    mimus.require

    This is the main method that you will use. It will require only the module you want to test against, while stubbing any specified internal modules, that can be retrieved with other methods.

    Require a stubbed db module and also stub the mongodb and zlib module.

      var db = mimus.require('./lib/db', __dirname, ['mongodb', 'zlib'])

    Why the whitelist approach?

    This way, unexpected clashes with mocking low level modules can be controlled by the user.

    mimus.get

    Get an internal variable.

    Uses rewire.__get__.

      mimus.get(required_module, 'internal_var_name')

    mimus.set

    Set an internal variable.

    Uses rewire.__set__.

      mimus.set(required_module, 'internal_var_name', 'value')

    mimus.stub

    Create a (Sinon.JS) stub.

      var stub = mimus.stub()
      stub.returns...

    mimus.spy

    Create a (Sinon.JS) spy.

      var spy = mimus.spy()

    mimus.reset

    Calls reset on every (Sinon.JS) stub/spy.

      mimus.reset()

    mimus.restore

    Calls restore on every (Sinon.JS) stub.

      mimus.restore()

    Examples

    See the system tests.

    Contributing

    Current list of contributors.

    Any contributions are welcome. Please consider tests and code quality before submitting.

    Code Of Conduct

    See bantik's contributor covenant!

    Issues

    Current issue tracker is on github.

    Please read any docs available before opening an issue.

    Hacking

    git clone git@github.com:brentlintner/mimus.git
    cd mimus
    npm install
    

    Testing

    npm run test
    npm run test-cov
    

    Code Quality

    npm run lint
    npm run lint-cov
    

    Auto Compiling CoffeeScript

    npm run dev &
    

    Architectural Notes

    The top level API's main goal is to be a one method level interface with the object returned via mimus.require being passed around by reference. This keeps api methods off of the main object, and also provides a more functional way to interact with mimus.

    Versioning

    This project ascribes to semantic versioning.

    Kudos!

    • Sinon is currently used underneath.
    • For dependency injection, Rewire is used.
    • Inspiration could not have happened with seeing Jest in action.

    Also, see all other deps.

    install

    npm i mimus

    Downloadsweekly downloads

    40

    version

    0.2.8

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar