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
use std::{
    error::Error,
    fmt,
    fmt::{Display, Formatter},
};

use crate::{ColumnName, TableColumnAttributes, TableName};

/// Struct for generating the `JOIN` clause.
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct SqlJoin {
    pub other_table_name:  TableName,
    pub other_column_name: ColumnName,
    pub real_table_name:   Option<TableName>,
    pub using_table_name:  TableName,
    pub using_column_name: ColumnName,
}

impl SqlJoin {
    #[doc(hidden)]
    #[inline]
    pub fn from_table_column_attributes(table_column_attributes: &TableColumnAttributes) -> Self {
        Self {
            other_table_name:  table_column_attributes.table_name.clone(),
            other_column_name: table_column_attributes.column_name.clone(),
            real_table_name:   table_column_attributes.real_table_name.clone(),
            using_table_name:  table_column_attributes.foreign_table_name.clone(),
            using_column_name: table_column_attributes.foreign_column_name.clone(),
        }
    }
}

#[cfg(any(feature = "mysql", feature = "sqlite"))]
impl SqlJoin {
    fn to_sql_join_clause<'a>(&self, s: &'a mut String) -> &'a str {
        use std::{fmt::Write, str::from_utf8_unchecked};

        let len = s.len();

        if let Some(real_table_name) = &self.real_table_name {
            s.write_fmt(format_args!(
                "LEFT JOIN `{real_table_name}` AS `{other_table_name}` ON \
                 `{other_table_name}`.`{other_column_name}` = \
                 `{using_table_name}`.`{using_column_name}`",
                other_table_name = self.other_table_name,
                other_column_name = self.other_column_name,
                using_table_name = self.using_table_name,
                using_column_name = self.using_column_name,
            ))
            .unwrap()
        } else {
            s.write_fmt(format_args!(
                "LEFT JOIN `{other_table_name}` ON `{other_table_name}`.`{other_column_name}` = \
                 `{using_table_name}`.`{using_column_name}`",
                other_table_name = self.other_table_name,
                other_column_name = self.other_column_name,
                using_table_name = self.using_table_name,
                using_column_name = self.using_column_name,
            ))
            .unwrap()
        }

        unsafe { from_utf8_unchecked(&s.as_bytes()[len..]) }
    }

    fn format_sql_join_clauses<'a>(joins: &[SqlJoin], s: &'a mut String) -> &'a str {
        use std::str::from_utf8_unchecked;

        if joins.is_empty() {
            return "";
        }

        let len = s.len();

        for join in joins {
            join.to_sql_join_clause(s);
            s.push('\n');
        }

        unsafe {
            let len = s.len();

            s.as_mut_vec().truncate(len - 1);
        }

        unsafe { from_utf8_unchecked(&s.as_bytes()[len..]) }
    }
}

#[cfg(feature = "mysql")]
impl SqlJoin {
    /// Generate a `JOIN` clause for MySQL.
    ///
    /// If `real_table_name` exists,
    ///
    /// ```sql
    /// JOIN `<real_table_name>` AS `<other_table_name>` ON `<other_table_name>`.`<other_column_name>` = `<using_table_name>`.`<using_column_name>`
    /// ```
    ///
    /// or
    ///
    /// ```sql
    /// JOIN `<other_table_name>` ON `<other_table_name>`.`<other_column_name>` = `<using_table_name>`.`<using_column_name>`
    /// ```
    #[inline]
    pub fn to_mysql_join_clause<'a>(&self, s: &'a mut String) -> &'a str {
        self.to_sql_join_clause(s)
    }

    /// Generate `JOIN` clauses for MySQL.
    ///
    /// Concatenate a series of `SqlJoin`s with `\n`.
    #[inline]
    pub fn format_mysql_join_clauses<'a>(joins: &[SqlJoin], s: &'a mut String) -> &'a str {
        Self::format_sql_join_clauses(joins, s)
    }
}

#[cfg(feature = "sqlite")]
impl SqlJoin {
    /// Generate a `JOIN` clause for SQLite.
    ///
    /// If `real_table_name` exists,
    ///
    /// ```sql
    /// JOIN `<real_table_name>` AS `<other_table_name>` ON `<other_table_name>`.`<other_column_name>` = `<using_table_name>`.`<using_column_name>`
    /// ```
    ///
    /// or
    ///
    /// ```sql
    /// JOIN `<other_table_name>` ON `<other_table_name>`.`<other_column_name>` = `<using_table_name>`.`<using_column_name>`
    /// ```
    #[inline]
    pub fn to_sqlite_join_clause<'a>(&self, s: &'a mut String) -> &'a str {
        self.to_sql_join_clause(s)
    }

    /// Generate `JOIN` clauses for SQLite.
    ///
    /// Concatenate a series of `SqlJoin`s with `\n`.
    #[inline]
    pub fn format_sqlite_join_clauses<'a>(joins: &[SqlJoin], s: &'a mut String) -> &'a str {
        Self::format_sql_join_clauses(joins, s)
    }
}

/// Operators for `SqlJoin`s.
pub trait SqlJoinsOps {
    /// Insert a `SqlJoin` if it does not exist. Return `Ok(true)` if a new `SqlJoin` has been pushed.
    fn add_join(&mut self, join: SqlJoin) -> Result<bool, SqlJoinsInsertError>;
}

impl SqlJoinsOps for Vec<SqlJoin> {
    #[inline]
    fn add_join(&mut self, join: SqlJoin) -> Result<bool, SqlJoinsInsertError> {
        if let Some(existing_join) = self
            .iter()
            .find(|existing_join| existing_join.other_table_name == join.other_table_name)
        {
            if existing_join.other_column_name != join.other_column_name
                || existing_join.real_table_name != join.real_table_name
                || existing_join.using_table_name != join.using_table_name
                || existing_join.using_column_name != join.using_column_name
            {
                Err(SqlJoinsInsertError::OtherTableNameConflict)
            } else {
                Ok(false)
            }
        } else {
            self.push(join);

            Ok(true)
        }
    }
}

#[derive(Debug, Clone)]
pub enum SqlJoinsInsertError {
    OtherTableNameConflict,
}

impl Display for SqlJoinsInsertError {
    #[inline]
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::OtherTableNameConflict => {
                f.write_str("other_table_name exists but the join clauses are not exactly the same")
            },
        }
    }
}

impl Error for SqlJoinsInsertError {}