Packages

nldoc_spec

1.2.2
3.1.11 3.1.10 3.1.9 3.1.8 3.1.7 3.1.6 3.1.5 3.1.4 3.1.3 3.1.2 3.1.1 3.1.0 3.0.10 3.0.9 3.0.8 3.0.7 3.0.6 3.0.5 3.0.4 3.0.3 3.0.2 3.0.1 3.0.0 2.0.1 2.0.0 1.3.12 1.3.11 1.3.10 1.3.9 1.3.8 1.3.7 1.3.6 1.3.5 1.3.4 1.3.3 1.3.2 1.3.1 1.3.0 1.2.5 1.2.4 1.2.3 1.2.2 1.2.1 1.2.0 1.1.2 1.1.1 1.1.0 1.0.2 1.0.0

Elixir implementation of the NLdoc Spec for documents.

HexDocs

Current section

Files

Jump to
Readme
49 Versions
6 Dependencies
Dependants
Files
Activity
nldoc_spec lib nldoc spec document.ex
Raw

lib/nldoc/spec/document.ex 

defmodule NLdoc.Spec.Document do

  @moduledoc """

  This module defines the Ecto schema for the NLdoc spec Document object.

  """



  use NLdoc.Spec.Schema, type: "https://spec.nldoc.nl/Resource/Document"



  typed_embedded_schema null: false do

    field :id, Ecto.UUID

    field :type, :string, default: @resource_type

    field :cite, :string, null: true



    embeds_many :footnotes, NLdoc.Spec.Footnote

    embeds_many :assets, NLdoc.Spec.Asset



    field(:children, {:array, PolymorphicEmbed},

      types: map(NLdoc.Spec.document_children()),

      type_field_name: :type,

      on_replace: :delete,

      default: [],

      array?: true

    ) :: [NLdoc.Spec.document_child()]



    field(:descriptors, {:array, PolymorphicEmbed},

      types: map(NLdoc.Spec.descriptors()),

      type_field_name: :type,

      on_replace: :delete,

      default: [],

      array?: true

    ) :: [NLdoc.Spec.descriptor()]

  end



  def changeset(document, attrs) do

    document

    |> cast(attrs, [:id, :type, :cite], @cast_opts)

    |> cast_embed(:footnotes, @cast_opts)

    |> cast_embed(:assets, @cast_opts)

    |> cast_polymorphic_embed(:children, @cast_opts)

    |> cast_polymorphic_embed(:descriptors, @cast_opts)

    |> validate_required([:id, :type])

    |> validate_inclusion(:type, [@resource_type])

  end

end