Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support "Remove Model" in Automatic Migration Generator #221

Merged
merged 2 commits into from
Mar 4, 2025
Merged

Support "Remove Model" in Automatic Migration Generator #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9c7249
Add support for removing models in automatic migration generator
Soroushsrd Mar 3, 2025
3d089ba
Update cot-cli/src/migration_generator.rs
seqre Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 158 additions & 3 deletions cot-cli/src/migration_generator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,14 +498,18 @@ impl MigrationGenerator {
&format!("Model '{}'", &migration_model.model.name),
);

todo!();
let op = DynOperation::RemoveModel {
table_name: migration_model.model.table_name.clone(),
model_ty: migration_model.model.resolved_ty.clone(),
fields: migration_model.model.fields.clone(),
};

// line below should be removed once todo is implemented
#[allow(unreachable_code)]
print_status_msg(
StatusType::Removed,
&format!("Model '{}'", &migration_model.model.name),
);

op
}

fn generate_migration_file_content(&self, migration: GeneratedMigration) -> String {
Expand Down Expand Up @@ -937,6 +941,12 @@ impl GeneratedMigration {
because it doesn't create a new model"
)
}
DynOperation::RemoveModel { .. } => {
unreachable!(
"RemoveModel operation shouldn't be a dependency of CreateModel \
because it doesn't create a new model"
)
}
};
trace!(
"Removing foreign keys from {} to {}",
Expand Down Expand Up @@ -965,6 +975,10 @@ impl GeneratedMigration {
// removing it shouldn't ever affect whether a graph is cyclic
unreachable!("AddField operation should never create cycles")
}
DynOperation::RemoveModel { .. } => {
// RemoveModel doesn't create dependencies, it only removes a model
unreachable!("RemoveModel operation should never create cycles")
}
}
}

Expand Down Expand Up @@ -1060,6 +1074,10 @@ impl GeneratedMigration {

ops
}
DynOperation::RemoveModel { .. } => {
// RemoveModel Doesnt Add Foreign Keys
Vec::new()
}
})
.collect()
}
Expand Down Expand Up @@ -1198,6 +1216,11 @@ pub enum DynOperation {
model_ty: syn::Type,
field: Field,
},
RemoveModel {
table_name: String,
model_ty: syn::Type,
fields: Vec<Field>,
},
}

/// Returns whether given [`Field`] is a foreign key to given type.
Expand Down Expand Up @@ -1241,6 +1264,19 @@ impl Repr for DynOperation {
.build()
}
}
Self::RemoveModel {
table_name, fields, ..
} => {
let fields = fields.iter().map(Repr::repr).collect::<Vec<_>>();
quote! {
::cot::db::migrations::Operation::remove_model()
.table_name(::cot::db::Identifier::new(#table_name))
.fields(&[
#(#fields,)*
])
.build()
}
}
}
}
}
Expand Down Expand Up @@ -1728,6 +1764,125 @@ mod tests {
}
}

#[test]
fn make_remove_model_operation() {
let migration_model = ModelInSource {
model_item: parse_quote! {
struct UserModel {
#[model(primary_key)]
id: i32,
name: String,
}
},
model: Model {
name: format_ident!("UserModel"),
vis: syn::Visibility::Inherited,
original_name: "UserModel".to_string(),
resolved_ty: parse_quote!(UserModel),
model_type: Default::default(),
table_name: "user_model".to_string(),
pk_field: Field {
field_name: format_ident!("id"),
column_name: "id".to_string(),
ty: parse_quote!(i32),
auto_value: true,
primary_key: true,
unique: false,
foreign_key: None,
},
fields: vec![Field {
field_name: format_ident!("name"),
column_name: "name".to_string(),
ty: parse_quote!(String),
auto_value: false,
primary_key: false,
unique: false,
foreign_key: None,
}],
},
};

let generator = MigrationGenerator::new(
PathBuf::from("/fake/path/Cargo.toml"),
"test_crate".to_string(),
MigrationGeneratorOptions::default(),
);

let operation = generator.make_remove_model_operation(&migration_model);

match &operation {
DynOperation::RemoveModel {
table_name, fields, ..
} => {
assert_eq!(table_name, "user_model");
assert_eq!(fields.len(), 1);
assert_eq!(fields[0].column_name, "name");
}
_ => panic!("Expected DynOperation::RemoveModel"),
}
}

#[test]
fn generate_operations_with_removed_model() {
let app_models = vec![];

let migration_model = ModelInSource {
model_item: parse_quote! {
struct UserModel {
#[model(primary_key)]
id: i32,
name: String,
}
},
model: Model {
name: format_ident!("UserModel"),
vis: syn::Visibility::Inherited,
original_name: "UserModel".to_string(),
resolved_ty: parse_quote!(UserModel),
model_type: Default::default(),
table_name: "user_model".to_string(),
pk_field: Field {
field_name: format_ident!("id"),
column_name: "id".to_string(),
ty: parse_quote!(i32),
auto_value: true,
primary_key: true,
unique: false,
foreign_key: None,
},
fields: vec![Field {
field_name: format_ident!("name"),
column_name: "name".to_string(),
ty: parse_quote!(String),
auto_value: false,
primary_key: false,
unique: false,
foreign_key: None,
}],
},
};

let migration_models = vec![migration_model.clone()];

let generator = MigrationGenerator::new(
PathBuf::from("/fake/path/Cargo.toml"),
"test_crate".to_string(),
MigrationGeneratorOptions::default(),
);

let (_modified_models, operations) =
generator.generate_operations(&app_models, &migration_models);

assert_eq!(operations.len(), 1);

match &operations[0] {
DynOperation::RemoveModel { table_name, .. } => {
assert_eq!(table_name, "user_model");
}
_ => panic!("Expected DynOperation::RemoveModel"),
}
}

#[test]
fn generate_operations_with_modified_model() {
let app_model = ModelInSource {
Expand Down
Loading
Loading