use std::fmt; use std::str::FromStr; use serde::{Deserialize, Serialize}; use crate::error::Error; use crate::{AscDesc, AscDescError, Member, UserError}; #[derive(Debug)] pub enum CriterionError { InvalidName { name: String }, ReservedName { name: String }, ReservedNameForSort { name: String }, ReservedNameForFilter { name: String }, } impl fmt::Display for CriterionError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match self { Self::InvalidName { name } => write!(f, "invalid ranking rule {}", name), Self::ReservedName { name } => { write!(f, "{} is a reserved keyword and thus can't be used as a ranking rule", name) } Self::ReservedNameForSort { name } => { write!( f, "{0} is a reserved keyword and thus can't be used as a ranking rule. \ {0} can only be used for sorting at search time", name ) } Self::ReservedNameForFilter { name } => { write!( f, "{0} is a reserved keyword and thus can't be used as a ranking rule. \ {0} can only be used for filtering at search time", name ) } } } } #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)] pub enum Criterion { /// Sorted by decreasing number of matched query terms. /// Query words at the front of an attribute is considered better than if it was at the back. Words, /// Sorted by increasing number of typos. Typo, /// Sorted by increasing distance between matched query terms. Proximity, /// Documents with quey words contained in more important /// attributes are considered better. Attribute, /// Dynamically sort at query time the documents. None, one or multiple Asc/Desc sortable /// attributes can be used in place of this criterion at query time. Sort, /// Sorted by the similarity of the matched words with the query words. Exactness, /// Sorted by the increasing value of the field specified. Asc(String), /// Sorted by the decreasing value of the field specified. Desc(String), } impl Criterion { /// Returns the field name parameter of this criterion. pub fn field_name(&self) -> Option<&str> { match self { Criterion::Asc(name) | Criterion::Desc(name) => Some(name), _otherwise => None, } } } impl FromStr for Criterion { type Err = CriterionError; fn from_str(text: &str) -> Result { match text { "words" => Ok(Criterion::Words), "typo" => Ok(Criterion::Typo), "proximity" => Ok(Criterion::Proximity), "attribute" => Ok(Criterion::Attribute), "sort" => Ok(Criterion::Sort), "exactness" => Ok(Criterion::Exactness), text => match AscDesc::from_str(text) { Ok(AscDesc::Asc(Member::Field(field))) => Ok(Criterion::Asc(field)), Ok(AscDesc::Desc(Member::Field(field))) => Ok(Criterion::Desc(field)), Ok(AscDesc::Asc(Member::Geo(_))) | Ok(AscDesc::Desc(Member::Geo(_))) => { Err(CriterionError::ReservedNameForSort { name: "_geoPoint".to_string() })? } Err(AscDescError::InvalidSyntax { name }) => { Err(CriterionError::InvalidName { name })? } Err(AscDescError::ReservedKeyword { name }) if name.starts_with("_geoPoint") => { Err(CriterionError::ReservedNameForSort { name: "_geoPoint".to_string() })? } Err(AscDescError::ReservedKeyword { name }) if name.starts_with("_geoRadius") => { Err(CriterionError::ReservedNameForFilter { name: "_geoRadius".to_string() })? } Err(AscDescError::ReservedKeyword { name }) => { Err(CriterionError::ReservedName { name })? } }, } } } impl From for Error { fn from(error: CriterionError) -> Self { Self::UserError(UserError::CriterionError(error)) } } pub fn default_criteria() -> Vec { vec![ Criterion::Words, Criterion::Typo, Criterion::Proximity, Criterion::Attribute, Criterion::Sort, Criterion::Exactness, ] } impl fmt::Display for Criterion { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { use Criterion::*; match self { Words => f.write_str("words"), Typo => f.write_str("typo"), Proximity => f.write_str("proximity"), Attribute => f.write_str("attribute"), Sort => f.write_str("sort"), Exactness => f.write_str("exactness"), Asc(attr) => write!(f, "{}:asc", attr), Desc(attr) => write!(f, "{}:desc", attr), } } } #[cfg(test)] mod tests { use big_s::S; use CriterionError::*; use super::*; #[test] fn parse_criterion() { let valid_criteria = [ ("words", Criterion::Words), ("typo", Criterion::Typo), ("proximity", Criterion::Proximity), ("attribute", Criterion::Attribute), ("sort", Criterion::Sort), ("exactness", Criterion::Exactness), ("price:asc", Criterion::Asc(S("price"))), ("price:desc", Criterion::Desc(S("price"))), ("price:asc:desc", Criterion::Desc(S("price:asc"))), ("truc:machin:desc", Criterion::Desc(S("truc:machin"))), ("hello-world!:desc", Criterion::Desc(S("hello-world!"))), ("it's spacy over there:asc", Criterion::Asc(S("it's spacy over there"))), ]; for (input, expected) in valid_criteria { let res = input.parse::(); assert!( res.is_ok(), "Failed to parse `{}`, was expecting `{:?}` but instead got `{:?}`", input, expected, res ); assert_eq!(res.unwrap(), expected); } let invalid_criteria = [ ("words suffix", InvalidName { name: S("words suffix") }), ("prefix typo", InvalidName { name: S("prefix typo") }), ("proximity attribute", InvalidName { name: S("proximity attribute") }), ("price", InvalidName { name: S("price") }), ("asc:price", InvalidName { name: S("asc:price") }), ("price:deesc", InvalidName { name: S("price:deesc") }), ("price:aasc", InvalidName { name: S("price:aasc") }), ("price:asc and desc", InvalidName { name: S("price:asc and desc") }), ("price:asc:truc", InvalidName { name: S("price:asc:truc") }), ("_geo:asc", ReservedName { name: S("_geo") }), ("_geoDistance:asc", ReservedName { name: S("_geoDistance") }), ("_geoPoint:asc", ReservedNameForSort { name: S("_geoPoint") }), ("_geoPoint(42, 75):asc", ReservedNameForSort { name: S("_geoPoint") }), ("_geoRadius:asc", ReservedNameForFilter { name: S("_geoRadius") }), ("_geoRadius(42, 75, 59):asc", ReservedNameForFilter { name: S("_geoRadius") }), ]; for (input, expected) in invalid_criteria { let res = input.parse::(); assert!( res.is_err(), "Should no be able to parse `{}`, was expecting an error but instead got: `{:?}`", input, res ); let res = res.unwrap_err(); assert_eq!( res.to_string(), expected.to_string(), "Bad error for input {}: got `{:?}` instead of `{:?}`", input, res, expected ); } } }