Deprecate isEmpty() for exists() and update docs (#722)

book.json

@@ -8,7 +8,7 @@
   },
   "plugins": [
     "edit-link",
-    "prism",
+    "prism@2.0.0",
     "-highlight",
     "github",
     "-search",

docs/README.md

@@ -30,6 +30,7 @@
     * [equals(node)](/docs/api/ShallowWrapper/equals.md)
     * [every(selector)](/docs/api/ShallowWrapper/every.md)
     * [everyWhere(predicate)](/docs/api/ShallowWrapper/everyWhere.md)
+    * [exists()](/docs/api/ShallowWrapper/exists.md)
     * [filter(selector)](/docs/api/ShallowWrapper/filter.md)
     * [filterWhere(predicate)](/docs/api/ShallowWrapper/filterWhere.md)
     * [find(selector)](/docs/api/ShallowWrapper/find.md)
@@ -82,6 +83,7 @@
     * [debug()](/docs/api/ReactWrapper/debug.md)
     * [detach()](/docs/api/ReactWrapper/detach.md)
     * [every(selector)](/docs/api/ReactWrapper/every.md)
+    * [exists()](/docs/api/ReactWrapper/exists.md)
     * [everyWhere(predicate)](/docs/api/ReactWrapper/everyWhere.md)
     * [filter(selector)](/docs/api/ReactWrapper/filter.md)
     * [filterWhere(predicate)](/docs/api/ReactWrapper/filterWhere.md)

docs/api/ReactWrapper/exists.md

@@ -0,0 +1,18 @@
+# `.exists() => Boolean`
+
+Returns whether or not the current node exists.
+
+
+#### Returns
+
+`Boolean`: whether or not the current node exists.
+
+
+
+#### Example
+
+
+```jsx
+const wrapper = mount(<div className="some-class" />);
+expect(wrapper.find('.other-class').exists()).to.be(false);
+```

docs/api/ReactWrapper/isEmpty.md

@@ -1,4 +1,5 @@
 # `.isEmpty() => Boolean`
+**Deprecated**: Use [.exists()](exists.md) instead.
 
 Returns whether or not the current node is empty.
 

docs/api/ShallowWrapper/exists.md

@@ -0,0 +1,18 @@
+# `.exists() => Boolean`
+
+Returns whether or not the current node exists.
+
+
+#### Returns
+
+`Boolean`: whether or not the current node exists.
+
+
+
+#### Example
+
+
+```jsx
+const wrapper = shallow(<div className="some-class" />);
+expect(wrapper.find('.other-class').exists()).to.be(false);
+```

docs/api/ShallowWrapper/isEmpty.md

@@ -1,4 +1,5 @@
 # `.isEmpty() => Boolean`
+**Deprecated**: Use [.exists()](exists.md) instead.
 
 Returns whether or not the current node is empty.
 

docs/api/mount.md

@@ -89,8 +89,11 @@ Returns whether or not the current root node has the given class name or not.
 #### [`.is(selector) => Boolean`](ReactWrapper/is.md)
 Returns whether or not the current node matches a provided selector.
 
+#### [`.exists() => Boolean`](ReactWrapper/exists.md)
+Returns whether or not the current node exists.
+
 #### [`.isEmpty() => Boolean`](ReactWrapper/isEmpty.md)
-Returns whether or not the current node is empty.
+*Deprecated*: Use [.exists()](ReactWrapper/exists.md) instead.
 
 #### [`.not(selector) => ReactWrapper`](ReactWrapper/not.md)
 Remove nodes in the current wrapper that match the provided selector. (inverse of `.filter()`)

docs/api/shallow.md

@@ -91,8 +91,11 @@ Returns whether or not the current node has the given class name or not.
 #### [`.is(selector) => Boolean`](ShallowWrapper/is.md)
 Returns whether or not the current node matches a provided selector.
 
+#### [`.exists() => Boolean`](ShallowWrapper/exists.md)
+Returns whether or not the current node exists.
+
 #### [`.isEmpty() => Boolean`](ShallowWrapper/isEmpty.md)
-Returns whether or not the current node is empty.
+*Deprecated*: Use [.exists()](ShallowWrapper/exists.md) instead.
 
 #### [`.not(selector) => ShallowWrapper`](ShallowWrapper/not.md)
 Remove nodes in the current wrapper that match the provided selector. (inverse of `.filter()`)

src/ReactWrapper.jsx

@@ -885,12 +885,23 @@ class ReactWrapper {
   }
 
   /**
-   * Returns true if the current wrapper has no nodes. False otherwise.
+   * Delegates to exists()
    *
    * @returns {boolean}
    */
   isEmpty() {
-    return this.length === 0;
+    // eslint-disable-next-line no-console
+    console.warn('Enzyme::Deprecated method isEmpty() called, use exists() instead.');
+    return !this.exists();
+  }
+
+  /**
+   * Returns true if the current wrapper has nodes. False otherwise.
+   *
+   * @returns {boolean}
+   */
+  exists() {
+    return this.length > 0;
   }
 
   /**

src/ShallowWrapper.js

@@ -942,12 +942,23 @@ class ShallowWrapper {
   }
 
   /**
-   * Returns true if the current wrapper has no nodes. False otherwise.
+   * Delegates to exists()
    *
    * @returns {boolean}
    */
   isEmpty() {
-    return this.length === 0;
+    // eslint-disable-next-line no-console
+    console.warn('Enzyme::Deprecated method isEmpty() called, use exists() instead.');
+    return !this.exists();
+  }
+
+  /**
+   * Returns true if the current wrapper has nodes. False otherwise.
+   *
+   * @returns {boolean}
+   */
+  exists() {
+    return this.length > 0;
   }
 
   /**

test/ReactWrapper-spec.jsx

@@ -2464,12 +2464,47 @@ describeWithDOM('mount', () => {
   });
 
   describe('.isEmpty()', () => {
-    it('should return true iff wrapper is empty', () => {
+    let warningStub;
+    let fooNode;
+    let missingNode;
+
+    beforeEach(() => {
+      warningStub = sinon.stub(console, 'warn');
+      const wrapper = mount(
+        <div className="foo" />,
+      );
+      fooNode = wrapper.find('.foo');
+      missingNode = wrapper.find('.missing');
+    });
+    afterEach(() => {
+      warningStub.restore();
+    });
+
+    it('should display a deprecation warning', () => {
+      fooNode.isEmpty();
+      expect(warningStub.calledWith('Enzyme::Deprecated method isEmpty() called, use exists() instead.')).to.equal(true);
+    });
+
+    it('calls exists() instead', () => {
+      const existsSpy = sinon.spy();
+      fooNode.exists = existsSpy;
+      fooNode.isEmpty();
+      expect(existsSpy.called).to.equal(true);
+    });
+
+    it('should return true if wrapper is empty', () => {
+      expect(fooNode.isEmpty()).to.equal(false);
+      expect(missingNode.isEmpty()).to.equal(true);
+    });
+  });
+
+  describe('.exists()', () => {
+    it('should return true if node exists in wrapper', () => {
       const wrapper = mount(
         <div className="foo" />,
       );
-      expect(wrapper.find('.bar').isEmpty()).to.equal(true);
-      expect(wrapper.find('.foo').isEmpty()).to.equal(false);
+      expect(wrapper.find('.bar').exists()).to.equal(false);
+      expect(wrapper.find('.foo').exists()).to.equal(true);
     });
   });
 
@@ -3215,7 +3250,7 @@ describeWithDOM('mount', () => {
         const ref = wrapper.ref('not-a-ref');
 
         expect(ref.length).to.equal(0);
-        expect(ref.isEmpty()).to.equal(true);
+        expect(ref.exists()).to.equal(false);
       });
     });
   });

test/ShallowWrapper-spec.jsx

@@ -2474,12 +2474,47 @@ describe('shallow', () => {
   });
 
   describe('.isEmpty()', () => {
-    it('should return true iff wrapper is empty', () => {
+    let warningStub;
+    let fooNode;
+    let missingNode;
+
+    beforeEach(() => {
+      warningStub = sinon.stub(console, 'warn');
+      const wrapper = shallow(
+        <div className="foo" />,
+      );
+      fooNode = wrapper.find('.foo');
+      missingNode = wrapper.find('.missing');
+    });
+    afterEach(() => {
+      warningStub.restore();
+    });
+
+    it('should display a deprecation warning', () => {
+      fooNode.isEmpty();
+      expect(warningStub.calledWith('Enzyme::Deprecated method isEmpty() called, use exists() instead.')).to.equal(true);
+    });
+
+    it('calls exists() instead', () => {
+      const existsSpy = sinon.spy();
+      fooNode.exists = existsSpy;
+      fooNode.isEmpty();
+      expect(existsSpy.called).to.equal(true);
+    });
+
+    it('should return true if wrapper is empty', () => {
+      expect(fooNode.isEmpty()).to.equal(false);
+      expect(missingNode.isEmpty()).to.equal(true);
+    });
+  });
+
+  describe('.exists()', () => {
+    it('should return true if node exists in wrapper', () => {
       const wrapper = shallow(
         <div className="foo" />,
       );
-      expect(wrapper.find('.bar').isEmpty()).to.equal(true);
-      expect(wrapper.find('.foo').isEmpty()).to.equal(false);
+      expect(wrapper.find('.bar').exists()).to.equal(false);
+      expect(wrapper.find('.foo').exists()).to.equal(true);
     });
   });