Added `usingPromise` method to stub. by blacksun1 · Pull Request #1364 · sinonjs/sinon

blacksun1 · 2017-03-24T02:01:44Z

In progress

Things to still be done:

Get agreement on implementation
Add .usingPromise to higher level objects such as sandbox
Add documentation

Purpose

The usingPromise method allows the setting of the promise library
that will be used by the resolve and reject method. If it is not set then it will use the default promise implementation by default.

This will eventually fix #1354

Background

To allow the setting of a custom promise library when creating a stub that resolves or rejects. Sometimes you need to get back a custom promise library to have access to it's extended methods and so on, such as .tap, .done etc.

Solution

Add a .usingPromise method that sets the promise library to use.

Example using sinon.stub():

var assert = require("assert");
var bluebird = require("bluebird");
var sinon = require("sinon");

var myObject = {};
var myStub = sinon.stub()
    .usingPromise(bluebird.Promise)
    .resolves(myObject);

myStub()
    // Tap should now be available!!!
    .tap(function(actual) {
        assert.strictEqual(actual, myObject);
    })
    .catch(function(err) {
        console.err("Error", err);
    });

Example using sinon.sandbox():

var assert = require("assert");
var bluebird = require("bluebird");
var sinon = require("sinon");

var myObject = {
  myMethod: function() { return; }
};

var sandbox = sinon.sandbox.create()

sandbox.stub(myObject);

myObject.myMethod
    .usingPromise(bluebird.Promise)
    .resolves("baz");

myObject.myMethod()
    // Tap should now be available!!!
    .tap(function(actual) {
        assert.strictEqual(actual, "baz");
    });

How to verify

Check out this branch (see github instructions below)
npm install
npm test

coveralls · 2017-03-24T02:03:17Z

Coverage increased (+0.003%) to 95.375% when pulling 4601eb2 on blacksun1:add-custom-promise into f701abe on sinonjs:master.

mantoni · 2017-03-27T07:07:11Z

Nice work. I'm not so sure about the name setPromise, because you're not setting a promise instance but rather the type of promise to use. Alternatives that I can think of are usesPromise or usingPromise or returnsPromise. I'm not using promises myself, so I'm not the best to make a decision here.

blacksun1 · 2017-03-27T07:36:49Z

I would prefer usePromise or usingPromise. usesPromise sounds like something in the past.

fatso83 · 2017-03-27T19:36:05Z

I'd go for usingPromise (or something like that - no hard feelings on this matter).

coveralls · 2017-03-28T01:12:21Z

Coverage increased (+0.01%) to 95.382% when pulling cccc574 on blacksun1:add-custom-promise into f701abe on sinonjs:master.

blacksun1 · 2017-03-28T01:14:53Z

@fatso83, @mantoni

blacksun1 · 2017-03-28T01:16:04Z

If I have agreement then I will continue with the rest of the implementation this week when I have some "free time" - meaning I steal some time from somewhere else. ;)

mantoni · 2017-03-28T06:08:53Z

@blacksun1 Sure, usingPromise sounds good. We all steal our time elsewhere 🍻

coveralls · 2017-03-28T16:57:07Z

Coverage increased (+0.02%) to 95.388% when pulling fde9c1c on blacksun1:add-custom-promise into f701abe on sinonjs:master.

mantoni

LGTM

coveralls · 2017-03-28T21:09:10Z

Coverage increased (+0.01%) to 95.388% when pulling 8e0e191 on blacksun1:add-custom-promise into c5bc9ab on sinonjs:master.

blacksun1 · 2017-03-28T21:48:43Z

Any idea where I should put the documentation for the feature?

mantoni · 2017-03-29T06:51:39Z

Please put documentation into the docs folder (https://github.com/sinonjs/sinon/tree/master/docs). The README and the CONTRIBUTING files in there explain how to work with it.

coveralls · 2017-04-05T13:36:59Z

Coverage increased (+0.01%) to 95.388% when pulling 249f818 on blacksun1:add-custom-promise into c5bc9ab on sinonjs:master.

blacksun1 · 2017-04-05T13:37:23Z

Docs added. @mantoni @fatso83

The `usingPromise` method allows the setting of the promise library that will be used by the resolve and reject method. If it is not set then it will use the default promise implementation by default. Example: ```js var assert = require("assert"); var bluebird = require("bluebird"); var sinon = require("sinon"); var myObject = {}; var myStub = sinon.stub() .usingPromise(bluebird.Promise) .resolves(myObject); myStub() // Tap should now be available!!! .tap(function(actual) { assert.strictEqual(actual, myObject); }) .catch(function(err) { console.err("Error", err); }) ``` Documentation still to come.

The `usingPromise` method allows the setting of the promise library that will be used by the resolve and reject method. If it is not set then it will use the default promise implementation by default. Example: ```js var assert = require("assert"); var bluebird = require("bluebird"); var sinon = require("sinon"); var myObject = { myMethod: function() { return; } }; var sandbox = sinon.sandbox.create() sandbox.stub(myObject); myObject.myMethod .usingPromise(bluebird.Promise) .resolves("baz"); myObject.myMethod() // Tap should now be available!!! .tap(function(actual) { assert.strictEqual(actual, "baz"); }); ``` Documentation still to come.

coveralls · 2017-04-05T17:58:28Z

Coverage increased (+0.01%) to 95.388% when pulling 25bfde0 on blacksun1:add-custom-promise into c5bc9ab on sinonjs:master.

fearphage · 2017-04-06T12:08:12Z

+            var stub = createStub.create();
+
+            assert(stub.usingPromise);
+            assert.isTrue(typeof stub.usingPromise === "function");


assert.isFunction

jrnail23 · 2017-04-06T17:25:33Z

I just wanted to say thanks for doing this, @blacksun1. This should fill the gap left by obsolescing sinon-as-promised which left us without a way to plug bluebird in, and thus preventing us from upgrading to sinon v2.x 😄

coveralls · 2017-04-07T00:19:03Z

Coverage increased (+0.01%) to 95.388% when pulling 7ac4f60 on blacksun1:add-custom-promise into c5bc9ab on sinonjs:master.

fatso83 · 2017-04-10T10:20:42Z

Never mind my issue comment - found out I could review and merge this using even an old-skool cell phone :-) Thanks!

mroderick · 2017-05-02T08:01:59Z

sinon@2.2.0 is now on npm

blacksun1 mentioned this pull request Mar 24, 2017

Enhancement: Add ability to override global promise library #1354

Closed

blacksun1 changed the title ~~Added setPromise method to stub.~~ Added usingPromise method to stub. Mar 28, 2017

mantoni approved these changes Mar 28, 2017

View reviewed changes

blacksun1 force-pushed the add-custom-promise branch from fde9c1c to 8e0e191 Compare March 28, 2017 21:07

blacksun1 and others added 3 commits April 6, 2017 03:24

Added docs for usingPromise

25bfde0

blacksun1 force-pushed the add-custom-promise branch from 249f818 to 25bfde0 Compare April 5, 2017 17:56

fearphage reviewed Apr 6, 2017

View reviewed changes

Fixes for pull request comments

7ac4f60

fearphage approved these changes Apr 7, 2017

View reviewed changes

fatso83 approved these changes Apr 10, 2017

View reviewed changes

fatso83 merged commit 3d4bc16 into sinonjs:master Apr 10, 2017

mroderick added the semver:minor changes will cause a new minor version label May 2, 2017

blacksun1 deleted the add-custom-promise branch September 5, 2022 08:22

Uh oh!

Conversation

blacksun1 commented Mar 24, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

In progress

Purpose

Background

Solution

How to verify

Uh oh!

coveralls commented Mar 24, 2017

Uh oh!

mantoni commented Mar 27, 2017

Uh oh!

blacksun1 commented Mar 27, 2017

Uh oh!

fatso83 commented Mar 27, 2017

Uh oh!

coveralls commented Mar 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

blacksun1 commented Mar 28, 2017

Uh oh!

blacksun1 commented Mar 28, 2017

Uh oh!

mantoni commented Mar 28, 2017

Uh oh!

coveralls commented Mar 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mantoni left a comment

Choose a reason for hiding this comment

Uh oh!

coveralls commented Mar 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

blacksun1 commented Mar 28, 2017

Uh oh!

mantoni commented Mar 29, 2017

Uh oh!

coveralls commented Apr 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

blacksun1 commented Apr 5, 2017

Uh oh!

coveralls commented Apr 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fearphage Apr 6, 2017

Choose a reason for hiding this comment

Uh oh!

blacksun1 Apr 7, 2017

Choose a reason for hiding this comment

Uh oh!

jrnail23 commented Apr 6, 2017

Uh oh!

coveralls commented Apr 7, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fatso83 commented Apr 10, 2017

Uh oh!

mroderick commented May 2, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

blacksun1 commented Mar 24, 2017 •

edited

Loading

coveralls commented Mar 28, 2017 •

edited

Loading

coveralls commented Mar 28, 2017 •

edited

Loading

coveralls commented Mar 28, 2017 •

edited

Loading

coveralls commented Apr 5, 2017 •

edited

Loading

coveralls commented Apr 5, 2017 •

edited

Loading

coveralls commented Apr 7, 2017 •

edited

Loading