[](https://hex.pm/packages/test_match)
[](https://travis-ci.org/Apelsinka223/test_match)
[](https://coveralls.io/github/Apelsinka223/test_match?branch=master)
[](http://inch-ci.org/github/Apelsinka223/test_match)
# RecursiveMatch
Module for matching
### What difference between `Kernel.match?/2` and `RecursiveMatch.match_r/3`?
When you use `Kernel.match?/2`
* can't use functions as pattern
* can't match not strict equality (only `===`, no `==`)
`RecursiveMatch.match_r/3` allows you:
* use functions as patterns
* match not strictly (with option `strict: false`)
* ignore order of lists item (with option `ignore_order: true`)
### What is for `assert_match/3` and `refute_match/3`?
Is is same as `assert RecursiveMatch.match_r`, but with detailed fail message. ExUnit has no special message for `match_r/3` and even special message for `match?/2` is not detailed enough, it has no diff in fail message.
`assert_match/3` provides diff in test fail message
<img src="/images/screenshot.png?raw=true" width="500" height="155">
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `test_match` to your list of dependencies in `mix.exs`:
**Requires `elixir ~> 1.5`**
```elixir
def deps do
[
{:test_match, "~> 1.1.0"}
]
end
```
## Usage
```elixir
defmodule YourModule do
import RecursiveMatch
def function1 do
...
end
def function2 do
...
match_r 1, 2
match_r a, b
match_r :_, b
match_r function1(), 1
...
end
end
```
```elixir
defmodule YourModuleTest do
use ExUnit.Case
import RecursiveMatch
test "some test" do
...
assert_match 1, 2
assert_match :_, b
assert_match a, b
refute_match a, c
assert_match YourModule.function1(), 1
...
end
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/test_match](https://hexdocs.pm/test_match).
