dbviewer 0.4.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61c23f612495654e7fba0280fd361cf872d668ea21618c74c95d05f4ea7fdb6a
-  data.tar.gz: eeea9728edb2716f44e66eb1851767a7e77cf38c53f3ee4c676fd3d1d9e3608d
+  metadata.gz: 628884438be23468b7910e2a13c14b2aa00cc6361f01cb09b53ecdcf1d8a0b78
+  data.tar.gz: e9952d0c11ae3669b2604ac208f1a4ae224c37eb4d5f2b1074c4f284bb0bc24a
 SHA512:
-  metadata.gz: 6674c2063fb577a3468ded6ffab856bcc8092f5a6fa46a28eb727f3e6a140556401c05777a7bc4ab7dd9e2a78c90b4576800db5a6b724f31d6a1e8f649cc1392
-  data.tar.gz: 1714aa447da6c73754b4702e2114e63dca6c1dce5be4be790bd0b7ae89aa7972f9bbbfc54de588da5237f45ca69066f2fde1b50ae15017e0a52842c954ee9372
+  metadata.gz: 369f106d728156712416e6d1f65c51e156ec1357e717c5cc4f95e9fe16dbe696e3a06b8c70a2ef2fd6ae559dd0e7ad7b73fc6a5b2e0ccc396a756633d733c2dd
+  data.tar.gz: 273df74ea6e69b327b01faecb4b3572983fbd461ee042c41ba2402729482ead2b9ebaed117c95158ff01def2e1a1373aaf0fed75d8268d8546b0f3e38d2ff2ae

data/README.md

@@ -5,7 +5,8 @@
 DBViewer is a powerful Rails engine that provides a comprehensive interface to view and explore database tables, records, and schema.
 It's designed for development, debugging, and database analysis, offering a clean and intuitive way to interact with your application's database.
 
-<img width="1470" alt="image" src="https://github.com/user-attachments/assets/c946a286-e80a-4cca-afa0-654052e4ef2c" />
+<img width="1470" alt="image" src="https://github.com/user-attachments/assets/0d2719ad-f5b4-4818-891d-5bff7be6c5c3" />
+
 
 ## ✨ Features
 
@@ -45,27 +46,10 @@ It's designed for development, debugging, and database analysis, offering a clea
 
 <details>
   <summary>Click to see more screenshots</summary>
-  
-#### Dashboard Overview
-
-  <img width="1470" alt="image" src="https://github.com/user-attachments/assets/4e803d51-9a5b-4c80-bb4c-a761dba15a40" />
-
-#### Table Details
-
-  <img width="1470" alt="image" src="https://github.com/user-attachments/assets/fe425ab4-5b22-4839-87bc-050b80ad4cf0" />
-
-#### Query Editor
-
-  <img width="1470" alt="image" src="https://github.com/user-attachments/assets/392c73c7-0724-4a39-8ffa-8ff5115c5d5f" />
-
-#### Query Logs
-
-  <img width="1470" alt="image" src="https://github.com/user-attachments/assets/7fcf3355-be3c-4d6a-9ab0-811333be5bbc" />
 
-#### ERD
+  <img width="1470" alt="image" src="https://github.com/user-attachments/assets/7d708c14-5f78-42c4-b769-2167546b3aad" />
+  <img width="1470" alt="image" src="https://github.com/user-attachments/assets/f6d9a39a-a571-4328-908a-d96b3148f707" />
 
-  <img width="1470" alt="image" src="https://github.com/user-attachments/assets/0a2f838f-4ca6-4592-b939-7c7f8ac40f48" />
-  
 </details>
 
 ## 📥 Installation

data/app/controllers/concerns/dbviewer/database_operations.rb

@@ -50,7 +50,6 @@ module Dbviewer
       database_manager.tables.map do |table_name|
         table_stats = {
           name: table_name
-          # columns_count: database_manager.column_count(table_name)
         }
 
         # Only fetch record counts if explicitly requested
@@ -72,36 +71,8 @@ module Dbviewer
         largest_tables: tables.sort_by { |t| -t[:record_count] }.first(10),
         empty_tables: tables.select { |t| t[:record_count] == 0 }
       }
-
-      # Calculate total foreign key relationships
-      begin
-        total_relationships = 0
-        tables.each do |table|
-          metadata = fetch_table_metadata(table[:name])
-          total_relationships += metadata[:foreign_keys].size if metadata && metadata[:foreign_keys]
-        end
-        analytics[:total_relationships] = total_relationships
-      rescue => e
-        Rails.logger.error("Error calculating relationship count: #{e.message}")
-        analytics[:total_relationships] = 0
-      end
-
       # Calculate schema size if possible
-      begin
-        analytics[:schema_size] = calculate_schema_size
-      rescue => e
-        Rails.logger.error("Error calculating schema size: #{e.message}")
-        analytics[:schema_size] = nil
-      end
-
-      # Calculate average rows per table
-      if tables.any?
-        analytics[:avg_records_per_table] = (analytics[:total_records].to_f / tables.size).round(1)
-        analytics[:avg_columns_per_table] = (analytics[:total_columns].to_f / tables.size).round(1)
-      else
-        analytics[:avg_records_per_table] = 0
-        analytics[:avg_columns_per_table] = 0
-      end
+      analytics[:schema_size] = calculate_schema_size
 
       analytics
     end

data/app/controllers/dbviewer/api/base_controller.rb

@@ -0,0 +1,19 @@
+module Dbviewer
+  module Api
+    class BaseController < ApplicationController
+      # Skip setting the tables instance variable for API endpoints since we don't need it
+      skip_before_action :set_tables
+
+      # Common API response handling for errors
+      def render_error(error_message, status = :internal_server_error)
+        Rails.logger.error(error_message)
+        render json: { error: error_message }, status: status
+      end
+
+      # Common API response handling for success
+      def render_success(data)
+        render json: data
+      end
+    end
+  end
+end

data/app/controllers/dbviewer/api/database_controller.rb

@@ -0,0 +1,14 @@
+module Dbviewer
+  module Api
+    class DatabaseController < BaseController
+      def size
+        begin
+          size = calculate_schema_size
+          render_success(schema_size: size)
+        rescue => e
+          render_error("Error calculating schema size: #{e.message}")
+        end
+      end
+    end
+  end
+end

data/app/controllers/dbviewer/api/queries_controller.rb

@@ -0,0 +1,18 @@
+module Dbviewer
+  module Api
+    class QueriesController < BaseController
+      def recent
+        @recent_queries = if Dbviewer.configuration.enable_query_logging
+          Dbviewer::Logger.instance.recent_queries(limit: 10)
+        else
+          []
+        end
+
+        render_success({
+          enabled: Dbviewer.configuration.enable_query_logging,
+          queries: @recent_queries
+        })
+      end
+    end
+  end
+end

data/app/controllers/dbviewer/api/tables_controller.rb

@@ -0,0 +1,39 @@
+module Dbviewer
+  module Api
+    class TablesController < BaseController
+      def index
+        tables = fetch_tables_with_stats(include_record_counts: false)
+        render_success(total_tables: tables.size)
+      end
+
+      def records
+        tables = fetch_tables_with_stats(include_record_counts: true)
+
+        records_data = {
+          total_records: tables.sum { |t| t[:record_count] },
+          largest_tables: tables.sort_by { |t| -t[:record_count] }.first(10),
+          empty_tables: tables.select { |t| t[:record_count] == 0 },
+          avg_records_per_table: tables.any? ? (tables.sum { |t| t[:record_count] }.to_f / tables.size).round(1) : 0
+        }
+
+        render_success(records_data)
+      end
+
+      def relationships_count
+        begin
+          tables = fetch_tables_with_stats(include_record_counts: false)
+          total_relationships = 0
+
+          tables.each do |table|
+            metadata = fetch_table_metadata(table[:name])
+            total_relationships += metadata[:foreign_keys].size if metadata && metadata[:foreign_keys]
+          end
+
+          render_success(total_relationships: total_relationships)
+        rescue => e
+          render_error("Error calculating relationship count: #{e.message}")
+        end
+      end
+    end
+  end
+end

data/app/controllers/dbviewer/home_controller.rb

@@ -1,98 +1,6 @@
 module Dbviewer
   class HomeController < ApplicationController
     def index
-      # Load page immediately without heavy data
-      # Data will be loaded asynchronously via AJAX
-    end
-
-    def analytics
-      # This method is deprecated but kept for backward compatibility
-      analytics_data = fetch_database_analytics
-      # Remove record data which will be served by the records endpoint
-      analytics_data.delete(:total_records)
-      analytics_data.delete(:largest_tables)
-      analytics_data.delete(:empty_tables)
-      analytics_data.delete(:avg_records_per_table)
-
-      respond_to do |format|
-        format.json { render json: analytics_data }
-      end
-    end
-
-    def tables_count
-      tables = fetch_tables_with_stats(include_record_counts: false)
-
-      respond_to do |format|
-        format.json { render json: { total_tables: tables.size } }
-      end
-    end
-
-    def relationships_count
-      begin
-        tables = fetch_tables_with_stats(include_record_counts: false)
-        total_relationships = 0
-
-        tables.each do |table|
-          metadata = fetch_table_metadata(table[:name])
-          total_relationships += metadata[:foreign_keys].size if metadata && metadata[:foreign_keys]
-        end
-
-        respond_to do |format|
-          format.json { render json: { total_relationships: total_relationships } }
-        end
-      rescue => e
-        Rails.logger.error("Error calculating relationship count: #{e.message}")
-        respond_to do |format|
-          format.json { render json: { total_relationships: 0, error: e.message }, status: :internal_server_error }
-        end
-      end
-    end
-
-    def database_size
-      begin
-        size = calculate_schema_size
-
-        respond_to do |format|
-          format.json { render json: { schema_size: size } }
-        end
-      rescue => e
-        Rails.logger.error("Error calculating schema size: #{e.message}")
-        respond_to do |format|
-          format.json { render json: { schema_size: nil, error: e.message }, status: :internal_server_error }
-        end
-      end
-    end
-
-    def records
-      tables = fetch_tables_with_stats(include_record_counts: true)
-
-      records_data = {
-        total_records: tables.sum { |t| t[:record_count] },
-        largest_tables: tables.sort_by { |t| -t[:record_count] }.first(10),
-        empty_tables: tables.select { |t| t[:record_count] == 0 },
-        avg_records_per_table: tables.any? ? (tables.sum { |t| t[:record_count] }.to_f / tables.size).round(1) : 0
-      }
-
-      respond_to do |format|
-        format.json { render json: records_data }
-      end
-    end
-
-    def recent_queries
-      @recent_queries = if Dbviewer.configuration.enable_query_logging
-        Dbviewer::Logger.instance.recent_queries(limit: 10)
-      else
-        []
-      end
-
-      respond_to do |format|
-        format.json do
-          render json: {
-            enabled: Dbviewer.configuration.enable_query_logging,
-            queries: @recent_queries
-          }
-        end
-      end
     end
 
     private

data/app/controllers/dbviewer/tables_controller.rb

@@ -103,11 +103,9 @@ module Dbviewer
       @current_page = [ 1, params[:page].to_i ].max
       @per_page = params[:per_page] ? params[:per_page].to_i : self.class.default_per_page
       @per_page = self.class.default_per_page unless self.class.per_page_options.include?(@per_page)
-      @order_by = params[:order_by].presence ||
-                  database_manager.primary_key(@table_name).presence ||
-                  (@columns.first ? @columns.first[:name] : nil)
+      @order_by = params[:order_by].presence || determine_default_order_column
       @order_direction = params[:order_direction].upcase if params[:order_direction].present?
-      @order_direction = "ASC" unless self.class::VALID_SORT_DIRECTIONS.include?(@order_direction)
+      @order_direction = "DESC" unless self.class::VALID_SORT_DIRECTIONS.include?(@order_direction)
       @column_filters = params[:column_filters].presence ? params[:column_filters].to_enum.to_h : {}
     end
 
@@ -158,5 +156,23 @@ module Dbviewer
         end
       end
     end
+
+    # Determine the default order column using configurable ordering logic
+    def determine_default_order_column
+      # Get the table columns to check what's available
+      columns = @columns || fetch_table_columns(@table_name)
+      column_names = columns.map { |col| col[:name] }
+
+      # Try the configured default order column first
+      default_column = Dbviewer.configuration.default_order_column
+      return default_column if default_column && column_names.include?(default_column)
+
+      # Fall back to primary key
+      primary_key = database_manager.primary_key(@table_name)
+      return primary_key if primary_key.present?
+
+      # Final fallback to first column
+      columns.first ? columns.first[:name] : nil
+    end
   end
 end

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

@@ -8,7 +8,7 @@
     </div>
   </div>
 
-  <div class="row g-3 mb-4" id="analytics-cards">
+  <div class="row g-3 mb-4 dashboard-analytics-cards">
     <div class="col-md-4">
       <div class="card h-100 border-0 shadow-sm <%= stat_card_bg_class %>">
         <div class="card-body d-flex align-items-center">
@@ -299,7 +299,7 @@ document.addEventListener('DOMContentLoaded', function() {
   }
 
   // Load tables count data
-  fetch('<%= api_tables_path %>', {
+  fetch('<%= dbviewer.api_tables_path %>', {
     headers: {
       'Accept': 'application/json',
       'X-Requested-With': 'XMLHttpRequest'
@@ -324,7 +324,7 @@ document.addEventListener('DOMContentLoaded', function() {
   });
 
   // Load database size data
-  fetch('<%= api_database_size_path %>', {
+  fetch('<%= dbviewer.size_api_database_path %>', {
     headers: {
       'Accept': 'application/json',
       'X-Requested-With': 'XMLHttpRequest'
@@ -349,7 +349,7 @@ document.addEventListener('DOMContentLoaded', function() {
   });
   
   // Load records data separately
-  fetch('<%= api_records_path %>', {
+  fetch('<%= dbviewer.records_api_tables_path %>', {
     headers: {
       'Accept': 'application/json',
       'X-Requested-With': 'XMLHttpRequest'
@@ -377,7 +377,7 @@ document.addEventListener('DOMContentLoaded', function() {
   });
 
   // Load recent queries data
-  fetch('<%= api_recent_queries_path %>', {
+  fetch('<%= dbviewer.recent_api_queries_path %>', {
     headers: {
       'Accept': 'application/json',
       'X-Requested-With': 'XMLHttpRequest'
@@ -400,73 +400,173 @@ document.addEventListener('DOMContentLoaded', function() {
 </script>
 
 <style>
+  /* ================================================
+     CSS Custom Properties (CSS Variables)
+     ================================================ */
+  :root {
+    /* Colors */
+    --dbviewer-code-bg: rgba(0, 0, 0, 0.05);
+    --dbviewer-code-border: rgba(0, 0, 0, 0.1);
+    --dbviewer-muted-color: #6c757d;
+    --dbviewer-success-color: #28a745;
+    --dbviewer-danger-color: #dc3545;
+    --dbviewer-warning-color: #ffc107;
+    
+    /* Skeleton loader colors */
+    --skeleton-base-color: #f0f0f0;
+    --skeleton-highlight-color: #e0e0e0;
+    
+    /* Typography */
+    --dbviewer-monospace-font: 'Courier New', Courier, monospace;
+    --dbviewer-code-font-size: 0.85rem;
+    
+    /* Spacing and sizing */
+    --dbviewer-border-radius: 4px;
+    --dbviewer-border-radius-sm: 3px;
+    --dbviewer-padding-sm: 2px 4px;
+  }
+
+  /* ================================================
+     Dark Mode Support
+     ================================================ */
+  @media (prefers-color-scheme: dark) {
+    :root {
+      --dbviewer-code-bg: rgba(255, 255, 255, 0.1);
+      --dbviewer-code-border: rgba(255, 255, 255, 0.15);
+      --dbviewer-muted-color: #adb5bd;
+      --skeleton-base-color: #2a2a2a;
+      --skeleton-highlight-color: #404040;
+    }
+  }
+
+  /* Bootstrap dark mode support */
+  [data-bs-theme="dark"] {
+    --dbviewer-code-bg: rgba(255, 255, 255, 0.1);
+    --dbviewer-code-border: rgba(255, 255, 255, 0.15);
+    --dbviewer-muted-color: #adb5bd;
+    --skeleton-base-color: #2a2a2a;
+    --skeleton-highlight-color: #404040;
+  }
+
+  /* ================================================
+     SQL Query Styling
+     ================================================ */
   .sql-query-code {
-    font-family: 'Courier New', Courier, monospace;
-    font-size: 0.85rem;
-    background-color: rgba(0, 0, 0, 0.05);
-    padding: 2px 4px;
-    border-radius: 3px;
+    font-family: var(--dbviewer-monospace-font);
+    font-size: var(--dbviewer-code-font-size);
+    background-color: var(--dbviewer-code-bg);
+    padding: var(--dbviewer-padding-sm);
+    border-radius: var(--dbviewer-border-radius-sm);
+    border: 1px solid var(--dbviewer-code-border);
+    transition: background-color 0.2s ease, border-color 0.2s ease;
   }
-  
+
+  .sql-query-code:hover {
+    background-color: var(--dbviewer-code-bg);
+    filter: brightness(0.95);
+  }
+
+  /* ================================================
+     Query Performance Indicators
+     ================================================ */
   .query-duration {
-    color: #28a745;
+    color: var(--dbviewer-success-color);
     font-weight: 500;
+    font-variant-numeric: tabular-nums;
+    transition: color 0.2s ease;
   }
   
   .query-duration-slow {
-    color: #dc3545;
+    color: var(--dbviewer-danger-color);
     font-weight: 600;
+    font-variant-numeric: tabular-nums;
+    transition: color 0.2s ease;
   }
   
   .query-timestamp {
-    color: #6c757d;
+    color: var(--dbviewer-muted-color);
+    font-variant-numeric: tabular-nums;
+    transition: color 0.2s ease;
   }
-  
+
+  /* ================================================
+     Empty States and Messages
+     ================================================ */
   .empty-data-message {
-    color: #6c757d;
+    color: var(--dbviewer-muted-color);
+    transition: color 0.2s ease;
   }
-  
-  /* Loading animations */
+
+  .empty-data-message p {
+    margin-bottom: 0.5rem;
+    font-weight: 500;
+  }
+
+  .empty-data-message small {
+    opacity: 0.8;
+  }
+
+  /* ================================================
+     Loading States
+     ================================================ */
   .spinner-border-sm {
     width: 1rem;
     height: 1rem;
   }
-  
-  /* Skeleton loader styles */
+
+  /* ================================================
+     Skeleton Loader System
+     ================================================ */
   .skeleton-loader {
     display: inline-block;
     height: 1.2em;
     width: 100%;
-    background: linear-gradient(90deg, #f0f0f0 25%, #e0e0e0 37%, #f0f0f0 63%);
+    background: linear-gradient(
+      90deg, 
+      var(--skeleton-base-color) 25%, 
+      var(--skeleton-highlight-color) 37%, 
+      var(--skeleton-base-color) 63%
+    );
     background-size: 400% 100%;
     animation: skeleton-loading 1.2s ease-in-out infinite;
-    border-radius: 4px;
+    border-radius: var(--dbviewer-border-radius);
   }
-  .number-loader {
+
+  /* Skeleton loader variants */
+  .skeleton-loader.number-loader {
     width: 2.5em;
     height: 1.5em;
     margin-bottom: 0.2em;
   }
-  .table-cell-loader {
+
+  .skeleton-loader.table-cell-loader {
     width: 6em;
     height: 1.2em;
   }
-  .records-loader {
+
+  .skeleton-loader.records-loader {
     width: 3em;
     height: 1.2em;
   }
-  .query-cell-loader {
+
+  .skeleton-loader.query-cell-loader {
     width: 12em;
     height: 1.2em;
   }
-  .duration-cell-loader {
+
+  .skeleton-loader.duration-cell-loader {
     width: 4em;
     height: 1.2em;
   }
-  .time-cell-loader {
+
+  .skeleton-loader.time-cell-loader {
     width: 7em;
     height: 1.2em;
   }
+
+  /* ================================================
+     Animations
+     ================================================ */
   @keyframes skeleton-loading {
     0% {
       background-position: 100% 50%;
@@ -475,4 +575,58 @@ document.addEventListener('DOMContentLoaded', function() {
       background-position: 0 50%;
     }
   }
+
+  /* ================================================
+     Table Enhancements
+     ================================================ */
+  .table-hover tbody tr:hover .sql-query-code {
+    background-color: var(--dbviewer-code-bg);
+    filter: brightness(0.9);
+  }
+
+  /* ================================================
+     Responsive Design
+     ================================================ */
+  @media (max-width: 768px) {
+    .sql-query-code {
+      font-size: 0.75rem;
+      padding: 1px 3px;
+    }
+    
+    .query-cell-loader {
+      width: 8em;
+    }
+    
+    .duration-cell-loader {
+      width: 3em;
+    }
+    
+    .time-cell-loader {
+      width: 5em;
+    }
+  }
+
+  /* ================================================
+     Accessibility Improvements
+     ================================================ */
+  @media (prefers-reduced-motion: reduce) {
+    .skeleton-loader {
+      animation: none;
+      background: var(--skeleton-base-color);
+    }
+    
+    .sql-query-code,
+    .query-duration,
+    .query-duration-slow,
+    .query-timestamp,
+    .empty-data-message {
+      transition: none;
+    }
+  }
+
+  /* Focus states for better keyboard navigation */
+  .sql-query-code:focus-visible {
+    outline: 2px solid var(--dbviewer-success-color);
+    outline-offset: 2px;
+  }
 </style>