A project that integrates Phoenix with Ecto, implementing all relevant protocols.

Usage

You can use phoenix_ecto in your projects in two steps:

1. Add it to your mix.exs dependencies:

    def deps do
      [{:phoenix_ecto, "~> 2.0"}]
    end

2. List it as your application dependency:

    def application do
      [applications: [:logger, :phoenix_ecto]]
    end

The Phoenix <-> Ecto integration

Thanks to Elixir protocols, the integration between Phoenix and Ecto is simply a matter of implementing a handful of protocols. We provide the following implementations:

• Phoenix.HTML.FormData protocol for Ecto.Changeset
• Phoenix.HTML.Safe protocol for Decimal, Ecto.Date, Ecto.Time and Ecto.DateTime
• Plug.Exception protocol for the relevant Ecto exceptions
• Poison.Encoder protocol for Decimal, Ecto.Date, Ecto.Time and Ecto.DateTime

Concurrent acceptance tests

This library also provides a plug called Phoenix.Ecto.SQL.Sandbox that allows developers to run acceptance tests concurrently. If you are not familiar with Ecto's SQL sandbox, we recommend you to first get acquainted with it by reading Ecto.Adapters.SQL.Sandbox documentation.

In the examples below, we will list the instructions of running concurrent acceptance tests with Hound but it would apply to any tool.

1. First add Hound as a dependency to your project as outlined in its README

2. Then set a flag to enable the sandbox in config/test.exs:

```elixir
config :your_app, sql_sandbox: true
```

1. And use the flag to conditionally add the plug to lib/your_app/endpoint.ex:

```elixir
if Application.get_env(:your_app, :sql_sandbox) do
  plug Phoenix.Ecto.SQL.Sandbox
end
```

1. Then, within an acceptance test, checkout a sandboxed connection as usual and then use your acceptance test driver to access the sandbox endpoint. This will set a cookie that will be used for connection management in following requests:

```elixir
use Hound.Helpers

setup do
  :ok = Ecto.Adapters.SQL.Sandbox.checkout(YourApp.Repo)
  Hound.start_session
  navigate_to Phoenix.Ecto.SQL.Sandbox.path_for(YourApp.Repo, self())
end
```

Keep in mind phantomjs is not currently supported for concurrent transactional tests as it shares cookies between sessions.

License

Same license as Phoenix.