Rename filterParams, simplify spec and add hspec-expectations-lifted

Author: eahlberg

package.yaml

@@ -63,6 +63,7 @@ tests:
     dependencies:
       - QuickCheck
       - hspec
+      - hspec-expectations-lifted
       - quickcheck-classes
       - yesod-core
       - yesod-paginator

src/Yesod/Paginator/Widgets.hs

@@ -9,7 +9,7 @@ module Yesod.Paginator.Widgets
     , ellipsedWith
 
     -- * Exported for testing
-    , filterParams
+    , buildParams
     ) where
 
 import Yesod.Paginator.Prelude
@@ -181,14 +181,14 @@ getUpdateGetParams
 getUpdateGetParams pageParamName = do
     params <- handlerToWidget $ reqGetParams <$> getRequest
     pure
-        $ \number -> filterParams pageParamName number params
+        $ \number -> buildParams pageParamName number params
 
 renderGetParams :: [(Text, Text)] -> Text
 renderGetParams [] = ""
 renderGetParams ps = "?" <> T.intercalate "&" (map renderGetParam ps)
     where renderGetParam (k, v) = encodeText k <> "=" <> encodeText v
 
-filterParams :: Show a => PageParamName -> a -> [(Text, Text)] -> [(Text, Text)]
-filterParams pageParamName number params =
+buildParams :: Show a => PageParamName -> a -> [(Text, Text)] -> [(Text, Text)]
+buildParams pageParamName number params =
   let name = unPageParamName pageParamName
   in [(name, tshow number)] <> filter ((/=) name . fst) params

test/SpecHelper.hs

@@ -10,7 +10,8 @@ module SpecHelper
     , module X
     ) where
 
-import Test.Hspec as X
+import Test.Hspec as X hiding (shouldBe)
+import Test.Hspec.Expectations.Lifted as HspecLifted
 import Yesod.Core
 import Yesod.Paginator as X
 import Yesod.Paginator.Prelude as X
@@ -62,3 +63,6 @@ getEllipsedParamNameR total per elements pageParamName = do
 
 withApp :: SpecWith (TestApp App) -> Spec
 withApp = before $ pure (App, id)
+
+shouldBe :: (HasCallStack, Eq a, Show a) => a -> a -> YesodExample site ()
+shouldBe a b = a `HspecLifted.shouldBe` b

test/Yesod/Paginator/WidgetsSpec.hs

@@ -189,7 +189,7 @@ spec = withApp $ do
             , "</ul>"
             ]
 
-    describe "filterParams" $ it "works" $ do
+    describe "buildParams" $ it "works" $ do
         let pageParamName = PageParamName "p"
             pageNumber :: Int
             pageNumber = 3
@@ -202,7 +202,9 @@ spec = withApp $ do
                 , ("ids[]", "2")
                 ]
 
-        assertEq
-            "filters page params not equal to the page number but keeps query params with the same name"
-            (filterParams pageParamName pageNumber params)
-            [("p", "3"), ("foo", "bar"), ("ids[]", "1"), ("ids[]", "2")]
+        buildParams pageParamName pageNumber params
+            `shouldBe` [ ("p", "3")
+                       , ("foo", "bar")
+                       , ("ids[]", "1")
+                       , ("ids[]", "2")
+                       ]

yesod-paginator.cabal

@@ -116,6 +116,7 @@ test-suite test
       QuickCheck
     , base <5
     , hspec
+    , hspec-expectations-lifted
     , quickcheck-classes
     , yesod-core
     , yesod-paginator