dbdoc_engine 0.1.0

data/config/routes.rb

@@ -0,0 +1,73 @@
+DbdocEngine::Engine.routes.draw do
+  # ------------------------
+  # Authentication Routes
+  # ------------------------
+  get    "login",  to: "db_doc_sessions#new"       # Login form
+  post   "login",  to: "db_doc_sessions#create"    # Perform login
+  delete "logout", to: "db_doc_sessions#destroy"   # Perform logout
+
+  # ------------------------
+  # Admin Namespace
+  # ------------------------
+  namespace :admin do
+    get "dashboard", to: "dashboard#index"
+    root to: "db_design_dynamic_tables#index" # Admin dashboard
+    get  "export_data", to: "data_transfer#export_data", defaults: { format: :json }
+    post "import_data", to: "data_transfer#import_data"
+    post "import_schema", to: "data_transfer#import_schema"
+
+    # Routes for dynamic tables
+    resources :db_design_dynamic_tables, except: [ :show ] do
+      collection do
+        get :render_column_fields              # Render dynamic column fields
+        get :columns                           # List columns for all tables
+        get :check_column_dependency           # Check column dependencies
+        get :deleted_tables                    # View soft-deleted tables
+        get :export_all_to_excel, defaults: { format: "xlsx" } # Export all tables to Excel
+      end
+
+      member do
+        get    :columns                        # List columns for a specific table
+        get    :show_table_info                # Show table metadata
+        patch  :restore                        # Restore a soft-deleted table
+        delete :permanent_destroy              # Permanently delete a table
+        get    :export_to_excel                # Export a specific table to Excel
+      end
+    end
+
+    # Routes for table groups
+    resources :db_design_table_groups, except: [ :show ] do
+      collection do
+        get :deleted_groups                    # View soft-deleted groups
+        get :existing_names                    # Check for existing group names
+      end
+
+      member do
+        patch  :restore                        # Restore a soft-deleted group
+        delete :permanent_destroy              # Permanently delete a group
+      end
+    end
+  end
+
+  # ------------------------
+  # Public Routes
+  # ------------------------
+  root "home#index" # Application landing page
+
+  get "group_details/:id", to: "home#group_details", as: "group_details"      # Show group details
+  get "table_details/:id", to: "home#table_details", as: "table_details"      # Show table details
+
+  get "changelogs",        to: "home#changelogs",        as: "changelogs"     # List all changelogs
+  get "changelogs/:id",    to: "home#changelog_details", as: "changelog_details" # Show specific changelog
+
+  get "schema_diagram", to: "schema_diagram#index", as: "schema_diagram"
+  get "schema_diagram/data", to: "schema_diagram#data", defaults: { format: :json }
+  # Make sure the route is accessible via AJAX/fetch
+  match "schema_diagram/data", to: "schema_diagram#data", via: [ :get, :post ], as: "schema_diagram_data_ajax"
+
+
+  # ------------------------
+  # Health Check Route
+  # ------------------------
+  get "up", to: "rails/health#show", as: :rails_health_check # Health check endpoint
+end

data/db/migrate/rails7/20250227060610_create_db_design_table_groups.rb

@@ -0,0 +1,15 @@
+# Migration to create the db_design_table_groups table
+# This table will store groups for organizing database designs, including a group name and color identifier.
+class CreateDbDesignTableGroups < ActiveRecord::Migration[7.0]
+  def change
+    create_table :db_design_table_groups do |t|
+      t.string :group_name, null: false, comment: "Group name for logical grouping of tables"
+      t.string :group_color, null: false, comment: "Color identifier for UI representation"
+      t.string :created_by, comment: "Username or ID of the creator"
+      t.string :updated_by, comment: "Username or ID of the user who last updated the record"
+      t.datetime :deleted_at, index: true, comment: "Timestamp for soft deletion"
+
+      t.timestamps  # created_at and updated_at
+    end
+  end
+end

data/db/migrate/rails7/20250227094626_create_db_design_dynamic_tables.rb

@@ -0,0 +1,19 @@
+# Migration to create the db_design_dynamic_tables table
+# This table will store dynamic tables within the db_design_table_groups, including table name, description, and creator information.
+class CreateDbDesignDynamicTables < ActiveRecord::Migration[7.0]
+  def change
+    create_table :db_design_dynamic_tables do |t|
+      t.string :table_name, null: false, comment: "Unique table name identifier"
+      t.string :physical_table_name, null: false, comment: "Japanese table name"
+      t.references :db_design_table_group, null: false, foreign_key: true, comment: "Foreign key to table group"
+      t.text :description, comment: "Optional description for the table"
+      t.string :created_by, null: false, comment: "Username or ID of the creator"
+      t.string :updated_by, comment: "Username or ID of the person who last updated the table"
+      t.datetime :deleted_at, index: true, comment: "Timestamp for soft deletion"
+
+      t.timestamps
+    end
+
+    add_index :db_design_dynamic_tables, :table_name, unique: true
+  end
+end

data/db/migrate/rails7/20250228022732_create_db_design_dynamic_columns.rb

@@ -0,0 +1,34 @@
+# Migration to create the db_design_dynamic_columns table
+# This table stores columns for dynamic tables in the db_design schema.
+# It includes metadata about the columns, such as name, data type, constraints (primary key, foreign key, not null, etc.),
+# and other properties (like description and creator information).
+class CreateDbDesignDynamicColumns < ActiveRecord::Migration[7.0]
+  def change
+    create_table :db_design_dynamic_columns do |t|
+      t.references :db_design_dynamic_table, null: false, foreign_key: true, comment: "Reference to the parent dynamic table"
+      t.string :column_name, null: false, comment: "Logical or display name for the column"
+      t.string :physical_column_name, null: false, comment: "Actual physical name used in DB schema"
+      t.string :data_type, null: false, comment: "Data type of the column"
+      t.integer :length, comment: "Optional field length or size (if applicable)"
+      t.integer :decimal_precision, comment: "decimal precision for floating point numbers"
+      t.boolean :is_primary_key, default: false, comment: "Marks column as primary key"
+      t.boolean :is_foreign_key, default: false, comment: "Marks column as foreign key"
+      t.string :foreign_table_name, comment: "Referenced table name (if foreign key)"
+      t.string :foreign_column_name, comment: "Referenced column name (if foreign key)"
+      t.string :relationship_type, comment: "Type of relationship (one-to-one, one-to-many, many-to-many) for foreign keys"
+      t.boolean :is_candidate_key, default: false, comment: "Marks column as a candidate key"
+      t.boolean :is_unique_key, default: false, comment: "Marks column as a unique key"
+      t.boolean :is_indexed, default: false, comment: "Marks column for indexing"
+      t.boolean :not_null, default: false, comment: "NOT NULL constraint"
+      t.string :default_value, comment: "Default value for the column"
+      t.string :sample_value, comment: "Sample value for the column"
+      t.text :description, comment: "Optional description for the column"
+      t.string :created_by, null: false, comment: "Username or ID of the creator"
+      t.datetime :deleted_at, index: true, comment: "Timestamp for soft deletion"
+
+      t.timestamps
+    end
+
+    add_index :db_design_dynamic_columns, [ :db_design_dynamic_table_id, :column_name ], unique: true, name: "index_dynamic_columns_on_table_and_column"
+  end
+end

data/db/migrate/rails7/20250401051453_create_db_design_changelogs.rb

@@ -0,0 +1,26 @@
+# Migration to create the db_design_changelogs table
+# This table stores logs of changes made to database design objects (e.g., tables, columns, groups).
+# It includes metadata about the change such as the timestamp, action type (create, update, delete),
+# entity type (table_group, table, column), entity name, a description of the change, and who made the change.
+# Previous and new values are stored for tracking updates and deletions.
+class CreateDbDesignChangelogs < ActiveRecord::Migration[7.0]
+  def change
+    create_table :db_design_changelogs do |t|
+      t.datetime :change_timestamp, null: false, comment: 'Timestamp when the change was made'
+      t.string :action_type, null: false, comment: 'Type of action (create, update, delete)'
+      t.string :entity_type, null: false, comment: 'Type of entity affected (table_group, table, column)'
+      t.string :entity_name, null: false, comment: 'Descriptive name of the entity (e.g., table_name, column_name)'
+      t.text :description, null: false, comment: 'Detailed explanation of the change'
+      t.string :changed_by, null: false, comment: 'User responsible for the change'
+      t.json :previous_values, comment: 'Stores previous values for updates or deletions'
+      t.json :new_values, comment: 'Stores new values for create or update actions'
+
+      t.timestamps
+    end
+
+    # Adding indices to improve query performance
+    add_index :db_design_changelogs, :change_timestamp
+    add_index :db_design_changelogs, :entity_type
+    add_index :db_design_changelogs, :entity_name
+  end
+end

data/db/migrate/rails7/20250411040822_create_users.rb

@@ -0,0 +1,14 @@
+class CreateUsers < ActiveRecord::Migration[7.0]
+  def change
+    create_table :dbdoc_engine_users do |t|
+      t.string :username, null: false, comment: "Username for authentication"
+      t.string :password_digest, null: false, comment: "Hashed password (bcrypt)"
+      t.string :role, null: false, default: "user", comment: "Role: user, admin, superadmin"
+
+      t.timestamps
+    end
+
+    add_index :dbdoc_engine_users, :username, unique: true, name: "index_dbdoc_engine_users_on_username"
+    add_index :dbdoc_engine_users, :role, name: "index_dbdoc_engine_users_on_role"
+  end
+end

data/db/migrate/rails7/20250421080851_add_missing_indexes_to_dbdoc_tables.rb

@@ -0,0 +1,23 @@
+class AddMissingIndexesToDbdocTables < ActiveRecord::Migration[7.0]
+  def change
+    add_index :db_design_changelogs, :action_type,
+              name: "index_db_design_changelogs_on_action_type"
+
+    add_index :db_design_changelogs, [:action_type, :change_timestamp],
+              name: "index_db_design_changelogs_on_action_type_and_timestamp",
+              order: { change_timestamp: :desc }
+
+    add_index :db_design_changelogs, :changed_by,
+              name: "index_db_design_changelogs_on_changed_by"
+
+    add_index :db_design_dynamic_columns, [:foreign_table_name, :foreign_column_name],
+              name: "index_dynamic_columns_on_fk_table_and_column"
+
+    add_index :db_design_dynamic_columns, :is_foreign_key,
+              name: "index_db_design_dynamic_columns_on_is_foreign_key"
+
+    add_index :db_design_table_groups, :group_name,
+              unique: true,
+              name: "index_db_design_table_groups_on_group_name"
+  end
+end

data/db/migrate/rails8/20250227060610_create_db_design_table_groups.rb

@@ -0,0 +1,15 @@
+# Migration to create the db_design_table_groups table
+# This table will store groups for organizing database designs, including a group name and color identifier.
+class CreateDbDesignTableGroups < ActiveRecord::Migration[8.0]
+  def change
+    create_table :db_design_table_groups do |t|
+      t.string :group_name, null: false, comment: "Group name for logical grouping of tables"
+      t.string :group_color, null: false, comment: "Color identifier for UI representation"
+      t.string :created_by, comment: "Username or ID of the creator"
+      t.string :updated_by, comment: "Username or ID of the user who last updated the record"
+      t.datetime :deleted_at, index: true, comment: "Timestamp for soft deletion"
+
+      t.timestamps  # created_at and updated_at
+    end
+  end
+end

data/db/migrate/rails8/20250227094626_create_db_design_dynamic_tables.rb

@@ -0,0 +1,19 @@
+# Migration to create the db_design_dynamic_tables table
+# This table will store dynamic tables within the db_design_table_groups, including table name, description, and creator information.
+class CreateDbDesignDynamicTables < ActiveRecord::Migration[8.0]
+  def change
+    create_table :db_design_dynamic_tables do |t|
+      t.string :table_name, null: false, comment: "Unique table name identifier"
+      t.string :physical_table_name, null: false, comment: "Japanese table name"
+      t.references :db_design_table_group, null: false, foreign_key: true, comment: "Foreign key to table group"
+      t.text :description, comment: "Optional description for the table"
+      t.string :created_by, null: false, comment: "Username or ID of the creator"
+      t.string :updated_by, comment: "Username or ID of the person who last updated the table"
+      t.datetime :deleted_at, index: true, comment: "Timestamp for soft deletion"
+
+      t.timestamps
+    end
+
+    add_index :db_design_dynamic_tables, :table_name, unique: true
+  end
+end

data/db/migrate/rails8/20250228022732_create_db_design_dynamic_columns.rb

@@ -0,0 +1,34 @@
+# Migration to create the db_design_dynamic_columns table
+# This table stores columns for dynamic tables in the db_design schema.
+# It includes metadata about the columns, such as name, data type, constraints (primary key, foreign key, not null, etc.),
+# and other properties (like description and creator information).
+class CreateDbDesignDynamicColumns < ActiveRecord::Migration[8.0]
+  def change
+    create_table :db_design_dynamic_columns do |t|
+      t.references :db_design_dynamic_table, null: false, foreign_key: true, comment: "Reference to the parent dynamic table"
+      t.string :column_name, null: false, comment: "Logical or display name for the column"
+      t.string :physical_column_name, null: false, comment: "Actual physical name used in DB schema"
+      t.string :data_type, null: false, comment: "Data type of the column"
+      t.integer :length, comment: "Optional field length or size (if applicable)"
+      t.integer :decimal_precision, comment: "decimal precision for floating point numbers"
+      t.boolean :is_primary_key, default: false, comment: "Marks column as primary key"
+      t.boolean :is_foreign_key, default: false, comment: "Marks column as foreign key"
+      t.string :foreign_table_name, comment: "Referenced table name (if foreign key)"
+      t.string :foreign_column_name, comment: "Referenced column name (if foreign key)"
+      t.string :relationship_type, comment: "Type of relationship (one-to-one, one-to-many, many-to-one, many-to-many) for foreign keys"
+      t.boolean :is_candidate_key, default: false, comment: "Marks column as a candidate key"
+      t.boolean :is_unique_key, default: false, comment: "Marks column as a unique key"
+      t.boolean :is_indexed, default: false, comment: "Marks column for indexing"
+      t.boolean :not_null, default: false, comment: "NOT NULL constraint"
+      t.string :default_value, comment: "Default value for the column"
+      t.string :sample_value, comment: "Sample value for the column"
+      t.text :description, comment: "Optional description for the column"
+      t.string :created_by, null: false, comment: "Username or ID of the creator"
+      t.datetime :deleted_at, index: true, comment: "Timestamp for soft deletion"
+
+      t.timestamps
+    end
+
+    add_index :db_design_dynamic_columns, [ :db_design_dynamic_table_id, :column_name ], unique: true, name: "index_dynamic_columns_on_table_and_column"
+  end
+end

data/db/migrate/rails8/20250401051453_create_db_design_changelogs.rb

@@ -0,0 +1,26 @@
+# Migration to create the db_design_changelogs table
+# This table stores logs of changes made to database design objects (e.g., tables, columns, groups).
+# It includes metadata about the change such as the timestamp, action type (create, update, delete),
+# entity type (table_group, table, column), entity name, a description of the change, and who made the change.
+# Previous and new values are stored for tracking updates and deletions.
+class CreateDbDesignChangelogs < ActiveRecord::Migration[8.0]
+  def change
+    create_table :db_design_changelogs do |t|
+      t.datetime :change_timestamp, null: false, comment: 'Timestamp when the change was made'
+      t.string :action_type, null: false, comment: 'Type of action (create, update, delete)'
+      t.string :entity_type, null: false, comment: 'Type of entity affected (table_group, table, column)'
+      t.string :entity_name, null: false, comment: 'Descriptive name of the entity (e.g., table_name, column_name)'
+      t.text :description, null: false, comment: 'Detailed explanation of the change'
+      t.string :changed_by, null: false, comment: 'User responsible for the change'
+      t.json :previous_values, comment: 'Stores previous values for updates or deletions'
+      t.json :new_values, comment: 'Stores new values for create or update actions'
+
+      t.timestamps
+    end
+
+    # Adding indices to improve query performance
+    add_index :db_design_changelogs, :change_timestamp
+    add_index :db_design_changelogs, :entity_type
+    add_index :db_design_changelogs, :entity_name
+  end
+end

data/db/migrate/rails8/20250411040822_create_users.rb

@@ -0,0 +1,14 @@
+class CreateUsers < ActiveRecord::Migration[8.0]
+  def change
+    create_table :dbdoc_engine_users do |t|
+      t.string :username, null: false, comment: "Username for authentication"
+      t.string :password_digest, null: false, comment: "Hashed password (bcrypt)"
+      t.string :role, null: false, default: "user", comment: "Role: user, admin, superadmin"
+
+      t.timestamps
+    end
+
+    add_index :dbdoc_engine_users, :username, unique: true, name: "index_dbdoc_engine_users_on_username"
+    add_index :dbdoc_engine_users, :role, name: "index_dbdoc_engine_users_on_role"
+  end
+end

data/db/migrate/rails8/20250421080851_add_missing_indexes_to_dbdoc_tables.rb

@@ -0,0 +1,23 @@
+class AddMissingIndexesToDbdocTables < ActiveRecord::Migration[8.0]
+  def change
+    add_index :db_design_changelogs, :action_type,
+              name: "index_db_design_changelogs_on_action_type"
+
+    add_index :db_design_changelogs, [:action_type, :change_timestamp],
+              name: "index_db_design_changelogs_on_action_type_and_timestamp",
+              order: { change_timestamp: :desc }
+
+    add_index :db_design_changelogs, :changed_by,
+              name: "index_db_design_changelogs_on_changed_by"
+
+    add_index :db_design_dynamic_columns, [:foreign_table_name, :foreign_column_name],
+              name: "index_dynamic_columns_on_fk_table_and_column"
+
+    add_index :db_design_dynamic_columns, :is_foreign_key,
+              name: "index_db_design_dynamic_columns_on_is_foreign_key"
+
+    add_index :db_design_table_groups, :group_name,
+              unique: true,
+              name: "index_db_design_table_groups_on_group_name"
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,28 @@
+if defined?(DbdocEngine::User)
+  user_class = DbdocEngine::User
+else
+  puts "Error: DbdocEngine::User model not found. Seeds cannot be loaded."
+  return
+end
+
+puts "Clearing existing #{user_class.name} records..."
+user_class.destroy_all
+
+users = [
+  { username: "user", role: "user", password: "password123" },
+  { username: "admin", role: "admin", password: "password123" },
+  { username: "superadmin", role: "superadmin", password: "password123" }
+]
+
+puts "Creating users..."
+users.each do |user_data|
+  user = user_class.create!(
+    username: user_data[:username],
+    role: user_data[:role],
+    password: user_data[:password],
+    password_confirmation: user_data[:password]
+  )
+  puts "  Created #{user.role}: #{user.username}"
+end
+
+puts "DbdocEngine seed completed. Created #{user_class.count} users."

data/lib/dbdoc_engine/engine.rb

@@ -0,0 +1,57 @@
+require "rails/engine"
+require "kaminari"
+require "kaminari-bootstrap"
+require "turbo-rails"
+require "stimulus-rails"
+require "inline_svg"
+require "caxlsx"
+require "caxlsx_rails"
+require "zip"
+require "select2-rails"
+
+module DbdocEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace DbdocEngine
+
+    config.autoload_paths += %W[
+      #{root}/app/models/concerns
+      #{root}/app/controllers/concerns
+      #{root}/app/models/DbdocEngine/concerns
+      #{root}/app/controllers/DbdocEngine/concerns
+    ]
+
+    config.app_middleware.use(
+      Rack::Static,
+      urls: [ "/dbdoc_engine_assets" ],  # URL prefix
+      root: DbdocEngine::Engine.root.join("public")  # Engine's public dir
+    )
+
+    # Single consolidated initializer
+    initializer "dbdoc_engine.config" do |app|
+      # Asset paths
+      app.config.assets.paths << root.join("app/assets/stylesheets")
+      app.config.assets.paths << root.join("app/assets/images")
+      app.config.assets.paths << root.join("app/javascript") # Added JavaScript directory
+      app.config.assets.paths << root.join("node_modules/bootstrap/dist/js")
+      app.config.assets.paths << root.join("node_modules/@popperjs/core/dist/umd")
+
+      # Precompile list
+      app.config.assets.precompile += %w[
+        dbdoc_engine/application.css
+        dbdoc_engine/application.js
+        dbdoc_engine/*.svg
+        dbdoc_engine/*.png
+      ]
+
+      # Importmap configuration
+      Rails.application.importmap.draw do
+        eval File.read(DbdocEngine::Engine.root.join("config/importmap.rb"))
+      end
+
+      app.config.importmap.cache_sweepers += [ root.join("app/javascript").to_s ]
+    end
+    rake_tasks do
+      load 'tasks/dbdoc_engine_tasks.rake'
+    end
+  end
+end

data/lib/dbdoc_engine/version.rb

@@ -0,0 +1,3 @@
+module DbdocEngine
+  VERSION = "0.1.0"
+end

data/lib/dbdoc_engine.rb

@@ -0,0 +1,9 @@
+require "rails"
+require_relative "dbdoc_engine/version"
+require_relative "dbdoc_engine/engine"
+
+module DbdocEngine
+  # def self.table_name_prefix
+  #   '' # Explicitly return empty string
+  # end
+end