/usr/share/doc/libghc-hspec-core-doc/html/src/Test-Hspec-Core-Spec-Monad.html is in libghc-hspec-core-doc 2.2.4-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>src/Test/Hspec/Core/Spec/Monad.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE GeneralizedNewtypeDeriving #-}</span>
<a name="line-2"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Spec</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span>
<a name="line-3"></a> <span class='hs-conid'>Spec</span>
<a name="line-4"></a><span class='hs-layout'>,</span> <span class='hs-conid'>SpecWith</span>
<a name="line-5"></a><span class='hs-layout'>,</span> <span class='hs-conid'>SpecM</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-6"></a><span class='hs-layout'>,</span> <span class='hs-varid'>runSpecM</span>
<a name="line-7"></a><span class='hs-layout'>,</span> <span class='hs-varid'>fromSpecList</span>
<a name="line-8"></a><span class='hs-layout'>,</span> <span class='hs-varid'>runIO</span>
<a name="line-9"></a>
<a name="line-10"></a><span class='hs-layout'>,</span> <span class='hs-varid'>mapSpecTree</span>
<a name="line-11"></a><span class='hs-layout'>,</span> <span class='hs-varid'>mapSpecItem</span>
<a name="line-12"></a><span class='hs-layout'>,</span> <span class='hs-varid'>mapSpecItem_</span>
<a name="line-13"></a><span class='hs-layout'>,</span> <span class='hs-varid'>modifyParams</span>
<a name="line-14"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-15"></a>
<a name="line-16"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Prelude</span> <span class='hs-conid'>()</span>
<a name="line-17"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Compat</span>
<a name="line-18"></a>
<a name="line-19"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Trans</span><span class='hs-varop'>.</span><span class='hs-conid'>Writer</span>
<a name="line-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Class</span> <span class='hs-layout'>(</span><span class='hs-varid'>liftIO</span><span class='hs-layout'>)</span>
<a name="line-21"></a>
<a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Example</span>
<a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Tree</span>
<a name="line-24"></a>
<a name="line-25"></a><a name="Spec"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Spec</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>SpecWith</span> <span class='hs-conid'>()</span>
<a name="line-26"></a>
<a name="line-27"></a><a name="SpecWith"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>SpecM</span> <span class='hs-varid'>a</span> <span class='hs-conid'>()</span>
<a name="line-28"></a>
<a name="line-29"></a><a name="SpecM"></a><span class='hs-comment'>-- | A writer monad for `SpecTree` forests</span>
<a name="line-30"></a><a name="SpecM"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>SpecM</span> <span class='hs-varid'>a</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>SpecM</span> <span class='hs-layout'>(</span><span class='hs-conid'>WriterT</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span>
<a name="line-31"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Functor</span><span class='hs-layout'>,</span> <span class='hs-conid'>Applicative</span><span class='hs-layout'>,</span> <span class='hs-conid'>Monad</span><span class='hs-layout'>)</span>
<a name="line-32"></a>
<a name="line-33"></a><a name="runSpecM"></a><span class='hs-comment'>-- | Convert a `Spec` to a forest of `SpecTree`s.</span>
<a name="line-34"></a><span class='hs-definition'>runSpecM</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span>
<a name="line-35"></a><span class='hs-definition'>runSpecM</span> <span class='hs-layout'>(</span><span class='hs-conid'>SpecM</span> <span class='hs-varid'>specs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>execWriterT</span> <span class='hs-varid'>specs</span>
<a name="line-36"></a>
<a name="line-37"></a><a name="fromSpecList"></a><span class='hs-comment'>-- | Create a `Spec` from a forest of `SpecTree`s.</span>
<a name="line-38"></a><span class='hs-definition'>fromSpecList</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span>
<a name="line-39"></a><span class='hs-definition'>fromSpecList</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>SpecM</span> <span class='hs-varop'>.</span> <span class='hs-varid'>tell</span>
<a name="line-40"></a>
<a name="line-41"></a><a name="runIO"></a><span class='hs-comment'>-- | Run an IO action while constructing the spec tree.</span>
<a name="line-42"></a><span class='hs-comment'>--</span>
<a name="line-43"></a><span class='hs-comment'>-- `SpecM` is a monad to construct a spec tree, without executing any spec</span>
<a name="line-44"></a><span class='hs-comment'>-- items. @runIO@ allows you to run IO actions during this construction phase.</span>
<a name="line-45"></a><span class='hs-comment'>-- The IO action is always run when the spec tree is constructed (e.g. even</span>
<a name="line-46"></a><span class='hs-comment'>-- when @--dry-run@ is specified).</span>
<a name="line-47"></a><span class='hs-comment'>-- If you do not need the result of the IO action to construct the spec tree,</span>
<a name="line-48"></a><span class='hs-comment'>-- `Test.Hspec.Core.Hooks.beforeAll` may be more suitable for your use case.</span>
<a name="line-49"></a><span class='hs-definition'>runIO</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecM</span> <span class='hs-varid'>a</span> <span class='hs-varid'>r</span>
<a name="line-50"></a><span class='hs-definition'>runIO</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>SpecM</span> <span class='hs-varop'>.</span> <span class='hs-varid'>liftIO</span>
<a name="line-51"></a>
<a name="line-52"></a><a name="mapSpecTree"></a><span class='hs-definition'>mapSpecTree</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecTree</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>b</span>
<a name="line-53"></a><span class='hs-definition'>mapSpecTree</span> <span class='hs-varid'>f</span> <span class='hs-varid'>spec</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runIO</span> <span class='hs-layout'>(</span><span class='hs-varid'>runSpecM</span> <span class='hs-varid'>spec</span><span class='hs-layout'>)</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>fromSpecList</span> <span class='hs-varop'>.</span> <span class='hs-varid'>map</span> <span class='hs-varid'>f</span>
<a name="line-54"></a>
<a name="line-55"></a><a name="mapSpecItem"></a><span class='hs-definition'>mapSpecItem</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ActionWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ActionWith</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>Item</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Item</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>b</span>
<a name="line-56"></a><span class='hs-definition'>mapSpecItem</span> <span class='hs-varid'>g</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mapSpecTree</span> <span class='hs-varid'>go</span>
<a name="line-57"></a> <span class='hs-keyword'>where</span>
<a name="line-58"></a> <span class='hs-varid'>go</span> <span class='hs-varid'>spec</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>spec</span> <span class='hs-keyword'>of</span>
<a name="line-59"></a> <span class='hs-conid'>Node</span> <span class='hs-varid'>d</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Node</span> <span class='hs-varid'>d</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>go</span> <span class='hs-varid'>xs</span><span class='hs-layout'>)</span>
<a name="line-60"></a> <span class='hs-conid'>NodeWithCleanup</span> <span class='hs-varid'>cleanup</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>NodeWithCleanup</span> <span class='hs-layout'>(</span><span class='hs-varid'>g</span> <span class='hs-varid'>cleanup</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>go</span> <span class='hs-varid'>xs</span><span class='hs-layout'>)</span>
<a name="line-61"></a> <span class='hs-conid'>Leaf</span> <span class='hs-varid'>item</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Leaf</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span> <span class='hs-varid'>item</span><span class='hs-layout'>)</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="mapSpecItem_"></a><span class='hs-definition'>mapSpecItem_</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Item</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Item</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span>
<a name="line-64"></a><span class='hs-definition'>mapSpecItem_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mapSpecItem</span> <span class='hs-varid'>id</span>
<a name="line-65"></a>
<a name="line-66"></a><a name="modifyParams"></a><span class='hs-definition'>modifyParams</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Params</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Params</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-varid'>a</span>
<a name="line-67"></a><span class='hs-definition'>modifyParams</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mapSpecItem_</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>item</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>item</span> <span class='hs-layout'>{</span><span class='hs-varid'>itemExample</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>p</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>itemExample</span> <span class='hs-varid'>item</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span><span class='hs-layout'>}</span>
</pre></body>
</html>
|