Skip to content

Commit b75fbfa

Browse files
mroderickmroderick
committed
Fix 2448: remove custom formatter
Remove option to pass a custom formatter. The sub libraries of Sinon has long moved on to use `util.inspect` from Node. By using that in Sinon itself, we align all the libraries.
1 parent 49ef930 commit b75fbfa

6 files changed

Lines changed: 23 additions & 26 deletions

File tree

‎lib/sinon.js‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ var behavior = require("./sinon/behavior");
44
var createSandbox = require("./sinon/create-sandbox");
55
var extend = require("./sinon/util/core/extend");
66
var fakeTimers = require("./sinon/util/fake-timers");
7-
var format = require("./sinon/util/core/format");
87
var nise = require("nise");
98
var Sandbox = require("./sinon/sandbox");
109
var stub = require("./sinon/stub");
@@ -19,8 +18,6 @@ var apiMethods = {
1918
expectation: require("./sinon/mock-expectation"),
2019
defaultConfig: require("./sinon/util/core/default-config"),
2120

22-
setFormatter: format.setFormatter,
23-
2421
// fake timers
2522
timers: fakeTimers.timers,
2623

‎lib/sinon/assert.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ var calledInOrder = require("@sinonjs/commons").calledInOrder;
55
var createMatcher = require("@sinonjs/samsam").createMatcher;
66
var orderByFirstCall = require("@sinonjs/commons").orderByFirstCall;
77
var timesInWords = require("./util/core/times-in-words");
8-
var format = require("./util/core/format");
8+
var inspect = require("util").inspect;
99
var stringSlice = require("@sinonjs/commons").prototypes.string.slice;
1010
var globalObject = require("@sinonjs/commons").global;
1111

@@ -162,7 +162,7 @@ function createAssertObject() {
162162
var msg;
163163
if (typeof count !== "number") {
164164
msg =
165-
`expected ${format(count)} to be a number ` +
165+
`expected ${inspect(count)} to be a number ` +
166166
`but was of type ${typeof count}`;
167167
failAssertion(this, msg);
168168
} else if (method.callCount !== count) {
@@ -206,8 +206,8 @@ function createAssertObject() {
206206
} else {
207207
var formatted = [
208208
"expected value to match",
209-
` expected = ${format(expectation)}`,
210-
` actual = ${format(actual)}`,
209+
` expected = ${inspect(expectation)}`,
210+
` actual = ${inspect(actual)}`,
211211
];
212212

213213
failAssertion(this, join(formatted, "\n"));

‎lib/sinon/mock-expectation.js‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ var match = require("@sinonjs/samsam").createMatcher;
99
var stub = require("./stub");
1010
var assert = require("./assert");
1111
var deepEqual = require("@sinonjs/samsam").deepEqual;
12-
var format = require("./util/core/format");
12+
var inspect = require("util").inspect;
1313
var valueToString = require("@sinonjs/commons").valueToString;
1414

1515
var every = arrayProto.every;
@@ -166,17 +166,17 @@ var mockExpectation = {
166166

167167
if (!args) {
168168
mockExpectation.fail(
169-
`${this.method} received no arguments, expected ${format(
169+
`${this.method} received no arguments, expected ${inspect(
170170
expectedArguments
171171
)}`
172172
);
173173
}
174174

175175
if (args.length < expectedArguments.length) {
176176
mockExpectation.fail(
177-
`${this.method} received too few arguments (${format(
177+
`${this.method} received too few arguments (${inspect(
178178
args
179-
)}), expected ${format(expectedArguments)}`
179+
)}), expected ${inspect(expectedArguments)}`
180180
);
181181
}
182182

@@ -185,9 +185,9 @@ var mockExpectation = {
185185
args.length !== expectedArguments.length
186186
) {
187187
mockExpectation.fail(
188-
`${this.method} received too many arguments (${format(
188+
`${this.method} received too many arguments (${inspect(
189189
args
190-
)}), expected ${format(expectedArguments)}`
190+
)}), expected ${inspect(expectedArguments)}`
191191
);
192192
}
193193

@@ -196,17 +196,17 @@ var mockExpectation = {
196196
function (expectedArgument, i) {
197197
if (!verifyMatcher(expectedArgument, args[i])) {
198198
mockExpectation.fail(
199-
`${this.method} received wrong arguments ${format(
199+
`${this.method} received wrong arguments ${inspect(
200200
args
201201
)}, didn't match ${String(expectedArguments)}`
202202
);
203203
}
204204

205205
if (!deepEqual(args[i], expectedArgument)) {
206206
mockExpectation.fail(
207-
`${this.method} received wrong arguments ${format(
207+
`${this.method} received wrong arguments ${inspect(
208208
args
209-
)}, expected ${format(expectedArguments)}`
209+
)}, expected ${inspect(expectedArguments)}`
210210
);
211211
}
212212
},

‎lib/sinon/proxy-call.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ var arrayProto = require("@sinonjs/commons").prototypes.array;
44
var match = require("@sinonjs/samsam").createMatcher;
55
var deepEqual = require("@sinonjs/samsam").deepEqual;
66
var functionName = require("@sinonjs/commons").functionName;
7-
var sinonFormat = require("./util/core/format");
7+
var inspect = require("util").inspect;
88
var valueToString = require("@sinonjs/commons").valueToString;
99

1010
var concat = arrayProto.concat;
@@ -208,13 +208,13 @@ var callProto = {
208208
}
209209

210210
formattedArgs = map(this.args, function (arg) {
211-
return sinonFormat(arg);
211+
return inspect(arg);
212212
});
213213

214214
callStr = `${callStr + join(formattedArgs, ", ")})`;
215215

216216
if (typeof this.returnValue !== "undefined") {
217-
callStr += ` => ${sinonFormat(this.returnValue)}`;
217+
callStr += ` => ${inspect(this.returnValue)}`;
218218
}
219219

220220
if (this.exception) {

‎lib/sinon/proxy.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ var functionToString = require("./util/core/function-to-string");
66
var proxyCall = require("./proxy-call");
77
var proxyCallUtil = require("./proxy-call-util");
88
var proxyInvoke = require("./proxy-invoke");
9-
var sinonFormat = require("./util/core/format");
9+
var inspect = require("util").inspect;
1010

1111
var push = arrayProto.push;
1212
var forEach = arrayProto.forEach;
@@ -126,7 +126,7 @@ var proxyApi = {
126126
if (typeof formatter === "function") {
127127
return String(formatter(spyInstance, args));
128128
} else if (!isNaN(parseInt(specifier, 10))) {
129-
return sinonFormat(args[specifier - 1]);
129+
return inspect(args[specifier - 1]);
130130
}
131131

132132
return `%${specifier}`;

‎lib/sinon/spy-formatters.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ var arrayProto = require("@sinonjs/commons").prototypes.array;
44
var color = require("./color");
55
var match = require("@sinonjs/samsam").createMatcher;
66
var timesInWords = require("./util/core/times-in-words");
7-
var sinonFormat = require("./util/core/format");
7+
var inspect = require("util").inspect;
88
var jsDiff = require("diff");
99

1010
var join = arrayProto.join;
@@ -85,7 +85,7 @@ module.exports = {
8585
message += "\n";
8686

8787
var calledArgMessage =
88-
j < calledArgs.length ? sinonFormat(calledArg) : "";
88+
j < calledArgs.length ? inspect(calledArg) : "";
8989
if (match.isMatcher(expectedArg)) {
9090
message += colorSinonMatchText(
9191
expectedArg,
@@ -94,7 +94,7 @@ module.exports = {
9494
);
9595
} else {
9696
var expectedArgMessage =
97-
j < expectedArgs.length ? sinonFormat(expectedArg) : "";
97+
j < expectedArgs.length ? inspect(expectedArg) : "";
9898
var diff = jsDiff.diffJson(
9999
calledArgMessage,
100100
expectedArgMessage
@@ -126,7 +126,7 @@ module.exports = {
126126
var objects = [];
127127

128128
for (var i = 0, l = spyInstance.callCount; i < l; ++i) {
129-
push(objects, sinonFormat(spyInstance.thisValues[i]));
129+
push(objects, inspect(spyInstance.thisValues[i]));
130130
}
131131

132132
return join(objects, ", ");
@@ -135,7 +135,7 @@ module.exports = {
135135
"*": function (spyInstance, args) {
136136
return join(
137137
map(args, function (arg) {
138-
return sinonFormat(arg);
138+
return inspect(arg);
139139
}),
140140
", "
141141
);

0 commit comments

Comments
 (0)