Merge branch 'master' into url-parsing

Author: Marcin Szamotulski

GUIDE.md

@@ -5,7 +5,7 @@ A couple notes upfront:
 * This library facilitates hash-based routing.  If you're looking to do pushstate routing with the [history](https://developer.mozilla.org/en-US/docs/Web/API/History_API) object, then you are in the wrong place.
 * Routes are declared using [applicative](https://pursuit.purescript.org/packages/purescript-prelude/0.1.4/docs/Prelude#t:Applicative) syntax.  If you're not yet comfortable with applicatives, see this [chapter](http://learnyouahaskell.com/functors-applicative-functors-and-monoids#applicative-functors) or this [paper](http://www.staff.city.ac.uk/~ross/papers/Applicative.pdf).
 
-####Usage
+#### Usage
 
 First, define some locations:
 

bower.json

@@ -35,7 +35,7 @@
     "purescript-semirings": "^4.0.0",
     "purescript-tuples": "^4.0.0",
     "purescript-validation": "^3.0.0",
-    "purescript-aff": "^3.0.0",
+    "purescript-aff": "^4.0.0",
     "purescript-control": "^3.0.0",
     "purescript-console": "^3.0.0",
     "purescript-integers": "^3.0.0"

package.json

@@ -2,7 +2,7 @@
   "private": true,
   "scripts": {
     "clean": "rimraf output && rimraf .pulp-cache",
-    "build": "pulp build --censor-lib --strict",
+    "build": "pulp build -- --censor-lib --strict",
     "test": "pulp test"
   },
   "devDependencies": {

src/Routing.purs

@@ -9,17 +9,16 @@ module Routing (
   matchesAff'
   ) where
 
-import Prelude (Unit, unit, pure, const, ($))
-import Control.Monad.Eff (Eff())
-import Control.Monad.Aff (Aff(), makeAff)
-import Data.Maybe (Maybe(..))
+import Control.Monad.Aff (Aff, makeAff, nonCanceler)
+import Control.Monad.Eff (Eff)
 import Data.Either (Either(..), either)
-import Data.Tuple (Tuple(..))
+import Data.Maybe (Maybe(..))
 import Data.String.Regex as R
 import Data.String.Regex.Flags as RF
-
-import Routing.Parser (parse)
+import Data.Tuple (Tuple(..))
+import Prelude (Unit, const, pure, unit, ($), (<$))
 import Routing.Match (Match, runMatch)
+import Routing.Parser (parse)
 
 
 foreign import decodeURIComponent :: String -> String
@@ -53,9 +52,9 @@ matches' decoder routing cb = hashes $ \old new ->
 matchesAff' :: forall e a. (String -> String) ->
                Match a -> Aff e (Tuple (Maybe a) a)
 matchesAff' decoder routing =
-  makeAff \_ k -> do
+  makeAff \k -> nonCanceler <$
     matches' decoder routing \old new ->
-      k $ Tuple old new
+      k $ Right $ Tuple old new
 
 matchesAff :: forall e a. Match a -> Aff e (Tuple (Maybe a) a)
 matchesAff = matchesAff' decodeURIComponent

src/Routing/Match.purs

@@ -176,3 +176,12 @@ eitherMatch (Match r2eab) = Match $ \r ->
     case eit of
       Left _ -> invalid $ free $ Fail "Nested check failed"
       Right res -> pure $ Tuple rs res
+
+-- | useful for matching optional params at the end of a path
+-- | ```
+-- | optParams = maybe M.empty id <$> optionalMatch params <* end
+-- | runMatch (lit "path" *> optParams) (parse id "path/?a=1")
+-- | -- (Right (fromFoldable [(Tuple "a" "1")]))
+-- | ```
+optionalMatch :: forall a. Match a -> Match (Maybe a)
+optionalMatch (Match fn) = Match (\route -> unV (const $ pure (Tuple route Nothing)) (pure <<< map Just) $ fn route)