dbviewer 0.4.8 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03dfb13567e8cf7a2eaf2977e421fec7a2117ff12a6462515399a4b7cfb056d1
-  data.tar.gz: 77ae23ada80eabbc1a5744376a96c0d5df4f20f0cb3723be4c0f9c9967994716
+  metadata.gz: d16f8924e91f06f61088b4948397aa23530cd6e4a89e00ab483cc047ea5fc492
+  data.tar.gz: 98091d292dfe7c42f0644dc1734fb298f532cfc6f99e0176ff1ae517c8db1cc8
 SHA512:
-  metadata.gz: 35d69706133dc764c081a6bc172dc0d99f39c2eaa7d62db9c17664c5a1fe05b78255932bd14a3f9a9542e99cb74020cb2926d69c9d21d9a339776fc4023098e9
-  data.tar.gz: b3a4e2029d81da79e922fb5ee0e889fc9e1f66e66129136333f6820d66dbc1dd7648da63a4ab99d3ed822e8cc64c77e9815a1c1bd34b4d0a11b208118d2eb72c
+  metadata.gz: a423fec219eaf8f40adde10a316cd4e45f33eb27d514ead5a0da735db3a475ac1ac430851cc347095106ca011dda72eae4ab68a01cba8ea8782ab132c99de8b6
+  data.tar.gz: 57594e053bf4bd1389da099fa91236af80e579bfc6f0ebd72da5081187c16a2343717c803632781bf39eb8d5281151cc8614def62c035b1b35dfd2f8946da631

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

@@ -5,7 +5,7 @@ module Dbviewer
     extend ActiveSupport::Concern
 
     included do
-      helper_method :current_table?, :get_database_name if respond_to?(:helper_method)
+      helper_method :current_table?, :get_database_name, :get_adapter_name if respond_to?(:helper_method)
     end
 
     # Initialize the database manager
@@ -44,13 +44,36 @@ module Dbviewer
       "Database"
     end
 
+    # Get the name of the current database adapter
+    def get_adapter_name
+      adapter = database_manager.connection.adapter_name
+
+      # Format the adapter name for better display
+      case adapter.downcase
+      when /mysql/
+        "MySQL"
+      when /postgres/
+        "PostgreSQL"
+      when /sqlite/
+        "SQLite"
+      when /oracle/
+        "Oracle"
+      when /sqlserver/, /mssql/
+        "SQL Server"
+      else
+        adapter.titleize # Fallback to titleized version
+      end
+    rescue => e
+      Rails.logger.error("Error retrieving adapter name: #{e.message}")
+      "Unknown"
+    end
+
     # Fetch all tables with their stats
     # By default, don't include record counts for better performance on sidebar
-    def fetch_tables_with_stats(include_record_counts = false)
+    def fetch_tables(include_record_counts = false)
       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
@@ -63,7 +86,7 @@ module Dbviewer
     # Gather database analytics information
     def fetch_database_analytics
       # For analytics, we do need record counts
-      tables = fetch_tables_with_stats(include_record_counts: true)
+      tables = fetch_tables(include_record_counts: true)
 
       # Calculate overall statistics
       analytics = {
@@ -72,82 +95,12 @@ 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
 
-    # Calculate approximate schema size
-    def calculate_schema_size
-      adapter = database_manager.connection.adapter_name.downcase
-
-      case adapter
-      when /mysql/
-        query = <<-SQL
-          SELECT
-            SUM(data_length + index_length) AS size
-          FROM
-            information_schema.TABLES
-          WHERE
-            table_schema = DATABASE()
-        SQL
-        result = database_manager.execute_query(query).first
-        result ? result["size"].to_i : nil
-      when /postgres/
-        query = <<-SQL
-          SELECT pg_database_size(current_database()) AS size
-        SQL
-        result = database_manager.execute_query(query).first
-        result ? result["size"].to_i : nil
-      when /sqlite/
-        # For SQLite, we need to use the special PRAGMA method without LIMIT
-        # Get page count
-        page_count_result = database_manager.execute_sqlite_pragma("page_count")
-        page_count = page_count_result.first.values.first.to_i
-
-        # Get page size
-        page_size_result = database_manager.execute_sqlite_pragma("page_size")
-        page_size = page_size_result.first.values.first.to_i
-
-        # Calculate total size
-        page_count * page_size
-      else
-        nil # Unsupported database type for size calculation
-      end
-    rescue => e
-      Rails.logger.error("Error calculating database size: #{e.message}")
-      nil
-    end
-
     # Get column information for a specific table
     def fetch_table_columns(table_name)
       database_manager.table_columns(table_name)

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,10 @@
+module Dbviewer
+  module Api
+    class DatabaseController < BaseController
+      def size
+        size = database_manager.fetch_schema_size
+        render_success(schema_size: size)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Dbviewer
+  module Api
+    class QueriesController < BaseController
+      def recent
+        render_success({
+          enabled: query_logging_enabled?,
+          queries: fetch_recent_queries
+        })
+      end
+
+      private
+
+      def fetch_recent_queries
+        return [] unless query_logging_enabled?
+
+        Dbviewer::Logger.instance.recent_queries(limit: queries_limit)
+      end
+
+      def query_logging_enabled?
+        Dbviewer.configuration.enable_query_logging
+      end
+
+      def queries_limit
+        10
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+module Dbviewer
+  module Api
+    class TablesController < BaseController
+      def index
+        tables_count = fetch_tables_count
+        render_success(total_tables: tables_count)
+      end
+
+      def records
+        tables_stats = fetch_tables_stats
+        render_success(tables_stats)
+      end
+
+      def relationships_count
+        total_relationships = calculate_total_relationships
+        render_success(total_relationships: total_relationships)
+      end
+
+      private
+
+      def fetch_tables_count
+        fetch_tables(include_record_counts: false).size
+      end
+
+      def fetch_tables_stats
+        tables = fetch_tables(include_record_counts: true)
+
+        {
+          total_records: calculate_total_records(tables),
+          largest_tables: find_largest_tables(tables),
+          empty_tables: find_empty_tables(tables),
+          avg_records_per_table: calculate_average_records(tables)
+        }
+      end
+
+      def calculate_total_relationships
+        tables = fetch_tables(include_record_counts: false)
+
+        tables.sum do |table|
+          metadata = fetch_table_metadata(table[:name])
+          metadata&.dig(:foreign_keys)&.size || 0
+        end
+      end
+
+      def calculate_total_records(tables)
+        tables.sum { |table| table[:record_count] }
+      end
+
+      def find_largest_tables(tables, limit = 10)
+        tables.sort_by { |table| -table[:record_count] }.first(limit)
+      end
+
+      def find_empty_tables(tables)
+        tables.select { |table| table[:record_count] == 0 }
+      end
+
+      def calculate_average_records(tables)
+        return 0 if tables.empty?
+
+        (calculate_total_records(tables).to_f / tables.size).round(1)
+      end
+    end
+  end
+end

data/app/controllers/dbviewer/application_controller.rb

@@ -19,7 +19,7 @@ module Dbviewer
     end
 
     def set_tables
-      @tables = fetch_tables_with_stats
+      @tables = fetch_tables
     end
   end
 end

data/app/controllers/dbviewer/home_controller.rb

@@ -1,104 +1,12 @@
 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
 
     def set_tables
-      @tables = fetch_tables_with_stats(include_record_counts: true)
+      @tables = fetch_tables(include_record_counts: true)
     end
   end
 end

data/app/controllers/dbviewer/tables_controller.rb

@@ -7,7 +7,7 @@ module Dbviewer
     before_action :set_global_filters, only: [ :show, :export_csv ]
 
     def index
-      @tables = fetch_tables_with_stats(include_record_counts: true)
+      @tables = fetch_tables(include_record_counts: true)
     end
 
     def show
@@ -60,7 +60,7 @@ module Dbviewer
     def query
       @read_only_mode = true # Flag to indicate we're in read-only mode
       @columns = fetch_table_columns(@table_name)
-      @tables = fetch_tables_with_stats  # Fetch tables for sidebar
+      @tables = fetch_tables  # Fetch tables for sidebar
 
       prepare_query
       execute_query

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

@@ -3,12 +3,12 @@
     <div class="col">
       <h1 class="h3 mb-2">Database Overview</h1>
       <p class="database-connection-info">
-        Connected to database: <span class="badge rounded-pill database-name-badge"><%= get_database_name %></span>
+        Connected to <%= get_adapter_name %> database: <span class="badge rounded-pill database-name-badge"><%= get_database_name %></span>
       </p>
     </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'

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

@@ -314,7 +314,7 @@
 <% content_for :sidebar_active do %>active<% end %>
 
 <div class="d-flex justify-content-between align-items-center mb-4">
-  <div>
+  <div class="d-flex justify-content-between align-items-center">
     <h1>Table: <%= @table_name %></h1>
   </div>
   <div class="d-flex gap-2">
@@ -393,7 +393,7 @@
 </div>
 
 <!-- Records Section -->
-<div class="dbviewer-card card mb-4">
+<div class="dbviewer-card card mb-4" id="table-section">
   <div class="card-header d-flex justify-content-between align-items-center">
     <h5 class="mb-0">
       <select id="per-page-select" class="form-select form-select-sm" onchange="window.location.href='<%= table_path(@table_name) %>?<%= per_page_url_params(@table_name) %>'">
@@ -414,6 +414,9 @@
       <% if active_filters > 0 %>
         <span class="badge bg-info ms-2" title="Active filters"><i class="bi bi-funnel-fill me-1"></i><%= active_filters %></span>
       <% end %>
+      <button type="button" class="btn btn-outline-secondary btn-sm ms-2" id="fullscreen-toggle" title="Toggle fullscreen">
+        <i class="bi bi-fullscreen" id="fullscreen-icon"></i>
+      </button>
     </div>
   </div>
     <div class="card-body p-0">
@@ -1311,6 +1314,71 @@
   [data-bs-theme="dark"] .record-detail-table .code-block {
     background-color: var(--bs-dark);
   }
+
+  /* Fullscreen table styles */
+  .table-fullscreen {
+    position: fixed !important;
+    top: 0 !important;
+    left: 0 !important;
+    width: 100vw !important;
+    height: 100vh !important;
+    z-index: 9999 !important;
+    background: var(--bs-body-bg) !important;
+    margin: 0 !important;
+    border-radius: 0 !important;
+    overflow: hidden !important;
+    display: flex !important;
+    flex-direction: column !important;
+  }
+
+  .table-fullscreen .card-body {
+    flex: 1 !important;
+    overflow: hidden !important;
+    display: flex !important;
+    flex-direction: column !important;
+  }
+
+  .table-fullscreen .table-responsive {
+    flex: 1 !important;
+    overflow: auto !important;
+  }
+
+  .table-fullscreen .card-header {
+    flex-shrink: 0 !important;
+    position: sticky !important;
+    top: 0 !important;
+    z-index: 10000 !important;
+    background: var(--bs-body-bg) !important;
+    border-bottom: 1px solid var(--bs-border-color) !important;
+  }
+
+  /* Hide pagination in fullscreen mode */
+  .table-fullscreen .pagination-container {
+    display: none !important;
+  }
+
+  /* Adjust table header in fullscreen */
+  .table-fullscreen .dbviewer-table-header {
+    position: sticky !important;
+    top: 0 !important;
+    z-index: 100 !important;
+  }
+
+  /* Ensure body doesn't scroll when table is fullscreen */
+  body.table-fullscreen-active {
+    overflow: hidden !important;
+  }
+
+  /* Fullscreen button hover effect */
+  #fullscreen-toggle:hover {
+    background-color: var(--bs-secondary-bg) !important;
+    border-color: var(--bs-secondary-border-subtle) !important;
+  }
+
+  /* Smooth transitions */
+  #table-section {
+    transition: all 0.3s ease-in-out;
+  }
 </style>
 
 <% if @timestamp_data.present? %>
@@ -1516,5 +1584,70 @@
     
     return section;
   }
+
+  // Table fullscreen functionality
+  document.addEventListener('DOMContentLoaded', function() {
+    const fullscreenToggle = document.getElementById('fullscreen-toggle');
+    const fullscreenIcon = document.getElementById('fullscreen-icon');
+    const tableSection = document.getElementById('table-section');
+    
+    if (fullscreenToggle && tableSection) {
+      // Key for storing fullscreen state in localStorage
+      const fullscreenStateKey = 'dbviewer-table-fullscreen-<%= @table_name %>';
+      
+      // Function to apply fullscreen state
+      function applyFullscreenState(isFullscreen) {
+        if (isFullscreen) {
+          // Enter fullscreen
+          tableSection.classList.add('table-fullscreen');
+          document.body.classList.add('table-fullscreen-active');
+          fullscreenIcon.classList.remove('bi-fullscreen');
+          fullscreenIcon.classList.add('bi-fullscreen-exit');
+          fullscreenToggle.setAttribute('title', 'Exit fullscreen');
+        } else {
+          // Exit fullscreen
+          tableSection.classList.remove('table-fullscreen');
+          document.body.classList.remove('table-fullscreen-active');
+          fullscreenIcon.classList.remove('bi-fullscreen-exit');
+          fullscreenIcon.classList.add('bi-fullscreen');
+          fullscreenToggle.setAttribute('title', 'Toggle fullscreen');
+        }
+      }
+      
+      // Restore fullscreen state from localStorage on page load
+      try {
+        const savedState = localStorage.getItem(fullscreenStateKey);
+        if (savedState === 'true') {
+          applyFullscreenState(true);
+        }
+      } catch (e) {
+        // Handle localStorage not available (private browsing, etc.)
+        console.warn('Could not restore fullscreen state:', e);
+      }
+      
+      fullscreenToggle.addEventListener('click', function() {
+        const isFullscreen = tableSection.classList.contains('table-fullscreen');
+        const newState = !isFullscreen;
+        
+        // Apply the new state
+        applyFullscreenState(newState);
+        
+        // Save state to localStorage
+        try {
+          localStorage.setItem(fullscreenStateKey, newState.toString());
+        } catch (e) {
+          // Handle localStorage not available (private browsing, etc.)
+          console.warn('Could not save fullscreen state:', e);
+        }
+      });
+      
+      // Exit fullscreen with Escape key
+      document.addEventListener('keydown', function(e) {
+        if (e.key === 'Escape' && tableSection.classList.contains('table-fullscreen')) {
+          fullscreenToggle.click();
+        }
+      });
+    }
+  });
 </script>
 <% end %>