Merge pull request #67 from shipt/development

Release 1.1.1

.github/workflows/sast.yaml

@@ -1,25 +1,5 @@
-# This workflow is to automate Checkmarx SAST scans.  It runs on a push to the main branch.
-#
-# The following GitHub Secrets must be first defined:
-#   - CHECKMARX_URL
-#   - CHECKMARX_USER
-#   - CHECKMARX_PASSWORD
-#   - CHECKMARX_CLIENT_SECRET
-#
-# The following variables must be inserted below:
-#   - <ProjectName>
-#
-# Update the 'team' field to reflect the team name used in Checkmarx.
-#
-# For full documentation, including a list of all inputs, please refer to the README https://github.com/checkmarx-ts/checkmarx-cxflow-github-action
-
 name: Checkmarx SAST Scan
 on:
-  pull_request:
-    branches:
-      - main
-      - master
-      - development
   push:
     branches:
     - master

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## v1.1.1
+
+* Minor dependency updates
+
 ## v1.1.0
 
 * Removed deprecated class based container logic

examples/counter-react/src/App.js

@@ -1,5 +1,23 @@
-import Osmosis from '@shipt/osmosis';
-import { wrapCounter } from './store';
+import { StoreProvider, configureUsePersistedState } from '@shipt/osmosis';
+import { CounterWrapper, CounterWithReducerWrapper } from './store';
+
 import Counter from './counter';
+import PersistedCounter from './persistedCounter.js';
+import DispactCounter from './dispatchCounter.js';
+
+configureUsePersistedState({
+  getItem: key => JSON.parse(window.localStorage.getItem(key)),
+  setItem: (key, value) => window.localStorage.setItem(key, JSON.stringify(value))
+});
+
+const App = () => {
+  return (
+    <>
+      <Counter />
+      <PersistedCounter />
+      <DispactCounter />
+    </>
+  );
+};
 
-export default Osmosis.StoreProvider([wrapCounter], Counter);
+export default StoreProvider([CounterWrapper, CounterWithReducerWrapper], App);

examples/counter-react/src/__tests__/__snapshots__/counter.spec.js.snap

@@ -5,17 +5,18 @@ exports[`Counter renders default 1`] = `
   data-testid="counter-wrap"
 >
   <p>
+    Count: 
     0
   </p>
   <button
-    data-testid="increment"
+    data-testid="decrement"
   >
-    +
+    -
   </button>
   <button
-    data-testid="decrement"
+    data-testid="increment"
   >
-    -
+    +
   </button>
 </div>
 `;

examples/counter-react/src/__tests__/counter.spec.js

@@ -8,8 +8,8 @@ describe('Counter', () => {
     state: {
       count: 0
     },
-    increment: jest.fn(),
-    decrement: jest.fn()
+    incrementCount: jest.fn(),
+    decrementCount: jest.fn()
   };
   let ContextComponent = () => (
     <CounterContext.Provider value={[CounterStore]}>
@@ -23,11 +23,11 @@ describe('Counter', () => {
   it('tests increment button', async () => {
     let wrapper = await render(<ContextComponent />);
     fireEvent.click(wrapper.getByTestId('increment'));
-    expect(CounterStore.increment).toHaveBeenCalled();
+    expect(CounterStore.incrementCount).toHaveBeenCalled();
   });
   it('tests decrement button', async () => {
     let wrapper = await render(<ContextComponent />);
     fireEvent.click(wrapper.getByTestId('decrement'));
-    expect(CounterStore.decrement).toHaveBeenCalled();
+    expect(CounterStore.decrementCount).toHaveBeenCalled();
   });
 });

examples/counter-react/src/counter.js

@@ -7,13 +7,13 @@ const Counter = () => {
 
   return (
     <div data-testid="counter-wrap">
-      <p>{count}</p>
-      <button data-testid="increment" onClick={counterContext.increment}>
-        +
-      </button>
-      <button data-testid="decrement" onClick={counterContext.decrement}>
+      <p>Count: {count}</p>
+      <button data-testid="decrement" onClick={counterContext.decrementCount}>
         -
       </button>
+      <button data-testid="increment" onClick={counterContext.incrementCount}>
+        +
+      </button>
     </div>
   );
 };

examples/counter-react/src/dispatchCounter.js

@@ -0,0 +1,21 @@
+import React, { useContext } from 'react';
+import { CounterWithReducerContext } from './store';
+
+const PersistedCounter = () => {
+  const [counterContext] = useContext(CounterWithReducerContext);
+  let { dispatch, counterState: { count }} = counterContext;
+
+  return (
+    <div data-testid="counter-wrap">
+      <p>Dispatch Count: {count}</p>
+      <button data-testid="decrement" onClick={() => dispatch({type: 'decrement'})}>
+        -
+      </button>
+      <button data-testid="increment" onClick={() => dispatch({type: 'increment'})}>
+        +
+      </button>
+    </div>
+  );
+};
+
+export default PersistedCounter;

examples/counter-react/src/index.js

@@ -1,7 +1,6 @@
 import React from 'react';
 import ReactDOM from 'react-dom';
 import App from './App';
-import * as serviceWorker from './serviceWorker';
 
 ReactDOM.render(
   <React.StrictMode>
@@ -10,7 +9,3 @@ ReactDOM.render(
   document.getElementById('root')
 );
 
-// If you want your app to work offline and load faster, you can change
-// unregister() to register() below. Note this comes with some pitfalls.
-// Learn more about service workers: https://bit.ly/CRA-PWA
-serviceWorker.unregister();

examples/counter-react/src/persistedCounter.js

@@ -0,0 +1,21 @@
+import React, { useContext } from 'react';
+import { CounterContext } from './store';
+
+const PersistedCounter = () => {
+  const [counterContext] = useContext(CounterContext);
+  let { persistedCount } = counterContext.state;
+
+  return (
+    <div data-testid="counter-wrap">
+      <p>Persisted Count: {persistedCount}</p>
+      <button data-testid="decrement" onClick={counterContext.decrementPersistedCount}>
+        -
+      </button>
+      <button data-testid="increment" onClick={counterContext.incrementPersistedCount}>
+        +
+      </button>
+    </div>
+  );
+};
+
+export default PersistedCounter;

examples/counter-react/src/setupTests.js

@@ -3,3 +3,10 @@
 // expect(element).toHaveTextContent(/react/i)
 // learn more: https://github.com/testing-library/jest-dom
 import '@testing-library/jest-dom/extend-expect';
+import 'regenerator-runtime/runtime';
+
+import { configureUsePersistedState } from '@shipt/osmosis';
+configureUsePersistedState({
+  getItem: ()=> {},
+  setItem: () => {}
+});

examples/counter-react/src/store/__tests__/counter.store.spec.js

@@ -1,12 +1,12 @@
 import React, { useContext } from 'react';
-import { CounterContext, wrapCounter } from '../counter.store';
+import { CounterContext, CounterWrapper} from '../counter.store';
 import { render } from '@testing-library/react';
 import { act } from 'react-dom/test-utils';
 
 describe('CounterStore', () => {
   let store;
   const renderStore = () => {
-    let Prep = wrapCounter(() => {
+    let Prep = CounterWrapper(() => {
       store = useContext(CounterContext)[0];
       return null;
     });
@@ -19,7 +19,7 @@ describe('CounterStore', () => {
     });
     expect(store.state.count).toEqual(0);
     act(() => {
-      store.increment();
+      store.incrementCount();
     });
     expect(store.state.count).toEqual(1);
   });
@@ -30,7 +30,7 @@ describe('CounterStore', () => {
     });
     expect(store.state.count).toEqual(0);
     act(() => {
-      store.decrement();
+      store.decrementCount();
     });
     expect(store.state.count).toEqual(-1);
   });