Skip to content

✨ enhance the schema.rb parser to support Constraints #1408

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

✨ enhance the schema.rb parser to support Constraints #1408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8db5874
✨ update parser to set constraints object
tnyo43 Apr 20, 2025
1b903a0
✨ set PRIMARY KEY constraint for "id" column
tnyo43 Apr 20, 2025
7179225
✨ set FOREIGN KEY constraint
tnyo43 Apr 20, 2025
2f880cf
✨ set CHECK constraint when `add_check_constraint` is set
tnyo43 Apr 20, 2025
e4d0639
✨ set UNIQUE constraint when `index` is set with `unique: true`
tnyo43 Apr 20, 2025
ecd3ace
🔧 revert chagens of testcases.ts
tnyo43 Apr 22, 2025
ee6053f
🔧 fix test cases by mentioning their own expected objects
tnyo43 Apr 22, 2025
53fee26
🔧 update snapshots
tnyo43 Apr 22, 2025
8d71055
add changeset
tnyo43 Apr 22, 2025
4a31a5a
✨ add helper function to generate random identifier
tnyo43 Apr 26, 2025
83cc5e5
🐛 set columnName and name of the constraint if it's not provided
tnyo43 Apr 26, 2025
d893b3b
🔧 integrate the logic to generate foreign key constraint name with re…
tnyo43 Apr 26, 2025
4ac6aa3
Merge branch 'main' into feat/schemarb-constraints
tnyo43 Apr 26, 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
5 changes: 5 additions & 0 deletions .changeset/wet-zoos-add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@liam-hq/db-structure": patch
---

✨ Enhance the schema.rb parser to support Constraints
216 changes: 206 additions & 10 deletions frontend/packages/db-structure/src/parser/__snapshots__/index.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,31 @@ exports[`parse > should parse schema.rb to JSON correctly 1`] = `
},
},
"comment": "Stores comments on tasks, enabling discussions or updates.",
"constraints": {},
"constraints": {
"PRIMARY_id": {
"columnName": "id",
"name": "PRIMARY_id",
"type": "PRIMARY KEY",
},
"fk_comments_task_id": {
"columnName": "task_id",
"deleteConstraint": "CASCADE",
"name": "fk_comments_task_id",
"targetColumnName": "id",
"targetTableName": "tasks",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
"fk_comments_user_id": {
"columnName": "user_id",
"deleteConstraint": "CASCADE",
"name": "fk_comments_user_id",
"targetColumnName": "id",
"targetTableName": "users",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
},
"indexes": {
"index_comments_on_task_id": {
"columns": [
Expand Down Expand Up @@ -361,7 +385,13 @@ exports[`parse > should parse schema.rb to JSON correctly 1`] = `
},
},
"comment": "Represents organizations using the system. Each company is a top-level entity that owns departments, users, and projects.",
"constraints": {},
"constraints": {
"PRIMARY_id": {
"columnName": "id",
"name": "PRIMARY_id",
"type": "PRIMARY KEY",
},
},
"indexes": {},
"name": "companies",
},
Expand Down Expand Up @@ -399,7 +429,22 @@ exports[`parse > should parse schema.rb to JSON correctly 1`] = `
},
},
"comment": "Represents departments within a company, organizing users into functional groups.",
"constraints": {},
"constraints": {
"PRIMARY_id": {
"columnName": "id",
"name": "PRIMARY_id",
"type": "PRIMARY KEY",
},
"fk_departments_company_id": {
"columnName": "company_id",
"deleteConstraint": "CASCADE",
"name": "fk_departments_company_id",
"targetColumnName": "id",
"targetTableName": "companies",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
},
"indexes": {
"index_departments_on_company_id": {
"columns": [
Expand Down Expand Up @@ -446,7 +491,36 @@ exports[`parse > should parse schema.rb to JSON correctly 1`] = `
},
},
"comment": "Associates users with projects they are assigned to work on.",
"constraints": {},
"constraints": {
"PRIMARY_id": {
"columnName": "id",
"name": "PRIMARY_id",
"type": "PRIMARY KEY",
},
"UNIQUE_user_id": {
"columnName": "user_id",
"name": "UNIQUE_user_id",
"type": "UNIQUE",
},
"fk_project_assignments_project_id": {
"columnName": "project_id",
"deleteConstraint": "CASCADE",
"name": "fk_project_assignments_project_id",
"targetColumnName": "id",
"targetTableName": "projects",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
"fk_project_assignments_user_id": {
"columnName": "user_id",
"deleteConstraint": "CASCADE",
"name": "fk_project_assignments_user_id",
"targetColumnName": "id",
"targetTableName": "users",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
},
"indexes": {
"index_project_assignments_on_user_id_and_project_id": {
"columns": [
Expand Down Expand Up @@ -504,7 +578,22 @@ exports[`parse > should parse schema.rb to JSON correctly 1`] = `
},
},
"comment": "Represents projects managed within a company. Projects are linked to tasks and users.",
"constraints": {},
"constraints": {
"PRIMARY_id": {
"columnName": "id",
"name": "PRIMARY_id",
"type": "PRIMARY KEY",
},
"fk_projects_company_id": {
"columnName": "company_id",
"deleteConstraint": "CASCADE",
"name": "fk_projects_company_id",
"targetColumnName": "id",
"targetTableName": "companies",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
},
"indexes": {
"index_projects_on_company_id": {
"columns": [
Expand Down Expand Up @@ -551,7 +640,13 @@ exports[`parse > should parse schema.rb to JSON correctly 1`] = `
},
},
"comment": "Defines roles that can be assigned to users, such as 'Admin' or 'Manager'.",
"constraints": {},
"constraints": {
"PRIMARY_id": {
"columnName": "id",
"name": "PRIMARY_id",
"type": "PRIMARY KEY",
},
},
"indexes": {},
"name": "roles",
},
Expand Down Expand Up @@ -629,7 +724,31 @@ exports[`parse > should parse schema.rb to JSON correctly 1`] = `
},
},
"comment": "Represents tasks within a project, assigned to users with deadlines and statuses.",
"constraints": {},
"constraints": {
"PRIMARY_id": {
"columnName": "id",
"name": "PRIMARY_id",
"type": "PRIMARY KEY",
},
"fk_tasks_assigned_user_id": {
"columnName": "assigned_user_id",
"deleteConstraint": "RESTRICT",
"name": "fk_tasks_assigned_user_id",
"targetColumnName": "id",
"targetTableName": "users",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
"fk_tasks_project_id": {
"columnName": "project_id",
"deleteConstraint": "CASCADE",
"name": "fk_tasks_project_id",
"targetColumnName": "id",
"targetTableName": "projects",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
},
"indexes": {
"index_tasks_on_assigned_user_id": {
"columns": [
Expand Down Expand Up @@ -714,7 +833,31 @@ exports[`parse > should parse schema.rb to JSON correctly 1`] = `
},
},
"comment": "Tracks time spent by users on tasks for reporting or billing purposes.",
"constraints": {},
"constraints": {
"PRIMARY_id": {
"columnName": "id",
"name": "PRIMARY_id",
"type": "PRIMARY KEY",
},
"fk_timesheets_task_id": {
"columnName": "task_id",
"deleteConstraint": "CASCADE",
"name": "fk_timesheets_task_id",
"targetColumnName": "id",
"targetTableName": "tasks",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
"fk_timesheets_user_id": {
"columnName": "user_id",
"deleteConstraint": "CASCADE",
"name": "fk_timesheets_user_id",
"targetColumnName": "id",
"targetTableName": "users",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
},
"indexes": {
"index_timesheets_on_task_id": {
"columns": [
Expand Down Expand Up @@ -769,7 +912,36 @@ exports[`parse > should parse schema.rb to JSON correctly 1`] = `
},
},
"comment": "Associates users with roles to define their permissions within the company.",
"constraints": {},
"constraints": {
"PRIMARY_id": {
"columnName": "id",
"name": "PRIMARY_id",
"type": "PRIMARY KEY",
},
"UNIQUE_user_id": {
"columnName": "user_id",
"name": "UNIQUE_user_id",
"type": "UNIQUE",
},
"fk_user_roles_role_id": {
"columnName": "role_id",
"deleteConstraint": "CASCADE",
"name": "fk_user_roles_role_id",
"targetColumnName": "id",
"targetTableName": "roles",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
"fk_user_roles_user_id": {
"columnName": "user_id",
"deleteConstraint": "CASCADE",
"name": "fk_user_roles_user_id",
"targetColumnName": "id",
"targetTableName": "users",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
},
"indexes": {
"index_user_roles_on_user_id_and_role_id": {
"columns": [
Expand Down Expand Up @@ -867,7 +1039,31 @@ exports[`parse > should parse schema.rb to JSON correctly 1`] = `
},
},
"comment": "Represents employees or members of a company, who are assigned roles and tasks.",
"constraints": {},
"constraints": {
"PRIMARY_id": {
"columnName": "id",
"name": "PRIMARY_id",
"type": "PRIMARY KEY",
},
"fk_users_company_id": {
"columnName": "company_id",
"deleteConstraint": "CASCADE",
"name": "fk_users_company_id",
"targetColumnName": "id",
"targetTableName": "companies",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
"fk_users_department_id": {
"columnName": "department_id",
"deleteConstraint": "CASCADE",
"name": "fk_users_department_id",
"targetColumnName": "id",
"targetTableName": "departments",
"type": "FOREIGN KEY",
"updateConstraint": "RESTRICT",
},
},
"indexes": {
"index_users_on_company_id": {
"columns": [
Expand Down
Loading
Loading