on master help sign in
Merge branch 'master' into canonical-types
commit504793b3b3204ecc1d44785fa09af73d96dc2554 authorAlp Mestanogullari <alpmestan@gmail.com> dateSun 19 Apr 2015, 10:35 (11 years ago) parentad0c6528c6f327
6 files changed+106−33
.gitignore+17 CHANGELOG.md+1 servant-jquery.cabal+4−4 src/Servant/JQuery.hs+3−2 src/Servant/JQuery/Internal.hs+81−26 test/Servant/JQuerySpec.hs−1
.gitignorenew file+17
@@ -0,0 +1,17 @@
1+dist
2+cabal-dev
3+*.o
4+*.hi
5+*.chi
6+*.chs.h
7+*.dyn_o
8+*.dyn_hi
9+.virtualenv
10+.hpc
11+.hsenv
12+.cabal-sandbox/
13+cabal.sandbox.config
14+cabal.config
15+*.prof
16+*.aux
17+*.hp
CHANGELOG.md+1
@@ -2,6 +2,7 @@
22---
33* Extend `HeaderArg` to support more advanced HTTP header handling (https://github.com/haskell-servant/servant-jquery/pull/6)
44* Support content-type aware combinators (but require that endpoints support JSON)
5+* Add support for Matrix params (https://github.com/haskell-servant/servant-jquery/pull/11)
56
670.2.2
78-----
servant-jquery.cabal+4−4
@@ -34,7 +34,7 @@ library
3434 build-depends: base >=4.5 && <5
3535 , charset
3636 , lens >= 4
37− , servant >= 0.2.1
37+ , servant >= 0.2.2
3838 , text
3939 hs-source-dirs: src
4040 default-language: Haskell2010
@@ -54,9 +54,9 @@ executable counter
5454 aeson
5555 , base
5656 , filepath
57− , servant >= 0.2.1
58− , servant-server >= 0.2.1
59− , servant-jquery >= 0.2.1
57+ , servant >= 0.2.2
58+ , servant-server >= 0.2.3
59+ , servant-jquery >= 0.2.2
6060 , stm
6161 , transformers
6262 , warp
src/Servant/JQuery.hs+3−2
@@ -48,7 +48,7 @@ generateJS req = "\n" <>
4848 ++ body
4949 ++ map (toValidFunctionName . (<>) "header" . headerArgName) hs
5050 ++ ["onSuccess", "onError"]
51−
51+
5252 captures = map captureArg
5353 . filter isCapture
5454 $ req ^. reqUrl.path
@@ -78,7 +78,8 @@ generateJS req = "\n" <>
7878
7979 fname = req ^. funcName
8080 method = req ^. reqMethod
81− url = "'"
81+ url = if url' == "'" then "'/'" else url'
82+ url' = "'"
8283 ++ urlArgs
8384 ++ queryArgs
8485
src/Servant/JQuery/Internal.hs+81−26
@@ -24,29 +24,12 @@ import Servant.API
2424
2525type Arg = String
2626
27−data Segment = Static String -- ^ a static path segment. like "/foo"
28− | Cap Arg -- ^ a capture. like "/:userid"
27+data Segment = Segment { _segment :: SegmentType, _matrix :: [MatrixArg] }
2928 deriving (Eq, Show)
3029
31−
32−isCapture :: Segment -> Bool
33−isCapture (Cap _) = True
34−isCapture _ = False
35−
36−captureArg :: Segment -> Arg
37−captureArg (Cap s) = s
38−captureArg _ = error "captureArg called on non capture"
39−
40−jsSegments :: [Segment] -> String
41−jsSegments [] = "/'"
42−jsSegments [x] = "/" ++ segmentToStr x False
43−jsSegments (x:xs) = "/" ++ segmentToStr x True ++ jsSegments xs
44−
45−segmentToStr :: Segment -> Bool -> String
46−segmentToStr (Static s) notTheEnd =
47− if notTheEnd then s else s ++ "'"
48−segmentToStr (Cap s) notTheEnd =
49− "' + encodeURIComponent(" ++ s ++ if notTheEnd then ") + '" else ")"
30+data SegmentType = Static String -- ^ a static path segment. like "/foo"
31+ | Cap Arg -- ^ a capture. like "/:userid"
32+ deriving (Eq, Show)
5033
5134type Path = [Segment]
5235
@@ -113,6 +96,8 @@ toValidFunctionName (x:xs) = [setFirstChar x] <> filter remainder xs
11396 , Set.connectorPunctuation ]
11497toValidFunctionName [] = "_"
11598
99+type MatrixArg = QueryArg
100+
116101data Url = Url
117102 { _path :: Path
118103 , _queryStr :: [QueryArg]
@@ -133,13 +118,52 @@ data AjaxReq = AjaxReq
133118 } deriving (Eq, Show)
134119
135120makeLenses ''QueryArg
121+makeLenses ''Segment
136122makeLenses ''Url
137123makeLenses ''AjaxReq
138124
125+isCapture :: Segment -> Bool
126+isCapture (Segment (Cap _) _) = True
127+isCapture _ = False
128+
129+hasMatrixArgs :: Segment -> Bool
130+hasMatrixArgs (Segment _ (_:_)) = True
131+hasMatrixArgs _ = False
132+
133+hasArgs :: Segment -> Bool
134+hasArgs s = isCapture s || hasMatrixArgs s
135+
136+matrixArgs :: Segment -> [MatrixArg]
137+matrixArgs (Segment _ ms) = ms
138+
139+captureArg :: Segment -> Arg
140+captureArg (Segment (Cap s) _) = s
141+captureArg _ = error "captureArg called on non capture"
142+
143+jsSegments :: [Segment] -> String
144+jsSegments [] = ""
145+jsSegments [x] = "/" ++ segmentToStr x False
146+jsSegments (x:xs) = "/" ++ segmentToStr x True ++ jsSegments xs
147+
148+segmentToStr :: Segment -> Bool -> String
149+segmentToStr (Segment st ms) notTheEnd =
150+ segmentTypeToStr st ++ jsMParams ms ++ if notTheEnd then "" else "'"
151+
152+segmentTypeToStr :: SegmentType -> String
153+segmentTypeToStr (Static s) = s
154+segmentTypeToStr (Cap s) = "' + encodeURIComponent(" ++ s ++ ") + '"
155+
156+jsGParams :: String -> [QueryArg] -> String
157+jsGParams _ [] = ""
158+jsGParams _ [x] = paramToStr x False
159+jsGParams s (x:xs) = paramToStr x True ++ s ++ jsGParams s xs
160+
139161jsParams :: [QueryArg] -> String
140−jsParams [] = ""
141−jsParams [x] = paramToStr x False
142−jsParams (x:xs) = paramToStr x True ++ "&" ++ jsParams xs
162+jsParams = jsGParams "&"
163+
164+jsMParams :: [MatrixArg] -> String
165+jsMParams [] = ""
166+jsMParams xs = ";" ++ jsGParams ";" xs
143167
144168paramToStr :: QueryArg -> Bool -> String
145169paramToStr qarg notTheEnd =
@@ -186,7 +210,7 @@ instance (KnownSymbol sym, HasJQ sublayout)
186210
187211 jqueryFor Proxy req =
188212 jqueryFor (Proxy :: Proxy sublayout) $
189− req & reqUrl.path <>~ [Cap str]
213+ req & reqUrl.path <>~ [Segment (Cap str) []]
190214
191215 where str = symbolVal (Proxy :: Proxy sym)
192216
@@ -258,6 +282,37 @@ instance (KnownSymbol sym, HasJQ sublayout)
258282
259283 where str = symbolVal (Proxy :: Proxy sym)
260284
285+instance (KnownSymbol sym, HasJQ sublayout)
286+ => HasJQ (MatrixParam sym a :> sublayout) where
287+ type JQ (MatrixParam sym a :> sublayout) = JQ sublayout
288+
289+ jqueryFor Proxy req =
290+ jqueryFor (Proxy :: Proxy sublayout) $
291+ req & reqUrl.path._last.matrix <>~ [QueryArg strArg Normal]
292+
293+ where str = symbolVal (Proxy :: Proxy sym)
294+ strArg = str ++ "Value"
295+
296+instance (KnownSymbol sym, HasJQ sublayout)
297+ => HasJQ (MatrixParams sym a :> sublayout) where
298+ type JQ (MatrixParams sym a :> sublayout) = JQ sublayout
299+
300+ jqueryFor Proxy req =
301+ jqueryFor (Proxy :: Proxy sublayout) $
302+ req & reqUrl.path._last.matrix <>~ [QueryArg str List]
303+
304+ where str = symbolVal (Proxy :: Proxy sym)
305+
306+instance (KnownSymbol sym, HasJQ sublayout)
307+ => HasJQ (MatrixFlag sym :> sublayout) where
308+ type JQ (MatrixFlag sym :> sublayout) = JQ sublayout
309+
310+ jqueryFor Proxy req =
311+ jqueryFor (Proxy :: Proxy sublayout) $
312+ req & reqUrl.path._last.matrix <>~ [QueryArg str Flag]
313+
314+ where str = symbolVal (Proxy :: Proxy sym)
315+
261316instance HasJQ Raw where
262317 type JQ' Raw = Method -> AjaxReq
263318
@@ -278,7 +333,7 @@ instance (KnownSymbol path, HasJQ sublayout)
278333
279334 jqueryFor Proxy req =
280335 jqueryFor (Proxy :: Proxy sublayout) $
281− req & reqUrl.path <>~ [Static str]
336+ req & reqUrl.path <>~ [Segment (Static str) []]
282337 & funcName %~ (str <>)
283338
284339 where str = map (\c -> if c == '.' then '_' else c) $ symbolVal (Proxy :: Proxy path)
test/Servant/JQuerySpec.hs−1
@@ -13,7 +13,6 @@ import Language.ECMAScript3.Parser (parseFromString)
1313import Test.Hspec
1414
1515import Servant.API
16−import Servant.API.ContentTypes
1716import Servant.JQuery
1817import Servant.JQuerySpec.CustomHeaders
1918