penpot/src/uxbox/rstore.cljs
2016-03-15 20:52:29 +02:00

115 lines
3.1 KiB
Clojure

;; This Source Code Form is subject to the terms of the Mozilla Public
;; License, v. 2.0. If a copy of the MPL was not distributed with this
;; file, You can obtain one at http://mozilla.org/MPL/2.0/.
;;
;; Copyright (c) 2015-2016 Andrey Antukh <niwi@niwi.nz>
;; Copyright (c) 2015-2016 Juan de la Cruz <delacruzgarciajuan@gmail.com>
(ns uxbox.rstore
"Reactive storage management architecture helpers."
(:require [beicon.core :as rx]))
;; An abstraction for implement a simple state
;; transition. The `-apply-update` function receives
;; the state and shoudl return the transformed state.
(defprotocol UpdateEvent
(-apply-update [event state]))
;; An abstraction for perform some async stuff such
;; as communicate with api rest or other resources
;; that implies asynchronous access.
;; The `-apply-watch` receives the state and should
;; return a reactive stream of events (that can be
;; of `UpdateEvent`, `WatchEvent` or `EffectEvent`.
(defprotocol WatchEvent
(-apply-watch [event state]))
;; An abstraction for perform just side effects. It
;; receives state and its return value is completly
;; ignored.
(defprotocol EffectEvent
(-apply-effect [event state]))
(defn update?
"Return `true` when `e` satisfies
the UpdateEvent protocol."
[e]
(satisfies? UpdateEvent e))
(defn watch?
"Return `true` when `e` satisfies
the WatchEvent protocol."
[e]
(satisfies? WatchEvent e))
(defn effect?
"Return `true` when `e` satisfies
the EffectEvent protocol."
[e]
(satisfies? EffectEvent e))
(extend-protocol UpdateEvent
function
(-apply-update [func state]
(func state)))
(defonce bus (rx/bus))
(defn emit!
"Emits an event or a collection of them.
The order of events does not matters."
([event]
(rx/push! bus event))
([event & events]
(run! #(rx/push! bus %) (into [event] events))))
(defn swap
"A helper for just apply some function to state
without a need to declare additional event."
[f]
(reify
UpdateEvent
(-apply-update [_ state]
(f state))))
(defn reset
"A event that resets the internal state with
the provided value."
[state]
(reify
UpdateEvent
(-apply-update [_ _]
state)))
(enable-console-print!)
(defn init
"Initializes the stream event loop and
return a stream with model changes."
[state]
(let [watch-s (rx/filter watch? bus)
effect-s (rx/filter effect? bus)
update-s (rx/filter update? bus)
state-s (->> update-s
(rx/scan #(-apply-update %2 %1) state)
(rx/share))]
;; Process event sources: combine with the latest model and the result will be
;; pushed to the event-stream bus
(as-> watch-s $
(rx/with-latest-from vector state-s $)
(rx/flat-map (fn [[event model]] (-apply-watch event model)) $)
(rx/on-value $ emit!))
;; Process effects: combine with the latest model to process the new effect
(as-> effect-s $
(rx/with-latest-from vector state-s $)
(rx/subscribe $ (fn [[event model]] (-apply-effect event model))))
;; Initialize the stream machinary with initial state.
(emit! (swap #(merge % state)))
state-s))