├── resources
    └── public
    │   └── test.html
├── .gitignore
├── src
    └── re_frame_worker_fx
    │   └── core.cljs
├── LICENSE
├── project.clj
├── test
    └── re_frame_worker_fx
    │   └── test.cljs
└── README.md


/resources/public/test.html:
--------------------------------------------------------------------------------
1 | <script src="js/test/test.js"></script>
2 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | /target
 2 | /classes
 3 | /checkouts
 4 | pom.xml
 5 | pom.xml.asc
 6 | *.jar
 7 | *.class
 8 | /.lein-*
 9 | /.nrepl-port
10 | .hgignore
11 | .hg/
12 | 


--------------------------------------------------------------------------------
/src/re_frame_worker_fx/core.cljs:
--------------------------------------------------------------------------------
 1 | (ns re-frame-worker-fx.core
 2 |   (:require [cljs.core.async :refer [<!]]
 3 |             [re-frame.core :refer [reg-fx dispatch]]
 4 |             [cljs-workers.core :refer [do-with-pool!]])
 5 |   (:require-macros [cljs.core.async.macros :refer [go]]))
 6 | 
 7 | (reg-fx
 8 |  :worker
 9 |  (fn worker-fx
10 |    [{:keys [pool on-success on-error] :as data}]
11 |    (go
12 |      (let [result-chan
13 |            (do-with-pool! pool data)
14 | 
15 |            {:keys [state] :as result}
16 |            (<! result-chan)]
17 | 
18 |        (if (= :success (keyword state))
19 |          (dispatch (conj on-success result))
20 |          (dispatch (conj on-error result)))))))
21 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2017 JT Knabenschuh
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/project.clj:
--------------------------------------------------------------------------------
 1 | (defproject jtk-dvlp/re-frame-worker-fx "1.0.3"
 2 |   :description
 3 |   "A re-frame effects handler for performing async tasks via cljs-workers"
 4 | 
 5 |   :url
 6 |   "https://github.com/jtkDvlp/re-frame-worker-fx"
 7 | 
 8 |   :license
 9 |   {:name "MIT"}
10 | 
11 |   :dependencies
12 |   [[jtk-dvlp/cljs-workers "1.1.2"]]
13 | 
14 |   :min-lein-version
15 |   "2.5.3"
16 | 
17 |   :source-paths
18 |   ["src"]
19 | 
20 |   :clean-targets
21 |   ^{:protect false}
22 |   ["resources/public/js"
23 |    "target"]
24 | 
25 |   :plugins
26 |   [[lein-cljsbuild "1.1.4"
27 |     :exclusions [[org.clojure/clojure]]]
28 |    [lein-figwheel "0.5.0-1"]]
29 | 
30 |   :profiles
31 |   {:provided
32 |    {:dependencies
33 |     [[org.clojure/clojure "1.8.0"]
34 |      [org.clojure/clojurescript "1.9.229"]
35 | 
36 |      [re-frame "0.9.1"]]}
37 | 
38 |    :dev
39 |    {:dependencies
40 |     [[figwheel-sidecar "0.5.8"]
41 |      [com.cemerick/piggieback "0.2.1"]]}}
42 | 
43 |   :repl-options
44 |   {:nrepl-middleware
45 |    [cemerick.piggieback/wrap-cljs-repl]}
46 | 
47 |   :cljsbuild
48 |   {:builds
49 |    [{:id "test"
50 |      :source-paths ["src" "test"]
51 |      :figwheel true
52 |      :compiler {:main re-frame-worker-fx.test
53 |                 :asset-path "js/test/out"
54 |                 :output-to "resources/public/js/test/test.js"
55 |                 :output-dir "resources/public/js/test/out"}}
56 |     {:id "worker"
57 |      :source-paths ["src" "test"]
58 |      :compiler {:main re-frame-worker-fx.test
59 |                 :asset-path "js/worker/out"
60 |                 :output-to "resources/public/js/worker/worker.js"
61 |                 :output-dir "resources/public/js/worker/out"
62 |                 :optimizations :advanced}}]})
63 | 


--------------------------------------------------------------------------------
/test/re_frame_worker_fx/test.cljs:
--------------------------------------------------------------------------------
 1 | (ns re-frame-worker-fx.test
 2 |   (:require [cljs-workers.core :as main]
 3 |             [cljs-workers.worker :as worker]
 4 |             [re-frame.core :as re-frame]
 5 |             [re-frame-worker-fx.core]))
 6 | 
 7 | (defn app
 8 |   []
 9 |   (re-frame/reg-event-fx
10 |    :on-worker-fx-success
11 |    (fn [_ [_ result]]
12 |      (.debug js/console "success" result)))
13 | 
14 |   (re-frame/reg-event-fx
15 |    :on-worker-fx-error
16 |    (fn [_ [_ result]]
17 |      (.debug js/console "error" result)))
18 | 
19 |   (re-frame/reg-event-fx
20 |    :test-worker-fx
21 |    (fn [coeffects [_ task]]
22 |      (let [worker-pool
23 |            (-> coeffects :db :worker-pool)
24 | 
25 |            task-with-pool
26 |            (assoc task :pool worker-pool)]
27 | 
28 |        {:worker task-with-pool})))
29 | 
30 |   (re-frame/reg-event-fx
31 |    :initialize
32 |    (fn [_ _]
33 |      {:db {:worker-pool (main/create-pool 2 "js/worker/worker.js")}
34 |       :dispatch-n [[:test-worker-fx {:handler :mirror, :arguments {:a "Hallo" :b "Welt" :c 10} :on-success [:on-worker-fx-success] :on-error [:on-worker-fx-error]}]
35 |                    [:test-worker-fx {:handler :mirror, :arguments {:a "Hallo" :b "Welt" :c 10 :d (js/ArrayBuffer. 10) :transfer [:d]} :transfer [:d] :on-success [:on-worker-fx-success] :on-error [:on-worker-fx-error]}]
36 |                    [:test-worker-fx {:handler :mirror, :arguments {:a "Hallo" :b "Welt" :c 10 :d (js/ArrayBuffer. 10) :transfer [:d]} :transfer [:c] :on-success [:on-worker-fx-success] :on-error [:on-worker-fx-error]}]
37 |                    [:test-worker-fx {:handler :mirror, :arguments {:a "Hallo" :b "Welt" :c 10 :d (js/ArrayBuffer. 10) :transfer [:c]} :transfer [:d] :on-success [:on-worker-fx-success] :on-error [:on-worker-fx-error]}]]}))
38 | 
39 |   (re-frame/dispatch-sync [:initialize]))
40 | 
41 | (defn worker
42 |   []
43 |   (worker/register
44 |    :mirror
45 |    (fn [arguments]
46 |      arguments))
47 | 
48 |   (worker/bootstrap))
49 | 
50 | (if (and (main/supported?) (main/main?))
51 |   (app)
52 |   (worker))
53 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![Clojars Project](https://img.shields.io/clojars/v/jtk-dvlp/re-frame-worker-fx.svg)](https://clojars.org/jtk-dvlp/re-frame-worker-fx)
 2 | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/jtkDvlp/re-frame-worker-fx/blob/master/LICENSE)
 3 | [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/donate?hosted_button_id=2PDXQMHX56T6U)
 4 | 
 5 | # Web workers effect handler for re-frame
 6 | 
 7 | This [re-frame](https://github.com/Day8/re-frame) library contains an [web worker](https://developer.mozilla.org/docs/Web/API/Web_Workers_API/Using_web_workers) [effect handler](https://github.com/Day8/re-frame/tree/develop/docs). The handler can be addressed by `:worker` and wraps the API of [cljs-workers](https://github.com/jtkDvlp/cljs-workers).
 8 | 
 9 | ## Getting started
10 | 
11 | ### Get it / add dependency
12 | 
13 | Add the following dependency to your `project.cljs`:<br>
14 | [![Clojars Project](https://img.shields.io/clojars/v/jtk-dvlp/re-frame-worker-fx.svg)](https://clojars.org/jtk-dvlp/re-frame-worker-fx)
15 | 
16 | ### Usage
17 | 
18 | See the following minimal code example or the [test.cljs](https://github.com/jtkDvlp/re-frame-worker-fx/blob/master/test/re_frame_worker_fx/test.cljs). For general usage of workers see [cljs-workers](https://github.com/jtkDvlp/cljs-workers).
19 | 
20 | The following example presupposes that there is already a worker pool and registered worker-handler.
21 | 
22 | ```clojure
23 | (ns your.project
24 |   (:require [re-frame.core :as re-frame]
25 |             [re-frame-worker-fx.core]))
26 | 
27 | (re-frame/reg-event-fx
28 |  :some-event
29 |  (fn [coeffects _]
30 |    (let [worker-pool
31 |          (-> coeffects :db :worker-pool)]
32 |      {:worker {:pool worker-pool
33 |                ;; handler that will be called
34 |                :handler :your-worker-handler
35 |                ;; arguments applied to the handler
36 |                :arguments {:a "Hallo Welt!" :b 10 :c (js/ArrayBuffer. 10)}
37 |                ;; which arguments will be transfered instead of copied
38 |                :transfer [:c]
39 |                ;; dispatched on success conjoined with the result
40 |                :on-success [:your-success-event]
41 |                ;; dispatched on error conjoined with the result
42 |                :on-error [:your-error-event]}})))
43 | ```
44 | 
45 | ## Appendix
46 | 
47 | I´d be thankful to receive patches, comments and constructive criticism.
48 | 
49 | Hope the package is useful :-)
50 | 


--------------------------------------------------------------------------------