refactor according to self review

WordPress · May 21, 2020 · 86b3a9e · 86b3a9e
1 parent 088ef48
commit 86b3a9e
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 13 deletions.
diff --git a/docs/designers-developers/developers/data/data-core.md b/docs/designers-developers/developers/data/data-core.md
@@ -473,7 +473,13 @@ _Returns_
 
 <a name="deleteEntityRecord" href="#deleteEntityRecord">#</a> **deleteEntityRecord**
 
-Undocumented declaration.
+Action triggered to delete an entity record.
+
+_Parameters_
+
+-   _kind_ `string`: Kind of the deleted entity.
+-   _name_ `string`: Name of the deleted entity.
+-   _recordId_ `Object`: Record to be deleted.
 
 <a name="editEntityRecord" href="#editEntityRecord">#</a> **editEntityRecord**
 
@@ -619,7 +625,18 @@ edit to an entity record, if any.
 
 <a name="removeItems" href="#removeItems">#</a> **removeItems**
 
-Undocumented declaration.
+Returns an action object used in signalling that entity records have been
+deleted and it needs to be removed from entities state.
+
+_Parameters_
+
+-   _kind_ `string`: Kind of the removed entity.
+-   _name_ `string`: Name of the removed entity.
+-   _records_ `(Array|Object)`: Records removed.
+
+_Returns_
+
+-   `Object`: Action object.
 
 <a name="saveEditedEntityRecord" href="#saveEditedEntityRecord">#</a> **saveEditedEntityRecord**
 

diff --git a/packages/core-data/README.md b/packages/core-data/README.md
@@ -56,7 +56,13 @@ _Returns_
 
 <a name="deleteEntityRecord" href="#deleteEntityRecord">#</a> **deleteEntityRecord**
 
-Undocumented declaration.
+Action triggered to delete an entity record.
+
+_Parameters_
+
+-   _kind_ `string`: Kind of the deleted entity.
+-   _name_ `string`: Name of the deleted entity.
+-   _recordId_ `Object`: Record to be deleted.
 
 <a name="editEntityRecord" href="#editEntityRecord">#</a> **editEntityRecord**
 
@@ -202,7 +208,18 @@ edit to an entity record, if any.
 
 <a name="removeItems" href="#removeItems">#</a> **removeItems**
 
-Undocumented declaration.
+Returns an action object used in signalling that entity records have been
+deleted and it needs to be removed from entities state.
+
+_Parameters_
+
+-   _kind_ `string`: Kind of the removed entity.
+-   _name_ `string`: Name of the removed entity.
+-   _records_ `(Array|Object)`: Records removed.
+
+_Returns_
+
+-   `Object`: Action object.
 
 <a name="saveEditedEntityRecord" href="#saveEditedEntityRecord">#</a> **saveEditedEntityRecord**
 

diff --git a/packages/core-data/src/actions.js b/packages/core-data/src/actions.js
@@ -94,6 +94,16 @@ export function receiveEntityRecords(
 	};
 }
 
+/**
+ * Returns an action object used in signalling that entity records have been
+ * deleted and it needs to be removed from entities state.
+ *
+ * @param {string}       kind            Kind of the removed entity.
+ * @param {string}       name            Name of the removed entity.
+ * @param {Array|Object} records         Records removed.
+ *
+ * @return {Object} Action object.
+ */
 export function removeItems( kind, name, records ) {
 	return {
 		type: 'REMOVE_ITEMS',
@@ -149,6 +159,13 @@ export function receiveEmbedPreview( url, preview ) {
 	};
 }
 
+/**
+ * Action triggered to delete an entity record.
+ *
+ * @param {string} kind      Kind of the deleted entity.
+ * @param {string} name      Name of the deleted entity.
+ * @param {Object} recordId  Record to be deleted.
+ */
 export function* deleteEntityRecord( kind, name, recordId ) {
 	const entities = yield getKindEntities( kind );
 	const entity = find( entities, { kind, name } );
@@ -162,6 +179,7 @@ export function* deleteEntityRecord( kind, name, recordId ) {
 		name,
 		recordId,
 	};
+
 	yield removeItems( kind, name, recordId );
 
 	let error;
@@ -484,7 +502,6 @@ export function* saveEntityRecord(
 				name,
 				recordId
 			);
-
 			yield receiveEntityRecords(
 				kind,
 				name,
@@ -498,7 +515,6 @@ export function* saveEntityRecord(
 				method: recordId ? 'PUT' : 'POST',
 				data,
 			} );
-
 			yield receiveEntityRecords(
 				kind,
 				name,

diff --git a/packages/core-data/src/queried-data/reducer.js b/packages/core-data/src/queried-data/reducer.js
@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-import { map, flowRight } from 'lodash';
+import { map, flowRight, omit } from 'lodash';
 
 /**
  * WordPress dependencies
@@ -83,10 +83,7 @@ function items( state = {}, action ) {
 				}, {} ),
 			};
 		case 'REMOVE_ITEMS':
-			const newState = { ...state };
-			for ( const id of action.items ) {
-				delete newState[ id ];
-			}
+			const newState = omit( state, action.items );
 			return newState;
 	}
 	return state;

diff --git a/packages/edit-navigation/src/components/menu-editor/use-navigation-blocks.js b/packages/edit-navigation/src/components/menu-editor/use-navigation-blocks.js
@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-import { groupBy, isEqual, difference, remove } from 'lodash';
+import { groupBy, isEqual, difference } from 'lodash';
 
 /**
  * WordPress dependencies
@@ -131,7 +131,6 @@ export default function useNavigationBlocks( menuId ) {
 		for ( const deletedClientId of deletedClientIds ) {
 			const menuItem = menuItemsRef.current[ deletedClientId ];
 			deleteMenuItem( menuItem.id );
-			remove( deletedClientIds, deletedClientId );
 		}
 
 		createSuccessNotice( __( 'Navigation saved.' ), {