Throw away flix files in favor of a flix database

2025-09-18 22:41:34 -06:00
parent ba9c3fa03d
commit 06110b91a1
117 changed files with 8645 additions and 1054 deletions
@@ -1,90 +1,242 @@
+//! Typed TMDB IDs
+
+use core::cmp::Ordering;
 use core::fmt;
 use core::hash::{Hash, Hasher};
 use core::marker::PhantomData;

-/// The TMDB ID type of a movie genre
-pub type MovieGenreId = TmdbId<MovieGenre>;
-/// The TMDB ID type of a show genre
-pub type ShowGenreId = TmdbId<ShowGenre>;
-/// 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>;
+#[cfg(feature = "sea-orm")]
+use sea_orm::sea_query::{ArrayType, Nullable, ValueType, ValueTypeErr};
+#[cfg(feature = "sea-orm")]
+use sea_orm::{ColIdx, ColumnType, DbErr, QueryResult, TryFromU64, TryGetError, TryGetable, Value};

-pub enum MovieGenre {}
-pub enum ShowGenre {}
-pub enum Collection {}
-pub enum Movie {}
-pub enum Show {}
+/// The internal representation used by TMDB
+pub type TmdbRepr = u32;

-/// The inner type of TmdbId
-pub type Inner = u32;
-
-/// Wraps an ID from TMDB, the generic parameter is to enforce that
-/// IDs for different types of media are not interchangeable
+/// An opaque type representing a TMDB ID
 #[derive(serde::Serialize, serde::Deserialize)]
 #[serde(transparent)]
 #[repr(transparent)]
-pub struct TmdbId<T> {
-	inner: Inner,
+pub struct Id<T> {
+	id: TmdbRepr,
 	#[serde(skip_serializing, default)]
 	_phantom: PhantomData<T>,
 }

-impl<T> TmdbId<T> {
-	/// Extract the inner value
-	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> {
+// Manual implementation since `T: Clone` is not required
+impl<T> Clone for Id<T> {
 	fn clone(&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 {
-		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> {}

-impl<T> Hash for TmdbId<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.inner.hash(state);
+		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, 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;
+
+/// A placeholder type used for CollectionId
+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)
+	}
+}
+
+/// A placeholder type used for MovieId
+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)
+	}
+}
+
+/// A placeholder type used for ShowId
+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)
 	}
 }