1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
/*
 *   Copyright (c) 2022 R3BL LLC
 *   All rights reserved.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

//! # Context
//!
//! ![](https://raw.githubusercontent.com/r3bl-org/r3bl_rs_utils/main/r3bl-term.svg)
//!
//! <!-- R3BL TUI library & suite of apps focused on developer productivity -->
//!
//! <span style="color:#FD2F53">R</span><span style="color:#FC2C57">3</span><span style="color:#FB295B">B</span><span style="color:#FA265F">L</span><span style="color:#F92363">
//! </span><span style="color:#F82067">T</span><span style="color:#F61D6B">U</span><span style="color:#F51A6F">I</span><span style="color:#F31874">
//! </span><span style="color:#F11678">l</span><span style="color:#EF137C">i</span><span style="color:#ED1180">b</span><span style="color:#EB0F84">r</span><span style="color:#E90D89">a</span><span style="color:#E60B8D">r</span><span style="color:#E40A91">y</span><span style="color:#E10895">
//! </span><span style="color:#DE0799">&amp;</span><span style="color:#DB069E">
//! </span><span style="color:#D804A2">s</span><span style="color:#D503A6">u</span><span style="color:#D203AA">i</span><span style="color:#CF02AE">t</span><span style="color:#CB01B2">e</span><span style="color:#C801B6">
//! </span><span style="color:#C501B9">o</span><span style="color:#C101BD">f</span><span style="color:#BD01C1">
//! </span><span style="color:#BA01C4">a</span><span style="color:#B601C8">p</span><span style="color:#B201CB">p</span><span style="color:#AE02CF">s</span><span style="color:#AA03D2">
//! </span><span style="color:#A603D5">f</span><span style="color:#A204D8">o</span><span style="color:#9E06DB">c</span><span style="color:#9A07DE">u</span><span style="color:#9608E1">s</span><span style="color:#910AE3">e</span><span style="color:#8D0BE6">d</span><span style="color:#890DE8">
//! </span><span style="color:#850FEB">o</span><span style="color:#8111ED">n</span><span style="color:#7C13EF">
//! </span><span style="color:#7815F1">d</span><span style="color:#7418F3">e</span><span style="color:#701AF5">v</span><span style="color:#6B1DF6">e</span><span style="color:#6720F8">l</span><span style="color:#6322F9">o</span><span style="color:#5F25FA">p</span><span style="color:#5B28FB">e</span><span style="color:#572CFC">r</span><span style="color:#532FFD">
//! </span><span style="color:#4F32FD">p</span><span style="color:#4B36FE">r</span><span style="color:#4739FE">o</span><span style="color:#443DFE">d</span><span style="color:#4040FE">u</span><span style="color:#3C44FE">c</span><span style="color:#3948FE">t</span><span style="color:#354CFE">i</span><span style="color:#324FFD">v</span><span style="color:#2E53FD">i</span><span style="color:#2B57FC">t</span><span style="color:#285BFB">y</span>
//!
//! We are working on building command line apps in Rust which have rich text user interfaces (TUI).
//! We want to lean into the terminal as a place of productivity, and build all kinds of awesome
//! apps for it.
//!
//! 1. 🔮 Instead of just building one app, we are building a library to enable any kind of rich TUI
//!    development w/ a twist: taking concepts that work really well for the frontend mobile and web
//!    development world and re-imagining them for TUI & Rust.
//!
//!    - Taking things like React, JSX, CSS, and Redux, but making everything async (they can be run
//!      in parallel & concurrent via Tokio).
//!    - Even the thread running the main event loop doesn't block since it is async.
//!    - Using proc macros to create DSLs to implement CSS & JSX.
//!
//! 2. 🌎 We are building apps to enhance developer productivity & workflows.
//!
//!    - The idea here is not to rebuild tmux in Rust (separate processes mux'd onto a single
//!      terminal window). Rather it is to build a set of integrated "apps" (or "tasks") that run in
//!      the same process that renders to one terminal window.
//!    - Inside of this terminal window, we can implement things like "app" switching, routing,
//!      tiling layout, stacking layout, etc. so that we can manage a lot of TUI apps (which are
//!      tightly integrated) that are running in the same process, in the same window. So you can
//!      imagine that all these "app"s have shared application state (that is in a Redux store).
//!      Each "app" may also have its own Redux store.
//!    - Here are some examples of the types of "app"s we want to build:
//!      1. multi user text editors w/ syntax highlighting
//!      2. integrations w/ github issues
//!      3. integrations w/ calendar, email, contacts APIs
//!
//! These crates provides lots of useful functionality to help you build TUI (text user interface)
//! apps, along w/ general niceties & ergonomics that all Rustaceans 🦀 can enjoy 🎉:
//!
//! 1. Loosely coupled & fully asynchronous [TUI
//!    framework](https://docs.rs/r3bl_tui/latest/r3bl_tui/) to make it possible (and easy) to build
//!    sophisticated TUIs (Text User Interface apps) in Rust that are inspired by React, Redux, CSS
//!    and Flexbox.
//! 2. Thread-safe & fully asynchronous [Redux](https://docs.rs/r3bl_redux/latest/r3bl_redux/)
//!    crate (using Tokio to run subscribers and middleware in separate tasks). The reducer
//!    functions are run sequentially.
//! 3. Lots of [declarative macros](https://docs.rs/r3bl_rs_utils_core/latest/r3bl_rs_utils_core/),
//!    and [procedural macros](https://docs.rs/r3bl_rs_utils_macro/latest/r3bl_rs_utils_macro/)
//!    (both function like and derive) to avoid having to write lots of boilerplate code for many
//!    common (and complex) tasks. And even less noisy `Result` and `Error` types.
//! 4. [Non binary tree data](https://docs.rs/r3bl_rs_utils/latest/r3bl_rs_utils/) structure
//!    inspired by memory arenas, that is thread safe and supports parallel tree walking.
//! 5. Utility functions to improve
//!    [ergonomics](https://docs.rs/r3bl_rs_utils/latest/r3bl_rs_utils/) of commonly used patterns
//!    in Rust programming, ranging from things like colorizing `stdout`, `stderr` output to lazy
//!    value holders.
//!
//! ## Learn more about how this library is built
//!
//! 🦜 Here are some articles (on [developerlife.com](https://developerlife.com)) about how this
//! crate is made:
//! 1. <https://developerlife.com/2022/02/24/rust-non-binary-tree/>
//! 2. <https://developerlife.com/2022/03/12/rust-redux/>
//! 3. <https://developerlife.com/2022/03/30/rust-proc-macro/>
//!
//! 🦀 You can also find all the Rust related content on developerlife.com
//! [here](https://developerlife.com/category/Rust/).
//!
//! # r3bl_redux
//!
//! `Store` is thread safe and asynchronous (using Tokio). You have to implement `async` traits in
//! order to use it, by defining your own reducer, subscriber, and middleware trait objects. You
//! also have to supply the Tokio runtime, this library will not create its own runtime. However,
//! for best results, it is best to use the multithreaded Tokio runtime.
//!
//! Once you setup your Redux store w/ your reducer, subscriber, and middleware, you can use it by
//! calling `spawn_dispatch_action!( store, action )`. This kicks off a parallel Tokio task that
//! will run the middleware functions, reducer functions, and finally the subscriber functions. So
//! this will not block the thread of whatever code you call this from. The
//! `spawn_dispatch_action!()` macro itself is not `async`. So you can call it from non `async`
//! code, however you still have to provide a Tokio executor / runtime, without which you will get a
//! panic when `spawn_dispatch_action!()` is called.
//!
//! > Here are some interesting links for you to look into further:
//! >
//! > 1. [In depth guide on this Redux
//! >    implementation](https://developerlife.com/2022/03/12/rust-redux/).
//! > 2. [Code example of an address book using
//! >    Redux](https://github.com/r3bl-org/address-book-with-redux-tui).
//! > 3. [Code example of TUI apps using
//! >    Redux](https://github.com/r3bl-org/r3bl_rs_utils/tree/main/tui/examples/demo).
//!
//! ## Middlewares
//!
//! Your middleware (`async` trait implementations) will be run concurrently or in parallel via
//! Tokio tasks. You get to choose which `async` trait to implement to do one or the other. And
//! regardless of which kind you implement the `Action` that is optionally returned will be
//! dispatched to the Redux store at the end of execution of all the middlewares (for that
//! particular `spawn_dispatch_action!()` call).
//!
//! 1. `AsyncMiddlewareSpawns<State, Action>` - Your middleware has to use `tokio::spawn` to run
//!    `async` blocks in a [separate
//!    thread](https://docs.rs/tokio/latest/tokio/task/index.html#spawning) and return a
//!    `JoinHandle` that contains an `Option<Action>`. A macro
//!    [`fire_and_forget!`](https://docs.rs/r3bl_rs_utils/latest/r3bl_rs_utils/macro.fire_and_forget.html)
//!    is provided so that you can easily spawn parallel blocks of code in your `async` functions.
//!    These are added to the store via a call to `add_middleware_spawns(...)`.
//!
//! 2. `AsyncMiddleware<State, Action>` - They are will all be run together concurrently using
//!    [`futures::join_all()`](https://docs.rs/futures/latest/futures/future/fn.join_all.html).
//!    These are added to the store via a call to `add_middleware(...)`.
//!
//! ## Subscribers
//!
//! The subscribers will be run asynchronously via Tokio tasks. They are all run together
//! concurrently but not in parallel, using
//! [`futures::join_all()`](https://docs.rs/futures/latest/futures/future/fn.join_all.html).
//!
//! ## Reducers
//!
//! The reducer functions are also are `async` functions that are run in the tokio runtime. They're
//! also run one after another in the order in which they're added.
//!
//! ⚡ **Any functions or blocks that you write which uses the Redux library will have to be marked
//! `async` as well. And you will have to spawn the Tokio runtime by using the `#[tokio::main]`
//! macro. If you use the default runtime then Tokio will use multiple threads and its task stealing
//! implementation to give you parallel and concurrent behavior. You can also use the single
//! threaded runtime; its really up to you.**
//!
//! 1. To create middleware you have to implement the `AsyncMiddleware<S,A>` trait or
//!    `AsyncMiddlewareSpawns<S,A>` trait. Please read the [`AsyncMiddleware`
//!    docs](https://docs.rs/r3bl_rs_utils/latest/r3bl_rs_utils/redux/async_middleware/trait.AsyncMiddleware.html)
//!    for examples of both. The `run()` method is passed two arguments: the `State` and the
//!    `Action`.
//!
//!    1. For `AsyncMiddlewareSpawns<S,A>` in your `run()` implementation you have to use the
//!       [`fire_and_forget!`](https://docs.rs/r3bl_rs_utils/latest/r3bl_rs_utils/macro.fire_and_forget.html)
//!       macro to surround your code. And this will return a `JoinHandle<Option<A>>`.
//!    2. For `AsyncMiddleware<S,A>` in your `run()` implementation you just have to return an
//!       `Option<A>>`.
//!
//! 2. To create reducers you have to implement the `AsyncReducer` trait.
//!
//!    - These should be [pure
//!      functions](https://redux.js.org/understanding/thinking-in-redux/three-principles#changes-are-made-with-pure-functions)
//!      and simply return a new `State` object.
//!    - The `run()` method will be passed two arguments: a ref to `Action` and ref to `State`.
//!
//! 3. To create subscribers you have to implement the `AsyncSubscriber` trait.
//!
//!    - The `run()` method will be passed a `State` object as an argument.
//!    - It returns nothing `()`.
//!
//! ## Summary
//!
//! Here's the gist of how to make & use one of these:
//!
//! 1. Create a struct. Make it derive `Default`. Or you can add your own properties / fields to
//!    this struct, and construct it yourself, or even provide a constructor function.
//!    - A default constructor function `new()` is provided for you by the trait.
//!    - Just follow how that works for when you need to make your own constructor function for a
//!      struct w/ your own properties.
//! 2. Implement the `AsyncMiddleware`, `AsyncMiddlewareSpawns`, `AsyncReducer`, or
//!    `AsyncSubscriber` trait on your struct.
//! 3. Register this struct w/ the store using one of the `add_middleware()`,
//!    `add_middleware_spawns()`, `add_reducer()`, or `add_subscriber()` methods. You can register
//!    as many of these as you like.
//!    - If you have a struct w/ no properties, you can just use the default `::new()` method to
//!      create an instance and pass that to the `add_???()` methods.
//!    - If you have a struct w/ custom properties, you can either implement your own constructor
//!      function or use the following as an argument to the `add_???()` methods:
//!      `Box::new($YOUR_STRUCT))`.
//!
//! # Small example step by step
//!
//! 💡 There are lots of examples in the
//! [tests](https://github.com/r3bl-org/r3bl-rs-utils/blob/main/tests/test_redux.rs) for this
//! library and in this [CLI application](https://github.com/r3bl-org/address-book-with-redux-tui/)
//! built using it.
//!
//! Here's an example of how to use it. Let's start w/ the import statements.
//!
//! ```ignore
//! /// Imports.
//! use async_trait::async_trait;
//! use r3bl_rs_utils::redux::{
//!   AsyncMiddlewareSpawns, AsyncMiddleware, AsyncReducer,
//!   AsyncSubscriber, Store, StoreStateMachine,
//! };
//! use std::sync::{Arc, Mutex};
//! use tokio::sync::RwLock;
//! ```
//!
//! 1. Make sure to have the `tokio` and `async-trait` crates installed as well as `r3bl_rs_utils`
//!    in your `Cargo.toml` file.
//! 2. Here's an example
//!    [`Cargo.toml`](https://github.com/nazmulidris/rust_scratch/blob/main/address-book-with-redux/Cargo.toml).
//!
//! Let's say we have the following action enum, and state struct.
//!
//! ```ignore
//! /// Action enum.
//! #[derive(Debug, PartialEq, Eq, Clone)]
//! pub enum Action {
//!   Add(i32, i32),
//!   AddPop(i32),
//!   Clear,
//!   MiddlewareCreateClearAction,
//!   Noop,
//! }
//!
//! impl Default for Action {
//!   fn default() -> Self {
//!     Action::Noop
//!   }
//! }
//!
//! /// State.
//! #[derive(Clone, Default, PartialEq, Debug)]
//! pub struct State {
//!   pub stack: Vec<i32>,
//! }
//! ```
//!
//! Here's an example of the reducer function.
//!
//! ```ignore
//! /// Reducer function (pure).
//! #[derive(Default)]
//! struct MyReducer;
//!
//! #[async_trait]
//! impl AsyncReducer<State, Action> for MyReducer {
//!   async fn run(
//!     &self,
//!     action: &Action,
//!     state: &mut State,
//!   ) {
//!     match action {
//!       Action::Add(a, b) => {
//!         let sum = a + b;
//!         state.stack = vec![sum];
//!       }
//!       Action::AddPop(a) => {
//!         let sum = a + state.stack[0];
//!         state.stack = vec![sum];
//!       }
//!       Action::Clear => State {
//!         state.stack.clear();
//!       },
//!       _ => {}
//!     }
//!   }
//! }
//! ```
//!
//! Here's an example of an async subscriber function (which are run in parallel after an action is
//! dispatched). The following example uses a lambda that captures a shared object. This is a pretty
//! common pattern that you might encounter when creating subscribers that share state in your
//! enclosing block or scope.
//!
//! ```ignore
//! /// This shared object is used to collect results from the subscriber
//! /// function & test it later.
//! let shared_object = Arc::new(Mutex::new(Vec::<i32>::new()));
//!
//! #[derive(Default)]
//! struct MySubscriber {
//!   pub shared_object_ref: Arc<Mutex<Vec<i32>>>,
//! }
//!
//! #[async_trait]
//! impl AsyncSubscriber<State> for MySubscriber {
//!   async fn run(
//!     &self,
//!     state: State,
//!   ) {
//!     let mut stack = self
//!       .shared_object_ref
//!       .lock()
//!       .unwrap();
//!     if !state.stack.is_empty() {
//!       stack.push(state.stack[0]);
//!     }
//!   }
//! }
//!
//! let my_subscriber = MySubscriber {
//!   shared_object_ref: shared_object_ref.clone(),
//! };
//! ```
//!
//! Here are two types of async middleware functions. One that returns an action (which will get
//! dispatched once this middleware returns), and another that doesn't return anything (like a
//! logger middleware that just dumps the current action to the console). Note that both these
//! functions share the `shared_object` reference from above.
//!
//! ```ignore
//! /// This shared object is used to collect results from the subscriber
//! /// function & test it later.
//! #[derive(Default)]
//! struct MwExampleNoSpawn {
//!   pub shared_object_ref: Arc<Mutex<Vec<i32>>>,
//! }
//!
//! #[async_trait]
//! impl AsyncMiddleware<State, Action> for MwExampleNoSpawn {
//!   async fn run(
//!     &self,
//!     action: Action,
//!     _store_ref: Arc<RwLock<StoreStateMachine<State, Action>>>,
//!   ) {
//!     let mut stack = self
//!       .shared_object_ref
//!       .lock()
//!       .unwrap();
//!     match action {
//!       Action::MwExampleNoSpawn_Add(_, _) => stack.push(-1),
//!       Action::MwExampleNoSpawn_AddPop(_) => stack.push(-2),
//!       Action::MwExampleNoSpawn_Clear => stack.push(-3),
//!       _ => {}
//!     }
//!     None
//!   }
//! }
//!
//! let mw_example_no_spawn = MwExampleNoSpawn {
//!   shared_object_ref: shared_object_ref.clone(),
//! };
//!
//! /// This shared object is used to collect results from the subscriber
//! /// function & test it later.
//! #[derive(Default)]
//! struct MwExampleSpawns {
//!   pub shared_object_ref: Arc<Mutex<Vec<i32>>>,
//! }
//!
//! #[async_trait]
//! impl AsyncMiddlewareSpawns<State, Action> for MwExampleSpawns {
//!   async fn run(
//!     &self,
//!     action: Action,
//!     store_ref: Arc<RwLock<StoreStateMachine<State, Action>>>,
//!   ) -> JoinHandle<Option<Action>> {
//!     fire_and_forget!(
//!       {
//!         let mut stack = self
//!           .shared_object_ref
//!           .lock()
//!           .unwrap();
//!         match action {
//!           Action::MwExampleSpawns_ModifySharedObject_ResetState => {
//!             shared_vec.push(-4);
//!             return Some(Action::Reset);
//!           }
//!           _ => {}
//!         }
//!         None
//!       }
//!     );
//!   }
//! }
//!
//! let mw_example_spawns = MwExampleSpawns {
//!   shared_object_ref: shared_object_ref.clone(),
//! };
//! ```
//!
//! Here's how you can setup a store with the above reducer, middleware, and subscriber functions.
//!
//! ```ignore
//! // Setup store.
//! let mut store = Store::<State, Action>::default();
//! store
//!   .add_reducer(MyReducer::new()) // Note the use of `::new()` here.
//!   .await
//!   .add_subscriber(Box::new(         // We aren't using `::new()` here
//!     my_subscriber,                  // because the struct has properties.
//!   ))
//!   .await
//!   .add_middleware_spawns(Box::new(  // We aren't using `::new()` here
//!     mw_example_spawns,              // because the struct has properties.
//!   ))
//!   .await
//!   .add_middleware(Box::new(         // We aren't using `::new()` here
//!     mw_example_no_spawn,            // because the struct has properties.
//!   ))
//!   .await;
//! ```
//!
//! Finally here's an example of how to dispatch an action in a test. You can dispatch actions in
//! parallel using `spawn_dispatch_action!()` which is "fire and forget" meaning that the caller
//! won't block or wait for the `spawn_dispatch_action!()` to return.
//!
//! ```ignore
//! // Test reducer and subscriber by dispatching `Add`, `AddPop`, `Clear` actions in parallel.
//! spawn_dispatch_action!( store, Action::Add(1, 2) );
//! assert_eq!(shared_object.lock().unwrap().pop(), Some(3));
//!
//! spawn_dispatch_action!( store, Action::AddPop(1) );
//! assert_eq!(shared_object.lock().unwrap().pop(), Some(4));
//!
//! spawn_dispatch_action!( store, Action::Clear );
//! assert_eq!(store.get_state().stack.len(), 0);
//! ```
//!
//! # Complete example in one go
//!
//! If you like to learn by example, below is a full example of using this Redux crate.
//!
//! ```ignore
//! use std::sync::Arc;
//!
//! use async_trait::async_trait;
//! use r3bl_rs_utils::{redux::{AsyncReducer, AsyncSubscriber, Store},
//!                     SharedStore};
//! use tokio::sync::RwLock;
//!
//! #[allow(non_camel_case_types)]
//! #[derive(Debug, PartialEq, Eq, Clone)]
//! pub enum Action {
//!   // Reducer actions.
//!   Add(i32, i32),
//!   AddPop(i32),
//!   Reset,
//!   Clear,
//!   // Middleware actions for MwExampleNoSpawn.
//!   MwExampleNoSpawn_Foo(i32, i32),
//!   MwExampleNoSpawn_Bar(i32),
//!   MwExampleNoSpawn_Baz,
//!   // Middleware actions for MwExampleSpawns.
//!   MwExampleSpawns_ModifySharedObject_ResetState,
//!   // For Default impl.
//!   Noop,
//! }
//!
//! impl Default for Action {
//!   fn default() -> Self { Action::Noop }
//! }
//!
//! #[derive(Clone, Default, PartialEq, Eq, Debug)]
//! pub struct State {
//!   pub stack: Vec<i32>,
//! }
//!
//! #[tokio::test]
//! async fn test_redux_store_works_for_main_use_cases() {
//!   // This shared object is used to collect results from the subscriber &
//!   // middleware & reducer functions & test it later.
//!   let shared_vec = Arc::new(RwLock::new(Vec::<i32>::new()));
//!
//!   // Create the store.
//!   let mut _store = Store::<State, Action>::default();
//!   let shared_store: SharedStore<State, Action> = Arc::new(RwLock::new(_store));
//!
//!   run_reducer_and_subscriber(&shared_vec, &shared_store.clone()).await;
//! }
//!
//! async fn reset_shared_object(shared_vec: &Arc<RwLock<Vec<i32>>>) {
//!   shared_vec.write().await.clear();
//! }
//!
//! async fn reset_store(shared_store: &SharedStore<State, Action>) {
//!   shared_store.write().await.clear_reducers().await;
//!   shared_store.write().await.clear_subscribers().await;
//!   shared_store.write().await.clear_middlewares().await;
//! }
//!
//! async fn run_reducer_and_subscriber(
//!   shared_vec: &Arc<RwLock<Vec<i32>>>, shared_store: &SharedStore<State, Action>,
//! ) {
//!   // Setup store w/ only reducer & subscriber (no middlewares).
//!   let my_subscriber = MySubscriber {
//!     shared_vec: shared_vec.clone(),
//!   };
//!   reset_shared_object(shared_vec).await;
//!   reset_store(shared_store).await;
//!
//!   shared_store
//!     .write()
//!     .await
//!     .add_reducer(MyReducer::new())
//!     .await
//!     .add_subscriber(Box::new(my_subscriber))
//!     .await;
//!
//!   shared_store
//!     .write()
//!     .await
//!     .dispatch_action(Action::Add(1, 2))
//!     .await;
//!
//!   assert_eq!(shared_vec.write().await.pop(), Some(3));
//!
//!   shared_store
//!     .write()
//!     .await
//!     .dispatch_action(Action::AddPop(1))
//!     .await;
//!
//!   assert_eq!(shared_vec.write().await.pop(), Some(4));
//!
//!   // Clean up the store's state.
//!   shared_store
//!     .write()
//!     .await
//!     .dispatch_action(Action::Clear)
//!     .await;
//!
//!   let state = shared_store.read().await.get_state();
//!   assert_eq!(state.stack.len(), 0);
//! }
//!
//! struct MySubscriber {
//!   pub shared_vec: Arc<RwLock<Vec<i32>>>,
//! }
//!
//! #[async_trait]
//! impl AsyncSubscriber<State> for MySubscriber {
//!   async fn run(&self, state: State) {
//!     let mut stack = self.shared_vec.write().await;
//!     if !state.stack.is_empty() {
//!       stack.push(state.stack[0]);
//!     }
//!   }
//! }
//!
//! #[derive(Default)]
//! struct MyReducer;
//!
//! #[async_trait]
//! impl AsyncReducer<State, Action> for MyReducer {
//!   async fn run(&self, action: &Action, state: &State) -> State {
//!     match action {
//!       Action::Add(a, b) => {
//!         let sum = a + b;
//!         State { stack: vec![sum] }
//!       }
//!       Action::AddPop(a) => {
//!         let sum = a + state.stack[0];
//!         State { stack: vec![sum] }
//!       }
//!       Action::Clear => State { stack: vec![] },
//!       Action::Reset => State { stack: vec![-100] },
//!       _ => state.clone(),
//!     }
//!   }
//! }
//! ```

// https://github.com/rust-lang/rust-clippy
// https://rust-lang.github.io/rust-clippy/master/index.html
#![warn(clippy::all)]
#![warn(clippy::unwrap_in_result)]
#![warn(rust_2018_idioms)]

// Attach.
pub mod redux;

// Re-export.
pub use redux::*;