https://github.com/danielberkompas/ecto_validation_case

Simplify your Ecto validation tests
https://github.com/danielberkompas/ecto_validation_case

Last synced: 3 months ago
JSON representation

Simplify your Ecto validation tests

• Host: GitHub
• URL: https://github.com/danielberkompas/ecto_validation_case
• Owner: danielberkompas
• License: mit
• Created: 2015-05-08T00:53:35.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-09-03T16:31:36.000Z (over 9 years ago)
• Last Synced: 2024-10-07T18:36:58.003Z (4 months ago)
• Language: Elixir
• Size: 160 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Simplify your Ecto model validation tests. Loosely inspired by shoulda matchers, but simpler. (ORM and Datamapping)
• fucking-awesome-elixir - ecto_validation_case - Simplify your Ecto model validation tests. Loosely inspired by shoulda matchers, but simpler. (ORM and Datamapping)
• awesome-elixir - ecto_validation_case - Simplify your Ecto model validation tests. Loosely inspired by shoulda matchers, but simpler. (ORM and Datamapping)

README

        
Ecto.ValidationCase

==================

[![Hex Version](http://img.shields.io/hexpm/v/ecto_validation_case.svg)](https://hex.pm/packages/ecto_validation_case)

[![Build Status](https://travis-ci.org/danielberkompas/ecto_validation_case.svg?branch=master)](https://travis-ci.org/danielberkompas/ecto_validation_case)

[![Inline docs](http://inch-ci.org/github/danielberkompas/ecto_validation_case.svg?branch=master)](http://inch-ci.org/github/danielberkompas/ecto_validation_case)

Simplify your [Ecto][ecto] model validation tests. Loosely inspired by [shoulda

matchers][shoulda], but simpler.

## IMPORTANT

Jose Valim, creator of Elixir, has outlined a better approach to this problem

here: https://groups.google.com/forum/#!topic/elixir-lang-talk/kwLLyCiarls

Go check it out.

## Sample

```elixir

defmodule MyApp.UserTest do

  use ExUnit.Case

  use Ecto.ValidationCase, model: MyApp.User

  test "requires password to be 10 chars long" do

    rejects "password",    for: :password, message: "too short"

    accepts "password123", for: :password

  end

end

```

## Rationale

Rather than create a matching test helper function for each of the valiations

that [Ecto][ecto] supports, this library intentionally keeps things simple,

providing only `accepts/2` and `rejects/2`. Why?

- The api very easy to remember, which makes validation tests more likely to be

  written.

- The tests are more explicit, with a minimum of magic. It is very clear exactly

  what values are being tested, for which fields, and which error messages

  should be returned.

## Installation

You can install `Ecto.ValidationCase` from hex. First, change your `deps` in

`mix.exs` specifying that this is applicable only for the test environment:

```elixir

def deps do

  [{:ecto_validation_case, ">= 0.1.0", env: :test}]

end

```

Then run `mix deps.get` to install.

## Documentation

Documentation is available on `Ecto.ValidationCase`'s [hex page][hex-page].

## License

MIT. See [LICENSE](/LICENSE) and [NOTICE](/NOTICE) for more details.

[hex-page]: https://hex.pm/packages/ecto_validation_case

[ecto]: https://github.com/elixir-lang/ecto

[shoulda]: http://matchers.shoulda.io/