├── .circleci └── config.yml ├── .github └── CODEOWNERS ├── .gitignore ├── LICENSE ├── ORIGINATOR ├── README.md ├── project.clj ├── src └── pushy │ └── core.cljs └── test └── pushy └── test ├── core.cljs └── runner.cljs /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | # Clojure CircleCI 2.0 configuration file 2 | # 3 | # Check https://circleci.com/docs/2.0/language-clojure/ for more details 4 | # 5 | version: 2 6 | jobs: 7 | build: 8 | docker: 9 | # specify the version you desire here 10 | - image: circleci/clojure:lein-2.9.1-node-browsers-legacy 11 | 12 | # Specify service dependencies here if necessary 13 | # CircleCI maintains a library of pre-built images 14 | # documented at https://circleci.com/docs/2.0/circleci-images/ 15 | # - image: circleci/postgres:9.4 16 | 17 | working_directory: ~/repo 18 | 19 | environment: 20 | LEIN_ROOT: "true" 21 | # Customize the JVM maximum heap limit 22 | JVM_OPTS: -Xmx3200m 23 | 24 | steps: 25 | - checkout 26 | 27 | # Download and cache dependencies 28 | - restore_cache: 29 | keys: 30 | - v1-dependencies-{{ checksum "project.clj" }} 31 | # fallback to using the latest cache if no exact match is found 32 | - v1-dependencies- 33 | 34 | - run: lein deps 35 | - run: sudo npm install -g karma karma-cli karma-chrome-launcher karma-cljs-test 36 | - save_cache: 37 | paths: 38 | - ~/.m2 39 | key: v1-dependencies-{{ checksum "project.clj" }} 40 | 41 | # run tests! 42 | - run: lein test -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @shen-tian @slipset 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 | /out 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC 2 | LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM 3 | CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 4 | 5 | 1. DEFINITIONS 6 | 7 | "Contribution" means: 8 | 9 | a) in the case of the initial Contributor, the initial code and 10 | documentation distributed under this Agreement, and 11 | 12 | b) in the case of each subsequent Contributor: 13 | 14 | i) changes to the Program, and 15 | 16 | ii) additions to the Program; 17 | 18 | where such changes and/or additions to the Program originate from and are 19 | distributed by that particular Contributor. A Contribution 'originates' from 20 | a Contributor if it was added to the Program by such Contributor itself or 21 | anyone acting on such Contributor's behalf. Contributions do not include 22 | additions to the Program which: (i) are separate modules of software 23 | distributed in conjunction with the Program under their own license 24 | agreement, and (ii) are not derivative works of the Program. 25 | 26 | "Contributor" means any person or entity that distributes the Program. 27 | 28 | "Licensed Patents" mean patent claims licensable by a Contributor which are 29 | necessarily infringed by the use or sale of its Contribution alone or when 30 | combined with the Program. 31 | 32 | "Program" means the Contributions distributed in accordance with this 33 | Agreement. 34 | 35 | "Recipient" means anyone who receives the Program under this Agreement, 36 | including all Contributors. 37 | 38 | 2. GRANT OF RIGHTS 39 | 40 | a) Subject to the terms of this Agreement, each Contributor hereby grants 41 | Recipient a non-exclusive, worldwide, royalty-free copyright license to 42 | reproduce, prepare derivative works of, publicly display, publicly perform, 43 | distribute and sublicense the Contribution of such Contributor, if any, and 44 | such derivative works, in source code and object code form. 45 | 46 | b) Subject to the terms of this Agreement, each Contributor hereby grants 47 | Recipient a non-exclusive, worldwide, royalty-free patent license under 48 | Licensed Patents to make, use, sell, offer to sell, import and otherwise 49 | transfer the Contribution of such Contributor, if any, in source code and 50 | object code form. This patent license shall apply to the combination of the 51 | Contribution and the Program if, at the time the Contribution is added by the 52 | Contributor, such addition of the Contribution causes such combination to be 53 | covered by the Licensed Patents. The patent license shall not apply to any 54 | other combinations which include the Contribution. No hardware per se is 55 | licensed hereunder. 56 | 57 | c) Recipient understands that although each Contributor grants the licenses 58 | to its Contributions set forth herein, no assurances are provided by any 59 | Contributor that the Program does not infringe the patent or other 60 | intellectual property rights of any other entity. Each Contributor disclaims 61 | any liability to Recipient for claims brought by any other entity based on 62 | infringement of intellectual property rights or otherwise. As a condition to 63 | exercising the rights and licenses granted hereunder, each Recipient hereby 64 | assumes sole responsibility to secure any other intellectual property rights 65 | needed, if any. For example, if a third party patent license is required to 66 | allow Recipient to distribute the Program, it is Recipient's responsibility 67 | to acquire that license before distributing the Program. 68 | 69 | d) Each Contributor represents that to its knowledge it has sufficient 70 | copyright rights in its Contribution, if any, to grant the copyright license 71 | set forth in this Agreement. 72 | 73 | 3. REQUIREMENTS 74 | 75 | A Contributor may choose to distribute the Program in object code form under 76 | its own license agreement, provided that: 77 | 78 | a) it complies with the terms and conditions of this Agreement; and 79 | 80 | b) its license agreement: 81 | 82 | i) effectively disclaims on behalf of all Contributors all warranties and 83 | conditions, express and implied, including warranties or conditions of title 84 | and non-infringement, and implied warranties or conditions of merchantability 85 | and fitness for a particular purpose; 86 | 87 | ii) effectively excludes on behalf of all Contributors all liability for 88 | damages, including direct, indirect, special, incidental and consequential 89 | damages, such as lost profits; 90 | 91 | iii) states that any provisions which differ from this Agreement are offered 92 | by that Contributor alone and not by any other party; and 93 | 94 | iv) states that source code for the Program is available from such 95 | Contributor, and informs licensees how to obtain it in a reasonable manner on 96 | or through a medium customarily used for software exchange. 97 | 98 | When the Program is made available in source code form: 99 | 100 | a) it must be made available under this Agreement; and 101 | 102 | b) a copy of this Agreement must be included with each copy of the Program. 103 | 104 | Contributors may not remove or alter any copyright notices contained within 105 | the Program. 106 | 107 | Each Contributor must identify itself as the originator of its Contribution, 108 | if any, in a manner that reasonably allows subsequent Recipients to identify 109 | the originator of the Contribution. 110 | 111 | 4. COMMERCIAL DISTRIBUTION 112 | 113 | Commercial distributors of software may accept certain responsibilities with 114 | respect to end users, business partners and the like. While this license is 115 | intended to facilitate the commercial use of the Program, the Contributor who 116 | includes the Program in a commercial product offering should do so in a 117 | manner which does not create potential liability for other Contributors. 118 | Therefore, if a Contributor includes the Program in a commercial product 119 | offering, such Contributor ("Commercial Contributor") hereby agrees to defend 120 | and indemnify every other Contributor ("Indemnified Contributor") against any 121 | losses, damages and costs (collectively "Losses") arising from claims, 122 | lawsuits and other legal actions brought by a third party against the 123 | Indemnified Contributor to the extent caused by the acts or omissions of such 124 | Commercial Contributor in connection with its distribution of the Program in 125 | a commercial product offering. The obligations in this section do not apply 126 | to any claims or Losses relating to any actual or alleged intellectual 127 | property infringement. In order to qualify, an Indemnified Contributor must: 128 | a) promptly notify the Commercial Contributor in writing of such claim, and 129 | b) allow the Commercial Contributor tocontrol, and cooperate with the 130 | Commercial Contributor in, the defense and any related settlement 131 | negotiations. The Indemnified Contributor may participate in any such claim 132 | at its own expense. 133 | 134 | For example, a Contributor might include the Program in a commercial product 135 | offering, Product X. That Contributor is then a Commercial Contributor. If 136 | that Commercial Contributor then makes performance claims, or offers 137 | warranties related to Product X, those performance claims and warranties are 138 | such Commercial Contributor's responsibility alone. Under this section, the 139 | Commercial Contributor would have to defend claims against the other 140 | Contributors related to those performance claims and warranties, and if a 141 | court requires any other Contributor to pay any damages as a result, the 142 | Commercial Contributor must pay those damages. 143 | 144 | 5. NO WARRANTY 145 | 146 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON 147 | AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER 148 | EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR 149 | CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A 150 | PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the 151 | appropriateness of using and distributing the Program and assumes all risks 152 | associated with its exercise of rights under this Agreement , including but 153 | not limited to the risks and costs of program errors, compliance with 154 | applicable laws, damage to or loss of data, programs or equipment, and 155 | unavailability or interruption of operations. 156 | 157 | 6. DISCLAIMER OF LIABILITY 158 | 159 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY 160 | CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, 161 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION 162 | LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 163 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 164 | ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE 165 | EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY 166 | OF SUCH DAMAGES. 167 | 168 | 7. GENERAL 169 | 170 | If any provision of this Agreement is invalid or unenforceable under 171 | applicable law, it shall not affect the validity or enforceability of the 172 | remainder of the terms of this Agreement, and without further action by the 173 | parties hereto, such provision shall be reformed to the minimum extent 174 | necessary to make such provision valid and enforceable. 175 | 176 | If Recipient institutes patent litigation against any entity (including a 177 | cross-claim or counterclaim in a lawsuit) alleging that the Program itself 178 | (excluding combinations of the Program with other software or hardware) 179 | infringes such Recipient's patent(s), then such Recipient's rights granted 180 | under Section 2(b) shall terminate as of the date such litigation is filed. 181 | 182 | All Recipient's rights under this Agreement shall terminate if it fails to 183 | comply with any of the material terms or conditions of this Agreement and 184 | does not cure such failure in a reasonable period of time after becoming 185 | aware of such noncompliance. If all Recipient's rights under this Agreement 186 | terminate, Recipient agrees to cease use and distribution of the Program as 187 | soon as reasonably practicable. However, Recipient's obligations under this 188 | Agreement and any licenses granted by Recipient relating to the Program shall 189 | continue and survive. 190 | 191 | Everyone is permitted to copy and distribute copies of this Agreement, but in 192 | order to avoid inconsistency the Agreement is copyrighted and may only be 193 | modified in the following manner. The Agreement Steward reserves the right to 194 | publish new versions (including revisions) of this Agreement from time to 195 | time. No one other than the Agreement Steward has the right to modify this 196 | Agreement. The Eclipse Foundation is the initial Agreement Steward. The 197 | Eclipse Foundation may assign the responsibility to serve as the Agreement 198 | Steward to a suitable separate entity. Each new version of the Agreement will 199 | be given a distinguishing version number. The Program (including 200 | Contributions) may always be distributed subject to the version of the 201 | Agreement under which it was received. In addition, after a new version of 202 | the Agreement is published, Contributor may elect to distribute the Program 203 | (including its Contributions) under the new version. Except as expressly 204 | stated in Sections 2(a) and 2(b) above, Recipient receives no rights or 205 | licenses to the intellectual property of any Contributor under this 206 | Agreement, whether expressly, by implication, estoppel or otherwise. All 207 | rights in the Program not expressly granted under this Agreement are 208 | reserved. 209 | 210 | This Agreement is governed by the laws of the State of Washington and the 211 | intellectual property laws of the United States of America. No party to this 212 | Agreement will bring a legal action under this Agreement more than one year 213 | after the cause of action arose. Each party waives its rights to a jury trial 214 | in any resulting litigation. 215 | -------------------------------------------------------------------------------- /ORIGINATOR: -------------------------------------------------------------------------------- 1 | @wavejumper 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pushy 2 | [![Clojars Project](https://img.shields.io/clojars/v/clj-commons/pushy.svg)](https://clojars.org/clj-commons/pushy) 3 | [![cljdoc badge](https://cljdoc.org/badge/clj-commons/pushy)](https://cljdoc.org/d/clj-commons/pushy/CURRENT) 4 | [![CircleCI](https://circleci.com/gh/clj-commons/pushy.svg?style=svg)](https://circleci.com/gh/clj-commons/pushy) 5 | 6 | A Clojurescript library for quick and easy HTML5 pushState. Fork of [the original](https://github.com/kibu-australia/pushy) which is no longer maintained. 7 | 8 | ### Setup 9 | 10 | You can construct a new instance by calling the `pushy` function. 11 | 12 | `pushy` takes in two arguments: 13 | 14 | * `dispatch` fn: gets called when there is a match 15 | * `match` fn: checks if the path matches any routes defined. 16 | 17 | Optionally, you can specify an `:identity-fn` which parses and returns the route based on the result of the `match` fn. 18 | 19 | ### Event listeners 20 | 21 | You can start the event listeners with the `start!` method. 22 | 23 | This adds an event listener to all `click` events, which dispatches on all matched routes. 24 | Bypasses on Alt, Shift, Meta, Ctrl keys and middle clicks. 25 | 26 | The `stop!` method will tear down all event listeners of the pushy instance. 27 | 28 | ### Routing libraries 29 | 30 | pushy should work with any routing library: 31 | 32 | [Secretary](https://github.com/gf3/secretary) 33 | 34 | ```clojure 35 | (ns foo.core 36 | (:require [secretary.core :as secretary :include-macros true :refer-macros [defroute]] 37 | [pushy.core :as pushy])) 38 | 39 | (secretary/set-config! :prefix "/") 40 | 41 | (defroute index "/foo" [] 42 | (.log js/console "Hi")) 43 | 44 | (def history (pushy/pushy secretary/dispatch! 45 | (fn [x] (when (secretary/locate-route x) x)))) 46 | 47 | ;; Start event listeners 48 | (pushy/start! history) 49 | ``` 50 | 51 | [Bidi](https://github.com/juxt/bidi) 52 | 53 | ```clojure 54 | (ns foo.core 55 | (:require [bidi.bidi :as bidi] 56 | [pushy.core :as pushy])) 57 | 58 | (def state (atom {})) 59 | 60 | (def app-routes 61 | ["/" {"foo" :foo}]) 62 | 63 | (defn set-page! [match] 64 | (swap! state assoc :page match)) 65 | 66 | (def history 67 | (pushy/pushy set-page! (partial bidi/match-route app-routes))) 68 | 69 | (pushy/start! history) 70 | ``` 71 | 72 | [Silk](https://github.com/DomKM/silk) 73 | 74 | ```clojure 75 | (ns foo.core 76 | (:require [domkm.silk :as silk] 77 | [pushy.core :as pushy])) 78 | 79 | (def state (atom {})) 80 | 81 | (def app-routes 82 | (silk/routes [[:foo [["/foo"]]]])) 83 | 84 | (defn set-page! [match] 85 | (swap! state assoc :page match)) 86 | 87 | (def history 88 | (pushy/pushy set-page! (partial silk/arrive app-routes))) 89 | 90 | (pushy/start! history) 91 | ``` 92 | 93 | [Router](https://github.com/darkleaf/router) 94 | 95 | ```clojure 96 | (ns foo.core 97 | (:require [pushy.core :as pushy] 98 | [darkleaf.router :as r])) 99 | 100 | (r/defcontroller root-controller 101 | (show [_req] 102 | :root)) 103 | 104 | (r/defcontroller pages-controller 105 | (index [_req] 106 | :pages-index)) 107 | 108 | (def routing 109 | (r/group 110 | (r/resource :root root-controller, :segment false) 111 | (r/resources :pages :page pages-controller))) 112 | 113 | (def handler (r/make-handler routing)) 114 | 115 | (def history (pushy/pushy (fn [response] (prn response)) 116 | (fn [uri] (handler {:uri uri, :request-method :get})))) 117 | 118 | (pushy/start! history) 119 | 120 | #_(pushy/set-token! history "/") 121 | #_(pushy/set-token! history "/pages") 122 | ``` 123 | 124 | [Sibiro](https://github.com/aroemers/sibiro) 125 | 126 | ```clojure 127 | (ns foo.core 128 | (:require [sibiro.core :as sibiro] 129 | [pushy.core :as pushy])) 130 | 131 | (def state (atom {})) 132 | 133 | (defn set-page! [match] 134 | (assoc state :page match)) 135 | 136 | (def routes 137 | {[:get "/home" :home]}) 138 | 139 | (defn match-uri [uri] 140 | (:route-handler (sibiro/match-uri (sibiro/compile-routes routes) uri :get))) 141 | 142 | (def history (pushy/pushy set-page! match-uri)) 143 | 144 | (pushy/start! history) 145 | ``` 146 | 147 | [Reitit](https://github.com/metosin/reitit) 148 | ```clojure 149 | (ns foo.core 150 | (:require [reitit.core :as r] 151 | [pushy.core :as pushy])) 152 | 153 | (def routes 154 | [["/" {:page :index 155 | :name :index}]]) 156 | 157 | (def router (r/router routes)) 158 | 159 | (def history 160 | (pushy/pushy 161 | (fn [match] (prn match)) 162 | (fn [uri] (r/match-by-path router uri)))) 163 | 164 | (pushy/start! history) 165 | ``` 166 | 167 | ### URL handling 168 | 169 | By default pushy will dispatch on all relative URLs and absolute URLs that match the window's origin. This means that all external links will be bypassed. 170 | 171 | It is possible to specify which URLs are processable to pushy by specifying a custom predicate function `:processable-url?` in the constructor. This function is passed a single argument which is an instance of `goog.URI`. 172 | 173 | ### goog.history.HTML5History methods 174 | 175 | You can set the history state manually by calling the `set-token!` method. This will call the `dispatch` fn on a successfully matched path. 176 | 177 | Example: 178 | 179 | ```clojure 180 | (set-token! history "/foo") 181 | 182 | (get-token history) 183 | ;; => /foo 184 | ``` 185 | 186 | Likewise, you can call `replace-token!` which will also call the `dispatch` fn and replace the current history state without affecting the rest of the history stack. 187 | 188 | ## License 189 | 190 | Copyright © 2017 191 | 192 | Distributed under the Eclipse Public License either version 1.0 193 | -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject clj-commons/pushy "0.3.11-SNAPSHOT" 2 | :description "HTML5 pushState for Clojurescript" 3 | :url "https://github.com/clj-commons/pushy" 4 | :license {:name "Eclipse Public License" 5 | :url "http://www.eclipse.org/legal/epl-v10.html"} 6 | 7 | :dependencies [[org.clojure/clojure "1.8.0" :scope "provided"] 8 | [org.clojure/clojurescript "1.9.494" :scope "provided"]] 9 | 10 | :aliases {"test" ["do" "clean," "doo" "phantom" "test" "once"]} 11 | 12 | 13 | :deploy-repositories [["releases" {:sign-releases false :url "https://clojars.org/repo"}] 14 | ["snapshots" {:sign-releases false :url "https://clojars.org/repo"}]] 15 | 16 | :release-tasks [["vcs" "assert-committed"] 17 | ["change" "version" "leiningen.release/bump-version" "release"] 18 | ["vcs" "commit"] 19 | ["vcs" "tag" "v" "--no-sign"] 20 | ["deploy"] 21 | ["change" "version" "leiningen.release/bump-version"] 22 | ["vcs" "commit"] 23 | ["vcs" "push"]] 24 | 25 | :source-paths ["src"] 26 | 27 | :profiles {:dev {:dependencies [[secretary "1.2.3"]] 28 | :plugins [[lein-cljsbuild "1.1.7"] 29 | [lein-doo "0.1.10"]] 30 | 31 | :cljsbuild 32 | {:test-commands 33 | {"unit" ["phantomjs" :runner 34 | "target/unit-test.js"]} 35 | :builds 36 | {:test {:source-paths ["src" "test"] 37 | :compiler {:output-to "target/unit-test.js" 38 | :main pushy.test.runner 39 | :optimizations :whitespace 40 | :pretty-print true}}}}}}) 41 | -------------------------------------------------------------------------------- /src/pushy/core.cljs: -------------------------------------------------------------------------------- 1 | (ns pushy.core 2 | (:require [goog.dom :as dom] 3 | [goog.events :as events] 4 | [clojure.string]) 5 | (:import goog.History 6 | goog.history.Html5History 7 | goog.history.Html5History.TokenTransformer 8 | goog.history.EventType 9 | goog.Uri)) 10 | 11 | (defn- on-click [funk] 12 | (events/listen js/document "click" funk)) 13 | 14 | (defn- update-history! [h] 15 | (doto h 16 | (.setUseFragment false) 17 | (.setPathPrefix "") 18 | (.setEnabled true))) 19 | 20 | (defn- set-retrieve-token! [t] 21 | (set! (.. t -retrieveToken) 22 | (fn [path-prefix location] 23 | (str (.-pathname location) 24 | (.-search location) 25 | (.-hash location)))) 26 | t) 27 | 28 | (defn- set-create-url! [t] 29 | (set! (.. t -createUrl) 30 | (fn [token path-prefix location] 31 | (str path-prefix token))) 32 | t) 33 | 34 | (defn new-history 35 | ([] 36 | (new-history (-> (TokenTransformer.) set-retrieve-token! set-create-url!))) 37 | ([transformer] 38 | (-> (Html5History. js/window transformer) update-history!))) 39 | 40 | (defprotocol IHistory 41 | (set-token! [this token] [this token title]) 42 | (replace-token! [this token] [this token title]) 43 | (get-token [this]) 44 | (start! [this]) 45 | (stop! [this])) 46 | 47 | (defn- processable-url? [uri] 48 | (and (not (clojure.string/blank? uri)) ;; Blank URLs are not processable. 49 | (or (and (not (.hasScheme uri)) (not (.hasDomain uri))) ;; By default only process relative URLs + URLs matching window's origin 50 | (some? (re-matches (re-pattern (str "^" (.-origin js/location) ".*$")) 51 | (str uri)))))) 52 | 53 | (defn- get-token-from-uri [uri] 54 | (let [path (.getPath uri) 55 | query (.getQuery uri) 56 | fragment (.getFragment uri)] 57 | (cond-> path 58 | (seq query) (str "?" query) 59 | (seq fragment) (str "#" fragment)))) 60 | 61 | (defn- valid-link? [el] 62 | (and (#{"A" "AREA"} (.-tagName el)) 63 | (.hasAttribute el "href"))) 64 | 65 | (defn pushy 66 | "Takes in three functions: 67 | * dispatch-fn: the function that dispatches when a match is found 68 | * match-fn: the function used to check if a particular route exists 69 | * identity-fn: (optional) extract the route from value returned by match-fn" 70 | [dispatch-fn match-fn & 71 | {:keys [processable-url? identity-fn prevent-default-when-no-match?] 72 | :or {processable-url? processable-url? 73 | identity-fn identity 74 | prevent-default-when-no-match? (constantly false)}}] 75 | 76 | (let [history (new-history) 77 | event-keys (atom nil)] 78 | (reify 79 | IHistory 80 | (set-token! [_ token] 81 | (. history (setToken token))) 82 | (set-token! [_ token title] 83 | (. history (setToken token title))) 84 | 85 | (replace-token! [_ token] 86 | (. history (replaceToken token))) 87 | (replace-token! [_ token title] 88 | (. history (replaceToken token title))) 89 | 90 | (get-token [_] 91 | (.getToken history)) 92 | 93 | (start! [this] 94 | (stop! this) 95 | ;; We want to call `dispatch-fn` on any change to the location 96 | (swap! event-keys conj 97 | (events/listen history EventType.NAVIGATE 98 | (fn [e] 99 | (when-let [match (-> (.-token e) match-fn identity-fn)] 100 | (dispatch-fn match))))) 101 | 102 | ;; Dispatch on initialization 103 | (when-let [match (-> (get-token this) match-fn identity-fn)] 104 | (dispatch-fn match)) 105 | 106 | (swap! event-keys conj 107 | (on-click 108 | (fn [e] 109 | (when-let [el (some-> e .-target (dom/getAncestor valid-link? true))] 110 | (let [uri (.parse Uri (.-href el))] 111 | ;; Proceed if `identity-fn` returns a value and 112 | ;; the user did not trigger the event via one of the 113 | ;; keys we should bypass 114 | (when (and (processable-url? uri) 115 | ;; Bypass dispatch if any of these keys 116 | (not (.-altKey e)) 117 | (not (.-ctrlKey e)) 118 | (not (.-metaKey e)) 119 | (not (.-shiftKey e)) 120 | ;; Bypass if target = _blank 121 | (not (get #{"_blank" "_self"} (.getAttribute el "target"))) 122 | ;; Bypass if explicitly instructed to ignore this element 123 | (or (not (.hasAttribute el "data-pushy-ignore")) 124 | (= (.getAttribute el "data-pushy-ignore") "false")) 125 | ;; Only dispatch on left button click 126 | (= 0 (.-button e))) 127 | (let [next-token (get-token-from-uri uri)] 128 | (if (identity-fn (match-fn next-token)) 129 | ;; Dispatch! 130 | (do 131 | (if-let [title (-> el .-title)] 132 | (set-token! this next-token title) 133 | (set-token! this next-token)) 134 | (.preventDefault e)) 135 | 136 | (when (prevent-default-when-no-match? next-token) 137 | (.preventDefault e)))))))))) 138 | nil) 139 | 140 | (stop! [this] 141 | (doseq [key @event-keys] 142 | (events/unlistenByKey key)) 143 | (reset! event-keys nil))))) 144 | 145 | (defn supported? 146 | "Returns whether Html5History is supported" 147 | ([] (supported? js/window)) 148 | ([window] (.isSupported Html5History window))) 149 | 150 | ;; Backwards compatibility with pushy <= 0.2.2 151 | (defn push-state! 152 | ([dispatch-fn match-fn] 153 | (push-state! dispatch-fn match-fn identity)) 154 | ([dispatch-fn match-fn identity-fn] 155 | (let [h (pushy dispatch-fn match-fn :identity-fn identity-fn)] 156 | (start! h) 157 | h))) 158 | -------------------------------------------------------------------------------- /test/pushy/test/core.cljs: -------------------------------------------------------------------------------- 1 | (ns pushy.test.core 2 | (:require 3 | [clojure.test :refer [deftest is async] :as test] 4 | [pushy.core :as pushy] 5 | [secretary.core :as secretary :refer-macros [defroute]] 6 | [goog.events :as events]) 7 | (:import goog.history.Html5History)) 8 | 9 | (secretary/set-config! :prefix "/") 10 | (def test-val (atom false)) 11 | 12 | (def history 13 | (pushy/pushy secretary/dispatch! 14 | (fn [x] (when (secretary/locate-route x) x)) 15 | identity)) 16 | 17 | (defroute foo-route "/foo" [] 18 | (reset! test-val true)) 19 | 20 | (defroute bar-route "/bar" [] 21 | (reset! test-val true)) 22 | 23 | (deftest constructing-history 24 | (is (instance? Html5History (pushy/new-history)))) 25 | 26 | (deftest constructing-pushy 27 | (is (satisfies? pushy/IHistory (pushy/pushy (constantly nil) (constantly nil))))) 28 | 29 | (deftest supported-browser 30 | (is (pushy/supported?))) 31 | 32 | ;; event listeners started = dispatch 33 | (deftest push-state-foo-route 34 | (async done 35 | (reset! test-val false) 36 | (pushy/start! history) 37 | (pushy/replace-token! history "/foo") 38 | (js/setTimeout 39 | (fn [] 40 | (is @test-val) 41 | (is (nil? (pushy/stop! history))) 42 | (is (= "/foo" (pushy/get-token history))) 43 | (done)) 44 | 5000))) 45 | 46 | ;; no event listeners started = no dispatch 47 | (deftest push-state-bar-route 48 | (async done 49 | (reset! test-val false) 50 | (pushy/replace-token! history "/bar") 51 | (js/setTimeout 52 | (fn [] 53 | (is (false? @test-val)) 54 | (is (= "/bar" (pushy/get-token history))) 55 | (done)) 56 | 5000))) 57 | -------------------------------------------------------------------------------- /test/pushy/test/runner.cljs: -------------------------------------------------------------------------------- 1 | (ns pushy.test.runner 2 | (:require [doo.runner :refer-macros [doo-tests]] 3 | [pushy.test.core])) 4 | 5 | 6 | (doo-tests 'pushy.test.core) 7 | --------------------------------------------------------------------------------