Clean specs

This commit is contained in:
miffigriffy
2019-09-13 01:55:45 +02:00
parent 56efb0acb1
commit 5967b30bb1
21 changed files with 86 additions and 90 deletions

View File

@@ -48,13 +48,13 @@ defmodule Mobilizon.Events.Comment do
Returns the id of the first comment in the conversation.
"""
@spec get_thread_id(t) :: integer
def get_thread_id(%Comment{id: id, origin_comment_id: origin_comment_id}) do
def get_thread_id(%__MODULE__{id: id, origin_comment_id: origin_comment_id}) do
origin_comment_id || id
end
@doc false
@spec changeset(t, map) :: Ecto.Changeset.t()
def changeset(%Comment{} = comment, attrs) do
def changeset(%__MODULE__{} = comment, attrs) do
uuid = attrs["uuid"] || Ecto.UUID.generate()
url = attrs["url"] || generate_url(uuid)

View File

@@ -11,7 +11,6 @@ defmodule Mobilizon.Events.Event do
alias Mobilizon.Addresses.Address
alias Mobilizon.Events.{
Event,
EventOptions,
EventStatus,
EventVisibility,
@@ -115,7 +114,7 @@ defmodule Mobilizon.Events.Event do
@doc false
@spec changeset(t, map) :: Ecto.Changeset.t()
def changeset(%Event{} = event, attrs) do
def changeset(%__MODULE__{} = event, attrs) do
event
|> cast(attrs, @attrs)
|> cast_embed(:options)
@@ -124,7 +123,7 @@ defmodule Mobilizon.Events.Event do
@doc false
@spec update_changeset(t, map) :: Ecto.Changeset.t()
def update_changeset(%Event{} = event, attrs) do
def update_changeset(%__MODULE__{} = event, attrs) do
event
|> Ecto.Changeset.cast(attrs, @update_attrs)
|> cast_embed(:options)
@@ -136,7 +135,7 @@ defmodule Mobilizon.Events.Event do
Checks whether an event can be managed.
"""
@spec can_be_managed_by(t, integer | String.t()) :: boolean
def can_be_managed_by(%Event{organizer_actor_id: organizer_actor_id}, actor_id)
def can_be_managed_by(%__MODULE__{organizer_actor_id: organizer_actor_id}, actor_id)
when organizer_actor_id == actor_id do
{:event_can_be_managed, true}
end

View File

@@ -9,7 +9,6 @@ defmodule Mobilizon.Events.EventOptions do
alias Mobilizon.Events.{
EventOffer,
EventOptions,
EventParticipationCondition,
CommentModeration
}
@@ -52,7 +51,7 @@ defmodule Mobilizon.Events.EventOptions do
@doc false
@spec changeset(t, map) :: Ecto.Changeset.t()
def changeset(%EventOptions{} = event_options, attrs) do
def changeset(%__MODULE__{} = event_options, attrs) do
cast(event_options, attrs, @attrs)
end
end

View File

@@ -8,7 +8,6 @@ defmodule Mobilizon.Events.FeedToken do
import Ecto.Changeset
alias Mobilizon.Actors.Actor
alias Mobilizon.Events.FeedToken
alias Mobilizon.Users.User
@type t :: %__MODULE__{
@@ -33,7 +32,7 @@ defmodule Mobilizon.Events.FeedToken do
@doc false
@spec changeset(t, map) :: Ecto.Changeset.t()
def changeset(%FeedToken{} = feed_token, attrs) do
def changeset(%__MODULE__{} = feed_token, attrs) do
feed_token
|> cast(attrs, @attrs)
|> validate_required(@required_attrs)

View File

@@ -10,7 +10,7 @@ defmodule Mobilizon.Events.Participant do
alias Mobilizon.Actors.Actor
alias Mobilizon.Config
alias Mobilizon.Events
alias Mobilizon.Events.{Event, Participant, ParticipantRole}
alias Mobilizon.Events.{Event, ParticipantRole}
@type t :: %__MODULE__{
role: ParticipantRole.t(),
@@ -41,7 +41,7 @@ defmodule Mobilizon.Events.Participant do
@spec is_not_only_organizer(integer | String.t(), integer | String.t()) :: boolean
def is_not_only_organizer(event_id, actor_id) do
case Events.list_organizers_participants_for_event(event_id) do
[%Participant{actor: %Actor{id: participant_actor_id}}] ->
[%__MODULE__{actor: %Actor{id: participant_actor_id}}] ->
participant_actor_id == actor_id
_ ->
@@ -51,7 +51,7 @@ defmodule Mobilizon.Events.Participant do
@doc false
@spec changeset(t, map) :: Ecto.Changeset.t()
def changeset(%Participant{} = participant, attrs) do
def changeset(%__MODULE__{} = participant, attrs) do
participant
|> cast(attrs, @attrs)
|> ensure_url()
@@ -60,7 +60,7 @@ defmodule Mobilizon.Events.Participant do
# If there's a blank URL that's because we're doing the first insert
@spec ensure_url(Ecto.Changeset.t()) :: Ecto.Changeset.t()
defp ensure_url(%Ecto.Changeset{data: %Participant{url: nil}} = changeset) do
defp ensure_url(%Ecto.Changeset{data: %__MODULE__{url: nil}} = changeset) do
case fetch_change(changeset, :url) do
{:ok, _url} ->
changeset

View File

@@ -7,7 +7,7 @@ defmodule Mobilizon.Events.Session do
import Ecto.Changeset
alias Mobilizon.Events.{Event, Session, Track}
alias Mobilizon.Events.{Event, Track}
@type t :: %__MODULE__{
audios_urls: String.t(),
@@ -57,7 +57,7 @@ defmodule Mobilizon.Events.Session do
@doc false
@spec changeset(t, map) :: Ecto.Changeset.t()
def changeset(%Session{} = session, attrs) do
def changeset(%__MODULE__{} = session, attrs) do
session
|> cast(attrs, @attrs)
|> validate_required(@required_attrs)

View File

@@ -7,13 +7,13 @@ defmodule Mobilizon.Events.Tag do
import Ecto.Changeset
alias Mobilizon.Events.{Tag, TagRelation}
alias Mobilizon.Events.TagRelation
alias Mobilizon.Events.Tag.TitleSlug
@type t :: %__MODULE__{
title: String.t(),
slug: TitleSlug.Type.t(),
related_tags: [Tag.t()]
related_tags: [t]
}
@required_attrs [:title, :slug]
@@ -23,14 +23,14 @@ defmodule Mobilizon.Events.Tag do
field(:title, :string)
field(:slug, TitleSlug.Type)
many_to_many(:related_tags, Tag, join_through: TagRelation)
many_to_many(:related_tags, __MODULE__, join_through: TagRelation)
timestamps()
end
@doc false
@spec changeset(t, map) :: Ecto.Changeset.t()
def changeset(%Tag{} = tag, attrs) do
def changeset(%__MODULE__{} = tag, attrs) do
tag
|> cast(attrs, @attrs)
|> TitleSlug.maybe_generate_slug()

View File

@@ -7,7 +7,7 @@ defmodule Mobilizon.Events.TagRelation do
import Ecto.Changeset
alias Mobilizon.Events.{Tag, TagRelation}
alias Mobilizon.Events.Tag
@type t :: %__MODULE__{
weight: integer,
@@ -29,7 +29,7 @@ defmodule Mobilizon.Events.TagRelation do
@doc false
@spec changeset(t, map) :: Ecto.Changeset.t()
def changeset(%TagRelation{} = tag, attrs) do
def changeset(%__MODULE__{} = tag, attrs) do
# Return if tag_id or link_id are not set because it will fail later otherwise
with %Ecto.Changeset{errors: [], changes: changes} = changeset <-
tag

View File

@@ -7,7 +7,7 @@ defmodule Mobilizon.Events.Track do
import Ecto.Changeset
alias Mobilizon.Events.{Track, Event, Session}
alias Mobilizon.Events.{Event, Session}
@type t :: %__MODULE__{
color: String.t(),
@@ -34,7 +34,7 @@ defmodule Mobilizon.Events.Track do
@doc false
@spec changeset(t, map) :: Ecto.Changeset.t()
def changeset(%Track{} = track, attrs) do
def changeset(%__MODULE__{} = track, attrs) do
track
|> cast(attrs, @attrs)
|> validate_required(@required_attrs)