1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
// Copyright (c) 2018 The predicates-rs Project Developers.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/license/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use std::ffi;
use std::fmt;
use std::str;
use crate::reflection;
#[cfg(feature = "normalize-line-endings")]
use crate::str::normalize::NormalizedPredicate;
use crate::Predicate;
/// Predicate adaper that trims the variable being tested.
///
/// This is created by `pred.trim()`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct TrimPredicate<P>
where
P: Predicate<str>,
{
p: P,
}
impl<P> Predicate<str> for TrimPredicate<P>
where
P: Predicate<str>,
{
fn eval(&self, variable: &str) -> bool {
self.p.eval(variable.trim())
}
fn find_case<'a>(&'a self, expected: bool, variable: &str) -> Option<reflection::Case<'a>> {
self.p.find_case(expected, variable.trim())
}
}
impl<P> reflection::PredicateReflection for TrimPredicate<P>
where
P: Predicate<str>,
{
fn children<'a>(&'a self) -> Box<dyn Iterator<Item = reflection::Child<'a>> + 'a> {
let params = vec![reflection::Child::new("predicate", &self.p)];
Box::new(params.into_iter())
}
}
impl<P> fmt::Display for TrimPredicate<P>
where
P: Predicate<str>,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.p.fmt(f)
}
}
/// Predicate adaper that converts a `str` predicate to byte predicate.
///
/// This is created by `pred.from_utf8()`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Utf8Predicate<P>
where
P: Predicate<str>,
{
p: P,
}
impl<P> Predicate<ffi::OsStr> for Utf8Predicate<P>
where
P: Predicate<str>,
{
fn eval(&self, variable: &ffi::OsStr) -> bool {
variable.to_str().map(|s| self.p.eval(s)).unwrap_or(false)
}
fn find_case<'a>(
&'a self,
expected: bool,
variable: &ffi::OsStr,
) -> Option<reflection::Case<'a>> {
let var_str = variable.to_str();
match (expected, var_str) {
(_, Some(var_str)) => self.p.find_case(expected, var_str).map(|child| {
child.add_product(reflection::Product::new("var as str", var_str.to_owned()))
}),
(true, None) => None,
(false, None) => Some(
reflection::Case::new(Some(self), false)
.add_product(reflection::Product::new("error", "Invalid UTF-8 string")),
),
}
}
}
impl<P> Predicate<[u8]> for Utf8Predicate<P>
where
P: Predicate<str>,
{
fn eval(&self, variable: &[u8]) -> bool {
str::from_utf8(variable)
.map(|s| self.p.eval(s))
.unwrap_or(false)
}
fn find_case<'a>(&'a self, expected: bool, variable: &[u8]) -> Option<reflection::Case<'a>> {
let var_str = str::from_utf8(variable);
match (expected, var_str) {
(_, Ok(var_str)) => self.p.find_case(expected, var_str).map(|child| {
child.add_product(reflection::Product::new("var as str", var_str.to_owned()))
}),
(true, Err(_)) => None,
(false, Err(err)) => Some(
reflection::Case::new(Some(self), false)
.add_product(reflection::Product::new("error", err)),
),
}
}
}
impl<P> reflection::PredicateReflection for Utf8Predicate<P>
where
P: Predicate<str>,
{
fn children<'a>(&'a self) -> Box<dyn Iterator<Item = reflection::Child<'a>> + 'a> {
let params = vec![reflection::Child::new("predicate", &self.p)];
Box::new(params.into_iter())
}
}
impl<P> fmt::Display for Utf8Predicate<P>
where
P: Predicate<str>,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.p.fmt(f)
}
}
/// `Predicate` extension adapting a `str` Predicate.
pub trait PredicateStrExt
where
Self: Predicate<str>,
Self: Sized,
{
/// Returns a `TrimPredicate` that ensures the data passed to `Self` is trimmed.
///
/// # Examples
///
/// ```
/// use predicates::prelude::*;
///
/// let predicate_fn = predicate::str::is_empty().trim();
/// assert_eq!(true, predicate_fn.eval(" "));
/// assert_eq!(false, predicate_fn.eval(" Hello "));
/// ```
fn trim(self) -> TrimPredicate<Self> {
TrimPredicate { p: self }
}
/// Returns a `Utf8Predicate` that adapts `Self` to a `[u8]` `Predicate`.
///
/// # Examples
///
/// ```
/// use predicates::prelude::*;
/// use std::ffi::OsStr;
///
/// let predicate_fn = predicate::str::is_empty().not().from_utf8();
/// assert_eq!(true, predicate_fn.eval(OsStr::new("Hello")));
/// assert_eq!(false, predicate_fn.eval(OsStr::new("")));
/// let variable: &[u8] = b"";
/// assert_eq!(false, predicate_fn.eval(variable));
/// ```
#[allow(clippy::wrong_self_convention)]
fn from_utf8(self) -> Utf8Predicate<Self> {
Utf8Predicate { p: self }
}
/// Returns a `NormalizedPredicate` that ensures
/// the newlines within the data passed to `Self` is normalised.
///
/// # Examples
///
/// ```
/// use predicates::prelude::*;
///
/// let predicate_fn = predicate::eq("Hello World!\n").normalize();
/// assert_eq!(true, predicate_fn.eval("Hello World!\n"));
/// assert_eq!(true, predicate_fn.eval("Hello World!\r"));
/// assert_eq!(true, predicate_fn.eval("Hello World!\r\n"));
/// assert_eq!(false, predicate_fn.eval("Goodbye"));
/// ```
///
#[cfg(feature = "normalize-line-endings")]
fn normalize(self) -> NormalizedPredicate<Self> {
NormalizedPredicate { p: self }
}
}
impl<P> PredicateStrExt for P where P: Predicate<str> {}