Expand SeaORM entity generator with Seaography related data

CHANGELOG.md

@@ -165,6 +165,56 @@ 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
+```rust
+/// ... Entity File ...
+
+/// the following information is added by `sea-orm-cli` when flag `seaography` is `true`
+impl seaography::RelationBuilder for Relation {
+    fn get_relation(&self, context: & 'static seaography::BuilderContext) -> async_graphql::dynamic::Field {
+        let builder = seaography::EntityObjectRelationBuilder { context };
+        match self {
+            Self::Fruit => builder.get_relation:: <Entity, super::fruit::Entity>("fruit", Self::Fruit.def()),
+            _ => panic!("No relations for this entity")
+        }
+    }
+}
+
+impl seaography::RelationBuilder for RelatedEntity {
+    fn get_relation(&self, context: & 'static seaography::BuilderContext) -> async_graphql::dynamic::Field {
+        let builder = seaography::EntityObjectViaRelationBuilder { context };
+        match self {
+            Self::Fruit => builder.get_relation:: <Entity, super::fruit::Entity>("fruit"),
+            Self::Filling => builder.get_relation:: <Entity, super::filling::Entity>("filling"),
+            _ => panic!("No relations for this entity")
+        }
+    }
+}
+
+```
+* Add `DeriveEntityRelated` macro https://github.com/SeaQL/sea-orm/pull/1599
+```rust
+/// when generating SeaORM entities on compact format the generator will output
+/// instead of many blocks of `impl Related` trait
+
+#[derive(Copy, Clone, Debug, EnumIter, DeriveRelatedEntity)]
+pub enum RelatedEntity {
+    #[sea_orm(
+        entity = "sea_orm::tests_cfg::fruit::Entity",
+        to = "sea_orm::tests_cfg::cake_expanded::Relation::Fruit.def()"
+    )]
+    Fruit,
+    #[sea_orm(
+        entity = "sea_orm::tests_cfg::filling::Entity",
+        to = "sea_orm::tests_cfg::cake_filling::Relation::Filling.def()",
+        via = "Some(sea_orm::tests_cfg::cake_filling::Relation::Cake.def().rev())"
+    )]
+    Filling
+}
+```
+* When generating **compact** entities with `sea-orm-cli` the `sea-orm-codegen` uses `DeriveEntityRelated` macro instead of generating the `impl Related` code https://github.com/SeaQL/sea-orm/pull/1599
+
 ### 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 +460,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 and Traits 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,17 @@ impl Entity {
             .collect()
     }
 
+    pub fn get_related_enum_name(&self) -> Vec<Ident> {
+        let conjunct_related = self.get_conjunct_relations_to_upper_camel_case();
+
+        self.relations
+            .iter()
+            .filter(|rel| !rel.self_referencing && rel.num_suffix == 0 && rel.impl_related)
+            .map(|rel| rel.get_enum_name())
+            .chain(conjunct_related.into_iter())
+            .collect()
+    }
+
     pub fn get_relation_defs(&self) -> Vec<TokenStream> {
         self.relations.iter().map(|rel| rel.get_def()).collect()
     }
@@ -100,6 +111,96 @@ impl Entity {
         self.relations.iter().map(|rel| rel.get_attrs()).collect()
     }
 
+    pub fn get_related_attrs(&self) -> Vec<TokenStream> {
+        let table_name_camel_case = self.get_table_name_camel_case_ident();
+        let via_snake_case = self.get_conjunct_relations_via_snake_case();
+        let to_snake_case = self.get_conjunct_relations_to_snake_case();
+        let to_upper_camel_case = self.get_conjunct_relations_to_upper_camel_case();
+
+        let conjunct_related = via_snake_case
+            .into_iter()
+            .zip(to_snake_case)
+            .zip(to_upper_camel_case)
+            .map(|((via_snake_case, to_snake_case), to_upper_camel_case)| {
+                let to = format!(
+                    "super::{}::Relation::{}.def()",
+                    via_snake_case, to_upper_camel_case
+                );
+                let via = format!(
+                    "Some(super::{}::Relation::{}.def().rev())",
+                    via_snake_case, table_name_camel_case
+                );
+                let entity = format!("super::{}::Entity", to_snake_case);
+
+                quote! {
+                    #[sea_orm(
+                        entity = #entity,
+                        to = #to,
+                        via = #via
+                    )]
+                }
+            });
+
+        self.relations
+            .iter()
+            .filter(|rel| !rel.self_referencing && rel.num_suffix == 0 && rel.impl_related)
+            .map(|rel| rel.get_related_attrs())
+            .chain(conjunct_related)
+            .collect()
+    }
+
+    pub fn get_basic_relations(&self) -> Vec<TokenStream> {
+        self.relations
+            .iter()
+            .map(|rel| {
+                let enum_name = rel.get_enum_name();
+                let name = enum_name.to_string().to_snake_case();
+
+                let path = match rel.get_module_name() {
+                    Some(module_name) => quote!{ super::#module_name::Entity },
+                    None => quote!{ Entity },
+                };
+
+                quote! {
+                    Self::#enum_name => builder.get_relation::<Entity, #path>(#name, Self::#enum_name.def())
+                }
+            }).collect()
+    }
+
+    pub fn get_related_relations(&self) -> Vec<TokenStream> {
+        let to_snake_case = self.get_conjunct_relations_to_snake_case();
+        let to_upper_camel_case = self.get_conjunct_relations_to_upper_camel_case();
+
+        let conj_related = to_snake_case
+            .into_iter()
+            .zip(to_upper_camel_case)
+            .map(|(to_snake_case, to_upper_camel_case)| {
+                let name = to_snake_case.to_string();
+                quote! {
+                    Self::#to_upper_camel_case => builder.get_relation::<Entity, super::#to_snake_case::Entity>(#name)
+                }
+            });
+
+        self.relations
+            .iter()
+            .filter(|rel| !rel.self_referencing && rel.num_suffix == 0 && rel.impl_related)
+            .map(|rel| {
+                let enum_name = rel.get_enum_name();
+                let name = enum_name.to_string().to_snake_case();
+
+                let path = match rel.get_module_name() {
+                    Some(module_name) => quote! { super::#module_name::Entity },
+                    None => quote! { Entity },
+                };
+
+                quote! {
+                    Self::#enum_name => builder.get_relation::<Entity, #path>(#name)
+                }
+            })
+            .chain(conj_related)
+            .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/relation.rs

@@ -131,6 +131,21 @@ impl Relation {
         }
     }
 
+    pub fn get_related_attrs(&self) -> TokenStream {
+        let enum_name = self.get_enum_name();
+
+        let entity = match self.get_module_name() {
+            Some(module_name) => format!("super::{}::Entity", module_name),
+            None => String::from("Entity"),
+        };
+
+        let to = format!("Relation::{}.def()", enum_name);
+
+        quote! {
+            #[sea_orm(entity = #entity, to = #to)]
+        }
+    }
+
     pub fn get_rel_type(&self) -> Ident {
         match self.rel_type {
             RelationType::HasOne => format_ident!("has_one"),

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

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