Merge pull request #30 from natefaubion/housekeeping

Housekeeping, various fixes

Author: natefaubion

.github/workflows/ci.yml

@@ -4,29 +4,34 @@ on:
   push:
     branches: [master]
   pull_request:
-    branches: [master]
 
 jobs:
   build:
     runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v2
 
       - uses: purescript-contrib/setup-purescript@main
+        with:
+          purescript: "0.15.6"
+          spago: "0.20.9"
+          psa: "0.8.2"
+          purs-tidy: "latest"
 
-      - uses: actions/setup-node@v2
+      - name: Cache PureScript dependencies
+        uses: actions/cache@v2
         with:
-          node-version: "14"
+          key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }}
+          path: |
+            .spago
+            output
 
-      - name: Install dependencies
-        run: |
-          npm install -g bower
-          npm install
-          bower install --production
       - name: Build source
-        run: spago build
+        run: spago build --purs-args '--censor-lib --strict'
 
       - name: Run tests
-        run: |
-          bower install
-          spago test
+        run: spago test
+
+      - name: Check formatting
+        run: purs-tidy check src test

.tidyrc.json

@@ -0,0 +1,10 @@
+{
+  "importSort": "ide",
+  "importWrap": "source",
+  "indent": 2,
+  "operatorsFile": null,
+  "ribbon": 1,
+  "typeArrowPlacement": "first",
+  "unicode": "never",
+  "width": null
+}

bower.json

@@ -1,5 +1,5 @@
 let upstream =
-      https://github.com/purescript/package-sets/releases/download/psc-0.15.0-20220429/packages.dhall
-        sha256:03c682bff56fc8f9d8c495ffcc6f524cbd3c89fe04778f965265c08757de8c9d
+      https://github.com/purescript/package-sets/releases/download/psc-0.15.4-20221124/packages.dhall
+        sha256:792255bbd8e2141468d967325f3e78246cb7e500bf3ab6d76d5b22dffbb09d49
 
 in  upstream

packages.dhall

@@ -2,7 +2,6 @@
 , dependencies =
   [ "arrays"
   , "assert"
-  , "bifunctors"
   , "control"
   , "effect"
   , "either"
@@ -12,7 +11,6 @@
   , "lazy"
   , "maybe"
   , "newtype"
-  , "partial"
   , "prelude"
   , "profunctor"
   , "quickcheck"

spago.dhall

@@ -11,6 +11,7 @@ module Routing.Duplex
   , segment
   , param
   , flag
+  , hash
   , many1
   , many
   , rest
@@ -41,7 +42,7 @@ import Data.String (Pattern(..))
 import Data.String as String
 import Data.Symbol (class IsSymbol, reflectSymbol)
 import Prim.Row as Row
-import Prim.RowList (RowList, class RowToList, Cons, Nil)
+import Prim.RowList (class RowToList, Cons, Nil, RowList)
 import Record as Record
 import Routing.Duplex.Parser (RouteParser)
 import Routing.Duplex.Parser as Parser
@@ -167,7 +168,6 @@ segment = RouteDuplex Printer.put Parser.take
 param :: String -> RouteDuplex' String
 param p = RouteDuplex (Printer.param p) (Parser.param p)
 
-
 -- | Consumes or prints a query flag (i.e. parameter without value).
 -- | **Note:** that this combinator ignores the value of the parameter. It only cares about its presence/absence.
 -- | Presence is interpreted as `true`, absence as `false`.
@@ -185,19 +185,28 @@ flag (RouteDuplex enc dec) = RouteDuplex enc' dec'
   enc' _ = mempty
   dec' = Parser.default false (dec $> true)
 
+-- | Consumes or prints the URI hash segment.
+-- |
+-- | ```purescript
+-- | parse hash "abc#def" == Right "def"
+-- | ```
+hash :: RouteDuplex' String
+hash = RouteDuplex Printer.hash Parser.hash
+
 -- | Repeatedly applies a given codec to parse one or more values from path segments.
 -- | Parsing will fail if no segment can be parsed.
 -- |
 -- |```purescript
 -- | parse (many1 (int segment)) "1/2/3/x" == Right [1,2,3]
 -- | parse (many1 (int segment)) "x",      == Left (Expected "Int" "x") :: Either RouteError (Array Int)
 -- |```
-many1 :: forall f a b.
-  Foldable f =>
-  Alt f =>
-  Applicative f =>
-  RouteDuplex a b ->
-  RouteDuplex (f a) (f b)
+many1
+  :: forall f a b
+   . Foldable f
+  => Alt f
+  => Applicative f
+  => RouteDuplex a b
+  -> RouteDuplex (f a) (f b)
 many1 (RouteDuplex enc dec) = RouteDuplex (foldMap enc) (Parser.many1 dec)
 
 -- | Similar to `many1`, except also succeeds when no values can be parsed.
@@ -206,11 +215,12 @@ many1 (RouteDuplex enc dec) = RouteDuplex (foldMap enc) (Parser.many1 dec)
 -- | parse (many (int segment)) "1/2/3/x" == Right [1,2,3]
 -- | parse (many (int segment)) "x",      == Right []
 -- |```
-many :: forall f a b.
-  Foldable f =>
-  Alternative f =>
-  RouteDuplex a b ->
-  RouteDuplex (f a) (f b)
+many
+  :: forall f a b
+   . Foldable f
+  => Alternative f
+  => RouteDuplex a b
+  -> RouteDuplex (f a) (f b)
 many (RouteDuplex enc dec) = RouteDuplex (foldMap enc) (Parser.many dec)
 
 -- | Consumes or prints all the remaining segments.
@@ -314,15 +324,16 @@ record :: forall r. RouteDuplex r {}
 record = RouteDuplex mempty (pure {})
 
 -- | See `record`.
-prop :: forall sym a b r1 r2 r3 rx.
-  IsSymbol sym =>
-  Row.Cons sym a rx r1 =>
-  Row.Cons sym b r2 r3 =>
-  Row.Lacks sym r2 =>
-  Proxy sym ->
-  RouteDuplex a b ->
-  RouteDuplex { | r1 } { | r2 } ->
-  RouteDuplex { | r1 } { | r3 }
+prop
+  :: forall sym a b r1 r2 r3 rx
+   . IsSymbol sym
+  => Row.Cons sym a rx r1
+  => Row.Cons sym b r2 r3
+  => Row.Lacks sym r2
+  => Proxy sym
+  -> RouteDuplex a b
+  -> RouteDuplex { | r1 } { | r2 }
+  -> RouteDuplex { | r1 } { | r3 }
 prop sym (RouteDuplex f g) (RouteDuplex x y) =
   RouteDuplex (\r -> x r <> f (Record.get sym r)) (flip (Record.insert sym) <$> y <*> g)
 
@@ -354,11 +365,11 @@ instance routeDuplexParams ::
       # buildParams (Proxy :: Proxy rl) r
 
 class RouteDuplexBuildParams (rl :: RowList Type) (r1 :: Row Type) (r2 :: Row Type) (r3 :: Row Type) (r4 :: Row Type) | rl -> r1 r2 r3 r4 where
-  buildParams ::
-    Proxy rl ->
-    { | r1 } ->
-    RouteDuplex { | r2 } { | r3 } ->
-    RouteDuplex { | r2 } { | r4 }
+  buildParams
+    :: Proxy rl
+    -> { | r1 }
+    -> RouteDuplex { | r2 } { | r3 }
+    -> RouteDuplex { | r2 } { | r4 }
 
 instance buildParamsCons ::
   ( IsSymbol sym
@@ -378,4 +389,4 @@ instance buildParamsCons ::
 
 instance buildParamsNil ::
   RouteDuplexBuildParams Nil r1 r2 r3 r3 where
-    buildParams _ _ = identity
+  buildParams _ _ = identity

src/Routing/Duplex.purs

@@ -11,25 +11,43 @@ import Record as Record
 import Routing.Duplex (RouteDuplex(..), RouteDuplex', end)
 import Type.Proxy (Proxy(..))
 
-sum :: forall a rep r.
-  Generic a rep =>
-  GRouteDuplex rep r =>
-  { | r } ->
-  RouteDuplex' a
-sum = dimap from to <<< gRouteDuplex
+-- | Builds a parser/printer from a record, where each record field corresponds
+-- | to a constructor name for your data type.
+-- |
+-- | Note: this implicitly inserts calls to `end` for each constructor, making
+-- | the parser only valid for parsing URI suffixes. To parse URI prefixes, or
+-- | to just have more explicit control, use `sumPrefix`.
+sum
+  :: forall a rep r
+   . Generic a rep
+  => GRouteDuplex rep r
+  => { | r }
+  -> RouteDuplex' a
+sum = dimap from to <<< gRouteDuplex end
+
+-- | A variation of `sum` that does not implicitly add an `end` to each branch.
+-- | This is useful for defining sub-parsers that may consume only some of the
+-- | URI segments, leaving the rest for subsequent parsers.
+sumPrefix
+  :: forall a rep r
+   . Generic a rep
+  => GRouteDuplex rep r
+  => { | r }
+  -> RouteDuplex' a
+sumPrefix = dimap from to <<< gRouteDuplex identity
 
 class GRouteDuplex rep (r :: Row Type) | rep -> r where
-  gRouteDuplex :: { | r } -> RouteDuplex' rep
+  gRouteDuplex :: (forall x y. RouteDuplex x y -> RouteDuplex x y) -> { | r } -> RouteDuplex' rep
 
 instance gRouteSum ::
   ( GRouteDuplex a r
   , GRouteDuplex b r
   ) =>
   GRouteDuplex (Sum a b) r where
-  gRouteDuplex r = RouteDuplex enc dec
+  gRouteDuplex end' r = RouteDuplex enc dec
     where
-    RouteDuplex encl decl = gRouteDuplex r
-    RouteDuplex encr decr = gRouteDuplex r
+    RouteDuplex encl decl = gRouteDuplex end' r
+    RouteDuplex encr decr = gRouteDuplex end' r
     enc = case _ of
       Inl a -> encl a
       Inr b -> encr b
@@ -41,10 +59,10 @@ instance gRouteConstructor ::
   , GRouteDuplexCtr a b
   ) =>
   GRouteDuplex (Constructor sym b) r where
-  gRouteDuplex r = RouteDuplex enc dec
+  gRouteDuplex end' r = RouteDuplex enc dec
     where
     RouteDuplex enc' dec' =
-      end
+      end'
         $ (gRouteDuplexCtr :: RouteDuplex' a -> RouteDuplex' b)
         $ Record.get (Proxy :: Proxy sym) r
     enc (Constructor a) = enc' a
@@ -56,32 +74,30 @@ class GRouteDuplexCtr a b | a -> b where
 instance gRouteProduct ::
   GRouteDuplexCtr (Product a b) (Product a b) where
   gRouteDuplexCtr = identity
-else
-instance gRouteNoArguments ::
+else instance gRouteNoArguments ::
   GRouteDuplexCtr NoArguments NoArguments where
   gRouteDuplexCtr = identity
-else
-instance gRouteArgument ::
+else instance gRouteArgument ::
   GRouteDuplexCtr (Argument a) (Argument a) where
   gRouteDuplexCtr = identity
-else
-instance gRouteAll ::
+else instance gRouteAll ::
   GRouteDuplexCtr a (Argument a) where
   gRouteDuplexCtr (RouteDuplex enc dec) =
     RouteDuplex (\(Argument a) -> enc a) (Argument <$> dec)
 
-product :: forall a b c.
-  GRouteDuplexCtr b c =>
-  RouteDuplex' a ->
-  RouteDuplex' b ->
-  RouteDuplex' (Product (Argument a) c)
+product
+  :: forall a b c
+   . GRouteDuplexCtr b c
+  => RouteDuplex' a
+  -> RouteDuplex' b
+  -> RouteDuplex' (Product (Argument a) c)
 product (RouteDuplex encl decl) l = RouteDuplex enc dec
   where
   RouteDuplex encr decr = gRouteDuplexCtr l
   enc (Product (Argument a) b) = encl a <> encr b
   dec = Product <$> (Argument <$> decl) <*> decr
 
-noArgs:: RouteDuplex' NoArguments
+noArgs :: RouteDuplex' NoArguments
 noArgs = pure NoArguments
 
 infixr 0 product as ~

src/Routing/Duplex/Generic.purs

@@ -12,18 +12,15 @@ class GSep a b c | a b -> c where
 instance gsepStringString ::
   GSep String String Unit where
   gsep a b = prefix a $ prefix b $ pure unit
-else
-instance gsepStringRoute ::
+else instance gsepStringRoute ::
   GRouteDuplexCtr a b =>
   GSep String (RouteDuplex a a) b where
   gsep a = prefix a <<< gRouteDuplexCtr
-else
-instance gsepRouteString ::
+else instance gsepRouteString ::
   GRouteDuplexCtr a b =>
   GSep (RouteDuplex a a) String b where
   gsep = suffix <<< gRouteDuplexCtr
-else
-instance gsepProduct ::
+else instance gsepProduct ::
   GRouteDuplexCtr b c =>
   GSep (RouteDuplex a a) (RouteDuplex b b) (Product (Argument a) c) where
   gsep = product
@@ -37,8 +34,7 @@ instance gparamsString ::
   RouteDuplexParams r1 r2 =>
   GParams String { | r1 } { | r2 } where
   gparams a = prefix a <<< params
-else
-instance gparamsRoute ::
+else instance gparamsRoute ::
   RouteDuplexParams r1 r2 =>
   GParams (RouteDuplex a a) { | r1 } (Product (Argument a) (Argument { | r2 })) where
   gparams a = product a <<< params