Espec v0.4.2

Modules summary

ESpec

The ESpec basic module. Imports a lot of ESpec components. One should use the module in spec modules

ESpec.Allow
ESpec.AllowTo
ESpec.AssertionHelpers

Defines helper functions for modules which use ESpec. These fucntions wraps arguments for ESpec.ExpectTo module. See ESpec.Assertion module for corresponding ‘assertion modules’

ESpec.Assertions.Accepted
ESpec.Assertions.Be
ESpec.Assertions.BeBetween
ESpec.Assertions.BeCloseTo
ESpec.Assertions.BeType
ESpec.Assertions.ChangeFromTo
ESpec.Assertions.ChangeTo
ESpec.Assertions.Enum.BeEmpty
ESpec.Assertions.Enum.Have
ESpec.Assertions.Enum.HaveAll
ESpec.Assertions.Enum.HaveAny
ESpec.Assertions.Enum.HaveAt
ESpec.Assertions.Enum.HaveCount
ESpec.Assertions.Enum.HaveCountBy
ESpec.Assertions.Enum.HaveMax
ESpec.Assertions.Enum.HaveMaxBy
ESpec.Assertions.Enum.HaveMin
ESpec.Assertions.Enum.HaveMinBy
ESpec.Assertions.Eq
ESpec.Assertions.Eql
ESpec.Assertions.Interface
ESpec.Assertions.List.HaveFirst
ESpec.Assertions.List.HaveHd
ESpec.Assertions.List.HaveLast
ESpec.Assertions.List.HaveTl
ESpec.Assertions.Match
ESpec.Assertions.RaiseException
ESpec.Assertions.ThrowTerm
ESpec.Before

Defines ‘before’ macro. If before block returns {:ok, key: value}, the {key, value} is added to an ‘exapmle dict’. The dict can be accessed in another before, in let, and in example by __ (__[:key])

ESpec.Configuration
ESpec.Context

Defines macros ‘context’, ‘describe’, and ‘example_group’. Defines macros for ‘skip’ and ‘focus’ example groups

ESpec.Example

Defines macros ‘example’ and ‘it’. These macros defines function with random name which will be called when example runs. Example structs %ESpec.Example are accumulated in @examples attribute

ESpec.Expect

Defines helper functions for modules which use ESpec. These fucntions wraps arguments for ESpec.ExpectTo module

ESpec.ExpectTo

Defines to and to_not functions which call specific ‘assertion’

ESpec.Finally

Defines finally macro. The block is evaluated after the example. __ is available. Define the finally before example!

ESpec.Formatter

Functions to print espec results

ESpec.Let

Defines ‘let’, ‘let!’ and ‘subject’ macrsos. ‘let’ and ‘let!’ macros define named functions with cached return values. The ‘let’ evaluate block in runtime when called first time. The ‘let!’ evaluates as a before block just after all ‘befores’ for example. The ‘subject’ macro is just an alias for let to define subject

ESpec.Mock

Defines ‘expect` function to mock function using ‘meck’. :meck.new is called with options :non_strict and :passthrough. The :non_strict allows create mocks for modules and functions that do not exist. The :passthroug options allow call other functions in the module. Information about mock is stored in the ‘:espec_mock_agent’ set. Mock are being unloaded after each example

ESpec.Runner

Defines functions which runs the examples

ESpec.Should

Defines should and should_not helpers

ESpec.SomeModule
ESpec.Support
Mix.Tasks.Espec

Runs the specs

Mix.Tasks.Espec.Init

Exceptions summary

ESpec.AssertionError