Browse Source

revert: renames spy.called to spy.isCalled

e22m4u 1 week ago
parent
commit
a0339d5237
7 changed files with 30 additions and 30 deletions
  1. 10 10
      README.md
  2. 2 2
      dist/cjs/index.cjs
  3. 1 1
      src/chai/chai-spies.js
  4. 2 2
      src/create-sandbox.spec.js
  5. 1 1
      src/create-spy.d.ts
  6. 2 2
      src/create-spy.js
  7. 12 12
      src/create-spy.spec.js

+ 10 - 10
README.md

@@ -17,7 +17,7 @@
   - [Свойства и методы шпиона](#свойства-и-методы-шпиона)
   - [Свойства и методы шпиона](#свойства-и-методы-шпиона)
     - [spy(...args)](#spyargs)
     - [spy(...args)](#spyargs)
     - [spy.calls](#spycalls)
     - [spy.calls](#spycalls)
-    - [spy.called](#spycalled)
+    - [spy.isCalled](#spyiscalled)
     - [spy.callCount](#spycallcount)
     - [spy.callCount](#spycallcount)
     - [spy.restore()](#spyrestore)
     - [spy.restore()](#spyrestore)
   - [Функция `createSandbox`](#функция-createsandbox)
   - [Функция `createSandbox`](#функция-createsandbox)
@@ -71,7 +71,7 @@ greetSpy('World');
 greetSpy('JavaScript');
 greetSpy('JavaScript');
 
 
 // количество вызовов
 // количество вызовов
-console.log(greetSpy.called);  // true
+console.log(greetSpy.isCalled);  // true
 console.log(greetSpy.callCount); // 2
 console.log(greetSpy.callCount); // 2
 
 
 // аргументы и возвращаемое значение первого вызова
 // аргументы и возвращаемое значение первого вызова
@@ -127,7 +127,7 @@ calculator.add(2, 1);
 console.log(calculator.value); // 3
 console.log(calculator.value); // 3
 
 
 // количество вызовов
 // количество вызовов
-console.log(addSpy.called);  // true
+console.log(addSpy.isCalled);  // true
 console.log(addSpy.callCount); // 2
 console.log(addSpy.callCount); // 2
 
 
 // аргументы и возвращаемое значение первого вызова
 // аргументы и возвращаемое значение первого вызова
@@ -213,7 +213,7 @@ console.log(loggerSpy.callCount);      // 1
 // восстановление всех шпионов песочницы:
 // восстановление всех шпионов песочницы:
 //   - оригинальные методы service.fetchData
 //   - оригинальные методы service.fetchData
 //     и service.processItem будут восстановлены
 //     и service.processItem будут восстановлены
-//   - история вызовов (callCount, called, calls и т.д.)
+//   - история вызовов (calls, callCount, isCalled и т.д.)
 //     для fetchDataSpy, processItemSpy и loggerSpy
 //     для fetchDataSpy, processItemSpy и loggerSpy
 //     будет сброшена
 //     будет сброшена
 //   - внутренний список шпионов песочницы будет очищен
 //   - внутренний список шпионов песочницы будет очищен
@@ -223,7 +223,7 @@ console.log(service.fetchData === fetchDataSpy);
 // false (оригинальный метод восстановлен)
 // false (оригинальный метод восстановлен)
 console.log(fetchDataSpy.callCount);
 console.log(fetchDataSpy.callCount);
 // 0 (история сброшена)
 // 0 (история сброшена)
-console.log(loggerSpy.called);
+console.log(loggerSpy.isCalled);
 // false (история сброшена)
 // false (история сброшена)
 ```
 ```
 
 
@@ -392,16 +392,16 @@ console.log(spy.calls);
 // ]
 // ]
 ```
 ```
 
 
-#### spy.called
+#### spy.isCalled
 
 
 - Тип: `boolean` (только для чтения)
 - Тип: `boolean` (только для чтения)
 - Описание: Указывает, был ли шпион вызван хотя бы один раз.
 - Описание: Указывает, был ли шпион вызван хотя бы один раз.
 
 
 ```js
 ```js
 const spy = createSpy();
 const spy = createSpy();
-console.log(spy.called); // false
+console.log(spy.isCalled); // false
 spy();
 spy();
-console.log(spy.called); // true
+console.log(spy.isCalled); // true
 ```
 ```
 
 
 #### spy.callCount
 #### spy.callCount
@@ -424,7 +424,7 @@ console.log(spy.callCount); // 2
 - Восстанавливает оригинальный метод, если шпион был создан
 - Восстанавливает оригинальный метод, если шпион был создан
   для метода объекта.
   для метода объекта.
 - Сбрасывает историю вызовов шпиона (`callCount` становится 0,
 - Сбрасывает историю вызовов шпиона (`callCount` становится 0,
-  `called` становится `false`, и все записи о вызовах очищаются).
+  `isCalled` становится `false`, и все записи о вызовах очищаются).
 - Если шпион был создан для отдельной функции (а не для метода объекта),
 - Если шпион был создан для отдельной функции (а не для метода объекта),
   восстановление метода не происходит (так как нечего восстанавливать),
   восстановление метода не происходит (так как нечего восстанавливать),
   но история вызовов все равно сбрасывается.
   но история вызовов все равно сбрасывается.
@@ -497,7 +497,7 @@ const obj = {greet: () => 'Hello'};
 const greetSpy = sandbox.on(obj, 'greet');
 const greetSpy = sandbox.on(obj, 'greet');
 // obj.greet теперь шпион, и greetSpy добавлен в песочницу
 // obj.greet теперь шпион, и greetSpy добавлен в песочницу
 obj.greet();
 obj.greet();
-console.log(greetSpy.called); // true
+console.log(greetSpy.isCalled); // true
 ```
 ```
 
 
 #### sandbox.restore()
 #### sandbox.restore()

+ 2 - 2
dist/cjs/index.cjs

@@ -52,7 +52,7 @@ function chaiSpies(chai, _) {
       );
       );
     } else {
     } else {
       this.assert(
       this.assert(
-        spy.called === true,
+        spy.isCalled === true,
         "expected " + this._obj + " to have been called",
         "expected " + this._obj + " to have been called",
         "expected " + this._obj + " to not have been called"
         "expected " + this._obj + " to not have been called"
       );
       );
@@ -387,7 +387,7 @@ function createSpy(target = void 0, methodNameOrImpl = void 0, customImplForMeth
     enumerable: true,
     enumerable: true,
     configurable: false
     configurable: false
   });
   });
-  Object.defineProperty(spy, "called", {
+  Object.defineProperty(spy, "isCalled", {
     get: /* @__PURE__ */ __name(() => callLog.count > 0, "get"),
     get: /* @__PURE__ */ __name(() => callLog.count > 0, "get"),
     enumerable: true,
     enumerable: true,
     configurable: false
     configurable: false

+ 1 - 1
src/chai/chai-spies.js

@@ -32,7 +32,7 @@ export function chaiSpies(chai, _) {
       );
       );
     } else {
     } else {
       this.assert(
       this.assert(
-          spy.called === true
+          spy.isCalled === true
         , 'expected ' + this._obj + ' to have been called'
         , 'expected ' + this._obj + ' to have been called'
         , 'expected ' + this._obj + ' to not have been called'
         , 'expected ' + this._obj + ' to not have been called'
       );
       );

+ 2 - 2
src/create-sandbox.spec.js

@@ -88,10 +88,10 @@ describe('Sandbox', function () {
         const fn = () => {};
         const fn = () => {};
         const spy = sandbox.on(fn);
         const spy = sandbox.on(fn);
         spy();
         spy();
-        expect(spy.called).to.be.true;
+        expect(spy.isCalled).to.be.true;
         expect(spy.callCount).to.equal(1);
         expect(spy.callCount).to.equal(1);
         sandbox.restore();
         sandbox.restore();
-        expect(spy.called).to.be.false;
+        expect(spy.isCalled).to.be.false;
         expect(spy.callCount).to.equal(0);
         expect(spy.callCount).to.equal(0);
       });
       });
 
 

+ 1 - 1
src/create-spy.d.ts

@@ -66,7 +66,7 @@ export interface Spy<TFunc extends AnyCallable = AnyCallable> {
    *
    *
    * @readonly
    * @readonly
    */
    */
-  readonly called: boolean;
+  readonly isCalled: boolean;
 
 
   /**
   /**
    * Восстанавливает оригинальный метод,
    * Восстанавливает оригинальный метод,

+ 2 - 2
src/create-spy.js

@@ -235,9 +235,9 @@ export function createSpy(
     enumerable: true,
     enumerable: true,
     configurable: false,
     configurable: false,
   });
   });
-  // определение свойства `called` на шпионе,
+  // определение свойства `isCalled` на шпионе,
   // указывающего, был ли шпион вызван
   // указывающего, был ли шпион вызван
-  Object.defineProperty(spy, 'called', {
+  Object.defineProperty(spy, 'isCalled', {
     get: () => callLog.count > 0,
     get: () => callLog.count > 0,
     enumerable: true,
     enumerable: true,
     configurable: false,
     configurable: false,

+ 12 - 12
src/create-spy.spec.js

@@ -74,7 +74,7 @@ describe('createSpy', function () {
 
 
     it('should not be called initially', function () {
     it('should not be called initially', function () {
       const spy = createSpy(function () {});
       const spy = createSpy(function () {});
-      expect(spy.called).to.be.false;
+      expect(spy.isCalled).to.be.false;
       expect(spy.callCount).to.be.eq(0);
       expect(spy.callCount).to.be.eq(0);
     });
     });
 
 
@@ -83,7 +83,7 @@ describe('createSpy', function () {
       const spy = createSpy(sum);
       const spy = createSpy(sum);
       spy(1, 2);
       spy(1, 2);
       spy(3, 4);
       spy(3, 4);
-      expect(spy.called).to.be.true;
+      expect(spy.isCalled).to.be.true;
       expect(spy.callCount).to.be.eq(2);
       expect(spy.callCount).to.be.eq(2);
       expect(spy.calls[0].args).to.deep.equal([1, 2]);
       expect(spy.calls[0].args).to.deep.equal([1, 2]);
       expect(spy.calls[1].args).to.deep.equal([3, 4]);
       expect(spy.calls[1].args).to.deep.equal([3, 4]);
@@ -94,7 +94,7 @@ describe('createSpy', function () {
       const spy = createSpy(originalFn);
       const spy = createSpy(originalFn);
       const result = spy();
       const result = spy();
       expect(result).to.be.eq('original value');
       expect(result).to.be.eq('original value');
-      expect(spy.called).to.be.true;
+      expect(spy.isCalled).to.be.true;
     });
     });
 
 
     it('should use the custom implementation if provided', function () {
     it('should use the custom implementation if provided', function () {
@@ -103,7 +103,7 @@ describe('createSpy', function () {
       const spy = createSpy(originalFn, customImpl);
       const spy = createSpy(originalFn, customImpl);
       const result = spy();
       const result = spy();
       expect(result).to.be.eq('custom');
       expect(result).to.be.eq('custom');
-      expect(spy.called).to.be.true;
+      expect(spy.isCalled).to.be.true;
     });
     });
 
 
     it('should preserve `this` context for the original function', function () {
     it('should preserve `this` context for the original function', function () {
@@ -134,11 +134,11 @@ describe('createSpy', function () {
         const standaloneFn = () => 'standalone result';
         const standaloneFn = () => 'standalone result';
         const fnSpy = createSpy(standaloneFn);
         const fnSpy = createSpy(standaloneFn);
         fnSpy('call standalone');
         fnSpy('call standalone');
-        expect(fnSpy.called).to.be.true;
+        expect(fnSpy.isCalled).to.be.true;
         expect(fnSpy.callCount).to.be.eq(1);
         expect(fnSpy.callCount).to.be.eq(1);
         expect(() => fnSpy.restore()).to.not.throw();
         expect(() => fnSpy.restore()).to.not.throw();
         expect(fnSpy.callCount).to.be.eq(0);
         expect(fnSpy.callCount).to.be.eq(0);
-        expect(fnSpy.called).to.be.false;
+        expect(fnSpy.isCalled).to.be.false;
       });
       });
     });
     });
   });
   });
@@ -193,14 +193,14 @@ describe('createSpy', function () {
         };
         };
         const spy = createSpy(obj, 'method');
         const spy = createSpy(obj, 'method');
         obj.method('call before restore');
         obj.method('call before restore');
-        expect(spy.called).to.be.true;
+        expect(spy.isCalled).to.be.true;
         expect(obj.method).to.be.eq(spy);
         expect(obj.method).to.be.eq(spy);
         spy.restore();
         spy.restore();
         expect(obj.method).to.be.eq(originalMethodImpl);
         expect(obj.method).to.be.eq(originalMethodImpl);
         const result = obj.method('call after restore');
         const result = obj.method('call after restore');
         expect(result).to.be.eq('original: TestObj call after restore');
         expect(result).to.be.eq('original: TestObj call after restore');
         expect(spy.callCount).to.be.eq(0);
         expect(spy.callCount).to.be.eq(0);
-        expect(spy.called).to.be.false;
+        expect(spy.isCalled).to.be.false;
       });
       });
 
 
       it('should restore an "own" property by assigning the original value back', function () {
       it('should restore an "own" property by assigning the original value back', function () {
@@ -266,18 +266,18 @@ describe('createSpy', function () {
       });
       });
     });
     });
 
 
-    describe('.callCount and .called', function () {
-      it('should have callCount = 0 and called = false initially', function () {
+    describe('.callCount and .isCalled', function () {
+      it('should have callCount = 0 and isCalled = false initially', function () {
         const spy = createSpy(() => {});
         const spy = createSpy(() => {});
         expect(spy.callCount).to.be.eq(0);
         expect(spy.callCount).to.be.eq(0);
-        expect(spy.called).to.be.false;
+        expect(spy.isCalled).to.be.false;
       });
       });
 
 
       it('should update after calls', function () {
       it('should update after calls', function () {
         const spy = createSpy(() => {});
         const spy = createSpy(() => {});
         spy(1, 1);
         spy(1, 1);
         expect(spy.callCount).to.be.eq(1);
         expect(spy.callCount).to.be.eq(1);
-        expect(spy.called).to.be.true;
+        expect(spy.isCalled).to.be.true;
         spy(2, 2);
         spy(2, 2);
         expect(spy.callCount).to.be.eq(2);
         expect(spy.callCount).to.be.eq(2);
       });
       });