rustrails-record 0.1.2

ORM layer (ActiveRecord equivalent)
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
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

use rustrails_support::inflector::{foreign_key, tableize};

use super::{AssociationMeta, AssociationType};

/// Builder for [`AssociationType::BelongsTo`] metadata.
#[derive(Debug, Clone)]
pub struct BelongsToBuilder {
    name: String,
    foreign_key: Option<String>,
    primary_key: Option<String>,
    polymorphic: bool,
}

impl BelongsToBuilder {
    /// Creates a builder for the named association.
    #[must_use]
    pub fn new(name: &str) -> Self {
        Self {
            name: name.to_owned(),
            foreign_key: None,
            primary_key: None,
            polymorphic: false,
        }
    }

    /// Overrides the inferred foreign-key column name.
    #[must_use]
    pub fn foreign_key(mut self, fk: &str) -> Self {
        self.foreign_key = Some(fk.to_owned());
        self
    }

    /// Overrides the target primary-key column name.
    #[must_use]
    pub fn primary_key(mut self, key: &str) -> Self {
        self.primary_key = Some(key.to_owned());
        self
    }

    /// Marks the association as polymorphic.
    #[must_use]
    pub fn polymorphic(mut self) -> Self {
        self.polymorphic = true;
        self
    }

    /// Builds association metadata with ActiveRecord-style defaults.
    #[must_use]
    pub fn build(self) -> AssociationMeta {
        let name = self.name;
        let inferred_key = foreign_key(&name);

        AssociationMeta {
            target_table: tableize(&name),
            foreign_key: self.foreign_key.unwrap_or(inferred_key),
            primary_key: self.primary_key.unwrap_or_else(|| "id".to_owned()),
            dependent: None,
            through: None,
            polymorphic: self.polymorphic,
            association_type: AssociationType::BelongsTo,
            name,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::BelongsToBuilder;
    use crate::associations::AssociationType;

    #[test]
    fn build_defaults_foreign_key_from_association_name() {
        let meta = BelongsToBuilder::new("author").build();

        assert_eq!(meta.association_type, AssociationType::BelongsTo);
        assert_eq!(meta.target_table, "authors");
        assert_eq!(meta.foreign_key, "author_id");
        assert_eq!(meta.primary_key, "id");
        assert!(!meta.polymorphic);
    }

    #[test]
    fn build_supports_custom_keys() {
        let meta = BelongsToBuilder::new("account")
            .foreign_key("owner_uuid")
            .primary_key("uuid")
            .build();

        assert_eq!(meta.foreign_key, "owner_uuid");
        assert_eq!(meta.primary_key, "uuid");
    }

    #[test]
    fn build_marks_polymorphic_associations() {
        let meta = BelongsToBuilder::new("attachable").polymorphic().build();

        assert!(meta.polymorphic);
    }
    #[test]
    fn build_preserves_association_name() {
        let meta = BelongsToBuilder::new("author").build();

        assert_eq!(meta.name, "author");
    }

    #[test]
    fn foreign_key_override_keeps_default_primary_key() {
        let meta = BelongsToBuilder::new("author")
            .foreign_key("writer_id")
            .build();

        assert_eq!(meta.foreign_key, "writer_id");
        assert_eq!(meta.primary_key, "id");
    }

    #[test]
    fn primary_key_override_keeps_inferred_foreign_key() {
        let meta = BelongsToBuilder::new("author").primary_key("uuid").build();

        assert_eq!(meta.foreign_key, "author_id");
        assert_eq!(meta.primary_key, "uuid");
    }

    #[test]
    fn polymorphic_preserves_default_keys() {
        let meta = BelongsToBuilder::new("attachable").polymorphic().build();

        assert_eq!(meta.foreign_key, "attachable_id");
        assert_eq!(meta.primary_key, "id");
    }

    #[test]
    fn build_does_not_set_dependent_or_through_metadata() {
        let meta = BelongsToBuilder::new("author").build();

        assert!(meta.dependent.is_none());
        assert!(meta.through.is_none());
    }
}