| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| redux-arg | -100% | -74/74 | -100% | -36/36 | -100% | -32/32 | -100% | -58/58 | -|
| redux-arg/reducers | -49.33% | -37/75 | -27.66% | -13/47 | -80% | -20/25 | -51.67% | -31/60 | -|
| redux-arg/utils | -100% | -10/10 | -100% | -12/12 | -100% | -2/2 | -100% | -6/6 | -
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 | - - - - - - - - - - - - - - - - - - - - - -6x - - - - - -7x -6x - - - - - - - - - - - - - - -6x -4x - - - - - - -6x - - - - - - - - - -10x -10x - - - - - -10x - - -1x - - - - - - - - - - - -10x - - - - - - - - - - - -6x - - - - - - - - - - - - - | //@flow
-//==============================
-// Flow imports
-//==============================
-import type { StructureType, PrimitiveType } from './structure';
-import type { PartialStoreChunk } from './reducers';
-
-//==============================
-// JS imports
-//==============================
-import { combineReducers } from 'redux';
-import { reduce, find, omit, isFunction } from 'lodash';
-import { compose } from 'ramda';
-import { createReducer } from './reducers';
-import { PROP_TYPES } from './structure';
-
-// Build a chunk of the eventual store. The selectors and actions
-// generated will specifically operate on the store chunk generated. Selectors will be
-// relative to the baseSelector provided or, if not specified, the root of the store, using
-// the name of the chunk as the base property.
-
-export function buildStoreChunk(name: string, structure: any, {
- baseSelector = state => state[name],
- locationString = '',
-}: {
- baseSelector: any,
- locationString: string,
-} = {}): PartialStoreChunk {
- if (!structure) throw new Error(`The structure must be defined for a reducer! LocationString: ${ locationString }`);
- const initialMemo: PartialStoreChunk = {
- reducers: {
- [name]: {},
- },
- actions: {},
- selectors: {},
- baseSelector,
- locationString,
- name,
- };
- //Build up the reducers, actions, and selectors for this level. Due to recursion,
- //these objects will be assigned to a property in the parent object, or simply
- //returned to the call site for use in the rest of the application.
-
- //If the reducer's structure is a function (and, therefore, not nested reducers), we can skip the reduce.
- if (isFunction(structure)) return combineStoreChunkReducers(processStructure(initialMemo, structure, name));
- return combineStoreChunkReducers(reduce(structure, processStructure, initialMemo));
-}
-
-export function combineStoreChunkReducers(processedStoreChunk: PartialStoreChunk) {
- //The Redux 'combineReducers' helper function is used here to save a little bit of boilerplate.
- //This helper, if you're not aware, ensures that the correct store properties are passed to the
- //reducers assigned to those properties.
- return { ...omit(processedStoreChunk, ['baseSelector', 'locationString', 'name']), reducers: {
- [processedStoreChunk.name]: combineReducers(processedStoreChunk.reducers)
- }};
-}
-
-export function processStructure(memo: PartialStoreChunk, propValue: StructureType | PrimitiveType, propName: string) {
- //Get the structure from the propValue. In the case of 'StructureType' properties, this
- //will be some form of shape (or primitives in the case of arrays). At this point we
- //are only interested in whether or not the structure contains reducers, as that
- //has an impact on how we proceed with regards to calls.
- const { structure: propStructure } = propValue();
- const containsReducers = !!find(propStructure, v => v().type === PROP_TYPES._reducer);
-
- //Create the child reducer. Depending on whether or not the current structure level contains
- //child reducers, we will either recursively call reducerBuilder, or we will call the
- //createReducer function, which will create the correct reducer for the given structure
- //(which can be either object, array, or primitive).
- let childReducer = containsReducers
- ? buildStoreChunk(propName, propStructure, {
- locationString: memo.locationString ? `${memo.locationString}.${propName}` : propName,
- baseSelector: (state: any) => memo.baseSelector(state)[propName],
- })
- : createReducer(propValue, {
- locationString: `${memo.locationString}.${propName}`,
- name: propName,
- });
-
- //As the object is built up, we want to assign the reducers/actions created
- //by the child to a location on the reducers/actions object which will match up
- //to their location. Selectors are created at this level, as the child does not
- //need to know where it is located within the grand scheme of things.
-
- return {
- ...memo,
- reducers: {
- ...memo.reducers,
- ...childReducer.reducers
- },
- actions: {
- ...memo.actions,
- [propName]: childReducer.actions,
- },
- selectors: {
- ...memo.selectors,
- [propName]: containsReducers ? childReducer.selectors : state => memo.baseSelector(state)[propName],
- },
- };
-}
-
-
-
-
-
-
-
-
-
- |
| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| buildStoreChunk.js | -100% | -15/15 | -100% | -13/13 | -100% | -7/7 | -100% | -12/12 | -|
| reducers.js | -100% | -16/16 | -100% | -7/7 | -100% | -6/6 | -100% | -12/12 | -|
| structure.js | -100% | -14/14 | -100% | -4/4 | -100% | -12/12 | -100% | -8/8 | -|
| validatePayload.js | -100% | -29/29 | -100% | -12/12 | -100% | -7/7 | -100% | -26/26 | -
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -2x - - - - - - - - - - - - - - - - - -14x -14x - -14x - -13x - - - - - - - - - - - - - -9x - - - - - - - - - - - -22x - - - - - - - - - - - -12x -12x - -12x - -6x - - - - - -2x - | //@flow
-//==============================
-// Flow imports
-//==============================
-import type {
- StructureType,
- PrimitiveType,
- ReducerType,
- PropTypeKeys,
-} from './structure';
-
-//==============================
-// Flow types
-//==============================
-export type PartialStoreChunk = {
- reducers: { [key: string]: any },
- actions: { [key: string]: any },
- selectors: { [key: string]: any },
- locationString: string,
- baseSelector: () => {},
- name: string,
-};
-
-export type Selector = (state: Object) => any;
-
-type CallReducerInterface = {
- name: string,
- reducerFn: () => {},
- reducerStructureDescriptor: StructureType | PrimitiveType,
- locationString: string,
-};
-
-//==============================
-// JS imports
-//==============================
-import {
- PROP_TYPES,
-} from './structure';
-import { compose } from 'ramda';
-import { reduce, find } from 'lodash';
-import { createShapeReducer } from './reducers/objectReducer';
-import { createArrayReducer } from './reducers/arrayReducer';
-import { createPrimitiveReducer } from './reducers/primitiveReducer';
-
-export const REDUCER_CREATOR_MAPPING: { [key: PropTypeKeys]: any } = {
- [PROP_TYPES._shape]: createShapeReducer,
- [PROP_TYPES._array]: createArrayReducer,
- [PROP_TYPES._boolean]: createPrimitiveReducer,
- [PROP_TYPES._string]: createPrimitiveReducer,
- [PROP_TYPES._number]: createPrimitiveReducer,
-};
-
-export function determineReducerType(reducerDescriptor: ReducerType, {
- name,
- locationString,
- reducerCreatorMapping = REDUCER_CREATOR_MAPPING,
-}: {
- name: string,
- locationString: string,
- reducerCreatorMapping: { [key: PropTypeKeys]: any },
-}): CallReducerInterface {
-
- const { structure } = reducerDescriptor();
- const { type } = structure();
-
- if (!reducerCreatorMapping[type]) throw new Error(`Reducer type ${type} does not have a corresponding createReducer function`);
-
- return {
- name,
- reducerFn: reducerCreatorMapping[type],
- reducerStructureDescriptor: structure,
- locationString,
- };
-}
-
-export function callReducer({
- name,
- reducerFn,
- reducerStructureDescriptor,
- locationString
-}: CallReducerInterface) {
- return reducerFn(reducerStructureDescriptor, {
- locationString,
- name,
- });
-}
-
-export function createReducerBehaviors(behaviorsConfig: { [key: string]: { reducer: () => {} } }, locationString: string): any {
- //Take a reducer behavior config object, and create the reducer behaviors using the location string.
- //This is necessary since all action types are effectively global when Redux processes an action
- //(i.e. every reducer will be ran using the action object). Therefore we need to ensure that all
- //actions only result in the specific reducer performing a change. Actions are also generated using
- //the location string/name combination, so will match up 1:1.
- return reduce(behaviorsConfig, (memo, behavior, name) => ({
- ...memo,
- [`${locationString}.${name}`]: behavior.reducer,
- }), {});
-}
-
-export function calculateDefaults(typeDescription: StructureType | PrimitiveType) {
- //Using the structure of a type, calculate the default for that type.
- //Types can take two forms; a 'StructureType' and a 'PrimitiveType'. The former
- //can (and usually does) contain nested type descriptions, so we need to recurse
- //through the definition until defaults are found, and build up the corresponding
- //structure.
- const { type, structure = {}, defaultValue = '' } = typeDescription();
- const complex = [PROP_TYPES._array, PROP_TYPES._shape].indexOf(type) > -1;
-
- if (!complex) return defaultValue;
-
- return reduce(structure, (memo, propValue, propName) => ({
- ...memo,
- [propName]: calculateDefaults(propValue),
- }), {});
-}
-
-export const createReducer = compose(callReducer, determineReducerType);
- |
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -2x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -1x -1x - - - - - - - - - - - - - - - - - -1x - - - - - - - - - - - -1x - - -1x - -15x - - - - - - - - - - - - - - - - - - - - - - - - - - - - -6x - -1x - - - - - - - | //@flow
-//==============================
-// Flow imports
-//==============================
-import type { ArrayStructureType } from '../structure';
-
-//==============================
-// Flow types
-//==============================
-export type ArrayReducerAction = {
- type: string,
- payload: any,
- index: number,
-};
-export type ArrayReducer = (state: Array<any>, action: ArrayReducerAction) => Array<any>;
-export type ArrayReducerBehavior = (state: Array<any>, payload: any, initialState: Array<any>, index: number | void) => Array<any>;
-export type ArrayReducerBehaviorsConfig = {
- [key: string]: {
- action?: (value: any) => any,
- reducer: ArrayReducerBehavior,
- }
-};
-export type ArrayReducerBehaviors = {
- [key: string]: ArrayReducerBehavior,
-};
-export type ArrayAction = (value: Array<any>) => { type: string, payload: any, index?: number };
-export type ArrayActions = {
- [key: string]: Array<any>
-};
-export type ArrayReducerOptions = {
- behaviorsConfig: ArrayReducerBehaviorsConfig,
- locationString: string,
- name: string,
-};
-export type ArraySelector = (state: Object) => Array<any>;
-
-//==============================
-// JS imports
-//==============================
-import { reduce, isArray, isNumber, isObject } from 'lodash';
-import { validateArray, validateShape, validatePrimitive } from '../validatePayload';
-import { createReducerBehaviors } from '../reducers';
-import { updateAtIndex, removeAtIndex } from '../utils/arrayUtils';
-import { PROP_TYPES } from '../structure';
-
-
-function checkIndex(index: ?number, payload: any, behaviorName: string): boolean {
- if (!isNumber(index) || index === -1) {
- console.warn(`Index not passed to ${behaviorName} for payload ${payload}.`);
- return false;
- }
- return true;
-}
-
-
-//==============================
-// Array behaviors
-// ----------------
-// Arrays are more complicated than shape or primitive reducers, due to
-// the complexities in amending specific elements. Of course, the behaviours
-// could still follow and the same pattern as the other reducers and simply
-// make the end user replace the correct index themselves. However, it made sense
-// to create a few helper behaviors to aid with the most common array operations.
-//==============================
-const DEFAULT_ARRAY_BEHAVIORS: ArrayReducerBehaviorsConfig = {
- //Index specific behaviors.
- updateAtIndex: {
- reducer(state, payload, initialState, index = -1) {
- if (!checkIndex(index, payload, 'updateAtIndex')) return state;
- if (payload === undefined) return console.warn('Undefined was passed when updating index. Update not performed') || state;
- if (isArray(payload) || isObject(payload)) return updateAtIndex(state, { ...state[index], ...payload }, index);
- return updateAtIndex(state, payload, index);
- }
- },
- resetAtIndex: {
- reducer(state, payload, initialState, index) {
- checkIndex(index, payload, 'resetAtIndex');
- return updateAtIndex(state, initialState, index);
- }
- },
- removeAtIndex: {
- reducer(state, payload, initialState, index) {
- checkIndex(index, payload, 'removeAtIndex');
- return removeAtIndex(state, index);
- }
- },
- replaceAtIndex: {
- reducer(state, payload, initialState, index) {
- checkIndex(index, payload, 'replaceAtIndex');
- if (payload === undefined) console.warn('Undefined was passed when updating index. Update not performed');
- return updateAtIndex(state, payload, index);
- }
- },
- //Whole array behaviors.
- replace: {
- action(value) {
- Iif(!isArray(value)) throw new Error('An array must be provided when replacing an array');
- return value;
- },
- reducer(state, payload) {
- return payload;
- }
- },
- reset: {
- reducer(state, payload, initialState) {
- return initialState;
- }
- },
-};
-
-
-export function createArrayReducer(arrayTypeDescription: ArrayStructureType, {
- locationString,
- name,
-}: ArrayReducerOptions = {}) {
- return {
- reducers: {
- [name]: createReducer(arrayTypeDescription, createReducerBehaviors(DEFAULT_ARRAY_BEHAVIORS, locationString))
- },
- actions: createActions(DEFAULT_ARRAY_BEHAVIORS, locationString, {}),
- };
-}
-
-
-function createReducer(arrayTypeDescription: ArrayStructureType, behaviors: ArrayReducerBehaviors): ArrayReducer {
- //Take the initial value specified as the default for the array, then apply it, using the validation
- //when doing so. The initial value must be an array.
- const initialValue = validateArray(arrayTypeDescription, arrayTypeDescription().defaultValue);
-
- //Return the array reducer.
- return (state: Array<any> = initialValue, { type, payload, index }: ArrayReducerAction) => {
- //If the action type does not match any of the specified behaviors, just return the current state.
- Eif (!behaviors[type]) return state;
- //Validating the payload of an array is more tricky, as we do not know ahead of time if the
- //payload should be an object, primitive, or an array. However, we can still validate here based on the
- //payload type passed.
- return behaviors[type](state, applyValidation(arrayTypeDescription, payload), initialValue, index);
- }
-}
-
-
-function applyValidation(arrayTypeDescription: ArrayStructureType, payload: any) {
- // Array validation is more tricky than object/primitive, as it is possible that the current
- // action may involve updating the contents of a specific array element, rather than the
- // whole array. As a result, some extra functionality is required to determine which
- // form of validation to apply.
-
- // First case is simple - if the action payload is an array, then we simply validate it against
- // the structure of this reducer.
- if (isArray(payload)) return validateArray(arrayTypeDescription, payload);
-
- // If a non-array payload has been passed in, then we need to check which form of validation
- // to use, by checking the structure of the array.
- const { structure } = arrayTypeDescription();
- if (structure().type === PROP_TYPES._shape) return validateShape(structure, payload);
- return validatePrimitive(structure, payload);
-}
-
-
-function createActions(behaviorsConfig: ArrayReducerBehaviorsConfig, locationString: string): ArrayActions {
- //Take a reducer behavior config object, and create actions using the location string
- return reduce(behaviorsConfig, (memo, behavior, name) => ({
- ...memo,
- [name]: (value: Array<any>, index: ?number) => ({
- type: `${locationString}.${name}`,
- payload: (behavior.action || (() => value))(value),
- index,
- })
- }), {});
-}
- |
| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| arrayReducer.js | -26.83% | -11/41 | -13.79% | -4/29 | -66.67% | -6/9 | -28.13% | -9/32 | -|
| objectReducer.js | -61.11% | -11/18 | -30% | -3/10 | -77.78% | -7/9 | -60% | -9/15 | -|
| primitiveReducer.js | -93.75% | -15/16 | -75% | -6/8 | -100% | -7/7 | -100% | -13/13 | -
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -2x - - - - - - - - - - - - -1x - - - - - - - - - - - -1x - - - - - - - - - -1x - - - - - - - - - -1x -1x - -15x - - - - - - - - - - -3x - -1x - - - - - - - - | //@flow
-//==============================
-// Flow imports
-//==============================
-import type { StructureType } from '../structure';
-
-
-//==============================
-// Flow types
-//==============================
-export type ShapeReducerAction = {
- type: string,
- payload: Object,
-};
-export type ShapeReducer = (state: Object, action: ShapeReducerAction) => Object;
-export type ShapeReducerBehavior = (state: {}, payload: Object | void, initialState: {}) => Object;
-export type ShapeReducerBehaviorsConfig = {
- [key: string]: {
- action?: (value: Object) => Object,
- reducer: ShapeReducerBehavior,
- }
-};
-export type ShapeReducerBehaviors = {
- [key: string]: ShapeReducerBehavior,
-};
-export type ShapeAction = (value: Object) => { type: string, payload: Object };
-export type ShapeActions = {
- [key: string]: ShapeAction
-};
-export type ShapeReducerOptions = {
- behaviorsConfig: ShapeReducerBehaviorsConfig,
- locationString: string,
- name: string,
-};
-
-
-//==============================
-// JS imports
-//==============================
-import { reduce } from 'lodash';
-import { validateShape } from '../validatePayload';
-import { createReducerBehaviors } from '../reducers';
-import { PROP_TYPES } from '../structure';
-
-
-//==============================
-// Shape behaviors
-// ----------------
-// Shapes differ from primitive reducers by allowing an update behavior, merging the
-// payload and the previous state in a shallow way. This supplements the replace
-// behavior, which still replaces the previous state with the payload.
-//==============================
-const DEFAULT_SHAPE_BEHAVIORS: ShapeReducerBehaviorsConfig = {
- update: {
- action(value) { return value },
- reducer(state, payload = {}) {
- return { ...state, ...payload };
- }
- },
- reset: {
- reducer(state, payload, initialState) {
- return initialState;
- }
- },
- replace: {
- action(value) { return value },
- reducer(state, payload = {}) {
- return payload;
- }
- }
-};
-
-
-export function createShapeReducer(reducerShape: StructureType, {
- locationString,
- name,
-}: ShapeReducerOptions = {}) {
- return {
- reducers: {
- [name]: createReducer(reducerShape, createReducerBehaviors(DEFAULT_SHAPE_BEHAVIORS, locationString)),
- },
- actions: createActions(DEFAULT_SHAPE_BEHAVIORS, locationString, {}),
- };
-}
-
-
-function calculateDefaults(reducerStructure) {
- return reduce(reducerStructure, (memo, propValue, propName) => ({
- ...memo,
- [propName]: propValue().type === PROP_TYPES._shape
- ? calculateDefaults(propValue().structure)
- : propValue().defaultValue,
- }), {});
-}
-
-
-function createReducer(objectStructure: StructureType, behaviors: ShapeReducerBehaviors): ShapeReducer {
- const initialState: Object = validateShape(objectStructure, calculateDefaults(objectStructure().structure));
- return (state = initialState, { type, payload }: ShapeReducerAction) => {
- //If the action type does not match any of the specified behaviors, just return the current state.
- Eif (!behaviors[type]) return state;
-
- //Sanitize the payload using the reducer shape, then apply the sanitized
- //payload to the state using the behavior linked to this action type.
- return behaviors[type](state, validateShape(objectStructure, payload), initialState);
- }
-}
-
-
-function createActions(behaviorsConfig: ShapeReducerBehaviorsConfig, locationString: string, defaultPayload: any): ShapeActions {
- //Take a reducer behavior config object, and create actions using the location string
- return reduce(behaviorsConfig, (memo, behavior, name) => ({
- ...memo,
- [name]: (value: Object) => ({
- type: `${locationString}.${name}`,
- payload: (behavior.action || (() => defaultPayload))(value),
- })
- }), {});
-}
-
-
- |
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -2x - -3x - -2x -2x - - - - -2x - - - - - - - - - -6x - - - - - - - - - -6x -6x - -67x - - - -4x - - - - - - -12x - -5x - -2x - - - - - - - | //@flow
-//==============================
-// Flow imports
-//==============================
-import type { PrimitiveType } from '../structure';
-
-//==============================
-// Flow types
-//==============================
-export type PrimitiveReducerAction = {
- type: string,
- payload: mixed,
-};
-export type PrimitiveReducer = (state: mixed, action: PrimitiveReducerAction) => mixed;
-export type PrimitiveReducerBehavior = (state: mixed, payload: mixed | void, initialState: mixed) => mixed;
-export type PrimitiveReducerBehaviorsConfig = {
- [key: string]: {
- action?: (value: mixed) => mixed,
- reducer: PrimitiveReducerBehavior,
- }
-};
-export type PrimitiveReducerBehaviors = {
- [key: string]: PrimitiveReducerBehavior,
-};
-export type PrimitiveAction = (value: mixed) => { type: string, payload: mixed };
-export type PrimitiveActions = {
- [key: string]: PrimitiveAction
-};
-export type PrimitiveReducerOptions = {
- behaviorsConfig: PrimitiveReducerBehaviorsConfig,
- locationString: string,
- name: string,
-};
-
-//==============================
-// JS imports
-//==============================
-import { reduce } from 'lodash';
-import { validatePrimitive } from '../validatePayload';
-import { createReducerBehaviors } from '../reducers';
-
-
-//==============================
-// Primitive behaviors
-// ----------------
-// Primitives are the most simple case, as they only have the replace and
-// reset behaviors by default.
-//==============================
-
-const DEFAULT_PRIMITIVE_BEHAVIORS: PrimitiveReducerBehaviorsConfig = {
- replace: {
- action(value) { return value },
- reducer(state, payload) {
- Iif (payload === undefined) return state;
- return payload;
- }
- },
- reset: {
- reducer(state, payload, initialState) {
- return initialState;
- }
- },
-};
-
-
-export function createPrimitiveReducer(primitiveType: PrimitiveType, {
- locationString,
- name,
-}: PrimitiveReducerOptions = {}) {
- return {
- reducers: {
- [name]: createReducer(primitiveType, createReducerBehaviors(DEFAULT_PRIMITIVE_BEHAVIORS, locationString)),
- },
- actions: createActions(DEFAULT_PRIMITIVE_BEHAVIORS, locationString, {}),
- };
-}
-
-
-function createReducer(primitiveType: PrimitiveType, behaviors: PrimitiveReducerBehaviors): PrimitiveReducer {
- const initialState: mixed = validatePrimitive(primitiveType, primitiveType().defaultValue);
- return (state = initialState, { type, payload }: PrimitiveReducerAction) => {
- //If the action type does not match any of the specified behaviors, just return the current state.
- if (!behaviors[type]) return state;
-
- //Sanitize the payload using the reducer shape, then apply the sanitized
- //payload to the state using the behavior linked to this action type.
- return behaviors[type](state, validatePrimitive(primitiveType, payload), initialState);
- }
-}
-
-
-function createActions(behaviorsConfig: PrimitiveReducerBehaviorsConfig, locationString: string, defaultPayload: any): PrimitiveActions {
- //Take a reducer behavior config object, and create actions using the location string
- return reduce(behaviorsConfig, (memo, behavior, name) => ({
- ...memo,
- [name]: (value: mixed) => ({
- type: `${locationString}.${name}`,
- payload: (behavior.action || (() => defaultPayload))(value),
- })
- }), {});
-}
-
-
-
- |
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -4x - - - - - - - - - - -4x -59x - - - - -28x - - - - -7x - - - - -15x - - - - -28x - - - -29x - - - - - | //@flow
-
-//==============================
-// Flow types
-//==============================
-export type PropTypeKeys = $Keys<typeof PROP_TYPES>;
-
-export type ShapeStructure = {
- [key: string]: StructureType | PrimitiveType | ArrayStructureType,
-}
-export type StructureType = () => {
- type: PropTypeKeys,
- structure: ShapeStructure | StructureType | PrimitiveType,
- defaultValue?: any,
-};
-export type ReducerType = () => {
- type: PropTypeKeys,
- structure: StructureType | PrimitiveType,
-};
-export type ArrayStructureType = () => {
- type: PropTypeKeys,
- structure: StructureType | PrimitiveType,
- defaultValue: any,
-}
-export type PrimitiveType = () => {
- type: PropTypeKeys,
- defaultValue?: any,
- typeofValue: string,
- structure?: PrimitiveType,
-};
-export type TypesObject = {
- [key: string]: CreateArrayType | CreateStringType | CreateNumberType | CreateShapeType | CreateBooleanType;
-}
-
-export type TypesObjectDefaults = {
- [key: string]: mixed | TypesArrayDefaults,
-}
-export type TypesArrayDefaults = Array<mixed> | Array<TypesObjectDefaults>;
-
-type CreateStringType = (defaultValue: string) => PrimitiveType;
-type CreateNumberType = (defaultValue: number) => PrimitiveType;
-type CreateBooleanType = (defaultValue: boolean) => PrimitiveType;
-type CreateArrayType = (structure: StructureType | PrimitiveType, defaultValue: TypesArrayDefaults | TypesObjectDefaults) => StructureType;
-type CreateShapeType = (structure: ShapeStructure, defaultValue: TypesArrayDefaults | TypesObjectDefaults) => StructureType;
-
-//==============================
-// Structure
-//==============================
-export const PROP_TYPES = {
- _string: '_string',
- _number: '_number',
- _boolean: '_boolean',
- _reducer: '_reducer',
- _shape: '_shape',
- _array: '_array',
-};
-
-//The types objects are used in order to build up the structure of a store chunk, and provide/accept
-//default values whilst doing so.
-export const Types: TypesObject = {
- string: (defaultValue: string = '') => () => ({
- type: PROP_TYPES._string,
- defaultValue,
- typeofValue: 'string',
- }),
- number: (defaultValue: number = 0) => () => ({
- type: PROP_TYPES._number,
- defaultValue,
- typeofValue: 'number',
- }),
- boolean: (defaultValue: boolean = false) => () => ({
- type: PROP_TYPES._boolean,
- defaultValue,
- typeofValue: 'boolean',
- }),
- arrayOf: (structure: StructureType | PrimitiveType, defaultValue = []) => () => ({
- type: PROP_TYPES._array,
- structure,
- defaultValue,
- }),
- reducer: (structure: ShapeStructure) => () => ({
- type: PROP_TYPES._reducer,
- structure,
- }),
- shape: (structure: ShapeStructure) => () => ({
- type: PROP_TYPES._shape,
- structure,
- }),
-};
- |
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 | - -6x -4x -3x - - - - - - - -6x -4x -3x - - - - - | //@flow
-export function updateAtIndex(array: Array<any>, value: any, index: number): Array<any> {
- if (typeof index !== 'number') throw new Error('Must provide a numeric index to updateAtIndex');
- if (index < 0 || index > array.length - 1) throw new Error(`The index ${index} is out of range for the array provided`);
- return [
- ...array.slice(0,index),
- value,
- ...array.slice(index + 1),
- ];
-}
-
-export function removeAtIndex(array: Array<any>, index: number): Array<any> {
- if (typeof index !== 'number') throw new Error('Must provide a numeric index to removeAtIndex');
- if (index < 0 || index > array.length - 1) throw new Error(`The index ${index} is out of range for the array provided`);
- return [
- ...array.slice(0, index),
- ...array.slice(index + 1),
- ];
-}
- |
| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| arrayUtils.js | -100% | -10/10 | -100% | -12/12 | -100% | -2/2 | -100% | -6/6 | -
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 | - - - - - - - - - - - - - - -11x -1x -1x - - -10x -15x - - -15x -1x - -1x - - -14x -14x -1x - - -1x - - -13x - - - - - - - - -35x -4x - - - - - -7x -1x -1x - -6x -6x -14x - - - -29x - - - - - - -29x -29x -1x - - -28x - | //@flow
-//==============================
-// Flow imports and types
-//==============================
-import type { PrimitiveType, StructureType, ShapeStructure } from './structure';
-
-type validationFunction = (structure: StructureType | PrimitiveType | ShapeStructure, value: any) => any;
-
-//==============================
-// JS imports
-//==============================
-import { reduce, isObject } from 'lodash';
-import { PROP_TYPES } from './structure';
-
-export function validateShape(objectStructure: any, value: mixed): Object {
- if (!isObject(value)) {
- console.error(`The value passed to validateObject() was not an object. Value: `, value);
- return {};
- }
-
- return reduce(value, (memo, value, name) => {
- const valueType = objectStructure().structure[name];
- //If the value type does not exist in the reducer structure, we don't want to include it in the payload.
- //Display a console error for the developer, and skip the inclusion of this property in the payload.
- if (!valueType) {
- console.warn(`The property, ${name}, was not specified in the structure` +
- ' and was stripped out of the payload. Structure: ', objectStructure().structure);
- return memo;
- }
-
- const validatedValue = getTypeValidation(valueType().type)(valueType, value);
- if (validatedValue === undefined) {
- console.warn(`The property, ${name}, was populated with a type ${ typeof value } which does not` +
- ' match that specified in the reducer configuration. It has been stripped from' +
- ' the payload');
- return memo;
- }
-
- return {
- ...memo,
- [name]: validatedValue,
- }
- }, {});
-}
-
-export function validatePrimitive(primitive: any, value: any): mixed {
- //Validate primitives using the typeofValue property of the primitive type definitions.
- if (typeof value === primitive().typeofValue ) return value;
- return console.warn(`The value, ${value}, did not match the type specified (${primitive().type}).`);
-}
-
-export function validateArray(arrayStructure: any, value: Array<any>): Array<mixed> {
- //Validate arrays by performing either of the other validation types to each element of the array,
- //based on the provided reducer structure.
- if (!Array.isArray(value)) {
- console.error(`The value passed to validateArray() was not an array. Value: `, value);
- return [];
- }
- const elementStructure = arrayStructure().structure;
- const elementType = elementStructure().type;
- return value.map(element => getTypeValidation(elementType)(elementStructure, element)).filter(e => e);
-}
-
-export function getTypeValidation(type: string): validationFunction {
- const TYPE_VALIDATIONS = {
- [PROP_TYPES._string]: validatePrimitive,
- [PROP_TYPES._number]: validatePrimitive,
- [PROP_TYPES._boolean]: validatePrimitive,
- [PROP_TYPES._array]: validateArray,
- [PROP_TYPES._shape]: validateShape,
- };
- const typeValidation = TYPE_VALIDATIONS[type];
- if (!typeValidation) {
- throw new Error(`The type ${type} does not have a corresponding
- validation function!`);
- }
- return typeValidation;
-} |