14 Commits

73 changed files with 8110 additions and 1114 deletions
Generated
+2336 -471
View File
File diff suppressed because it is too large Load Diff
+22 -4
View File
@@ -12,6 +12,7 @@ rust-version = "1.85.0"
arithmetic_overflow = "forbid" arithmetic_overflow = "forbid"
missing_docs = "forbid" missing_docs = "forbid"
unsafe_code = "forbid" unsafe_code = "forbid"
unused_doc_comments = "forbid"
[workspace.lints.clippy] [workspace.lints.clippy]
arithmetic_side_effects = "forbid" arithmetic_side_effects = "forbid"
@@ -34,17 +35,34 @@ overflow-checks = true
strip = "debuginfo" strip = "debuginfo"
[workspace.dependencies] [workspace.dependencies]
flix = { path = "crates/flix", version = "=0.0.2", default-features = false } flix = { path = "crates/flix", version = "=0.0.14", default-features = false }
flix-tmdb = { path = "crates/tmdb", version = "=0.0.2", default-features = false } flix-cli = { path = "crates/cli", version = "=0.0.14", default-features = false }
flix-db = { path = "crates/db", version = "=0.0.14", default-features = false }
flix-fs = { path = "crates/fs", version = "=0.0.14", default-features = false }
flix-model = { path = "crates/model", version = "=0.0.14", default-features = false }
flix-tmdb = { path = "crates/tmdb", version = "=0.0.14", default-features = false }
seamantic = { version = "0.0.10", default-features = false }
sea-orm = { version = "2.0.0-rc.17", default-features = false }
sea-orm-migration = { version = "2.0.0-rc.17", default-features = false }
anyhow = { version = "^1", default-features = false } anyhow = { version = "^1", default-features = false }
async-stream = { version = "^0.3", default-features = false }
chrono = { version = "^0.4", default-features = false } chrono = { version = "^0.4", default-features = false }
clap = { version = "^4", default-features = false, features = ["std"] } clap = { version = "^4", default-features = false, features = ["std"] }
home = { version = "^0.5", default-features = false } futures = { version = "^0.3", default-features = false }
governor = { version = "^0.10", default-features = false }
nonzero_ext = { version = "^0.3", default-features = false }
regex = { version = "^1", default-features = false }
reqwest = { version = "^0.12", default-features = false } reqwest = { version = "^0.12", default-features = false }
serde = { version = "^1", default-features = false } serde = { version = "^1", default-features = false }
serde_test = { version = "^1", default-features = false }
thiserror = { version = "^2", default-features = false } thiserror = { version = "^2", default-features = false }
tokio = { version = "^1", default-features = false } tokio = { version = "^1", default-features = false }
toml = { version = "^0.8", default-features = false } tokio-stream = { version = "^0.1", default-features = false }
toml = { version = "^0.9", default-features = false }
tracing = { version = "^0.1", default-features = false }
tracing-subscriber = { version = "^0.3", default-features = false }
url = { version = "^2", default-features = false } url = { version = "^2", default-features = false }
url-macro = { version = "^0.2", default-features = false } url-macro = { version = "^0.2", default-features = false }
+4 -3
View File
@@ -6,9 +6,10 @@ Libraries and tools for dealing with media metadata
- build: `cargo hack --feature-powerset build` - build: `cargo hack --feature-powerset build`
- clippy: `cargo hack --feature-powerset clippy -- -D warnings` - clippy: `cargo hack --feature-powerset clippy -- -D warnings`
- test: `cargo hack --feature-powerset test`
- test old: `cargo +1.85 hack --feature-powerset test`
- fmt: `cargo fmt --check` - fmt: `cargo fmt --check`
- docs: `RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features` - docs: `RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features`
- install: `cargo install --path crates/cli` - install: `cargo install --path crates/cli`
- publish: `cargo publish --dry-run -p flix-tmdb` - semver: `cargo semver-checks --all-features`
- publish: `cargo publish --dry-run -p flix` - publish: `cargo publish --dry-run --workspace`
- publish: `cargo publish --dry-run -p flix-cli`
+12 -5
View File
@@ -1,9 +1,9 @@
[package] [package]
name = "flix-cli" name = "flix-cli"
version = "0.0.2" version = "0.0.14"
categories = ["command-line-utilities"] categories = ["command-line-utilities"]
description = "CLI for interacting with flix media" description = "CLI for interacting with a flix database"
repository = "https://github.com/QuantumShade/flix" repository = "https://github.com/QuantumShade/flix"
authors.workspace = true authors.workspace = true
@@ -11,6 +11,10 @@ edition.workspace = true
license-file.workspace = true license-file.workspace = true
rust-version.workspace = true rust-version.workspace = true
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[[bin]] [[bin]]
doc = false doc = false
name = "flix" name = "flix"
@@ -35,9 +39,9 @@ unwrap_used = "deny"
[dependencies] [dependencies]
flix = { workspace = true, features = ["tmdb"] } flix = { workspace = true, features = ["tmdb"] }
flix-tmdb = { workspace = true }
anyhow = { workspace = true } anyhow = { workspace = true }
chrono = { workspace = true, features = ["now"] }
clap = { workspace = true, features = [ clap = { workspace = true, features = [
"derive", "derive",
"color", "color",
@@ -46,7 +50,10 @@ clap = { workspace = true, features = [
"suggestions", "suggestions",
"usage", "usage",
] } ] }
home = { workspace = true } futures = { workspace = true }
sea-orm = { workspace = true, features = ["runtime-tokio", "debug-print"] }
serde = { workspace = true, features = ["derive"] } serde = { workspace = true, features = ["derive"] }
tokio = { workspace = true, features = ["rt", "fs", "macros"] } tokio = { workspace = true, features = ["rt", "fs", "macros"] }
toml = { workspace = true, features = ["display", "parse"] } toml = { workspace = true, features = ["parse", "serde"] }
tracing = { workspace = true }
tracing-subscriber = { workspace = true }
+7 -1
View File
@@ -2,4 +2,10 @@
[![Crates Version](https://img.shields.io/crates/v/flix-cli.svg)](https://crates.io/crates/flix-cli) [![Crates Version](https://img.shields.io/crates/v/flix-cli.svg)](https://crates.io/crates/flix-cli)
CLI for interacting with flix media CLI for interacting with a flix database
## Commands
```sh
cargo run -- init
cargo run -- add tmdb movie <id>
```
+57 -26
View File
@@ -1,5 +1,6 @@
use std::path::PathBuf; use std::path::PathBuf;
use anyhow::{Result, anyhow};
use clap::{Parser, Subcommand}; use clap::{Parser, Subcommand};
pub mod tmdb; pub mod tmdb;
@@ -7,9 +8,17 @@ pub mod tmdb;
#[derive(Parser)] #[derive(Parser)]
#[command(version, about, long_about = None)] #[command(version, about, long_about = None)]
pub struct Cli { pub struct Cli {
/// Use a custom config file [default: ~/.flix] /// Use a custom config file
#[arg(short, long, value_name = "FILE")] #[arg(short, long, value_name = "FILE", default_value = "~/.flix")]
config: Option<PathBuf>, config: PathBuf,
/// Use a custom database file
#[arg(short, long, value_name = "DATABASE", default_value = "./flix.db")]
database: PathBuf,
/// Enable tracing
#[arg(short, long)]
pub trace: bool,
#[command(subcommand)] #[command(subcommand)]
command: Command, command: Command,
@@ -17,40 +26,61 @@ pub struct Cli {
impl Cli { impl Cli {
pub fn config_path(&self) -> PathBuf { pub fn config_path(&self) -> PathBuf {
match self.config.as_ref() { fn expect_home_dir() -> PathBuf {
Some(path) => match path.strip_prefix("~/") { #[allow(clippy::expect_used)]
Ok(path) => expect_home_dir().join(path), std::env::home_dir().expect("you do not have a home directory")
Err(_) => path.to_owned(), }
},
None => expect_home_dir().join(".flix"), match self.config.strip_prefix("~/") {
Ok(path) => expect_home_dir().join(path),
Err(_) => self.config.to_owned(),
} }
} }
pub fn command(&self) -> &Command { pub fn database_path(&self) -> Result<String> {
&self.command self.database
.as_os_str()
.to_str()
.map(ToOwned::to_owned)
.ok_or_else(|| anyhow!(".as_os_str().to_str()"))
}
pub fn command(self) -> Command {
self.command
} }
} }
#[derive(Subcommand)] #[derive(Subcommand)]
pub enum Command { pub enum Command {
/// Print a flix manifest /// Initialize a new database
Print { Init,
/// Add new items to the database
Add {
#[command(subcommand)] #[command(subcommand)]
command: BackendCommand, command: BackendCommand,
}, },
/// Write a flix manifest if the destination does not exist /// Update an existing item in the database
Write { Update {
/// Overwrite the destination
#[arg(short, long, default_value_t = false)]
force: bool,
/// Change the destination
#[arg(short, long, value_name = "FILE")]
output: Option<PathBuf>,
#[command(subcommand)] #[command(subcommand)]
command: BackendCommand, command: BackendCommand,
}, },
/// Delete an existing item in the database
Delete {
#[command(subcommand)]
command: BackendCommand,
},
/// Create a toml backup of the database
Backup {
/// Change the destination
#[arg(short, long, value_name = "FILE", default_value = "./flix.toml")]
output: PathBuf,
},
/// Create a database from a toml backup
Restore {
/// Change the source
#[arg(short, long, value_name = "FILE", default_value = "./flix.toml")]
input: PathBuf,
},
} }
#[derive(Subcommand)] #[derive(Subcommand)]
@@ -62,7 +92,8 @@ pub enum BackendCommand {
}, },
} }
fn expect_home_dir() -> PathBuf { impl From<tmdb::Command> for BackendCommand {
#[allow(clippy::expect_used)] fn from(value: tmdb::Command) -> Self {
home::home_dir().expect("you do not have a home directory") Self::Tmdb { command: value }
}
} }
+14 -8
View File
@@ -1,3 +1,6 @@
use flix::model::numbers::{EpisodeNumber, SeasonNumber};
use flix::tmdb::model::id::RawId;
use clap::Subcommand; use clap::Subcommand;
#[derive(Subcommand)] #[derive(Subcommand)]
@@ -5,32 +8,35 @@ pub enum Command {
/// Process a TMDB collection /// Process a TMDB collection
Collection { Collection {
#[arg(value_name = "TMDB_ID")] #[arg(value_name = "TMDB_ID")]
id: i32, id: RawId,
}, },
/// Process a TMDB movie /// Process a TMDB movie
Movie { Movie {
#[arg(value_name = "TMDB_ID")] #[arg(value_name = "TMDB_ID")]
id: i32, id: RawId,
}, },
/// Process a TMDB show /// Process a TMDB show
Show { Show {
#[arg(value_name = "TMDB_ID")] #[arg(value_name = "TMDB_ID")]
id: i32, id: RawId,
}, },
/// Process a TMDB season /// Process a TMDB season
Season { Season {
#[arg(value_name = "TMDB_ID")] #[arg(value_name = "TMDB_ID")]
id: i32, id: RawId,
#[arg(value_name = "SEASON_NUM")] #[arg(value_name = "SEASON_NUM")]
season: i32, season: SeasonNumber,
}, },
/// Process a TMDB episode /// Process a TMDB episode
#[command(trailing_var_arg = true)]
Episode { Episode {
#[arg(value_name = "TMDB_ID")] #[arg(value_name = "TMDB_ID")]
id: i32, id: RawId,
#[arg(value_name = "SEASON_NUM")] #[arg(value_name = "SEASON_NUM")]
season: i32, season: SeasonNumber,
#[arg(value_name = "EPISODE_NUM")] #[arg(value_name = "EPISODE_NUM")]
episode: i32, episode: EpisodeNumber,
#[arg(value_name = "...")]
episodes: Vec<EpisodeNumber>,
}, },
} }
+27
View File
@@ -0,0 +1,27 @@
use flix::db::connection::Connection;
use anyhow::{Context, Result, bail};
use sea_orm::{ConnectOptions, Database};
use tokio::fs;
async fn connect(string: String) -> Result<Connection> {
Connection::try_from(
Database::connect(ConnectOptions::new(string))
.await
.context("Database::connect")?,
)
.await
.context("Connection::try_from")
}
pub async fn open(database_path: String) -> Result<Connection> {
connect(format!("sqlite:{database_path}?mode=rw")).await
}
pub async fn open_new(database_path: String) -> Result<Connection> {
if fs::try_exists(&database_path).await? {
bail!("database already exists");
}
connect(format!("sqlite:{database_path}?mode=rwc")).await
}
+3
View File
@@ -0,0 +1,3 @@
//! Placeholder
#![cfg_attr(docsrs, feature(doc_cfg))]
+73 -36
View File
@@ -1,4 +1,6 @@
use flix_tmdb::Client; use std::path::PathBuf;
use flix::tmdb::Client;
use anyhow::{Context, Result}; use anyhow::{Context, Result};
use clap::Parser; use clap::Parser;
@@ -9,8 +11,8 @@ use cli::{BackendCommand, Cli, Command};
mod config; mod config;
use config::Config; use config::Config;
use tokio::io::AsyncWriteExt;
mod db;
mod run; mod run;
#[tokio::main(flavor = "current_thread")] #[tokio::main(flavor = "current_thread")]
@@ -22,44 +24,79 @@ async fn main() -> Result<()> {
let config: Config = toml::from_str(config.as_str()) let config: Config = toml::from_str(config.as_str())
.with_context(|| format!("could not parse config: {:?}", cli.config_path()))?; .with_context(|| format!("could not parse config: {:?}", cli.config_path()))?;
let database_path = cli.database_path()?;
let client = Client::new(config.tmdb().bearer_token().to_owned()); let client = Client::new(config.tmdb().bearer_token().to_owned());
match cli.command() { if cli.trace {
Command::Print { command } => match command { tracing_subscriber::fmt()
BackendCommand::Tmdb { command } => { .with_max_level(tracing::Level::DEBUG)
let object = run::tmdb::TmdbObject::fetch(&client, command).await?; .with_test_writer()
println!("{}", object.serialize().context("failed to serialize")?) .init();
} }
},
Command::Write {
force,
output,
command,
} => match command {
BackendCommand::Tmdb { command } => {
let object = run::tmdb::TmdbObject::fetch(&client, command).await?;
let output = output
.as_ref()
.map(|p| p.as_path())
.unwrap_or(object.default_filename());
let mut file = if *force { match cli.command() {
fs::File::create(output).await Command::Init => exec_init(database_path).await?,
} else { Command::Add { command } => exec_add(client, database_path, command).await?,
fs::File::create_new(output).await Command::Update { command } => exec_update(client, database_path, command).await?,
} Command::Delete { command } => exec_delete(client, database_path, command).await?,
.with_context(|| format!("could not create file at path {}", output.display()))?; Command::Backup { output } => exec_backup(database_path, output).await?,
file.write_all( Command::Restore { input } => exec_restore(database_path, input).await?,
object
.serialize()
.context("failed to serialize tmdb object")?
.as_bytes(),
)
.await
.with_context(|| format!("could not write to file at path {}", output.display()))?;
}
},
} }
Ok(()) Ok(())
} }
async fn exec_init(database_path: String) -> Result<()> {
db::open_new(database_path).await?;
Ok(())
}
async fn exec_add(client: Client, database_path: String, command: BackendCommand) -> Result<()> {
let database = db::open(database_path).await?;
match command {
BackendCommand::Tmdb { command } => {
run::tmdb::add(client, database.as_ref(), command).await?;
}
}
Ok(())
}
async fn exec_update(client: Client, database_path: String, command: BackendCommand) -> Result<()> {
let database = db::open(database_path).await?;
match command {
BackendCommand::Tmdb { command } => {
run::tmdb::update(client, database.as_ref(), command).await?;
}
}
Ok(())
}
async fn exec_delete(client: Client, database_path: String, command: BackendCommand) -> Result<()> {
let database = db::open(database_path).await?;
match command {
BackendCommand::Tmdb { command } => {
run::tmdb::delete(client, database.as_ref(), command).await?;
}
}
Ok(())
}
async fn exec_backup(database_path: String, output: PathBuf) -> Result<()> {
_ = database_path;
_ = output;
unimplemented!()
}
async fn exec_restore(database_path: String, input: PathBuf) -> Result<()> {
_ = database_path;
_ = input;
unimplemented!()
}
+490 -114
View File
@@ -1,131 +1,507 @@
use std::path::Path; use std::collections::HashMap;
use flix::model::{ use flix::db::entity;
Collection, Episode, GenericCollection, GenericEpisode, GenericMovie, GenericSeason, use flix::model::id::{CollectionId, MovieId, ShowId};
GenericShow, Movie, Season, Show, TmdbCollection, TmdbMovie, TmdbShow, use flix::model::numbers::{EpisodeNumber, SeasonNumber};
}; use flix::tmdb::Client;
use flix_tmdb::Client; use flix::tmdb::model::id::{
use flix_tmdb::model::{ CollectionId as TmdbCollectionId, MovieId as TmdbMovieId, ShowId as TmdbShowId,
Collection as TCollection, Episode as TEpisode, Movie as TMovie, Season as TSeason,
Show as TShow,
}; };
use anyhow::{Context, Result}; use anyhow::{Context, Result, bail};
use chrono::Utc;
use sea_orm::ActiveValue::{NotSet, Set};
use sea_orm::{
ActiveModelTrait, DatabaseConnection, DbErr, EntityTrait, TransactionError, TransactionTrait,
};
use crate::cli::tmdb::Command; use crate::cli::tmdb::Command;
pub enum TmdbObject { pub async fn add(client: Client, db: &DatabaseConnection, command: Command) -> Result<()> {
Collection(TCollection), match command {
Movie(TMovie), Command::Collection { id } => {
Show(TShow), let id = TmdbCollectionId::from_raw(id);
Season(TSeason),
Episode(TEpisode),
}
impl TmdbObject { let collection = entity::tmdb::collections::Entity::find_by_id(id)
pub fn default_filename(&self) -> &'static Path { .one(db)
Path::new(match self { .await?;
TmdbObject::Collection(_) => "collection.toml", if collection.is_some() {
TmdbObject::Movie(_) => "movie.toml", bail!("collection already exists");
TmdbObject::Show(_) => "show.toml", }
TmdbObject::Season(_) => "season.toml",
TmdbObject::Episode(_) => "episode.toml",
})
}
pub fn serialize(self) -> Result<String> { let collection = client
Ok(match self { .collections()
TmdbObject::Collection(tmdb) => toml::to_string(&Collection { .get_details(id, None)
collection: GenericCollection { .await
name: tmdb.name, .with_context(|| format!("collections().get_details({})", id.into_raw()))?;
overview: tmdb.overview,
},
tmdb: Some(TmdbCollection { id: tmdb.id }),
})?,
TmdbObject::Movie(tmdb) => toml::to_string(&Movie {
movie: GenericMovie {
title: tmdb.title,
overview: tmdb.overview,
release_date: tmdb.release_date,
},
tmdb: Some(TmdbMovie {
id: tmdb.id,
genres: tmdb.genres.iter().map(|g| g.id).collect(),
}),
})?,
TmdbObject::Show(tmdb) => toml::to_string(&Show {
show: GenericShow {
name: tmdb.name,
overview: tmdb.overview,
air_date: tmdb.first_air_date,
},
tmdb: Some(TmdbShow {
id: tmdb.id,
genres: tmdb.genres.iter().map(|g| g.id).collect(),
}),
})?,
TmdbObject::Season(tmdb) => toml::to_string(&Season {
season: GenericSeason {
name: tmdb.name,
overview: tmdb.overview,
air_date: tmdb.air_date,
},
})?,
TmdbObject::Episode(tmdb) => toml::to_string(&Episode {
episode: GenericEpisode {
name: tmdb.name,
overview: tmdb.overview,
air_date: tmdb.air_date,
},
})?,
})
}
}
impl TmdbObject { let result: Result<CollectionId, TransactionError<DbErr>> = db
pub async fn fetch(client: &Client, command: &Command) -> Result<Self> { .transaction(|txn| {
Ok(match *command { Box::pin(async move {
Command::Collection { id } => Self::Collection( let flix = entity::info::collections::ActiveModel {
client id: NotSet,
.collections() title: Set(collection.title),
.get_details(id, None) overview: Set(collection.overview),
.await }
.with_context(|| format!("could not get collection details for '{id}'"))?, .insert(txn)
), .await?;
Command::Movie { id } => Self::Movie(
client entity::tmdb::collections::ActiveModel {
.movies() tmdb_id: Set(id),
.get_details(id, None) flix_id: Set(flix.id),
.await last_update: Set(Utc::now().naive_utc().date()),
.with_context(|| format!("could not get movie details for '{id}'"))?, movie_count: Set(collection.movies.len().try_into().unwrap_or(0)),
), }
Command::Show { id } => Self::Show( .insert(txn)
client .await?;
.shows()
.get_details(id, None) Ok(flix.id)
.await })
.with_context(|| format!("could not get show details for '{id}'"))?, })
), .await;
Command::Season { id, season } => Self::Season(
client let flix_id = match result {
Ok(id) => id,
Err(TransactionError::Connection(err)) => Err(err)?,
Err(TransactionError::Transaction(err)) => Err(err)?,
};
println!("Created Collection: {}", flix_id.into_raw());
Ok(())
}
Command::Movie { id } => {
let id = TmdbMovieId::from_raw(id);
let movie = entity::tmdb::movies::Entity::find_by_id(id).one(db).await?;
if movie.is_some() {
bail!("movie already exists");
}
let movie = client
.movies()
.get_details(id, None)
.await
.with_context(|| format!("movies().get_details({})", id.into_raw()))?;
let result: Result<MovieId, TransactionError<DbErr>> = db
.transaction(|txn| {
Box::pin(async move {
let flix = entity::info::movies::ActiveModel {
id: NotSet,
title: Set(movie.title),
tagline: Set(movie.tagline),
overview: Set(movie.overview),
date: Set(movie.release_date),
}
.insert(txn)
.await?;
entity::tmdb::movies::ActiveModel {
tmdb_id: Set(id),
flix_id: Set(flix.id),
last_update: Set(Utc::now().naive_utc().date()),
runtime: Set(movie.runtime.into()),
collection_id: Set(movie.collection.map(|c| c.id)),
}
.insert(txn)
.await?;
Ok(flix.id)
})
})
.await;
let flix_id = match result {
Ok(id) => id,
Err(TransactionError::Connection(err)) => Err(err)?,
Err(TransactionError::Transaction(err)) => Err(err)?,
};
println!("Created Movie: {}", flix_id.into_raw());
Ok(())
}
Command::Show { id } => {
let id = TmdbShowId::from_raw(id);
let show = entity::tmdb::shows::Entity::find_by_id(id).one(db).await?;
if show.is_some() {
bail!("show already exists");
}
let show = client
.shows()
.get_details(id, None)
.await
.with_context(|| format!("shows().get_details({})", id.into_raw()))?;
let mut seasons = Vec::new();
let mut episodes = HashMap::new();
for season in 1..=show.number_of_seasons {
let season = client
.seasons() .seasons()
.get_details(id, season, None) .get_details(id, season, None)
.await .await
.with_context(|| format!("could not get show details for '{id}' S{season}"))?, .with_context(|| {
), format!("seasons().get_details({}, {})", id.into_raw(), season)
Command::Episode { })?;
id, if season.air_date > Utc::now().naive_utc().date() {
season, eprintln!(
episode, "skipping season ({}, {})",
} => Self::Episode( id.into_raw(),
client season.season_number
);
break;
}
let Ok(number_of_episodes) = EpisodeNumber::try_from(season.episodes.len()) else {
bail!(
"could not convert {} to an EpisodeNumber",
season.episodes.len()
)
};
let mut season_episodes = Vec::new();
for episode in 1..=number_of_episodes {
let Ok(episode) = client
.episodes()
.get_details(id, season.season_number, episode, None)
.await
else {
eprintln!(
"skipping episode ({}, {}, {})",
id.into_raw(),
season.season_number,
episode
);
break;
};
season_episodes.push(episode);
}
episodes.insert(season.season_number, season_episodes);
seasons.push(season);
}
let result: Result<ShowId, TransactionError<DbErr>> = db
.transaction(|txn| {
Box::pin(async move {
let flix = entity::info::shows::ActiveModel {
id: NotSet,
title: Set(show.title),
tagline: Set(show.tagline),
overview: Set(show.overview),
date: Set(show.first_air_date),
}
.insert(txn)
.await?;
entity::tmdb::shows::ActiveModel {
tmdb_id: Set(id),
flix_id: Set(flix.id),
last_update: Set(Utc::now().naive_utc().date()),
number_of_seasons: Set(show.number_of_seasons),
}
.insert(txn)
.await?;
for season in seasons {
entity::info::seasons::ActiveModel {
show_id: Set(flix.id),
season_number: Set(season.season_number),
title: Set(season.title),
overview: Set(season.overview),
date: Set(season.air_date),
}
.insert(txn)
.await?;
entity::tmdb::seasons::ActiveModel {
tmdb_show: Set(id),
tmdb_season: Set(season.season_number),
flix_show: Set(flix.id),
flix_season: Set(season.season_number),
last_update: Set(Utc::now().naive_utc().date()),
}
.insert(txn)
.await?;
}
for (season, episodes) in episodes {
for episode in episodes {
entity::info::episodes::ActiveModel {
show_id: Set(flix.id),
season_number: Set(season),
episode_number: Set(episode.episode_number),
title: Set(episode.title),
overview: Set(episode.overview),
date: Set(episode.air_date),
}
.insert(txn)
.await?;
entity::tmdb::episodes::ActiveModel {
tmdb_show: Set(id),
tmdb_season: Set(season),
tmdb_episode: Set(episode.episode_number),
flix_show: Set(flix.id),
flix_season: Set(season),
flix_episode: Set(episode.episode_number),
last_update: Set(Utc::now().naive_utc().date()),
runtime: Set(episode.runtime.into()),
}
.insert(txn)
.await?;
}
}
Ok(flix.id)
})
})
.await;
let flix_id = match result {
Ok(id) => id,
Err(TransactionError::Connection(err)) => Err(err)?,
Err(TransactionError::Transaction(err)) => Err(err)?,
};
println!("Created Show: {}", flix_id.into_raw());
Ok(())
}
Command::Season { id, season } => {
let id = TmdbShowId::from_raw(id);
let season_number = season;
let Some(show) = entity::tmdb::shows::Entity::find_by_id(id).one(db).await? else {
bail!("show does not exists");
};
let season = entity::tmdb::seasons::Entity::find_by_id((id, season))
.one(db)
.await?;
if season.is_some() {
bail!("season already exists");
}
let season = client
.seasons()
.get_details(id, season_number, None)
.await
.with_context(|| {
format!(
"seasons().get_details({}, {})",
id.into_raw(),
season_number
)
})?;
let mut episodes = Vec::new();
let Ok(number_of_episodes) = EpisodeNumber::try_from(season.episodes.len()) else {
bail!(
"could not convert {} to an EpisodeNumber",
season.episodes.len()
)
};
for episode in 1..=number_of_episodes {
let Ok(episode) = client
.episodes() .episodes()
.get_details(id, season, episode, None) .get_details(id, season.season_number, episode, None)
.await
else {
eprintln!(
"skipping episode ({}, {}, {})",
id.into_raw(),
season.season_number,
episode
);
break;
};
episodes.push(episode);
}
let result: Result<(), TransactionError<DbErr>> = db
.transaction(|txn| {
Box::pin(async move {
entity::info::seasons::ActiveModel {
show_id: Set(show.flix_id),
season_number: Set(season_number),
title: Set(season.title),
overview: Set(season.overview),
date: Set(season.air_date),
}
.insert(txn)
.await?;
entity::tmdb::seasons::ActiveModel {
tmdb_show: Set(show.tmdb_id),
tmdb_season: Set(season_number),
flix_show: Set(show.flix_id),
flix_season: Set(season_number),
last_update: Set(Utc::now().naive_utc().date()),
}
.insert(txn)
.await?;
for episode in episodes {
entity::info::episodes::ActiveModel {
show_id: Set(show.flix_id),
season_number: Set(season_number),
episode_number: Set(episode.episode_number),
title: Set(episode.title),
overview: Set(episode.overview),
date: Set(episode.air_date),
}
.insert(txn)
.await?;
entity::tmdb::episodes::ActiveModel {
tmdb_show: Set(show.tmdb_id),
tmdb_season: Set(season_number),
tmdb_episode: Set(episode.episode_number),
flix_show: Set(show.flix_id),
flix_season: Set(season_number),
flix_episode: Set(episode.episode_number),
last_update: Set(Utc::now().naive_utc().date()),
runtime: Set(episode.runtime.into()),
}
.insert(txn)
.await?;
}
Ok(())
})
})
.await;
match result {
Ok(_) => (),
Err(TransactionError::Connection(err)) => Err(err)?,
Err(TransactionError::Transaction(err)) => Err(err)?,
};
println!(
"Created Season: {} S{}",
show.flix_id.into_raw(),
season_number
);
Ok(())
}
Command::Episode {
id,
season,
episode,
episodes,
} => {
let id = TmdbShowId::from_raw(id);
let season_number = season;
let Some(show) = entity::tmdb::shows::Entity::find_by_id(id).one(db).await? else {
bail!("show does not exists");
};
let Some(_) = entity::tmdb::seasons::Entity::find_by_id((id, season))
.one(db)
.await?
else {
bail!("season does not exists");
};
async fn fetch_episode(
client: &Client,
db: &DatabaseConnection,
flix_id: ShowId,
tmdb_id: TmdbShowId,
id: TmdbShowId,
season: SeasonNumber,
episode: EpisodeNumber,
) -> Result<()> {
let episode_number = episode;
let episode = entity::tmdb::episodes::Entity::find_by_id((id, season, episode))
.one(db)
.await?;
if episode.is_some() {
bail!("episode already exists");
}
let episode = client
.episodes()
.get_details(id, season, episode_number, None)
.await .await
.with_context(|| { .with_context(|| {
format!("could not get show details for '{id}' S{season}E{episode}") format!("episodes().get_details({}, {})", id.into_raw(), season)
})?, })?;
),
}) let result: Result<(), TransactionError<DbErr>> = db
.transaction(|txn| {
Box::pin(async move {
entity::info::episodes::ActiveModel {
show_id: Set(flix_id),
season_number: Set(season),
episode_number: Set(episode_number),
title: Set(episode.title),
overview: Set(episode.overview),
date: Set(episode.air_date),
}
.insert(txn)
.await?;
entity::tmdb::episodes::ActiveModel {
tmdb_show: Set(tmdb_id),
tmdb_season: Set(season),
tmdb_episode: Set(episode_number),
flix_show: Set(flix_id),
flix_season: Set(season),
flix_episode: Set(episode_number),
last_update: Set(Utc::now().naive_utc().date()),
runtime: Set(episode.runtime.into()),
}
.insert(txn)
.await?;
Ok(())
})
})
.await;
match result {
Ok(_) => (),
Err(TransactionError::Connection(err)) => Err(err)?,
Err(TransactionError::Transaction(err)) => Err(err)?,
};
println!(
"Created Episode: {} S{}E{}",
flix_id.into_raw(),
season,
episode_number
);
Ok(())
}
let flix_id = show.flix_id;
let tmdb_id = show.tmdb_id;
fetch_episode(&client, db, flix_id, tmdb_id, id, season_number, episode).await?;
for episode in episodes {
fetch_episode(&client, db, flix_id, tmdb_id, id, season_number, episode).await?;
}
Ok(())
}
} }
} }
pub async fn update(client: Client, database: &DatabaseConnection, command: Command) -> Result<()> {
_ = client;
_ = database;
_ = command;
unimplemented!("updates")
}
pub async fn delete(client: Client, database: &DatabaseConnection, command: Command) -> Result<()> {
_ = client;
_ = database;
_ = command;
unimplemented!("deletions")
}
+45
View File
@@ -0,0 +1,45 @@
[package]
name = "flix-db"
version = "0.0.14"
categories = []
description = "Types for storing persistent data about media"
repository = "https://github.com/QuantumShade/flix"
authors.workspace = true
edition.workspace = true
license-file.workspace = true
rust-version.workspace = true
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[lints]
workspace = true
[features]
default = []
tmdb = ["dep:flix-tmdb"]
[dependencies]
flix-model = { workspace = true }
flix-tmdb = { workspace = true, optional = true, features = ["sea-orm"] }
seamantic = { workspace = true, features = ["sqlite"] }
chrono = { workspace = true }
sea-orm = { workspace = true, features = [
"entity-registry",
"schema-sync",
"with-chrono",
] }
sea-orm-migration = { workspace = true }
[dev-dependencies]
sea-orm-migration = { workspace = true, features = ["runtime-tokio-rustls"] }
tokio = { version = "^1", default-features = false, features = [
"rt",
"macros",
] }
+5
View File
@@ -0,0 +1,5 @@
# flix-db
[![Crates Version](https://img.shields.io/crates/v/flix-db.svg)](https://crates.io/crates/flix-db)
A library providing types for storing persistent data about media
+32
View File
@@ -0,0 +1,32 @@
//! Types and functions related to [DatabaseConnection]s
use sea_orm::{DatabaseConnection, DbErr};
use sea_orm_migration::MigratorTrait as _;
/// A newtype wrapping a [DatabaseConnection]
pub struct Connection(DatabaseConnection);
impl Connection {
/// Helper function for applying database migrations while wrapping a
/// [DatabaseConnection] in a newtype
pub async fn try_from(db: DatabaseConnection) -> Result<Self, DbErr> {
crate::migration::Migrator::down(&db, None).await?;
db.get_schema_registry("flix_db::*").sync(&db).await?;
db.get_schema_registry("flix_db::*").sync(&db).await?;
crate::migration::Migrator::up(&db, None).await?;
Ok(Self(db))
}
}
impl AsRef<DatabaseConnection> for Connection {
fn as_ref(&self) -> &DatabaseConnection {
&self.0
}
}
#[cfg(test)]
impl Connection {
pub(crate) fn take(self) -> DatabaseConnection {
self.0
}
}
+802
View File
@@ -0,0 +1,802 @@
//! This module contains entities for storing media file information
/// Library entity
pub mod libraries {
use flix_model::id::LibraryId;
use seamantic::model::path::PathBytes;
use chrono::NaiveDateTime;
use sea_orm::entity::prelude::*;
/// The database representation of a library media folder
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_libraries")]
pub struct Model {
/// The library's ID
#[sea_orm(column_type = "Integer", primary_key, nullable, auto_increment = false)]
pub id: LibraryId,
/// The library's directory
pub directory: PathBytes,
/// The library's last scan data
pub last_scan: Option<NaiveDateTime>,
/// Collections that are part of this library
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub collections: HasMany<super::collections::Entity>,
/// Movies that are part of this library
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub movies: HasMany<super::movies::Entity>,
/// Shows that are part of this library
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub shows: HasMany<super::shows::Entity>,
/// Seasons that are part of this library
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub seasons: HasMany<super::seasons::Entity>,
/// Episodes that are part of this library
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub episodes: HasMany<super::episodes::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Collection entity
pub mod collections {
use flix_model::id::{CollectionId, LibraryId};
use seamantic::model::path::PathBytes;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a collection media folder
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_collections")]
pub struct Model {
/// The collection's ID
#[sea_orm(column_type = "Integer", primary_key, nullable, auto_increment = false)]
pub id: CollectionId,
/// The collection's parent
#[sea_orm(indexed)]
pub parent_id: Option<CollectionId>,
/// The collection's slug
#[sea_orm(unique)]
pub slug: String,
/// The collection's library ID
pub library_id: LibraryId,
/// The collection's directory
pub directory: PathBytes,
/// The collection's poster path
pub relative_poster_path: Option<String>,
/// This collection's parent
#[sea_orm(self_ref, relation_enum = "Parent", from = "parent_id", to = "id")]
pub parent: HasOne<Entity>,
/// The library this collection belongs to
#[sea_orm(belongs_to, from = "library_id", to = "id")]
pub library: HasOne<super::libraries::Entity>,
/// The info for this collection
#[sea_orm(belongs_to, relation_enum = "Info", from = "id", to = "id")]
pub info: HasOne<entity::info::collections::Entity>,
/// The watched info for this collection
#[sea_orm(has_many, relation_enum = "Watched", from = "id", to = "id")]
pub watched: HasMany<entity::watched::collections::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Movie entity
pub mod movies {
use flix_model::id::{CollectionId, LibraryId, MovieId};
use seamantic::model::path::PathBytes;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a movie media folder
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_movies")]
pub struct Model {
/// The movie's ID
#[sea_orm(column_type = "Integer", primary_key, nullable, auto_increment = false)]
pub id: MovieId,
/// The movie's parent
#[sea_orm(indexed)]
pub parent_id: Option<CollectionId>,
/// The movie's slug
#[sea_orm(unique)]
pub slug: String,
/// The movie's library
pub library_id: LibraryId,
/// The movie's directory
pub directory: PathBytes,
/// The movie's media path
pub relative_media_path: String,
/// The movie's poster path
pub relative_poster_path: Option<String>,
/// This movie's parent
#[sea_orm(belongs_to, from = "parent_id", to = "id")]
pub parent: HasOne<super::collections::Entity>,
/// The library this movie belongs to
#[sea_orm(belongs_to, from = "library_id", to = "id")]
pub library: HasOne<super::libraries::Entity>,
/// The info for this movie
#[sea_orm(belongs_to, relation_enum = "Info", from = "id", to = "id")]
pub info: HasOne<entity::info::movies::Entity>,
/// The watched info for this movie
#[sea_orm(has_many, relation_enum = "Watched", from = "id", to = "id")]
pub watched: HasMany<entity::watched::movies::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Show entity
pub mod shows {
use flix_model::id::{CollectionId, LibraryId, ShowId};
use seamantic::model::path::PathBytes;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a show media folder
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_shows")]
pub struct Model {
/// The show's ID
#[sea_orm(column_type = "Integer", primary_key, nullable, auto_increment = false)]
pub id: ShowId,
/// The show's parent
#[sea_orm(indexed)]
pub parent_id: Option<CollectionId>,
/// The show's slug
#[sea_orm(unique)]
pub slug: String,
/// The show's library
pub library_id: LibraryId,
/// The show's directory
pub directory: PathBytes,
/// The show's poster path
pub relative_poster_path: Option<String>,
/// This show's parent
#[sea_orm(belongs_to, from = "parent_id", to = "id")]
pub parent: HasOne<super::collections::Entity>,
/// The library this show belongs to
#[sea_orm(belongs_to, from = "library_id", to = "id")]
pub library: HasOne<super::libraries::Entity>,
/// The info for this show
#[sea_orm(belongs_to, relation_enum = "Info", from = "id", to = "id")]
pub info: HasOne<entity::info::shows::Entity>,
/// The watched info for this show
#[sea_orm(has_many, relation_enum = "Watched", from = "id", to = "id")]
pub watched: HasMany<entity::watched::shows::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Season entity
pub mod seasons {
use flix_model::id::{LibraryId, ShowId};
use flix_model::numbers::SeasonNumber;
use seamantic::model::path::PathBytes;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a season media folder
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_seasons")]
pub struct Model {
/// The season's show's ID
#[sea_orm(primary_key, auto_increment = false)]
pub show_id: ShowId,
/// The season's number
#[sea_orm(primary_key, auto_increment = false)]
pub season_number: SeasonNumber,
/// The season's slug
#[sea_orm(unique)]
pub slug: String,
/// The season's library
pub library_id: LibraryId,
/// The season's directory
pub directory: PathBytes,
/// The season's poster path
pub relative_poster_path: Option<String>,
/// The library this season belongs to
#[sea_orm(belongs_to, from = "library_id", to = "id")]
pub library: HasOne<super::libraries::Entity>,
/// The info for this season
#[sea_orm(
belongs_to,
relation_enum = "Info",
from = "(show_id, season_number)",
to = "(show_id, season_number)"
)]
pub info: HasOne<entity::info::seasons::Entity>,
/// The watched info for this season
#[sea_orm(
has_many,
relation_enum = "Watched",
from = "(show_id, season_number)",
to = "(show_id, season_number)"
)]
pub watched: HasMany<entity::watched::seasons::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Episode entity
pub mod episodes {
use flix_model::id::{LibraryId, ShowId};
use flix_model::numbers::{EpisodeNumber, SeasonNumber};
use seamantic::model::path::PathBytes;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a episode media folder
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_episodes")]
pub struct Model {
/// The episode's show's ID
#[sea_orm(primary_key, auto_increment = false)]
pub show_id: ShowId,
/// The episode's season's number
#[sea_orm(primary_key, auto_increment = false)]
pub season_number: SeasonNumber,
/// The episode's number
#[sea_orm(primary_key, auto_increment = false)]
pub episode_number: EpisodeNumber,
/// The number of additional contained episodes
pub count: u8,
/// The episode's slug
#[sea_orm(unique)]
pub slug: String,
/// The episode's library
pub library_id: LibraryId,
/// The episode's directory
pub directory: PathBytes,
/// The episode's media path
pub relative_media_path: String,
/// The episode's poster path
pub relative_poster_path: Option<String>,
/// The library this episode belongs to
#[sea_orm(belongs_to, from = "library_id", to = "id")]
pub library: HasOne<super::libraries::Entity>,
/// The info for this episode
#[sea_orm(
belongs_to,
relation_enum = "Info",
from = "(show_id, season_number, episode_number)",
to = "(show_id, season_number, episode_number)"
)]
pub info: HasOne<entity::info::episodes::Entity>,
/// The watched info for this episode
#[sea_orm(
has_many,
relation_enum = "Watched",
from = "(show_id, season_number, episode_number)",
to = "(show_id, season_number, episode_number)"
)]
pub watched: HasMany<entity::watched::episodes::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Macros for creating content entities
#[cfg(test)]
pub mod test {
macro_rules! make_content_library {
($db:expr, $id:literal) => {
$crate::entity::content::libraries::ActiveModel {
id: Set(::flix_model::id::LibraryId::from_raw($id)),
directory: Set(::std::path::PathBuf::new().into()),
last_scan: Set(None),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_content_library;
macro_rules! make_content_collection {
($db:expr, $lid:literal, $id:literal, $pid:expr) => {
$crate::entity::info::test::make_info_collection!($db, $id);
$crate::entity::content::collections::ActiveModel {
id: Set(::flix_model::id::CollectionId::from_raw($id)),
parent_id: Set($pid.map(::flix_model::id::CollectionId::from_raw)),
slug: Set(concat!("C ", $id).to_string()),
library_id: Set(::flix_model::id::LibraryId::from_raw($lid)),
directory: Set(::std::path::PathBuf::new().into()),
relative_poster_path: Set(::core::option::Option::None),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_content_collection;
macro_rules! make_content_movie {
($db:expr, $lid:literal, $id:literal, $pid:expr) => {
$crate::entity::info::test::make_info_movie!($db, $id);
$crate::entity::content::movies::ActiveModel {
id: Set(::flix_model::id::MovieId::from_raw($id)),
parent_id: Set($pid.map(::flix_model::id::CollectionId::from_raw)),
slug: Set(concat!("< ", $id).to_string()),
library_id: Set(::flix_model::id::LibraryId::from_raw($lid)),
directory: Set(::std::path::PathBuf::new().into()),
relative_media_path: Set(::std::string::String::new()),
relative_poster_path: Set(::core::option::Option::None),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_content_movie;
macro_rules! make_content_show {
($db:expr, $lid:literal, $id:literal, $pid:expr) => {
$crate::entity::info::test::make_info_show!($db, $id);
$crate::entity::content::shows::ActiveModel {
id: Set(::flix_model::id::ShowId::from_raw($id)),
parent_id: Set($pid.map(::flix_model::id::CollectionId::from_raw)),
slug: Set(concat!("S ", $id).to_string()),
library_id: Set(::flix_model::id::LibraryId::from_raw($lid)),
directory: Set(::std::path::PathBuf::new().into()),
relative_poster_path: Set(::core::option::Option::None),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_content_show;
macro_rules! make_content_season {
($db:expr, $lid:literal, $show:literal, $season:literal) => {
$crate::entity::info::test::make_info_season!($db, $show, $season);
$crate::entity::content::seasons::ActiveModel {
show_id: Set(::flix_model::id::ShowId::from_raw($show)),
season_number: Set($season),
slug: Set(concat!("SS ", $show, $season).to_string()),
library_id: Set(::flix_model::id::LibraryId::from_raw($lid)),
directory: Set(::std::path::PathBuf::new().into()),
relative_poster_path: Set(::core::option::Option::None),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_content_season;
macro_rules! make_content_episode {
($db:expr, $lid:literal, $show:literal, $season:literal, $episode:literal) => {
make_content_episode!(@make, $db, $lid, $show, $season, $episode, 0);
};
($db:expr, $lid:literal, $show:literal, $season:literal, $episode:literal, >1) => {
make_content_episode!(@make, $db, $lid, $show, $season, $episode, 1);
};
(@make, $db:expr, $lid:literal, $show:literal, $season:literal, $episode:literal, $count:literal) => {
$crate::entity::info::test::make_info_episode!($db, $show, $season, $episode);
$crate::entity::content::episodes::ActiveModel {
show_id: Set(::flix_model::id::ShowId::from_raw($show)),
season_number: Set($season),
episode_number: Set($episode),
count: Set($count),
slug: Set(concat!("SSE ", $show, $season, $episode).to_string()),
library_id: Set(::flix_model::id::LibraryId::from_raw($lid)),
directory: Set(::std::path::PathBuf::new().into()),
relative_media_path: Set(::std::string::String::new()),
relative_poster_path: Set(::core::option::Option::None),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_content_episode;
}
#[cfg(test)]
mod tests {
use std::path::Path;
use flix_model::id::{CollectionId, LibraryId, MovieId, ShowId};
use chrono::{NaiveDate, NaiveDateTime, NaiveTime};
use sea_orm::ActiveValue::{NotSet, Set};
use sea_orm::entity::prelude::*;
use sea_orm::sqlx::error::ErrorKind;
use crate::entity::content::test::{
make_content_collection, make_content_episode, make_content_library, make_content_movie,
make_content_season, make_content_show,
};
use crate::entity::info::test::{
make_info_collection, make_info_episode, make_info_movie, make_info_season, make_info_show,
};
use crate::tests::new_initialized_memory_db;
use super::super::tests::get_error_kind;
use super::super::tests::{noneable, notsettable};
#[tokio::test]
async fn use_test_macros() {
let db = new_initialized_memory_db().await;
make_content_library!(&db, 1);
make_content_collection!(&db, 1, 1, None);
make_content_movie!(&db, 1, 1, None);
make_content_show!(&db, 1, 1, None);
make_content_season!(&db, 1, 1, 1);
make_content_episode!(&db, 1, 1, 1, 1);
}
#[tokio::test]
async fn test_round_trip_libraries() {
let db = new_initialized_memory_db().await;
macro_rules! assert_library {
($db:expr, $id:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_library!(@insert, $db, $id $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.id, LibraryId::from_raw($id));
assert_eq!(model.directory, Path::new(concat!("L Directory ", $id)).to_owned().into());
assert_eq!(model.last_scan, noneable!(last_scan, NaiveDateTime::new(NaiveDate::from_yo_opt($id, 1).expect("from_yo_opt"), NaiveTime::from_hms_opt(1, 1, 1).expect("from_yo_opt")) $(, $($skip),+)?));
};
($db:expr, $id:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_library!(@insert, $db, $id $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal $(; $($skip:ident),+)?) => {
super::libraries::ActiveModel {
id: notsettable!(id, LibraryId::from_raw($id) $(, $($skip),+)?),
directory: notsettable!(directory, Path::new(concat!("L Directory ", $id)).to_owned().into() $(, $($skip),+)?),
last_scan: notsettable!(last_scan, Some(NaiveDateTime::new(NaiveDate::from_yo_opt($id, 1).expect("from_yo_opt"), NaiveTime::from_hms_opt(1, 1, 1).expect("from_yo_opt"))) $(, $($skip),+)?),
}.insert($db).await
};
}
assert_library!(&db, 1, Success);
assert_library!(&db, 1, UniqueViolation);
assert_library!(&db, 2, Success);
assert_library!(&db, 3, Success; id);
assert_library!(&db, 4, NotNullViolation; directory);
assert_library!(&db, 5, Success; last_scan);
}
#[tokio::test]
async fn test_round_trip_collections() {
let db = new_initialized_memory_db().await;
macro_rules! assert_collection {
($db:expr, $id:literal, $pid:expr, $lid:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_collection!(@insert, $db, $id, $pid, $lid $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.id, CollectionId::from_raw($id));
assert_eq!(model.parent_id, $pid.map(CollectionId::from_raw));
assert_eq!(model.slug, concat!("C Slug ", $id).to_string());
assert_eq!(model.library_id, LibraryId::from_raw($lid));
assert_eq!(model.directory, Path::new(concat!("C Directory ", $id)).to_owned().into());
assert_eq!(model.relative_poster_path, noneable!(relative_poster_path, concat!("C Poster ", $id).to_owned() $(, $($skip),+)?));
};
($db:expr, $id:literal, $pid:expr, $lid:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_collection!(@insert, $db, $id, $pid, $lid $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal, $pid:expr, $lid:literal $(; $($skip:ident),+)?) => {
super::collections::ActiveModel {
id: notsettable!(id, CollectionId::from_raw($id) $(, $($skip),+)?),
parent_id: notsettable!(parent_id, $pid.map(CollectionId::from_raw) $(, $($skip),+)?),
slug: notsettable!(slug, concat!("C Slug ", $id).to_string() $(, $($skip),+)?),
library_id: notsettable!(library_id, LibraryId::from_raw($lid) $(, $($skip),+)?),
directory: notsettable!(directory, Path::new(concat!("C Directory ", $id)).to_owned().into() $(, $($skip),+)?),
relative_poster_path: notsettable!(relative_poster_path, Some(concat!("C Poster ", $id).to_owned()) $(, $($skip),+)?),
}.insert($db).await
};
}
make_content_library!(&db, 1);
assert_collection!(&db, 1, None, 1, ForeignKeyViolation);
make_info_collection!(&db, 1);
assert_collection!(&db, 1, None, 1, Success);
make_info_collection!(&db, 2);
assert_collection!(&db, 2, None, 2, ForeignKeyViolation);
make_content_library!(&db, 2);
assert_collection!(&db, 2, None, 2, Success);
assert_collection!(&db, 1, None, 1, UniqueViolation);
make_info_collection!(&db, 3);
make_info_collection!(&db, 4);
make_info_collection!(&db, 5);
make_info_collection!(&db, 6);
make_info_collection!(&db, 7);
make_info_collection!(&db, 8);
assert_collection!(&db, 3, None, 1, Success; id);
assert_collection!(&db, 4, None, 1, Success; parent_id);
assert_collection!(&db, 5, None, 1, NotNullViolation; slug);
assert_collection!(&db, 6, None, 1, NotNullViolation; library_id);
assert_collection!(&db, 7, None, 1, NotNullViolation; directory);
assert_collection!(&db, 8, None, 1, Success; relative_poster_path);
}
#[tokio::test]
async fn test_round_trip_movies() {
let db = new_initialized_memory_db().await;
macro_rules! assert_movie {
($db:expr, $id:literal, $pid:expr, $lid:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_movie!(@insert, $db, $id, $pid, $lid $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.id, MovieId::from_raw($id));
assert_eq!(model.parent_id, $pid.map(CollectionId::from_raw));
assert_eq!(model.slug, concat!("M Slug ", $id).to_string());
assert_eq!(model.library_id, LibraryId::from_raw($lid));
assert_eq!(model.directory, Path::new(concat!("M Directory ", $id)).to_owned().into());
assert_eq!(model.relative_media_path, concat!("M Media ", $id));
assert_eq!(model.relative_poster_path, noneable!(relative_poster_path, concat!("M Poster ", $id).to_owned() $(, $($skip),+)?));
};
($db:expr, $id:literal, $pid:expr, $lid:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_movie!(@insert, $db, $id, $pid, $lid $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal, $pid:expr, $lid:literal $(; $($skip:ident),+)?) => {
super::movies::ActiveModel {
id: notsettable!(id, MovieId::from_raw($id) $(, $($skip),+)?),
parent_id: notsettable!(parent_id, $pid.map(CollectionId::from_raw) $(, $($skip),+)?),
slug: notsettable!(slug, concat!("M Slug ", $id).to_string() $(, $($skip),+)?),
library_id: notsettable!(library_id, LibraryId::from_raw($lid) $(, $($skip),+)?),
directory: notsettable!(directory, Path::new(concat!("M Directory ", $id)).to_owned().into() $(, $($skip),+)?),
relative_media_path: notsettable!(relative_media_path, concat!("M Media ", $id).to_owned() $(, $($skip),+)?),
relative_poster_path: notsettable!(relative_poster_path, Some(concat!("M Poster ", $id).to_owned()) $(, $($skip),+)?),
}.insert($db).await
};
}
make_content_library!(&db, 1);
assert_movie!(&db, 1, None, 1, ForeignKeyViolation);
make_info_movie!(&db, 1);
assert_movie!(&db, 1, Some(1), 1, ForeignKeyViolation);
make_content_collection!(&db, 1, 1, None);
assert_movie!(&db, 1, Some(1), 1, Success);
assert_movie!(&db, 2, None, 2, ForeignKeyViolation);
make_info_movie!(&db, 2);
assert_movie!(&db, 2, None, 2, ForeignKeyViolation);
make_content_library!(&db, 2);
assert_movie!(&db, 2, None, 2, Success);
assert_movie!(&db, 1, None, 1, UniqueViolation);
make_info_movie!(&db, 3);
make_info_movie!(&db, 4);
make_info_movie!(&db, 5);
make_info_movie!(&db, 6);
make_info_movie!(&db, 7);
make_info_movie!(&db, 8);
make_info_movie!(&db, 9);
assert_movie!(&db, 3, None, 1, Success; id);
assert_movie!(&db, 4, None, 1, Success; parent_id);
assert_movie!(&db, 5, None, 1, NotNullViolation; slug);
assert_movie!(&db, 6, None, 1, NotNullViolation; library_id);
assert_movie!(&db, 7, None, 1, NotNullViolation; directory);
assert_movie!(&db, 8, None, 1, NotNullViolation; relative_media_path);
assert_movie!(&db, 9, None, 1, Success; relative_poster_path);
}
#[tokio::test]
async fn test_round_trip_shows() {
let db = new_initialized_memory_db().await;
macro_rules! assert_show {
($db:expr, $id:literal, $pid:expr, $lid:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_show!(@insert, $db, $id, $pid, $lid $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.id, ShowId::from_raw($id));
assert_eq!(model.parent_id, $pid.map(CollectionId::from_raw));
assert_eq!(model.slug, concat!("S Slug ", $id).to_string());
assert_eq!(model.library_id, LibraryId::from_raw($lid));
assert_eq!(model.directory, Path::new(concat!("S Directory ", $id)).to_owned().into());
assert_eq!(model.relative_poster_path, noneable!(relative_poster_path, concat!("S Poster ", $id).to_owned() $(, $($skip),+)?));
};
($db:expr, $id:literal, $pid:expr, $lid:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_show!(@insert, $db, $id, $pid, $lid $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal, $pid:expr, $lid:literal $(; $($skip:ident),+)?) => {
super::shows::ActiveModel {
id: notsettable!(id, ShowId::from_raw($id) $(, $($skip),+)?),
parent_id: notsettable!(parent_id, $pid.map(CollectionId::from_raw) $(, $($skip),+)?),
slug: notsettable!(slug, concat!("S Slug ", $id).to_string() $(, $($skip),+)?),
library_id: notsettable!(library_id, LibraryId::from_raw($lid) $(, $($skip),+)?),
directory: notsettable!(directory, Path::new(concat!("S Directory ", $id)).to_owned().into() $(, $($skip),+)?),
relative_poster_path: notsettable!(relative_poster_path, Some(concat!("S Poster ", $id).to_owned()) $(, $($skip),+)?),
}.insert($db).await
};
}
make_content_library!(&db, 1);
assert_show!(&db, 1, None, 1, ForeignKeyViolation);
make_info_show!(&db, 1);
assert_show!(&db, 1, Some(1), 1, ForeignKeyViolation);
make_content_collection!(&db, 1, 1, None);
assert_show!(&db, 1, Some(1), 1, Success);
assert_show!(&db, 2, None, 2, ForeignKeyViolation);
make_info_show!(&db, 2);
assert_show!(&db, 2, None, 2, ForeignKeyViolation);
make_content_library!(&db, 2);
assert_show!(&db, 2, None, 2, Success);
assert_show!(&db, 1, None, 1, UniqueViolation);
make_info_show!(&db, 3);
make_info_show!(&db, 4);
make_info_show!(&db, 5);
make_info_show!(&db, 6);
make_info_show!(&db, 7);
make_info_show!(&db, 8);
assert_show!(&db, 3, None, 1, Success; id);
assert_show!(&db, 4, None, 1, Success; parent_id);
assert_show!(&db, 5, None, 1, NotNullViolation; slug);
assert_show!(&db, 6, None, 1, NotNullViolation; library_id);
assert_show!(&db, 7, None, 1, NotNullViolation; directory);
assert_show!(&db, 8, None, 1, Success; relative_poster_path);
}
#[tokio::test]
async fn test_round_trip_seasons() {
let db = new_initialized_memory_db().await;
macro_rules! assert_season {
($db:expr, $id:literal, $season:literal, $lid:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_season!(@insert, $db, $id, $season, $lid $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.show_id, ShowId::from_raw($id));
assert_eq!(model.season_number, $season);
assert_eq!(model.slug, concat!("SS Slug ", $id, ",", $season).to_string());
assert_eq!(model.library_id, LibraryId::from_raw($lid));
assert_eq!(model.directory, Path::new(concat!("SS Directory ", $id, ",", $season)).to_owned().into());
assert_eq!(model.relative_poster_path, noneable!(relative_poster_path, concat!("SS Poster ", $id, ",", $season).to_owned() $(, $($skip),+)?));
};
($db:expr, $id:literal, $season:literal, $lid:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_season!(@insert, $db, $id, $season, $lid $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal, $season:literal, $lid:literal $(; $($skip:ident),+)?) => {
super::seasons::ActiveModel {
show_id: notsettable!(show_id, ShowId::from_raw($id) $(, $($skip),+)?),
season_number: notsettable!(season_number, $season $(, $($skip),+)?),
slug: notsettable!(slug, concat!("SS Slug ", $id, ",", $season).to_string() $(, $($skip),+)?),
library_id: notsettable!(library_id, LibraryId::from_raw($lid) $(, $($skip),+)?),
directory: notsettable!(directory, Path::new(concat!("SS Directory ", $id, ",", $season)).to_owned().into() $(, $($skip),+)?),
relative_poster_path: notsettable!(relative_poster_path, Some(concat!("SS Poster ", $id, ",", $season).to_owned()) $(, $($skip),+)?),
}.insert($db).await
};
}
make_content_library!(&db, 1);
make_info_show!(&db, 1);
assert_season!(&db, 1, 1, 1, ForeignKeyViolation);
make_info_season!(&db, 1, 1);
assert_season!(&db, 1, 1, 1, Success);
assert_season!(&db, 1, 1, 1, UniqueViolation);
make_info_season!(&db, 1, 3);
make_info_season!(&db, 1, 4);
make_info_season!(&db, 1, 5);
make_info_season!(&db, 1, 6);
make_info_season!(&db, 1, 7);
make_info_season!(&db, 1, 8);
assert_season!(&db, 1, 3, 1, NotNullViolation; show_id);
assert_season!(&db, 1, 4, 1, NotNullViolation; season_number);
assert_season!(&db, 1, 5, 1, NotNullViolation; slug);
assert_season!(&db, 1, 6, 1, NotNullViolation; library_id);
assert_season!(&db, 1, 7, 1, NotNullViolation; directory);
assert_season!(&db, 1, 8, 1, Success; relative_poster_path);
}
#[tokio::test]
async fn test_round_trip_episodes() {
let db = new_initialized_memory_db().await;
macro_rules! assert_episode {
($db:expr, $id:literal, $season:literal, $episode:literal, $lid:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_episode!(@insert, $db, $id, $season, $episode, $lid $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.show_id, ShowId::from_raw($id));
assert_eq!(model.season_number, $season);
assert_eq!(model.episode_number, $episode);
assert_eq!(model.slug, concat!("SS Slug ", $id, ",", $season, $episode).to_string());
assert_eq!(model.library_id, LibraryId::from_raw($lid));
assert_eq!(model.directory, Path::new(concat!("SS Directory ", $id, ",", $season, $episode)).to_owned().into());
assert_eq!(model.relative_media_path, concat!("SS Media ", $id, ",", $season, $episode));
assert_eq!(model.relative_poster_path, noneable!(relative_poster_path, concat!("SS Poster ", $id, ",", $season, $episode).to_owned() $(, $($skip),+)?));
};
($db:expr, $id:literal, $season:literal, $episode:literal, $lid:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_episode!(@insert, $db, $id, $season, $episode, $lid $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal, $season:literal, $episode:literal, $lid:literal $(; $($skip:ident),+)?) => {
super::episodes::ActiveModel {
show_id: notsettable!(show_id, ShowId::from_raw($id) $(, $($skip),+)?),
season_number: notsettable!(season_number, $season $(, $($skip),+)?),
episode_number: notsettable!(episode_number, $episode $(, $($skip),+)?),
count: notsettable!(count, 0 $(, $($skip),+)?),
slug: notsettable!(slug, concat!("SS Slug ", $id, ",", $season, $episode).to_string() $(, $($skip),+)?),
library_id: notsettable!(library_id, LibraryId::from_raw($lid) $(, $($skip),+)?),
directory: notsettable!(directory, Path::new(concat!("SS Directory ", $id, ",", $season, $episode)).to_owned().into() $(, $($skip),+)?),
relative_media_path: notsettable!(relative_media_path, concat!("SS Media ", $id, ",", $season, $episode).to_owned() $(, $($skip),+)?),
relative_poster_path: notsettable!(relative_poster_path, Some(concat!("SS Poster ", $id, ",", $season, $episode).to_owned()) $(, $($skip),+)?),
}.insert($db).await
};
}
make_content_library!(&db, 1);
make_info_show!(&db, 1);
make_info_season!(&db, 1, 1);
assert_episode!(&db, 1, 1, 1, 1, ForeignKeyViolation);
make_info_episode!(&db, 1, 1, 1);
assert_episode!(&db, 1, 1, 1, 1, Success);
assert_episode!(&db, 1, 1, 1, 1, UniqueViolation);
make_info_episode!(&db, 1, 1, 3);
make_info_episode!(&db, 1, 1, 4);
make_info_episode!(&db, 1, 1, 5);
make_info_episode!(&db, 1, 1, 6);
make_info_episode!(&db, 1, 1, 7);
make_info_episode!(&db, 1, 1, 8);
make_info_episode!(&db, 1, 1, 9);
make_info_episode!(&db, 1, 1, 10);
assert_episode!(&db, 1, 1, 3, 1, NotNullViolation; show_id);
assert_episode!(&db, 1, 1, 4, 1, NotNullViolation; season_number);
assert_episode!(&db, 1, 1, 5, 1, NotNullViolation; episode_number);
assert_episode!(&db, 1, 1, 6, 1, NotNullViolation; slug);
assert_episode!(&db, 1, 1, 7, 1, NotNullViolation; library_id);
assert_episode!(&db, 1, 1, 8, 1, NotNullViolation; directory);
assert_episode!(&db, 1, 1, 9, 1, NotNullViolation; relative_media_path);
assert_episode!(&db, 1, 1, 10, 1, Success; relative_poster_path);
}
}
+524
View File
@@ -0,0 +1,524 @@
//! This module contains entities for storing media information such as
//! titles and overviews
/// Collection entity
pub mod collections {
use flix_model::id::CollectionId;
use sea_orm::entity::prelude::*;
/// The database representation of a flix collection
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_info_collections")]
pub struct Model {
/// The collection's ID
#[sea_orm(column_type = "Integer", primary_key, nullable, auto_increment = false)]
pub id: CollectionId,
/// The collection's title
#[sea_orm(indexed)]
pub title: String,
/// The collection's overview
pub overview: String,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Movie entity
pub mod movies {
use flix_model::id::MovieId;
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
/// The database representation of a flix movie
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_info_movies")]
pub struct Model {
/// The movie's ID
#[sea_orm(column_type = "Integer", primary_key, nullable, auto_increment = false)]
pub id: MovieId,
/// The movie's title
#[sea_orm(indexed)]
pub title: String,
/// The movie's tagline
pub tagline: String,
/// The movie's overview
pub overview: String,
/// The movie's release date
#[sea_orm(indexed)]
pub date: NaiveDate,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Show entity
pub mod shows {
use flix_model::id::ShowId;
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
/// The database representation of a flix show
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_info_shows")]
pub struct Model {
/// The show's ID
#[sea_orm(column_type = "Integer", primary_key, nullable, auto_increment = false)]
pub id: ShowId,
/// The show's title
#[sea_orm(indexed)]
pub title: String,
/// The show's tagline
pub tagline: String,
/// The show's overview
pub overview: String,
/// The show's air date
#[sea_orm(indexed)]
pub date: NaiveDate,
/// Seasons that are part of this show
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub seasons: HasMany<super::seasons::Entity>,
/// Episodes that are part of this show
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub episodes: HasMany<super::episodes::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Season entity
pub mod seasons {
use flix_model::id::ShowId;
use flix_model::numbers::SeasonNumber;
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
/// The database representation of a flix season
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_info_seasons")]
pub struct Model {
/// The season's show's ID
#[sea_orm(primary_key, auto_increment = false)]
pub show_id: ShowId,
/// The season's number
#[sea_orm(primary_key, auto_increment = false)]
pub season_number: SeasonNumber,
/// The season's title
pub title: String,
/// The season's overview
pub overview: String,
/// The season's air date
#[sea_orm(indexed)]
pub date: NaiveDate,
/// The show this season belongs to
#[sea_orm(belongs_to, from = "show_id", to = "id")]
pub show: HasOne<super::shows::Entity>,
/// Episodes that are part of this season
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub episodes: HasMany<super::episodes::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Episode entity
pub mod episodes {
use flix_model::id::ShowId;
use flix_model::numbers::{EpisodeNumber, SeasonNumber};
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
/// The database representation of a flix episode
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_info_episodes")]
pub struct Model {
/// The episode's show's ID
#[sea_orm(primary_key, auto_increment = false)]
pub show_id: ShowId,
/// The episode's season's number
#[sea_orm(primary_key, auto_increment = false)]
pub season_number: SeasonNumber,
/// The episode's number
#[sea_orm(primary_key, auto_increment = false)]
pub episode_number: EpisodeNumber,
/// The episode's title
pub title: String,
/// The episode's overview
pub overview: String,
/// The episode's air date
#[sea_orm(indexed)]
pub date: NaiveDate,
/// The show this episode belongs to
#[sea_orm(belongs_to, from = "show_id", to = "id")]
pub show: HasOne<super::shows::Entity>,
/// The season this episode belongs to
#[sea_orm(
belongs_to,
from = "(show_id, season_number)",
to = "(show_id, season_number)"
)]
pub season: HasOne<super::seasons::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Macros for creating info entities
#[cfg(test)]
pub mod test {
macro_rules! make_info_collection {
($db:expr, $id:literal) => {
$crate::entity::info::collections::ActiveModel {
id: Set(::flix_model::id::CollectionId::from_raw($id)),
title: Set(::std::string::String::new()),
overview: Set(::std::string::String::new()),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_info_collection;
macro_rules! make_info_movie {
($db:expr, $id:literal) => {
$crate::entity::info::movies::ActiveModel {
id: Set(::flix_model::id::MovieId::from_raw($id)),
title: Set(::std::string::String::new()),
tagline: Set(::std::string::String::new()),
overview: Set(::std::string::String::new()),
date: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_info_movie;
macro_rules! make_info_show {
($db:expr, $id:literal) => {
$crate::entity::info::shows::ActiveModel {
id: Set(::flix_model::id::ShowId::from_raw($id)),
title: Set(::std::string::String::new()),
tagline: Set(::std::string::String::new()),
overview: Set(::std::string::String::new()),
date: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_info_show;
macro_rules! make_info_season {
($db:expr, $show:literal, $season:literal) => {
$crate::entity::info::seasons::ActiveModel {
show_id: Set(::flix_model::id::ShowId::from_raw($show)),
season_number: Set($season),
title: Set(::std::string::String::new()),
overview: Set(::std::string::String::new()),
date: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_info_season;
macro_rules! make_info_episode {
($db:expr, $show:literal, $season:literal, $episode:literal) => {
$crate::entity::info::episodes::ActiveModel {
show_id: Set(::flix_model::id::ShowId::from_raw($show)),
season_number: Set($season),
episode_number: Set($episode),
title: Set(::std::string::String::new()),
overview: Set(::std::string::String::new()),
date: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_info_episode;
}
#[cfg(test)]
mod tests {
use flix_model::id::{CollectionId, MovieId, ShowId};
use chrono::NaiveDate;
use sea_orm::ActiveValue::{NotSet, Set};
use sea_orm::entity::prelude::*;
use sea_orm::sqlx::error::ErrorKind;
use crate::tests::new_initialized_memory_db;
use super::super::tests::get_error_kind;
use super::super::tests::notsettable;
use super::test::{
make_info_collection, make_info_episode, make_info_movie, make_info_season, make_info_show,
};
#[tokio::test]
async fn use_test_macros() {
let db = new_initialized_memory_db().await;
make_info_collection!(&db, 1);
make_info_movie!(&db, 1);
make_info_show!(&db, 1);
make_info_season!(&db, 1, 1);
make_info_episode!(&db, 1, 1, 1);
}
#[tokio::test]
async fn test_round_trip_collections() {
let db = new_initialized_memory_db().await;
macro_rules! assert_collection {
($db:expr, $id:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_collection!(@insert, $db, $id $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.id, CollectionId::from_raw($id));
assert_eq!(model.title, concat!("C Title ", $id));
assert_eq!(model.overview, concat!("C Overview ", $id));
};
($db:expr, $id:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_collection!(@insert, $db, $id $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal $(; $($skip:ident),+)?) => {
super::collections::ActiveModel {
id: notsettable!(id, CollectionId::from_raw($id) $(, $($skip),+)?),
title: notsettable!(title, concat!("C Title ", $id).to_string() $(, $($skip),+)?),
overview: notsettable!(overview, concat!("C Overview ", $id).to_string() $(, $($skip),+)?),
}.insert($db).await
};
}
assert_collection!(&db, 1, Success);
assert_collection!(&db, 1, UniqueViolation);
assert_collection!(&db, 2, Success);
assert_collection!(&db, 3, Success; id);
assert_collection!(&db, 4, NotNullViolation; title);
assert_collection!(&db, 5, NotNullViolation; overview);
}
#[tokio::test]
async fn test_round_trip_movies() {
let db = new_initialized_memory_db().await;
macro_rules! assert_movie {
($db:expr, $id:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_movie!(@insert, $db, $id $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.id, MovieId::from_raw($id));
assert_eq!(model.title, concat!("M Title ", $id));
assert_eq!(model.tagline, concat!("M Tagline ", $id));
assert_eq!(model.overview, concat!("M Overview ", $id));
assert_eq!(model.date, NaiveDate::from_yo_opt($id, 1).expect("from_yo_opt"));
};
($db:expr, $id:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_movie!(@insert, $db, $id $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal $(; $($skip:ident),+)?) => {
super::movies::ActiveModel {
id: notsettable!(id, MovieId::from_raw($id) $(, $($skip),+)?),
title: notsettable!(title, concat!("M Title ", $id).to_string() $(, $($skip),+)?),
tagline: notsettable!(tagline, concat!("M Tagline ", $id).to_string() $(, $($skip),+)?),
overview: notsettable!(overview, concat!("M Overview ", $id).to_string() $(, $($skip),+)?),
date: notsettable!(date, NaiveDate::from_yo_opt($id, 1).expect("from_yo_opt") $(, $($skip),+)?),
}.insert($db).await
};
}
assert_movie!(&db, 1, Success);
assert_movie!(&db, 1, UniqueViolation);
assert_movie!(&db, 2, Success);
assert_movie!(&db, 3, Success; id);
assert_movie!(&db, 4, NotNullViolation; title);
assert_movie!(&db, 5, NotNullViolation; tagline);
assert_movie!(&db, 6, NotNullViolation; overview);
assert_movie!(&db, 7, NotNullViolation; date);
}
#[tokio::test]
async fn test_round_trip_shows() {
let db = new_initialized_memory_db().await;
macro_rules! assert_show {
($db:expr, $id:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_show!(@insert, $db, $id $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.id, ShowId::from_raw($id));
assert_eq!(model.title, concat!("S Title ", $id));
assert_eq!(model.tagline, concat!("S Tagline ", $id));
assert_eq!(model.overview, concat!("S Overview ", $id));
assert_eq!(model.date, NaiveDate::from_yo_opt($id, 1).expect("from_yo_opt"));
};
($db:expr, $id:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_show!(@insert, $db, $id $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(
get_error_kind(model).expect("get_error_kind"),
ErrorKind::$error
);
};
(@insert, $db:expr, $id:literal $(; $($skip:ident),+)?) => {
super::shows::ActiveModel {
id: notsettable!(id, ShowId::from_raw($id) $(, $($skip),+)?),
title: notsettable!(title, concat!("S Title ", $id).to_string() $(, $($skip),+)?),
tagline: notsettable!(tagline, concat!("S Tagline ", $id).to_string() $(, $($skip),+)?),
overview: notsettable!(overview, concat!("S Overview ", $id).to_string() $(, $($skip),+)?),
date: notsettable!(date, NaiveDate::from_yo_opt($id, 1).expect("from_yo_opt") $(, $($skip),+)?),
}.insert($db).await
};
}
assert_show!(&db, 1, Success);
assert_show!(&db, 1, UniqueViolation);
assert_show!(&db, 2, Success);
assert_show!(&db, 3, Success; id);
assert_show!(&db, 4, NotNullViolation; title);
assert_show!(&db, 5, NotNullViolation; tagline);
assert_show!(&db, 6, NotNullViolation; overview);
assert_show!(&db, 7, NotNullViolation; date);
}
#[tokio::test]
async fn test_round_trip_seasons() {
let db = new_initialized_memory_db().await;
macro_rules! assert_season {
($db:expr, $show:literal, $season:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_season!(@insert, $db, $show, $season $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.show_id, ShowId::from_raw($show));
assert_eq!(model.season_number, $season);
assert_eq!(model.title, concat!("SS Title ", $show, ",", $season));
assert_eq!(model.overview, concat!("SS Overview ", $show, ",", $season));
assert_eq!(model.date, NaiveDate::from_yo_opt($show + $season, 1).expect("from_yo_opt"));
};
($db:expr, $show:literal, $season:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_season!(@insert, $db, $show, $season $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(
get_error_kind(model).expect("get_error_kind"),
ErrorKind::$error
);
};
(@insert, $db:expr, $show:literal, $season:literal $(; $($skip:ident),+)?) => {
super::seasons::ActiveModel {
show_id: notsettable!(show_id, ShowId::from_raw($show) $(, $($skip),+)?),
season_number: notsettable!(season_number, $season $(, $($skip),+)?),
title: notsettable!(title, concat!("SS Title ", $show, ",", $season).to_string() $(, $($skip),+)?),
overview: notsettable!(overview, concat!("SS Overview ", $show, ",", $season).to_string() $(, $($skip),+)?),
date: notsettable!(date, NaiveDate::from_yo_opt($show + $season, 1).expect("from_yo_opt") $(, $($skip),+)?),
}.insert($db).await
};
}
assert_season!(&db, 1, 1, ForeignKeyViolation);
make_info_show!(&db, 1);
make_info_show!(&db, 2);
assert_season!(&db, 1, 1, Success);
assert_season!(&db, 1, 1, UniqueViolation);
assert_season!(&db, 2, 1, Success);
assert_season!(&db, 1, 2, Success);
assert_season!(&db, 1, 3, NotNullViolation; show_id);
assert_season!(&db, 1, 4, NotNullViolation; season_number);
assert_season!(&db, 1, 5, NotNullViolation; title);
assert_season!(&db, 1, 6, NotNullViolation; overview);
assert_season!(&db, 1, 7, NotNullViolation; date);
}
#[tokio::test]
async fn test_round_trip_episodes() {
let db = new_initialized_memory_db().await;
macro_rules! assert_episode {
($db:expr, $show:literal, $season:literal, $episode:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_episode!(@insert, $db, $show, $season, $episode $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.show_id, ShowId::from_raw($show));
assert_eq!(model.season_number, $season);
assert_eq!(model.episode_number, $episode);
assert_eq!(model.title, concat!("SSE Title ", $show, ",", $season, ",", $episode));
assert_eq!(model.overview, concat!("SSE Overview ", $show, ",", $season, ",", $episode));
assert_eq!(model.date, NaiveDate::from_yo_opt($show + $season, 1).expect("from_yo_opt"));
};
($db:expr, $show:literal, $season:literal, $episode:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_episode!(@insert, $db, $show, $season, $episode $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(
get_error_kind(model).expect("get_error_kind"),
ErrorKind::$error
);
};
(@insert, $db:expr, $show:literal, $season:literal, $episode:literal $(; $($skip:ident),+)?) => {
super::episodes::ActiveModel {
show_id: notsettable!(show_id, ShowId::from_raw($show) $(, $($skip),+)?),
season_number: notsettable!(season_number, $season $(, $($skip),+)?),
episode_number: notsettable!(episode_number, $episode $(, $($skip),+)?),
title: notsettable!(title, concat!("SSE Title ", $show, ",", $season, ",", $episode).to_string() $(, $($skip),+)?),
overview: notsettable!(overview, concat!("SSE Overview ", $show, ",", $season, ",", $episode).to_string() $(, $($skip),+)?),
date: notsettable!(date, NaiveDate::from_yo_opt($show + $season, 1).expect("from_yo_opt") $(, $($skip),+)?),
}.insert($db).await
};
}
assert_episode!(&db, 1, 1, 1, ForeignKeyViolation);
make_info_show!(&db, 1);
make_info_show!(&db, 2);
assert_episode!(&db, 1, 1, 1, ForeignKeyViolation);
make_info_season!(&db, 1, 1);
make_info_season!(&db, 1, 2);
make_info_season!(&db, 2, 1);
assert_episode!(&db, 1, 1, 1, Success);
assert_episode!(&db, 1, 1, 1, UniqueViolation);
assert_episode!(&db, 2, 1, 1, Success);
assert_episode!(&db, 1, 2, 1, Success);
assert_episode!(&db, 1, 1, 2, Success);
assert_episode!(&db, 1, 1, 3, NotNullViolation; show_id);
assert_episode!(&db, 1, 1, 4, NotNullViolation; season_number);
assert_episode!(&db, 1, 1, 4, NotNullViolation; episode_number);
assert_episode!(&db, 1, 1, 5, NotNullViolation; title);
assert_episode!(&db, 1, 1, 6, NotNullViolation; overview);
assert_episode!(&db, 1, 1, 7, NotNullViolation; date);
}
}
+73
View File
@@ -0,0 +1,73 @@
//! Entity structs for interacting with the database
pub mod content;
pub mod info;
#[cfg(feature = "tmdb")]
pub mod tmdb;
pub mod watched;
#[cfg(test)]
mod tests {
pub use sea_orm::DbErr;
use sea_orm::sqlx::error::ErrorKind;
#[derive(Debug)]
pub enum ErrorKindError {
NotRuntimeError,
NotSqlxError,
NotDatabaseError,
}
pub fn get_error_kind(error: DbErr) -> Result<ErrorKind, ErrorKindError> {
let runtime_err = match error {
DbErr::Conn(runtime_err) => runtime_err,
DbErr::Exec(runtime_err) => runtime_err,
DbErr::Query(runtime_err) => runtime_err,
_ => return Err(ErrorKindError::NotRuntimeError),
};
let sqlx_err = match runtime_err {
sea_orm::RuntimeErr::SqlxError(sqlx_err) => sqlx_err,
_ => return Err(ErrorKindError::NotSqlxError),
};
let database_err = match sqlx_err.as_ref() {
sea_orm::SqlxError::Database(database_err) => database_err,
_ => return Err(ErrorKindError::NotDatabaseError),
};
Ok(database_err.kind())
}
/// Helper macro for writing tests for `ActiveModel` structs where
/// toggling [sea_orm::ActiveValue] is needed
macro_rules! notsettable {
($field:ident, $value:expr $(, $($skip:ident),+)?) => {
if notsettable!(@skip, $field $(, $($skip),+)?) {
NotSet
} else {
Set($value)
}
};
(@skip, $field:ident $(, $skip:ident),*) => {
false $(|| stringify!($field) == stringify!($skip))*
};
}
pub(super) use notsettable;
/// Helper macro for writing tests for `ActiveModel` structs where
/// toggling [sea_orm::ActiveValue] is needed
macro_rules! noneable {
($field:ident, $value:expr $(, $($skip:ident),+)?) => {
if noneable!(@skip, $field $(, $($skip),+)?) {
None
} else {
Some($value)
}
};
(@skip, $field:ident $(, $skip:ident),*) => {
false $(|| stringify!($field) == stringify!($skip))*
};
}
pub(super) use noneable;
}
+629
View File
@@ -0,0 +1,629 @@
//! This module contains entities for storing dynamic data from TMDB
/// Collection entity
pub mod collections {
use flix_model::id::CollectionId as FlixId;
use flix_tmdb::model::id::CollectionId;
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a tmdb collection
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_tmdb_collections")]
pub struct Model {
/// The collection's TMDB ID
#[sea_orm(column_type = "Integer", primary_key, nullable, auto_increment = false)]
pub tmdb_id: CollectionId,
/// The collection's ID
#[sea_orm(unique)]
pub flix_id: FlixId,
/// The date of the last update
pub last_update: NaiveDate,
/// The number of movies in the collection
pub movie_count: u16,
/// Movies that are in this collection
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub movies: HasMany<super::movies::Entity>,
/// The info for this collection
#[sea_orm(belongs_to, from = "flix_id", to = "id")]
pub info: HasOne<entity::info::collections::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Movie entity
pub mod movies {
use flix_model::id::MovieId as FlixId;
use flix_tmdb::model::id::{CollectionId, MovieId};
use seamantic::model::duration::Seconds;
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a tmdb movie
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_tmdb_movies")]
pub struct Model {
/// The movie's TMDB ID
#[sea_orm(column_type = "Integer", primary_key, nullable, auto_increment = false)]
pub tmdb_id: MovieId,
/// The movie's ID
#[sea_orm(unique)]
pub flix_id: FlixId,
/// The date of the last update
pub last_update: NaiveDate,
/// The movie's runtime in seconds
pub runtime: Seconds,
/// The TMDB ID of the collection this movie belongs to
#[sea_orm(indexed)]
pub collection_id: Option<CollectionId>,
/// The info for this collection
#[sea_orm(belongs_to, from = "collection_id", to = "tmdb_id")]
pub collection: HasOne<super::collections::Entity>,
/// The info for this movie
#[sea_orm(belongs_to, from = "flix_id", to = "id")]
pub info: HasOne<entity::info::movies::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Show entity
pub mod shows {
use flix_model::id::ShowId as FlixId;
use flix_tmdb::model::id::ShowId;
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a tmdb show
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_tmdb_shows")]
pub struct Model {
/// The show's TMDB ID
#[sea_orm(column_type = "Integer", primary_key, nullable, auto_increment = false)]
pub tmdb_id: ShowId,
/// The show's ID
#[sea_orm(unique)]
pub flix_id: FlixId,
/// The movie's runtime in seconds
pub last_update: NaiveDate,
/// The number of seasons the show has
pub number_of_seasons: u32,
/// Seasons that are part of this show
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub seasons: HasMany<super::seasons::Entity>,
/// Episodes that are part of this show
#[sea_orm(has_many, on_update = "Cascade", on_delete = "Cascade")]
pub episodes: HasMany<super::episodes::Entity>,
/// The info for this show
#[sea_orm(belongs_to, from = "flix_id", to = "id")]
pub info: HasOne<entity::info::shows::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Season entity
pub mod seasons {
use flix_model::id::ShowId as FlixId;
use flix_model::numbers::SeasonNumber;
use flix_tmdb::model::id::ShowId;
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a tmdb season
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_tmdb_seasons")]
pub struct Model {
/// The season's show's TMDB ID
#[sea_orm(primary_key, auto_increment = false)]
pub tmdb_show: ShowId,
/// The season's TMDB season number
#[sea_orm(primary_key, auto_increment = false)]
pub tmdb_season: SeasonNumber,
/// The season's show's ID
#[sea_orm(unique_key = "flix")]
pub flix_show: FlixId,
/// The season's number
#[sea_orm(unique_key = "flix")]
pub flix_season: SeasonNumber,
/// The date of the last update
pub last_update: NaiveDate,
/// The show this season belongs to
#[sea_orm(belongs_to, from = "tmdb_show", to = "tmdb_id")]
pub show: HasOne<super::shows::Entity>,
/// The info for this season
#[sea_orm(
belongs_to,
from = "(flix_show, flix_season)",
to = "(show_id, season_number)"
)]
pub info: HasOne<entity::info::seasons::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Season entity
pub mod episodes {
use flix_model::id::ShowId as FlixId;
use flix_model::numbers::{EpisodeNumber, SeasonNumber};
use flix_tmdb::model::id::ShowId;
use seamantic::model::duration::Seconds;
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a tmdb episode
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_tmdb_episodes")]
pub struct Model {
/// The episode's show's TMDB ID
#[sea_orm(primary_key, auto_increment = false)]
pub tmdb_show: ShowId,
/// The episode's season's TMDB season number
#[sea_orm(primary_key, auto_increment = false)]
pub tmdb_season: SeasonNumber,
/// The episode's TMDB episode number
#[sea_orm(primary_key, auto_increment = false)]
pub tmdb_episode: EpisodeNumber,
/// The episode's show's ID
#[sea_orm(unique_key = "flix")]
pub flix_show: FlixId,
/// The episode's season's number
#[sea_orm(unique_key = "flix")]
pub flix_season: SeasonNumber,
/// The episode's number
#[sea_orm(unique_key = "flix")]
pub flix_episode: EpisodeNumber,
/// The date of the last update
pub last_update: NaiveDate,
/// The episode's runtime in seconds
pub runtime: Seconds,
/// The show this episode belongs to
#[sea_orm(belongs_to, from = "tmdb_show", to = "tmdb_id")]
pub show: HasOne<super::shows::Entity>,
/// The season this episode belongs to
#[sea_orm(
belongs_to,
from = "(tmdb_show, tmdb_season)",
to = "(tmdb_show, tmdb_season)"
)]
pub season: HasOne<super::seasons::Entity>,
/// The info for this episode
#[sea_orm(
belongs_to,
from = "(flix_show, flix_season, flix_episode)",
to = "(show_id, season_number, episode_number)"
)]
pub info: HasOne<entity::info::episodes::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Macros for creating tmdb entities
#[cfg(test)]
pub mod test {
macro_rules! make_tmdb_collection {
($db:expr, $id:literal, $flix_id:literal) => {
$crate::entity::tmdb::collections::ActiveModel {
tmdb_id: Set(::flix_tmdb::model::id::CollectionId::from_raw($id)),
flix_id: Set(::flix_model::id::CollectionId::from_raw($flix_id)),
last_update: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
movie_count: Set(::core::default::Default::default()),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_tmdb_collection;
macro_rules! make_tmdb_movie {
($db:expr, $id:literal, $flix_id:literal) => {
$crate::entity::tmdb::movies::ActiveModel {
tmdb_id: Set(::flix_tmdb::model::id::MovieId::from_raw($id)),
flix_id: Set(::flix_model::id::MovieId::from_raw($flix_id)),
last_update: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
runtime: Set(::core::default::Default::default()),
collection_id: Set(None),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_tmdb_movie;
macro_rules! make_tmdb_show {
($db:expr, $id:literal, $flix_id:literal) => {
$crate::entity::tmdb::shows::ActiveModel {
tmdb_id: Set(::flix_tmdb::model::id::ShowId::from_raw($id)),
flix_id: Set(::flix_model::id::ShowId::from_raw($flix_id)),
last_update: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
number_of_seasons: Set(::core::default::Default::default()),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_tmdb_show;
macro_rules! make_tmdb_season {
($db:expr, $show:literal, $season:literal, $flix_show:literal, $flix_season:literal) => {
$crate::entity::tmdb::seasons::ActiveModel {
tmdb_show: Set(::flix_tmdb::model::id::ShowId::from_raw($show)),
tmdb_season: Set($season),
flix_show: Set(::flix_model::id::ShowId::from_raw($flix_show)),
flix_season: Set($flix_season),
last_update: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_tmdb_season;
macro_rules! make_tmdb_episode {
($db:expr, $show:literal, $season:literal, $episode:literal, $flix_show:literal, $flix_season:literal, $flix_episode:literal) => {
$crate::entity::tmdb::episodes::ActiveModel {
tmdb_show: Set(::flix_tmdb::model::id::ShowId::from_raw($show)),
tmdb_season: Set($season),
tmdb_episode: Set($episode),
flix_show: Set(::flix_model::id::ShowId::from_raw($flix_show)),
flix_season: Set($flix_season),
flix_episode: Set($flix_episode),
last_update: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
runtime: Set(::core::default::Default::default()),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_tmdb_episode;
}
#[cfg(test)]
mod tests {
use core::time::Duration;
use flix_model::id::{CollectionId, MovieId, ShowId};
use flix_tmdb::model::id::{
CollectionId as TmdbCollectionId, MovieId as TmdbMovieId, ShowId as TmdbShowId,
};
use chrono::NaiveDate;
use sea_orm::ActiveValue::{NotSet, Set};
use sea_orm::entity::prelude::*;
use sea_orm::sqlx::error::ErrorKind;
use crate::entity::info::test::{
make_info_collection, make_info_episode, make_info_movie, make_info_season, make_info_show,
};
use crate::tests::new_initialized_memory_db;
use super::super::tests::get_error_kind;
use super::super::tests::notsettable;
use super::test::{
make_tmdb_collection, make_tmdb_episode, make_tmdb_movie, make_tmdb_season, make_tmdb_show,
};
#[tokio::test]
async fn use_test_macros() {
let db = new_initialized_memory_db().await;
make_info_collection!(&db, 1);
make_info_movie!(&db, 1);
make_info_show!(&db, 1);
make_info_season!(&db, 1, 1);
make_info_episode!(&db, 1, 1, 1);
make_tmdb_collection!(&db, 1, 1);
make_tmdb_movie!(&db, 1, 1);
make_tmdb_show!(&db, 1, 1);
make_tmdb_season!(&db, 1, 1, 1, 1);
make_tmdb_episode!(&db, 1, 1, 1, 1, 1, 1);
}
#[tokio::test]
async fn test_round_trip_collections() {
let db = new_initialized_memory_db().await;
macro_rules! assert_collection {
($db:expr, $id:literal, $tid:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_collection!(@insert, $db, $id, $tid $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.tmdb_id, TmdbCollectionId::from_raw($tid));
assert_eq!(model.flix_id, CollectionId::from_raw($id));
assert_eq!(model.last_update, NaiveDate::from_yo_opt($id, 1).expect("from_yo_opt"));
assert_eq!(model.movie_count, $id);
};
($db:expr, $id:literal, $tid:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_collection!(@insert, $db, $id, $tid $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal, $tid:literal $(; $($skip:ident),+)?) => {
super::collections::ActiveModel {
tmdb_id: notsettable!(tmdb_id, TmdbCollectionId::from_raw($tid) $(, $($skip),+)?),
flix_id: notsettable!(flix_id, CollectionId::from_raw($id) $(, $($skip),+)?),
last_update: notsettable!(last_update, NaiveDate::from_yo_opt($id, 1).expect("from_yo_opt") $(, $($skip),+)?),
movie_count: notsettable!(movie_count, $id $(, $($skip),+)?),
}.insert($db).await
};
}
assert_collection!(&db, 1, 1, ForeignKeyViolation);
make_info_collection!(&db, 1);
assert_collection!(&db, 1, 1, Success);
assert_collection!(&db, 1, 1, UniqueViolation);
assert_collection!(&db, 1, 2, UniqueViolation);
assert_collection!(&db, 2, 1, UniqueViolation);
make_info_collection!(&db, 2);
assert_collection!(&db, 2, 2, Success);
make_info_collection!(&db, 3);
assert_collection!(&db, 3, 3, Success; tmdb_id);
assert_collection!(&db, 4, 4, NotNullViolation; flix_id);
assert_collection!(&db, 5, 5, NotNullViolation; last_update);
assert_collection!(&db, 6, 6, NotNullViolation; movie_count);
}
#[tokio::test]
async fn test_round_trip_movies() {
let db = new_initialized_memory_db().await;
macro_rules! assert_movie {
($db:expr, $id:literal, $tid:literal, $cid:expr, Success $(; $($skip:ident),+)?) => {
let model = assert_movie!(@insert, $db, $id, $tid, $cid $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.tmdb_id, TmdbMovieId::from_raw($tid));
assert_eq!(model.flix_id, MovieId::from_raw($id));
assert_eq!(model.last_update, NaiveDate::from_yo_opt($id, 1).expect("from_yo_opt"));
assert_eq!(model.runtime, Duration::from_secs($tid).into());
assert_eq!(model.collection_id, $cid.map(TmdbCollectionId::from_raw));
};
($db:expr, $id:literal, $tid:literal, $cid:expr, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_movie!(@insert, $db, $id, $tid, $cid $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal, $tid:literal, $cid:expr $(; $($skip:ident),+)?) => {
super::movies::ActiveModel {
tmdb_id: notsettable!(tmdb_id, TmdbMovieId::from_raw($tid) $(, $($skip),+)?),
flix_id: notsettable!(flix_id, MovieId::from_raw($id) $(, $($skip),+)?),
last_update: notsettable!(last_update, NaiveDate::from_yo_opt($id, 1).expect("from_yo_opt") $(, $($skip),+)?),
runtime: notsettable!(runtime, Duration::from_secs($tid).into() $(, $($skip),+)?),
collection_id: notsettable!(collection_id, $cid.map(TmdbCollectionId::from_raw) $(, $($skip),+)?),
}.insert($db).await
};
}
assert_movie!(&db, 1, 1, None, ForeignKeyViolation);
make_info_movie!(&db, 1);
assert_movie!(&db, 1, 1, None, Success);
assert_movie!(&db, 1, 1, None, UniqueViolation);
make_info_movie!(&db, 2);
assert_movie!(&db, 2, 2, Some(2), ForeignKeyViolation);
make_info_collection!(&db, 2);
make_tmdb_collection!(&db, 2, 2);
assert_movie!(&db, 2, 2, Some(2), Success);
assert_movie!(&db, 1, 2, None, UniqueViolation);
assert_movie!(&db, 2, 1, None, UniqueViolation);
make_info_movie!(&db, 3);
assert_movie!(&db, 3, 3, None, Success; tmdb_id);
assert_movie!(&db, 4, 4, None, NotNullViolation; flix_id);
assert_movie!(&db, 5, 5, None, NotNullViolation; last_update);
assert_movie!(&db, 6, 6, None, NotNullViolation; runtime);
assert_movie!(&db, 7, 7, None, ForeignKeyViolation; collection_id);
}
#[tokio::test]
async fn test_round_trip_shows() {
let db = new_initialized_memory_db().await;
macro_rules! assert_show {
($db:expr, $id:literal, $tid:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_show!(@insert, $db, $id, $tid $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.tmdb_id, TmdbShowId::from_raw($tid));
assert_eq!(model.flix_id, ShowId::from_raw($id));
assert_eq!(model.last_update, NaiveDate::from_yo_opt(2000, $tid).expect("NaiveDate::from_yo_opt"));
assert_eq!(model.number_of_seasons, $id);
};
($db:expr, $id:literal, $tid:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_show!(@insert, $db, $id, $tid $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(
get_error_kind(model).expect("get_error_kind"),
ErrorKind::$error
);
};
(@insert, $db:expr, $id:literal, $tid:literal $(; $($skip:ident),+)?) => {
super::shows::ActiveModel {
tmdb_id: notsettable!(tmdb_id, TmdbShowId::from_raw($tid) $(, $($skip),+)?),
flix_id: notsettable!(flix_id, ShowId::from_raw($id) $(, $($skip),+)?),
last_update: notsettable!(last_update, NaiveDate::from_yo_opt(2000, $tid).expect("NaiveDate::from_yo_opt") $(, $($skip),+)?),
number_of_seasons: notsettable!(number_of_seasons, $id $(, $($skip),+)?),
}.insert($db).await
};
}
assert_show!(&db, 1, 1, ForeignKeyViolation);
make_info_show!(&db, 1);
assert_show!(&db, 1, 1, Success);
assert_show!(&db, 1, 1, UniqueViolation);
assert_show!(&db, 1, 2, UniqueViolation);
assert_show!(&db, 2, 1, UniqueViolation);
make_info_show!(&db, 2);
assert_show!(&db, 2, 2, Success);
make_info_show!(&db, 3);
assert_show!(&db, 3, 3, Success; tmdb_id);
assert_show!(&db, 4, 4, NotNullViolation; flix_id);
assert_show!(&db, 5, 5, NotNullViolation; last_update);
assert_show!(&db, 6, 6, NotNullViolation; number_of_seasons);
}
#[tokio::test]
async fn test_round_trip_seasons() {
let db = new_initialized_memory_db().await;
macro_rules! assert_season {
($db:expr, $show:literal, $season:literal, $tshow:literal, $tseason:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_season!(@insert, $db, $show, $season, $tshow, $tseason $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.tmdb_show, TmdbShowId::from_raw($tshow));
assert_eq!(model.tmdb_season, $tseason);
assert_eq!(model.flix_show, ShowId::from_raw($show));
assert_eq!(model.flix_season, $season);
assert_eq!(model.last_update, NaiveDate::from_yo_opt(2000, $tshow).expect("NaiveDate::from_yo_opt"));
};
($db:expr, $show:literal, $season:literal, $tshow:literal, $tseason:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_season!(@insert, $db, $show, $season, $tshow, $tseason $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(
get_error_kind(model).expect("get_error_kind"),
ErrorKind::$error
);
};
(@insert, $db:expr, $show:literal, $season:literal, $tshow:literal, $tseason:literal $(; $($skip:ident),+)?) => {
super::seasons::ActiveModel {
tmdb_show: notsettable!(tmdb_show, TmdbShowId::from_raw($tshow) $(, $($skip),+)?),
tmdb_season: notsettable!(tmdb_season, $tseason $(, $($skip),+)?),
flix_show: notsettable!(flix_show, ShowId::from_raw($show) $(, $($skip),+)?),
flix_season: notsettable!(flix_season, $season $(, $($skip),+)?),
last_update: notsettable!(last_update, NaiveDate::from_yo_opt(2000, $tshow).expect("NaiveDate::from_yo_opt") $(, $($skip),+)?),
}.insert($db).await
};
}
make_info_show!(&db, 1);
make_tmdb_show!(&db, 1, 1);
assert_season!(&db, 1, 1, 1, 1, ForeignKeyViolation);
make_info_season!(&db, 1, 1);
assert_season!(&db, 1, 1, 1, 1, Success);
assert_season!(&db, 1, 1, 1, 1, UniqueViolation);
assert_season!(&db, 1, 1, 2, 1, UniqueViolation);
assert_season!(&db, 2, 1, 1, 1, UniqueViolation);
make_info_season!(&db, 1, 2);
assert_season!(&db, 1, 2, 1, 2, Success);
assert_season!(&db, 1, 3, 1, 3, NotNullViolation; tmdb_show);
assert_season!(&db, 1, 4, 1, 4, NotNullViolation; tmdb_season);
assert_season!(&db, 1, 5, 1, 5, NotNullViolation; flix_show);
assert_season!(&db, 1, 6, 1, 6, NotNullViolation; flix_season);
assert_season!(&db, 1, 7, 1, 7, NotNullViolation; last_update);
}
#[tokio::test]
async fn test_round_trip_episodes() {
let db = new_initialized_memory_db().await;
macro_rules! assert_episode {
($db:expr, $show:literal, $season:literal, $episode:literal, $tshow:literal, $tseason:literal, $tepisode:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_episode!(@insert, $db, $show, $season, $episode, $tshow, $tseason, $tepisode $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.tmdb_show, TmdbShowId::from_raw($tshow));
assert_eq!(model.tmdb_season, $tseason);
assert_eq!(model.tmdb_episode, $tepisode);
assert_eq!(model.flix_show, ShowId::from_raw($show));
assert_eq!(model.flix_season, $season);
assert_eq!(model.flix_episode, $episode);
assert_eq!(model.last_update, NaiveDate::from_yo_opt(2000, $tshow).expect("NaiveDate::from_yo_opt"));
assert_eq!(model.runtime, Duration::from_secs($tshow).into());
};
($db:expr, $show:literal, $season:literal, $episode:literal, $tshow:literal, $tseason:literal, $tepisode:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_episode!(@insert, $db, $show, $season, $episode, $tshow, $tseason, $tepisode $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(
get_error_kind(model).expect("get_error_kind"),
ErrorKind::$error
);
};
(@insert, $db:expr, $show:literal, $season:literal, $episode:literal, $tshow:literal, $tseason:literal, $tepisode:literal $(; $($skip:ident),+)?) => {
super::episodes::ActiveModel {
tmdb_show: notsettable!(tmdb_show, TmdbShowId::from_raw($tshow) $(, $($skip),+)?),
tmdb_season: notsettable!(tmdb_season, $tseason $(, $($skip),+)?),
tmdb_episode: notsettable!(tmdb_episode, $tepisode $(, $($skip),+)?),
flix_show: notsettable!(flix_show, ShowId::from_raw($show) $(, $($skip),+)?),
flix_season: notsettable!(flix_season, $season $(, $($skip),+)?),
flix_episode: notsettable!(flix_episode, $episode $(, $($skip),+)?),
last_update: notsettable!(last_update, NaiveDate::from_yo_opt(2000, $tshow).expect("NaiveDate::from_yo_opt") $(, $($skip),+)?),
runtime: notsettable!(runtime, Duration::from_secs($tshow).into() $(, $($skip),+)?),
}.insert($db).await
};
}
make_info_show!(&db, 1);
make_info_season!(&db, 1, 1);
make_tmdb_show!(&db, 1, 1);
make_tmdb_season!(&db, 1, 1, 1, 1);
assert_episode!(&db, 1, 1, 1, 1, 1, 1, ForeignKeyViolation);
make_info_episode!(&db, 1, 1, 1);
assert_episode!(&db, 1, 1, 1, 1, 1, 1, Success);
assert_episode!(&db, 1, 1, 1, 1, 1, 1, UniqueViolation);
assert_episode!(&db, 1, 1, 1, 1, 2, 1, UniqueViolation);
assert_episode!(&db, 1, 1, 1, 2, 1, 1, UniqueViolation);
assert_episode!(&db, 1, 2, 1, 1, 1, 1, UniqueViolation);
assert_episode!(&db, 2, 1, 1, 1, 1, 1, UniqueViolation);
make_info_episode!(&db, 1, 1, 2);
assert_episode!(&db, 1, 1, 2, 1, 1, 2, Success);
assert_episode!(&db, 1, 1, 3, 1, 1, 3, NotNullViolation; tmdb_show);
assert_episode!(&db, 1, 1, 3, 1, 1, 4, NotNullViolation; tmdb_season);
assert_episode!(&db, 1, 1, 3, 1, 1, 5, NotNullViolation; tmdb_episode);
assert_episode!(&db, 1, 1, 3, 1, 1, 6, NotNullViolation; flix_show);
assert_episode!(&db, 1, 1, 3, 1, 1, 7, NotNullViolation; flix_season);
assert_episode!(&db, 1, 1, 3, 1, 1, 8, NotNullViolation; flix_episode);
assert_episode!(&db, 1, 1, 3, 1, 1, 9, NotNullViolation; last_update);
assert_episode!(&db, 1, 1, 3, 1, 1, 10, NotNullViolation; runtime);
}
}
+555
View File
@@ -0,0 +1,555 @@
//! This module contains entities for storing watched information
/// Collection entity
pub mod collections {
use flix_model::id::{CollectionId, RawId};
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a watched movie
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_watched_collections")]
pub struct Model {
/// The collection's ID
#[sea_orm(primary_key, auto_increment = false)]
pub id: CollectionId,
/// The user's ID
#[sea_orm(primary_key, auto_increment = false)]
pub user_id: RawId,
/// The date this collection was watched
pub watched_date: NaiveDate,
/// The info for this collection
#[sea_orm(belongs_to, relation_enum = "Info", from = "id", to = "id")]
pub info: HasOne<entity::info::collections::Entity>,
/// The content for this collection
#[sea_orm(belongs_to, relation_enum = "Content", from = "id", to = "id", skip_fk)]
pub content: HasOne<entity::content::collections::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Movie entity
pub mod movies {
use flix_model::id::{MovieId, RawId};
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a watched movie
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_watched_movies")]
pub struct Model {
/// The movie's ID
#[sea_orm(primary_key, auto_increment = false)]
pub id: MovieId,
/// The user's ID
#[sea_orm(primary_key, auto_increment = false)]
pub user_id: RawId,
/// The date this movie was watched
pub watched_date: NaiveDate,
/// The info for this movie
#[sea_orm(belongs_to, from = "id", to = "id")]
pub info: HasOne<entity::info::movies::Entity>,
/// The content for this movie
#[sea_orm(belongs_to, relation_enum = "Content", from = "id", to = "id", skip_fk)]
pub content: HasOne<entity::content::movies::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Show entity
pub mod shows {
use flix_model::id::{RawId, ShowId};
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a watched movie
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_watched_shows")]
pub struct Model {
/// The show's ID
#[sea_orm(primary_key, auto_increment = false)]
pub id: ShowId,
/// The user's ID
#[sea_orm(primary_key, auto_increment = false)]
pub user_id: RawId,
/// The date this show was watched
pub watched_date: NaiveDate,
/// The info for this show
#[sea_orm(belongs_to, relation_enum = "Info", from = "id", to = "id")]
pub info: HasOne<entity::info::shows::Entity>,
/// The content for this show
#[sea_orm(belongs_to, relation_enum = "Content", from = "id", to = "id", skip_fk)]
pub content: HasOne<entity::content::shows::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Season entity
pub mod seasons {
use flix_model::id::{RawId, ShowId};
use flix_model::numbers::SeasonNumber;
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a watched movie
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_watched_seasons")]
pub struct Model {
/// The season's show's ID
#[sea_orm(primary_key, auto_increment = false)]
pub show_id: ShowId,
/// The season's number
#[sea_orm(primary_key, auto_increment = false)]
pub season_number: SeasonNumber,
/// The user's ID
#[sea_orm(primary_key, auto_increment = false)]
pub user_id: RawId,
/// The date this season was watched
pub watched_date: NaiveDate,
/// The info for this season
#[sea_orm(
belongs_to,
relation_enum = "Info",
from = "(show_id, season_number)",
to = "(show_id, season_number)"
)]
pub info: HasOne<entity::info::seasons::Entity>,
/// The content for this season
#[sea_orm(
belongs_to,
relation_enum = "Content",
from = "(show_id, season_number)",
to = "(show_id, season_number)",
skip_fk
)]
pub content: HasOne<entity::content::seasons::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Episode entity
pub mod episodes {
use flix_model::id::{RawId, ShowId};
use flix_model::numbers::{EpisodeNumber, SeasonNumber};
use chrono::NaiveDate;
use sea_orm::entity::prelude::*;
use crate::entity;
/// The database representation of a watched movie
#[sea_orm::model]
#[derive(Debug, Clone, DeriveEntityModel)]
#[sea_orm(table_name = "flix_watched_episodes")]
pub struct Model {
/// The episode's show's ID
#[sea_orm(primary_key, auto_increment = false)]
pub show_id: ShowId,
/// The episode's season's number
#[sea_orm(primary_key, auto_increment = false)]
pub season_number: SeasonNumber,
/// The episode's number
#[sea_orm(primary_key, auto_increment = false)]
pub episode_number: EpisodeNumber,
/// The user's ID
#[sea_orm(primary_key, auto_increment = false)]
pub user_id: RawId,
/// The date this episode was watched
pub watched_date: NaiveDate,
/// The info for this episode
#[sea_orm(
belongs_to,
relation_enum = "Info",
from = "(show_id, season_number, episode_number)",
to = "(show_id, season_number, episode_number)"
)]
pub info: HasOne<entity::info::episodes::Entity>,
/// The content for this episode
#[sea_orm(
belongs_to,
relation_enum = "Content",
from = "(show_id, season_number, episode_number)",
to = "(show_id, season_number, episode_number)",
skip_fk
)]
pub content: HasOne<entity::content::episodes::Entity>,
}
impl ActiveModelBehavior for ActiveModel {}
}
/// Macros for creating watched entities
#[cfg(test)]
pub mod test {
macro_rules! make_watched_movie {
($db:expr, $id:literal, $user:literal) => {
$crate::entity::watched::movies::ActiveModel {
id: Set(::flix_model::id::MovieId::from_raw($id)),
user_id: Set($user),
watched_date: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_watched_movie;
macro_rules! make_watched_episode {
($db:expr, $show:literal, $season:literal, $episode:literal, $user:literal) => {
$crate::entity::watched::episodes::ActiveModel {
show_id: Set(::flix_model::id::ShowId::from_raw($show)),
season_number: Set($season),
episode_number: Set($episode),
user_id: Set($user),
watched_date: Set(::chrono::NaiveDate::from_yo_opt(1, 1).expect("from_yo_opt")),
}
.insert($db)
.await
.expect("insert");
};
}
pub(crate) use make_watched_episode;
}
#[cfg(test)]
mod tests {
use flix_model::id::{MovieId, ShowId};
use chrono::NaiveDate;
use sea_orm::ActiveValue::{NotSet, Set};
use sea_orm::Condition;
use sea_orm::entity::prelude::*;
use sea_orm::sqlx::error::ErrorKind;
use crate::entity::content::test::{
make_content_collection, make_content_episode, make_content_library, make_content_movie,
make_content_season, make_content_show,
};
use crate::entity::info::test::{
make_info_episode, make_info_movie, make_info_season, make_info_show,
};
use crate::tests::new_initialized_memory_db;
use super::super::tests::get_error_kind;
use super::super::tests::notsettable;
use super::test::{make_watched_episode, make_watched_movie};
#[tokio::test]
async fn use_test_macros() {
let db = new_initialized_memory_db().await;
make_info_movie!(&db, 1);
make_info_show!(&db, 1);
make_info_season!(&db, 1, 1);
make_info_episode!(&db, 1, 1, 1);
make_watched_movie!(&db, 1, 1);
make_watched_episode!(&db, 1, 1, 1, 1);
}
#[tokio::test]
async fn test_round_trip_movies() {
let db = new_initialized_memory_db().await;
macro_rules! assert_movie {
($db:expr, $id:literal, $uid:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_movie!(@insert, $db, $id, $uid $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.id, MovieId::from_raw($id));
assert_eq!(model.user_id, $uid);
assert_eq!(model.watched_date, NaiveDate::from_yo_opt($uid, 1).expect("from_yo_opt"));
};
($db:expr, $id:literal, $uid:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_movie!(@insert, $db, $id, $uid $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $id:literal, $uid:literal $(; $($skip:ident),+)?) => {
super::movies::ActiveModel {
id: notsettable!(id, MovieId::from_raw($id) $(, $($skip),+)?),
user_id: notsettable!(user_id, $uid $(, $($skip),+)?),
watched_date: notsettable!(watched_date, NaiveDate::from_yo_opt($uid, 1).expect("from_yo_opt") $(, $($skip),+)?),
}.insert($db).await
};
}
assert_movie!(&db, 1, 1, ForeignKeyViolation);
make_info_movie!(&db, 1);
assert_movie!(&db, 1, 1, Success);
assert_movie!(&db, 1, 2, Success);
assert_movie!(&db, 1, 1, UniqueViolation);
make_info_movie!(&db, 2);
assert_movie!(&db, 2, 1, Success);
assert_movie!(&db, 2, 2, Success);
assert_movie!(&db, 3, 1, NotNullViolation; id);
assert_movie!(&db, 4, 1, NotNullViolation; user_id);
assert_movie!(&db, 5, 1, NotNullViolation; watched_date);
}
#[tokio::test]
async fn test_round_trip_episodes() {
let db = new_initialized_memory_db().await;
macro_rules! assert_episode {
($db:expr, $show:literal, $season:literal, $episode:literal, $uid:literal, Success $(; $($skip:ident),+)?) => {
let model = assert_episode!(@insert, $db, $show, $season, $episode, $uid $(; $($skip),+)?)
.expect("insert");
assert_eq!(model.show_id, ShowId::from_raw($show));
assert_eq!(model.season_number, $season);
assert_eq!(model.episode_number, $episode);
assert_eq!(model.user_id, $uid);
assert_eq!(model.watched_date, NaiveDate::from_yo_opt($uid, 1).expect("from_yo_opt"));
};
($db:expr, $show:literal, $season:literal, $episode:literal, $uid:literal, $error:ident $(; $($skip:ident),+)?) => {
let model = assert_episode!(@insert, $db, $show, $season, $episode, $uid $(; $($skip),+)?)
.expect_err("insert");
assert_eq!(get_error_kind(model).expect("get_error_kind"), ErrorKind::$error);
};
(@insert, $db:expr, $show:literal, $season:literal, $episode:literal, $uid:literal $(; $($skip:ident),+)?) => {
super::episodes::ActiveModel {
show_id: notsettable!(show_id, ShowId::from_raw($show) $(, $($skip),+)?),
season_number: notsettable!(season_number, $season $(, $($skip),+)?),
episode_number: notsettable!(episode_number, $episode $(, $($skip),+)?),
user_id: notsettable!(user_id, $uid $(, $($skip),+)?),
watched_date: notsettable!(watched_date, NaiveDate::from_yo_opt($uid, 1).expect("from_yo_opt") $(, $($skip),+)?),
}.insert($db).await
};
}
make_info_show!(&db, 1);
make_info_season!(&db, 1, 1);
make_info_show!(&db, 2);
make_info_season!(&db, 2, 1);
assert_episode!(&db, 1, 1, 1, 1, ForeignKeyViolation);
assert_episode!(&db, 2, 1, 1, 1, ForeignKeyViolation);
make_info_episode!(&db, 1, 1, 1);
make_info_episode!(&db, 2, 1, 1);
assert_episode!(&db, 1, 1, 1, 1, Success);
assert_episode!(&db, 1, 1, 1, 2, Success);
assert_episode!(&db, 2, 1, 1, 1, Success);
assert_episode!(&db, 1, 1, 1, 1, UniqueViolation);
assert_episode!(&db, 3, 1, 1, 1, NotNullViolation; show_id);
assert_episode!(&db, 4, 1, 1, 1, NotNullViolation; season_number);
assert_episode!(&db, 5, 1, 1, 1, NotNullViolation; episode_number);
assert_episode!(&db, 6, 1, 1, 1, NotNullViolation; user_id);
assert_episode!(&db, 7, 1, 1, 1, NotNullViolation; watched_date);
}
#[tokio::test]
async fn test_query_seasons() {
let db = new_initialized_memory_db().await;
macro_rules! assert_season {
($db:expr, $show:literal, $season:literal, $uid:literal, Watched) => {
assert_season!(@find, $db, $show, $season, $uid)
.ok_or(())
.expect("is none");
};
($db:expr, $show:literal, $season:literal, $uid:literal, Unwatched) => {
assert_season!(@find, $db, $show, $season, $uid)
.ok_or(())
.expect_err("is some");
};
(@find, $db:expr, $show:literal, $season:literal, $uid:literal) => {
super::seasons::Entity::find()
.filter(
Condition::all()
.add(super::seasons::Column::ShowId.eq($show))
.add(super::seasons::Column::SeasonNumber.eq($season))
.add(super::seasons::Column::UserId.eq($uid)),
)
.one(&db)
.await
.expect("find.filter.one")
};
}
make_content_library!(&db, 1);
make_content_show!(&db, 1, 1, None);
make_content_season!(&db, 1, 1, 1);
assert_season!(&db, 1, 1, 1, Unwatched);
make_content_episode!(&db, 1, 1, 1, 1);
assert_season!(&db, 1, 1, 1, Unwatched);
make_watched_episode!(&db, 1, 1, 1, 1);
assert_season!(&db, 1, 1, 1, Watched);
assert_season!(&db, 1, 1, 2, Unwatched);
make_content_episode!(&db, 1, 1, 1, 2);
assert_season!(&db, 1, 1, 1, Unwatched);
make_content_season!(&db, 1, 1, 2);
make_content_episode!(&db, 1, 1, 2, 1);
make_content_episode!(&db, 1, 1, 2, 2, >1);
make_info_episode!(&db, 1, 2, 3);
make_content_episode!(&db, 1, 1, 2, 4);
assert_season!(&db, 1, 2, 1, Unwatched);
assert_season!(&db, 1, 2, 2, Unwatched);
assert_season!(&db, 1, 2, 3, Unwatched);
make_watched_episode!(&db, 1, 2, 1, 1);
make_watched_episode!(&db, 1, 2, 1, 2);
make_watched_episode!(&db, 1, 2, 2, 3);
assert_season!(&db, 1, 2, 1, Unwatched);
assert_season!(&db, 1, 2, 2, Unwatched);
assert_season!(&db, 1, 2, 3, Unwatched);
make_watched_episode!(&db, 1, 2, 2, 1);
make_watched_episode!(&db, 1, 2, 2, 2);
make_watched_episode!(&db, 1, 2, 1, 3);
assert_season!(&db, 1, 2, 1, Unwatched);
assert_season!(&db, 1, 2, 2, Unwatched);
assert_season!(&db, 1, 2, 3, Unwatched);
make_watched_episode!(&db, 1, 2, 4, 1);
assert_season!(&db, 1, 2, 1, Watched);
assert_season!(&db, 1, 2, 2, Unwatched);
assert_season!(&db, 1, 2, 3, Unwatched);
}
#[tokio::test]
async fn test_query_shows() {
let db = new_initialized_memory_db().await;
macro_rules! assert_show {
($db:expr, $show:literal, $uid:literal, Watched) => {
assert_show!(@find, $db, $show, $uid)
.ok_or(())
.expect("is none");
};
($db:expr, $show:literal, $uid:literal, Unwatched) => {
assert_show!(@find, $db, $show, $uid)
.ok_or(())
.expect_err("is some");
};
(@find, $db:expr, $show:literal, $uid:literal) => {
super::shows::Entity::find()
.filter(
Condition::all()
.add(super::shows::Column::Id.eq($show))
.add(super::shows::Column::UserId.eq($uid)),
)
.one(&db)
.await
.expect("find.filter.one")
};
}
make_content_library!(&db, 1);
make_content_show!(&db, 1, 1, None);
assert_show!(&db, 1, 1, Unwatched);
make_content_season!(&db, 1, 1, 1);
assert_show!(&db, 1, 1, Unwatched);
make_content_episode!(&db, 1, 1, 1, 1);
assert_show!(&db, 1, 1, Unwatched);
make_watched_episode!(&db, 1, 1, 1, 1);
assert_show!(&db, 1, 1, Watched);
assert_show!(&db, 1, 2, Unwatched);
make_content_episode!(&db, 1, 1, 1, 2);
assert_show!(&db, 1, 1, Unwatched);
assert_show!(&db, 1, 2, Unwatched);
make_watched_episode!(&db, 1, 1, 2, 1);
make_content_season!(&db, 1, 1, 2);
assert_show!(&db, 1, 1, Unwatched);
assert_show!(&db, 1, 2, Unwatched);
make_content_episode!(&db, 1, 1, 2, 1);
assert_show!(&db, 1, 1, Unwatched);
assert_show!(&db, 1, 2, Unwatched);
make_watched_episode!(&db, 1, 2, 1, 1);
assert_show!(&db, 1, 1, Watched);
assert_show!(&db, 1, 2, Unwatched);
}
#[tokio::test]
async fn test_query_collections() {
let db = new_initialized_memory_db().await;
macro_rules! assert_collection {
($db:expr, $id:literal, $uid:literal, Watched) => {
assert_collection!(@find, $db, $id, $uid)
.ok_or(())
.expect("is none");
};
($db:expr, $id:literal, $uid:literal, Unwatched) => {
assert_collection!(@find, $db, $id, $uid)
.ok_or(())
.expect_err("is some");
};
(@find, $db:expr, $id:literal, $uid:literal) => {
super::collections::Entity::find()
.filter(
Condition::all()
.add(super::collections::Column::Id.eq($id))
.add(super::collections::Column::UserId.eq($uid)),
)
.one(&db)
.await
.expect("find.filter.one")
};
}
make_content_library!(&db, 1);
make_content_collection!(&db, 1, 1, None);
assert_collection!(&db, 1, 1, Unwatched);
make_content_movie!(&db, 1, 1, Some(1));
assert_collection!(&db, 1, 1, Unwatched);
make_info_movie!(&db, 9999);
make_watched_movie!(&db, 9999, 1);
assert_collection!(&db, 1, 1, Unwatched);
make_watched_movie!(&db, 1, 1);
assert_collection!(&db, 1, 1, Watched);
make_content_collection!(&db, 1, 2, Some(1));
assert_collection!(&db, 1, 1, Watched);
assert_collection!(&db, 2, 1, Unwatched);
make_content_movie!(&db, 1, 2, Some(2));
assert_collection!(&db, 1, 1, Unwatched);
assert_collection!(&db, 2, 1, Unwatched);
make_watched_movie!(&db, 2, 1);
assert_collection!(&db, 1, 1, Watched);
assert_collection!(&db, 2, 1, Watched);
make_content_show!(&db, 1, 1, Some(2));
assert_collection!(&db, 1, 1, Unwatched);
assert_collection!(&db, 2, 1, Unwatched);
make_content_season!(&db, 1, 1, 1);
make_content_episode!(&db, 1, 1, 1, 1);
make_watched_episode!(&db, 1, 1, 1, 1);
assert_collection!(&db, 1, 1, Watched);
assert_collection!(&db, 2, 1, Watched);
}
}
+26
View File
@@ -0,0 +1,26 @@
//! flix-db provides types for storing persistent data about media
#![cfg_attr(docsrs, feature(doc_cfg))]
pub mod connection;
pub mod entity;
pub mod migration;
#[cfg(test)]
mod tests {
use sea_orm::{ConnectOptions, Database, DatabaseConnection};
use crate::connection::Connection;
pub async fn new_initialized_memory_db() -> DatabaseConnection {
let options = ConnectOptions::new("sqlite::memory:");
let db = Database::connect(options)
.await
.expect("Database::connect()");
let connection = Connection::try_from(db)
.await
.expect("Connection::try_from");
connection.take()
}
}
+34
View File
@@ -0,0 +1,34 @@
//! Adds watched views:
//! - Collections
//! - Shows
//! - Seasons
use sea_orm::{DbErr, DeriveMigrationName};
use sea_orm_migration::async_trait;
use sea_orm_migration::{MigrationTrait, SchemaManager};
mod collections;
mod seasons;
mod shows;
#[derive(DeriveMigrationName)]
pub(super) struct Migration;
#[async_trait::async_trait]
impl MigrationTrait for Migration {
async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
seasons::up(manager).await?;
shows::up(manager).await?;
collections::up(manager).await?;
Ok(())
}
async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
collections::down(manager).await?;
shows::down(manager).await?;
seasons::down(manager).await?;
Ok(())
}
}
@@ -0,0 +1,104 @@
use sea_orm::prelude::*;
use sea_orm::sea_query::Table;
use sea_orm::{ConnectionTrait, DbBackend, Statement};
use sea_orm_migration::prelude::*;
pub async fn up(manager: &SchemaManager<'_>) -> Result<(), DbErr> {
manager
.drop_table(Table::drop().table("flix_watched_collections").to_owned())
.await?;
manager
.get_connection()
.execute_raw(Statement::from_string(
DbBackend::Sqlite,
r#"
CREATE VIEW flix_watched_collections AS
WITH RECURSIVE
watched_items AS (
SELECT
w.id,
w.user_id,
w.watched_date,
'movie' AS type
FROM flix_watched_movies w
UNION ALL
SELECT
w.id,
w.user_id,
w.watched_date,
'show' AS type
FROM flix_watched_shows w
),
collection_items AS (
SELECT
m.parent_id,
m.id,
'movie' AS type
FROM flix_movies m
WHERE m.parent_id IS NOT NULL
UNION ALL
SELECT
s.parent_id,
s.id,
'show' AS type
FROM flix_shows s
WHERE s.parent_id IS NOT NULL
UNION ALL
SELECT
c.parent_id,
ci.id,
ci.type
FROM collection_items ci
JOIN flix_collections c
ON c.id = ci.parent_id
)
SELECT
ci.parent_id AS id,
wi.user_id,
MAX(wi.watched_date) AS watched_date
FROM collection_items ci
JOIN watched_items wi
ON wi.id = ci.id
AND wi.type = ci.type
WHERE NOT EXISTS (
SELECT 1
FROM collection_items ci2
WHERE ci2.parent_id = ci.parent_id
AND NOT EXISTS (
SELECT 1
FROM watched_items wi2
WHERE wi2.id = ci2.id
AND wi2.type = ci2.type
AND wi2.user_id = wi.user_id
)
)
GROUP BY ci.parent_id, wi.user_id
;
"#,
))
.await?;
Ok(())
}
pub async fn down(manager: &SchemaManager<'_>) -> Result<(), DbErr> {
manager
.get_connection()
.execute_raw(Statement::from_string(
DbBackend::Sqlite,
r#"
DROP VIEW flix_watched_collections
;
"#,
))
.await?;
Ok(())
}
@@ -0,0 +1,59 @@
use sea_orm::prelude::*;
use sea_orm::sea_query::Table;
use sea_orm::{ConnectionTrait, DbBackend, Statement};
use sea_orm_migration::prelude::*;
pub async fn up(manager: &SchemaManager<'_>) -> Result<(), DbErr> {
manager
.drop_table(Table::drop().table("flix_watched_seasons").to_owned())
.await?;
manager
.get_connection()
.execute_raw(Statement::from_string(
DbBackend::Sqlite,
r#"
CREATE VIEW flix_watched_seasons AS
SELECT
w.show_id,
w.season_number,
w.user_id,
MAX(w.watched_date) AS watched_date
FROM flix_watched_episodes w
WHERE NOT EXISTS (
SELECT 1
FROM flix_episodes e
WHERE e.show_id = w.show_id
AND e.season_number = w.season_number
AND NOT EXISTS (
SELECT 1
FROM flix_watched_episodes wc
WHERE wc.show_id = e.show_id
AND wc.season_number = e.season_number
AND wc.episode_number = e.episode_number
AND wc.user_id = w.user_id
)
)
GROUP BY w.show_id, w.season_number, w.user_id
;
"#,
))
.await?;
Ok(())
}
pub async fn down(manager: &SchemaManager<'_>) -> Result<(), DbErr> {
manager
.get_connection()
.execute_raw(Statement::from_string(
DbBackend::Sqlite,
r#"
DROP VIEW flix_watched_seasons
;
"#,
))
.await?;
Ok(())
}
+56
View File
@@ -0,0 +1,56 @@
use sea_orm::prelude::*;
use sea_orm::sea_query::Table;
use sea_orm::{ConnectionTrait, DbBackend, Statement};
use sea_orm_migration::prelude::*;
pub async fn up(manager: &SchemaManager<'_>) -> Result<(), DbErr> {
manager
.drop_table(Table::drop().table("flix_watched_shows").to_owned())
.await?;
manager
.get_connection()
.execute_raw(Statement::from_string(
DbBackend::Sqlite,
r#"
CREATE VIEW flix_watched_shows AS
SELECT
w.show_id as id,
w.user_id,
MAX(w.watched_date) AS watched_date
FROM flix_watched_seasons w
WHERE NOT EXISTS (
SELECT 1
FROM flix_seasons s
WHERE s.show_id = w.show_id
AND NOT EXISTS (
SELECT 1
FROM flix_watched_seasons wc
WHERE wc.show_id = s.show_id
AND wc.season_number = s.season_number
AND wc.user_id = w.user_id
)
)
GROUP BY w.show_id, w.user_id
;
"#,
))
.await?;
Ok(())
}
pub async fn down(manager: &SchemaManager<'_>) -> Result<(), DbErr> {
manager
.get_connection()
.execute_raw(Statement::from_string(
DbBackend::Sqlite,
r#"
DROP VIEW flix_watched_shows
;
"#,
))
.await?;
Ok(())
}
+6
View File
@@ -0,0 +1,6 @@
//! Migrations for maintaining the database schema
seamantic::migrations! {
"seaql_migrations_flix";
m_000001,
}
+13 -7
View File
@@ -1,9 +1,9 @@
[package] [package]
name = "flix" name = "flix"
version = "0.0.2" version = "0.0.14"
categories = [] categories = []
description = "Types for storing persistent data about media" description = "Mechanisms for interacting with flix media"
repository = "https://github.com/QuantumShade/flix" repository = "https://github.com/QuantumShade/flix"
authors.workspace = true authors.workspace = true
@@ -11,16 +11,22 @@ edition.workspace = true
license-file.workspace = true license-file.workspace = true
rust-version.workspace = true rust-version.workspace = true
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[lints] [lints]
workspace = true workspace = true
[features] [features]
default = [] default = []
tmdb = ["dep:flix-tmdb"] fs = ["dep:flix-fs"]
serde = ["flix-model/serde"]
tmdb = ["dep:flix-tmdb", "flix-db/tmdb"]
[dependencies] [dependencies]
flix-tmdb = { workspace = true, optional = true } flix-db = { workspace = true }
flix-model = { workspace = true }
chrono = { workspace = true, features = ["serde"] } flix-fs = { workspace = true, optional = true }
serde = { workspace = true, features = ["std", "derive"] } flix-tmdb = { workspace = true, optional = true }
thiserror = { workspace = true }
+1 -1
View File
@@ -2,4 +2,4 @@
[![Crates Version](https://img.shields.io/crates/v/flix.svg)](https://crates.io/crates/flix) [![Crates Version](https://img.shields.io/crates/v/flix.svg)](https://crates.io/crates/flix)
A library providing types for storing persistent data about media A library for interacting with flix media
+12 -3
View File
@@ -1,4 +1,13 @@
//! flix provides types for storing persistent data about media //! flix provides mechanisms for interacting with flix media
/// flix types #![cfg_attr(docsrs, feature(doc_cfg))]
pub mod model;
pub use flix_db as db;
pub use flix_model as model;
#[cfg(feature = "fs")]
#[cfg_attr(docsrs, doc(cfg(feature = "fs")))]
pub use flix_fs as fs;
#[cfg(feature = "tmdb")]
#[cfg_attr(docsrs, doc(cfg(feature = "tmdb")))]
pub use flix_tmdb as tmdb;
-30
View File
@@ -1,30 +0,0 @@
#[cfg(feature = "tmdb")]
use flix_tmdb::model::CollectionId;
/// A Collection container
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct Collection {
/// Generic collection data
pub collection: GenericCollection,
/// TMDB collection data
#[cfg(feature = "tmdb")]
pub tmdb: Option<TmdbCollection>,
}
/// The generic collection data
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct GenericCollection {
/// The collection's name
pub name: String,
/// The collection's overview
pub overview: String,
}
/// The TMDB collection data
#[cfg(feature = "tmdb")]
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct TmdbCollection {
/// The collection's TMDB ID
pub id: CollectionId,
}
-19
View File
@@ -1,19 +0,0 @@
use chrono::NaiveDate;
/// An Episode container
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct Episode {
/// The generic episode data
pub episode: GenericEpisode,
}
/// The generic episode data
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct GenericEpisode {
/// The episode's name
pub name: String,
/// The episode's overview
pub overview: String,
/// The episode's air date
pub air_date: NaiveDate,
}
-13
View File
@@ -1,13 +0,0 @@
mod collection;
mod episode;
mod movie;
mod season;
mod show;
mod verse;
pub use collection::*;
pub use episode::*;
pub use movie::*;
pub use season::*;
pub use show::*;
pub use verse::*;
-36
View File
@@ -1,36 +0,0 @@
#[cfg(feature = "tmdb")]
use flix_tmdb::model::{MovieGenreId, MovieId};
use chrono::NaiveDate;
/// A Movie container
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct Movie {
/// The generic movie data
pub movie: GenericMovie,
/// The TMDB movie data
#[cfg(feature = "tmdb")]
pub tmdb: Option<TmdbMovie>,
}
/// The generic movie data
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct GenericMovie {
/// The movie's title
pub title: String,
/// The movie's overview
pub overview: String,
/// The movie's release date
pub release_date: NaiveDate,
}
/// The TMDB movie data
#[cfg(feature = "tmdb")]
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct TmdbMovie {
/// The movie's TMDB ID
pub id: MovieId,
/// The list of genre TMDB IDs that the movie is associated with
pub genres: Vec<MovieGenreId>,
}
-19
View File
@@ -1,19 +0,0 @@
use chrono::NaiveDate;
/// A Season container
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct Season {
/// The generic season data
pub season: GenericSeason,
}
/// The generic season data
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct GenericSeason {
/// The season's name
pub name: String,
/// The season's overview
pub overview: String,
/// The season's air date
pub air_date: NaiveDate,
}
-36
View File
@@ -1,36 +0,0 @@
#[cfg(feature = "tmdb")]
use flix_tmdb::model::{ShowGenreId, ShowId};
use chrono::NaiveDate;
/// A Show container
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct Show {
/// The generic show data
pub show: GenericShow,
/// The TMDB show data
#[cfg(feature = "tmdb")]
pub tmdb: Option<TmdbShow>,
}
/// The generic show data
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct GenericShow {
/// The show's name
pub name: String,
/// The show's overview
pub overview: String,
/// The show's air date
pub air_date: NaiveDate,
}
/// The TMDB show data
#[cfg(feature = "tmdb")]
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct TmdbShow {
/// The show's TMDB ID
pub id: ShowId,
/// The list of genre TMDB IDs that the movie is associated with
pub genres: Vec<ShowGenreId>,
}
-32
View File
@@ -1,32 +0,0 @@
#[cfg(feature = "tmdb")]
use flix_tmdb::model::{MovieId, ShowId};
/// A Verse container
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct Verse {
/// The generic verse data
pub verse: GenericVerse,
/// The TMDB verse data
#[cfg(feature = "tmdb")]
pub tmdb: Option<TmdbVerse>,
}
/// The generic verse data
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct GenericVerse {
/// The verse's name
pub name: String,
/// The verse's overview
pub overview: String,
}
/// The TMDB verse data
#[cfg(feature = "tmdb")]
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct TmdbVerse {
/// The list of movie TMDB IDs in the verse
pub movies: Vec<MovieId>,
/// The list of show TMDB IDs in the verse
pub shows: Vec<ShowId>,
}
+28
View File
@@ -0,0 +1,28 @@
[package]
name = "flix-fs"
version = "0.0.14"
categories = []
description = "Filesystem scanner for flix media"
repository = "https://github.com/QuantumShade/flix"
authors.workspace = true
edition.workspace = true
license-file.workspace = true
rust-version.workspace = true
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[lints]
workspace = true
[dependencies]
flix-model = { workspace = true }
async-stream = { workspace = true }
regex = { workspace = true, features = ["std", "perf"] }
thiserror = { workspace = true }
tokio = { workspace = true }
tokio-stream = { workspace = true, features = ["fs"] }
+5
View File
@@ -0,0 +1,5 @@
# flix-fs
[![Crates Version](https://img.shields.io/crates/v/flix-fs.svg)](https://crates.io/crates/flix-fs)
A library providing filesystem scanners for flix media
+39
View File
@@ -0,0 +1,39 @@
use std::io;
/// The error type for filesystem scanning operations.
#[derive(Debug, thiserror::Error)]
pub enum Error {
/// fs::read_dir failed
#[error("fs::read_dir: {0}")]
ReadDir(io::Error),
/// fs::read_dir::next_entry failed
#[error("fs::read_dir::next_entry: {0}")]
ReadDirEntry(io::Error),
/// fs::read_dir::file_type failed
#[error("fs::read_dir::file_type: {0}")]
FileType(io::Error),
/// There is an unexpected file in the directory
#[error("unexpected file")]
UnexpectedFile,
/// There is an unexpected folder in the directory
#[error("unexpected folder")]
UnexpectedFolder,
/// There is an unexpected non-file item in the directory
#[error("unexpected non-file")]
UnexpectedNonFile,
/// There are multiple media files in the directory
#[error("duplicate media file")]
DuplicateMediaFile,
/// There are multiple poster files in the directory
#[error("duplicate poster file")]
DuplicatePosterFile,
/// The directory contains incomplete flix media
#[error("incomplete")]
Incomplete,
/// Some data is inconsistent with the folder structure
#[error("inconsistent")]
Inconsistent,
}
+23
View File
@@ -0,0 +1,23 @@
use std::path::PathBuf;
use crate::Error;
/// An item returned by scanner streams
#[derive(Debug)]
pub struct Item<T> {
/// The path of the item
pub path: PathBuf,
/// The event relating to the item
pub event: Result<T, Error>,
}
impl<T> Item<T> {
/// Helper function for mapping the inner event [Result]
#[inline]
pub fn map<U, F: FnOnce(T) -> U>(self, op: F) -> Item<U> {
Item {
path: self.path,
event: self.event.map(op),
}
}
}
+14
View File
@@ -0,0 +1,14 @@
//! flix-fs provides filesystem scanners for flix media
#![cfg_attr(docsrs, feature(doc_cfg))]
mod macros;
mod error;
pub use error::Error;
mod item;
pub use item::Item;
pub mod scanner;
+13
View File
@@ -0,0 +1,13 @@
macro_rules! is_media_extension {
() => {
Some("mp4" | "mkv")
};
}
pub(super) use is_media_extension;
macro_rules! is_image_extension {
() => {
Some("png" | "jpg")
};
}
pub(super) use is_image_extension;
+282
View File
@@ -0,0 +1,282 @@
//! The collection scanner will scan a folder and its children
use core::pin::Pin;
use std::ffi::OsStr;
use std::path::Path;
use flix_model::id::{CollectionId, MovieId, ShowId};
use flix_model::numbers::{EpisodeNumbers, SeasonNumber};
use async_stream::stream;
use tokio::fs;
use tokio_stream::Stream;
use tokio_stream::wrappers::ReadDirStream;
use crate::Error;
use crate::macros::is_image_extension;
use crate::scanner::{generic, movie, show};
/// A collection item
pub type Item = crate::Item<Scanner>;
/// The scanner for collections
pub enum Scanner {
/// A scanned collection
Collection {
/// The ID of the parent collection (if any)
parent: Option<CollectionId>,
/// The ID of the collection
id: CollectionId,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned movie
Movie {
/// The ID of the parent collection (if any)
parent: Option<CollectionId>,
/// The ID of the movie
id: MovieId,
/// The file name of the media file
media_file_name: String,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned show
Show {
/// The ID of the parent collection (if any)
parent: Option<CollectionId>,
/// The ID of the show
id: ShowId,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned episode
Season {
/// The ID of the show this season belongs to
show: ShowId,
/// The number of this season
season: SeasonNumber,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned episode
Episode {
/// The ID of the show this episode belongs to
show: ShowId,
/// The season this episode belongs to
season: SeasonNumber,
/// The number(s) of this episode
episode: EpisodeNumbers,
/// The file name of the media file
media_file_name: String,
/// The file name of the poster file
poster_file_name: Option<String>,
},
}
impl From<movie::Scanner> for Scanner {
fn from(value: movie::Scanner) -> Self {
match value {
movie::Scanner::Movie {
parent,
id,
media_file_name,
poster_file_name,
} => Self::Movie {
parent,
id,
media_file_name,
poster_file_name,
},
}
}
}
impl From<show::Scanner> for Scanner {
fn from(value: show::Scanner) -> Self {
match value {
show::Scanner::Show {
parent,
id,
poster_file_name,
} => Self::Show {
parent,
id,
poster_file_name,
},
show::Scanner::Season {
show,
season,
poster_file_name,
} => Self::Season {
show,
season,
poster_file_name,
},
show::Scanner::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
} => Self::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
},
}
}
}
impl From<generic::Scanner> for Scanner {
fn from(value: generic::Scanner) -> Self {
match value {
generic::Scanner::Collection {
parent,
id,
poster_file_name,
} => Self::Collection {
parent,
id,
poster_file_name,
},
generic::Scanner::Movie {
parent,
id,
media_file_name,
poster_file_name,
} => Self::Movie {
parent,
id,
media_file_name,
poster_file_name,
},
generic::Scanner::Show {
parent,
id,
poster_file_name,
} => Self::Show {
parent,
id,
poster_file_name,
},
generic::Scanner::Season {
show,
season,
poster_file_name,
} => Self::Season {
show,
season,
poster_file_name,
},
generic::Scanner::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
} => Self::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
},
}
}
}
impl Scanner {
/// Scan a folder for a collection
pub fn scan_collection(
path: &Path,
parent: Option<CollectionId>,
id: CollectionId,
) -> Pin<Box<impl Stream<Item = Item>>> {
Box::pin(stream!({
let dirs = match fs::read_dir(path).await {
Ok(dirs) => dirs,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDir(err)),
};
return;
}
};
let mut poster_file_name = None;
let mut subdirs_to_scan = Vec::new();
for await dir in ReadDirStream::new(dirs) {
match dir {
Ok(dir) => {
let filetype = match dir.file_type().await {
Ok(filetype) => filetype,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::FileType(err)),
};
continue;
}
};
let path = dir.path();
if filetype.is_dir() {
subdirs_to_scan.push(path);
continue;
}
match path.extension().and_then(OsStr::to_str) {
is_image_extension!() => {
if poster_file_name.is_some() {
yield Item {
path: path.to_owned(),
event: Err(Error::DuplicatePosterFile),
};
continue;
}
poster_file_name = path
.file_name()
.and_then(|s| s.to_str())
.map(ToOwned::to_owned);
}
Some(_) | None => {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFile),
};
}
}
}
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDirEntry(err)),
}
}
}
}
yield Item {
path: path.to_owned(),
event: Ok(Self::Collection {
parent,
id,
poster_file_name,
}),
};
for subdir in subdirs_to_scan {
for await event in generic::Scanner::scan_detect_folder(&subdir, Some(id)) {
yield event.map(|e| e.into());
}
}
}))
}
}
+147
View File
@@ -0,0 +1,147 @@
//! The episode scanner will scan a folder and exit
use std::ffi::OsStr;
use std::path::Path;
use flix_model::id::ShowId;
use flix_model::numbers::{EpisodeNumbers, SeasonNumber};
use async_stream::stream;
use tokio::fs;
use tokio_stream::Stream;
use tokio_stream::wrappers::ReadDirStream;
use crate::Error;
use crate::macros::{is_image_extension, is_media_extension};
/// An episode item
pub type Item = crate::Item<Scanner>;
/// The scanner for epispdes
pub enum Scanner {
/// A scanned episode
Episode {
/// The ID of the show this episode belongs to
show: ShowId,
/// The season this episode belongs to
season: SeasonNumber,
/// The number(s) of this episode
episode: EpisodeNumbers,
/// The file name of the media file
media_file_name: String,
/// The file name of the poster file
poster_file_name: Option<String>,
},
}
impl Scanner {
/// Scan a folder for an episode
pub fn scan_episode(
path: &Path,
show: ShowId,
season: SeasonNumber,
episode: EpisodeNumbers,
) -> impl Stream<Item = Item> {
stream!({
let dirs = match fs::read_dir(path).await {
Ok(dirs) => dirs,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDir(err)),
};
return;
}
};
let mut media_file_name = None;
let mut poster_file_name = None;
for await dir in ReadDirStream::new(dirs) {
match dir {
Ok(dir) => {
let filetype = match dir.file_type().await {
Ok(filetype) => filetype,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::FileType(err)),
};
continue;
}
};
if !filetype.is_file() {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedNonFile),
};
continue;
}
let path = dir.path();
match path.extension().and_then(OsStr::to_str) {
is_media_extension!() => {
if media_file_name.is_some() {
yield Item {
path: path.to_owned(),
event: Err(Error::DuplicateMediaFile),
};
continue;
}
media_file_name = path
.file_name()
.and_then(|s| s.to_str())
.map(ToOwned::to_owned);
continue;
}
is_image_extension!() => {
if poster_file_name.is_some() {
yield Item {
path: path.to_owned(),
event: Err(Error::DuplicatePosterFile),
};
continue;
}
poster_file_name = path
.file_name()
.and_then(|s| s.to_str())
.map(ToOwned::to_owned);
}
Some(_) | None => {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFile),
};
}
}
}
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDirEntry(err)),
}
}
}
}
let Some(media_file_name) = media_file_name else {
yield Item {
path: path.to_owned(),
event: Err(Error::Incomplete),
};
return;
};
yield Item {
path: path.to_owned(),
event: Ok(Self::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
}),
};
})
}
}
+333
View File
@@ -0,0 +1,333 @@
//! The generic scanner will scan a directory and automatically
//! detect the type of media, deferring to the correct scanner.
use std::ffi::OsStr;
use std::path::Path;
use std::sync::OnceLock;
use flix_model::id::{CollectionId, MovieId, RawId, ShowId};
use flix_model::numbers::{EpisodeNumbers, SeasonNumber};
use async_stream::stream;
use regex::Regex;
use tokio::fs;
use tokio_stream::Stream;
use tokio_stream::wrappers::ReadDirStream;
use crate::Error;
use crate::scanner::{collection, movie, show};
static MEDIA_FOLDER_REGEX: OnceLock<Regex> = OnceLock::new();
static SEASON_FOLDER_REGEX: OnceLock<Regex> = OnceLock::new();
/// A collection item
pub type Item = crate::Item<Scanner>;
/// The scanner for collections
pub enum Scanner {
/// A scanned collection
Collection {
/// The ID of the parent collection (if any)
parent: Option<CollectionId>,
/// The ID of the collection
id: CollectionId,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned movie
Movie {
/// The ID of the parent collection (if any)
parent: Option<CollectionId>,
/// The ID of the movie
id: MovieId,
/// The file name of the media file
media_file_name: String,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned show
Show {
/// The ID of the parent collection (if any)
parent: Option<CollectionId>,
/// The ID of the show
id: ShowId,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned episode
Season {
/// The ID of the show this season belongs to
show: ShowId,
/// The season this episode belongs to
season: SeasonNumber,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned episode
Episode {
/// The ID of the show this episode belongs to
show: ShowId,
/// The season this episode belongs to
season: SeasonNumber,
/// The number(s) of this episode
episode: EpisodeNumbers,
/// The file name of the media file
media_file_name: String,
/// The file name of the poster file
poster_file_name: Option<String>,
},
}
impl From<collection::Scanner> for Scanner {
fn from(value: collection::Scanner) -> Self {
match value {
collection::Scanner::Collection {
parent,
id,
poster_file_name,
} => Self::Collection {
parent,
id,
poster_file_name,
},
collection::Scanner::Movie {
parent,
id,
media_file_name,
poster_file_name,
} => Self::Movie {
parent,
id,
media_file_name,
poster_file_name,
},
collection::Scanner::Show {
parent,
id,
poster_file_name,
} => Self::Show {
parent,
id,
poster_file_name,
},
collection::Scanner::Season {
show,
season,
poster_file_name,
} => Self::Season {
show,
season,
poster_file_name,
},
collection::Scanner::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
} => Self::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
},
}
}
}
impl From<movie::Scanner> for Scanner {
fn from(value: movie::Scanner) -> Self {
match value {
movie::Scanner::Movie {
parent,
id,
media_file_name,
poster_file_name,
} => Self::Movie {
parent,
id,
media_file_name,
poster_file_name,
},
}
}
}
impl From<show::Scanner> for Scanner {
fn from(value: show::Scanner) -> Self {
match value {
show::Scanner::Show {
parent,
id,
poster_file_name,
} => Self::Show {
parent,
id,
poster_file_name,
},
show::Scanner::Season {
show,
season,
poster_file_name,
} => Self::Season {
show,
season,
poster_file_name,
},
show::Scanner::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
} => Self::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
},
}
}
}
impl Scanner {
/// Detect the type of a folder and call the correct scanner. Use
/// this only for detecting possibly ambiguous media:
/// - Collections
/// - Movies
/// - Shows
pub fn scan_detect_folder(
path: &Path,
parent: Option<CollectionId>,
) -> impl Stream<Item = Item> {
enum MediaType {
Collection,
Movie,
Show,
}
let media_folder_re = MEDIA_FOLDER_REGEX.get_or_init(|| {
Regex::new(r"^[[[:alnum:]] -]+ \([[:digit:]]+\) \[[[:digit:]]+\]$")
.unwrap_or_else(|err| panic!("regex is invalid: {err}"))
});
let season_folder_re = SEASON_FOLDER_REGEX.get_or_init(|| {
Regex::new(r"^S[[:digit:]]+$").unwrap_or_else(|err| panic!("regex is invalid: {err}"))
});
stream!({
let Some(dir_name) = path.file_name().and_then(OsStr::to_str) else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
return;
};
let Some(Ok(id)) = dir_name
.split_once('[')
.and_then(|(_, s)| s.split_once(']'))
.map(|(s, _)| s.parse::<RawId>())
else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
return;
};
let media_type: MediaType;
if media_folder_re.is_match(dir_name) {
let dirs = match fs::read_dir(path).await {
Ok(dirs) => dirs,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDir(err)),
};
return;
}
};
let mut is_show = false;
for await dir in ReadDirStream::new(dirs) {
match dir {
Ok(dir) => {
let filetype = match dir.file_type().await {
Ok(filetype) => filetype,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::FileType(err)),
};
continue;
}
};
if !filetype.is_dir() {
continue;
}
let dir_path = dir.path();
let Some(folder_name) = dir_path.file_name().and_then(OsStr::to_str)
else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
continue;
};
if season_folder_re.is_match(folder_name) {
is_show = true;
break;
}
}
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDirEntry(err)),
};
}
}
}
if is_show {
media_type = MediaType::Show;
} else {
media_type = MediaType::Movie;
}
} else {
media_type = MediaType::Collection;
}
match media_type {
MediaType::Collection => {
for await event in collection::Scanner::scan_collection(
path,
parent,
CollectionId::from_raw(id),
) {
yield event.map(|e| e.into());
}
}
MediaType::Movie => {
for await event in
movie::Scanner::scan_movie(path, parent, MovieId::from_raw(id))
{
yield event.map(|e| e.into());
}
}
MediaType::Show => {
for await event in show::Scanner::scan_show(path, parent, ShowId::from_raw(id))
{
yield event.map(|e| e.into());
}
}
}
})
}
}
+83
View File
@@ -0,0 +1,83 @@
//! The library scanner will scan an entire directory using the generic
//! scanner
use std::ffi::OsStr;
use std::path::Path;
use async_stream::stream;
use tokio::fs;
use tokio_stream::Stream;
use tokio_stream::wrappers::ReadDirStream;
use crate::Error;
use crate::scanner::generic;
/// A library item
pub type Item = crate::Item<generic::Scanner>;
/// The scanner for collections
pub enum Scanner {}
impl Scanner {
/// Scan a folder for a library
pub fn scan_library(path: &Path) -> impl Stream<Item = Item> {
stream!({
let dirs = match fs::read_dir(path).await {
Ok(dirs) => dirs,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDir(err)),
};
return;
}
};
let mut subdirs_to_scan = Vec::new();
for await dir in ReadDirStream::new(dirs) {
match dir {
Ok(dir) => {
let filetype = match dir.file_type().await {
Ok(filetype) => filetype,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::FileType(err)),
};
continue;
}
};
let path = dir.path();
if filetype.is_dir() {
subdirs_to_scan.push(path);
continue;
}
match path.extension().and_then(OsStr::to_str) {
Some(_) | None => {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFile),
};
}
}
}
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDirEntry(err)),
}
}
}
}
for subdir in subdirs_to_scan {
for await event in generic::Scanner::scan_detect_folder(&subdir, None) {
yield event;
}
}
})
}
}
+16
View File
@@ -0,0 +1,16 @@
//! This module contains all of the filesystem scanner modules
//!
//! The most common scanner to use is [generic::Scanner] which will
//! automatically detect and use the appropriate scanner.
pub mod library;
pub mod generic;
pub mod collection;
pub mod movie;
pub mod episode;
pub mod season;
pub mod show;
+142
View File
@@ -0,0 +1,142 @@
//! The movie scanner will scan a folder and exit
use std::ffi::OsStr;
use std::path::Path;
use flix_model::id::{CollectionId, MovieId};
use async_stream::stream;
use tokio::fs;
use tokio_stream::Stream;
use tokio_stream::wrappers::ReadDirStream;
use crate::Error;
use crate::macros::{is_image_extension, is_media_extension};
/// An movie item
pub type Item = crate::Item<Scanner>;
/// The scanner for movies
pub enum Scanner {
/// A scanned movie
Movie {
/// The ID of the parent collection (if any)
parent: Option<CollectionId>,
/// The ID of the movie
id: MovieId,
/// The file name of the media file
media_file_name: String,
/// The file name of the poster file
poster_file_name: Option<String>,
},
}
impl Scanner {
/// Scan a folder for a movie
pub fn scan_movie(
path: &Path,
parent: Option<CollectionId>,
id: MovieId,
) -> impl Stream<Item = Item> {
stream!({
let dirs = match fs::read_dir(path).await {
Ok(dirs) => dirs,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDir(err)),
};
return;
}
};
let mut media_file_name = None;
let mut poster_file_name = None;
for await dir in ReadDirStream::new(dirs) {
match dir {
Ok(dir) => {
let filetype = match dir.file_type().await {
Ok(filetype) => filetype,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::FileType(err)),
};
continue;
}
};
if !filetype.is_file() {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedNonFile),
};
continue;
}
let path = dir.path();
match path.extension().and_then(OsStr::to_str) {
is_media_extension!() => {
if media_file_name.is_some() {
yield Item {
path: path.to_owned(),
event: Err(Error::DuplicateMediaFile),
};
continue;
}
media_file_name = path
.file_name()
.and_then(|s| s.to_str())
.map(ToOwned::to_owned);
continue;
}
is_image_extension!() => {
if poster_file_name.is_some() {
yield Item {
path: path.to_owned(),
event: Err(Error::DuplicatePosterFile),
};
continue;
}
poster_file_name = path
.file_name()
.and_then(|s| s.to_str())
.map(ToOwned::to_owned);
}
Some(_) | None => {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFile),
};
}
}
}
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDirEntry(err)),
}
}
}
}
let Some(media_file_name) = media_file_name else {
yield Item {
path: path.to_owned(),
event: Err(Error::Incomplete),
};
return;
};
yield Item {
path: path.to_owned(),
event: Ok(Self::Movie {
parent,
id,
media_file_name,
poster_file_name,
}),
};
})
}
}
+218
View File
@@ -0,0 +1,218 @@
//! The episode scanner will scan a folder and its children
use std::ffi::OsStr;
use std::path::Path;
use flix_model::id::ShowId;
use flix_model::numbers::{EpisodeNumber, EpisodeNumbers, SeasonNumber};
use async_stream::stream;
use tokio::fs;
use tokio_stream::Stream;
use tokio_stream::wrappers::ReadDirStream;
use crate::Error;
use crate::macros::is_image_extension;
use crate::scanner::episode;
/// A season item
pub type Item = crate::Item<Scanner>;
/// The scanner for seasons
pub enum Scanner {
/// A scanned episode
Season {
/// The ID of the show this season belongs to
show: ShowId,
/// The season this episode belongs to
season: SeasonNumber,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned episode
Episode {
/// The ID of the show this episode belongs to
show: ShowId,
/// The season this episode belongs to
season: SeasonNumber,
/// The number(s) of this episode
episode: EpisodeNumbers,
/// The file name of the media file
media_file_name: String,
/// The file name of the poster file
poster_file_name: Option<String>,
},
}
impl From<episode::Scanner> for Scanner {
fn from(value: episode::Scanner) -> Self {
match value {
episode::Scanner::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
} => Self::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
},
}
}
}
impl Scanner {
/// Scan a folder for a season and its episodes
pub fn scan_season(
path: &Path,
show: ShowId,
season: SeasonNumber,
) -> impl Stream<Item = Item> {
stream!({
let dirs = match fs::read_dir(path).await {
Ok(dirs) => dirs,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDir(err)),
};
return;
}
};
let mut poster_file_name = None;
let mut episode_dirs_to_scan = Vec::new();
for await dir in ReadDirStream::new(dirs) {
match dir {
Ok(dir) => {
let filetype = match dir.file_type().await {
Ok(filetype) => filetype,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::FileType(err)),
};
continue;
}
};
let path = dir.path();
if filetype.is_dir() {
episode_dirs_to_scan.push(path);
continue;
}
match path.extension().and_then(OsStr::to_str) {
is_image_extension!() => {
if poster_file_name.is_some() {
yield Item {
path: path.to_owned(),
event: Err(Error::DuplicatePosterFile),
};
continue;
}
poster_file_name = path
.file_name()
.and_then(|s| s.to_str())
.map(ToOwned::to_owned);
}
Some(_) | None => {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFile),
};
}
}
}
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDirEntry(err)),
}
}
}
}
yield Item {
path: path.to_owned(),
event: Ok(Self::Season {
show,
season,
poster_file_name,
}),
};
for episode_dir in episode_dirs_to_scan {
let Some(episode_dir_name) = episode_dir.file_name().and_then(OsStr::to_str) else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
continue;
};
let Some((_, s_e_str)) = episode_dir_name.split_once('S') else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
continue;
};
let Some((s_str, e_str)) = s_e_str.split_once('E') else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
continue;
};
let Ok(season_number) = s_str.parse::<SeasonNumber>() else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
continue;
};
if season_number != season {
yield Item {
path: path.to_owned(),
event: Err(Error::Inconsistent),
};
continue;
}
let Ok(episode_numbers) = e_str
.split('E')
.map(|s| s.parse::<EpisodeNumber>())
.collect::<Result<Vec<_>, _>>()
else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
continue;
};
let Ok(episode_numbers) = EpisodeNumbers::try_from(episode_numbers.as_ref()) else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
continue;
};
for await event in episode::Scanner::scan_episode(
&episode_dir,
show,
season_number,
episode_numbers,
) {
yield event.map(|e| e.into());
}
}
})
}
}
+193
View File
@@ -0,0 +1,193 @@
//! The show scanner will scan a folder and its children
use std::ffi::OsStr;
use std::path::Path;
use flix_model::id::{CollectionId, ShowId};
use flix_model::numbers::{EpisodeNumbers, SeasonNumber};
use async_stream::stream;
use tokio::fs;
use tokio_stream::Stream;
use tokio_stream::wrappers::ReadDirStream;
use crate::Error;
use crate::macros::is_image_extension;
use crate::scanner::season;
/// A show item
pub type Item = crate::Item<Scanner>;
/// The scanner for shows
pub enum Scanner {
/// A scanned show
Show {
/// The ID of the parent collection (if any)
parent: Option<CollectionId>,
/// The ID of the show
id: ShowId,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned episode
Season {
/// The ID of the show this season belongs to
show: ShowId,
/// The season this episode belongs to
season: SeasonNumber,
/// The file name of the poster file
poster_file_name: Option<String>,
},
/// A scanned episode
Episode {
/// The ID of the show this episode belongs to
show: ShowId,
/// The season this episode belongs to
season: SeasonNumber,
/// The number(s) of this episode
episode: EpisodeNumbers,
/// The file name of the media file
media_file_name: String,
/// The file name of the poster file
poster_file_name: Option<String>,
},
}
impl From<season::Scanner> for Scanner {
fn from(value: season::Scanner) -> Self {
match value {
season::Scanner::Season {
show,
season,
poster_file_name,
} => Self::Season {
show,
season,
poster_file_name,
},
season::Scanner::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
} => Self::Episode {
show,
season,
episode,
media_file_name,
poster_file_name,
},
}
}
}
impl Scanner {
/// Scan a folder for a show and its seasons/episodes
pub fn scan_show(
path: &Path,
parent: Option<CollectionId>,
id: ShowId,
) -> impl Stream<Item = Item> {
stream!({
let dirs = match fs::read_dir(path).await {
Ok(dirs) => dirs,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDir(err)),
};
return;
}
};
let mut poster_file_name = None;
let mut season_dirs_to_scan = Vec::new();
for await dir in ReadDirStream::new(dirs) {
match dir {
Ok(dir) => {
let filetype = match dir.file_type().await {
Ok(filetype) => filetype,
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::FileType(err)),
};
continue;
}
};
let path = dir.path();
if filetype.is_dir() {
season_dirs_to_scan.push(path);
continue;
}
match path.extension().and_then(OsStr::to_str) {
is_image_extension!() => {
if poster_file_name.is_some() {
yield Item {
path: path.to_owned(),
event: Err(Error::DuplicatePosterFile),
};
continue;
}
poster_file_name = path
.file_name()
.and_then(|s| s.to_str())
.map(ToOwned::to_owned);
}
Some(_) | None => {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFile),
};
}
}
}
Err(err) => {
yield Item {
path: path.to_owned(),
event: Err(Error::ReadDirEntry(err)),
}
}
}
}
yield Item {
path: path.to_owned(),
event: Ok(Self::Show {
parent,
id,
poster_file_name,
}),
};
for season_dir in season_dirs_to_scan {
let Some(season_dir_name) = season_dir.file_name().and_then(OsStr::to_str) else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
continue;
};
let Some(Ok(season_number)) = season_dir_name
.split_once('S')
.map(|(_, s)| s.parse::<SeasonNumber>())
else {
yield Item {
path: path.to_owned(),
event: Err(Error::UnexpectedFolder),
};
continue;
};
for await event in season::Scanner::scan_season(&season_dir, id, season_number) {
yield event.map(|e| e.into());
}
}
})
}
}
+29
View File
@@ -0,0 +1,29 @@
[package]
name = "flix-model"
version = "0.0.14"
categories = []
description = "Core types for flix data"
repository = "https://github.com/QuantumShade/flix"
authors.workspace = true
edition.workspace = true
license-file.workspace = true
rust-version.workspace = true
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[lints]
workspace = true
[features]
default = []
serde = ["dep:serde"]
[dependencies]
seamantic = { workspace = true }
serde = { workspace = true, optional = true, features = ["std", "derive"] }
thiserror = { workspace = true }
+5
View File
@@ -0,0 +1,5 @@
# flix-model
[![Crates Version](https://img.shields.io/crates/v/flix-model.svg)](https://crates.io/crates/flix-model)
A library providing core types for flix data
+26
View File
@@ -0,0 +1,26 @@
//! This module contains types relating to flix media IDs
use seamantic::model::id::Id;
/// Type alias for the raw ID representation
pub use seamantic::model::id::SeaOrmRepr as RawId;
#[doc(hidden)]
pub enum Library {}
/// Type alias for a library ID
pub type LibraryId = Id<Library>;
#[doc(hidden)]
pub enum Collection {}
/// Type alias for a collection ID
pub type CollectionId = Id<Collection>;
#[doc(hidden)]
pub enum Movie {}
/// Type alias for a movie ID
pub type MovieId = Id<Movie>;
#[doc(hidden)]
pub enum Show {}
/// Type alias for a show ID
pub type ShowId = Id<Show>;
+6
View File
@@ -0,0 +1,6 @@
//! flix-model provides core types for flix data
#![cfg_attr(docsrs, feature(doc_cfg))]
pub mod id;
pub mod numbers;
+60
View File
@@ -0,0 +1,60 @@
//! This module contains season and episode numbers and related errors
use core::ops::RangeInclusive;
use std::collections::HashSet;
/// Type alias for representing season numbers
pub type SeasonNumber = u32;
/// Type alias for representing episode numbers
pub type EpisodeNumber = u32;
/// Potential errors when building EpisodeNumbers
#[derive(Debug, thiserror::Error)]
pub enum Error {
/// There are no episodes
#[error("zero episodes")]
Zero,
/// There are gaps in the episodes
#[error("noncontiguous episodes")]
Noncontiguous,
}
/// A wrapper for handling single and multi-episode entries
#[derive(Debug)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct EpisodeNumbers(RangeInclusive<EpisodeNumber>);
impl TryFrom<&[EpisodeNumber]> for EpisodeNumbers {
type Error = Error;
fn try_from(value: &[EpisodeNumber]) -> Result<Self, Self::Error> {
match value {
[] => Err(Error::Zero),
[n] => Ok(Self(*n..=*n)),
_ => {
// min and max will always exist
let min = value.iter().copied().min().unwrap_or_default();
let max = value.iter().copied().max().unwrap_or_default();
let len = value.len();
if usize::try_from(max.saturating_sub(min).saturating_add(1)) != Ok(len) {
return Err(Error::Noncontiguous);
}
let set: HashSet<_> = value.iter().copied().collect();
if set.len() != len {
return Err(Error::Noncontiguous);
}
Ok(Self(min..=max))
}
}
}
}
impl EpisodeNumbers {
/// Get the range of episodes
pub fn as_range(&self) -> &RangeInclusive<EpisodeNumber> {
&self.0
}
}
+18 -1
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "flix-tmdb" name = "flix-tmdb"
version = "0.0.2" version = "0.0.14"
categories = [] categories = []
description = "Clients and models for fetching data from TMDB" description = "Clients and models for fetching data from TMDB"
@@ -11,13 +11,30 @@ edition.workspace = true
license-file.workspace = true license-file.workspace = true
rust-version.workspace = true rust-version.workspace = true
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[lints] [lints]
workspace = true workspace = true
[features]
default = []
sea-orm = ["dep:sea-orm"]
[dependencies] [dependencies]
flix-model = { workspace = true }
chrono = { workspace = true, features = ["serde"] } chrono = { workspace = true, features = ["serde"] }
governor = { workspace = true, features = ["std", "jitter"] }
nonzero_ext = { workspace = true }
reqwest = { workspace = true, features = ["json", "rustls-tls"] } reqwest = { workspace = true, features = ["json", "rustls-tls"] }
serde = { workspace = true, features = ["derive"] } serde = { workspace = true, features = ["derive"] }
thiserror = { workspace = true } thiserror = { workspace = true }
url = { workspace = true } url = { workspace = true }
url-macro = { workspace = true } url-macro = { workspace = true }
sea-orm = { workspace = true, optional = true }
[dev-dependencies]
serde_test = { workspace = true }
+16 -2
View File
@@ -1,7 +1,13 @@
//! Collections API
use core::time::Duration;
use std::rc::Rc; use std::rc::Rc;
use governor::Jitter;
use crate::Config; use crate::Config;
use crate::model::{Collection, CollectionId}; use crate::model::Collection;
use crate::model::id::CollectionId;
use super::{Error, make_request}; use super::{Error, make_request};
@@ -24,12 +30,20 @@ impl Client {
id: impl Into<CollectionId>, id: impl Into<CollectionId>,
language: Option<&str>, language: Option<&str>,
) -> Result<Collection, Error> { ) -> Result<Collection, Error> {
self.config
.limiter
.until_ready_with_jitter(Jitter::new(
Duration::from_millis(0),
Duration::from_millis(50),
))
.await;
Ok(self Ok(self
.config .config
.client .client
.execute(make_request( .execute(make_request(
&self.config, &self.config,
&format!("/3/collection/{}", id.into()), &format!("/3/collection/{}", id.into().into_raw()),
language, language,
)?) )?)
.await? .await?
+20 -4
View File
@@ -1,7 +1,15 @@
//! Episodes API
use core::time::Duration;
use std::rc::Rc; use std::rc::Rc;
use flix_model::numbers::{EpisodeNumber, SeasonNumber};
use governor::Jitter;
use crate::Config; use crate::Config;
use crate::model::{Episode, ShowId}; use crate::model::Episode;
use crate::model::id::ShowId;
use super::{Error, make_request}; use super::{Error, make_request};
@@ -22,10 +30,18 @@ impl Client {
pub async fn get_details( pub async fn get_details(
&self, &self,
id: impl Into<ShowId>, id: impl Into<ShowId>,
season: impl Into<i32>, season: impl Into<SeasonNumber>,
episode: impl Into<i32>, episode: impl Into<EpisodeNumber>,
language: Option<&str>, language: Option<&str>,
) -> Result<Episode, Error> { ) -> Result<Episode, Error> {
self.config
.limiter
.until_ready_with_jitter(Jitter::new(
Duration::from_millis(0),
Duration::from_millis(50),
))
.await;
Ok(self Ok(self
.config .config
.client .client
@@ -33,7 +49,7 @@ impl Client {
&self.config, &self.config,
&format!( &format!(
"/3/tv/{}/season/{}/episode/{}", "/3/tv/{}/season/{}/episode/{}",
id.into(), id.into().into_raw(),
season.into(), season.into(),
episode.into() episode.into()
), ),
-58
View File
@@ -1,58 +0,0 @@
use std::rc::Rc;
use crate::Config;
use crate::model::{MovieGenre, ShowGenre};
use super::{Error, make_request};
/// TMDB Genre API client
pub struct Client {
config: Rc<Config>,
}
impl Client {
/// Create a new client with the given configuration
pub fn new(config: Rc<Config>) -> Self {
Self { config }
}
}
impl Client {
/// Fetch the list of all valid movie genres
pub async fn get_movie_genres(&self, language: Option<&str>) -> Result<Vec<MovieGenre>, Error> {
#[derive(Debug, serde::Deserialize)]
struct Genres {
genres: Vec<MovieGenre>,
}
let genres: Genres = self
.config
.client
.execute(make_request(&self.config, "/3/genre/movie/list", language)?)
.await?
.error_for_status()?
.json()
.await?;
Ok(genres.genres)
}
/// Fetch the list of all valid show genres
pub async fn get_tv_genres(&self, language: Option<&str>) -> Result<Vec<ShowGenre>, Error> {
#[derive(Debug, serde::Deserialize)]
struct Genres {
genres: Vec<ShowGenre>,
}
let genres: Genres = self
.config
.client
.execute(make_request(&self.config, "/3/genre/tv/list", language)?)
.await?
.error_for_status()?
.json()
.await?;
Ok(genres.genres)
}
}
+2 -7
View File
@@ -1,19 +1,14 @@
//! TMDB API clients
use reqwest::Request; use reqwest::Request;
use reqwest::header; use reqwest::header;
use crate::Config; use crate::Config;
/// Collections API
pub mod collections; pub mod collections;
/// Episodes API
pub mod episodes; pub mod episodes;
/// Genres API
pub mod genres;
/// Movies API
pub mod movies; pub mod movies;
/// Seasons API
pub mod seasons; pub mod seasons;
/// Shows API
pub mod shows; pub mod shows;
/// A generic error wrapping Url and Reqwest errors /// A generic error wrapping Url and Reqwest errors
+16 -2
View File
@@ -1,7 +1,13 @@
//! Movies API
use core::time::Duration;
use std::rc::Rc; use std::rc::Rc;
use governor::Jitter;
use crate::Config; use crate::Config;
use crate::model::{Movie, MovieId}; use crate::model::Movie;
use crate::model::id::MovieId;
use super::{Error, make_request}; use super::{Error, make_request};
@@ -24,12 +30,20 @@ impl Client {
id: impl Into<MovieId>, id: impl Into<MovieId>,
language: Option<&str>, language: Option<&str>,
) -> Result<Movie, Error> { ) -> Result<Movie, Error> {
self.config
.limiter
.until_ready_with_jitter(Jitter::new(
Duration::from_millis(0),
Duration::from_millis(50),
))
.await;
Ok(self Ok(self
.config .config
.client .client
.execute(make_request( .execute(make_request(
&self.config, &self.config,
&format!("/3/movie/{}", id.into()), &format!("/3/movie/{}", id.into().into_raw()),
language, language,
)?) )?)
.await? .await?
+19 -3
View File
@@ -1,7 +1,15 @@
//! Seasons API
use core::time::Duration;
use std::rc::Rc; use std::rc::Rc;
use flix_model::numbers::SeasonNumber;
use governor::Jitter;
use crate::Config; use crate::Config;
use crate::model::{Season, ShowId}; use crate::model::Season;
use crate::model::id::ShowId;
use super::{Error, make_request}; use super::{Error, make_request};
@@ -22,15 +30,23 @@ impl Client {
pub async fn get_details( pub async fn get_details(
&self, &self,
id: impl Into<ShowId>, id: impl Into<ShowId>,
season: impl Into<i32>, season: impl Into<SeasonNumber>,
language: Option<&str>, language: Option<&str>,
) -> Result<Season, Error> { ) -> Result<Season, Error> {
self.config
.limiter
.until_ready_with_jitter(Jitter::new(
Duration::from_millis(0),
Duration::from_millis(50),
))
.await;
Ok(self Ok(self
.config .config
.client .client
.execute(make_request( .execute(make_request(
&self.config, &self.config,
&format!("/3/tv/{}/season/{}", id.into(), season.into()), &format!("/3/tv/{}/season/{}", id.into().into_raw(), season.into()),
language, language,
)?) )?)
.await? .await?
+16 -2
View File
@@ -1,7 +1,13 @@
//! Shows API
use core::time::Duration;
use std::rc::Rc; use std::rc::Rc;
use governor::Jitter;
use crate::Config; use crate::Config;
use crate::model::{Show, ShowId}; use crate::model::Show;
use crate::model::id::ShowId;
use super::{Error, make_request}; use super::{Error, make_request};
@@ -24,12 +30,20 @@ impl Client {
id: impl Into<ShowId>, id: impl Into<ShowId>,
language: Option<&str>, language: Option<&str>,
) -> Result<Show, Error> { ) -> Result<Show, Error> {
self.config
.limiter
.until_ready_with_jitter(Jitter::new(
Duration::from_millis(0),
Duration::from_millis(50),
))
.await;
Ok(self Ok(self
.config .config
.client .client
.execute(make_request( .execute(make_request(
&self.config, &self.config,
&format!("/3/tv/{}", id.into()), &format!("/3/tv/{}", id.into().into_raw()),
language, language,
)?) )?)
.await? .await?
-7
View File
@@ -4,7 +4,6 @@ use crate::{Config, api};
/// The primary client that references all other clients /// The primary client that references all other clients
pub struct Client { pub struct Client {
genres: api::genres::Client,
collections: api::collections::Client, collections: api::collections::Client,
movies: api::movies::Client, movies: api::movies::Client,
shows: api::shows::Client, shows: api::shows::Client,
@@ -22,7 +21,6 @@ impl Client {
pub fn new_with_config(config: Config) -> Self { pub fn new_with_config(config: Config) -> Self {
let config = Rc::new(config); let config = Rc::new(config);
Self { Self {
genres: api::genres::Client::new(config.clone()),
collections: api::collections::Client::new(config.clone()), collections: api::collections::Client::new(config.clone()),
movies: api::movies::Client::new(config.clone()), movies: api::movies::Client::new(config.clone()),
shows: api::shows::Client::new(config.clone()), shows: api::shows::Client::new(config.clone()),
@@ -33,11 +31,6 @@ impl Client {
} }
impl Client { impl Client {
/// Access the Genres API
pub fn genres(&self) -> &api::genres::Client {
&self.genres
}
/// Access the Collections API /// Access the Collections API
pub fn collections(&self) -> &api::collections::Client { pub fn collections(&self) -> &api::collections::Client {
&self.collections &self.collections
+7
View File
@@ -1,3 +1,7 @@
use governor::clock::MonotonicClock;
use governor::state::{InMemoryState, NotKeyed};
use governor::{Quota, RateLimiter};
use nonzero_ext::nonzero;
use url::Url; use url::Url;
use url_macro::url; use url_macro::url;
@@ -7,6 +11,8 @@ pub struct Config {
pub base_url: Url, pub base_url: Url,
/// The reqwest client that is used for every request /// The reqwest client that is used for every request
pub client: reqwest::Client, pub client: reqwest::Client,
/// The rate limiter to use for the client
pub limiter: RateLimiter<NotKeyed, InMemoryState, MonotonicClock>,
/// The bearer token for readonly access to the API /// The bearer token for readonly access to the API
pub bearer_token: String, pub bearer_token: String,
/// An optional user agent string to provide to the API /// An optional user agent string to provide to the API
@@ -19,6 +25,7 @@ impl Config {
Self { Self {
base_url: url!("https://api.themoviedb.org"), base_url: url!("https://api.themoviedb.org"),
client: reqwest::Client::new(), client: reqwest::Client::new(),
limiter: RateLimiter::direct(Quota::per_second(nonzero!(30u32))),
bearer_token, bearer_token,
user_agent: None, user_agent: None,
} }
+2 -2
View File
@@ -1,8 +1,8 @@
//! flix-tmdb provides clients and models for fetching data from TMDB //! flix-tmdb provides clients and models for fetching data from TMDB
/// TMDB API clients #![cfg_attr(docsrs, feature(doc_cfg))]
pub mod api; pub mod api;
/// Deserializable types from the TMDB API
pub mod model; pub mod model;
mod client; mod client;
+8 -5
View File
@@ -1,12 +1,13 @@
use super::{CollectionId, MovieId}; use super::id::{CollectionId, MovieId};
/// A deserialized Collection from the TMDB API /// A deserialized Collection from the TMDB API
#[derive(Debug, serde::Deserialize)] #[derive(Debug, Clone, serde::Deserialize)]
pub struct Collection { pub struct Collection {
/// The collection's TMDB ID /// The collection's TMDB ID
pub id: CollectionId, pub id: CollectionId,
/// The collection's name /// The collection's title
pub name: String, #[serde(rename = "name")]
pub title: String,
/// The collection's overview /// The collection's overview
pub overview: String, pub overview: String,
/// The list of movies that are part of this collection /// The list of movies that are part of this collection
@@ -15,8 +16,10 @@ pub struct Collection {
} }
/// A deserialized collection item from the TMDB API /// A deserialized collection item from the TMDB API
#[derive(Debug, serde::Deserialize)] #[derive(Debug, Clone, serde::Deserialize)]
pub struct Item { pub struct Item {
/// The movie's TMDB ID /// The movie's TMDB ID
pub id: MovieId, pub id: MovieId,
/// The movie's title
pub title: String,
} }
+14 -4
View File
@@ -1,14 +1,24 @@
use core::time::Duration;
use flix_model::numbers::EpisodeNumber;
use chrono::NaiveDate; use chrono::NaiveDate;
use super::duration_from_minutes;
/// A deserialized Episode from the TMDB API /// A deserialized Episode from the TMDB API
#[derive(Debug, serde::Deserialize)] #[derive(Debug, Clone, serde::Deserialize)]
pub struct Episode { pub struct Episode {
/// The episode's number /// The episode's number
pub episode_number: i32, pub episode_number: EpisodeNumber,
/// The episode's name /// The episode's title
pub name: String, #[serde(rename = "name")]
pub title: String,
/// The episode's overview /// The episode's overview
pub overview: String, pub overview: String,
/// The episode's air date /// The episode's air date
pub air_date: NaiveDate, pub air_date: NaiveDate,
/// The movie's runtime
#[serde(deserialize_with = "duration_from_minutes")]
pub runtime: Duration,
} }
-19
View File
@@ -1,19 +0,0 @@
use super::id::{MovieGenreId, ShowGenreId};
/// A deserialized movie Genre from the TMDB API
#[derive(Debug, serde::Deserialize)]
pub struct MovieGenre {
/// The genre's TMDB ID
pub id: MovieGenreId,
/// The genre's name
pub name: String,
}
/// A deserialized show Genre from the TMDB API
#[derive(Debug, serde::Deserialize)]
pub struct ShowGenre {
/// The genre's TMDB ID
pub id: ShowGenreId,
/// The genre's name
pub name: String,
}
+220 -61
View File
@@ -1,83 +1,242 @@
//! Typed TMDB IDs
use core::cmp::Ordering;
use core::fmt; use core::fmt;
use core::hash::{Hash, Hasher};
use core::marker::PhantomData; use core::marker::PhantomData;
/// The TMDB ID type of a movie genre #[cfg(feature = "sea-orm")]
pub type MovieGenreId = TmdbId<MovieGenre>; use sea_orm::sea_query::{ArrayType, Nullable, ValueType, ValueTypeErr};
/// The TMDB ID type of a show genre #[cfg(feature = "sea-orm")]
pub type ShowGenreId = TmdbId<ShowGenre>; use sea_orm::{ColIdx, ColumnType, DbErr, QueryResult, TryFromU64, TryGetError, TryGetable, Value};
/// The TMDB ID type of a collection
pub type CollectionId = TmdbId<Collection>;
/// The TMDB ID type of a movie
pub type MovieId = TmdbId<Movie>;
/// The TMDB ID type of a show
pub type ShowId = TmdbId<Show>;
pub enum MovieGenre {} /// The internal representation used by TMDB
pub enum ShowGenre {} pub type TmdbRepr = u32;
pub enum Collection {}
pub enum Movie {}
pub enum Show {}
/// The inner type of TmdbId /// An opaque type representing a TMDB ID
pub type Inner = i32;
/// Wraps an ID from TMDB, the generic parameter is to enforce that
/// IDs for different types of media are not interchangeable
#[derive(serde::Serialize, serde::Deserialize)] #[derive(serde::Serialize, serde::Deserialize)]
#[serde(transparent)] #[serde(transparent)]
#[repr(transparent)] #[repr(transparent)]
pub struct TmdbId<T> { pub struct Id<T> {
inner: Inner, id: TmdbRepr,
#[serde(skip_serializing, default)] #[serde(skip_serializing, default)]
_phantom: PhantomData<T>, _phantom: PhantomData<T>,
} }
impl<T> TmdbId<T> { // Manual implementation since `T: Clone` is not required
/// Extract the inner value impl<T> Clone for Id<T> {
pub fn inner(self) -> Inner {
self.inner
}
}
impl<T> From<Inner> for TmdbId<T> {
fn from(value: Inner) -> Self {
Self {
inner: value,
_phantom: PhantomData,
}
}
}
impl<T> From<TmdbId<T>> for Inner {
fn from(value: TmdbId<T>) -> Self {
value.inner
}
}
impl<T> fmt::Debug for TmdbId<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.inner.fmt(f)
}
}
impl<T> fmt::Display for TmdbId<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.inner.fmt(f)
}
}
impl<T> Clone for TmdbId<T> {
fn clone(&self) -> Self { fn clone(&self) -> Self {
*self *self
} }
} }
impl<T> Copy for TmdbId<T> {} // Manual implementation since `T: Copy` is not required
impl<T> Copy for Id<T> {}
impl<T> PartialEq for TmdbId<T> { // Manual implementation since `T: PartialEq` is not required
impl<T> PartialEq for Id<T> {
fn eq(&self, other: &Self) -> bool { fn eq(&self, other: &Self) -> bool {
self.inner == other.inner self.id == other.id
} }
} }
impl<T> Eq for TmdbId<T> {} // Manual implementation since `T: Eq` is not required
impl<T> Eq for Id<T> {}
// Manual implementation since `T: PartialOrd` is not required
impl<T> PartialOrd for Id<T> {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
// Manual implementation since `T: Ord` is not required
impl<T> Ord for Id<T> {
fn cmp(&self, other: &Self) -> Ordering {
self.id.cmp(&other.id)
}
}
// Manual implementation since `T: Hash` is not required
impl<T> Hash for Id<T> {
fn hash<H: Hasher>(&self, state: &mut H) {
self.id.hash(state);
}
}
impl<T> Id<T> {
/// Allows the conversion from a raw value to [Id], though the use is discouraged.
pub fn from_raw(raw: TmdbRepr) -> Self {
Self {
id: raw,
_phantom: PhantomData,
}
}
/// Allows extracting the raw value, though the use is discouraged.
pub fn into_raw(self) -> TmdbRepr {
self.id
}
}
impl<T> fmt::Debug for Id<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Id")
.field("T", &core::any::type_name::<T>())
.field("id", &self.id)
.finish()
}
}
#[cfg(feature = "sea-orm")]
impl<T> ValueType for Id<T> {
fn try_from(v: Value) -> Result<Self, ValueTypeErr> {
<TmdbRepr as ValueType>::try_from(v).map(|id| Self {
id,
_phantom: PhantomData,
})
}
fn type_name() -> String {
format!("Id<{}>", &core::any::type_name::<T>())
}
fn array_type() -> ArrayType {
TmdbRepr::array_type()
}
fn column_type() -> ColumnType {
TmdbRepr::column_type()
}
}
#[cfg(feature = "sea-orm")]
impl<T> From<Id<T>> for Value {
fn from(value: Id<T>) -> Self {
value.id.into()
}
}
#[cfg(feature = "sea-orm")]
impl<T> TryGetable for Id<T> {
fn try_get_by<I: ColIdx>(res: &QueryResult, index: I) -> Result<Self, TryGetError> {
TmdbRepr::try_get_by(res, index).map(|id| Self {
id,
_phantom: PhantomData,
})
}
}
#[cfg(feature = "sea-orm")]
impl<T> TryFromU64 for Id<T> {
fn try_from_u64(n: u64) -> Result<Self, DbErr> {
TmdbRepr::try_from_u64(n).map(|id| Self {
id,
_phantom: PhantomData,
})
}
}
#[cfg(feature = "sea-orm")]
impl<T> Nullable for Id<T> {
fn null() -> Value {
TmdbRepr::null()
}
}
#[cfg(test)]
mod tests {
#[test]
#[cfg(feature = "sea-orm")]
fn test_sea_orm() {
use sea_orm::{
ActiveModelBehavior, DeriveEntityModel, DerivePrimaryKey, DeriveRelation, EntityTrait,
EnumIter, PrimaryKeyTrait,
};
use super::Id;
#[allow(dead_code)]
#[derive(Debug, Clone, PartialEq, Eq, DeriveEntityModel)]
#[sea_orm(table_name = "ids")]
pub struct Model {
#[sea_orm(primary_key, auto_increment = false)]
id: Id<Model>,
nullable: Option<Id<Model>>,
}
impl ActiveModelBehavior for ActiveModel {}
#[allow(dead_code)]
#[derive(Debug, EnumIter, DeriveRelation)]
pub enum Relation {}
}
#[test]
fn test_serde() {
use super::Id;
let id: Id<()> = Id::from_raw(1234);
serde_test::assert_tokens(&id, &[serde_test::Token::U32(1234)]);
}
}
/// Type alias for the raw ID representation
pub use self::TmdbRepr as RawId;
#[doc(hidden)]
pub enum Collection {}
/// Type alias for a collection ID
pub type CollectionId = Id<Collection>;
impl From<CollectionId> for flix_model::id::CollectionId {
fn from(value: CollectionId) -> Self {
Self::from_raw(value.into_raw().into())
}
}
impl TryFrom<flix_model::id::CollectionId> for CollectionId {
type Error = <RawId as TryFrom<flix_model::id::RawId>>::Error;
fn try_from(value: flix_model::id::CollectionId) -> Result<Self, Self::Error> {
value.into_raw().try_into().map(Self::from_raw)
}
}
#[doc(hidden)]
pub enum Movie {}
/// Type alias for a movie ID
pub type MovieId = Id<Movie>;
impl From<MovieId> for flix_model::id::MovieId {
fn from(value: MovieId) -> Self {
Self::from_raw(value.into_raw().into())
}
}
impl TryFrom<flix_model::id::MovieId> for MovieId {
type Error = <RawId as TryFrom<flix_model::id::RawId>>::Error;
fn try_from(value: flix_model::id::MovieId) -> Result<Self, Self::Error> {
value.into_raw().try_into().map(Self::from_raw)
}
}
#[doc(hidden)]
pub enum Show {}
/// Type alias for a show ID
pub type ShowId = Id<Show>;
impl From<ShowId> for flix_model::id::ShowId {
fn from(value: ShowId) -> Self {
Self::from_raw(value.into_raw().into())
}
}
impl TryFrom<flix_model::id::ShowId> for ShowId {
type Error = <RawId as TryFrom<flix_model::id::RawId>>::Error;
fn try_from(value: flix_model::id::ShowId) -> Result<Self, Self::Error> {
value.into_raw().try_into().map(Self::from_raw)
}
}
+15 -6
View File
@@ -1,18 +1,27 @@
//! Deserializable types from the TMDB API
use core::time::Duration;
use serde::{Deserialize, Deserializer};
pub mod id;
mod collection; mod collection;
mod episode; mod episode;
mod genre;
mod id;
mod movie; mod movie;
mod season; mod season;
mod show; mod show;
pub use collection::*; pub use collection::*;
pub use episode::*; pub use episode::*;
pub use genre::*;
pub use movie::*; pub use movie::*;
pub use season::*; pub use season::*;
pub use serde::*;
pub use show::*; pub use show::*;
pub use id::{CollectionId, MovieGenreId, MovieId, ShowGenreId, ShowId}; fn duration_from_minutes<'de, D>(deserializer: D) -> Result<Duration, D::Error>
pub use id::{Inner as TmdbIdInner, TmdbId}; where
D: Deserializer<'de>,
{
let minutes = u64::deserialize(deserializer)?;
Ok(Duration::from_secs(minutes.saturating_mul(60)))
}
+21 -29
View File
@@ -1,9 +1,12 @@
use core::time::Duration;
use chrono::NaiveDate; use chrono::NaiveDate;
use super::{CollectionId, MovieGenre, MovieId}; use super::duration_from_minutes;
use super::id::{CollectionId, MovieId};
/// A deserialized Movie from the TMDB API /// A deserialized Movie from the TMDB API
#[derive(Debug, serde::Deserialize)] #[derive(Debug, Clone, serde::Deserialize)]
pub struct Movie { pub struct Movie {
/// The movie's TMDB ID /// The movie's TMDB ID
pub id: MovieId, pub id: MovieId,
@@ -12,42 +15,31 @@ pub struct Movie {
pub collection: Option<InCollection>, pub collection: Option<InCollection>,
/// The movie's title /// The movie's title
pub title: String, pub title: String,
/// The movie's tagline
pub tagline: String,
/// The movie's overview /// The movie's overview
pub overview: String, pub overview: String,
/// The list of genres the movie belongs to
pub genres: Vec<MovieGenre>,
/// The movie's release date /// The movie's release date
pub release_date: NaiveDate, pub release_date: NaiveDate,
/// The movie's status /// The movie's runtime
pub status: MovieStatus, #[serde(deserialize_with = "duration_from_minutes")]
pub runtime: Duration,
} }
/// A deserialized movie's collection from the TMDB API /// A deserialized movie's collection from the TMDB API
#[derive(Debug, serde::Deserialize)] #[derive(Debug, Clone, serde::Deserialize)]
pub struct InCollection { pub struct InCollection {
/// The collection's TMDB ID /// The collection's TMDB ID
pub id: CollectionId, pub id: CollectionId,
/// The collection's title
#[serde(rename = "name")]
pub title: String,
} }
/// A deserialized movie status from the TMDB API // TODO: Genres
#[derive(Debug, serde::Deserialize)] // pub genres: Vec<Genre>,
pub enum MovieStatus { // where: struct Genre { id, name }
/// The movie was cancelled
#[serde(rename = "Canceled")] // TODO: Company
Canceled, // pub companies: Vec<Company>
/// The movie is in production // where: struct Company { id, name }
#[serde(rename = "In Production")]
InProduction,
/// The movie is planned
#[serde(rename = "Planned")]
Planned,
/// The movie is in post production
#[serde(rename = "Post Production")]
PostProduction,
/// The movie is released
#[serde(rename = "Released")]
Released,
/// The movie is rumored
#[serde(rename = "Rumored")]
Rumored,
}
+12 -7
View File
@@ -1,18 +1,23 @@
use chrono::NaiveDate; use chrono::NaiveDate;
use super::Episode; use flix_model::numbers::SeasonNumber;
/// A deserialized Season from the TMDB API /// A deserialized Season from the TMDB API
#[derive(Debug, serde::Deserialize)] #[derive(Debug, Clone, serde::Deserialize)]
pub struct Season { pub struct Season {
/// The season's number /// The season's number
pub season_number: i32, pub season_number: SeasonNumber,
/// The season's name /// The season's title
pub name: String, #[serde(rename = "name")]
pub title: String,
/// The season's overview /// The season's overview
pub overview: String, pub overview: String,
/// The season's air date /// The season's air date
pub air_date: NaiveDate, pub air_date: NaiveDate,
/// The list of episodes in this season /// The number of episodes in this season
pub episodes: Vec<Episode>, pub episodes: Vec<FakeEpisode>,
} }
/// A placeholder struct for parsing the episodes list for a season
#[derive(Debug, Clone, serde::Deserialize)]
pub struct FakeEpisode {}
+21 -31
View File
@@ -1,47 +1,37 @@
use chrono::NaiveDate; use chrono::NaiveDate;
use super::{ShowGenre, ShowId}; use super::id::ShowId;
/// A deserialized Show from the TMDB API /// A deserialized Show from the TMDB API
#[derive(Debug, serde::Deserialize)] #[derive(Debug, Clone, serde::Deserialize)]
pub struct Show { pub struct Show {
/// The show's TMDB ID /// The show's TMDB ID
pub id: ShowId, pub id: ShowId,
/// The show's name /// The show's title
pub name: String, #[serde(rename = "name")]
pub title: String,
/// The show's tagline
pub tagline: String,
/// The show's overview /// The show's overview
pub overview: String, pub overview: String,
/// The list of genres this show belongs to
pub genres: Vec<ShowGenre>,
/// The show's first air date /// The show's first air date
pub first_air_date: NaiveDate, pub first_air_date: NaiveDate,
/// The show's last air date /// The show's last air date
pub last_air_date: NaiveDate, pub last_air_date: NaiveDate,
/// The total number of episodes in this show
pub number_of_episodes: u32,
/// The number of seasons in this show /// The number of seasons in this show
pub number_of_seasons: i32, pub number_of_seasons: u32,
/// The show's status
pub status: ShowStatus,
} }
/// A deserialized show Status from the TMDB API // TODO: Genres
#[derive(Debug, serde::Deserialize)] // pub genres: Vec<Genre>,
pub enum ShowStatus { // where: struct Genre { id, name }
/// The show is returning
#[serde(rename = "Returning Series")] // TODO: Network
Returning, // pub networks: Vec<Network>
/// The show is planned // where: struct Network { id, name }
#[serde(rename = "Planned")]
Planned, // TODO: Company
/// The show is in procuction // pub companies: Vec<Company>
#[serde(rename = "In Production")] // where: struct Company { id, name }
InProduction,
/// The show has ended
#[serde(rename = "Ended")]
Ended,
/// The show is canceled
#[serde(rename = "Canceled")]
Canceled,
/// The show only released a pilot
#[serde(rename = "Pilot")]
Pilot,
}