Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve docs #183

Merged
merged 1 commit into from
Feb 5, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions apps/one_piece_commanded/lib/one_piece/commanded/value_object.ex
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,48 @@ defmodule OnePiece.Commanded.ValueObject do

## Usage

```elixir
defmodule MyValueObject do
use OnePiece.Commanded.ValueObject

embedded_schema do
field :title, :string
# ...
end
end
```

## Overridable

- `validate/2` to add custom validation to the existing `changeset/2` without overriding the whole `changeset/2`
function.

```elixir
defmodule MyValueObject do
use OnePiece.Commanded.ValueObject

embedded_schema do
field :title, :string
# ...
field :amount, :integer
end

def validate(changeset, attrs) do
changeset
|> Changeset.validate_number(:amount, greater_than: 0)
end
end
```

- `changeset/2` returns an `t:Ecto.Changeset.t/0` for a given value object struct.

{:ok, my_value} = MyValueObject.new(%{title: "Hello, World!"})
> #### Overriding Changeset {: .warning}
>
> Be careful when overriding `changeset/2` because the default
> implementation takes care of `cast`, `validate_required` the
> `@enforced_keys` and nested embeds. You may want to call
> `OnePiece.Commanded.ValueObject.changeset/2` to have such features.
>
> If you only need to extend the changeset, you can override the
> `validate/2` function instead.
"""
@spec __using__(opts :: []) :: any()
defmacro __using__(_opts \\ []) do
Expand Down Expand Up @@ -60,45 +92,13 @@ defmodule OnePiece.Commanded.ValueObject do
ValueObject.__new__!(__MODULE__, attrs)
end

@doc """
Used to extend the `t:Ecto.Changeset.t/0` from `changeset/2` without
overriding it.

> #### Example

```elixir
defmodule MyValueObject do
use OnePiece.Commanded.ValueObject

embedded_schema do
field :amount, :integer
end

def validate(changeset, attrs) do
changeset
|> Changeset.validate_number(:amount, greater_than: 0)
end
end
```
"""
@doc false
@spec validate(Ecto.Changeset.t(), map()) :: Ecto.Changeset.t()
def validate(%Ecto.Changeset{} = changeset, attrs) do
changeset
end

@doc """
Returns an `t:Ecto.Changeset.t/0` for a given `t:t/0` value object.

> #### Overriding Changeset {: .warning}
>
> Be careful when overriding `changeset/2` because the default
> implementation takes care of `cast`, `validate_required` the
> `@enforced_keys` and nested embeds. You may want to call
> `OnePiece.Commanded.ValueObject.changeset/2` to have such features.
>
> If you only need to extend the changeset, you can use the
> `validate/2` function instead.
"""
@doc false
@spec changeset(message :: %__MODULE__{}, attrs :: map()) :: Ecto.Changeset.t()
def changeset(message, attrs) do
message
Expand Down
Loading