Added "migrations" feature (#41)

* Creating feature "migrations".
Changed "canyon_observer" to "canyon_migrations"

* WIP - Bringing back canyon_manager as canyon_entities

* Refactoring functions rust datatype to database datatype to be standalone

* Cargo fmt

* Added lib and Cargo.toml for canyon_entities

---------

Co-authored-by: Gonzalo Busto Musi <gonzalo.busto@gmail.com>

Author: TheRustifyer

.github/workflows/code-quality.yml

@@ -55,7 +55,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        crate: [canyon_connection, canyon_crud, canyon_macros, canyon_observer]
+        crate: [canyon_connection, canyon_crud, canyon_macros, canyon_migrations]
     steps:
       - uses: actions/checkout@v3
 

Cargo.toml

@@ -13,7 +13,8 @@ description.workspace = true
 members = [
     "canyon_connection",
     "canyon_crud",
-    "canyon_observer",
+    "canyon_entities",
+    "canyon_migrations",
     "canyon_macros",
 
     "tests"
@@ -23,7 +24,8 @@ members = [
 # Project crates
 canyon_connection = { workspace = true, path = "canyon_connection" }
 canyon_crud = { workspace = true, path = "canyon_crud" }
-canyon_observer = { workspace = true, path = "canyon_observer" }
+canyon_entities = { workspace = true, path = "canyon_entities" }
+canyon_migrations = { workspace = true, path = "canyon_migrations", optional = true  }
 canyon_macros = { workspace = true, path = "canyon_macros" }
 
 # To be marked as opt deps
@@ -33,7 +35,8 @@ tiberius = { workspace = true, optional = true }
 [workspace.dependencies]
 canyon_crud = { version = "0.3.1", path = "canyon_crud" }
 canyon_connection = { version = "0.3.1", path = "canyon_connection" }
-canyon_observer = { version = "0.3.1", path = "canyon_observer" }
+canyon_entities = { version = "0.3.1", path = "canyon_entities" }
+canyon_migrations = { version = "0.3.1", path = "canyon_migrations"}
 canyon_macros = { version = "0.3.1", path = "canyon_macros" }
 
 tokio = { version = "1.27.0", features = ["full"]  }
@@ -52,20 +55,22 @@ toml = "0.7.3"
 async-trait = "0.1.68"
 walkdir = "2.3.3"
 regex = "1.5"
+partialdebug = "0.2.0"
 
 quote = "1.0.9"
 proc-macro2 = "1.0.27"
 
 [workspace.package]
 version = "0.3.1"
 edition = "2021"
-authors = ["Alex Vergara<pyzyryab@tutanota.com>, Gonzalo Busto<gbm25@gmail.com>"]
+authors = ["Alex Vergara<pyzyryab@tutanota.com>, Gonzalo Busto Musi<gonzalo.busto@gmail.com>"]
 documentation = "https://zerodaycode.github.io/canyon-book/"
 homepage = "https://github.com/zerodaycode/Canyon-SQL"
 readme = "README.md"
 license = "MIT"
 description = "A Rust ORM and QueryBuilder"
 
 [features]
-postgres = ["tokio-postgres", "canyon_connection/postgres", "canyon_crud/postgres", "canyon_observer/postgres", "canyon_macros/postgres"]
-mssql = ["tiberius", "canyon_connection/mssql", "canyon_crud/mssql", "canyon_observer/mssql", "canyon_macros/mssql"]
+postgres = ["tokio-postgres", "canyon_connection/postgres", "canyon_crud/postgres", "canyon_migrations/postgres", "canyon_macros/postgres"]
+mssql = ["tiberius", "canyon_connection/mssql", "canyon_crud/mssql", "canyon_migrations/mssql", "canyon_macros/mssql"]
+migrations = ["canyon_migrations", "canyon_macros/migrations"]

bash_aliases.sh

@@ -39,7 +39,7 @@ alias SqlServerInitializationLinux='cargo test initialize_sql_server_docker_inst
 
 
 # Publish Canyon-SQL to the registry with its dependencies
-alias PublishCanyon='cargo publish -p canyon_connection && cargo publish -p canyon_crud && cargo publish -p canyon_observer && cargo publish -p canyon_macros && cargo publish -p canyon_sql_root'
+alias PublishCanyon='cargo publish -p canyon_connection && cargo publish -p canyon_crud && cargo publish -p canyon_migrations && cargo publish -p canyon_macros && cargo publish -p canyon_sql_root'
 
 # Collects the code coverage for the project (tests must run before this)
 alias CcEnvVars='export CARGO_INCREMENTAL=0

canyon_entities/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "canyon_entities"
+version.workspace = true
+edition.workspace = true
+authors.workspace = true
+documentation.workspace = true
+homepage.workspace = true
+readme.workspace = true
+license.workspace = true
+description.workspace = true
+
+[dependencies]
+regex = { workspace = true }
+partialdebug = { workspace = true }
+quote = { workspace = true }
+proc-macro2 = { workspace = true }
+syn = { version = "1.0.86", features = ["full", "parsing"] } # TODO Pending to refactor and upgrade

canyon_observer/src/manager/entity.rs canyon_entities/src/entity.rscanyon_observer/src/manager/entity.rs renamed to canyon_entities/src/entity.rs

@@ -10,7 +10,7 @@ use syn::{
 use super::entity_fields::EntityField;
 
 /// Provides a convenient way of handling the data on any
-/// `CanyonEntity` struct anntotaded with the macro `#[canyon_entity]`
+/// `CanyonEntity` struct annotated with the macro `#[canyon_entity]`
 #[derive(PartialDebug, Clone)]
 pub struct CanyonEntity {
     pub struct_name: Ident,

…on_observer/src/manager/entity_fields.rs canyon_entities/src/entity_fields.rscanyon_observer/src/manager/entity_fields.rs renamed to canyon_entities/src/entity_fields.rs canyon_observer/src/manager/entity_fields.rs renamed to canyon_entities/src/entity_fields.rs

@@ -0,0 +1,11 @@
+use crate::register_types::CanyonRegisterEntity;
+use std::sync::Mutex;
+
+pub mod entity;
+pub mod entity_fields;
+pub mod field_annotation;
+pub mod manager_builder;
+pub mod register_types;
+
+pub static CANYON_REGISTER_ENTITIES: Mutex<Vec<CanyonRegisterEntity<'static>>> =
+    Mutex::new(Vec::new());

…observer/src/manager/field_annotation.rs canyon_entities/src/field_annotation.rscanyon_observer/src/manager/field_annotation.rs renamed to canyon_entities/src/field_annotation.rs canyon_observer/src/manager/field_annotation.rs renamed to canyon_entities/src/field_annotation.rs

@@ -0,0 +1,45 @@
+/// This file contains `Rust` types that represents an entry on the `CanyonRegister`
+/// where `Canyon` tracks the user types that has to manage
+
+pub const NUMERIC_PK_DATATYPE: [&str; 6] = ["i16", "u16", "i32", "u32", "i64", "u64"];
+
+/// Gets the necessary identifiers of a CanyonEntity to make it the comparative
+/// against the database schemas
+#[derive(Debug, Clone, Default)]
+pub struct CanyonRegisterEntity<'a> {
+    pub entity_name: &'a str,
+    pub entity_db_table_name: &'a str,
+    pub user_schema_name: Option<&'a str>,
+    pub entity_fields: Vec<CanyonRegisterEntityField>,
+}
+
+/// Complementary type for a field that represents a struct field that maps
+/// some real database column data
+#[derive(Debug, Clone, Default)]
+pub struct CanyonRegisterEntityField {
+    pub field_name: String,
+    pub field_type: String,
+    pub annotations: Vec<String>,
+}
+
+impl CanyonRegisterEntityField {
+    /// Return if the field is autoincremental
+    pub fn is_autoincremental(&self) -> bool {
+        let has_pk_annotation = self
+            .annotations
+            .iter()
+            .find(|a| a.starts_with("Annotation: PrimaryKey"));
+
+        let pk_is_autoincremental = match has_pk_annotation {
+            Some(annotation) => annotation.contains("true"),
+            None => false,
+        };
+
+        NUMERIC_PK_DATATYPE.contains(&self.field_type.as_str()) && pk_is_autoincremental
+    }
+
+    /// Return the nullability of a the field
+    pub fn is_nullable(&self) -> bool {
+        self.field_type.to_uppercase().starts_with("OPTION")
+    }
+}