reinhardt-rest 0.1.2

//! Searchable model trait
//!
//! Defines which fields are searchable and the default ordering for a model.

use super::ordering_field::OrderingField;
use reinhardt_db::orm::{Field, Model};

/// Trait for models that support search and ordering
///
/// Implement this trait to define which fields can be searched
/// and what the default ordering should be.
///
/// # Examples
///
/// ```rust
/// # use reinhardt_rest::filters::{SearchableModel, field_extensions::FieldOrderingExt, OrderingField};
/// # use reinhardt_db::orm::{Model, Field, FieldSelector};
/// #
/// # #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
/// # struct Post {
/// #     id: i64,
/// #     title: String,
/// #     content: String,
/// #     created_at: String,
/// # }
/// #
/// # #[derive(Clone)]
/// # struct PostFields;
/// # impl FieldSelector for PostFields {
/// #     fn with_alias(self, _alias: &str) -> Self { self }
/// # }
/// #
/// # impl Model for Post {
/// #     type PrimaryKey = i64;
/// #     type Fields = PostFields;
/// #     fn table_name() -> &'static str { "posts" }
/// #     fn new_fields() -> Self::Fields { PostFields }
/// #     fn primary_key(&self) -> Option<Self::PrimaryKey> { Some(self.id) }
/// #     fn set_primary_key(&mut self, value: Self::PrimaryKey) { self.id = value; }
/// # }
/// #
/// impl SearchableModel for Post {
///     fn searchable_fields() -> Vec<Field<Self, String>> {
///         vec![
///             Field::new(vec!["title"]),
///             Field::new(vec!["content"]),
///         ]
///     }
///
///     fn default_ordering() -> Vec<OrderingField<Self>> {
///         vec![Field::<Self, String>::new(vec!["created_at"]).desc()]
///     }
/// }
///
/// // Verify the implementation
/// let fields = Post::searchable_fields();
/// assert_eq!(fields.len(), 2);
/// let ordering = Post::default_ordering();
/// assert_eq!(ordering.len(), 1);
/// ```
pub trait SearchableModel: Model {
	/// Get the list of searchable string fields
	///
	/// These fields will be used for text search operations.
	fn searchable_fields() -> Vec<Field<Self, String>> {
		Vec::new()
	}

	/// Get the default ordering
	///
	/// Returns an empty vector by default (no ordering).
	/// Override to specify default sort order.
	fn default_ordering() -> Vec<OrderingField<Self>> {
		Vec::new()
	}

	/// Get searchable field names as strings (for compatibility)
	///
	/// This is a helper method that extracts field names from searchable_fields().
	fn searchable_field_names() -> Vec<String> {
		Self::searchable_fields()
			.into_iter()
			.map(|field| field.path().join("."))
			.collect()
	}
}