stry-common 0.1.3

//! Entities for the story 'module', everything tags unique to a story or
//! series is here.

use {
    crate::models::{
        core::{Comment, Part, User},
        Existing, Id,
    },
    either::Either,
};

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Story {
    /// The title of the story, this is not unique as stories are tracked
    /// with its `Id`.
    pub name: String,
    pub summary: String,

    pub rating: Rating,
    pub state: State,

    pub authors: Vec<Existing<User>>,
    pub commissioners: Vec<Existing<User>>,
    pub dedicatees: Vec<Existing<User>>,

    pub origins: Vec<Existing<Origin>>,
    pub warnings: Vec<Existing<Warning>>,
    pub pairings: Vec<Existing<Pairing>>,
    pub characters: Vec<Existing<Character>>,
    pub tags: Vec<Existing<Tag>>,

    /// # Variant
    ///
    /// Is `None` when this type is used indirectly (ie in another entity).
    pub series: Option<Existing<Series>>,

    /// # Variant
    ///
    /// Is `None` when this type is used indirectly (ie in another entity).
    pub chapters: Option<Either<Vec<Existing<Chapter>>, Vec<Id>>>,

    /// THe sum of all of the chapter's word counts.
    ///
    /// # Database Implementation
    ///
    /// Do not actually store the value in the database, let it be counted at run time.
    pub words: i32,

    pub comments: Vec<Existing<Comment>>,
}

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Chapter {
    /// The title of the chapter.
    ///
    /// # Variant
    ///
    /// To display use the default title (`Chapter {number}`) if is [`None`].
    pub name: Option<String>,

    /// Marks the chapter was published allowing non authors to view it.
    ///
    /// # Note
    ///
    /// Even when `true` a chapter can still be edited.
    pub published: bool,

    /// The parts the make up the beginning author's note.
    ///
    /// # Note
    ///
    /// This does not contribute to word count.
    pub prefix: Vec<Existing<Part>>,

    /// THe parts of the actual chapter itself.
    pub main: Vec<Existing<Part>>,

    /// The parts the make up the ending author's note.
    ///
    /// # Note
    ///
    /// This does not contribute to word count.
    pub suffix: Vec<Existing<Part>>,

    /// Comments on the chapter itself not its parts.
    pub comments: Vec<Existing<Comment>>,

    /// The sum of all the [`main`] parts word count.
    ///
    /// # Database Implementation
    ///
    /// Do not actually store the value in the database, let it be counted at run time.
    ///
    /// [`main`]: #structfield.main
    pub words: i64,
}

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Series {
    /// The title of the series, this is not unique as series are tracked
    /// with its `Id`.
    pub name: String,

    pub summary: String,

    pub state: State,

    /// # Variant
    ///
    /// Is `Left` when its used directly and is `Left` when its used indirectly (ie in another entity).
    pub stories: Either<Vec<Existing<Story>>, Vec<Id>>,
}

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Character {
    pub content: String,

    pub description: String,
}

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Origin {
    pub content: String,

    pub description: String,
}

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Pairing {
    pub hash: String,

    pub relationship: Relationship,

    pub characters: Vec<Existing<Character>>,
}

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub enum Relationship {
    Family,
    Friends,
    Romantic,
}

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Tag {
    pub content: String,

    pub description: String,
}

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub struct Warning {
    pub content: String,

    pub description: String,
}

#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub enum Rating {
    Explicit,
    Mature,
    Teen,
    General,
}

/// The story's state.
///
/// # Note
///
/// Stories will automatically become [`State::Abandoned`] if they are left
/// without modification for some time.
///
/// To get this time check the `story-auto-abandon` setting key.
#[rustfmt::skip]
#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[derive(serde::Deserialize, serde::Serialize)]
pub enum State {
    Completed,
    InProgress,
    Hiatus,
    Abandoned,
}