refactor and clean-up boxed-immutable, add tests

Author: vsch

package.json

@@ -16,7 +16,7 @@
         "babel-polyfill": "^6.26.0",
         "babel-preset-react": "^6.24.1",
         "bootstrap": "^4.1.0",
-        "boxed-immutable": "^0.4",
+        "boxed-immutable": "^0.5",
         "cross-env": "^5.1",
         "exports-loader": "^0.6.4",
         "history": "^4.7.2",

public/js/index.js

@@ -5,7 +5,7 @@ import { compose } from "redux";
 import Dashboard from "./Dashboard";
 import appSettings, { appSettingChecks, appSettingForcedChecks, appSettings_$ } from "../helpers/AppSettings";
 import $ from "jquery";
-import { boxedImmutable, eachKey } from "../helpers/helpers";
+import { boxedImmutable, eachProp } from "../helpers/helpers";
 import DashboardComponent from "./DashboardComponent";
 import { GLOBAL_SETTINGS_TRACE } from "../helpers/GlobalSetting";
 
@@ -15,7 +15,7 @@ class AppSettings extends DashboardComponent {
 
         this.state = this.getState();
 
-        eachKey.call(GLOBAL_SETTINGS_TRACE, (value, key) => {
+        eachProp.call(GLOBAL_SETTINGS_TRACE, (value, key) => {
             this.state["trace-" + key] = GLOBAL_SETTINGS_TRACE[key];
         });
 
@@ -36,11 +36,11 @@ class AppSettings extends DashboardComponent {
             defaultSuffixes: appSettings_$.uiSettings.defaultSuffixes() || '',
         });
 
-        eachKey.call(GLOBAL_SETTINGS_TRACE, (value, key) => {
+        eachProp.call(GLOBAL_SETTINGS_TRACE, (value, key) => {
             state["trace-" + key] = !!this.state["trace-" + key];
         });
 
-        eachKey.call(appSettingChecks, (value, key) => {
+        eachProp.call(appSettingChecks, (value, key) => {
             if (appSettingForcedChecks.hasOwnProperty(key)) {
                 state[key] = appSettingForcedChecks[key];
             } else {
@@ -62,7 +62,7 @@ class AppSettings extends DashboardComponent {
     saveSettings() {
         appSettings_$.uiSettings._$(_$ => {
             _$.xDebugSession = this.state.xDebugSession;
-            eachKey.call(appSettingChecks, (value, key) => {
+            eachProp.call(appSettingChecks, (value, key) => {
                 if (appSettingForcedChecks.hasOwnProperty(key)) {
                     _$[key] = appSettingForcedChecks[key];
                 } else {
@@ -74,7 +74,7 @@ class AppSettings extends DashboardComponent {
         appSettings_$.save();
 
         // save trace values, they are not persisted
-        eachKey.call(GLOBAL_SETTINGS_TRACE, (value, key) => {
+        eachProp.call(GLOBAL_SETTINGS_TRACE, (value, key) => {
             GLOBAL_SETTINGS_TRACE[key] = !!this.state["trace-" + key];
         });
     }

resources/assets/js/components/AppSettings.js

@@ -41,7 +41,7 @@ class UrlButton extends React.Component {
         const $el = $(e.target);
 
         const normalizedUrlData = normalizeProp(this.props.dataUrl);
-        const dataUrl = util.isObject(normalizedUrlData) ? normalizedUrlData : { url: normalizedUrlData };
+        const dataUrl = util.isObjectLike(normalizedUrlData) ? normalizedUrlData : { url: normalizedUrlData };
         const reloadGroups = this.props.reloadGroups;
         const disableWith = this.props.disableWith;
         const confirmationKey = this.props.confirmationKey;

resources/assets/js/components/UrlButton.js

@@ -5,9 +5,9 @@ import { isUndefined } from './helpers';
 const util = boxedImmutable.util;
 const _$ = boxedImmutable.box;
 const isArray = util.isArray;
-const eachKey = util.eachKey;
+const eachProp = util.eachProp;
 const isFunction = util.isFunction;
-const isObject = util.isObject;
+const isObject = util.isObjectLike;
 const UNDEFINED = util.UNDEFINED;
 
 const MODAL_HIDDEN = 0;

resources/assets/js/helpers/AppModal.js

@@ -7,9 +7,9 @@ import appEvents from './AppEvents';
 const util = boxedImmutable.util;
 const _$ = boxedImmutable.box;
 const isArray = util.isArray;
-const eachKey = util.eachKey;
+const eachProp = util.eachProp;
 const isFunction = util.isFunction;
-const isObject = util.isObject;
+const isObject = util.isObjectLike;
 const UNDEFINED = util.UNDEFINED;
 
 export const appSettingChecks = {
@@ -240,7 +240,7 @@ export class AppSettings extends GlobalSetting {
         });
 
         // include default settings for dashboardShow, collapse
-        eachKey.call(dashboardConfig.dashboards, (dashboard, dashboardName) => {
+        eachProp.call(dashboardConfig.dashboards, (dashboard, dashboardName) => {
             dashboard.dashboardName = dashboardName;
 
             const showState = util.firstDefined(dashboard.defaultShow, false);
@@ -254,7 +254,7 @@ export class AppSettings extends GlobalSetting {
             defaults_$.uiSettings[dashboard.collapseState] = collapseState;
 
             // include default settings for dashboardShow, collapse route specific
-            eachKey.call(dashboardConfig.routeDashboards, (routeConfig, route) => {
+            eachProp.call(dashboardConfig.routeDashboards, (routeConfig, route) => {
                 const explicitlyIncluded = routeConfig.includeDashboards && routeConfig.includeDashboards.indexOf(dashboardName) !== -1;
                 const implicitlyIncluded = !routeConfig.includeDashboards || explicitlyIncluded;
                 const explicitlyExcluded = routeConfig.excludeDashboards && routeConfig.excludeDashboards.indexOf(dashboardName) !== -1;
@@ -281,13 +281,13 @@ export class AppSettings extends GlobalSetting {
         });
 
         // need to sort the dashboards in the arrays in order of their index
-        eachKey.call(dashboardConfig.routeDashboards, (routeConfig, route) => {
+        eachProp.call(dashboardConfig.routeDashboards, (routeConfig, route) => {
             if (routeConfig.dashboards) {
                 routeConfig.dashboards.sort((a, b) => a.index - b.index);
             }
         });
 
-        eachKey.call(appSettingChecks, (value,key) => {
+        eachProp.call(appSettingChecks, (value,key) => {
             if (appSettingForcedChecks.hasOwnProperty(key)) {
                 const setTo = appSettingForcedChecks[key];
                 transforms_$.uiSettings[key] = setTo ? _$.transform.toAlwaysTrue : _$.transform.toAlwaysFalse;

resources/assets/js/helpers/AppSettings.js

@@ -8,11 +8,11 @@ const _$ = boxedImmutable.box;
 const boxState = boxedImmutable.boxState;
 const util = boxedImmutable.util;
 const isArray = util.isArray;
-const eachKey = util.eachKey;
+const eachProp = util.eachProp;
 const copyFiltered = util.copyFiltered;
 const copyFilteredNot = util.copyFilteredNot;
 const isFunction = util.isFunction;
-const isObject = util.isObject;
+const isObject = util.isObjectLike;
 const UNDEFINED = util.UNDEFINED;
 
 const NON_UPDATE_FIELDS = [
@@ -116,7 +116,7 @@ export class GlobalSetting {
         this.updateSettingsType = {};
         copyFilteredNot.call(this.updateSettingsType, updateSettingsType, NON_UPDATE_FIELDS);
 
-        eachKey.call(this.updateSettingsType, (keyValue, key) => {
+        eachProp.call(this.updateSettingsType, (keyValue, key) => {
             switch (keyValue) {
                 case true:
                 case UPDATE_IMMEDIATE:
@@ -331,7 +331,7 @@ export class GlobalSetting {
         if (!this.sentUpdateFrameIds) this.sentUpdateFrameIds = {};
         const sentUpdateFrameId = ++this.serverUpdateFrameId;
 
-        eachKey.call(settingsUpdate, (value, key) => {
+        eachProp.call(settingsUpdate, (value, key) => {
             if (this.sentUpdates.hasOwnProperty(key)) {
                 this.sentUpdateFrameIds[key] = sentUpdateFrameId;
             }
@@ -365,7 +365,7 @@ export class GlobalSetting {
             let isUpdating = false;
 
             if (sentUpdates) {
-                eachKey.call(sentUpdates, (value, key) => {
+                eachProp.call(sentUpdates, (value, key) => {
                     if (value !== UNDEFINED) {
                         if (sentUpdateFrameIds.hasOwnProperty(key)) {
                             const sentUpdateFrameId = sentUpdateFrameIds[key];

resources/assets/js/helpers/GlobalSetting.js

@@ -167,12 +167,12 @@ const box = boxedImmutableImp.box;
 const util = boxedImmutableImp.util;
 
 export const extend = util.extend;
-export const eachKey = util.eachKey;
+export const eachProp = util.eachProp;
 export const hasOwnProperty = util.hasOwnProperty;
 export const hasOwnProperties = util.hasOwnProperties;
 export const isString = util.isString;
 export const isArray = util.isArray;
-export const isObject = util.isObject;
+export const isObject = util.isObjectLike;
 export const isFunction = util.isFunction;
 export const isNumeric = util.isNumeric;
 export const isNumericInteger = util.isNumericInteger;