README.md

# EctoExplorer

A small utility that uses metaprogramming to provide a neat `~>/2` macro to explore Ecto associations without having to `Repo.preload/2` all the time.

Use it like this:

```
iex> use EctoExplorer, repo: EctoExplorer.Repo
EctoExplorer

iex> f = Repo.get_by(Flag, colors: "YBR")
%EctoExplorer.Schemas.Flag{...}

iex> f~>country.addresses[0].postal_code
"postal_code_ECU_1"
```

## What's missing

- Currently the `Repo.preload/2` being executed under the hood for you isn't sorting results by ID, hence the code doesn't guarantee that `addresses[-1]` is in fact the last address that was inserted (or that `addresses[0]` is the first one).

## Installation

The package can be installed by adding `ecto_explorer` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:ecto_explorer, "~> 0.1.0", only: [:dev, :test]}
  ]
end
```

ℹ️  Notice that we're only adding it as a dependency for `:dev` and `:test` Mix environments.

🚨 Please don't use this in Production! This library is a convenience to quickly navigate
complex domain models, it shouldn't ever be considered as a replacement of proper consideration
of how you `Repo.preload/2` your associations.

Docs can be found at [https://hexdocs.pm/ecto_explorer](https://hexdocs.pm/ecto_explorer).