fakepull (empty) → 0.3.0.1

raw patch · 8 files changed

+498/−0 lines, 8 filesdep +QuickCheckdep +basedep +exceptionssetup-changed

Dependencies added: QuickCheck, base, exceptions, fakepull, hspec, mtl

Files

ChangeLog.md +5/−0
LICENSE +201/−0
README.md +82/−0
Setup.hs +2/−0
fakepull.cabal +50/−0
src/Test/Pull/Fake/IO.hs +31/−0
src/Test/Pull/Fake/Pure.hs +92/−0
test/Spec.hs +35/−0

+ ChangeLog.md view

@@ -0,0 +1,5 @@+# Changelog for fakepull++## 0.0.1.0 (2020-09-05)++Initial Release

+ LICENSE view

@@ -0,0 +1,201 @@+                                 Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/++   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++   1. Definitions.++      "License" shall mean the terms and conditions for use, reproduction,+      and distribution as defined by Sections 1 through 9 of this document.++      "Licensor" shall mean the copyright owner or entity authorized by+      the copyright owner that is granting the License.++      "Legal Entity" shall mean the union of the acting entity and all+      other entities that control, are controlled by, or are under common+      control with that entity. For the purposes of this definition,+      "control" means (i) the power, direct or indirect, to cause the+      direction or management of such entity, whether by contract or+      otherwise, or (ii) ownership of fifty percent (50%) or more of the+      outstanding shares, or (iii) beneficial ownership of such entity.++      "You" (or "Your") shall mean an individual or Legal Entity+      exercising permissions granted by this License.++      "Source" form shall mean the preferred form for making modifications,+      including but not limited to software source code, documentation+      source, and configuration files.++      "Object" form shall mean any form resulting from mechanical+      transformation or translation of a Source form, including but+      not limited to compiled object code, generated documentation,+      and conversions to other media types.++      "Work" shall mean the work of authorship, whether in Source or+      Object form, made available under the License, as indicated by a+      copyright notice that is included in or attached to the work+      (an example is provided in the Appendix below).++      "Derivative Works" shall mean any work, whether in Source or Object+      form, that is based on (or derived from) the Work and for which the+      editorial revisions, annotations, elaborations, or other modifications+      represent, as a whole, an original work of authorship. For the purposes+      of this License, Derivative Works shall not include works that remain+      separable from, or merely link (or bind by name) to the interfaces of,+      the Work and Derivative Works thereof.++      "Contribution" shall mean any work of authorship, including+      the original version of the Work and any modifications or additions+      to that Work or Derivative Works thereof, that is intentionally+      submitted to Licensor for inclusion in the Work by the copyright owner+      or by an individual or Legal Entity authorized to submit on behalf of+      the copyright owner. For the purposes of this definition, "submitted"+      means any form of electronic, verbal, or written communication sent+      to the Licensor or its representatives, including but not limited to+      communication on electronic mailing lists, source code control systems,+      and issue tracking systems that are managed by, or on behalf of, the+      Licensor for the purpose of discussing and improving the Work, but+      excluding communication that is conspicuously marked or otherwise+      designated in writing by the copyright owner as "Not a Contribution."++      "Contributor" shall mean Licensor and any individual or Legal Entity+      on behalf of whom a Contribution has been received by Licensor and+      subsequently incorporated within the Work.++   2. Grant of Copyright License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      copyright license to reproduce, prepare Derivative Works of,+      publicly display, publicly perform, sublicense, and distribute the+      Work and such Derivative Works in Source or Object form.++   3. Grant of Patent License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      (except as stated in this section) patent license to make, have made,+      use, offer to sell, sell, import, and otherwise transfer the Work,+      where such license applies only to those patent claims licensable+      by such Contributor that are necessarily infringed by their+      Contribution(s) alone or by combination of their Contribution(s)+      with the Work to which such Contribution(s) was submitted. If You+      institute patent litigation against any entity (including a+      cross-claim or counterclaim in a lawsuit) alleging that the Work+      or a Contribution incorporated within the Work constitutes direct+      or contributory patent infringement, then any patent licenses+      granted to You under this License for that Work shall terminate+      as of the date such litigation is filed.++   4. Redistribution. You may reproduce and distribute copies of the+      Work or Derivative Works thereof in any medium, with or without+      modifications, and in Source or Object form, provided that You+      meet the following conditions:++      (a) You must give any other recipients of the Work or+          Derivative Works a copy of this License; and++      (b) You must cause any modified files to carry prominent notices+          stating that You changed the files; and++      (c) You must retain, in the Source form of any Derivative Works+          that You distribute, all copyright, patent, trademark, and+          attribution notices from the Source form of the Work,+          excluding those notices that do not pertain to any part of+          the Derivative Works; and++      (d) If the Work includes a "NOTICE" text file as part of its+          distribution, then any Derivative Works that You distribute must+          include a readable copy of the attribution notices contained+          within such NOTICE file, excluding those notices that do not+          pertain to any part of the Derivative Works, in at least one+          of the following places: within a NOTICE text file distributed+          as part of the Derivative Works; within the Source form or+          documentation, if provided along with the Derivative Works; or,+          within a display generated by the Derivative Works, if and+          wherever such third-party notices normally appear. The contents+          of the NOTICE file are for informational purposes only and+          do not modify the License. You may add Your own attribution+          notices within Derivative Works that You distribute, alongside+          or as an addendum to the NOTICE text from the Work, provided+          that such additional attribution notices cannot be construed+          as modifying the License.++      You may add Your own copyright statement to Your modifications and+      may provide additional or different license terms and conditions+      for use, reproduction, or distribution of Your modifications, or+      for any such Derivative Works as a whole, provided Your use,+      reproduction, and distribution of the Work otherwise complies with+      the conditions stated in this License.++   5. Submission of Contributions. Unless You explicitly state otherwise,+      any Contribution intentionally submitted for inclusion in the Work+      by You to the Licensor shall be under the terms and conditions of+      this License, without any additional terms or conditions.+      Notwithstanding the above, nothing herein shall supersede or modify+      the terms of any separate license agreement you may have executed+      with Licensor regarding such Contributions.++   6. Trademarks. This License does not grant permission to use the trade+      names, trademarks, service marks, or product names of the Licensor,+      except as required for reasonable and customary use in describing the+      origin of the Work and reproducing the content of the NOTICE file.++   7. Disclaimer of Warranty. Unless required by applicable law or+      agreed to in writing, Licensor provides the Work (and each+      Contributor provides its Contributions) on an "AS IS" BASIS,+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+      implied, including, without limitation, any warranties or conditions+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+      PARTICULAR PURPOSE. You are solely responsible for determining the+      appropriateness of using or redistributing the Work and assume any+      risks associated with Your exercise of permissions under this License.++   8. Limitation of Liability. In no event and under no legal theory,+      whether in tort (including negligence), contract, or otherwise,+      unless required by applicable law (such as deliberate and grossly+      negligent acts) or agreed to in writing, shall any Contributor be+      liable to You for damages, including any direct, indirect, special,+      incidental, or consequential damages of any character arising as a+      result of this License or out of the use or inability to use the+      Work (including but not limited to damages for loss of goodwill,+      work stoppage, computer failure or malfunction, or any and all+      other commercial damages or losses), even if such Contributor+      has been advised of the possibility of such damages.++   9. Accepting Warranty or Additional Liability. While redistributing+      the Work or Derivative Works thereof, You may choose to offer,+      and charge a fee for, acceptance of support, warranty, indemnity,+      or other liability obligations and/or rights consistent with this+      License. However, in accepting such obligations, You may act only+      on Your own behalf and on Your sole responsibility, not on behalf+      of any other Contributor, and only if You agree to indemnify,+      defend, and hold each Contributor harmless for any liability+      incurred by, or claims asserted against, such Contributor by reason+      of your accepting any such warranty or additional liability.++   END OF TERMS AND CONDITIONS++   APPENDIX: How to apply the Apache License to your work.++      To apply the Apache License to your work, attach the following+      boilerplate notice, with the fields enclosed by brackets "{}"+      replaced with your own identifying information. (Don't include+      the brackets!)  The text should be enclosed in the appropriate+      comment syntax for the file format. We also recommend that a+      file or class name and description of purpose be included on the+      same "printed page" as the copyright notice for easier+      identification within third-party archives.++   Copyright 2020 YAMAMOTO Yuji++   Licensed under the Apache License, Version 2.0 (the "License");+   you may not use this file except in compliance with the License.+   You may obtain a copy of the License at++       http://www.apache.org/licenses/LICENSE-2.0++   Unless required by applicable law or agreed to in writing, software+   distributed under the License is distributed on an "AS IS" BASIS,+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+   See the License for the specific language governing permissions and+   limitations under the License.

+ README.md view

@@ -0,0 +1,82 @@+# fakepull++Monad to pull from fake stream-like objects.++## Example++Sometimes you might want to test a function that uses an HTTP client object to+get responses from some web server, without actually making the HTTP requests.++```haskell+-- BEGINNING OF EXAMPLE++import Control.Monad.IO.Class+import Data.IORef+import Data.Maybe+import Test.Hspec+import Test.Pull.Fake.IO+++data Request = Request+  { searchTerm :: String+  , pageSize :: Int+  , cursor :: Maybe String+  } deriving (Eq, Show)+++data Response = Response+  { searchResult :: [String]+  , nextCursor :: Maybe String+  } deriving (Eq, Show)+++-- | The function you test.+--   Call `sendRequest` repeatedly to get all paginated search results using+--   the cursor.+fetchAllPages :: MonadIO m => (Request -> m Response) -> String -> m [String]+fetchAllPages sendRequest term = go [] (Request term 3 Nothing)+ where+  go accum req = do+    res <- sendRequest req+    let newAccum = accum ++ searchResult res+    case nextCursor res of+        Just cur -> do+          let newReq = req { cursor = Just cur }+          go newAccum newReq+        Nothing -> return newAccum+++-- | The function to make an HTTP request actually. Will be stubbed.+sendRequestActually :: Request -> IO Response+sendRequestActually = error "This function should be stubbed!"++-- | Simulate the `sendRequest` function that returns a different result every+--   time.+stubbedSendRequest :: FakeStream Response -> Request -> IO Response+stubbedSendRequest stream _request =+  -- NOTE: You may want to validate the request argument for testing.+  --       I've omitted that for simplicity here.+  fromJust <$> pull stream+++main :: IO ()+main = hspec $+  describe "fetchAllPages" $+    it "collect all results by sending requests" $ do+      let allResponses =+            [ Response ["result 1-1", "result 1-2", "result 1-3"] $ Just "cursor a"+            , Response ["result 2-2", "result 2-2", "result 2-3"] $ Just "cursor b"+            , Response ["result 3-1"] Nothing+            ]++      responsesToReturn <- newFakeStream allResponses+      fetchAllPages (stubbedSendRequest responsesToReturn) "result" +        `shouldReturn` concatMap searchResult allResponses++-- END+```++## Related package++- [fakefs](http://hackage.haskell.org/package/fakefs)+    - This package is a variant of fakefs for stream-like objects.

+ Setup.hs view

@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain

+ fakepull.cabal view

@@ -0,0 +1,50 @@+cabal-version: 2.2++name:           fakepull+version:        0.3.0.1+synopsis:       Monad to pull from fake stream-like objects.+description:    See <https://github.com/igrep/haskell-fakepull#readme>.++homepage:       https://github.com/igrep/haskell-fakepull#readme+bug-reports:    https://github.com/igrep/haskell-fakepull/issues+author:         YAMAMOTO Yuji+maintainer:     whosekiteneverfly@gmail.com+copyright:      2020 Yuji Yamamoto+license:        Apache-2.0+license-file:   LICENSE+category:       Testing+build-type:     Simple+extra-source-files:+    README.md+    ChangeLog.md++source-repository head+  type: git+  location: https://github.com/igrep/haskell-fakepull++common deps+  build-depends:+      base >=4.7 && <5+    , exceptions+    , mtl+  default-language: Haskell2010++library+  import: deps+  exposed-modules:+      Test.Pull.Fake.Pure+      Test.Pull.Fake.IO+  hs-source-dirs:+      src++test-suite fakepull-test+  import: deps+  type: exitcode-stdio-1.0+  main-is: Spec.hs+  hs-source-dirs:+      test+  ghc-options: -threaded -rtsopts -with-rtsopts=-N+  build-depends:+      fakepull+    , hspec+    , QuickCheck

+ src/Test/Pull/Fake/IO.hs view

@@ -0,0 +1,31 @@+{-# LANGUAGE LambdaCase #-}++module Test.Pull.Fake.IO+  ( FakeStream+  , newFakeStream+  , getFakeStreamContents+  , pull+  ) where+++import           Control.Monad.IO.Class (MonadIO, liftIO)+import           Data.IORef             (IORef, atomicModifyIORef', newIORef,+                                         readIORef)+++type FakeStream payload = IORef [payload]+++newFakeStream :: MonadIO m => [payload] -> m (FakeStream payload)+newFakeStream = liftIO . newIORef+++getFakeStreamContents :: MonadIO m => FakeStream payload -> m [payload]+getFakeStreamContents = liftIO . readIORef+++pull :: MonadIO m => FakeStream payload -> m (Maybe payload)+pull stream = do+  liftIO . atomicModifyIORef' stream $ \case+    [] -> ([], Nothing)+    hd : tl -> (tl, Just hd)

+ src/Test/Pull/Fake/Pure.hs view

@@ -0,0 +1,92 @@+{-# LANGUAGE ConstraintKinds            #-}+{-# LANGUAGE FlexibleContexts           #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE LambdaCase                 #-}++module Test.Pull.Fake.Pure+  ( PullT (..)+  , PullM+  , MonadPull+  , runPullT+  , evalPullT+  , execPullT+  , runPullM+  , evalPullM+  , execPullM+  , pull+  ) where++import           Control.Applicative        (Alternative)+import           Control.Monad              (MonadPlus)+import           Control.Monad.Catch        (MonadCatch, MonadMask, MonadThrow)+import           Control.Monad.Cont.Class   (MonadCont)+import           Control.Monad.Except       (MonadError)+import           Control.Monad.Fix          (MonadFix)+import           Control.Monad.IO.Class     (MonadIO)+import           Control.Monad.RWS.Class    (MonadRWS, MonadReader, MonadState,+                                             MonadWriter)+import           Control.Monad.State.Strict (StateT, get, put, runStateT)+import           Control.Monad.Trans        (MonadTrans)+import           Data.Functor.Identity      (Identity, runIdentity)+++newtype PullT payload m a =+  PullT { unPullT :: StateT [payload] m a }+  deriving+    ( Functor+    , Applicative+    , Monad+    , MonadTrans+    , MonadIO+    , Alternative+    , MonadFix+    , MonadFail+    , MonadPlus+    , MonadState [payload]+    , MonadReader r+    , MonadWriter w+    , MonadRWS r w [payload]+    , MonadCont+    , MonadError e+    , MonadCatch+    , MonadMask+    , MonadThrow+    )++type PullM payload = PullT payload Identity+++type MonadPull payload = MonadState [payload]+++runPullT :: PullT payload m a -> [payload] -> m (a, [payload])+runPullT (PullT act) = runStateT act+++evalPullT :: Functor f => PullT payload f a -> [payload] -> f a+evalPullT act = fmap fst . runPullT act+++execPullT :: Functor f => PullT payload f a -> [payload] -> f [payload]+execPullT act = fmap snd . runPullT act+++runPullM :: PullM payload a -> [payload] -> (a, [payload])+runPullM act = runIdentity . runPullT act+++evalPullM :: PullM payload a -> [payload] -> a+evalPullM act = fst . runPullM act+++execPullM :: PullM payload a -> [payload] -> [payload]+execPullM act = snd . runPullM act+++pull :: MonadPull payload m => m (Maybe payload)+pull =+  get >>= \case+    [] -> return Nothing+    hd : tl -> do+      put tl+      return $ Just hd

+ test/Spec.hs view

@@ -0,0 +1,35 @@+{-# LANGUAGE LambdaCase          #-}+{-# LANGUAGE ScopedTypeVariables #-}++import           Test.Hspec+import           Test.Hspec.QuickCheck++import qualified Test.Pull.Fake.IO     as IO+import qualified Test.Pull.Fake.Pure   as Pure+++main :: IO ()+main = hspec $ do+  let runner pull = go+       where+        go =+          pull >>= \case+            Nothing -> return []+            Just payload -> (payload :) <$> go++  describe "Test.Pull.Fake.Pure" $+    describe "pull" $+      prop "pulls from the stack" $ \(payloads :: [Int]) -> do+        let action = runner Pure.pull+            (pulledThings, leftPayloads) = Pure.runPullM action payloads+        pulledThings `shouldBe` payloads+        leftPayloads `shouldBe` []++  describe "Test.Pull.Fake.IO" $+    describe "pull" $+      prop "pulls from the stack" $ \(payloads :: [Int]) -> do+        stack <- IO.newFakeStream payloads+        pulledThings <- runner (IO.pull stack)+        pulledThings `shouldBe` payloads+        leftPayloads <- IO.getFakeStreamContents stack+        leftPayloads `shouldBe` []