Editor: withHistory: Add isIgnored callback option

aduth · aduth · commit caed8bf8f9c9 · 2018-09-17T14:46:30.000-04:00
diff --git a/packages/editor/src/utils/with-history/index.js b/packages/editor/src/utils/with-history/index.js
@@ -15,6 +15,7 @@ const DEFAULT_OPTIONS = {
 	resetTypes: [],
 	ignoreTypes: [],
 	shouldOverwriteState: () => false,
+	isIgnored: () => false,
 };
 
 /**
@@ -26,6 +27,9 @@ const DEFAULT_OPTIONS = {
  *                                                 clear past.
  * @param {?Array}    options.ignoreTypes          Action types upon which to
  *                                                 avoid history tracking.
+ * @param {?Function} options.isIgnored            Function given action, to
+ *                                                 return true if intended to
+ *                                                 avoid history tracking.
  * @param {?Function} options.shouldOverwriteState Function receiving last and
  *                                                 current actions, returning
  *                                                 boolean indicating whether
@@ -34,13 +38,14 @@ const DEFAULT_OPTIONS = {
  *
  * @return {Function} Higher-order reducer.
  */
-const withHistory = ( options = {} ) => ( reducer ) => {
+const withHistory = ( options ) => ( reducer ) => {
 	options = { ...DEFAULT_OPTIONS, ...options };
 
-	// `ignoreTypes` is simply a convenience for `shouldOverwriteState`
+	// `ignoreTypes`, `isIgnored` are conveniences for `shouldOverwriteState`
 	options.shouldOverwriteState = overSome( [
 		options.shouldOverwriteState,
 		( action ) => includes( options.ignoreTypes, action.type ),
+		( action ) => options.isIgnored( action ),
 	] );
 
 	const initialState = {
diff --git a/packages/editor/src/utils/with-history/test/index.js b/packages/editor/src/utils/with-history/test/index.js
@@ -131,6 +131,25 @@ describe( 'withHistory', () => {
 		} );
 	} );
 
+	it( 'should ignore history by options.isIgnored', () => {
+		const reducer = withHistory( {
+			isIgnored: ( action ) => action.type === 'INCREMENT',
+		} )( counter );
+
+		let state;
+		state = reducer( undefined, {} );
+		state = reducer( state, { type: 'INCREMENT' } );
+		state = reducer( state, { type: 'INCREMENT' } );
+
+		expect( state ).toEqual( {
+			past: [],
+			present: 2,
+			future: [],
+			lastAction: { type: 'INCREMENT' },
+			shouldCreateUndoLevel: false,
+		} );
+	} );
+
 	it( 'should return same reference if state has not changed', () => {
 		const reducer = withHistory()( counter );
 		const original = reducer( undefined, {} );
