[New] Debug: typeName now calls the adapter’s displayNameOfNode…

… if available
enzymejs · Jul 2, 2018 · c401fde · c401fde
1 parent e163a35
commit c401fde
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 19 deletions.
diff --git a/packages/enzyme-test-suite/package.json b/packages/enzyme-test-suite/package.json
@@ -33,6 +33,7 @@
     "enzyme": "^3.3.0",
     "enzyme-adapter-utils": "^1.3.0",
     "jsdom": "^6.5.1",
+    "mocha-wrap": "^2.1.2",
     "object.assign": "^4.1.0",
     "prop-types": "^15.6.0",
     "semver": "^5.5.0",

diff --git a/packages/enzyme-test-suite/test/Debug-spec.jsx b/packages/enzyme-test-suite/test/Debug-spec.jsx
@@ -1,5 +1,8 @@
 import { expect } from 'chai';
 import React from 'react';
+import wrap from 'mocha-wrap';
+import sinon from 'sinon';
+
 import { mount, shallow } from 'enzyme';
 import { get } from 'enzyme/build/configuration';
 import {
@@ -23,30 +26,56 @@ const { adapter } = get();
 const debugElement = element => debugNode(adapter.elementToNode(element));
 
 describe('debug', () => {
-  describe('typeName(node)', () => {
-    it('returns `.type` when not a function', () => {
-      const type = {};
-      expect(typeName({ type })).to.equal(type);
-    });
-
-    describe('when `.type` is a function', () => {
-      it('returns the function’s name', () => {
-        function Foo() {}
-        expect(typeName({ type: Foo })).to.equal('Foo');
+  wrap()
+    .withOverride(() => adapter, 'displayNameOfNode', () => undefined)
+    .describe('typeName(node)', () => {
+      it('returns `.type` when not a function', () => {
+        const type = {};
+        expect(typeName({ type })).to.equal(type);
       });
 
-      it('returns the function’s `.displayName` when present', () => {
-        function Foo() {}
-        Foo.displayName = 'Bar';
-        expect(typeName({ type: Foo })).to.equal('Bar');
+      describe('when `.type` is a function', () => {
+        it('returns the function’s name', () => {
+          function Foo() {}
+          expect(typeName({ type: Foo })).to.equal('Foo');
+        });
+
+        it('returns the function’s `.displayName` when present', () => {
+          function Foo() {}
+          Foo.displayName = 'Bar';
+          expect(typeName({ type: Foo })).to.equal('Bar');
+        });
+
+        it('returns "Component" when the function is anonymous', () => {
+          const anon = Object(() => {});
+          expect(typeName({ type: anon })).to.equal('Component');
+        });
       });
 
-      it('returns "Component" when the function is anonymous', () => {
-        const anon = Object(() => {});
-        expect(typeName({ type: anon })).to.equal('Component');
-      });
+      wrap()
+        .withOverride(() => adapter, 'displayNameOfNode', () => sinon.stub())
+        .describe('when the adapter has a `displayNameOfNode` function', () => {
+          it('calls it, and returns its return value', () => {
+            const stub = adapter.displayNameOfNode;
+            const sentinel = {};
+            stub.returns(sentinel);
+
+            const node = {};
+            expect(typeName(node)).to.equal(sentinel);
+
+            expect(stub).to.have.property('callCount', 1);
+            const { args } = stub.firstCall;
+            expect(args).to.eql([node]);
+          });
+
+          it('returns "Component" when `adapter.displayNameOfNode` returns something falsy', () => {
+            const stub = adapter.displayNameOfNode;
+            stub.returns('');
+
+            expect(typeName()).to.equal('Component');
+          });
+        });
     });
-  });
 
   describe('spaces(n)', () => {
     it('should return n spaces', () => {

diff --git a/packages/enzyme/src/Debug.js b/packages/enzyme/src/Debug.js
@@ -12,10 +12,15 @@ import {
   propsOfNode,
   childrenOfNode,
 } from './RSTTraversal';
+import { getAdapter } from './Utils';
 
 const booleanValue = Function.bind.call(Function.call, Boolean.prototype.valueOf);
 
 export function typeName(node) {
+  const adapter = getAdapter();
+  if (adapter.displayNameOfNode) {
+    return getAdapter().displayNameOfNode(node) || 'Component';
+  }
   return typeof node.type === 'function'
     ? (node.type.displayName || functionName(node.type) || 'Component')
     : node.type;