git.iko.soy/typeable/reflex-dom-nested-routing
on master help sign in
6 files changed+131−17
since splitsnapshots
unifiedsplit
CHANGELOG.md+13 LICENSE+30 README.md+4−1 Reflex/Dom/NestedRoute.hs → Reflex/Dom/Routing/Nested.hs+26−9 Reflex/Dom/RouteWriter.hs → Reflex/Dom/Routing/Writer.hs+15−7 reflex-dom-nested-routing.cabal+43
CHANGELOG.mdnew file+13
@@ -0,0 +1,13 @@
1+# Change Log
2+
3+## 0.0.3
4+
5+ * **[Breaking change]** Reorganize modules.
6+
7+## 0.0.2
8+
9+ * **[Breaking change]** Fix `parentRouteSegments` which was giving "grandparent" route instead of parent.
10+
11+## 0.0.1
12+
13+ * Initial prototype.
LICENSEnew file+30
@@ -0,0 +1,30 @@
1+Copyright (c) 2017 Elliot Cameron
2+
3+All rights reserved.
4+
5+Redistribution and use in source and binary forms, with or without
6+modification, are permitted provided that the following conditions are met:
7+
8+ * Redistributions of source code must retain the above copyright
9+ notice, this list of conditions and the following disclaimer.
10+
11+ * Redistributions in binary form must reproduce the above
12+ copyright notice, this list of conditions and the following
13+ disclaimer in the documentation and/or other materials provided
14+ with the distribution.
15+
16+ * Neither the name of Elliot Cameron nor the names of other
17+ contributors may be used to endorse or promote products derived
18+ from this software without specific prior written permission.
19+
20+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
README.md+4−1
@@ -1,5 +1,8 @@
11# Nested Routing for Reflex-DOM
22
3+[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](http://www.haskell.org)
4+[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://tldrlegal.com/license/bsd-3-clause-license-%28revised%29)
5+
36Example:
47
58```haskell
@@ -18,7 +21,7 @@ app = runRouteWithPathInFragment $ do
1821```haskell
1922app = runRouteWithPathInFragment $ fmap snd $ runRouteWriterT $ do
2023 void $ withRoute $ \route -> case fromMaybe "" route of
21− "" -> tellRouteAs ["users"] <=< buttonClick "Open users"
24+ "" -> tellRouteAs ["users"] =<< buttonClick "Open users"
2225 "users" -> users
2326 "test" -> codeToRun
2427 "settings" -> text "Settings"
Reflex/Dom/NestedRoute.hs → Reflex/Dom/Routing/Nested.hsrenamed+26−9
@@ -11,7 +11,7 @@
1111{-# LANGUAGE TypeFamilies #-}
1212{-# LANGUAGE UndecidableInstances #-}
1313
14−module Reflex.Dom.NestedRoute where
14+module Reflex.Dom.Routing.Nested where
1515
1616import Control.Lens (Rewrapped, Wrapped (..), iso, to,
1717 (^.))
@@ -32,7 +32,6 @@ import Data.Maybe (listToMaybe)
3232import Data.Text (Text)
3333import qualified Data.Text as T
3434import Data.Text.Encoding (decodeUtf8, encodeUtf8)
35−import Foreign.JavaScript.TH
3635import Language.Javascript.JSaddle (MonadJSM)
3736import Reflex
3837import Reflex.Dom.Builder.Class
@@ -114,6 +113,8 @@ instance (DomBuilder t m, MonadHold t m, MonadFix m) => DomBuilder t (RouteT t s
114113 placeRawElement = lift . placeRawElement
115114 wrapRawElement e = lift . wrapRawElement e
116115
116+instance (Monad m, NotReady t m) => NotReady t (RouteT t segment m)
117+
117118instance MonadReader r m => MonadReader r (RouteT t segment m) where
118119 ask = lift ask
119120 local f (RouteT a) = RouteT $ mapReaderT (local f) a
@@ -127,14 +128,25 @@ instance HasRoute t segment m => HasRoute t segment (EventWriterT t w m) where
127128instance EventWriter t w m => EventWriter t w (RouteT t segment m) where
128129 tellEvent = lift . tellEvent
129130
131+instance HasRoute t segment m => HasRoute t segment (DynamicWriterT t w m) where
132+ routeContext = lift routeContext
133+ withSegments f (DynamicWriterT a) = DynamicWriterT $ StrictState.mapStateT (withSegments f) a
134+
135+instance DynamicWriter t w m => DynamicWriter t w (RouteT t segment m) where
136+ tellDyn = lift . tellDyn
137+
130138instance HasDocument m => HasDocument (RouteT t segment m)
131−instance HasJSContext m => HasJSContext (RouteT t segment m) where
132− type JSContextPhantom (RouteT t segment m) = JSContextPhantom m
133− askJSContext = RouteT askJSContext
139+
134140#ifndef ghcjs_HOST_OS
135141instance MonadJSM m => MonadJSM (RouteT t segment m)
136142#endif
137143
144+deriving instance DomRenderHook t m => DomRenderHook t (RouteT t segment m)
145+
146+instance (Prerender t m, Monad m, Reflex t) => Prerender t (RouteT t segment m) where
147+ type Client (RouteT t segment m) = RouteT t segment (Client m)
148+ prerender (RouteT a) (RouteT b) = RouteT $ prerender a b
149+
138150
139151instance PrimMonad m => PrimMonad (RouteT t segment m) where
140152 type PrimState (RouteT t segment m) = PrimState m
@@ -180,8 +192,11 @@ runRouteWithPathInFragment
180192 => RouteT t Text m (Event t [Text])
181193 -> m ()
182194runRouteWithPathInFragment = runRoute
183− (T.splitOn "/" . T.dropAround (=='/') . fragAsText)
195+ (nullTextToEmptyList . T.splitOn "/" . T.dropAround (=='/') . fragAsText)
184196 (\oldUrl -> setFrag oldUrl . T.intercalate "/")
197+ where
198+ nullTextToEmptyList [""] = []
199+ nullTextToEmptyList x = x
185200
186201-- | Introduces a new "layer" in the nested routing tree. The given function takes
187202-- the current layer's route segment and builds the DOM for that segment.
@@ -243,9 +258,11 @@ nextRouteSegment = do
243258parentRouteSegments :: (MonadHold t m, MonadFix m, HasRoute t segment m, Eq segment) => m (Dynamic t [segment])
244259parentRouteSegments = do
245260 ctx <- routeContext
246− holdUniqDyn $ do
247− allSegments <- _routeContext_allSegments ctx
248− pure $ take (_routeContext_currentDepth ctx - 1) allSegments
261+ holdUniqDyn $ take (_routeContext_currentDepth ctx) <$> _routeContext_allSegments ctx
262+
263+-- | Route segments from child layers.
264+childRouteSegments :: (MonadHold t m, MonadFix m, HasRoute t segment m, Eq segment) => m (Dynamic t [segment])
265+childRouteSegments = holdUniqDyn =<< _routeContext_nextSegments <$> routeContext
249266
250267-- | A simple helper that produces a routing event on 'getPostBuild'.
251268redirectLocally :: (PostBuild t m) => [segment] -> m (Event t [segment])
Reflex/Dom/RouteWriter.hs → Reflex/Dom/Routing/Writer.hsrenamed+15−7
@@ -9,7 +9,7 @@
99{-# LANGUAGE TypeFamilies #-}
1010{-# LANGUAGE UndecidableInstances #-}
1111
12−module Reflex.Dom.RouteWriter where
12+module Reflex.Dom.Routing.Writer where
1313
1414import Control.Lens (Rewrapped, Wrapped (..), iso)
1515import Control.Monad.Exception (MonadAsyncException,
@@ -20,7 +20,6 @@ import Control.Monad.Reader
2020import Control.Monad.Ref
2121import qualified Control.Monad.State.Strict as StrictState
2222import Data.Coerce (coerce)
23−import Foreign.JavaScript.TH
2423import Language.Javascript.JSaddle (MonadJSM)
2524import Reflex
2625import Reflex.Dom.Builder.Class
@@ -28,7 +27,7 @@ import Reflex.Dom.Builder.Immediate
2827import Reflex.Dom.Core
2928import Reflex.Host.Class
3029
31−import Reflex.Dom.NestedRoute
30+import Reflex.Dom.Routing.Nested
3231
3332
3433class (Reflex t, Monad m) => RouteWriter t segment m | m -> segment, m -> t where
@@ -43,6 +42,11 @@ newtype RouteWriterT t segment m a = RouteWriterT { unRouteWriterT :: EventWrite
4342instance (MonadWidget t m) => RouteWriter t segment (RouteWriterT t segment m) where
4443 tellRoute = RouteWriterT . tellEvent
4544
45+deriving instance DomRenderHook t m => DomRenderHook t (RouteWriterT t segment m)
46+
47+instance (Prerender t m, Monad m, Reflex t) => Prerender t (RouteWriterT t segment m) where
48+ type Client (RouteWriterT t segment m) = RouteWriterT t segment (Client m)
49+ prerender (RouteWriterT a) (RouteWriterT b) = RouteWriterT $ prerender a b
4650
4751instance Requester t m => Requester t (RouteWriterT t segment m) where
4852 type Request (RouteWriterT t segment m) = Request m
@@ -91,18 +95,22 @@ instance (DomBuilder t m, MonadHold t m, MonadFix m) => DomBuilder t (RouteWrite
9195 placeRawElement = lift . placeRawElement
9296 wrapRawElement e = lift . wrapRawElement e
9397
98+instance (Monad m, NotReady t m) => NotReady t (RouteWriterT t segment m)
99+
94100deriving instance MonadReader r m => MonadReader r (RouteWriterT t segment m)
95101
96102instance RouteWriter t segment m => RouteWriter t segment (EventWriterT t w m) where
97103 tellRoute = lift . tellRoute
98−
99104instance EventWriter t w m => EventWriter t w (RouteWriterT t segment m) where
100105 tellEvent = lift . tellEvent
101106
107+instance RouteWriter t segment m => RouteWriter t segment (DynamicWriterT t w m) where
108+ tellRoute = lift . tellRoute
109+instance DynamicWriter t w m => DynamicWriter t w (RouteWriterT t segment m) where
110+ tellDyn = lift . tellDyn
111+
112+
102113instance HasDocument m => HasDocument (RouteWriterT t segment m)
103−instance HasJSContext m => HasJSContext (RouteWriterT t segment m) where
104− type JSContextPhantom (RouteWriterT t segment m) = JSContextPhantom m
105− askJSContext = RouteWriterT askJSContext
106114#ifndef ghcjs_HOST_OS
107115instance MonadJSM m => MonadJSM (RouteWriterT segment t m)
108116#endif
reflex-dom-nested-routing.cabalnew file+43
@@ -0,0 +1,43 @@
1+name: reflex-dom-nested-routing
2+version: 0.0.3
3+synopsis: Nested client-side routing for Reflex-DOM
4+description: See README at <https://github.com/3noch/reflex-dom-nested-routing#readme>
5+category: Web
6+maintainer: Elliot Cameron <elliot@graftedin.io>
7+copyright: 2017 Elliot Cameron
8+license: BSD3
9+license-file: LICENSE
10+build-type: Simple
11+cabal-version: >= 1.10
12+extra-source-files:
13+ CHANGELOG.md
14+ README.md
15+
16+
17+library
18+ hs-source-dirs: .
19+
20+ ghc-options:
21+ -Wall
22+ -Wincomplete-uni-patterns
23+ -Wincomplete-record-updates
24+ -Wno-unused-do-bind
25+ -O2
26+ build-depends:
27+ base
28+ , bytestring
29+ , exception-transformers
30+ , jsaddle
31+ , lens
32+ , mtl
33+ , primitive
34+ , ref-tf
35+ , reflex
36+ , reflex-dom-core
37+ , reflex-dom-contrib
38+ , text
39+ , uri-bytestring
40+ exposed-modules:
41+ Reflex.Dom.Routing.Nested
42+ Reflex.Dom.Routing.Writer
43+ default-language: Haskell2010