dbdoc_engine 0.1.0

data/lib/generators/dbdoc_engine/install/install_generator.rb

@@ -0,0 +1,245 @@
+require "rails/generators"
+require "rails/generators/base"
+require "rake"
+
+module DbdocEngine
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Install DbdocEngine: copies migrations, seeds default users, configures routes and JS"
+
+      source_root File.expand_path("templates", __dir__)
+
+      def welcome
+        say ""
+        say "=" * 60, :green
+        say "  DbdocEngine Installer", :green
+        say "=" * 60, :green
+        say ""
+        say "  This will set up DbdocEngine in your Rails application.", :cyan
+        say "  Rails version detected: #{Rails.version}", :cyan
+        say ""
+      end
+
+      def check_prerequisites
+        say_step "Checking prerequisites..."
+
+        unless defined?(ActiveRecord::Base)
+          say "ERROR: ActiveRecord is required. Please ensure your app uses ActiveRecord.", :red
+          raise SystemExit
+        end
+
+        db_config = ActiveRecord::Base.connection_db_config
+        say_done "Database: #{db_config.adapter} (#{db_config.database})"
+      end
+
+      def copy_and_run_migrations
+        rails_version = Rails.version.to_f
+
+        say_step "Copying migrations (Rails #{rails_version >= 8.0 ? '8.x' : '7.x'})..."
+        copy_migrations(rails_version)
+        say_done "Migrations copied"
+
+        Rake::Task.clear
+        Rails.application.load_tasks
+
+        invoke_task("dbdoc_engine:install:migrations", "Installing engine migrations")
+        invoke_task("db:migrate", "Running migrations")
+      end
+
+      def seed_default_users
+        say_step "Seeding default users..."
+
+        Rake::Task.clear
+        Rails.application.load_tasks
+
+        invoke_task("dbdoc_engine:install:seeds", "Copying seed file")
+        invoke_task("dbdoc_engine:db:seed", "Creating default users")
+
+        say_done "Default users created (user / admin / superadmin)"
+      end
+
+      def setup_javascript
+        rails_version = Rails.version.to_f
+
+        if rails_version < 8.0
+          install_js_stack
+        end
+
+        update_importmap
+        update_application_js
+
+        if rails_version < 8.0
+          update_manifest
+        end
+      end
+
+      def setup_routes
+        update_routes
+      end
+
+      def complete
+        say ""
+        say "=" * 60, :green
+        say "  DbdocEngine installed successfully!", :green
+        say "=" * 60, :green
+        say ""
+        say "  Access your documentation at: http://localhost:3000/dbdoc", :cyan
+        say ""
+        say "  Default login credentials:", :cyan
+        say "    user      / password123  (read-only)", :cyan
+        say "    admin     / password123  (can edit)", :cyan
+        say "    superadmin/ password123  (full control)", :cyan
+        say ""
+        say "  To uninstall later:", :yellow
+        say "    bin/rails generate dbdoc_engine:uninstall", :yellow
+        say ""
+      end
+
+      private
+
+      def copy_migrations(rails_version)
+        source_dir = rails_version >= 8.0 ? "rails8" : "rails7"
+        Dir[File.join(self.class.source_root, "db/migrate/#{source_dir}/*.rb")].each do |file|
+          dest = "db/migrate/#{File.basename(file)}"
+          if File.exist?(File.join(destination_root, dest))
+            say_status("exists", dest, :blue)
+          else
+            copy_file file, dest
+          end
+        end
+      end
+
+      def install_js_stack
+        importmap_path = File.join(destination_root, "config/importmap.rb")
+        js_path = File.join(destination_root, "app/javascript/application.js")
+        unless File.exist?(importmap_path) && File.exist?(js_path)
+          say_step "Installing Importmap, Turbo, and Stimulus..."
+          system("rails importmap:install")
+          system("rails turbo:install stimulus:install")
+          say_done "JS stack installed"
+        end
+      end
+
+      def invoke_task(task, message)
+        say_step "#{message}..."
+        Rake::Task[task].reenable
+        Rake::Task[task].invoke
+        say_done message
+      rescue RuntimeError => e
+        say "  Warning: #{e.message}", :yellow
+      end
+
+      def update_routes
+        routes_path = File.join(destination_root, "config/routes.rb")
+        mount_line = "  mount DbdocEngine::Engine => \"/dbdoc\"\n"
+
+        content = File.read(routes_path)
+        if content.include?("mount DbdocEngine::Engine")
+          say_done "Route already configured"
+          return
+        end
+
+        say_step "Adding engine route to routes.rb..."
+        new_content = content.sub(
+          /Rails\.application\.routes\.draw do\n/,
+          "Rails.application.routes.draw do\n#{mount_line}"
+        )
+        File.write(routes_path, new_content)
+        say_done "Route added: mount DbdocEngine::Engine => \"/dbdoc\""
+      rescue StandardError => e
+        say "  Warning: Could not update routes.rb: #{e.message}", :yellow
+        say "  Please add manually: mount DbdocEngine::Engine => \"/dbdoc\"", :yellow
+      end
+
+      def update_importmap
+        importmap_path = File.join(destination_root, "config/importmap.rb")
+        pin_code = <<~RUBY
+
+          if defined?(DbdocEngine)
+            pin_all_from DbdocEngine::Engine.root.join("app/javascript/dbdoc_engine"),
+              under: "dbdoc_engine",
+              to: "dbdoc_engine"
+          end
+        RUBY
+
+        content = File.exist?(importmap_path) ? File.read(importmap_path) : ""
+        if content.include?("pin_all_from DbdocEngine::Engine.root.join")
+          say_done "Importmap pins already configured"
+          return
+        end
+
+        say_step "Adding pins to importmap.rb..."
+        File.open(importmap_path, "a") { |f| f.puts pin_code }
+        say_done "Importmap pins added"
+      rescue StandardError => e
+        say "  Warning: Could not update importmap.rb: #{e.message}", :yellow
+      end
+
+      def update_application_js
+        js_path = File.join(destination_root, "app/javascript/application.js")
+        import_line = 'import "dbdoc_engine/application";'
+
+        content = File.exist?(js_path) ? File.read(js_path) : ""
+        if content.include?(import_line)
+          say_done "application.js already configured"
+          return
+        end
+
+        say_step "Adding import to application.js..."
+        File.write(js_path, "#{import_line}\n#{content}")
+        say_done "JS import added"
+      rescue StandardError => e
+        say "  Warning: Could not update application.js: #{e.message}", :yellow
+      end
+
+      def update_manifest
+        manifest_path = File.join(destination_root, "app/assets/config/manifest.js")
+        manifest_code = <<~JS.chomp
+          //= link_tree ../images
+          //= link_directory ../stylesheets .css
+          //= link dbdoc_engine/log_in_image.png
+          //= link dbdoc_engine/dbdoc_application.css
+          //= link dbdoc_engine/header.css
+          //= link dbdoc_engine/sidebar.css
+          //= link dbdoc_engine/ecommerce.css
+          //= link dbdoc_engine/group_details.css
+          //= link dbdoc_engine/table_details.css
+          //= link dbdoc_engine/changelog.css
+          //= link dbdoc_engine/loading_spinner.css
+          //= link dbdoc_engine/dashboard.css
+          //= link dbdoc_engine/schema_diagram.css
+          //= link dbdoc_engine/admin_header.css
+          //= link dbdoc_engine/login.css
+          //= link dbdoc_engine/admin.css
+          //= link_tree ../../javascript
+          //= link_tree ../../../vendor/javascript
+        JS
+
+        if File.exist?(manifest_path)
+          content = File.read(manifest_path)
+          if content.include?("dbdoc_engine/log_in_image.png")
+            say_done "manifest.js already configured"
+            return
+          end
+          say_step "Adding assets to manifest.js..."
+          File.open(manifest_path, "a") { |f| f.puts manifest_code }
+        else
+          say_step "Creating manifest.js..."
+          FileUtils.mkdir_p(File.dirname(manifest_path))
+          File.write(manifest_path, manifest_code)
+        end
+        say_done "manifest.js updated"
+      rescue StandardError => e
+        say "  Warning: Could not update manifest.js: #{e.message}", :yellow
+      end
+
+      def say_step(message)
+        say "  ▶ #{message}", :yellow
+      end
+
+      def say_done(message)
+        say "  ✔ #{message}", :green
+      end
+    end
+  end
+end

data/lib/generators/dbdoc_engine/uninstall/uninstall_generator.rb

@@ -0,0 +1,196 @@
+require "rails/generators"
+require "rails/generators/base"
+
+module DbdocEngine
+  module Generators
+    class UninstallGenerator < Rails::Generators::Base
+      desc "Uninstall DbdocEngine: removes all engine tables, routes, importmap pins, and JS imports"
+
+      DBDOC_TABLES = %w[
+        db_design_dynamic_columns
+        db_design_dynamic_tables
+        db_design_table_groups
+        db_design_changelogs
+        dbdoc_engine_users
+      ].freeze
+
+      def confirm_uninstall
+        say ""
+        say "=" * 60, :red
+        say "  DbdocEngine Uninstall", :red
+        say "=" * 60, :red
+        say ""
+        say "This will permanently remove the following from your application:", :yellow
+        say ""
+        say "  DATABASE TABLES:", :yellow
+        DBDOC_TABLES.each { |t| say "    - #{t}", :red }
+        say ""
+        say "  FILES & CONFIG:", :yellow
+        say "    - DbdocEngine route from config/routes.rb", :red
+        say "    - DbdocEngine pins from config/importmap.rb", :red
+        say "    - DbdocEngine import from app/javascript/application.js", :red
+        say "    - Seed file db/dbdoc_engine_seeds.rb", :red
+        say ""
+        say "=" * 60, :red
+        say ""
+
+        unless yes?("Are you sure you want to uninstall DbdocEngine? (y/N)", :red)
+          say "Uninstall cancelled.", :green
+          raise SystemExit
+        end
+
+        say ""
+        if yes?("Do you want to DROP all DbdocEngine tables? This cannot be undone! (y/N)", :red)
+          @drop_tables = true
+        else
+          say "Tables will be preserved. You can drop them manually later.", :yellow
+          @drop_tables = false
+        end
+      end
+
+      def drop_tables
+        return unless @drop_tables
+
+        say ""
+        say_status("uninstall", "Dropping DbdocEngine tables...", :yellow)
+
+        DBDOC_TABLES.each do |table_name|
+          if table_exists?(table_name)
+            ActiveRecord::Base.connection.drop_table(table_name, force: :cascade)
+            say_status("dropped", table_name, :red)
+          else
+            say_status("skipped", "#{table_name} (does not exist)", :cyan)
+          end
+        end
+
+        remove_migration_entries
+        say_status("done", "All DbdocEngine tables dropped", :green)
+      end
+
+      def remove_route
+        routes_path = File.join(destination_root, "config/routes.rb")
+        return unless File.exist?(routes_path)
+
+        content = File.read(routes_path)
+        if content.include?("DbdocEngine::Engine")
+          say_status("uninstall", "Removing DbdocEngine route...", :yellow)
+          new_content = content.gsub(/^\s*mount\s+DbdocEngine::Engine.*\n/, "")
+          File.write(routes_path, new_content)
+          say_status("removed", "DbdocEngine route from routes.rb", :green)
+        else
+          say_status("skipped", "No DbdocEngine route found in routes.rb", :cyan)
+        end
+      end
+
+      def remove_importmap_pins
+        importmap_path = File.join(destination_root, "config/importmap.rb")
+        return unless File.exist?(importmap_path)
+
+        content = File.read(importmap_path)
+        if content.include?("DbdocEngine")
+          say_status("uninstall", "Removing DbdocEngine importmap pins...", :yellow)
+          new_content = content.gsub(/\n*\s*if defined\?\(DbdocEngine\).*?end\n?/m, "\n")
+          File.write(importmap_path, new_content)
+          say_status("removed", "DbdocEngine pins from importmap.rb", :green)
+        else
+          say_status("skipped", "No DbdocEngine pins found in importmap.rb", :cyan)
+        end
+      end
+
+      def remove_js_import
+        js_path = File.join(destination_root, "app/javascript/application.js")
+        return unless File.exist?(js_path)
+
+        content = File.read(js_path)
+        if content.include?("dbdoc_engine")
+          say_status("uninstall", "Removing DbdocEngine JS import...", :yellow)
+          new_content = content.gsub(/^.*dbdoc_engine.*\n?/, "")
+          File.write(js_path, new_content)
+          say_status("removed", "DbdocEngine import from application.js", :green)
+        else
+          say_status("skipped", "No DbdocEngine import found in application.js", :cyan)
+        end
+      end
+
+      def remove_seed_file
+        seed_file = File.join(destination_root, "db/dbdoc_engine_seeds.rb")
+        if File.exist?(seed_file)
+          say_status("uninstall", "Removing seed file...", :yellow)
+          File.delete(seed_file)
+          say_status("removed", "db/dbdoc_engine_seeds.rb", :green)
+        end
+      end
+
+      def remove_manifest_entries
+        manifest_path = File.join(destination_root, "app/assets/config/manifest.js")
+        return unless File.exist?(manifest_path)
+
+        content = File.read(manifest_path)
+        if content.include?("dbdoc_engine")
+          say_status("uninstall", "Removing DbdocEngine manifest entries...", :yellow)
+          new_content = content.gsub(/^.*dbdoc_engine.*\n?/, "")
+          File.write(manifest_path, new_content)
+          say_status("removed", "DbdocEngine entries from manifest.js", :green)
+        end
+      end
+
+      def final_instructions
+        say ""
+        say "=" * 60, :green
+        say "  DbdocEngine has been uninstalled", :green
+        say "=" * 60, :green
+        say ""
+        say "Next steps:", :yellow
+        say "  1. Remove 'gem \"dbdoc_engine\"' from your Gemfile", :yellow
+        say "  2. Run 'bundle install'", :yellow
+        unless @drop_tables
+          say "  3. Manually drop DbdocEngine tables if needed:", :yellow
+          DBDOC_TABLES.each { |t| say "     DROP TABLE IF EXISTS #{t} CASCADE;", :cyan }
+        end
+        say ""
+      end
+
+      private
+
+      def table_exists?(table_name)
+        ActiveRecord::Base.connection.table_exists?(table_name)
+      rescue StandardError
+        false
+      end
+
+      def remove_migration_entries
+        if ActiveRecord::Base.connection.table_exists?(:schema_migrations)
+          migration_versions = Dir[File.join(destination_root, "db/migrate/*dbdoc*")].map do |f|
+            File.basename(f).split("_").first
+          end
+          migration_versions.concat(
+            Dir[File.join(destination_root, "db/migrate/*db_design*")].map do |f|
+              File.basename(f).split("_").first
+            end
+          )
+          migration_versions.concat(
+            Dir[File.join(destination_root, "db/migrate/*create_users*")].map do |f|
+              File.basename(f).split("_").first
+            end
+          )
+
+          migration_versions.uniq.each do |version|
+            ActiveRecord::Base.connection.execute(
+              "DELETE FROM schema_migrations WHERE version = '#{version}'"
+            )
+          end
+
+          migration_files = Dir[File.join(destination_root, "db/migrate/*db_design*")] +
+                            Dir[File.join(destination_root, "db/migrate/*dbdoc*")] +
+                            Dir[File.join(destination_root, "db/migrate/*create_users*")]
+          migration_files.uniq.each do |f|
+            File.delete(f) if File.exist?(f)
+            say_status("removed", "Migration: #{File.basename(f)}", :red)
+          end
+        end
+      rescue StandardError => e
+        say "Warning: Could not clean migration entries: #{e.message}", :yellow
+      end
+    end
+  end
+end

data/lib/tasks/dbdoc_engine_tasks.rake

@@ -0,0 +1,44 @@
+# lib/tasks/dbdoc_engine_tasks.rake
+
+namespace :dbdoc_engine do
+  namespace :install do
+    desc 'Copy seed file from dbdoc_engine to host application'
+    task :seeds do
+      # Path to the gem's seed file
+      source_file = File.join(DbdocEngine::Engine.root, 'db', 'seeds.rb')
+
+      # Path to the host application's seeds directory
+      seeds_dir = File.join(Rails.root, 'db')
+
+      # Create destination filename (avoid overwriting existing seeds.rb)
+      destination_file = File.join(seeds_dir, 'dbdoc_engine_seeds.rb')
+
+      # Ensure the directory exists
+      FileUtils.mkdir_p(seeds_dir)
+
+      # Copy the file
+      if File.exist?(source_file)
+        FileUtils.cp(source_file, destination_file)
+        puts "Copied dbdoc_engine seeds to #{destination_file}"
+      else
+        puts "No seed file found at #{source_file}"
+      end
+    end
+  end
+
+  namespace :db do
+    desc 'Load the seed data from dbdoc_engine'
+    task :seed => :environment do
+      # Path to the seed file in the host application
+      seed_file = File.join(Rails.root, 'db', 'dbdoc_engine_seeds.rb')
+
+      # If the file exists, load it
+      if File.exist?(seed_file)
+        load(seed_file)
+        puts "Loaded dbdoc_engine seed data"
+      else
+        puts "No seed file found at #{seed_file}. Run 'rake dbdoc_engine:install:seeds' first."
+      end
+    end
+  end
+end

data/public/dbdoc_engine_assets/images/dblogo.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="495.03 495.03 1009.94 1009.94" width="107.77" height="107.77" xml:space="preserve" style="fill-rule: evenodd; clip-rule: evenodd; stroke-linejoin: round; stroke-miterlimit: 2; position: absolute;">
+  <path transform="matrix(1.68137,0,0,1.68137,-146.171,265.639)" d="M381.356,343.146L381.356,136.431L527.189,136.431L527.189,343.14L527.189,488.979L381.356,343.146Z" style="fill: #5366A0; fill-opacity: 1;"></path>
+  <path transform="matrix(1.68137,0,0,1.68137,-146.171,265.639)" d="M681.688,737.095L381.356,737.095L381.356,737.089L527.189,591.256L527.189,591.261L681.688,591.261C767.015,591.261 836.186,522.09 836.186,436.763C836.186,351.436 767.015,282.264 681.688,282.264L591.014,282.264L591.014,136.431L681.688,136.431C847.557,136.431 982.02,270.894 982.02,436.763C982.02,493.264 966.417,546.122 939.286,591.261C913.9,633.496 878.421,668.975 836.186,694.361C813.824,707.802 789.567,718.414 763.911,725.701C737.78,733.122 710.198,737.095 681.688,737.095Z" style="fill: rgb(255, 255, 255); fill-opacity: 1;"></path>
+</svg>

data/public/dbdoc_engine_assets/images/login-bg.svg

@@ -0,0 +1,44 @@
+<svg width="1920" height="1080" viewBox="0 0 1920 1080" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <defs>
+    <!-- Main gradient -->
+    <linearGradient id="main-gradient" x1="0" y1="0" x2="1920" y2="0" gradientUnits="userSpaceOnUse">
+      <stop offset="0%" stop-color="#829ED4"/>
+      <stop offset="100%" stop-color="#364380"/>
+    </linearGradient>
+    <!-- White glow top right -->
+    <radialGradient id="white-glow" cx="80%" cy="10%" r="1">
+      <stop offset="0%" stop-color="#fff" stop-opacity="0.33"/>
+      <stop offset="90%" stop-color="#fff" stop-opacity="0"/>
+    </radialGradient>
+    <!-- Soft blue accent bottom left -->
+    <radialGradient id="accent" cx="15%" cy="90%" r="1">
+      <stop offset="0%" stop-color="#829ED4" stop-opacity="0.18"/>
+      <stop offset="100%" stop-color="#364380" stop-opacity="0"/>
+    </radialGradient>
+    <!-- Pink highlight wave -->
+    <linearGradient id="wave-pink" x1="0" y1="920" x2="1920" y2="1080" gradientUnits="userSpaceOnUse">
+      <stop offset="0%" stop-color="#f3d1ff" stop-opacity="0.13"/>
+      <stop offset="100%" stop-color="#829ED4" stop-opacity="0"/>
+    </linearGradient>
+    <!-- Blue overlay wave -->
+    <linearGradient id="wave-blue" x1="0" y1="1060" x2="1920" y2="980" gradientUnits="userSpaceOnUse">
+      <stop offset="0%" stop-color="#364380" stop-opacity="0.13"/>
+      <stop offset="100%" stop-color="#829ED4" stop-opacity="0"/>
+    </linearGradient>
+  </defs>
+  <!-- Main gradient background -->
+  <rect width="1920" height="1080" fill="url(#main-gradient)"/>
+  <!-- Soft white glow in the top right -->
+  <ellipse cx="1700" cy="120" rx="440" ry="280" fill="url(#white-glow)"/>
+  <!-- Soft blue accent in the bottom left -->
+  <ellipse cx="180" cy="1040" rx="400" ry="180" fill="url(#accent)"/>
+  <!-- Abstract pinkish wave overlay bottom -->
+  <path d="M0 950 Q 400 1100 1000 1000 T 1920 1080 V1080 H0Z" fill="url(#wave-pink)"/>
+  <!-- Abstract blue wave overlay bottom -->
+  <path d="M0 1040 Q 800 1160 1700 1040 T 1920 1080 V1080 H0Z" fill="url(#wave-blue)"/>
+  <!-- Subtle circles for extra depth -->
+  <circle cx="1600" cy="900" r="120" fill="#fff" opacity="0.03"/>
+  <circle cx="420" cy="160" r="80" fill="#fff" opacity="0.04"/>
+  <circle cx="1450" cy="300" r="60" fill="#fff" opacity="0.06"/>
+  <circle cx="350" cy="800" r="50" fill="#fff" opacity="0.04"/>
+</svg>

data/public/dbdoc_engine_assets/images/logo.svg

@@ -0,0 +1,12 @@
+<svg width="35" height="35" viewBox="0 0 50 50" xmlns="http://www.w3.org/2000/svg">
+  <!-- Background Circle -->
+  <circle cx="25" cy="25" r="25" fill="white" />
+
+  <!-- Table Icon -->
+  <rect x="12" y="12" width="20" height="5" rx="3" fill="#5366A0"/>
+  <rect x="12" y="20" width="20" height="5" rx="3" fill="#5366A0"/>
+  <rect x="12" y="28" width="20" height="5" rx="3" fill="#5366A0"/>
+
+  <!-- Shield Icon (Attached to the Bottom Right) -->
+  <path d="M30 28 L40 30 L40 37 Q35 42 30 37 Z" fill="#5366A0" stroke="#5366A0" stroke-width="2"/>
+</svg>