All files / source index.js

60% Statements 81/135
57.97% Branches 40/69
58.33% Functions 21/36
61.67% Lines 74/120

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375                                          5x 1x     4x 4x 4x 4x 4x 4x   4x       2x 2x             2x 1x       1x 1x               1x 1x                 2x       2x       7x       7x 4x 2x 2x       2x   7x       1x 1x   1x       2x 2x     2x           2x                       2x       2x                         6x     6x                     1x     1x 1x   1x                                                       4x 4x 4x 4x 4x 4x 4x 4x 4x 4x                                                                                                                                                 1x 1x 1x         2x 2x       2x 2x 2x       2x                   1x 1x                                                                     1x       2x         2x 1x         2x       6x 6x 5x 4x 1x         1x   2x                      
//
//  redux/index.js
//  medoboard
//
//  Created by Thomas Schönmann on 20.6.2018.
//  Copyright © expressFlow GmbH. All rights reserved.
//
//  Model to minify Redux-debris in app.
//
 
import { connect } from "react-redux";
import { takeEvery, call, put } from "redux-saga/effects";
 
/*
 *
 * Classes.
 *
 */
 
class ReduxWrapper {
  constructor(props) {
    if (!props || !props.called) {
      throw Error("ReduxWrapper : constructor - missing 'called'-arg");
    }
 
    this._id = props.called;
    this.component = props.component || null;
    this.actionReducers = {};
    this.saga = [];
    this.otherStateProps = {};
    this.otherStateActions = {};
 
    this._bind();
  }
 
  mapStateToProps(state) {
    let mapped = { ...state[this._id] };
    const props = { ...this.otherStateProps };
 
    /*
     console.log(`ReduxWrapper : mapStateToProps : ...state[${this._id}] -`, mapped);
     console.log("ReduxWrapper : mapStateToProps : ...this.otherStateProps -", props, ", _id -", this._id);
      */
 
    Object.keys(props).forEach(id => {
      Iif (props[id] === "all") {
        return (mapped = { ...mapped, ...state[id] });
      }
 
      Eif (props[id].constructor === Array) {
        const otherCopy = { ...state[id] };
 
        // Now let's check each element in the array. It may be either
        //  - a String
        //  - an Object
        // based on the caller input. If it's an object, the wrapped comp
        // uses the foreign state-prop under a custom name. If only a string
        // is provided, we can copy as is.
        return props[id].forEach(element => {
          Eif (element.constructor === String) return (mapped[element] = otherCopy[element]);
          if (element.constructor === Object) return (mapped[element.as] = otherCopy[element.origin]);
          throw Error(`ReduxWrapper : mapStateToProps - Unsupported type as value for ${id} in ${element}`);
        });
      }
 
      throw Error(`ReduxWrapper : mapStateToProps - Unsupported type as value for ${id}`);
    });
 
    return { ...mapped };
  }
 
  mapDispatchToProps(dispatch) {
    return this.dispatches(dispatch);
  }
 
  add(props) {
    const { initState, component, reducer, otherStateProps } = props;
 
    // Let's see what param has been passed. Only one per add-call is valid.
    // If non was found, the caller uses the shorthand version to add an actionReducer.
    if (initState) this.initState = initState;
    else if (component) this.component = component;
    else Iif (reducer) this._addActionReducer({ action: reducer });
    else Iif (otherStateProps) this.otherStateProps = { ...this.otherStateProps, otherStateProps };
    // No matching key, which means the caller provides a reducerAction. Now we
    // have to check if the value equals a function or an object containing the fn-key
    // (and maybe a 'withSaga'). If 'withSaga' is provided, the 'fn'-key is too.
    else this._addActionReducer({ action: props });
 
    return this;
  }
 
  import(props) {
    Iif (props.reducer) this._importOtherDispatchProps(props);
    Eif (props.state) this._importOtherStateProps(props);
 
    return this;
  }
 
  dispatches(dispatch) {
    const { actionReducers } = this;
    let obj = {};
 
    // Process own actionReducers.
    Object.keys(actionReducers).forEach(type => {
      obj = { ...obj, ...this._dispatch({ dispatch, type, action: actionReducers[type] }) };
      //obj[fnName] = params => dispatch(actionReducers[type].f({ type, ...params }));
    });
 
    // There might be imported ones as well.
    Object.keys(this.otherStateActions).forEach(wrapperName => {
      this.otherStateActions[wrapperName].forEach(element => {
        const names = ReduxWrapper._extractImportReducerParams(element);
        const t = ReduxWrapper._createExternalTypes({
          namespace: wrapperName,
          fName: names.fName,
          _id: this._id
        });
        obj[names.exposedName] = params => dispatch({ type: t.proxy, dispatch, ...params });
      });
    });
 
    return obj;
  }
 
  get connection() {
    return connect(
      this.mapStateToProps,
      this.mapDispatchToProps
    )(this.component);
  }
 
  // Exposed to store.
  reducer(state = this.initState, action) {
    /*
     console.log("ReduxWrapper : reducer : action -", action);
     console.log("ReduxWrapper : reducer : this.actionReducers -", this.actionReducers);
      */
 
    Iif (this.actionReducers[action.type] && this.actionReducers[action.type].isReducable)
      return this.actionReducers[action.type].f(state, action);
 
    return { ...state };
  }
 
  /**
   * Export the types used in the instance. If no args are provided,
   * export all.
   *
   * @param  {[String]} types The reducer-names as strings.
   * @return {Object}       The internal representation of those names.
   */
  types(...types) {
    let tuples = {};
 
    // Nothing specific, return everything.
    Eif (!types || types.length === 0) {
      Object.keys(this.actionReducers).forEach(k => (tuples[this.actionReducers[k].name] = k));
 
      return tuples;
    }
 
    // Only get requested types.
    const typeMap = types.map(actionKey => {
      const internalType = ReduxWrapper._createType({
        _id: this._id,
        actionKey
      });
      tuples[actionKey] = internalType;
 
      return internalType;
    });
 
    if (typeMap.some(type => Object.keys(this.actionReducers).includes(type)))
      throw Error("ReduxWrapper : types(...) - Requesting to export unavailable action type");
 
    // Now return the key-value-map so the caller knows
    // how the internal representation looks like for each
    // name requested.
    return tuples;
  }
 
  /*
    * Internal.
    */
 
  _bind() {
    this.mapStateToProps = this.mapStateToProps.bind(this);
    this.mapDispatchToProps = this.mapDispatchToProps.bind(this);
    this.dispatches = this.dispatches.bind(this);
    this.reducer = this.reducer.bind(this);
    this._importOtherDispatchProps = this._importOtherDispatchProps.bind(this);
    this._importOtherStateProps = this._importOtherStateProps.bind(this);
    this._addActionReducer = this._addActionReducer.bind(this);
    this._addAtomicActionReducer = this._addAtomicActionReducer.bind(this);
    this._addSaga = this._addSaga.bind(this);
    this._addSagaAction = this._addSagaAction.bind(this);
  }
 
  _dispatch(props) {
    const { dispatch, type, action } = props;
    const _action = { ...action };
 
    // If no name is provided, the action only lives
    // as a reducer without being exposed to the caller.
    // This is a valid use case, e.g. when implementing sagas.
    if (!_action.name) return;
 
    return {
      [_action.name]: params =>
        _action.params
          ? dispatch({ type, ...params, ..._action.params, dispatch })
          : dispatch({ type, ...params, dispatch })
    };
  }
 
  _importOtherDispatchProps(props) {
    const copy = { ...props.reducer };
 
    Object.keys(copy).forEach(wrapperName => {
      this.otherStateActions[wrapperName] = copy[wrapperName];
 
      // Now add a saga call for each external action. The saga itself enables
      // a safe way for dispatching another action, in this the external one.
      //
      // This is necessary, b/c during the app's init it isn't guraranteed that
      // the external functions already exists. Therefore, we're using a proxy
      // that provides the 'real' action upon being called.
      copy[wrapperName].forEach(tuple => {
        const { fName, exposedName, withSaga } = ReduxWrapper._extractImportReducerParams(tuple);
        const t = ReduxWrapper._createExternalTypes({
          namespace: wrapperName,
          fName,
          _id: this._id,
          withSaga
        });
 
        this.saga.push(
          takeEvery(t.proxy, function*(action) {
            const copy = { ...action };
            const { dispatch } = copy;
            let foreignParams = {};
 
            Object.keys(action)
              .filter(key => key !== "dispatch" && key !== "type")
              .forEach(key => (foreignParams[key] = copy[key]));
 
            /*
             console.log("ReduxWrapper : proxy reducer : action -", action);
             console.log("ReduxWrapper : proxy reducer : dispatch -", { type: t.basic, ...foreignParams });
              */
 
            withSaga
              ? yield put({
                  type: t.saga.req,
                  call,
                  put,
                  result: { type: t.saga.rec },
                  ...foreignParams,
                  dispatch: action.dispatch
                })
              : yield put({ type: t.basic, ...foreignParams, dispatch: action.dispatch });
          })
        );
      });
    });
  }
 
  _importOtherStateProps(props) {
    const stateCopy = { ...props.state };
    Object.keys(stateCopy).forEach(
      id => (this.otherStateProps = { ...this.otherStateProps, [id]: stateCopy[id] })
    );
  }
 
  _addActionReducer({ action }) {
    Iif (action[Object.keys(action)[0]].withSaga) return this._addSaga(action);
    else this._addAtomicActionReducer({ action, isShort: !action[Object.keys(action)[0]].fn });
  }
 
  _addAtomicActionReducer({ action, isShort = false }) {
    const _action = { ...action };
    const actionKey = Object.keys(_action)[0];
    const type = _action[actionKey].withType
      ? _action[actionKey].withType
      : `${this._id.toUpperCase()}_${actionKey.toUpperCase()}`;
 
    this.actionReducers[type] = {
      name: actionKey,
      f: isShort ? _action[actionKey] : _action[actionKey].fn,
      isReducable: true
    };
  }
 
  _addSaga(action) {
    // Only one key in 'withSaga', which is the name of
    // the saga-function that listens, e.g. takeEvery.
    const exposedFnName = Object.keys(action)[0];
    const sagaFnName = Object.keys(action[exposedFnName].withSaga)[0];
    switch (sagaFnName) {
      case "takeEvery":
        return this._addSagaAction({ action, exposedFnName, sagaFnName, sagaListener: takeEvery });
      default:
        throw Error(
          "ReduxWrapper : _addSaga : fn-signature unknown. The key in 'withSaga' can't be used or isn't provided."
        );
    }
  }
 
  _addSagaAction({ action, exposedFnName, sagaFnName, sagaListener }) {
    const _action = { ...action };
    const actionKey = Object.keys(_action)[0];
    const reqType = `SAGA_REQ_${this._id.toUpperCase()}_${actionKey.toUpperCase()}`;
    const recType = `SAGA_REC_${this._id.toUpperCase()}_${actionKey.toUpperCase()}`;
 
    // First declare the action to trigger the saga-sideeffect. Won't be registered
    // in the reducer, but will provide some params in the action.
    this.actionReducers[reqType] = {
      name: actionKey,
      isReducable: false,
      params: { call, put, result: { type: recType } }
    };
 
    // Now provide the saga-fn. The logic is contained as a function
    // in 'withSaga' by the caller.
    this.saga.push(sagaListener(reqType, _action[exposedFnName].withSaga[sagaFnName]));
 
    // Finally add the reducer provided by the caller. This function
    // deals with the saga's result.
    this.actionReducers[recType] = { f: _action[actionKey].fn, isReducable: true };
  }
 
  static _createType({ _id, actionKey }) {
    return `${_id.toUpperCase()}_${actionKey.toUpperCase()}`;
  }
 
  static _createExternalTypes({ namespace, fName, _id, withSaga = false }) {
    const tuples = {
      basic: `${namespace.toUpperCase()}_${fName.toUpperCase()}`,
      proxy: `${_id.toUpperCase()}_PROXY_${namespace.toUpperCase()}_${fName.toUpperCase()}`
    };
 
    if (withSaga)
      tuples.saga = {
        req: `SAGA_REQ_${namespace.toUpperCase()}_${fName.toUpperCase()}`,
        rec: `SAGA_REC_${namespace.toUpperCase()}_${fName.toUpperCase()}`
      };
 
    return { ...tuples };
  }
 
  static _extractImportReducerParams(element) {
    let names = {};
    if (element.constructor === String) names = { fName: element, exposedName: element, withSaga: false };
    else if (element.constructor === Object) {
      if (!element.origin || !element.as) throw Error("No 'origin' and/or 'as' provided in element to read from.");
      names = {
        fName: element.origin,
        exposedName: element.as || element.origin,
        withSaga: element.withSaga || false
      };
    } else throw Error("Unexpected type in otherStateActions' key found.");
 
    return { ...names };
  }
}
 
/*
  *
  * Exports.
  *
  */
 
export default ReduxWrapper;