Expand SeaORM entity generator with Seaography related data

CHANGELOG.md

@@ -165,6 +165,33 @@ pub enum Relation {}
 impl ActiveModelBehavior for ActiveModel {}
 ```
 
+* Add `seaography` flag to `sea-orm-cli` https://github.com/SeaQL/sea-orm/pull/1599
+* Add generation of `seaography` related information to `sea-orm-codegen` https://github.com/SeaQL/sea-orm/pull/1599
+
+    The following information is added in entities files by `sea-orm-cli` when flag `seaography` is `true`
+```rust
+/// ... Entity File ...
+
+#[derive(Copy, Clone, Debug, EnumIter, DeriveRelatedEntity)]
+pub enum RelatedEntity {
+    #[sea_orm(entity = "super::address::Entity")]
+    Address,
+    #[sea_orm(entity = "super::payment::Entity")]
+    Payment,
+    #[sea_orm(entity = "super::rental::Entity")]
+    Rental,
+    #[sea_orm(entity = "Entity", def = "Relation::SelfRef.def()")]
+    SelfRef,
+    #[sea_orm(entity = "super::store::Entity")]
+    Store,
+    #[sea_orm(entity = "Entity", def = "Relation::SelfRef.def().rev()")]
+    SelfRefRev,
+}
+```
+* Add `DeriveEntityRelated` macro https://github.com/SeaQL/sea-orm/pull/1599
+
+    The DeriveRelatedEntity derive macro will implement `seaography::RelationBuilder` for `RelatedEntity` enumeration
+
 ### Enhancements
 
 * Added `Migration::name()` and `Migration::status()` getters for the name and status of `sea_orm_migration::Migration` https://github.com/SeaQL/sea-orm/pull/1519
@@ -410,7 +437,7 @@ impl ColumnTrait for Column {
 ### Breaking Changes
 
 * [sea-orm-cli] Enable --universal-time by default https://github.com/SeaQL/sea-orm/pull/1420
-* Added `RecordNotInserted` and `RecordNotUpdated` to `DbErr` 
+* Added `RecordNotInserted` and `RecordNotUpdated` to `DbErr`
 * Added `ConnectionTrait::execute_unprepared` method https://github.com/SeaQL/sea-orm/pull/1327
 * As part of https://github.com/SeaQL/sea-orm/pull/1311, the required method of `TryGetable` changed:
 ```rust

sea-orm-cli/src/cli.rs

@@ -321,6 +321,14 @@ pub enum GenerateSubcommands {
             help = r#"Add extra attributes to generated model struct, no need for `#[]` (comma separated), e.g. `--model-extra-attributes 'serde(rename_all = "camelCase")','ts(export)'`"#
         )]
         model_extra_attributes: Vec<String>,
+
+        #[clap(
+            action,
+            long,
+            default_value = "false",
+            long_help = "Generate helper Enumerations that are used by Seaography."
+        )]
+        seaography: bool,
     },
 }
 

sea-orm-cli/src/commands/generate.rs

@@ -31,6 +31,7 @@ pub async fn run_generate_command(
             lib,
             model_extra_derives,
             model_extra_attributes,
+            seaography,
         } => {
             if verbose {
                 let _ = tracing_subscriber::fmt()
@@ -172,6 +173,7 @@ pub async fn run_generate_command(
                 serde_skip_hidden_column,
                 model_extra_derives,
                 model_extra_attributes,
+                seaography,
             );
             let output = EntityTransformer::transform(table_stmts)?.generate(&writer_context);
 

sea-orm-codegen/src/entity/base_entity.rs

@@ -92,6 +92,26 @@ impl Entity {
             .collect()
     }
 
+    /// Used to generate the names for the `enum RelatedEntity` that is useful to the Seaography project
+    pub fn get_related_entity_enum_name(&self) -> Vec<Ident> {
+        // 1st step get conjunct relations data
+        let conjunct_related_names = self.get_conjunct_relations_to_upper_camel_case();
+
+        // 2nd step get reverse self relations data
+        let self_relations_reverse = self
+            .relations
+            .iter()
+            .filter(|rel| rel.self_referencing)
+            .map(|rel| format_ident!("{}Reverse", rel.get_enum_name()));
+
+        // 3rd step get normal relations data
+        self.get_relation_enum_name()
+            .into_iter()
+            .chain(self_relations_reverse)
+            .chain(conjunct_related_names.into_iter())
+            .collect()
+    }
+
     pub fn get_relation_defs(&self) -> Vec<TokenStream> {
         self.relations.iter().map(|rel| rel.get_def()).collect()
     }
@@ -100,6 +120,64 @@ impl Entity {
         self.relations.iter().map(|rel| rel.get_attrs()).collect()
     }
 
+    /// Used to generate the attributes for the `enum RelatedEntity` that is useful to the Seaography project
+    pub fn get_related_entity_attrs(&self) -> Vec<TokenStream> {
+        // 1st step get conjunct relations data
+        let conjunct_related_attrs = self.conjunct_relations.iter().map(|conj| {
+            let entity = format!("super::{}::Entity", conj.get_to_snake_case());
+
+            quote! {
+                #[sea_orm(
+                    entity = #entity
+                )]
+            }
+        });
+
+        // helper function that generates attributes for `Relation` data
+        let produce_relation_attrs = |rel: &Relation, reverse: bool| {
+            let entity = match rel.get_module_name() {
+                Some(module_name) => format!("super::{}::Entity", module_name),
+                None => String::from("Entity"),
+            };
+
+            if rel.self_referencing || !rel.impl_related || rel.num_suffix > 0 {
+                let def = if reverse {
+                    format!("Relation::{}.def().rev()", rel.get_enum_name())
+                } else {
+                    format!("Relation::{}.def()", rel.get_enum_name())
+                };
+
+                quote! {
+                    #[sea_orm(
+                        entity = #entity,
+                        def = #def
+                    )]
+                }
+            } else {
+                quote! {
+                    #[sea_orm(
+                        entity = #entity
+                    )]
+                }
+            }
+        };
+
+        // 2nd step get reverse self relations data
+        let self_relations_reverse_attrs = self
+            .relations
+            .iter()
+            .filter(|rel| rel.self_referencing)
+            .map(|rel| produce_relation_attrs(rel, true));
+
+        // 3rd step get normal relations data
+        self.relations
+            .iter()
+            .map(|rel| produce_relation_attrs(rel, false))
+            .chain(self_relations_reverse_attrs)
+            .chain(conjunct_related_attrs)
+            .collect()
+    }
+
     pub fn get_primary_key_auto_increment(&self) -> Ident {
         let auto_increment = self.columns.iter().any(|col| col.auto_increment);
         format_ident!("{}", auto_increment)

sea-orm-codegen/src/entity/transformer.rs

@@ -385,6 +385,7 @@ mod tests {
                     false,
                     &Default::default(),
                     &Default::default(),
+                    false,
                 )
                 .into_iter()
                 .skip(1)