-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Behavior-Driven Development for Haskell
--   
--   Behavior-Driven Development for Haskell
--   
--   Hspec is roughly based on the Ruby library RSpec. However, Hspec is
--   just a framework for running HUnit and QuickCheck tests. Compared to
--   other options, it provides a much nicer syntax that makes tests very
--   easy to read.
--   
--   The Hspec Manual is at <a>http://hspec.github.com/</a>.
@package hspec
@version 1.4.2


-- | This module contains formatters that can be used with
--   <a>hspecWith</a>.
module Test.Hspec.Formatters
silent :: Formatter
specdoc :: Formatter
progress :: Formatter
failed_examples :: Formatter
data Formatter
Formatter :: FormatM () -> (Int -> [String] -> String -> FormatM ()) -> FormatM () -> (Path -> FormatM ()) -> (Path -> Either SomeException String -> FormatM ()) -> (Path -> Maybe String -> FormatM ()) -> FormatM () -> FormatM () -> Formatter
headerFormatter :: Formatter -> FormatM ()

-- | evaluated before each test group
--   
--   The given number indicates the position within the parent group.
exampleGroupStarted :: Formatter -> Int -> [String] -> String -> FormatM ()
exampleGroupDone :: Formatter -> FormatM ()

-- | evaluated after each successful example
exampleSucceeded :: Formatter -> Path -> FormatM ()

-- | evaluated after each failed example
exampleFailed :: Formatter -> Path -> Either SomeException String -> FormatM ()

-- | evaluated after each pending example
examplePending :: Formatter -> Path -> Maybe String -> FormatM ()

-- | evaluated after a test run
failedFormatter :: Formatter -> FormatM ()

-- | evaluated after <tt>failuresFormatter</tt>
footerFormatter :: Formatter -> FormatM ()
data FormatM a

-- | Get the number of successful examples encountered so far.
getSuccessCount :: FormatM Int

-- | Get the number of pending examples encountered so far.
getPendingCount :: FormatM Int

-- | Get the number of failed examples encountered so far.
getFailCount :: FormatM Int

-- | Get the total number of examples encountered so far.
getTotalCount :: FormatM Int
data FailureRecord
FailureRecord :: Path -> Either SomeException String -> FailureRecord
failureRecordPath :: FailureRecord -> Path
failureRecordMessage :: FailureRecord -> Either SomeException String

-- | Get the list of accumulated failure messages.
getFailMessages :: FormatM [FailureRecord]

-- | Get the used CPU time since the test run has been started.
getCPUTime :: FormatM (Maybe Double)

-- | Get the passed real time since the test run has been started.
getRealTime :: FormatM Double

-- | Append some output to the report.
write :: String -> FormatM ()

-- | The same as <a>write</a>, but adds a newline character.
writeLine :: String -> FormatM ()

-- | Append an empty line to the report.
--   
--   Calling this multiple times has the same effect as calling it once.
newParagraph :: FormatM ()

-- | Set output to color green, run given action, and finally restore the
--   default color.
withSuccessColor :: FormatM a -> FormatM a

-- | Set output color to yellow, run given action, and finally restore the
--   default color.
withPendingColor :: FormatM a -> FormatM a

-- | Set output color to red, run given action, and finally restore the
--   default color.
withFailColor :: FormatM a -> FormatM a

module Test.Hspec.HUnit

-- | Convert a HUnit test suite to a spec. This can be used to run existing
--   HUnit tests with Hspec.
fromHUnitTest :: Test -> Spec
instance Example Test


module Test.Hspec.Runner

-- | Run given spec and write a report to <a>stdout</a>. Exit with
--   <a>exitFailure</a> if at least one spec item fails.
--   
--   (see also <a>hspecWith</a>)
hspec :: Spec -> IO ()

-- | Run given spec with custom options. This is similar to <a>hspec</a>,
--   but more flexible.
--   
--   <i>Note</i>: <a>hspecWith</a> does not exit with <a>exitFailure</a> on
--   failing spec items. If you need this, you have to check the
--   <a>Summary</a> yourself and act accordingly.
hspecWith :: Config -> Spec -> IO Summary

-- | Summary of a test run.
data Summary
Summary :: Int -> Int -> Summary
summaryExamples :: Summary -> Int
summaryFailures :: Summary -> Int
data Config
Config :: Bool -> Bool -> Bool -> Maybe (Path -> Bool) -> Params -> ColorMode -> Formatter -> Bool -> Handle -> Config
configVerbose :: Config -> Bool
configPrintCpuTime :: Config -> Bool
configReRun :: Config -> Bool

-- | A predicate that is used to filter the spec before it is run. Only
--   examples that satisfy the predicate are run.
configFilterPredicate :: Config -> Maybe (Path -> Bool)
configParams :: Config -> Params
configColorMode :: Config -> ColorMode
configFormatter :: Config -> Formatter
configHtmlOutput :: Config -> Bool
configHandle :: Config -> Handle
data ColorMode
ColorAuto :: ColorMode
ColorNever :: ColorMode
ColorAlway :: ColorMode

-- | A tuple that represents the location of an example within a spec.
--   
--   It consists of a list of group descriptions and a requirement
--   description.
type Path = ([String], String)
defaultConfig :: Config

-- | Add a filter predicate to config. If there is already a filter
--   predicate, then combine them with <a>||</a>.
configAddFilter :: (Path -> Bool) -> Config -> Config
instance Eq Summary
instance Show Summary
instance Monoid Summary


-- | This module provides access to Hspec's internals. It is less stable
--   than other parts of the API. For most users <a>Test.Hspec</a> is more
--   suitable!
module Test.Hspec.Core

-- | A type class for examples.
class Example a
evaluateExample :: Example a => Params -> a -> IO Result
data Params
Params :: Args -> Params
paramsQuickCheckArgs :: Params -> Args

-- | The result of running an example.
data Result
Success :: Result
Pending :: (Maybe String) -> Result
Fail :: String -> Result

-- | A writer monad for <a>SpecTree</a> forests.
data SpecM a

-- | Convert a <a>Spec</a> to a forest of <a>SpecTree</a>s.
runSpecM :: Spec -> [SpecTree]

-- | Create a <a>Spec</a> from a forest of <a>SpecTree</a>s.
fromSpecList :: [SpecTree] -> Spec

-- | Internal representation of a spec.
data SpecTree
SpecGroup :: String -> [SpecTree] -> SpecTree
SpecItem :: String -> (Params -> IO Result) -> SpecTree

-- | The <tt>describe</tt> function combines a list of specs into a larger
--   spec.
describe :: String -> [SpecTree] -> SpecTree

-- | Create a spec item.
it :: Example a => String -> a -> SpecTree

-- | <i>Deprecated: use `SpecTree` instead</i>
type Spec = SpecTree

-- | <i>Deprecated: use `[SpecTree]` instead</i>
type Specs = [SpecTree]

-- | <i>Deprecated: use `Test.Hspec.Runner.hspecWith` instead</i>
hspecB :: [SpecTree] -> IO Bool

-- | <i>Deprecated: use `Test.Hspec.Runner.hspec` instead</i>
hspecX :: [SpecTree] -> IO ()

-- | <i>Deprecated: use `Test.Hspec.Runner.hspecWith` instead</i>
hHspec :: Handle -> [SpecTree] -> IO Summary

-- | <i>Deprecated: use `Test.Hspec.Runner.hspec` instead</i>
hspec :: [SpecTree] -> IO ()

-- | <i>Deprecated: use `Test.Hspec.Pending` instead</i>
type Pending = Pending

-- | <i>Deprecated: use `Test.Hspec.pending` instead</i>
pending :: String -> Pending


-- | Hspec is a framework for <i>Behavior-Driven Development (BDD)</i> in
--   Haskell. BDD is an approach to software development that combines
--   Test-Driven Development, Domain-Driven Design, and Acceptance
--   Test-Driven Planning. Hspec helps you do the TDD part of that
--   equation, focusing on the documentation and design aspects of TDD.
--   
--   Hspec (and the preceding intro) are based on the Ruby library RSpec.
--   Much of what applies to RSpec also applies to Hspec. Hspec ties
--   together <i>textual descriptions</i> of behavior and <i>examples</i>
--   for that behavior. The examples serve as test cases for the specified
--   behavior. Hspec's mechanism for examples is extensible. Support for
--   QuickCheck properties and HUnit tests is included in the core package.
module Test.Hspec
type Spec = SpecM ()

-- | A type class for examples.
class Example a

-- | A pending example.
data Pending

-- | Combine a list of specs into a larger spec.
describe :: String -> Spec -> Spec

-- | An alias for <a>describe</a>.
context :: String -> Spec -> Spec

-- | Create a spec item.
--   
--   A spec item consists of:
--   
--   <ul>
--   <li>a textual description of a desired behavior</li>
--   <li>an example for that behavior</li>
--   </ul>
--   
--   <pre>
--   describe "absolute" $ do
--     it "returns a positive number when given a negative number" $
--       absolute (-1) == 1
--   </pre>
it :: Example v => String -> v -> Spec

-- | A pending example.
--   
--   If you want to textually specify a behavior but do not have an example
--   yet, use this:
--   
--   <pre>
--   describe "fancyFormatter" $ do
--     it "can format text in a way that everyone likes" $
--       pending
--   </pre>
--   
--   You can give an optional reason for why it's pending:
--   
--   <pre>
--   describe "fancyFormatter" $ do
--     it "can format text in a way that everyone likes" $
--       pending "waiting for clarification from the designers"
--   </pre>
pending :: String -> Pending

-- | Run given spec and write a report to <a>stdout</a>. Exit with
--   <a>exitFailure</a> if at least one spec item fails.
--   
--   (see also <a>hspecWith</a>)
hspec :: Spec -> IO ()


-- | <i>Deprecated: use "Test.Hspec", "Test.Hspec.Runner" or
--   "Test.Hspec.Core" instead</i>
module Test.Hspec.Monadic
type Spec = SpecM ()

-- | A type class for examples.
class Example a

-- | A pending example.
data Pending

-- | Combine a list of specs into a larger spec.
describe :: String -> Spec -> Spec

-- | An alias for <a>describe</a>.
context :: String -> Spec -> Spec

-- | Create a spec item.
--   
--   A spec item consists of:
--   
--   <ul>
--   <li>a textual description of a desired behavior</li>
--   <li>an example for that behavior</li>
--   </ul>
--   
--   <pre>
--   describe "absolute" $ do
--     it "returns a positive number when given a negative number" $
--       absolute (-1) == 1
--   </pre>
it :: Example v => String -> v -> Spec

-- | A pending example.
--   
--   If you want to textually specify a behavior but do not have an example
--   yet, use this:
--   
--   <pre>
--   describe "fancyFormatter" $ do
--     it "can format text in a way that everyone likes" $
--       pending
--   </pre>
--   
--   You can give an optional reason for why it's pending:
--   
--   <pre>
--   describe "fancyFormatter" $ do
--     it "can format text in a way that everyone likes" $
--       pending "waiting for clarification from the designers"
--   </pre>
pending :: String -> Pending

-- | Run given spec and write a report to <a>stdout</a>. Exit with
--   <a>exitFailure</a> if at least one spec item fails.
--   
--   (see also <a>hspecWith</a>)
hspec :: Spec -> IO ()

-- | Summary of a test run.
data Summary
Summary :: Int -> Int -> Summary
summaryExamples :: Summary -> Int
summaryFailures :: Summary -> Int

-- | Convert a <a>Spec</a> to a forest of <a>SpecTree</a>s.
runSpecM :: Spec -> [SpecTree]

-- | Create a <a>Spec</a> from a forest of <a>SpecTree</a>s.
fromSpecList :: [SpecTree] -> Spec
type Specs = Spec
descriptions :: [Spec] -> Spec
hspecB :: Spec -> IO Bool
hspecX :: Spec -> IO ()
hHspec :: Handle -> Spec -> IO Summary


module Test.Hspec.QuickCheck
property :: Testable prop => prop -> Property

-- | <pre>
--   prop ".." $
--     ..
--   </pre>
--   
--   is a shortcut for
--   
--   <pre>
--   it ".." $ property $
--     ..
--   </pre>
prop :: Testable prop => String -> prop -> Spec