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.

Sign up for GitHub

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

added missing specs; minor edits to existing specs #4374

Merged
merged 2 commits into from
Feb 13, 2024
Merged

added missing specs; minor edits to existing specs #4374

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
792e389
added missing specs
bradhanks Feb 13, 2024
2700bf4
Update lib/ecto/changeset.ex
josevalim Feb 13, 2024
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
27 changes: 18 additions & 9 deletions lib/ecto/changeset.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ defmodule Ecto.Changeset do
prepare: [(t -> t)],
errors: [{atom, error}],
constraints: [constraint],
validations: [{atom, term}],
validations: [validation],
filters: %{optional(atom) => term},
action: action,
types: nil | %{atom => Ecto.Type.t() | {:assoc, term()} | {:embed, term()}}
Expand All @@ -387,7 +387,7 @@ defmodule Ecto.Changeset do
@type data :: map()
@type types :: map()
@type traverse_result :: %{atom => [term] | traverse_result}

@type validation :: {atom, term}
@typedoc """
A possible value that you can pass to the `:empty_values` option.

Expand Down Expand Up @@ -1193,9 +1193,11 @@ defmodule Ecto.Changeset do
`cast_assoc/3` for more information

"""
@spec cast_assoc(t, atom, Keyword.t()) :: t
def cast_assoc(changeset, name, opts \\ [])

def cast_assoc(%Changeset{data: %{} = data}, _name, _opts) when not is_map_key(data, :__meta__) do
def cast_assoc(%Changeset{data: %{} = data}, _name, _opts)
when not is_map_key(data, :__meta__) do
raise ArgumentError,
"cast_assoc/3 cannot be used to cast associations into embedded schemas or schemaless changesets. " <>
"Please modify the association independently."
Expand Down Expand Up @@ -1248,6 +1250,7 @@ defmodule Ecto.Changeset do
`cast_assoc/3` for more information

"""
@spec cast_embed(t, atom, Keyword.t()) :: t
def cast_embed(changeset, name, opts \\ []) when is_atom(name) do
cast_relation(:embed, changeset, name, opts)
end
Expand Down Expand Up @@ -1683,6 +1686,7 @@ defmodule Ecto.Changeset do
[%Post{id: 1, title: "world"}]

"""
@spec get_assoc(t, atom, :changeset | :struct) :: [t | Ecto.Schema.t()]
def get_assoc(changeset, name, as \\ :changeset)

def get_assoc(%Changeset{} = changeset, name, :struct) do
Expand Down Expand Up @@ -2101,10 +2105,13 @@ defmodule Ecto.Changeset do
* The [associations cheatsheet](associations.html)
* The [Constraints and Upserts guide](constraints-and-upserts.html)
* The [Polymorphic associations with many to many guide](polymorphic-associations-with-many-to-many.html)

"""
@spec put_assoc(t, atom, term, Keyword.t()) :: t
def put_assoc(changeset, name, value, opts \\ [])

def put_assoc(%Changeset{data: %{} = data}, _name, _value, _opts) when not is_map_key(data, :__meta__) do
def put_assoc(%Changeset{data: %{} = data}, _name, _value, _opts)
when not is_map_key(data, :__meta__) do
raise ArgumentError,
"put_assoc/4 cannot be used to put associations into embedded schemas or schemaless changesets. " <>
"Please modify the association independently."
Expand All @@ -2131,6 +2138,7 @@ defmodule Ecto.Changeset do
Although this function accepts an `opts` argument, there are no options
currently supported by `put_embed/4`.
"""
@spec put_embed(t, atom, term, Keyword.t()) :: t
def put_embed(%Changeset{} = changeset, name, value, opts \\ []) do
put_relation(:embed, changeset, name, value, opts)
end
Expand Down Expand Up @@ -2258,7 +2266,7 @@ defmodule Ecto.Changeset do
iex> {:error, changeset} = apply_action(changeset, :update)
%Ecto.Changeset{action: :update}
"""
@spec apply_action(t, atom) :: {:ok, Ecto.Schema.t() | data} | {:error, t}
@spec apply_action(t, action) :: {:ok, Ecto.Schema.t() | data} | {:error, t}
def apply_action(%Changeset{} = changeset, action) when is_atom(action) do
if changeset.valid? do
{:ok, apply_changes(changeset)}
Expand Down Expand Up @@ -2286,7 +2294,7 @@ defmodule Ecto.Changeset do

See `apply_action/2` for more information.
"""
@spec apply_action!(t, atom) :: Ecto.Schema.t() | data
@spec apply_action!(t, action) :: Ecto.Schema.t() | data
def apply_action!(%Changeset{} = changeset, action) do
case apply_action(changeset, action) do
{:ok, data} ->
Expand Down Expand Up @@ -2433,7 +2441,7 @@ defmodule Ecto.Changeset do
@spec validate_change(
t,
atom,
(atom, term -> [{atom, String.t()} | {atom, {String.t(), Keyword.t()}}])
(atom, term -> [{atom, String.t()} | {atom, error}])
) :: t
def validate_change(%Changeset{} = changeset, field, validator) when is_atom(field) do
%{changes: changes, types: types, errors: errors} = changeset
Expand Down Expand Up @@ -2479,7 +2487,7 @@ defmodule Ecto.Changeset do
t,
atom,
term,
(atom, term -> [{atom, String.t()} | {atom, {String.t(), Keyword.t()}}])
(atom, term -> [{atom, String.t()} | {atom, error}])
) :: t
def validate_change(
%Changeset{validations: validations} = changeset,
Expand Down Expand Up @@ -3568,6 +3576,7 @@ defmodule Ecto.Changeset do
`starts_with?` `:name` to this changeset constraint.

"""
@spec check_constraint(t, atom, Keyword.t()) :: t
def check_constraint(changeset, field, opts \\ []) do
name = opts[:name] || raise ArgumentError, "must supply the name of the constraint"
message = message(opts, "is invalid")
Expand Down Expand Up @@ -4145,7 +4154,7 @@ defmodule Ecto.Changeset do
"""
@spec traverse_validations(
t,
(error -> String.t()) | (Changeset.t(), atom, error -> String.t())
(validation -> String.t()) | (Changeset.t(), atom, validation -> String.t())
) :: traverse_result
def traverse_validations(
%Changeset{validations: validations, changes: changes, types: types} = changeset,
Expand Down
Loading