Merge pull request #126 from blueflag/feature/logging

Unmutable upgrade and logging
92green · Oct 23, 2018 · 200f9a8 · 200f9a8
2 parents 5988cfd + 3348305
commit 200f9a8
Show file tree

Hide file tree

Showing 24 changed files with 152 additions and 20 deletions.
diff --git a/packages/dataparcels-docs/src/component/ApiPage.jsx b/packages/dataparcels-docs/src/component/ApiPage.jsx
@@ -1,6 +1,7 @@
 // @flow
 import type {Node} from 'react';
 import React from 'react';
+import {Fragment} from 'react';
 import {Box, Grid, GridItem, NavigationList, NavigationListItem, Text, Typography} from 'dcme-style';
 import Link from 'component/Link';
 import SiteNavigation from 'component/SiteNavigation';
@@ -64,10 +65,18 @@ export default ({name, api, md, after}: Props) => {
             {renderDoclets({api, md})}
             {After && <Typography><After /></Typography>}
         </Box>}
-        nav={() => <NavigationList>
-            <NavigationListItem><Link to="/api">Api</Link></NavigationListItem>
-            <NavigationListItem>{name}</NavigationListItem>
-            {renderApi(api)}
-        </NavigationList>}
+        nav={() => <Fragment>
+            <NavigationList>
+                <NavigationListItem><Link to="/api">Api</Link></NavigationListItem>
+                <NavigationListItem><Link to="/api/Parcel">Parcel</Link></NavigationListItem>
+                <NavigationListItem><Link to="/api/ParcelHoc">ParcelHoc</Link></NavigationListItem>
+                <NavigationListItem><Link to="/api/ParcelBoundary">ParcelBoundary</Link></NavigationListItem>
+                <NavigationListItem><Link to="/api/ParcelBoundaryHoc">ParcelBoundaryHoc</Link></NavigationListItem>
+            </NavigationList>
+            <NavigationList>
+                <NavigationListItem>{name}</NavigationListItem>
+                {renderApi(api)}
+            </NavigationList>
+        </Fragment>}
     />;
 };
diff --git a/packages/dataparcels-docs/src/docs/api/parcel/log.md b/packages/dataparcels-docs/src/docs/api/parcel/log.md
@@ -1,3 +1,5 @@
 ```flow
 log(name: string?): Parcel
 ```
+
+Output's the parcel's data to the console each time data flows downward, and outputs the ChangeRequest each time a change has propagated upward.
diff --git a/packages/dataparcels-docs/src/docs/api/parcel/toConsole.md b/packages/dataparcels-docs/src/docs/api/parcel/toConsole.md
@@ -0,0 +1,5 @@
+```flow
+toConsole(): void
+```
+
+Outputs the parcel's data to the console.
diff --git a/packages/dataparcels-docs/src/docs/api/parcelBoundary/ParcelBoundary.md b/packages/dataparcels-docs/src/docs/api/parcelBoundary/ParcelBoundary.md
@@ -29,6 +29,7 @@ import {ParcelBoundary} from 'react-dataparcels';
     forceUpdate={?Array<*>}
     hold={?boolean}
     debugBuffer={?boolean}
+    debugParcel={?boolean}
 >
     {(parcel, actions) => Node}
 </ParcelBoundary>

diff --git a/packages/dataparcels-docs/src/docs/api/parcelBoundary/debugParcel.md b/packages/dataparcels-docs/src/docs/api/parcelBoundary/debugParcel.md
@@ -0,0 +1,5 @@
+```flow
+debugParcel?: boolean = false // optional
+```
+
+Wehn `debugParcel` is true, ParcelBoundary will log out changes to its current parcel state.
diff --git a/packages/dataparcels-docs/src/docs/api/parcelBoundaryHoc/ParcelBoundaryHoc.md b/packages/dataparcels-docs/src/docs/api/parcelBoundaryHoc/ParcelBoundaryHoc.md
@@ -31,6 +31,7 @@ ParcelBoundaryHoc({
     originalParcelProp?: string | (props: *) => string,
     // debugging options
     debugBuffer?: boolean
+    debugParcel?: boolean
 });
 ```
 

diff --git a/packages/dataparcels-docs/src/docs/api/parcelBoundaryHoc/debugParcel.md b/packages/dataparcels-docs/src/docs/api/parcelBoundaryHoc/debugParcel.md
@@ -0,0 +1,5 @@
+```flow
+debugParcel?: boolean = false // optional
+```
+
+Wehn `debugParcel` is true, ParcelBoundaryHoc will log out changes to its current parcel state.
diff --git a/packages/dataparcels-docs/src/docs/api/parcelHoc/ParcelHoc.md b/packages/dataparcels-docs/src/docs/api/parcelHoc/ParcelHoc.md
@@ -27,6 +27,7 @@ ParcelHoc({
     delayUntil?: Function,
     pipe?: Function
     // debugging options
+    debugParcel?: boolean
     debugRender?: boolean
 });
 ```

diff --git a/packages/dataparcels-docs/src/docs/api/parcelHoc/debugParcel.md b/packages/dataparcels-docs/src/docs/api/parcelHoc/debugParcel.md
@@ -0,0 +1,7 @@
+import Link from 'component/Link';
+
+```flow
+debugParcel?: boolean = false // optional
+```
+
+For debugging purposes. When set to `true` this logs the ParcelHoc's parcel each time it changes.
diff --git a/packages/dataparcels-docs/src/pages/api/Parcel.jsx b/packages/dataparcels-docs/src/pages/api/Parcel.jsx
@@ -59,6 +59,7 @@ import Markdown_spy from 'docs/api/parcel/spy.md';
 import Markdown_spyChange from 'docs/api/parcel/spyChange.md';
 import Markdown_pipe from 'docs/api/parcel/pipe.md';
 import Markdown_matchPipe from 'docs/api/parcel/matchPipe.md';
+import Markdown_toConsole from 'docs/api/parcel/toConsole.md';
 
 const md = {
     _desc: Markdown_Parcel,
@@ -117,7 +118,8 @@ const md = {
     spy: Markdown_spy,
     spyChange: Markdown_spyChange,
     pipe: Markdown_pipe,
-    matchPipe: Markdown_matchPipe
+    matchPipe: Markdown_matchPipe,
+    toConsole: Markdown_toConsole
 }
 
 const api = `
@@ -191,14 +193,17 @@ isTopLevel()
 hasDispatched()
 
 # Side-effect methods
-log()
 spy()
 spyChange()
 
 # Composition methods
 pipe()
 matchPipe()
 
+# Debug methods
+log()
+toConsole()
+
 `;
 
 export default () => <ApiPage

diff --git a/packages/dataparcels-docs/src/pages/api/ParcelBoundary.jsx b/packages/dataparcels-docs/src/pages/api/ParcelBoundary.jsx
@@ -11,6 +11,7 @@ import Markdown_debounce from 'docs/api/parcelBoundary/debounce.md';
 import Markdown_hold from 'docs/api/parcelBoundary/hold.md';
 import Markdown_pure from 'docs/api/parcelBoundary/pure.md';
 import Markdown_debugBuffer from 'docs/api/parcelBoundary/debugBuffer.md';
+import Markdown_debugParcel from 'docs/api/parcelBoundary/debugParcel.md';
 
 const md = {
     _desc: Markdown_ParcelBoundary,
@@ -21,7 +22,8 @@ const md = {
     debounce: Markdown_debounce,
     hold: Markdown_hold,
     pure: Markdown_pure,
-    debugBuffer: Markdown_debugBuffer
+    debugBuffer: Markdown_debugBuffer,
+    debugParcel: Markdown_debugParcel
 }
 
 const api = `
@@ -35,6 +37,7 @@ pure
 forceUpdate
 hold
 debugBuffer
+debugParcel
 `;
 
 export default () => <ApiPage

diff --git a/packages/dataparcels-docs/src/pages/api/ParcelBoundaryHoc.jsx b/packages/dataparcels-docs/src/pages/api/ParcelBoundaryHoc.jsx
@@ -8,6 +8,7 @@ import Markdown_originalParcelProp from 'docs/api/parcelBoundaryHoc/originalParc
 import Markdown_debounce from 'docs/api/parcelBoundaryHoc/debounce.md';
 import Markdown_hold from 'docs/api/parcelBoundaryHoc/hold.md';
 import Markdown_debugBuffer from 'docs/api/parcelBoundaryHoc/debugBuffer.md';
+import Markdown_debugParcel from 'docs/api/parcelBoundaryHoc/debugParcel.md';
 import Markdown_childName from 'docs/api/parcelBoundaryHoc/childName.md';
 import Markdown_childNameActions from 'docs/api/parcelBoundaryHoc/childNameActions.md';
 import Markdown_childOriginalParcelProp from 'docs/api/parcelBoundaryHoc/childOriginalParcelProp.md';
@@ -19,6 +20,7 @@ const md = {
     debounce: Markdown_debounce,
     hold: Markdown_hold,
     debugBuffer: Markdown_debugBuffer,
+    debugParcel: Markdown_debugParcel,
     ['${name}']: Markdown_childName,
     ['${name}Actions']: Markdown_childNameActions,
     ['${originalParcelProp}']: Markdown_childOriginalParcelProp
@@ -31,6 +33,7 @@ originalParcelProp
 debounce
 hold
 debugBuffer
+debugParcel
 
 # Child props
 $\{name\}

diff --git a/packages/dataparcels-docs/src/pages/api/ParcelHoc.jsx b/packages/dataparcels-docs/src/pages/api/ParcelHoc.jsx
@@ -10,6 +10,7 @@ import Markdown_valueFromProps from 'docs/api/parcelHoc/valueFromProps.md';
 import Markdown_delayUntil from 'docs/api/parcelHoc/delayUntil.md';
 import Markdown_onChange from 'docs/api/parcelHoc/onChange.md';
 import Markdown_pipe from 'docs/api/parcelHoc/pipe.md';
+import Markdown_debugParcel from 'docs/api/parcelHoc/debugParcel.md';
 import Markdown_debugRender from 'docs/api/parcelHoc/debugRender.md';
 import Markdown_childName from 'docs/api/parcelHoc/childName.md';
 
@@ -22,6 +23,7 @@ const md = {
     delayUntil: Markdown_delayUntil,
     onChange: Markdown_onChange,
     pipe: Markdown_pipe,
+    debugParcel: Markdown_debugParcel,
     debugRender: Markdown_debugRender,
     ['${name}']: Markdown_childName
 }
@@ -34,6 +36,7 @@ onChange
 shouldParcelUpdateFromProps
 delayUntil
 pipe
+debugParcel
 debugRender
 
 # Child props

diff --git a/packages/dataparcels/package.json b/packages/dataparcels/package.json
@@ -23,6 +23,6 @@
   },
   "dependencies": {
     "escape-string-regexp": "^1.0.5",
-    "unmutable": "^0.34.0"
+    "unmutable": "^0.37.0"
   }
 }
diff --git a/packages/dataparcels/src/parcel/Parcel.js b/packages/dataparcels/src/parcel/Parcel.js
@@ -365,4 +365,7 @@ export default class Parcel {
     // Advanced methods
     getInternalLocationShareData = (): * => this._methods.getInternalLocationShareData();
     setInternalLocationShareData = (partialData: Object): * => this._methods.setInternalLocationShareData(partialData);
+
+    // Debug methods
+    toConsole = () => this._methods.toConsole();
 }
diff --git a/packages/dataparcels/src/parcel/__test__/ParcelTypes-test.js b/packages/dataparcels/src/parcel/__test__/ParcelTypes-test.js
@@ -18,12 +18,12 @@ test('ParcelTypes should correctly identify date', () => {
     var data = {
         value: new Date()
     };
-    expect(new Parcel(data).isParent()).toBe(true);
+    expect(new Parcel(data).isParent()).toBe(false);
     expect(new Parcel(data).isIndexed()).toBe(false);
     expect(new Parcel(data).isChild()).toBe(false);
     expect(new Parcel(data).isElement()).toBe(false);
     expect(new Parcel(data).isTopLevel()).toBe(true);
-    expect(new Parcel(data)._parcelTypes.toTypeCode()).toBe("ceiPT");
+    expect(new Parcel(data)._parcelTypes.toTypeCode()).toBe("ceipT");
 });
 
 test('ParcelTypes should correctly identify object values', () => {
@@ -47,6 +47,22 @@ test('ParcelTypes should correctly identify class instance values', () => {
     var data = {
         value: new Thing()
     };
+    expect(new Parcel(data).isParent()).toBe(false);
+    expect(new Parcel(data).isIndexed()).toBe(false);
+    expect(new Parcel(data).isChild()).toBe(false);
+    expect(new Parcel(data).isElement()).toBe(false);
+    expect(new Parcel(data).isTopLevel()).toBe(true);
+    expect(new Parcel(data)._parcelTypes.toTypeCode()).toBe("ceipT");
+});
+
+test('ParcelTypes should correctly identify unmutable compatible class instance values', () => {
+    class UnmutableCompatible {
+        __UNMUTABLE_COMPATIBLE__ = true;
+        foo = "123";
+    }
+    var data = {
+        value: new UnmutableCompatible()
+    };
     expect(new Parcel(data).isParent()).toBe(true);
     expect(new Parcel(data).isIndexed()).toBe(false);
     expect(new Parcel(data).isChild()).toBe(false);
@@ -55,6 +71,7 @@ test('ParcelTypes should correctly identify class instance values', () => {
     expect(new Parcel(data)._parcelTypes.toTypeCode()).toBe("ceiPT");
 });
 
+
 test('ParcelTypes should correctly identify Immutable.js Map values', () => {
     var data = {
         value: Map({

diff --git a/packages/dataparcels/src/parcel/methods/ParcelGetMethods.js b/packages/dataparcels/src/parcel/methods/ParcelGetMethods.js
@@ -92,7 +92,7 @@ export default (_this: Parcel) => ({
         _this._log = true;
         _this._logName = name;
         console.log(`Parcel data: ${name} `);
-        console.log(JSON.parse(JSON.stringify(_this.data)));
+        _this.toConsole();
         return _this;
     },
 
@@ -111,5 +111,11 @@ export default (_this: Parcel) => ({
                 _this.dispatch(changeRequest);
             }
         });
+    },
+
+    // Debug methods
+
+    toConsole: () => {
+        console.log(JSON.parse(JSON.stringify(_this.data)));
     }
 });
diff --git a/packages/dataparcels/src/parcelData/isIndexedValue.js b/packages/dataparcels/src/parcelData/isIndexedValue.js
@@ -1,6 +1,7 @@
 // @flow
 import isIndexed from 'unmutable/lib/util/isIndexed';
+import isWriteable from 'unmutable/lib/util/isWriteable';
 
 export default (value: *): boolean => {
-    return isIndexed(value);
+    return isIndexed(value) && isWriteable(value);
 };
diff --git a/packages/dataparcels/src/parcelData/isParentValue.js b/packages/dataparcels/src/parcelData/isParentValue.js
@@ -1,6 +1,7 @@
 // @flow
 import isValueObject from 'unmutable/lib/util/isValueObject';
+import isWriteable from 'unmutable/lib/util/isWriteable';
 
 export default (value: *): boolean => {
-    return isValueObject(value);
+    return isValueObject(value) && isWriteable(value);
 };
diff --git a/packages/react-dataparcels/package.json b/packages/react-dataparcels/package.json
@@ -23,6 +23,6 @@
   },
   "dependencies": {
     "dataparcels": "^0.16.0-0",
-    "unmutable": "^0.34.0"
+    "unmutable": "^0.37.0"
   }
 }