feat: implement PartialEq for DynIden, SimpleExpr and related t…

…ypes (#620)

* feat: implement `PartialEq` for `SimpleExpr` and its related types

* ship our own `SeaRc`; old `SeaRc` is being re-export as `RcOrArc`

* fixup

* fmt

* bad idea to add `any::Any` as the super trait of `Iden`

* experiment

* assert two `dyn Iden` are of same type by comparing the memory address of vtable

* fmt

* more tests

src/expr.rs

@@ -19,7 +19,7 @@ pub struct Expr {
 ///
 /// [`SimpleExpr`] is a node in the expression tree and can represent identifiers, function calls,
 /// various operators and sub-queries.
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum SimpleExpr {
     Column(ColumnRef),
     Tuple(Vec<SimpleExpr>),

src/extension/postgres/func.rs

@@ -3,7 +3,7 @@
 use crate::{expr::*, func::*};
 
 /// Functions
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum PgFunction {
     ToTsquery,
     ToTsvector,

src/func.rs

@@ -6,7 +6,7 @@ use crate::{expr::*, types::*};
 pub use crate::extension::postgres::{PgFunc, PgFunction};
 
 /// Functions
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum Function {
     Max,
     Min,
@@ -29,7 +29,7 @@ pub enum Function {
 }
 
 /// Function call.
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct FunctionCall {
     pub(crate) func: Function,
     pub(crate) args: Vec<SimpleExpr>,

src/query/case.rs

@@ -1,12 +1,12 @@
 use crate::{Condition, IntoCondition, SimpleExpr};
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub(crate) struct CaseStatementCondition {
     pub(crate) condition: Condition,
     pub(crate) result: SimpleExpr,
 }
 
-#[derive(Debug, Clone, Default)]
+#[derive(Debug, Clone, Default, PartialEq)]
 pub struct CaseStatement {
     pub(crate) when: Vec<CaseStatementCondition>,
     pub(crate) r#else: Option<SimpleExpr>,

src/query/condition.rs

@@ -7,7 +7,7 @@ pub enum ConditionType {
 }
 
 /// Represents the value of an [`Condition::any`] or [`Condition::all`]: a set of disjunctive or conjunctive conditions.
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct Condition {
     pub(crate) negate: bool,
     pub(crate) condition_type: ConditionType,
@@ -23,21 +23,21 @@ pub type Cond = Condition;
 /// Represents anything that can be passed to an [`Condition::any`] or [`Condition::all`]'s [`Condition::add`] method.
 ///
 /// The arguments are automatically converted to the right enum.
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum ConditionExpression {
     Condition(Condition),
     SimpleExpr(SimpleExpr),
 }
 
-#[derive(Default, Debug, Clone)]
+#[derive(Default, Debug, Clone, PartialEq)]
 pub enum ConditionHolderContents {
     #[default]
     Empty,
     Chain(Vec<LogicalChainOper>),
     Condition(Condition),
 }
 
-#[derive(Default, Debug, Clone)]
+#[derive(Default, Debug, Clone, PartialEq)]
 pub struct ConditionHolder {
     pub contents: ConditionHolderContents,
 }

src/query/delete.rs

@@ -37,7 +37,7 @@ use inherent::inherent;
 ///     r#"DELETE FROM "glyph" WHERE "id" < 1 OR "id" > 10"#
 /// );
 /// ```
-#[derive(Default, Debug, Clone)]
+#[derive(Default, Debug, Clone, PartialEq)]
 pub struct DeleteStatement {
     pub(crate) table: Option<Box<TableRef>>,
     pub(crate) r#where: ConditionHolder,

src/query/insert.rs

@@ -9,7 +9,7 @@ use inherent::inherent;
 ///
 /// [`InsertValueSource`] is a node in the expression tree and can represent a raw value set
 /// ('VALUES') or a select query.
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub(crate) enum InsertValueSource {
     Values(Vec<Vec<SimpleExpr>>),
     Select(Box<SelectStatement>),
@@ -42,7 +42,7 @@ pub(crate) enum InsertValueSource {
 ///     r#"INSERT INTO "glyph" ("aspect", "image") VALUES (5.15, '12A'), (4.21, '123')"#
 /// );
 /// ```
-#[derive(Debug, Default, Clone)]
+#[derive(Debug, Default, Clone, PartialEq)]
 pub struct InsertStatement {
     pub(crate) replace: bool,
     pub(crate) table: Option<Box<TableRef>>,

src/query/mod.rs

@@ -46,7 +46,7 @@ pub enum QueryStatement {
     Delete(DeleteStatement),
 }
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum SubQueryStatement {
     SelectStatement(SelectStatement),
     InsertStatement(InsertStatement),

src/query/on_conflict.rs

@@ -1,6 +1,6 @@
 use crate::{ConditionHolder, DynIden, IntoCondition, IntoIden, SimpleExpr};
 
-#[derive(Debug, Clone, Default)]
+#[derive(Debug, Clone, Default, PartialEq)]
 pub struct OnConflict {
     pub(crate) target: Option<OnConflictTarget>,
     pub(crate) target_where: ConditionHolder,
@@ -9,14 +9,14 @@ pub struct OnConflict {
 }
 
 /// Represents ON CONFLICT (upsert) targets
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum OnConflictTarget {
     /// A list of columns with unique constraint
     ConflictColumns(Vec<DynIden>),
 }
 
 /// Represents ON CONFLICT (upsert) actions
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum OnConflictAction {
     /// Do nothing
     DoNothing,
@@ -25,7 +25,7 @@ pub enum OnConflictAction {
 }
 
 /// Represents strategies to update column in ON CONFLICT (upsert) actions
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum OnConflictUpdate {
     /// Update column value of existing row with inserting value
     Column(DynIden),

src/query/returning.rs

@@ -7,7 +7,7 @@ use crate::{ColumnRef, IntoColumnRef, SimpleExpr};
 /// * SQLite
 ///     - SQLite version >= 3.35.0
 ///     - **Note that sea-query won't try to enforce either of these constraints**
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, PartialEq)]
 pub enum ReturningClause {
     All,
     Columns(Vec<ColumnRef>),

src/query/select.rs

@@ -39,7 +39,7 @@ use inherent::inherent;
 ///     r#"SELECT "character", "font"."name" FROM "character" LEFT JOIN "font" ON "character"."font_id" = "font"."id" WHERE "size_w" IN (3, 4) AND "character" LIKE 'A%'"#
 /// );
 /// ```
-#[derive(Default, Debug, Clone)]
+#[derive(Default, Debug, Clone, PartialEq)]
 pub struct SelectStatement {
     pub(crate) distinct: Option<SelectDistinct>,
     pub(crate) selects: Vec<SelectExpr>,
@@ -57,7 +57,7 @@ pub struct SelectStatement {
 }
 
 /// List of distinct keywords that can be used in select statement
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum SelectDistinct {
     All,
     Distinct,
@@ -66,7 +66,7 @@ pub enum SelectDistinct {
 }
 
 /// Window type in [`SelectExpr`]
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum WindowSelectType {
     /// Name in [`SelectStatement`]
     Name(DynIden),
@@ -75,15 +75,15 @@ pub enum WindowSelectType {
 }
 
 /// Select expression used in select statement
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct SelectExpr {
     pub expr: SimpleExpr,
     pub alias: Option<DynIden>,
     pub window: Option<WindowSelectType>,
 }
 
 /// Join expression used in select statement
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct JoinExpr {
     pub join: JoinType,
     pub table: Box<TableRef>,
@@ -109,7 +109,7 @@ pub enum LockBehavior {
     SkipLocked,
 }
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct LockClause {
     pub(crate) r#type: LockType,
     pub(crate) tables: Vec<TableRef>,

src/query/update.rs

@@ -36,7 +36,7 @@ use inherent::inherent;
 ///     r#"UPDATE "glyph" SET "aspect" = 1.23, "image" = '123' WHERE "id" = 1"#
 /// );
 /// ```
-#[derive(Default, Debug, Clone)]
+#[derive(Default, Debug, Clone, PartialEq)]
 pub struct UpdateStatement {
     pub(crate) table: Option<Box<TableRef>>,
     pub(crate) values: Vec<(DynIden, Box<SimpleExpr>)>,

src/query/window.rs

@@ -40,7 +40,7 @@ pub trait OverStatement {
 }
 
 /// frame_start or frame_end clause
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum Frame {
     UnboundedPreceding,
     Preceding(u32),
@@ -50,14 +50,14 @@ pub enum Frame {
 }
 
 /// Frame type
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum FrameType {
     Range,
     Rows,
 }
 
 /// Frame clause
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct FrameClause {
     pub(crate) r#type: FrameType,
     pub(crate) start: Frame,
@@ -71,7 +71,7 @@ pub struct FrameClause {
 /// 1. <https://dev.mysql.com/doc/refman/8.0/en/window-function-descriptions.html>
 /// 2. <https://www.sqlite.org/windowfunctions.html>
 /// 3. <https://www.postgresql.org/docs/current/tutorial-window.html>
-#[derive(Default, Debug, Clone)]
+#[derive(Default, Debug, Clone, PartialEq)]
 pub struct WindowStatement {
     pub(crate) partition_by: Vec<SimpleExpr>,
     pub(crate) order_by: Vec<OrderExpr>,

src/query/with.rs

@@ -53,7 +53,7 @@ use std::ops::Deref;
 ///     DELETE FROM table WHERE table.a = cte_name.a)
 ///
 /// It is mandatory to set the [Self::table_name] and the [Self::query].
-#[derive(Debug, Clone, Default)]
+#[derive(Debug, Clone, Default, PartialEq)]
 pub struct CommonTableExpression {
     pub(crate) table_name: Option<DynIden>,
     pub(crate) cols: Vec<DynIden>,
@@ -193,7 +193,7 @@ impl CommonTableExpression {
 
 /// For recursive [WithQuery] [WithClause]s the traversing order can be specified in some databases
 /// that support this functionality.
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum SearchOrder {
     /// Breadth first traversal during the execution of the recursive query.
     BREADTH,
@@ -211,7 +211,7 @@ pub enum SearchOrder {
 ///
 /// Setting [Self::order] and [Self::expr] is mandatory. The [SelectExpr] used must specify an alias
 /// which will be the name that you can use to order the result of the [CommonTableExpression].
-#[derive(Debug, Clone, Default)]
+#[derive(Debug, Clone, Default, PartialEq)]
 pub struct Search {
     pub(crate) order: Option<SearchOrder>,
     pub(crate) expr: Option<SelectExpr>,
@@ -269,7 +269,7 @@ impl Search {
 /// A query can have both SEARCH and CYCLE clauses.
 ///
 /// Setting [Self::set], [Self::expr] and [Self::using] is mandatory.
-#[derive(Debug, Clone, Default)]
+#[derive(Debug, Clone, Default, PartialEq)]
 pub struct Cycle {
     pub(crate) expr: Option<SimpleExpr>,
     pub(crate) set_as: Option<DynIden>,
@@ -433,7 +433,7 @@ impl Cycle {
 ///     r#"WITH RECURSIVE "cte_traversal" ("id", "depth", "next", "value") AS (SELECT "id", 1, "next", "value" FROM "table" UNION ALL SELECT "id", "depth" + 1, "next", "value" FROM "table" INNER JOIN "cte_traversal" ON "cte_traversal"."next" = "table"."id") SELECT * FROM "cte_traversal""#
 /// );
 /// ```
-#[derive(Debug, Clone, Default)]
+#[derive(Debug, Clone, Default, PartialEq)]
 pub struct WithClause {
     pub(crate) recursive: bool,
     pub(crate) search: Option<Search>,
@@ -533,7 +533,7 @@ impl WithClause {
 ///     DELETE FROM table WHERE table.a = cte_name.a)
 ///
 /// It is mandatory to set the [Self::cte] and the [Self::query].
-#[derive(Debug, Clone, Default)]
+#[derive(Debug, Clone, Default, PartialEq)]
 pub struct WithQuery {
     pub(crate) with_clause: WithClause,
     pub(crate) query: Option<Box<SubQueryStatement>>,

src/table/column.rs

@@ -48,7 +48,7 @@ pub enum ColumnType {
         name: DynIden,
         variants: Vec<DynIden>,
     },
-    Array(SeaRc<ColumnType>),
+    Array(RcOrArc<ColumnType>),
     Cidr,
     Inet,
     MacAddr,
@@ -555,7 +555,7 @@ impl ColumnDef {
     /// Set column type as an array with a specified element type.
     /// This is only supported on Postgres.
     pub fn array(&mut self, elem_type: ColumnType) -> &mut Self {
-        self.types = Some(ColumnType::Array(SeaRc::new(elem_type)));
+        self.types = Some(ColumnType::Array(RcOrArc::new(elem_type)));
         self
     }