Readme File - Invisible Reducer #42

Anisospina · 2019-02-05T16:56:34Z

Summary

Added Readme File

Screenshots

Trello Card:

https://trello.com/c/ski2UTqu/41-invisible-reducer-documentation

marianozicavo

Great! 😀

I think we should make some changes.

I think we need a link in the main README that leads here. The user will always read the main README first.
The documentation needs to talk about wrapService, wrapReducer and createExternalActions, as those are the functions you use for invisible reducers. I think the concept of the IR is difficult to understand from an example alone. I would approach it by showing a "traditional" r-r reducer, then showing how you can improve it with an IR explaining step by step how to transform it.
I think the docs need to talk about what makes a IR preferable in some cases (always using the same service to do the same changes to the state, then you just couple the service with the reducer).

All this is just how I see it. I'd like to have more feedback on this PR to see if someone else thinks the same. @mvbattan mostly 😛

marianozicavo · 2019-03-19T13:23:40Z

src/invisible/README.md

@@ -0,0 +1,71 @@
+![coverage](https://img.shields.io/badge/Coverage-92%25-E01563.svg) ![downloads](https://img.shields.io/npm/dw/redux-recompose.svg?colorB=99d000&label=Downloads&style=popout) [![supported by](https://img.shields.io/badge/Supported%20by-Wolox.💗-blue.svg)](https://www.wolox.com.ar/) 


Let's add these shields in another PR, so we can separate that from the documentation

marianozicavo · 2019-03-19T13:26:36Z

src/invisible/README.md

+![coverage](https://img.shields.io/badge/Coverage-92%25-E01563.svg) ![downloads](https://img.shields.io/npm/dw/redux-recompose.svg?colorB=99d000&label=Downloads&style=popout) [![supported by](https://img.shields.io/badge/Supported%20by-Wolox.💗-blue.svg)](https://www.wolox.com.ar/) 
+# Invisible Reducer 👻
+
+By using invisible reducer, repeating the same logic in each of the reducers is avoided. 


an invisible reducer

marianozicavo · 2019-03-19T13:27:12Z

src/invisible/README.md

+
+By using invisible reducer, repeating the same logic in each of the reducers is avoided. 
+
+It is a extracting your cross-reducer logic, so this logic keeps isolated and reusable by our other reducers. Also, it keeps hidden from other reducers, so 👻.  


is extracting
Also, it is kept hidden from other reducers

marianozicavo · 2019-03-19T13:35:10Z

src/invisible/README.md

+In a few words, less work...
+
+
+### Learn Redux-recompose


I don't think we need this here, as the person reading this probably already knows r-r

marianozicavo · 2019-03-19T13:36:09Z

src/invisible/README.md

+
+If you are not aware, we invite you to read  [**Redux-recompose**](https://github.com/Wolox/redux-recompose)
+
+### Installation 


Nice! I hadn't noticed we didn't have the installation instructions.

This should go in the main README (in another PR).

marianozicavo · 2019-03-19T13:55:45Z

src/invisible/README.md

+
+### Example
+Then use it in your app, already implemented redux, we add wrapCombineReducers:
+```


Use ```js so github adds syntax highlighting to the code

marianozicavo · 2019-03-19T13:56:31Z

src/invisible/README.md

+
+By default, redux-recompose ships with a default invisible reducer that is the following:
+
+```


Same as before, we need to add js

marianozicavo · 2019-03-19T13:56:46Z

src/invisible/README.md

+import onFailure from '../../effects/onFailure';
+
+
+// TODO: Let the user specify selectors


I wouldn't show this TODO in the docs

marianozicavo · 2019-03-19T13:56:53Z

src/invisible/README.md

+
+export const defaultActionNames = Object.keys(reducerDescription);
+
+// TODO: Let user specify this initialState


I wouldn't show this TODO in the docs

guidoprinc · 2019-03-20T13:04:03Z

src/invisible/README.md

+![coverage](https://img.shields.io/badge/Coverage-92%25-E01563.svg) ![downloads](https://img.shields.io/npm/dw/redux-recompose.svg?colorB=99d000&label=Downloads&style=popout) [![supported by](https://img.shields.io/badge/Supported%20by-Wolox.💗-blue.svg)](https://www.wolox.com.ar/) 
+# Invisible Reducer 👻
+
+By using invisible reducer, repeating the same logic in each of the reducers is avoided. 


, we avoid repeating the same logic in each of the reducers.

guidoprinc · 2019-03-20T13:09:38Z

src/invisible/README.md

+ // Add here your reducers as usual.
+});
+```
+CombineReducers: utility from redux. This helps merge several reducers into a root one. Each reducer is part of the global state


global state.

marianozicavo · 2021-03-18T21:54:57Z

Hola @Anisospina !
Está por salir la version 3.0 de redux-recompose y estamos revisando el estado los PRs abiertos.

Me parece que a la documentación del reducer invisible todavía le falta un poco de explicación de los items que comenté acá. En la branch de 3.0 hay un archivo recipes/INVISIBLE.md que tiene el link a un post explicando el reducer invisible y una demo de ejemplo. Si querés actualizar el PR, podés hacerlo en ese archivo.
De todas formas voy a pedirle a los otros chicos de react-native que lo miren para que den una opinión, ya que ellos son los que la usan en el día a día.

La forma de poner "al día" este PR si querés hacerlo es

~~cambiar la base branch del PR por la branch 3.0~~
solucionar conflictos y comentarios

Readme

037fa63

Anisospina requested review from marianozicavo and mvbattan February 5, 2019 16:56

mvbattan self-assigned this Feb 11, 2019

marianozicavo self-assigned this Feb 19, 2019

marianozicavo suggested changes Mar 19, 2019

View reviewed changes

marianozicavo removed their assignment Mar 19, 2019

marianozicavo requested review from wfolini, guidoprinc and damfinkel March 19, 2019 19:04

guidoprinc suggested changes Mar 20, 2019

View reviewed changes

guidoprinc assigned Anisospina Mar 20, 2019

Anisospina and others added 2 commits May 5, 2019 19:06

Grammatical error corrections

6f16ccf

merge dev

4ba4f17

Anisospina requested review from marianozicavo and guidoprinc August 27, 2019 16:03

mvbattan removed their assignment Mar 13, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Readme File - Invisible Reducer #42

Readme File - Invisible Reducer #42

Anisospina commented Feb 5, 2019

marianozicavo left a comment

marianozicavo Mar 19, 2019

marianozicavo Mar 19, 2019

marianozicavo Mar 19, 2019

marianozicavo Mar 19, 2019

marianozicavo Mar 19, 2019

marianozicavo Mar 19, 2019

marianozicavo Mar 19, 2019

marianozicavo Mar 19, 2019

marianozicavo Mar 19, 2019

guidoprinc Mar 20, 2019

guidoprinc Mar 20, 2019

marianozicavo commented Mar 18, 2021 •

edited

Loading

		@@ -0,0 +1,71 @@
		![coverage](https://img.shields.io/badge/Coverage-92%25-E01563.svg) ![downloads](https://img.shields.io/npm/dw/redux-recompose.svg?colorB=99d000&label=Downloads&style=popout) [![supported by](https://img.shields.io/badge/Supported%20by-Wolox.💗-blue.svg)](https://www.wolox.com.ar/)


		By using invisible reducer, repeating the same logic in each of the reducers is avoided.

		It is a extracting your cross-reducer logic, so this logic keeps isolated and reusable by our other reducers. Also, it keeps hidden from other reducers, so 👻.


		If you are not aware, we invite you to read [Redux-recompose](https://github.com/Wolox/redux-recompose)

		### Installation


		By default, redux-recompose ships with a default invisible reducer that is the following:

		```

		import onFailure from '../../effects/onFailure';


		// TODO: Let the user specify selectors


		export const defaultActionNames = Object.keys(reducerDescription);

		// TODO: Let user specify this initialState

Readme File - Invisible Reducer #42

Are you sure you want to change the base?

Readme File - Invisible Reducer #42

Conversation

Anisospina commented Feb 5, 2019

Summary

Screenshots

Trello Card:

marianozicavo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marianozicavo commented Mar 18, 2021 • edited Loading

marianozicavo commented Mar 18, 2021 •

edited

Loading