Merge pull request #18 from alevnyacow/feature/tests-and-rewrite-whole

version 2.0.0

Author: alevnyacow

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 package-lock.json
-transpiled
+transpiled
+*.tgz

README.md

@@ -9,11 +9,18 @@
 
 ## ✨ **About**
 
-Shared React variables provide you easy and comfortable mutable state management based on hooks. It's extremely simple - you generate a hook in one line and then you can use it anywhere to operate with your state! Also you can have any number of such state variables in your application. 
+Shared React variables provide you easy and comfortable mutable state management based on hooks.
+
+## 🔍 **Example**
 
 ```tsx
-// creating timer state hook
-const useTimer = createUseSharedVariable({ ticks: 0 });
+const [
+    // returns a mutable state
+    useTimer,
+    // use it to rewrite the whole variable,
+    // normally you don't need it
+    useTimerRewrite
+] = createUseSharedVariable({ ticks: 0 });
 
 const Timer = () => {
     // using timer state
@@ -36,36 +43,6 @@ const AnotherTimerWithSameState = () => {
 };
 ```
 
-## 📖 **API**
-
-### **1. createUseSharedVariable**
-#### Description
-Takes initial state as a parameter. Returns a hook can be imported and used anywhere in your application. When you use this hook, it returns you mutable global state. Whenever this state is changed component will be rerendered (this behaviour can be changed via *rerenderOnChange* flag in the hook).
-
-#### Signature
-```ts
-<T extends object>(initialState: T) => ReactVariableHook<T>;
-```
-
-#### Usage example
-```ts
-// feel free to use this state hook anywhere!
-const useTimer = createUseSharedVariable({ ticks: 0 });
-
-export { useTimer }
-```
-
-
-## 🔍 **Exported types**
-
-### **1. ReactVariableHook**
-#### Description
-Describes signature of a hook which returns *createUseSharedVariable* method.
-#### Signature
-```ts
-type ReactVariableHook<T> = (rerenderOnChange?: boolean) => T;
-```
-
-## 💡 **Package usage example**
+## 💡 **Codesandbox**
 
 https://codesandbox.io/s/react-shared-variables-example-f7feo7

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@alevnyacow/shared-react-variables",
-  "version": "1.0.4",
+  "version": "2.0.0",
   "description": "Easy and comfortable React state manager",
   "main": "transpiled/index.js",
   "scripts": {
-    "test": "jest",
+    "test": "npm run build && npm pack && cd ./tests/test-application && npm i && npm run test",
     "clean_transpiled": "del-cli --force ./transpiled",
     "format": "prettier --config .prettierrc --write sources/**",
     "lint": "eslint sources/**/*.ts --ext .ts",

sources/index.ts

@@ -5,17 +5,20 @@ import { useRerenderer } from "./use-rerenderer";
 import { rerenderersList } from "./rerenderers-list";
 
 type ReactVariableHook<T> = (rerenderOnChange?: boolean) => T;
+type ReactVariableRewriteHook<T> = () => (
+    generator: (oldState: T) => T
+) => void;
 
-function createUseSharedVariable<T extends object>(
-    initialState: T
-): ReactVariableHook<T> {
+function createUseSharedVariable<T extends object>(initialState: T) {
     const variableIdentifier = v4();
-    const sharedVariable = deepProxy(
+    let sharedVariable = deepProxy(
         [rerenderersList.fire],
         variableIdentifier
     )(initialState);
 
-    function useSharedVariable(rerenderOnChange = true) {
+    const useSharedVariable: ReactVariableHook<T> = (
+        rerenderOnChange = true
+    ) => {
         const rerenderer = useRerenderer();
         const memoizedRerenderer = useCallback(rerenderer, []);
         const rerenderIdentifier = useRef(v4());
@@ -34,9 +37,18 @@ function createUseSharedVariable<T extends object>(
         }, []);
 
         return sharedVariable;
-    }
+    };
 
-    return useSharedVariable;
+    const useSharedVariableRewrite: ReactVariableRewriteHook<T> =
+        () => (generator: (oldState: T) => T) => {
+            sharedVariable = deepProxy(
+                [rerenderersList.fire],
+                variableIdentifier
+            )(generator(sharedVariable)) as T;
+            rerenderersList.fire(variableIdentifier);
+        };
+
+    return [useSharedVariable, useSharedVariableRewrite] as const;
 }
 
-export { createUseSharedVariable, ReactVariableHook };
+export { createUseSharedVariable, ReactVariableHook, ReactVariableRewriteHook };

tests/test-application/.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*

tests/test-application/README.md

@@ -0,0 +1,46 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).

tests/test-application/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "test-application",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@alevnyacow/shared-react-variables": "file:../../alevnyacow-shared-react-variables-2.0.0.tgz",
+    "@testing-library/jest-dom": "^5.16.2",
+    "@testing-library/react": "^12.1.4",
+    "@testing-library/user-event": "^13.5.0",
+    "@types/jest": "^27.4.1",
+    "@types/node": "^16.11.26",
+    "@types/react": "^17.0.40",
+    "@types/react-dom": "^17.0.13",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "react-scripts": "5.0.0",
+    "typescript": "^4.6.2",
+    "web-vitals": "^2.1.4"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "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"
+    ]
+  }
+}

tests/test-application/public/favicon.ico

@@ -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>