Tayori.Entries (Tayori v0.1.0)

Writes the news: what the admin does, for a script or a seed too.

{:ok, entry} =
  Tayori.Entries.create(%{
    "categories" => ["New"],
    "translations" => [
      %{"locale" => "en", "title" => "Exports", "body" => Kotoba.Content.from_markdown("...")}
    ]
  })

{:ok, entry} = Tayori.Entries.publish(entry)

Every change is told on the PubSub (see Tayori), and the entry is announced once, when it is published (Tayori.Notifier).

Summary

Functions

change(entry, attrs \\ %{})

A changeset of an entry, for a form.

counts()

The number of entries of each status, for the admin's tabs.

create(attrs, opts \\ [])

Creates an entry. Options: :author - who writes it, a map such as %{"id" => ..., "name" => ...}.

delete(entry)

Deletes an entry and its translations.

get(id)

An entry by its id, with its translations, or nil.

get!(id)

An entry by its id, with its translations. Raises if there is none.

list(opts \\ [])

All the entries, for the admin: drafts and scheduled first, then the published, the newest first, with their translations.

new()

A new entry, with an empty translation in the first language.

pin(entry)

Pins an entry: pinned entries come first, the last pinned first.

publish(entry, at \\ DateTime.utc_now())

Publishes an entry, now or at a time: a time in the future schedules it.

put_cover(entry, image, alt \\ nil)

Puts a cover on an entry, from a stored image: a Kotoba.Nodes.Attachment (as Kotoba.Attachments.store/2 or an upload of the admin makes it), with its alternative text. Only an image can be a cover.

put_cover_alt(entry, alt)

Changes the alternative text of an entry's cover.

remove_cover(entry)

Takes the cover off an entry. The image stays in the storage: delete it with the storage adapter (Kotoba.Storage) if nothing else uses it.

unpin(entry)

Unpins an entry.

unpublish(entry)

Makes an entry a draft again. It will be announced again when it is published.

update(entry, attrs)

Updates an entry: its fields, translations and publication time.

Functions

change(entry, attrs \\ %{})

@spec change(Tayori.Entry.t(), map()) :: Ecto.Changeset.t()

A changeset of an entry, for a form.

counts()

@spec counts() :: %{
  all: integer(),
  draft: integer(),
  scheduled: integer(),
  published: integer()
}

The number of entries of each status, for the admin's tabs.

create(attrs, opts \\ [])

@spec create(map(), keyword()) ::
  {:ok, Tayori.Entry.t()} | {:error, Ecto.Changeset.t()}

Creates an entry. Options: :author - who writes it, a map such as %{"id" => ..., "name" => ...}.

A slug made from the title that another entry has takes a number: exports-2. A slug given is the entry's, or an error.

delete(entry)

@spec delete(Tayori.Entry.t()) ::
  {:ok, Tayori.Entry.t()} | {:error, Ecto.Changeset.t()}

Deletes an entry and its translations.

get(id)

@spec get(Ecto.UUID.t()) :: Tayori.Entry.t() | nil

An entry by its id, with its translations, or nil.

get!(id)

@spec get!(Ecto.UUID.t()) :: Tayori.Entry.t()

An entry by its id, with its translations. Raises if there is none.

list(opts \\ [])

@spec list(keyword()) :: [Tayori.Entry.t()]

All the entries, for the admin: drafts and scheduled first, then the published, the newest first, with their translations.

Options: :search - words of a title or a slug; :status - :draft, :scheduled or :published.

new()

@spec new() :: Tayori.Entry.t()

A new entry, with an empty translation in the first language.

pin(entry)

@spec pin(Tayori.Entry.t()) :: {:ok, Tayori.Entry.t()} | {:error, Ecto.Changeset.t()}

Pins an entry: pinned entries come first, the last pinned first.

publish(entry, at \\ DateTime.utc_now())

@spec publish(Tayori.Entry.t(), DateTime.t()) ::
  {:ok, Tayori.Entry.t()} | {:error, Ecto.Changeset.t()}

Publishes an entry, now or at a time: a time in the future schedules it.

put_cover(entry, image, alt \\ nil)

@spec put_cover(Tayori.Entry.t(), Kotoba.Nodes.Attachment.t(), String.t() | nil) ::
  {:ok, Tayori.Entry.t()} | {:error, Ecto.Changeset.t() | :not_an_image}

Puts a cover on an entry, from a stored image: a Kotoba.Nodes.Attachment (as Kotoba.Attachments.store/2 or an upload of the admin makes it), with its alternative text. Only an image can be a cover.

put_cover_alt(entry, alt)

@spec put_cover_alt(Tayori.Entry.t(), String.t()) ::
  {:ok, Tayori.Entry.t()} | {:error, Ecto.Changeset.t()}

Changes the alternative text of an entry's cover.

remove_cover(entry)

@spec remove_cover(Tayori.Entry.t()) ::
  {:ok, Tayori.Entry.t()} | {:error, Ecto.Changeset.t()}

Takes the cover off an entry. The image stays in the storage: delete it with the storage adapter (Kotoba.Storage) if nothing else uses it.

unpin(entry)

@spec unpin(Tayori.Entry.t()) ::
  {:ok, Tayori.Entry.t()} | {:error, Ecto.Changeset.t()}

Unpins an entry.

unpublish(entry)

@spec unpublish(Tayori.Entry.t()) ::
  {:ok, Tayori.Entry.t()} | {:error, Ecto.Changeset.t()}

Makes an entry a draft again. It will be announced again when it is published.

update(entry, attrs)

@spec update(Tayori.Entry.t(), map()) ::
  {:ok, Tayori.Entry.t()} | {:error, Ecto.Changeset.t()}

Updates an entry: its fields, translations and publication time.