Readly

Readly is a simple module that allow you to create readonly datasource module easily. it is inspired by ActiveHash.

Installation

If available in Hex, the package can be installed as:

• Add readly to your list of dependencies in mix.exs:

elixir version >= 1.3

  def deps do
    [{:readly, "~> 0.1.0"}]
  end

elixir version <= 1.2

  def deps do
    [{:readly, "~> 0.0.4"}]
  end

• Ensure readly is started before your application:

  def application do
    [applications: [:readly]]
  end

Example

defmodule Gender do
  # Use with struct
  use Readly, struct: %{id: nil, name: ""}

  # First arg is datasource. (id is enforce_keys)
  # Second arg is a function name.(both Atom and String are OK)
  readonly %{id: 1, name: "Man"}, "man"
  readonly %{id: 2, name: "Woman"}, :woman
  readonly %{id: 3, name: "Trans"}, :trans
end

Gender.man     # %Gender{id: 1, name: "Man"}
Gender.woman   # %Gender{id: 2, name: "Woman"}
Gender.trans   # %Gender{id: 3, name: "Trans"}
Gender.all     # [%Gender{id: 1, name: "Man"}, %Gender{id: 2, name: "Woman"}, %Gender{id: 3, name: "Trans"}]
Gender.reverse # [%Gender{id: 3, name: "Trans"}, %Gender{id: 2, name: "Woman"}, %Gender{id: 1, name: "Man"}]
Gender.get(1)  # %Gender{id: 1, name: "Man"}
Gender.options(:name, :id)  # [{"Man", 1}, {"Woman", 2} ,{"Trans", 3}]

with Ecto

defmodule User do
  use Ecto.Schema
  import Ecto.Changeset

  schema "users" do
    field :name, :string
    field :gender, Gender
  end

  def changeset(user, params \\ %{}) do
    user
    |> cast(params, [:name, :gender])
  end
end

user = Repo.one(User)
user.gender == Gender.woman

NOTICE: Readly not use Ecto.Type behavior just implement function (type cast load dump)

implement Phoenix.Html.Form protocol

defimpl Phoenix.HTML.Safe, for: Gender do
  def to_iodata(nil),  do: ""
  def to_iodata(data), do: Integer.to_string(data.id)
end

LICENSE

See LICENSE