Rename enable_multi_table_joins! to allow_tables_to_appear_in_same_query!

Author: bippityboppity

diesel/src/macros/mod.rs

@@ -965,6 +965,14 @@ macro_rules! joinable_inner {
     }
 }
 
+#[deprecated(since = "0.16.0", note = "use `allow_tables_to_appear_in_same_query!` instead")]
+#[macro_export]
+macro_rules! enable_multi_table_joins {
+    ($left_mod:ident, $right_mod:ident) => {
+        enable_multi_table_joins!($left_mod, $right_mod);
+    }
+}
+
 /// Allow two tables which are otherwise unrelated to be used together in a
 /// multi-table join. This macro only needs to be invoked when the two tables
 /// don't have an association between them (e.g. parent to grandchild)
@@ -978,7 +986,7 @@ macro_rules! joinable_inner {
 /// enable_multi_table_joins!(users, comments);
 /// ```
 #[macro_export]
-macro_rules! enable_multi_table_joins {
+macro_rules! allow_tables_to_appear_in_same_query {
     ($left_mod:ident, $right_mod:ident) => {
         impl $crate::query_source::AppearsInFromClause<$left_mod::table>
             for $right_mod::table

diesel/src/query_dsl/join_dsl.rs

@@ -55,9 +55,9 @@ where
 /// and we do not currently have a fleshed out story for dealing with table
 /// aliases.
 ///
-/// You may also need to call [`enable_multi_table_joins!`][] (particularly if
+/// You may also need to call [`allow_tables_to_appear_in_same_query!`][] (particularly if
 /// you see an unexpected error about `AppearsInFromClause`). See the
-/// documentation for [`enable_multi_table_joins!`][] for details.
+/// documentation for [`allow_tables_to_appear_in_same_query!`][] for details.
 ///
 /// Diesel expects multi-table joins to be semantically grouped based on the
 /// relationships. For example, `users.inner_join(posts.inner_join(comments))`
@@ -81,7 +81,7 @@ where
 /// ```
 ///
 /// [associations]: ../associations/index.html
-/// [`enable_multi_table_joins!`]: ../macro.enable_multi_table_joins.html
+/// [`allow_tables_to_appear_in_same_query!`]: ../macro.allow_tables_to_appear_in_same_query.html
 pub trait JoinDsl: Sized {
     /// Join two tables using a SQL `INNER JOIN`. The `ON` clause is defined
     /// via the [associations API](../associations/index.html).
@@ -137,7 +137,7 @@ pub trait JoinOnDsl: Sized {
     /// #     }
     /// # }
     /// #
-    /// # enable_multi_table_joins!(users, posts);
+    /// # allow_tables_to_appear_in_same_query!(users, posts);
     /// #
     /// # fn main() {
     /// #     let connection = establish_connection();

diesel_compile_tests/tests/compile-fail/cannot_join_to_non_joinable_table.rs

@@ -25,8 +25,8 @@ table! {
 }
 
 joinable!(comments -> posts (post_id));
-enable_multi_table_joins!(users, posts);
-enable_multi_table_joins!(users, comments);
+allow_tables_to_appear_in_same_query!(users, posts);
+allow_tables_to_appear_in_same_query!(users, comments);
 
 fn main() {
     let _ = users::table.inner_join(posts::table);

diesel_compile_tests/tests/compile-fail/filter_cannot_take_comparison_for_columns_from_another_table.rs

@@ -18,7 +18,7 @@ table! {
     }
 }
 
-enable_multi_table_joins!(users, posts);
+allow_tables_to_appear_in_same_query!(users, posts);
 
 #[derive(Queryable)]
 struct User {

diesel_compile_tests/tests/compile-fail/join_with_explicit_on_requires_valid_boolean_expression.rs

@@ -20,9 +20,9 @@ table! {
     }
 }
 
-enable_multi_table_joins!(users, posts);
-enable_multi_table_joins!(users, comments);
-enable_multi_table_joins!(posts, comments);
+allow_tables_to_appear_in_same_query!(users, posts);
+allow_tables_to_appear_in_same_query!(users, comments);
+allow_tables_to_appear_in_same_query!(posts, comments);
 
 fn main() {
     // Sanity check, make sure valid joins compile

diesel_compile_tests/tests/compile-fail/subselect_cannot_reference_random_tables.rs

@@ -21,9 +21,9 @@ table! {
     }
 }
 
-enable_multi_table_joins!(users, posts);
-enable_multi_table_joins!(users, comments);
-enable_multi_table_joins!(posts, comments);
+allow_tables_to_appear_in_same_query!(users, posts);
+allow_tables_to_appear_in_same_query!(users, comments);
+allow_tables_to_appear_in_same_query!(posts, comments);
 
 fn main() {
     use diesel::dsl::{any, exists};

diesel_infer_schema/src/information_schema.rs

@@ -112,8 +112,8 @@ mod information_schema {
         }
     }
 
-    enable_multi_table_joins!(table_constraints, referential_constraints);
-    enable_multi_table_joins!(key_column_usage, table_constraints);
+    allow_tables_to_appear_in_same_query!(table_constraints, referential_constraints);
+    allow_tables_to_appear_in_same_query!(key_column_usage, table_constraints);
 }
 
 pub fn get_table_data<Conn>(conn: &Conn, table: &TableName) -> QueryResult<Vec<ColumnInformation>>

diesel_infer_schema/src/mysql.rs

@@ -29,7 +29,7 @@ mod information_schema {
         }
     }
 
-    enable_multi_table_joins!(table_constraints, key_column_usage);
+    allow_tables_to_appear_in_same_query!(table_constraints, key_column_usage);
 }
 
 /// Even though this is using `information_schema`, MySQL needs non-ANSI columns

diesel_tests/tests/schema.rs

@@ -301,7 +301,7 @@ pub fn find_user_by_name(name: &str, connection: &TestConnection) -> User {
         .unwrap()
 }
 
-enable_multi_table_joins!(users, comments);
-enable_multi_table_joins!(posts, likes);
-enable_multi_table_joins!(followings, likes);
-enable_multi_table_joins!(followings, comments);
+allow_tables_to_appear_in_same_query!(users, comments);
+allow_tables_to_appear_in_same_query!(posts, likes);
+allow_tables_to_appear_in_same_query!(followings, likes);
+allow_tables_to_appear_in_same_query!(followings, comments);