dbviewer 0.4.4 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b726fcc60badaa82692f22151b9656152810ecaa9a5c59e39e0a27e0c595add5
-  data.tar.gz: a88f8817f599d276ad814bce26fa2314bd79c7c4a5979123aa524457c7c0d534
+  metadata.gz: 61c23f612495654e7fba0280fd361cf872d668ea21618c74c95d05f4ea7fdb6a
+  data.tar.gz: eeea9728edb2716f44e66eb1851767a7e77cf38c53f3ee4c676fd3d1d9e3608d
 SHA512:
-  metadata.gz: c0a0cfc7172bf1ea0e3146bfeb3cb739e247a8412c0fd204828fdb0e2a4f261fdbd75ef070da765c1a6cde0d1ae0bd60b842346c71512a547c9d05dd592930ae
-  data.tar.gz: 5304c49470fe85760bf0e6aef851cb3c199963be104518c46dad24dac6e22eaae597802786c339b9a779a810a8c849f9c1b558f73672abbb7f432429bbd9c519
+  metadata.gz: 6674c2063fb577a3468ded6ffab856bcc8092f5a6fa46a28eb727f3e6a140556401c05777a7bc4ab7dd9e2a78c90b4576800db5a6b724f31d6a1e8f649cc1392
+  data.tar.gz: 1714aa447da6c73754b4702e2114e63dca6c1dce5be4be790bd0b7ae89aa7972f9bbbfc54de588da5237f45ca69066f2fde1b50ae15017e0a52842c954ee9372

data/README.md

@@ -92,23 +92,10 @@ Rails.application.routes.draw do
 
   # Mount the DBViewer engine
   mount Dbviewer::Engine, at: "/dbviewer"
-  # The engine can be mounted in any environment when using Basic Authentication
 end
 ```
 
-Configure Basic Authentication in an initializer to secure access (strongly recommended):
-
-```ruby
-# config/initializers/dbviewer.rb
-Dbviewer.configure do |config|
-  config.admin_credentials = {
-    username: "your_username",
-    password: "your_secure_password"
-  }
-end
-```
-
-Then, visit `/dbviewer` in your browser to access the database viewer. You'll be prompted for your username and password.
+Then, visit `/dbviewer` in your browser to access the database viewer.
 
 ### Rails API-only Applications
 
@@ -136,40 +123,15 @@ This is necessary because API-only Rails applications don't include the Flash mi
 - **ERD View** (`/dbviewer/entity_relationship_diagrams`): Interactive Entity Relationship Diagram of your database
 - **SQL Query Logs** (`/dbviewer/logs`): View and analyze logged SQL queries with performance metrics
 
-## 🤝🏻 Extending DBViewer
-
-### Adding Custom Functionality
+## ⚙️ Configuration Options
 
-You can extend the database manager with custom methods:
+You can configure DBViewer by using our generator to create an initializer in your application:
 
-```ruby
-# config/initializers/dbviewer_extensions.rb
-Rails.application.config.to_prepare do
-  Dbviewer::DatabaseManager.class_eval do
-    def table_statistics(table_name)
-      # Your custom code to generate table statistics
-      {
-        avg_row_size: calculate_avg_row_size(table_name),
-        last_updated: last_updated_timestamp(table_name)
-      }
-    end
-
-    private
-
-    def calculate_avg_row_size(table_name)
-      # Implementation...
-    end
-
-    def last_updated_timestamp(table_name)
-      # Implementation...
-    end
-  end
-end
+```bash
+rails generate dbviewer:initializer
 ```
 
-## ⚙️ Configuration Options
-
-You can configure DBViewer by creating an initializer in your application:
+This will create a file at `config/initializers/dbviewer.rb` with the default configuration:
 
 ```ruby
 # config/initializers/dbviewer.rb
@@ -183,16 +145,18 @@ Dbviewer.configure do |config|
   config.query_timeout = 30                          # SQL query timeout in seconds
 
   # Query logging options
-  config.enable_query_logging = true                 # Enable or disable query logging completely (default: true)
+  config.enable_query_logging = false                # Enable or disable query logging completely (default: true)
   config.query_logging_mode = :memory                # Storage mode for SQL queries (:memory or :file)
   config.query_log_path = "log/dbviewer.log"         # Path for query log file when in :file mode
   config.max_memory_queries = 1000                   # Maximum number of queries to store in memory
 
   # Authentication options
-  config.admin_credentials = { username: "admin", password: "your_secure_password" } # Basic HTTP auth credentials
+  # config.admin_credentials = { username: "admin", password: "your_secure_password" } # Basic HTTP auth credentials
 end
 ```
 
+You can also create this file manually if you prefer.
+
 The configuration is accessed through `Dbviewer.configuration` throughout the codebase. You can also access it via `Dbviewer.config` which is an alias for backward compatibility.
 
 ## 🪵 Query Logging
@@ -302,13 +266,13 @@ The simplest way to update is using Bundler:
 
 - Update your Gemfile with the desired version:
 
-   ```ruby
-   # For the latest version
-   gem "dbviewer", group: :development
-   
-   # Or specify a version
-   gem "dbviewer", "~> 0.3.2", group: :development
-   ```
+  ```ruby
+  # For the latest version
+  gem "dbviewer", group: :development
+
+  # Or specify a version
+  gem "dbviewer", "~> 0.3.2", group: :development
+  ```
 
 - Run bundle update:
 

data/app/views/dbviewer/entity_relationship_diagrams/index.html.erb

@@ -31,16 +31,22 @@
           </div>
         </div>
         <div class="card-body p-0">
-          <div id="erd-container" class="w-100 h-100">
-            <div id="erd-loading" class="d-flex justify-content-center align-items-center h-100">
+          <div id="erd-container" class="w-100 h-100" style="min-height: 450px;">
+            <div id="erd-loading" class="d-flex justify-content-center align-items-center h-100" style="min-height: 450px;">
               <div class="text-center">
                 <div class="spinner-border text-primary mb-3" role="status">
                   <span class="visually-hidden">Loading...</span>
                 </div>
                 <p>Generating Entity Relationship Diagram...</p>
+                <small class="text-muted">This may take a moment for databases with many tables</small>
               </div>
             </div>
             <!-- The ERD will be rendered here -->
+            <div id="erd-error" class="alert alert-danger m-3 d-none">
+              <h5>Error generating diagram</h5>
+              <p id="erd-error-message">There was an error rendering the entity relationship diagram.</p>
+              <pre id="erd-error-details" class="bg-light p-2 small mt-2 d-none"></pre>
+            </div>
           </div>
         </div>
       </div>
@@ -55,10 +61,17 @@
 
 <script>
   document.addEventListener('DOMContentLoaded', function() {
-    // Initialize mermaid
+    // Check if mermaid is loaded first
+    if (typeof mermaid === 'undefined') {
+      console.error('Mermaid library not loaded!');
+      showError('Mermaid library not loaded', 'The diagram library could not be loaded. Please check your internet connection and try again.');
+      return;
+    }
+    
+    // Initialize mermaid with theme detection like mini ERD
     mermaid.initialize({
       startOnLoad: true,
-      theme: 'neutral',
+      theme: document.documentElement.getAttribute('data-bs-theme') === 'dark' ? 'dark' : 'default',
       securityLevel: 'loose',
       er: {
         diagramPadding: 20,
@@ -72,6 +85,34 @@
       }
     });
     
+    // Function to show error messages
+    function showError(title, message, details = '') {
+      const errorContainer = document.getElementById('erd-error');
+      const errorMessage = document.getElementById('erd-error-message');
+      const errorDetails = document.getElementById('erd-error-details');
+      const loadingIndicator = document.getElementById('erd-loading');
+      
+      if (loadingIndicator) {
+        loadingIndicator.style.display = 'none';
+      }
+      
+      if (errorContainer && errorMessage) {
+        // Set error message
+        errorMessage.textContent = message;
+        
+        // Set error details if provided
+        if (details && errorDetails) {
+          errorDetails.textContent = details;
+          errorDetails.classList.remove('d-none');
+        } else if (errorDetails) {
+          errorDetails.classList.add('d-none');
+        }
+        
+        // Show the error container
+        errorContainer.classList.remove('d-none');
+      }
+    }
+    
     // ER Diagram download functionality
     let diagramReady = false;
     
@@ -235,6 +276,7 @@
           console.error('Error rendering updated diagram:', error);
           document.body.removeChild(tempContainer);
           isUpdatingDiagram = false;
+          showError('Error rendering diagram', 'There was an error updating the diagram with complete data.', error.message);
         });
       }
     }
@@ -291,8 +333,7 @@
     }).catch(function(error) {
       console.error('Error rendering diagram:', error);
       document.body.removeChild(tempInitContainer);
-      document.getElementById('erd-loading').innerHTML = 
-        '<div class="alert alert-danger">Error generating diagram. Please try again or check console for details.</div>';
+      showError('Error generating diagram', 'There was an error generating the entity relationship diagram.', error.message);
     });
     
     // SVG Pan Zoom instance
@@ -504,7 +545,6 @@
     overflow: auto;
     height: calc(100vh - 125px);
     padding: 20px;
-    /* background-color: #fafafa; */
     position: relative;
   }
   
@@ -514,6 +554,37 @@
     min-width: 100%;
   }
   
+  /* Loading state styling */
+  #erd-loading {
+    background-color: var(--bs-body-bg);
+  }
+  
+  #erd-loading .text-center p {
+    margin-bottom: 0.5rem;
+    font-weight: 500;
+  }
+  
+  #erd-loading .text-center small {
+    font-size: 0.875rem;
+  }
+  
+  /* Error state styling */
+  #erd-error {
+    max-width: 600px;
+    margin: 2rem auto;
+  }
+  
+  #erd-error h5 {
+    color: var(--bs-danger);
+    margin-bottom: 0.75rem;
+  }
+  
+  #erd-error-details {
+    font-size: 0.8rem;
+    max-height: 150px;
+    overflow-y: auto;
+  }
+  
   /* SVG Pan Zoom styles */
   .svg-pan-zoom_viewport {
     transition: 0.2s;
@@ -539,10 +610,67 @@
     font-size: 20px !important;
   }
   
+  /* Dark mode overrides - comprehensive styling like mini ERD */
+  [data-bs-theme="dark"] .entityBox {
+    fill: #2D3748;
+    stroke: #6ea8fe;
+  }
+  
+  [data-bs-theme="dark"] .entityLabel, 
+  [data-bs-theme="dark"] .mermaid .label {
+    color: #f8f9fa;
+  }
+  
+  [data-bs-theme="dark"] #erd-error-details {
+    background-color: var(--bs-dark) !important;
+    color: var(--bs-light);
+    border-color: var(--bs-border-color);
+  }
+  
+  /* Dark mode: Update mermaid diagram elements */
+  [data-bs-theme="dark"] .mermaid .er .entityBox {
+    fill: #2D3748 !important;
+    stroke: #6ea8fe !important;
+    stroke-width: 1.5px !important;
+  }
+  
+  [data-bs-theme="dark"] .mermaid .er .entityLabel {
+    fill: #f8f9fa !important;
+    color: #f8f9fa !important;
+  }
+  
+  [data-bs-theme="dark"] .mermaid .er .relationshipLine {
+    stroke: #6ea8fe !important;
+    stroke-width: 2px !important;
+  }
+  
+  [data-bs-theme="dark"] .mermaid .er .relationshipLabel {
+    fill: #f8f9fa !important;
+    color: #f8f9fa !important;
+  }
+  
+  [data-bs-theme="dark"] .mermaid .er .attributeBoxEven,
+  [data-bs-theme="dark"] .mermaid .er .attributeBoxOdd {
+    fill: #374151 !important;
+  }
+  
+  [data-bs-theme="dark"] .mermaid text {
+    fill: #f8f9fa !important;
+  }
+  
+  /* Loading indicator dark mode */
+  [data-bs-theme="dark"] #erd-loading {
+    background-color: var(--bs-dark);
+    color: var(--bs-light);
+  }
+  
+  [data-bs-theme="dark"] #erd-loading .spinner-border {
+    color: #6ea8fe;
+  }
+  
   /* Zoom percentage display styling */
   #zoomPercentage {
     font-size: 0.9rem;
-    /* color: #495057; */
     font-weight: 500;
     width: 45px;
     display: inline-block;
@@ -557,4 +685,17 @@
   .mermaid .er.relationshipLabel {
     font-size: 20px !important;
   }
+  
+  /* Enhanced table highlighting for current table */
+  .current-table-highlight rect {
+    fill: var(--bs-primary-bg-subtle) !important;
+    stroke: var(--bs-primary) !important;
+    stroke-width: 2px !important;
+  }
+  
+  [data-bs-theme="dark"] .current-table-highlight rect {
+    fill: #2c3034 !important;
+    stroke: #6ea8fe !important;
+    stroke-width: 2px !important;
+  }
 </style>

data/app/views/dbviewer/tables/show.html.erb

@@ -836,7 +836,7 @@
             <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
           </div>
           <div class="modal-body p-0"> <!-- Removed padding for full width -->
-            <div id="mini-erd-container" class="w-100" style="min-height: 450px; height: 100%;"> <!-- Increased height -->
+            <div id="mini-erd-container" class="w-100 d-flex justify-content-center align-items-center" style="min-height: 450px; height: 100%;"> <!-- Increased height -->
               <div id="mini-erd-loading" class="d-flex justify-content-center align-items-center" style="height: 100%; min-height: 450px;">
                 <div class="text-center">
                   <div class="spinner-border text-primary mb-3" role="status">
@@ -977,53 +977,100 @@
               try {
                 const svgElement = container.querySelector('svg');
                 if (svgElement && typeof svgPanZoom !== 'undefined') {
-                  // Make SVG take the full container width
+                  // Make SVG take the full container width and ensure it has valid dimensions
                   svgElement.setAttribute('width', '100%');
                   svgElement.setAttribute('height', '100%');
                   
-                  // Initialize SVG Pan-Zoom
-                  const panZoomInstance = svgPanZoom(svgElement, {
-                    zoomEnabled: true,
-                    controlIconsEnabled: true,
-                    fit: true,
-                    center: true,
-                    minZoom: 0.5,
-                    maxZoom: 2.5
-                  });
-                  
-                  // Store the panZoom instance for resize handling
-                  container.panZoomInstance = panZoomInstance;
-                  
-                  // Setup resize observer to maintain full size
-                  const resizeObserver = new ResizeObserver(() => {
-                    if (container.panZoomInstance) {
-                      // Reset zoom and center when container is resized
-                      container.panZoomInstance.resize();
-                      container.panZoomInstance.fit();
-                      container.panZoomInstance.center();
-                    }
-                  });
-                  
-                  // Observe the container for size changes
-                  resizeObserver.observe(container);
-                  
-                  // Also handle manual resize on modal resize
-                  miniErdModal.addEventListener('resize.bs.modal', function() {
-                    if (container.panZoomInstance) {
-                      setTimeout(() => {
-                        container.panZoomInstance.resize();
-                        container.panZoomInstance.fit();
-                        container.panZoomInstance.center();
-                      }, 100);
+                  // Wait for SVG to be fully rendered with proper dimensions
+                  setTimeout(() => {
+                    try {
+                      // Get dimensions to ensure they're valid before initializing pan-zoom
+                      const clientRect = svgElement.getBoundingClientRect();
+                      
+                      // Only initialize if we have valid dimensions
+                      if (clientRect.width > 0 && clientRect.height > 0) {
+                        // Initialize SVG Pan-Zoom with more robust error handling
+                        const panZoomInstance = svgPanZoom(svgElement, {
+                          zoomEnabled: true,
+                          controlIconsEnabled: true,
+                          fit: false, // Don't automatically fit on init - can cause the matrix error
+                          center: false, // Don't automatically center - can cause the matrix error
+                          minZoom: 0.5,
+                          maxZoom: 2.5,
+                          beforeZoom: function() {
+                            // Check if the SVG is valid for zooming
+                            return svgElement.getBoundingClientRect().width > 0 && 
+                                  svgElement.getBoundingClientRect().height > 0;
+                          }
+                        });
+                        
+                        // Store the panZoom instance for resize handling
+                        container.panZoomInstance = panZoomInstance;
+                        
+                        // Manually fit and center after a slight delay
+                        setTimeout(() => {
+                          try {
+                            panZoomInstance.resize();
+                            panZoomInstance.fit();
+                            panZoomInstance.center();
+                          } catch(err) {
+                            console.warn("Error during fit/center operation:", err);
+                          }
+                        }, 300);
+                        
+                        // Setup resize observer to maintain full size
+                        const resizeObserver = new ResizeObserver(() => {
+                          if (container.panZoomInstance) {
+                            try {
+                              // Reset zoom and center when container is resized
+                              container.panZoomInstance.resize();
+                              // Only fit and center if the element is visible with valid dimensions
+                              if (svgElement.getBoundingClientRect().width > 0 && 
+                                  svgElement.getBoundingClientRect().height > 0) {
+                                container.panZoomInstance.fit();
+                                container.panZoomInstance.center();
+                              }
+                            } catch(err) {
+                              console.warn("Error during resize observer callback:", err);
+                            }
+                          }
+                        });
+                        
+                        // Observe the container for size changes
+                        resizeObserver.observe(container);
+                        
+                        // Also handle manual resize on modal resize
+                        miniErdModal.addEventListener('resize.bs.modal', function() {
+                          if (container.panZoomInstance) {
+                            setTimeout(() => {
+                              try {
+                                container.panZoomInstance.resize();
+                                // Only fit and center if the element is visible with valid dimensions
+                                if (svgElement.getBoundingClientRect().width > 0 && 
+                                    svgElement.getBoundingClientRect().height > 0) {
+                                  container.panZoomInstance.fit();
+                                  container.panZoomInstance.center();
+                                }
+                              } catch(err) {
+                                console.warn("Error during modal resize handler:", err);
+                              }
+                            }, 300);
+                          }
+                        });
+                      } else {
+                        console.warn("Cannot initialize SVG-Pan-Zoom: SVG has invalid dimensions", clientRect);
+                      }
+                    } catch(err) {
+                      console.warn("Error initializing SVG-Pan-Zoom:", err);
                     }
-                  });
+                  }, 500); // Increased delay to ensure SVG is fully rendered with proper dimensions
                 }
               } catch (e) {
                 console.warn('Failed to initialize svg-pan-zoom:', e);
                 // Not critical, continue without pan-zoom
               }
               
-              // Add highlighting for the current table
+              // Add highlighting for the current table after a delay to ensure SVG is fully processed
               setTimeout(function() {
                 try {
                   const cleanTableName = '<%= @table_name %>'.replace(/[^\w]/g, '_');
@@ -1100,10 +1147,22 @@
         const container = document.getElementById('mini-erd-container');
         if (container && container.panZoomInstance) {
           setTimeout(() => {
-            container.panZoomInstance.resize();
-            container.panZoomInstance.fit();
-            container.panZoomInstance.center();
-          }, 200); // Small delay to ensure modal is fully transitioned
+            try {
+              // Check if the SVG still has valid dimensions before operating on it
+              const svgElement = container.querySelector('svg');
+              if (svgElement && 
+                  svgElement.getBoundingClientRect().width > 0 && 
+                  svgElement.getBoundingClientRect().height > 0) {
+                container.panZoomInstance.resize();
+                container.panZoomInstance.fit();
+                container.panZoomInstance.center();
+              } else {
+                console.warn("Cannot perform pan-zoom operations: SVG has invalid dimensions");
+              }
+            } catch(err) {
+              console.warn("Error during modal shown handler:", err);
+            }
+          }, 500); // Increased delay to ensure modal is fully transitioned and SVG is rendered
         }
       });
       

data/lib/dbviewer/engine.rb

@@ -6,6 +6,11 @@ module Dbviewer
     config.autoload_paths << File.expand_path("../../", __FILE__)
     config.eager_load_paths << File.expand_path("../../", __FILE__)
 
+    # Register generators
+    config.app_generators do |g|
+      g.templates.unshift File.expand_path("../../generators/dbviewer/templates", __dir__)
+    end
+
     # Initialize the engine safely
     initializer "dbviewer.setup", after: :load_config_initializers do |app|
       Dbviewer.init

data/lib/dbviewer/version.rb

@@ -1,3 +1,3 @@
 module Dbviewer
-  VERSION = "0.4.4"
+  VERSION = "0.4.7"
 end

data/lib/generators/dbviewer/initializer_generator.rb

@@ -0,0 +1,12 @@
+module Dbviewer
+  module Generators
+    class InitializerGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Creates a DBViewer initializer file at config/initializers/dbviewer.rb"
+
+      def copy_initializer_file
+        copy_file "initializer.rb", "config/initializers/dbviewer.rb"
+      end
+    end
+  end
+end

data/lib/generators/dbviewer/templates/initializer.rb

@@ -0,0 +1,18 @@
+Dbviewer.configure do |config|
+  config.per_page_options = [ 10, 20, 50, 100, 250 ]
+  config.default_per_page = 20
+  config.max_query_length = 10000
+  config.cache_expiry = 300
+  config.max_records = 10000
+  config.enable_data_export = false
+  config.query_timeout = 30
+
+  # Query logging options
+  config.enable_query_logging = false
+  config.query_logging_mode = :memory
+  config.query_log_path = "log/dbviewer.log"
+  config.max_memory_queries = 1000
+
+  # Authentication options
+  # config.admin_credentials = { username: "admin", password: "your_secure_password" } # Basic HTTP auth credentials
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbviewer
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.7
 platform: ruby
 authors:
 - Wailan Tirajoh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-24 00:00:00.000000000 Z
+date: 2025-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,6 +95,8 @@ files:
 - lib/dbviewer/table_query_operations.rb
 - lib/dbviewer/table_query_params.rb
 - lib/dbviewer/version.rb
+- lib/generators/dbviewer/initializer_generator.rb
+- lib/generators/dbviewer/templates/initializer.rb
 - lib/tasks/dbviewer_tasks.rake
 homepage: https://github.com/wailantirajoh/dbviewer
 licenses: