refactor(helpers.tsx): updated dependencies, added example proj

added a new example project that makes use of redux-act-classy. This will help ensure we have better documentation and testing of the library BREAKING CHANGE: updated Typescript and other dependencies to latest version. Not well regression tested
Jackman3005 · May 8, 2021 · a33e8b7 · a33e8b7
1 parent f0d1be7
commit a33e8b7
Show file tree

Hide file tree

Showing 33 changed files with 14,858 additions and 1,662 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,9 @@ modern approach to redux action creation.
 [![Build Status](https://travis-ci.org/Jackman3005/redux-act-classy.svg?branch=master)](https://travis-ci.org/Jackman3005/redux-act-classy)
 [![Coverage Status](https://coveralls.io/repos/github/Jackman3005/redux-act-classy/badge.svg?branch=master)](https://coveralls.io/github/Jackman3005/redux-act-classy?branch=master)
 
+### Examples
+Are you a hands-on learner? Checkout this example project!
+[React Redux example app](examples/react-redux-app/README.md)
 
 ### Define a basic action
 ##### A basic action with a generated type

diff --git a/examples/react-redux-app/.env b/examples/react-redux-app/.env
@@ -0,0 +1 @@
+SKIP_PREFLIGHT_CHECK=true
diff --git a/examples/react-redux-app/.gitignore b/examples/react-redux-app/.gitignore
@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/examples/react-redux-app/README.md b/examples/react-redux-app/README.md
@@ -0,0 +1,13 @@
+# React Redux Example App
+This app demonstrates some basics for how to use `redux-act-classy` with a React + Redux project, including:
+- Normal Synchronous Action
+- Asynchronous Action
+    - In progress state
+
+Key Files:
+- [drinks.state.ts](./src/drinks.state.ts) reducer and actions
+- [App.tsx](./src/App.tsx) React component dispatching actions and using global redux state
+- [index.tsx](./src/index.tsx) Redux store initialization
+
+Here is a demo of the example app
+![Demo](./demo.gif)
diff --git a/examples/react-redux-app/demo.gif b/examples/react-redux-app/demo.gif
diff --git a/examples/react-redux-app/package.json b/examples/react-redux-app/package.json
@@ -0,0 +1,47 @@
+{
+  "name": "react-redux-app",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "preinstall": "cd ../../ && yarn build && npm link",
+    "postinstall": "npm link redux-act-classy",
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "dependencies": {
+    "@testing-library/jest-dom": "^5.11.4",
+    "@testing-library/react": "^11.1.0",
+    "@testing-library/user-event": "^12.1.10",
+    "@types/jest": "^26.0.15",
+    "@types/node": "^12.0.0",
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "react-redux": "^7.2.4",
+    "react-scripts": "4.0.3",
+    "redux": "^4.1.0",
+    "typescript": "^4.1.2",
+    "web-vitals": "^1.0.1"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
+}
diff --git a/examples/react-redux-app/public/favicon.ico b/examples/react-redux-app/public/favicon.ico
diff --git a/examples/react-redux-app/public/index.html b/examples/react-redux-app/public/index.html
@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Web site created using create-react-app"
+    />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>
diff --git a/examples/react-redux-app/public/logo192.png b/examples/react-redux-app/public/logo192.png
diff --git a/examples/react-redux-app/public/logo512.png b/examples/react-redux-app/public/logo512.png
diff --git a/examples/react-redux-app/public/manifest.json b/examples/react-redux-app/public/manifest.json
@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}
diff --git a/examples/react-redux-app/public/robots.txt b/examples/react-redux-app/public/robots.txt
@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:
diff --git a/examples/react-redux-app/src/App.css b/examples/react-redux-app/src/App.css
@@ -0,0 +1,55 @@
+.order-button {
+  width: 200px;
+  height: 50px;
+  font-size: 38px;
+  border-radius: 4px;
+  margin-left: 10px;
+  margin-bottom: 30px;
+}
+.drinks-counter {
+  width: 100px;
+  height: 46px;
+  font-size: 38px;
+  border-radius: 4px;
+
+  margin-bottom: 30px;
+}
+
+.App {
+  text-align: center;
+}
+
+.App-logo {
+  /*height: 40vmin;*/
+  pointer-events: none;
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  .App-logo {
+    animation: App-logo-spin infinite 2s linear;
+  }
+}
+
+.App-header {
+  background-color: #282c34;
+  min-height: 100vh;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  font-size: calc(10px + 2vmin);
+  color: white;
+}
+
+.App-link {
+  color: #61dafb;
+}
+
+@keyframes App-logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
diff --git a/examples/react-redux-app/src/App.test.tsx b/examples/react-redux-app/src/App.test.tsx
@@ -0,0 +1,9 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import App from './App';
+
+test('renders learn react link', () => {
+  render(<App />);
+  const linkElement = screen.getByText(/learn react/i);
+  expect(linkElement).toBeInTheDocument();
+});
diff --git a/examples/react-redux-app/src/App.tsx b/examples/react-redux-app/src/App.tsx
@@ -0,0 +1,55 @@
+import React, { ChangeEvent } from 'react'
+import logo from './logo.svg'
+import './App.css'
+import { useDispatch, useSelector } from 'react-redux'
+import { OrderDrinksAction, UpdateDrinkCountAction } from './drinks.state'
+import { AppState } from './index'
+
+function App() {
+  const numDrinks = useSelector<AppState, number>(state => state.drinks.currentCount)
+  const totalPrice = useSelector<AppState, number>(state => state.drinks.totalPrice)
+  const orderInProgress = useSelector<AppState, number>(state => state.actions.inProgress[OrderDrinksAction.TYPE])
+  const dispatch = useDispatch()
+
+  function updateNumberOfDrinks(event: ChangeEvent<HTMLInputElement>) {
+    const numDrinks = parseInt(event.target.value)
+    dispatch(new UpdateDrinkCountAction(numDrinks))
+  }
+
+  function orderDrinks() {
+    dispatch(new OrderDrinksAction())
+  }
+
+  return (
+    <div className="App">
+      <header className="App-header">
+        {!!orderInProgress && <img width={100} src={logo} className="App-logo" alt="logo"/>}
+        {!orderInProgress && <div style={{ height: 70 }}/>}
+        <div>
+          <p>How many drinks would you like?</p>
+          <input
+            className="drinks-counter"
+            value={numDrinks}
+            onChange={updateNumberOfDrinks}
+            type="number"
+          />
+          <button
+            className="order-button"
+            onClick={orderDrinks}
+          >Order
+          </button>
+        </div>
+        {!!orderInProgress && (
+          <div>Processing order...</div>
+        ) || <div>&nbsp;</div>
+        }
+        <div>
+          <br/>
+          You owe: ${totalPrice}
+        </div>
+      </header>
+    </div>
+  )
+}
+
+export default App
diff --git a/examples/react-redux-app/src/drinks.state.ts b/examples/react-redux-app/src/drinks.state.ts
@@ -0,0 +1,52 @@
+import { Classy, isAction, afterSuccess } from 'redux-act-classy'
+import { AnyAction, Dispatch } from 'redux'
+import { AppState } from './index'
+
+export class UpdateDrinkCountAction extends Classy() {
+  constructor(readonly numDrinksToFetch: number) { super()}
+}
+
+function sleep(ms: number) {
+  return new Promise((resolve) => {setTimeout(resolve, ms)})
+}
+
+interface OrderDrinksResponse {
+  price: number;
+}
+
+export class OrderDrinksAction extends Classy<OrderDrinksResponse>() {
+  async perform(dispatch: Dispatch, getState: () => AppState) {
+    await sleep(2500)
+    return {
+      price: getState().drinks.currentCount * 5.25,
+    }
+  }
+}
+
+export interface DrinksState {
+  currentCount: number;
+  totalPrice: number;
+}
+
+const defaultDrinksState: DrinksState = {
+  totalPrice: 0,
+  currentCount: 1,
+}
+
+function reducer(drinksState: DrinksState = defaultDrinksState, action: AnyAction) {
+  if (isAction(action, UpdateDrinkCountAction)) {
+    return {
+      ...drinksState,
+      currentCount: action.numDrinksToFetch,
+    }
+  } else if (afterSuccess(action, OrderDrinksAction)) {
+    return {
+      ...drinksState,
+      totalPrice: drinksState.totalPrice + action.successResult.price,
+    }
+  }
+  return drinksState
+}
+
+export default reducer
+
diff --git a/examples/react-redux-app/src/index.css b/examples/react-redux-app/src/index.css
@@ -0,0 +1,13 @@
+body {
+  margin: 0;
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
+    'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
+    sans-serif;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+code {
+  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
+    monospace;
+}
diff --git a/examples/react-redux-app/src/index.tsx b/examples/react-redux-app/src/index.tsx
@@ -0,0 +1,33 @@
+import React from 'react'
+import ReactDOM from 'react-dom'
+import './index.css'
+import App from './App'
+import { applyMiddleware, combineReducers, createStore } from 'redux'
+import { ActionsState, buildAClassyMiddleware, Classy, classyActionsReducer } from 'redux-act-classy'
+import drinksStateReducer, { DrinksState } from './drinks.state'
+import { Provider } from 'react-redux'
+
+export interface AppState {
+  actions: ActionsState,
+  drinks: DrinksState
+}
+
+Classy.globalConfig.debugEnabled = true
+
+const store = createStore(
+  combineReducers<AppState>({
+    actions: classyActionsReducer,
+    drinks: drinksStateReducer,
+  }),
+  applyMiddleware(buildAClassyMiddleware()),
+)
+
+
+ReactDOM.render(
+  <React.StrictMode>
+    <Provider store={store}>
+      <App/>
+    </Provider>
+  </React.StrictMode>,
+  document.getElementById('root'),
+)
diff --git a/examples/react-redux-app/src/logo.svg b/examples/react-redux-app/src/logo.svg
diff --git a/examples/react-redux-app/src/react-app-env.d.ts b/examples/react-redux-app/src/react-app-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="react-scripts" />