/usr/share/doc/libghc-hspec-core-doc/html/src/Test-Hspec-Core-Spec.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 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 | <?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.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE CPP #-}</span>
<a name="line-2"></a><span class='hs-cpp'>#if MIN_VERSION_base(4,8,1)</span>
<a name="line-3"></a><span class='hs-cpp'>#define HAS_SOURCE_LOCATIONS</span>
<a name="line-4"></a><span class='hs-comment'>{-# LANGUAGE ImplicitParams #-}</span>
<a name="line-5"></a><span class='hs-cpp'>#endif</span>
<a name="line-6"></a><span class='hs-comment'>-- |</span>
<a name="line-7"></a><span class='hs-comment'>-- Stability: unstable</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- This module provides access to Hspec's internals. It is less stable than</span>
<a name="line-10"></a><span class='hs-comment'>-- other parts of the API. For most users @Test.Hspec@ is more suitable!</span>
<a name="line-11"></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-layout'>(</span>
<a name="line-12"></a>
<a name="line-13"></a><span class='hs-comment'>-- * Defining a spec</span>
<a name="line-14"></a> <span class='hs-varid'>describe</span>
<a name="line-15"></a><span class='hs-layout'>,</span> <span class='hs-varid'>it</span>
<a name="line-16"></a><span class='hs-layout'>,</span> <span class='hs-varid'>pending</span>
<a name="line-17"></a><span class='hs-layout'>,</span> <span class='hs-varid'>pendingWith</span>
<a name="line-18"></a><span class='hs-layout'>,</span> <span class='hs-varid'>parallel</span>
<a name="line-19"></a>
<a name="line-20"></a><span class='hs-comment'>-- * The @SpecM@ monad</span>
<a name="line-21"></a><span class='hs-layout'>,</span> <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>
<a name="line-22"></a>
<a name="line-23"></a><span class='hs-comment'>-- * A type class for examples</span>
<a name="line-24"></a><span class='hs-layout'>,</span> <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'>Example</span>
<a name="line-25"></a>
<a name="line-26"></a><span class='hs-comment'>-- * Internal representation of a spec tree</span>
<a name="line-27"></a><span class='hs-layout'>,</span> <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'>Tree</span>
<a name="line-28"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-29"></a>
<a name="line-30"></a><span class='hs-cpp'>#ifdef HAS_SOURCE_LOCATIONS</span>
<a name="line-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>Stack</span>
<a name="line-32"></a><span class='hs-cpp'>#endif</span>
<a name="line-33"></a>
<a name="line-34"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>E</span>
<a name="line-35"></a>
<a name="line-36"></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'>Expectations</span> <span class='hs-layout'>(</span><span class='hs-conid'>Expectation</span><span class='hs-layout'>)</span>
<a name="line-37"></a>
<a name="line-38"></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-39"></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-40"></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'>Spec</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span>
<a name="line-41"></a>
<a name="line-42"></a><a name="describe"></a><span class='hs-comment'>-- | The @describe@ function combines a list of specs into a larger spec.</span>
<a name="line-43"></a><span class='hs-definition'>describe</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</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-44"></a><span class='hs-definition'>describe</span> <span class='hs-varid'>label</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'>return</span> <span class='hs-varop'>.</span> <span class='hs-varid'>specGroup</span> <span class='hs-varid'>label</span>
<a name="line-45"></a>
<a name="line-46"></a><span class='hs-comment'>-- | The @it@ function creates a spec item.</span>
<a name="line-47"></a><span class='hs-comment'>--</span>
<a name="line-48"></a><span class='hs-comment'>-- A spec item consists of:</span>
<a name="line-49"></a><span class='hs-comment'>--</span>
<a name="line-50"></a><span class='hs-comment'>-- * a textual description of a desired behavior</span>
<a name="line-51"></a><span class='hs-comment'>--</span>
<a name="line-52"></a><span class='hs-comment'>-- * an example for that behavior</span>
<a name="line-53"></a><span class='hs-comment'>--</span>
<a name="line-54"></a><span class='hs-comment'>-- > describe "absolute" $ do</span>
<a name="line-55"></a><span class='hs-comment'>-- > it "returns a positive number when given a negative number" $</span>
<a name="line-56"></a><span class='hs-comment'>-- > absolute (-1) == 1</span>
<a name="line-57"></a><span class='hs-cpp'>#ifdef HAS_SOURCE_LOCATIONS</span>
<a name="line-58"></a><a name="it"></a><span class='hs-definition'>it</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varop'>?</span><span class='hs-varid'>loc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CallStack</span><span class='hs-layout'>,</span> <span class='hs-conid'>Example</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-layout'>(</span><span class='hs-conid'>Arg</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-59"></a><span class='hs-cpp'>#else</span>
<a name="line-60"></a><span class='hs-definition'>it</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Example</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecWith</span> <span class='hs-layout'>(</span><span class='hs-conid'>Arg</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-61"></a><span class='hs-cpp'>#endif</span>
<a name="line-62"></a><span class='hs-definition'>it</span> <span class='hs-varid'>label</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromSpecList</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>specItem</span> <span class='hs-varid'>label</span> <span class='hs-varid'>action</span><span class='hs-keyglyph'>]</span>
<a name="line-63"></a>
<a name="line-64"></a><a name="parallel"></a><span class='hs-comment'>-- | `parallel` marks all spec items of the given spec to be safe for parallel</span>
<a name="line-65"></a><span class='hs-comment'>-- evaluation.</span>
<a name="line-66"></a><span class='hs-definition'>parallel</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'>parallel</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'>itemIsParallelizable</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>True</span><span class='hs-layout'>}</span>
<a name="line-68"></a>
<a name="line-69"></a><a name="pending"></a><span class='hs-comment'>-- | `pending` can be used to indicate that an example is /pending/.</span>
<a name="line-70"></a><span class='hs-comment'>--</span>
<a name="line-71"></a><span class='hs-comment'>-- If you want to textually specify a behavior but do not have an example yet,</span>
<a name="line-72"></a><span class='hs-comment'>-- use this:</span>
<a name="line-73"></a><span class='hs-comment'>--</span>
<a name="line-74"></a><span class='hs-comment'>-- > describe "fancyFormatter" $ do</span>
<a name="line-75"></a><span class='hs-comment'>-- > it "can format text in a way that everyone likes" $</span>
<a name="line-76"></a><span class='hs-comment'>-- > pending</span>
<a name="line-77"></a><span class='hs-definition'>pending</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Expectation</span>
<a name="line-78"></a><span class='hs-definition'>pending</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>throwIO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Pending</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>)</span>
<a name="line-79"></a>
<a name="line-80"></a><a name="pendingWith"></a><span class='hs-comment'>-- |</span>
<a name="line-81"></a><span class='hs-comment'>-- `pendingWith` is similar to `pending`, but it takes an additional string</span>
<a name="line-82"></a><span class='hs-comment'>-- argument that can be used to specify the reason for why it's pending.</span>
<a name="line-83"></a><span class='hs-definition'>pendingWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Expectation</span>
<a name="line-84"></a><span class='hs-definition'>pendingWith</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>throwIO</span> <span class='hs-varop'>.</span> <span class='hs-conid'>Pending</span> <span class='hs-varop'>.</span> <span class='hs-conid'>Just</span>
</pre></body>
</html>
|