recipemd 0.2.0

Parser for the RecipeMD format
Documentation 
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

// Copyright (c) 2023 d-k-bo
// SPDX-License-Identifier: LGPL-3.0-or-later

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// A [Recipe](https://recipemd.org/specification.html#recipe) as defined by the RecipeMD specification.
///
/// See the [top-level documentation](crate) for details.
#[derive(Clone, Debug)]
#[cfg_attr(any(test, feature = "tests"), derive(PartialEq))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Recipe {
    pub title: String,
    pub description: Option<String>,
    pub tags: Vec<String>,
    pub yields: Vec<Amount>,
    pub ingredients: Vec<Ingredient>,
    pub ingredient_groups: Vec<IngredientGroup>,
    pub instructions: Option<String>,
}

/// An [IngredientGroup](https://recipemd.org/specification.html#ingredient-group).
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(any(test, feature = "tests"), derive(PartialEq))]
pub struct IngredientGroup {
    pub title: String,
    pub ingredients: Vec<Ingredient>,
    pub ingredient_groups: Vec<IngredientGroup>,
}

/// An [Ingredient](https://recipemd.org/specification.html#ingredient).
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(any(test, feature = "tests"), derive(PartialEq))]
pub struct Ingredient {
    pub amount: Option<Amount>,
    pub name: String,
    pub link: Option<String>,
}

/// An [Amount](https://recipemd.org/specification.html#amount) used for ingredients and yields.
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(any(test, feature = "tests"), derive(PartialEq))]
pub struct Amount {
    pub factor: Factor,
    pub unit: Option<String>,
}

/// Represents the numerical part of an [`Amount`].
///
/// Integers are serialized as integers, fractions and floats are serialized as floats.
#[derive(Copy, Clone, Debug)]
pub enum Factor {
    Integer(u32),
    Fraction(u16, u16),
    Float(f32),
}

impl From<Factor> for f32 {
    fn from(value: Factor) -> Self {
        match value {
            Factor::Integer(v) => v as f32,
            Factor::Fraction(num, denom) => num as f32 / denom as f32,
            Factor::Float(v) => v,
        }
    }
}

#[cfg(feature = "serde")]
impl Serialize for Factor {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        match self {
            Factor::Integer(v) => v.to_string().serialize(serializer),
            Factor::Fraction(num, denom) => (*num as f32 / *denom as f32)
                .to_string()
                .serialize(serializer),
            Factor::Float(v) => v.to_string().serialize(serializer),
        }
    }
}

#[cfg(feature = "serde")]
impl<'de> Deserialize<'de> for Factor {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        use std::str::FromStr;

        let s = <&str>::deserialize(deserializer)?;
        u32::from_str(s)
            .map(Factor::Integer)
            .or_else(|_| f32::from_str(s).map(Factor::Float))
            .map_err(serde::de::Error::custom)
    }
}

#[cfg(any(test, feature = "tests"))]
impl PartialEq for Factor {
    fn eq(&self, other: &Self) -> bool {
        f32::from(*self).eq(&f32::from(*other))
    }
}