adjust documentation to reflect reality

add missing setContext test
aweary · Mar 15, 2017 · 5dda4f8 · 5dda4f8
1 parent 9fc50dc
commit 5dda4f8
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 6 deletions.
diff --git a/docs/api/shallow.md b/docs/api/shallow.md
@@ -48,8 +48,8 @@ describe('<MyComponent />', () => {
 2. `options` (`Object` [optional]):
   - `options.context`: (`Object` [optional]): Context to be passed into the component
   - `options.disableLifecycleMethods`: (`Boolean` [optional]): If set to true, `componentDidMount`
-and `componentDidUpdate` are not called on the component. Allows `shallow` to be
-used when testing components that assume refs or DOM nodes are available during these methods
+is not called on the component, and `componentDidUpdate` is not called after
+[`setProps`](ShallowWrapper/setProps.md) and [`setContext`](ShallowWrapper/setContext.md).
 
 #### Returns
 

diff --git a/src/ShallowWrapper.js b/src/ShallowWrapper.js
@@ -71,7 +71,7 @@ function validateOptions(options) {
   const { lifecycleExperimental, disableLifecycleMethods } = options;
   if (
     typeof lifecycleExperimental !== 'undefined' &&
-    lifecycleExperimental !== !!lifecycleExperimental
+    typeof lifecycleExperimental !== 'boolean'
   ) {
     throw new Error(
       'lifecycleExperimental must be either true or false if provided',
@@ -80,7 +80,7 @@ function validateOptions(options) {
 
   if (
     typeof disableLifecycleMethods !== 'undefined' &&
-    disableLifecycleMethods !== !!disableLifecycleMethods
+    typeof disableLifecycleMethods !== 'boolean'
   ) {
     throw new Error(
       'disableLifecycleMethods must be either true or false if provided',

diff --git a/test/ShallowWrapper-spec.jsx b/test/ShallowWrapper-spec.jsx
@@ -2747,13 +2747,20 @@ describe('shallow', () => {
         }
       }
 
+      const options = {
+        disableLifecycleMethods: true,
+        context: {
+          foo: 'foo',
+        },
+      };
+
       beforeEach(() => {
-        wrapper = shallow(<Foo />, { disableLifecycleMethods: true });
+        wrapper = shallow(<Foo />, options);
         spy.reset();
       });
 
       it('does not call componentDidMount when mounting', () => {
-        wrapper = shallow(<Foo />, { disableLifecycleMethods: true });
+        wrapper = shallow(<Foo />, options);
         expect(spy.args).to.deep.equal([
           ['componentWillMount'],
           ['render'],
@@ -2770,6 +2777,15 @@ describe('shallow', () => {
         ]);
       });
 
+      it('calls expected methods when receiving new context', () => {
+        wrapper.setContext({ foo: 'foo' });
+        expect(spy.args).to.deep.equal([
+          ['shouldComponentUpdate'],
+          ['componentWillUpdate'],
+          ['render'],
+        ]);
+      });
+
       it('calls expected methods for setState', () => {
         wrapper.setState({ bar: 'bar' });
         expect(spy.args).to.deep.equal([