Browse Source

refactor: renames called to isCalled

e22m4u 2 weeks ago
parent
commit
cd89381d38
6 changed files with 34 additions and 34 deletions
  1. 10 10
      README.md
  2. 1 1
      dist/cjs/index.cjs
  3. 4 4
      src/create-spies-group.spec.js
  4. 1 1
      src/create-spy.d.ts
  5. 2 2
      src/create-spy.js
  6. 16 16
      src/create-spy.spec.js

+ 10 - 10
README.md

@@ -14,7 +14,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.getCall(n)](#spygetcalln)
     - [spy.getCall(n)](#spygetcalln)
     - [spy.calledWith(...expectedArgs)](#spycalledwithexpectedargs)
     - [spy.calledWith(...expectedArgs)](#spycalledwithexpectedargs)
@@ -63,7 +63,7 @@ const greetSpy = createSpy(greet);
 greetSpy('World');
 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
 
 
 // аргументы вызова
 // аргументы вызова
@@ -118,7 +118,7 @@ console.log(calculator.value); // 8
 calculator.add(2, 1);
 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
 
 
 // аргументы вызова
 // аргументы вызова
@@ -204,7 +204,7 @@ console.log(loggerSpy.callCount);      // 1
 // восстановление всех шпионов в группе:
 // восстановление всех шпионов в группе:
 //   - оригинальные методы service.fetchData
 //   - оригинальные методы service.fetchData
 //     и service.processItem будут восстановлены
 //     и service.processItem будут восстановлены
-//   - история вызовов (callCount, called, getCall и т.д.)
+//   - история вызовов (callCount, isCalled, getCall и т.д.)
 //     для fetchDataSpy, processItemSpy и loggerSpy
 //     для fetchDataSpy, processItemSpy и loggerSpy
 //     будет сброшена
 //     будет сброшена
 //   - внутренний список шпионов в группе будет очищен
 //   - внутренний список шпионов в группе будет очищен
@@ -214,7 +214,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 (история сброшена)
 ```
 ```
 
 
@@ -296,16 +296,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
@@ -526,7 +526,7 @@ try {
 - Восстанавливает оригинальный метод, если шпион был создан
 - Восстанавливает оригинальный метод, если шпион был создан
   для метода объекта.
   для метода объекта.
 - Сбрасывает историю вызовов шпиона (`callCount` становится 0,
 - Сбрасывает историю вызовов шпиона (`callCount` становится 0,
-  `called` становится `false`, и все записи о вызовах очищаются).
+  `isCalled` становится `false`, и все записи о вызовах очищаются).
 - Если шпион был создан для отдельной функции (а не для метода объекта),
 - Если шпион был создан для отдельной функции (а не для метода объекта),
   восстановление метода не происходит (так как нечего восстанавливать),
   восстановление метода не происходит (так как нечего восстанавливать),
   но история вызовов все равно сбрасывается.
   но история вызовов все равно сбрасывается.
@@ -600,7 +600,7 @@ const obj = {greet: () => 'Hello'};
 const greetSpy = group.on(obj, 'greet');
 const greetSpy = group.on(obj, 'greet');
 // obj.greet теперь шпион, и greetSpy добавлен в группу
 // obj.greet теперь шпион, и greetSpy добавлен в группу
 obj.greet();
 obj.greet();
-console.log(greetSpy.called); // true
+console.log(greetSpy.isCalled); // true
 ```
 ```
 
 
 #### group.restore()
 #### group.restore()

+ 1 - 1
dist/cjs/index.cjs

@@ -135,7 +135,7 @@ function createSpy(target, methodNameOrImpl, customImplForMethod) {
     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

+ 4 - 4
src/create-spies-group.spec.js

@@ -118,13 +118,13 @@ describe('SpiesGroup', function () {
         expect(obj2.method()).to.equal('original2');
         expect(obj2.method()).to.equal('original2');
         // проверка сброса истории
         // проверка сброса истории
         expect(spyObj1.callCount).to.equal(0);
         expect(spyObj1.callCount).to.equal(0);
-        expect(spyObj1.called).to.be.false;
+        expect(spyObj1.isCalled).to.be.false;
         expect(spyFn1.callCount).to.equal(0);
         expect(spyFn1.callCount).to.equal(0);
-        expect(spyFn1.called).to.be.false;
+        expect(spyFn1.isCalled).to.be.false;
         expect(spyObj2.callCount).to.equal(0);
         expect(spyObj2.callCount).to.equal(0);
-        expect(spyObj2.called).to.be.false;
+        expect(spyObj2.isCalled).to.be.false;
         expect(spyFn2.callCount).to.equal(0);
         expect(spyFn2.callCount).to.equal(0);
-        expect(spyFn2.called).to.be.false;
+        expect(spyFn2.isCalled).to.be.false;
       });
       });
 
 
       it('should clear the internal spies array', function () {
       it('should clear the internal spies array', function () {

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

@@ -78,7 +78,7 @@ export interface Spy<TFunc extends AnyCallable = AnyCallable> {
    *
    *
    * @readonly
    * @readonly
    */
    */
-  readonly called: boolean;
+  readonly isCalled: boolean;
 
 
   /**
   /**
    * Получает детали n-го вызова шпиона.
    * Получает детали n-го вызова шпиона.

+ 2 - 2
src/create-spy.js

@@ -224,9 +224,9 @@ export function createSpy(target, methodNameOrImpl, customImplForMethod) {
     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,

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

@@ -89,8 +89,8 @@ 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 () {});
-      // первоначальное состояние свойства called
-      expect(spy.called).to.be.false;
+      // первоначальное состояние свойства isCalled
+      expect(spy.isCalled).to.be.false;
       // первоначальное значение счетчика вызовов
       // первоначальное значение счетчика вызовов
       expect(spy.callCount).to.equal(0);
       expect(spy.callCount).to.equal(0);
     });
     });
@@ -105,9 +105,9 @@ describe('createSpy', function () {
       // второй вызов шпиона
       // второй вызов шпиона
       spy(3, 4);
       spy(3, 4);
 
 
-      // состояние свойства called
+      // состояние свойства isCalled
       // после вызовов
       // после вызовов
-      expect(spy.called).to.be.true;
+      expect(spy.isCalled).to.be.true;
       // значение счетчика вызовов
       // значение счетчика вызовов
       expect(spy.callCount).to.equal(2);
       expect(spy.callCount).to.equal(2);
 
 
@@ -128,7 +128,7 @@ describe('createSpy', function () {
       // проверка возвращенного значения
       // проверка возвращенного значения
       expect(result).to.equal('original value');
       expect(result).to.equal('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 () {
@@ -143,8 +143,8 @@ describe('createSpy', function () {
       // проверка того, что возвращено значение
       // проверка того, что возвращено значение
       // из пользовательской реализации
       // из пользовательской реализации
       expect(result).to.equal('custom');
       expect(result).to.equal('custom');
-      // проверка свойства called
-      expect(spy.called).to.be.true;
+      // проверка свойства isCalled
+      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 () {
@@ -190,14 +190,14 @@ describe('createSpy', function () {
       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.equal(1);
       expect(fnSpy.callCount).to.equal(1);
       expect(fnSpy.getCall(0).args).to.deep.equal(['call standalone']);
       expect(fnSpy.getCall(0).args).to.deep.equal(['call standalone']);
       // проверка, что вызов restore не вызывает ошибок
       // проверка, что вызов restore не вызывает ошибок
       expect(() => fnSpy.restore()).to.not.throw();
       expect(() => fnSpy.restore()).to.not.throw();
       // проверки сброса истории
       // проверки сброса истории
       expect(fnSpy.callCount).to.equal(0);
       expect(fnSpy.callCount).to.equal(0);
-      expect(fnSpy.called).to.be.false;
+      expect(fnSpy.isCalled).to.be.false;
       expect(() => fnSpy.getCall(0)).to.throw(
       expect(() => fnSpy.getCall(0)).to.throw(
         RangeError,
         RangeError,
         'Invalid call index 0. Spy has 0 call(s).',
         'Invalid call index 0. Spy has 0 call(s).',
@@ -276,7 +276,7 @@ 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(spy.callCount).to.equal(1);
       expect(spy.callCount).to.equal(1);
       expect(obj.method).to.equal(spy);
       expect(obj.method).to.equal(spy);
       // вызов метода restore на шпионе
       // вызов метода restore на шпионе
@@ -290,7 +290,7 @@ describe('createSpy', function () {
       expect(result).to.equal('original: TestObj call after restore');
       expect(result).to.equal('original: TestObj call after restore');
       // проверки сброса истории
       // проверки сброса истории
       expect(spy.callCount).to.equal(0);
       expect(spy.callCount).to.equal(0);
-      expect(spy.called).to.be.false;
+      expect(spy.isCalled).to.be.false;
       expect(() => spy.getCall(0)).to.throw(
       expect(() => spy.getCall(0)).to.throw(
         RangeError,
         RangeError,
         'Invalid call index 0. Spy has 0 call(s).',
         'Invalid call index 0. Spy has 0 call(s).',
@@ -348,12 +348,12 @@ 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 () {
         // начальное состояние счетчика вызовов
         // начальное состояние счетчика вызовов
         expect(spy.callCount).to.equal(0);
         expect(spy.callCount).to.equal(0);
-        // начальное состояние флага called
-        expect(spy.called).to.be.false;
+        // начальное состояние флага isCalled
+        expect(spy.isCalled).to.be.false;
       });
       });
 
 
       it('should update after calls', function () {
       it('should update after calls', function () {
@@ -361,7 +361,7 @@ describe('createSpy', function () {
         spy(1, 1);
         spy(1, 1);
         // состояние после первого вызова
         // состояние после первого вызова
         expect(spy.callCount).to.equal(1);
         expect(spy.callCount).to.equal(1);
-        expect(spy.called).to.be.true;
+        expect(spy.isCalled).to.be.true;
         // второй вызов шпиона
         // второй вызов шпиона
         spy(2, 2);
         spy(2, 2);
         // состояние после второго вызова
         // состояние после второго вызова