ec2eadb...master · typeable/reflex-dom-nested-routing

git.iko.soy/typeable/reflex-dom-nested-routing

on master help sign in

CHANGELOG.mdnew file+13

since splitsnapshots

unifiedsplit

@@ -0,0 +1,13 @@

1+# Change Log

3+## 0.0.3

5+ * **[Breaking change]** Reorganize modules.

7+## 0.0.2

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 @@

5+Redistribution and use in source and binary forms, with or without

6+modification, are permitted provided that the following conditions are met:

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 @@

1# Nested Routing for Reflex-DOM

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)

3Example:

6Example:

5```haskell

8```haskell

@@ -18,7 +21,7 @@ app = runRouteWithPathInFragment $ do

18```haskell

21```haskell

19app = runRouteWithPathInFragment $ fmap snd $ runRouteWriterT $ do

22app = runRouteWithPathInFragment $ fmap snd $ runRouteWriterT $ do

20 void $ withRoute $ \route -> case fromMaybe "" route of

23 void $ withRoute $ \route -> case fromMaybe "" route of

21− "" -> tellRouteAs ["users"] <=< buttonClick "Open users"

24+ "" -> tellRouteAs ["users"] =<< buttonClick "Open users"

22 "users" -> users

25 "users" -> users

23 "test" -> codeToRun

26 "test" -> codeToRun

24 "settings" -> text "Settings"

27 "settings" -> text "Settings"

Reflex/Dom/NestedRoute.hs → Reflex/Dom/Routing/Nested.hsrenamed+26−9

@@ -11,7 +11,7 @@

11{-# LANGUAGE TypeFamilies #-}

12{-# LANGUAGE UndecidableInstances #-}

14−module Reflex.Dom.NestedRoute where

14+module Reflex.Dom.Routing.Nested where

16import Control.Lens (Rewrapped, Wrapped (..), iso, to,

17 (^.))

@@ -32,7 +32,6 @@ import Data.Maybe (listToMaybe)

32import Data.Text (Text)

33import qualified Data.Text as T

34import Data.Text.Encoding (decodeUtf8, encodeUtf8)

35−import Foreign.JavaScript.TH

36import Language.Javascript.JSaddle (MonadJSM)

35import Language.Javascript.JSaddle (MonadJSM)

37import Reflex

36import Reflex

38import Reflex.Dom.Builder.Class

37import Reflex.Dom.Builder.Class

@@ -114,6 +113,8 @@ instance (DomBuilder t m, MonadHold t m, MonadFix m) => DomBuilder t (RouteT t s

114 placeRawElement = lift . placeRawElement

113 placeRawElement = lift . placeRawElement

115 wrapRawElement e = lift . wrapRawElement e

114 wrapRawElement e = lift . wrapRawElement e

116

115

116+instance (Monad m, NotReady t m) => NotReady t (RouteT t segment m)

117+

117instance MonadReader r m => MonadReader r (RouteT t segment m) where

118instance MonadReader r m => MonadReader r (RouteT t segment m) where

118 ask = lift ask

119 ask = lift ask

119 local f (RouteT a) = RouteT $ mapReaderT (local f) a

120 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

127instance EventWriter t w m => EventWriter t w (RouteT t segment m) where

128instance EventWriter t w m => EventWriter t w (RouteT t segment m) where

128 tellEvent = lift . tellEvent

129 tellEvent = lift . tellEvent

129

130

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+

130instance HasDocument m => HasDocument (RouteT t segment m)

138instance HasDocument m => HasDocument (RouteT t segment m)

131−instance HasJSContext m => HasJSContext (RouteT t segment m) where

139+

132− type JSContextPhantom (RouteT t segment m) = JSContextPhantom m

133− askJSContext = RouteT askJSContext

134#ifndef ghcjs_HOST_OS

140#ifndef ghcjs_HOST_OS

135instance MonadJSM m => MonadJSM (RouteT t segment m)

141instance MonadJSM m => MonadJSM (RouteT t segment m)

136#endif

142#endif

137

143

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+

138

150

139instance PrimMonad m => PrimMonad (RouteT t segment m) where

151instance PrimMonad m => PrimMonad (RouteT t segment m) where

140 type PrimState (RouteT t segment m) = PrimState m

152 type PrimState (RouteT t segment m) = PrimState m

@@ -180,8 +192,11 @@ runRouteWithPathInFragment

180 => RouteT t Text m (Event t [Text])

192 => RouteT t Text m (Event t [Text])

181 -> m ()

193 -> m ()

182runRouteWithPathInFragment = runRoute

194runRouteWithPathInFragment = runRoute

183− (T.splitOn "/" . T.dropAround (=='/') . fragAsText)

195+ (nullTextToEmptyList . T.splitOn "/" . T.dropAround (=='/') . fragAsText)

184 (\oldUrl -> setFrag oldUrl . T.intercalate "/")

196 (\oldUrl -> setFrag oldUrl . T.intercalate "/")

197+ where

198+ nullTextToEmptyList [""] = []

199+ nullTextToEmptyList x = x

185

200

186-- | Introduces a new "layer" in the nested routing tree. The given function takes

201-- | Introduces a new "layer" in the nested routing tree. The given function takes

187-- the current layer's route segment and builds the DOM for that segment.

202-- the current layer's route segment and builds the DOM for that segment.

@@ -243,9 +258,11 @@ nextRouteSegment = do

243parentRouteSegments :: (MonadHold t m, MonadFix m, HasRoute t segment m, Eq segment) => m (Dynamic t [segment])

258parentRouteSegments :: (MonadHold t m, MonadFix m, HasRoute t segment m, Eq segment) => m (Dynamic t [segment])

244parentRouteSegments = do

259parentRouteSegments = do

245 ctx <- routeContext

260 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

249

266

250-- | A simple helper that produces a routing event on 'getPostBuild'.

267-- | A simple helper that produces a routing event on 'getPostBuild'.

251redirectLocally :: (PostBuild t m) => [segment] -> m (Event t [segment])

268redirectLocally :: (PostBuild t m) => [segment] -> m (Event t [segment])

Reflex/Dom/RouteWriter.hs → Reflex/Dom/Routing/Writer.hsrenamed+15−7

@@ -9,7 +9,7 @@

9{-# LANGUAGE TypeFamilies #-}

10{-# LANGUAGE UndecidableInstances #-}

12−module Reflex.Dom.RouteWriter where

12+module Reflex.Dom.Routing.Writer where

14import Control.Lens (Rewrapped, Wrapped (..), iso)

15import Control.Monad.Exception (MonadAsyncException,

@@ -20,7 +20,6 @@ import Control.Monad.Reader

20import Control.Monad.Ref

21import qualified Control.Monad.State.Strict as StrictState

22import Data.Coerce (coerce)

23−import Foreign.JavaScript.TH

24import Language.Javascript.JSaddle (MonadJSM)

23import Language.Javascript.JSaddle (MonadJSM)

25import Reflex

24import Reflex

26import Reflex.Dom.Builder.Class

25import Reflex.Dom.Builder.Class

@@ -28,7 +27,7 @@ import Reflex.Dom.Builder.Immediate

28import Reflex.Dom.Core

27import Reflex.Dom.Core

29import Reflex.Host.Class

28import Reflex.Host.Class

31−import Reflex.Dom.NestedRoute

30+import Reflex.Dom.Routing.Nested

34class (Reflex t, Monad m) => RouteWriter t segment m | m -> segment, m -> t where

33class (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

43instance (MonadWidget t m) => RouteWriter t segment (RouteWriterT t segment m) where

42instance (MonadWidget t m) => RouteWriter t segment (RouteWriterT t segment m) where

44 tellRoute = RouteWriterT . tellEvent

43 tellRoute = RouteWriterT . tellEvent

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

47instance Requester t m => Requester t (RouteWriterT t segment m) where

51instance Requester t m => Requester t (RouteWriterT t segment m) where

48 type Request (RouteWriterT t segment m) = Request m

52 type Request (RouteWriterT t segment m) = Request m

@@ -91,18 +95,22 @@ instance (DomBuilder t m, MonadHold t m, MonadFix m) => DomBuilder t (RouteWrite

91 placeRawElement = lift . placeRawElement

95 placeRawElement = lift . placeRawElement

92 wrapRawElement e = lift . wrapRawElement e

96 wrapRawElement e = lift . wrapRawElement e

98+instance (Monad m, NotReady t m) => NotReady t (RouteWriterT t segment m)

99+

94deriving instance MonadReader r m => MonadReader r (RouteWriterT t segment m)

100deriving instance MonadReader r m => MonadReader r (RouteWriterT t segment m)

101

96instance RouteWriter t segment m => RouteWriter t segment (EventWriterT t w m) where

102instance RouteWriter t segment m => RouteWriter t segment (EventWriterT t w m) where

97 tellRoute = lift . tellRoute

103 tellRoute = lift . tellRoute

98−

99instance EventWriter t w m => EventWriter t w (RouteWriterT t segment m) where

104instance EventWriter t w m => EventWriter t w (RouteWriterT t segment m) where

100 tellEvent = lift . tellEvent

105 tellEvent = lift . tellEvent

101

106

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+

102instance HasDocument m => HasDocument (RouteWriterT t segment m)

113instance 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

106#ifndef ghcjs_HOST_OS

114#ifndef ghcjs_HOST_OS

107instance MonadJSM m => MonadJSM (RouteWriterT segment t m)

115instance MonadJSM m => MonadJSM (RouteWriterT segment t m)

108#endif

116#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