From 4de4e05829c2341276438cd5bf1bfbe2126dc247 Mon Sep 17 00:00:00 2001 From: Philipp Stracker Date: Tue, 21 Jan 2025 15:33:03 +0100 Subject: [PATCH] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Rename=20reducer=20methods?= =?UTF-8?q?=20for=20better=20clarity?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../resources/js/data/_example/reducer.js | 14 +++++++------- .../resources/js/data/common/reducer.js | 18 +++++++++--------- .../resources/js/data/onboarding/reducer.js | 16 ++++++++-------- .../resources/js/data/payment/reducer.js | 14 +++++++------- .../resources/js/data/settings-tab/reducer.js | 14 +++++++------- .../resources/js/data/styling/reducer.js | 14 +++++++------- .../ppcp-settings/resources/js/data/utils.js | 8 ++++---- 7 files changed, 49 insertions(+), 49 deletions(-) diff --git a/modules/ppcp-settings/resources/js/data/_example/reducer.js b/modules/ppcp-settings/resources/js/data/_example/reducer.js index a858b719a..b4c451645 100644 --- a/modules/ppcp-settings/resources/js/data/_example/reducer.js +++ b/modules/ppcp-settings/resources/js/data/_example/reducer.js @@ -7,7 +7,7 @@ * @file */ -import { createReducer, createSetters } from '../utils'; +import { createReducer, createReducerSetters } from '../utils'; import ACTION_TYPES from './action-types'; // Store structure. @@ -25,21 +25,21 @@ const defaultPersistent = Object.freeze( { // Reducer logic. -const [ setTransient, setPersistent ] = createSetters( +const [ changeTransient, changePersistent ] = createReducerSetters( defaultTransient, defaultPersistent ); const reducer = createReducer( defaultTransient, defaultPersistent, { [ ACTION_TYPES.SET_TRANSIENT ]: ( state, payload ) => - setTransient( state, payload ), + changeTransient( state, payload ), [ ACTION_TYPES.SET_PERSISTENT ]: ( state, payload ) => - setPersistent( state, payload ), + changePersistent( state, payload ), [ ACTION_TYPES.RESET ]: ( state ) => { - const cleanState = setTransient( - setPersistent( state, defaultPersistent ), + const cleanState = changeTransient( + changePersistent( state, defaultPersistent ), defaultTransient ); @@ -50,7 +50,7 @@ const reducer = createReducer( defaultTransient, defaultPersistent, { }, [ ACTION_TYPES.HYDRATE ]: ( state, payload ) => - setPersistent( state, payload.data ), + changePersistent( state, payload.data ), } ); export default reducer; diff --git a/modules/ppcp-settings/resources/js/data/common/reducer.js b/modules/ppcp-settings/resources/js/data/common/reducer.js index 559024728..78f38cb3b 100644 --- a/modules/ppcp-settings/resources/js/data/common/reducer.js +++ b/modules/ppcp-settings/resources/js/data/common/reducer.js @@ -7,7 +7,7 @@ * @file */ -import { createReducer, createSetters } from '../utils'; +import { createReducer, createReducerSetters } from '../utils'; import ACTION_TYPES from './action-types'; // Store structure. @@ -57,21 +57,21 @@ const defaultPersistent = Object.freeze( { // Reducer logic. -const [ setTransient, setPersistent ] = createSetters( +const [ changeTransient, changePersistent ] = createReducerSetters( defaultTransient, defaultPersistent ); const commonReducer = createReducer( defaultTransient, defaultPersistent, { [ ACTION_TYPES.SET_TRANSIENT ]: ( state, action ) => - setTransient( state, action ), + changeTransient( state, action ), [ ACTION_TYPES.SET_PERSISTENT ]: ( state, action ) => - setPersistent( state, action ), + changePersistent( state, action ), [ ACTION_TYPES.RESET ]: ( state ) => { - const cleanState = setTransient( - setPersistent( state, defaultPersistent ), + const cleanState = changeTransient( + changePersistent( state, defaultPersistent ), defaultTransient ); @@ -85,7 +85,7 @@ const commonReducer = createReducer( defaultTransient, defaultPersistent, { }, [ ACTION_TYPES.START_ACTIVITY ]: ( state, payload ) => { - return setTransient( state, { + return changeTransient( state, { activities: new Map( state.activities ).set( payload.id, payload.description @@ -96,7 +96,7 @@ const commonReducer = createReducer( defaultTransient, defaultPersistent, { [ ACTION_TYPES.STOP_ACTIVITY ]: ( state, payload ) => { const newActivities = new Map( state.activities ); newActivities.delete( payload.id ); - return setTransient( state, { activities: newActivities } ); + return changeTransient( state, { activities: newActivities } ); }, [ ACTION_TYPES.DO_REFRESH_MERCHANT ]: ( state ) => ( { @@ -106,7 +106,7 @@ const commonReducer = createReducer( defaultTransient, defaultPersistent, { } ), [ ACTION_TYPES.HYDRATE ]: ( state, payload ) => { - const newState = setPersistent( state, payload.data ); + const newState = changePersistent( state, payload.data ); // Populate read-only properties. [ 'wooSettings', 'merchant', 'features', 'webhooks' ].forEach( diff --git a/modules/ppcp-settings/resources/js/data/onboarding/reducer.js b/modules/ppcp-settings/resources/js/data/onboarding/reducer.js index 8d03f9fbf..cec0629ed 100644 --- a/modules/ppcp-settings/resources/js/data/onboarding/reducer.js +++ b/modules/ppcp-settings/resources/js/data/onboarding/reducer.js @@ -7,7 +7,7 @@ * @file */ -import { createReducer, createSetters } from '../utils'; +import { createReducer, createReducerSetters } from '../utils'; import ACTION_TYPES from './action-types'; // Store structure. @@ -36,21 +36,21 @@ const defaultPersistent = Object.freeze( { // Reducer logic. -const [ setTransient, setPersistent ] = createSetters( +const [ changeTransient, changePersistent ] = createReducerSetters( defaultTransient, defaultPersistent ); const onboardingReducer = createReducer( defaultTransient, defaultPersistent, { [ ACTION_TYPES.SET_TRANSIENT ]: ( state, payload ) => - setTransient( state, payload ), + changeTransient( state, payload ), [ ACTION_TYPES.SET_PERSISTENT ]: ( state, payload ) => - setPersistent( state, payload ), + changePersistent( state, payload ), [ ACTION_TYPES.RESET ]: ( state ) => { - const cleanState = setTransient( - setPersistent( state, defaultPersistent ), + const cleanState = changeTransient( + changePersistent( state, defaultPersistent ), defaultTransient ); @@ -62,9 +62,9 @@ const onboardingReducer = createReducer( defaultTransient, defaultPersistent, { }, [ ACTION_TYPES.HYDRATE ]: ( state, payload ) => { - const newState = setPersistent( state, payload.data ); + const newState = changePersistent( state, payload.data ); - // Flags are not updated by `setPersistent()`. + // Flags are not updated by `changePersistent()`. if ( payload.flags ) { newState.flags = Object.freeze( { ...newState.flags, diff --git a/modules/ppcp-settings/resources/js/data/payment/reducer.js b/modules/ppcp-settings/resources/js/data/payment/reducer.js index 4894c9996..3bfa6dc84 100644 --- a/modules/ppcp-settings/resources/js/data/payment/reducer.js +++ b/modules/ppcp-settings/resources/js/data/payment/reducer.js @@ -7,7 +7,7 @@ * @file */ -import { createReducer, createSetters } from '../utils'; +import { createReducer, createReducerSetters } from '../utils'; import ACTION_TYPES from './action-types'; // Store structure. @@ -41,21 +41,21 @@ const defaultPersistent = Object.freeze( { // Reducer logic. -const [ setTransient, setPersistent ] = createSetters( +const [ changeTransient, changePersistent ] = createReducerSetters( defaultTransient, defaultPersistent ); const reducer = createReducer( defaultTransient, defaultPersistent, { [ ACTION_TYPES.SET_TRANSIENT ]: ( state, payload ) => - setTransient( state, payload ), + changeTransient( state, payload ), [ ACTION_TYPES.SET_PERSISTENT ]: ( state, payload ) => - setPersistent( state, payload ), + changePersistent( state, payload ), [ ACTION_TYPES.RESET ]: ( state ) => { - const cleanState = setTransient( - setPersistent( state, defaultPersistent ), + const cleanState = changeTransient( + changePersistent( state, defaultPersistent ), defaultTransient ); @@ -66,7 +66,7 @@ const reducer = createReducer( defaultTransient, defaultPersistent, { }, [ ACTION_TYPES.HYDRATE ]: ( state, payload ) => - setPersistent( state, payload.data ), + changePersistent( state, payload.data ), } ); export default reducer; diff --git a/modules/ppcp-settings/resources/js/data/settings-tab/reducer.js b/modules/ppcp-settings/resources/js/data/settings-tab/reducer.js index a374f60af..e7a39ce7a 100644 --- a/modules/ppcp-settings/resources/js/data/settings-tab/reducer.js +++ b/modules/ppcp-settings/resources/js/data/settings-tab/reducer.js @@ -7,7 +7,7 @@ * @file */ -import { createReducer, createSetters } from '../utils'; +import { createReducer, createReducerSetters } from '../utils'; import ACTION_TYPES from './action-types'; // Store structure. @@ -47,7 +47,7 @@ const defaultPersistent = Object.freeze( { // Reducer logic. -const [ setTransient, setPersistent ] = createSetters( +const [ changeTransient, changePersistent ] = createReducerSetters( defaultTransient, defaultPersistent ); @@ -64,7 +64,7 @@ const reducer = createReducer( defaultTransient, defaultPersistent, { * @return {Object} Updated state */ [ ACTION_TYPES.SET_TRANSIENT ]: ( state, payload ) => { - return setTransient( state, payload ); + return changeTransient( state, payload ); }, /** @@ -75,7 +75,7 @@ const reducer = createReducer( defaultTransient, defaultPersistent, { * @return {Object} Updated state */ [ ACTION_TYPES.SET_PERSISTENT ]: ( state, payload ) => - setPersistent( state, payload ), + changePersistent( state, payload ), /** * Resets state to defaults while maintaining initialization status @@ -84,8 +84,8 @@ const reducer = createReducer( defaultTransient, defaultPersistent, { * @return {Object} Reset state */ [ ACTION_TYPES.RESET ]: ( state ) => { - const cleanState = setTransient( - setPersistent( state, defaultPersistent ), + const cleanState = changeTransient( + changePersistent( state, defaultPersistent ), defaultTransient ); cleanState.isReady = true; // Keep initialization flag @@ -101,7 +101,7 @@ const reducer = createReducer( defaultTransient, defaultPersistent, { * @return {Object} Hydrated state */ [ ACTION_TYPES.HYDRATE ]: ( state, payload ) => - setPersistent( state, payload.data ), + changePersistent( state, payload.data ), } ); export default reducer; diff --git a/modules/ppcp-settings/resources/js/data/styling/reducer.js b/modules/ppcp-settings/resources/js/data/styling/reducer.js index db92d646b..4eb6e98fd 100644 --- a/modules/ppcp-settings/resources/js/data/styling/reducer.js +++ b/modules/ppcp-settings/resources/js/data/styling/reducer.js @@ -7,7 +7,7 @@ * @file */ -import { createReducer, createSetters } from '../utils'; +import { createReducer, createReducerSetters } from '../utils'; import ACTION_TYPES from './action-types'; import { STYLING_COLORS, @@ -85,21 +85,21 @@ const sanitizeLocation = ( oldDetails, newDetails ) => { // Reducer logic. -const [ setTransient, setPersistent ] = createSetters( +const [ changeTransient, changePersistent ] = createReducerSetters( defaultTransient, defaultPersistent ); const reducer = createReducer( defaultTransient, defaultPersistent, { [ ACTION_TYPES.SET_TRANSIENT ]: ( state, payload ) => - setTransient( state, payload ), + changeTransient( state, payload ), [ ACTION_TYPES.SET_PERSISTENT ]: ( state, payload ) => - setPersistent( state, payload ), + changePersistent( state, payload ), [ ACTION_TYPES.RESET ]: ( state ) => { - const cleanState = setTransient( - setPersistent( state, defaultPersistent ), + const cleanState = changeTransient( + changePersistent( state, defaultPersistent ), defaultTransient ); @@ -121,7 +121,7 @@ const reducer = createReducer( defaultTransient, defaultPersistent, { {} ); - return setPersistent( state, validData ); + return changePersistent( state, validData ); }, } ); diff --git a/modules/ppcp-settings/resources/js/data/utils.js b/modules/ppcp-settings/resources/js/data/utils.js index 7d3a14af7..c7b3fc3f3 100644 --- a/modules/ppcp-settings/resources/js/data/utils.js +++ b/modules/ppcp-settings/resources/js/data/utils.js @@ -36,16 +36,16 @@ const updateObject = ( oldObject, newValues, allowedKeys = {} ) => ( { * @param {Object} defaultPersistent Object defining initial persistent values. * @return {[Function, Function]} An array containing setTransient and setPersistent functions. */ -export const createSetters = ( defaultTransient, defaultPersistent ) => { - const setTransient = ( oldState, newValues = {} ) => +export const createReducerSetters = ( defaultTransient, defaultPersistent ) => { + const changeTransient = ( oldState, newValues = {} ) => updateObject( oldState, newValues, defaultTransient ); - const setPersistent = ( oldState, newValues = {} ) => ( { + const changePersistent = ( oldState, newValues = {} ) => ( { ...oldState, data: updateObject( oldState.data, newValues, defaultPersistent ), } ); - return [ setTransient, setPersistent ]; + return [ changeTransient, changePersistent ]; }; /**