Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brodanoel/duix
A State Manager focused on KISS and Pareto's Principle
https://github.com/brodanoel/duix
callback callbacks kiss manager pareto pareto-principle redux state state-management state-manager statemanager vuex
Last synced: 10 days ago
JSON representation
A State Manager focused on KISS and Pareto's Principle
- Host: GitHub
- URL: https://github.com/brodanoel/duix
- Owner: BrodaNoel
- License: mit
- Created: 2018-12-20T21:32:48.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T22:16:53.000Z (over 1 year ago)
- Last Synced: 2024-10-12T08:47:27.418Z (26 days ago)
- Topics: callback, callbacks, kiss, manager, pareto, pareto-principle, redux, state, state-management, state-manager, statemanager, vuex
- Language: JavaScript
- Homepage:
- Size: 153 KB
- Stars: 51
- Watchers: 4
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# DUIX
A Simple library to keep vars on sync between components (or whatever). It's just a matter of callbacks. Use it as you want.
## The `duix` approach
`duix` just have a state that is just a plain (private) object, and some listeners (publish-subscribers) that are gonna be called every time the subscribed-value change.
It's just a Publish Subscriber lib + a private object (the state). Duix clone the received object, and send a cloned object to the subscribers, in order to keep the immutability of the store.
# API doc
With examples. People need examples!
- `duix.get('user')`: Returns (it's NOT a promise) the `user` value. This value is safe to be mutated. It's not going to mutate the state.
- `duix.set('user', { name: 'Noel' })`: This set the `user` value. It can be ab Object, Array, null, whatever. You can safely mutate the object after setting it. It's not going to mutate the state.
- `duix.subscribe('user', (newValue, oldValue) => { /* ... */ })`: Subscribe a callback on every change made in `user`. A change on `user` can be made only by calling `duix.set('user', {\* ... *\})` with a different value that the value is currently on the state. This function also returns a function that if you call it, you unsubcribe to the changes (example below).
Here the unsubscribe example:
```js
// Subscribe
const unsubscriber = duix.subscribe('user', (newValue, oldValue) => {
/* ... */
});
// Unsubscribe
unsubscriber();
```
See below for some advanced usages.
## The Counter Example
1. `Buttons` component is gonna add or subtract.
2. `Viewer` component is gonna show the value
```js
// index.js
import duix from 'duix';
// Set `null` as default `user` value
duix.set('githubStars', 0);
class App extends Component {
// ...
}
```
```js
// Buttons.js
import duix from 'duix';
class Buttons extends Component {
handleAdd = () => {
const currentValue = duix.get('githubStars');
duix.set('githubStars', currentValue + 1);
};
handleSubtract = () => {
const currentValue = duix.get('githubStars');
duix.set('githubStars', currentValue - 1);
};
// ...
}
```
```js
// Viewer.js
import duix from 'duix';
class Viewer extends Component {
unsubscribe = [];
state = {
githubStars: duix.get('githubStars'), // get initial value
};
componentDidMount() {
this.unsubscribe[0] = duix.subscribe('githubStars', this.onStarsChange);
}
componentWillUnmount() {
this.unsubscribe[0]();
}
onStarsChange = githubStars => {
this.setState({ githubStars });
};
render() {
return
{this.state.githubStars} stars;
}
}
```
So, could you understand what happened there? Only 3 things on `duix`:
1. Someone needs to set the default value
2. Someone is gonna get the initial value, and also `subscribe` to any change
3. Someone is gonna `set` the new value every time it have to be changed.
## The Login Example
1. The main file in the app defines the initial value for the `user` object.
2. The `Header` component is subscribed to the changes of `user` (because if the `user` object is not `null`, it's because the user is logged).
3. The `Login` component is gonna call a function that is gonna do the API call to check if the credentials are OK.
4. The `LogOut` component is gonna logout the user. :shrug:
The code:
```js
// index.js
import duix from 'duix';
// Set `null` as default `user` value
duix.set('user', null);
class App extends Component {
// ...
}
```
```js
// Login.js
import duix from 'duix';
// Let's suppose this `actions` is an object with all the functions necessary to login an user
import { loginWithCredentials } from 'actions';
class Login extends Component {
handleLogin = (email, password) => {
// The `Login` component is not gonna change the `user` object. Instead, the `loginWithCredentials` is gonna do it.
loginWithCredentials(email, password);
};
// ...
}
```
```js
// Logout.js
import duix from 'duix';
class Logout extends Component {
handleLogout = () => {
duix.set('user', null);
};
// ...
}
```
```js
// actions.js
import duix from 'duix';
export default {
loginWithCredentials: (email, password) => {
fetch(
'http://example.com/api/login'
// ...
)
.then(r => r.json())
.then(user => {
/**
* Whatever the backend send us, let's set it.
*
* Let's suppose the backend send `null` if the credentials were wrong,
* or the proper `user` object if the credentials were OK.
*/
duix.set('user', user);
});
},
};
```
```js
// Header.js
import duix from 'duix';
class Header extends Component {
unsubscribe = [];
state = {
user: null,
};
componentDidMount() {
// Let's subscribe to the `user` changes
this.unsubscribe[0] = duix.subscribe('user', this.onUserChange);
}
componentWillUnmount() {
// Let's unsubscribe.
this.unsubscribe[0]();
}
onUserChange = user => {
this.setState({ user });
};
render() {
return
{this.state.user && `Hello ${this.state.user.name}`};
}
}
```
So, could you understand what happened there? Only 3 things on `duix`:
1. Someone needs to set the default value
2. Someone is gonna `subscribe` to a value change, or unsubscribe when component unmount.
3. Someone is gonna `set` the new value every time it changes
## Advanced options/usages
When subscribing to a value, you can choose special behaviors by passing an object as third parameter:
```lang=javascript
duix.subscribe(key, callback, {
fireImmediately: false
});
```
| option | default value | comment |
| --------------- | ------------- | -------------------------------------------------------------------- |
| fireImmediately | false | Should duix callback immediately with the value currently in memory? |
## Why was it created?
Because some ~most~ of the current State Managers libs add too unnecessary complexity (even in the learning curve, or arch, or high coupling between components).
The idea of `duix` is to reuse some old knowledge to solve only one simple problem: Keep 2 components on sync.
There are 2 things that I keep on mind while working:
1. **KISS principle**: Keep it simple, stupid.
2. **Pareto's principle**: The 80% and 20%. The 80% of your bugs, are gonna be always the same 2 or 3 issues that you always see in every project.
The KISS principle is very clear, but I believe the Pareto principle deserves more details:
I believe that if you added a State Manager in 10 projects, you may added it 8 times just to solve 1 issue: "Keep a couple of vars on sync between components".
On another hand, you also added it 2 for solving tons of issues that it absolutelly worth it.
But, what about those 8 times that you added, let's say, Redux, only to keep 1 var on sync? You only needed a global state var and a callback, but you added the whole Redux library (complexity, a lot of complexity my friend).
The idea of `duix` is to cover those 8 times that you added Redux only because you needed to keep on sync vars between components. Just that. There is a global `state` object, where you `set`, or `get` values, and you can `subscribe` or `unsubscribe` of their changes. Every time someone `set` a new value, all the subscribers are gonna be called receiving the new and the old value.
If your team is not feeling very well with the current State Managers complexity (you may know a lot of devs with that feeling), I'd say that you should try this tool.
"That's all, folks"
PS: 10 minutes ago it was Christmas. This is my gift for te community.