Ecto.Rut
========

> Ecto Model shortcuts to make your life easier! :tada:

Tired of calling `YourApp.Repo` in your Ecto app for all CRUD operations? Sick of code repetitions?
Want to create, find, update and delete model objects the old ruby-way? Fret no more, `Ecto.Rut` is here!



## Installation

Add `:ecto_rut` as a dependency in your mix.exs file:

```elixir
defp deps do
  [
    {:ecto_rut, "~> 1.0.1"}
  ]
end
```

and run:

```bash
$ mix deps.get
```

### Phoenix Projects

If you have an app built in [Phoenix Framework][1], just add `use Ecto.Rut` in the `models` method
in `web/web.ex`:

```elixir
# web/web.ex

def model do
  quote do
    use Ecto.Schema
    use Ecto.Rut

    # Other stuff...
  end
end
```

That's it! `Ecto.Rut` will automatically be loaded in all of your models. You can now relax!


### Other Ecto Projects

If you're not using Phoenix or you don't want to use Ecto.Rut with all of your models (why wouldn't
you!?), you'll have to manually add `use Ecto.Rut`:

```elixir
defmodule YourApp.Post do
  use Ecto.Schema
  use Ecto.Rut

  # Schema, Changeset and other stuff...
end
```



## Basic Usage

You can call normal `Ecto.Repo` methods directly on the Models:

```elixir
Post.all
# instead of YourApp.Repo.all(Post)

Post.get(2)
# instead of YourApp.Repo.get(Post, 2)


# Other available methods:

Post.insert(title: "Awesome Post", slug: "awesome-post", category_id: 3)

Post.delete(bad_post)

Post.get_by(category: "elixir")
```

All methods (except `all/0`) also have their bang versions available, i.e. `get!/1`.



## Roadmap

 - Write Tests
 - Write Documentation
 - Cover all main `Ecto.Repo` methods
 - Introduce new wrapper methods that accept direct arguments (Such as `Post.delete_by_id(3)`)



## Contributing

 - [Fork][2], Enhance, Send PR
 - Lock issues with any bugs or feature requests
 - Implement something from Roadmap
 - Spread the word



## License

This package is available as open source under the terms of the [MIT License][3].



  [1]: https://github.com/phoenixframework/phoenix
  [2]: https://github.com/sheharyarn/ecto_rut/fork
  [3]: http://opensource.org/licenses/MIT