-- 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 http://hspec.github.io/.
@package hspec
@version 1.8.1.1

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

-- | This module contains formatters that can be used with
--   hspecWith.
module Test.Hspec.Formatters
silent :: Formatter
specdoc :: Formatter
progress :: Formatter
failed_examples :: Formatter
data Formatter
Formatter :: FormatM () -> (Int -> [String] -> String -> FormatM ()) -> FormatM () -> (Handle -> Path -> Progress -> IO ()) -> (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 ()

-- | used to notify the progress of the currently evaluated example
--   
--   NOTE: This is only called when interactive/color mode.
exampleProgress :: Formatter -> Handle -> Path -> Progress -> IO ()

-- | 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 failuresFormatter
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]

-- | The random seed that is used for QuickCheck.
usedSeed :: FormatM Integer

-- | 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 write, 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

-- | Convert an exception to a string.
--   
--   The type of the exception is included. Here is an example:
--   
--   
--   >>> import Control.Applicative
--   
--   >>> import Control.Exception
--   
--   >>> either formatException show <$> (try . evaluate) (1 `div` 0)
--   "ArithException (divide by zero)"
--   
formatException :: SomeException -> String
class IsFormatter a
toFormatter :: IsFormatter a => a -> IO Formatter
instance IsFormatter Formatter
instance IsFormatter (IO Formatter)

module Test.Hspec.Runner

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

-- | Run given spec and returns a summary of the test run.
--   
--   Note: hspecResult does not exit with exitFailure
--   on failing spec items. If you need this, you have to check the
--   Summary yourself and act accordingly.
hspecResult :: Spec -> IO Summary

-- | Run given spec with custom options and returns a summary of the test
--   run.
--   
--   Note: hspecWith does not exit with exitFailure on
--   failing spec items. If you need this, you have to check the
--   Summary 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) -> Args -> Int -> ColorMode -> Formatter -> Bool -> Either Handle FilePath -> Config
configDryRun :: Config -> Bool
configPrintCpuTime :: Config -> Bool
configFastFail :: 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)
configQuickCheckArgs :: Config -> Args
configSmallCheckDepth :: Config -> Int
configColorMode :: Config -> ColorMode
configFormatter :: Config -> Formatter
configHtmlOutput :: Config -> Bool
configHandle :: Config -> Either Handle FilePath
data ColorMode
ColorAuto :: ColorMode
ColorNever :: ColorMode
ColorAlways :: 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 ||.
configAddFilter :: (Path -> Bool) -> Config -> Config

-- | This function is used by hspec-discover. It is not part of
--   the public API and may change at any time.
hspecWithFormatter :: IsFormatter a => a -> Spec -> IO ()
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 Test.Hspec is more
--   suitable!
module Test.Hspec.Core

-- | A type class for examples.
class Example a
evaluateExample :: Example a => a -> Params -> (IO () -> IO ()) -> IO Result
data Params
Params :: Args -> Int -> (Progress -> IO ()) -> Params
paramsQuickCheckArgs :: Params -> Args
paramsSmallCheckDepth :: Params -> Int
paramsReportProgress :: Params -> Progress -> IO ()
type Progress = (Int, Int)

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

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

-- | Convert a Spec to a forest of SpecTrees.
runSpecM :: Spec -> [SpecTree]

-- | Create a Spec from a forest of SpecTrees.
fromSpecList :: [SpecTree] -> Spec

-- | Internal representation of a spec.
data SpecTree
SpecGroup :: String -> [SpecTree] -> SpecTree
SpecItem :: Item -> SpecTree
data Item
Item :: Bool -> String -> (Params -> (IO () -> IO ()) -> IO Result) -> Item
itemIsParallelizable :: Item -> Bool
itemRequirement :: Item -> String
itemExample :: Item -> Params -> (IO () -> IO ()) -> IO Result
mapSpecItem :: (Item -> Item) -> Spec -> Spec
modifyParams :: (Params -> Params) -> Spec -> Spec

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

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

-- | Deprecated: use `[SpecTree]` instead 
type Specs = [SpecTree]

-- | Deprecated: use hspecWith instead 
hspecB :: [SpecTree] -> IO Bool

-- | Deprecated: use hspec instead 
hspecX :: [SpecTree] -> IO ()

-- | Deprecated: use hspecWith instead 
hHspec :: Handle -> [SpecTree] -> IO Summary

-- | Deprecated: use hspec instead 
hspec :: [SpecTree] -> IO ()

-- | Hspec is a testing library for Haskell.
--   
--   This is the library reference for Hspec. The User's Manual
--   contains more in-depth documentation.
module Test.Hspec
type Spec = SpecM ()

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

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

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

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

-- | This is a type restricted version of id. It can be used to get
--   better error messages on type mismatches.
--   
--   Compare e.g.
--   
--   
--   it "exposes some behavior" $ example $ do
--     putStrLn
--   
--   
--   with
--   
--   
--   it "exposes some behavior" $ do
--     putStrLn
--   
example :: Expectation -> Expectation

-- | Specifies a pending example.
--   
--   If you want to textually specify a behavior but do not have an example
--   yet, use this:
--   
--   
--   describe "fancyFormatter" $ do
--     it "can format text in a way that everyone likes" $
--       pending
--   
pending :: Expectation

-- | Specifies a pending example with a reason for why it's pending.
--   
--   
--   describe "fancyFormatter" $ do
--     it "can format text in a way that everyone likes" $
--       pendingWith "waiting for clarification from the designers"
--   
pendingWith :: String -> Expectation

-- | Run a custom action before every spec item.
before :: IO () -> Spec -> Spec

-- | Run a custom action after every spec item.
after :: IO () -> Spec -> Spec

-- | Run a custom action before and/or after every spec item.
around :: (IO () -> IO ()) -> Spec -> Spec

-- | Run examples of given spec in parallel.
parallel :: Spec -> Spec

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

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

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

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

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

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

-- | Specifies a pending example.
--   
--   If you want to textually specify a behavior but do not have an example
--   yet, use this:
--   
--   
--   describe "fancyFormatter" $ do
--     it "can format text in a way that everyone likes" $
--       pending
--   
pending :: Expectation

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

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

-- | Convert a Spec to a forest of SpecTrees.
runSpecM :: Spec -> [SpecTree]

-- | Create a Spec from a forest of SpecTrees.
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

-- | Use a modified maxSuccess for given spec.
modifyMaxSuccess :: (Int -> Int) -> Spec -> Spec

-- | Use a modified maxDiscardRatio for given spec.
modifyMaxDiscardRatio :: (Int -> Int) -> Spec -> Spec

-- | Use a modified maxSize for given spec.
modifyMaxSize :: (Int -> Int) -> Spec -> Spec
property :: Testable prop => prop -> Property

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