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

-- | A Testing Framework for Haskell
--   
--   Hspec is a testing framework for Haskell. It is inspired by the Ruby
--   library RSpec. Some of Hspec's distinctive features are:
--   
--   
--   
- a friendly DSL for defining tests
--   
- integration with QuickCheck, SmallCheck, and HUnit
--   
- parallel test execution
--   
- automatic discovery of test files
--   
--   
--   The Hspec Manual is at http://hspec.github.io/.
@package hspec
@version 2.4.4

module Test.Hspec.Runner

-- | Deprecated: use Test.Hspec.Contrib.HUnit from package
--   hspec-contrib instead
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

module Test.Hspec.Formatters

-- | Warning: This module is used by hspec-discover. It is not
--   part of the public API and may change at any time.
module Test.Hspec.Discover
type Spec = SpecWith ()

-- | Run given spec and write a report to stdout. Exit with
--   exitFailure if at least one spec item fails.
hspec :: Spec -> IO ()
class IsFormatter a
toFormatter :: IsFormatter a => a -> IO Formatter
hspecWithFormatter :: IsFormatter a => a -> Spec -> IO ()
postProcessSpec :: FilePath -> Spec -> Spec

-- | The describe function combines a list of specs into a larger
--   spec.
describe :: String -> SpecWith a -> SpecWith a
instance Test.Hspec.Discover.IsFormatter (GHC.Types.IO Test.Hspec.Core.Formatters.Monad.Formatter)
instance Test.Hspec.Discover.IsFormatter Test.Hspec.Core.Formatters.Monad.Formatter

-- | Deprecated: use Test.Hspec.Core.Spec instead
module Test.Hspec.Core
describe :: String -> [SpecTree a] -> SpecTree a
it :: Example a => String -> a -> SpecTree (Arg a)

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

-- | A type class for examples
class Example e where type Arg e :: * where {
    type family Arg e :: *;
}

-- | The it function creates 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 :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)

-- | specify is an alias for it.
specify :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)

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

-- | context is an alias for describe.
context :: String -> SpecWith a -> SpecWith a

-- | example 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

-- | parallel marks all spec items of the given spec to be safe for
--   parallel evaluation.
parallel :: SpecWith a -> SpecWith a

-- | Run an IO action while constructing the spec tree.
--   
--   SpecM is a monad to construct a spec tree, without executing
--   any spec items. runIO allows you to run IO actions during
--   this construction phase. The IO action is always run when the spec
--   tree is constructed (e.g. even when --dry-run is specified).
--   If you do not need the result of the IO action to construct the spec
--   tree, beforeAll may be more suitable for your use case.
runIO :: IO r -> SpecM a r

-- | pending can be used to mark a spec item as pending.
--   
--   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

-- | pendingWith is similar to pending, but it takes an
--   additional string argument that can be used to specify the reason for
--   why the spec item is pending.
pendingWith :: String -> Expectation

-- | Changing it to xit marks the corresponding spec item as
--   pending.
--   
--   This can be used to temporarily disable a spec item.
xit :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)

-- | xspecify is an alias for xit.
xspecify :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)

-- | Changing describe to xdescribe marks all spec items of
--   the corresponding subtree as pending.
--   
--   This can be used to temporarily disable spec items.
xdescribe :: String -> SpecWith a -> SpecWith a

-- | xcontext is an alias for xdescribe.
xcontext :: String -> SpecWith a -> SpecWith a

-- | An IO action that expects an argument of type a
type ActionWith a = a -> IO ()

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

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

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

-- | Run a custom action before the first spec item.
beforeAll :: IO a -> SpecWith a -> Spec

-- | Run a custom action before the first spec item.
beforeAll_ :: IO () -> SpecWith a -> SpecWith a

-- | Run a custom action after every spec item.
after :: ActionWith a -> SpecWith a -> SpecWith a

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

-- | Run a custom action after the last spec item.
afterAll :: ActionWith a -> SpecWith a -> SpecWith a

-- | Run a custom action after the last spec item.
afterAll_ :: IO () -> SpecWith a -> SpecWith a

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

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

-- | Run a custom action before and/or after every spec item.
aroundWith :: (ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b

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

module Test.Hspec.QuickCheck

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

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

-- | Use a modified maxSize for given spec.
modifyMaxSize :: (Int -> Int) -> SpecWith a -> SpecWith a

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