dbviewer 0.4.3 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cc641a4845b5267ef95a4fd7b5c368a9f4145dd0f60322eb753e8b4a270414a
-  data.tar.gz: 37ee52e24a3578c61f939b14d74cea8d125e4f737ed98abafa109c9a3e71e627
+  metadata.gz: a9caec4627e8912e40d85d63c9105cdc80b2bae4227e145372693855a40fbc29
+  data.tar.gz: ca759885a1ec9522860d9926e1814f68457fa453832f7b3ea3298aa5c86222eb
 SHA512:
-  metadata.gz: 4253de79918ecd100eeb6f8e17b4e64346060295defd167cb709227db1eec0cd6716e230c1c56ae251dac5361643eaf8abd529fc566a31cad27edfdcc72ad424
-  data.tar.gz: af7b679d9ec6116487322ce9309ca4390e02e22fdaf8d873dff8c71f83ab8142a8bd7d08f34e9fd127d2a233c963b9903bf82bfd75972f8f6452f67c5994ab1e
+  metadata.gz: d71176e418170a1d82439a1266687d6f125c27dd96dcf008fb05ccecc169d11dafb52f1c5940549e030f3487fe8c2408f73dda51e7ddae8e05b598cde621943f
+  data.tar.gz: cebdde38e2e4500a265b20b86d1e6daee3ed7ba95447b348635efb00e963f7d895b8f147ab94b2b8c50656940c74279ebfbd17a90ff3921341cec2a0121b84cd

data/README.md

@@ -169,7 +169,13 @@ end
 
 ## ⚙️ Configuration Options
 
-You can configure DBViewer by creating an initializer in your application:
+You can configure DBViewer by using our generator to create an initializer in your application:
+
+```bash
+rails generate dbviewer:initializer
+```
+
+This will create a file at `config/initializers/dbviewer.rb` with the default configuration:
 
 ```ruby
 # config/initializers/dbviewer.rb
@@ -183,16 +189,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 +310,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/controllers/dbviewer/application_controller.rb

@@ -3,7 +3,7 @@ module Dbviewer
     include Dbviewer::DatabaseOperations
     include Dbviewer::ErrorHandling
 
-    # before_action :authenticate_with_basic_auth
+    before_action :authenticate_with_basic_auth
     before_action :set_tables
 
     private

data/app/controllers/dbviewer/home_controller.rb

@@ -6,10 +6,75 @@ module Dbviewer
     end
 
     def analytics
-      @analytics = fetch_database_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 }
+        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
 

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

@@ -9,7 +9,7 @@
   </div>
 
   <div class="row g-3 mb-4" id="analytics-cards">
-    <div class="col-md-3">
+    <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">
           <div class="metric-icon me-3">
@@ -28,7 +28,7 @@
       </div>
     </div>
     
-    <div class="col-md-3">
+    <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">
           <div class="metric-icon me-3">
@@ -47,27 +47,7 @@
       </div>
     </div>
     
-    <div class="col-md-3">
-      <div class="card h-100 border-0 shadow-sm <%= stat_card_bg_class %>">
-        <div class="card-body d-flex align-items-center">
-          <div class="metric-icon me-3">
-            <i class="bi bi-link-45deg fs-4"></i>
-          </div>
-          <div class="text-start">
-            <h5 class="mb-1">Relationships</h5>
-            <h2 class="mb-0">
-              <span class="skeleton-loader number-loader" id="relationships-loading">
-                &nbsp;&nbsp;
-              </span>
-              <span id="relationships-count" class="d-none">0</span>
-            </h2>
-            <small class="text-muted d-block">Foreign Key Connections</small>
-          </div>
-        </div>
-      </div>
-    </div>
-    
-    <div class="col-md-3">
+    <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">
           <div class="metric-icon me-3">
@@ -171,33 +151,39 @@ document.addEventListener('DOMContentLoaded', function() {
   }
 
   // Function to update analytics cards
-  function updateAnalyticsCards(analytics) {
-    // Update tables count
+  function updateTablesCount(data) {
     document.getElementById('tables-loading').classList.add('d-none');
     document.getElementById('tables-count').classList.remove('d-none');
-    document.getElementById('tables-count').textContent = analytics.total_tables || 0;
-
-    // Update records count
-    document.getElementById('records-loading').classList.add('d-none');
-    document.getElementById('records-count').classList.remove('d-none');
-    document.getElementById('records-count').textContent = numberWithDelimiter(analytics.total_records || 0);
-
-    // Update relationships count
+    document.getElementById('tables-count').textContent = data.total_tables || 0;
+  }
+  
+  function updateRelationshipsCount(data) {
     document.getElementById('relationships-loading').classList.add('d-none');
     document.getElementById('relationships-count').classList.remove('d-none');
-    document.getElementById('relationships-count').textContent = analytics.total_relationships || 0;
-
-    // Update database size
+    document.getElementById('relationships-count').textContent = data.total_relationships || 0;
+  }
+  
+  function updateDatabaseSize(data) {
     document.getElementById('size-loading').classList.add('d-none');
     document.getElementById('size-count').classList.remove('d-none');
-    document.getElementById('size-count').textContent = numberToHumanSize(analytics.schema_size);
+    document.getElementById('size-count').textContent = numberToHumanSize(data.schema_size);
+  }
+  
+  function updateRecordsData(recordsData) {
+    // Update records count
+    document.getElementById('records-loading').classList.add('d-none');
+    document.getElementById('records-count').classList.remove('d-none');
+    document.getElementById('records-count').textContent = numberWithDelimiter(recordsData.total_records || 0);
+    
+    // Update largest tables
+    updateLargestTables(recordsData);
   }
 
   // Function to update largest tables
-  function updateLargestTables(analytics) {
+  function updateLargestTables(data) {
     const container = document.getElementById('largest-tables-container');
     
-    if (analytics.largest_tables && analytics.largest_tables.length > 0) {
+    if (data.largest_tables && data.largest_tables.length > 0) {
       const tableHtml = `
         <div class="table-responsive">
           <table class="table table-sm table-hover">
@@ -208,7 +194,7 @@ document.addEventListener('DOMContentLoaded', function() {
               </tr>
             </thead>
             <tbody>
-              ${analytics.largest_tables.map(table => `
+              ${data.largest_tables.map(table => `
                 <tr>
                   <td>
                     <a href="${window.location.origin}${window.location.pathname.replace(/\/$/, '')}/tables/${table.name}">
@@ -312,8 +298,58 @@ document.addEventListener('DOMContentLoaded', function() {
     `;
   }
 
-  // Load analytics data
-  fetch('<%= api_analytics_path %>', {
+  // Load tables count data
+  fetch('<%= api_tables_path %>', {
+    headers: {
+      'Accept': 'application/json',
+      'X-Requested-With': 'XMLHttpRequest'
+    }
+  })
+  .then(response => {
+    if (!response.ok) {
+      throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+    }
+    return response.json();
+  })
+  .then(data => {
+    updateTablesCount(data);
+  })
+  .catch(error => {
+    console.error('Error loading tables count:', error);
+    const loading = document.getElementById('tables-loading');
+    const count = document.getElementById('tables-count');
+    loading.classList.add('d-none');
+    count.classList.remove('d-none');
+    count.innerHTML = '<span class="text-danger">Error</span>';
+  });
+
+  // Load database size data
+  fetch('<%= api_database_size_path %>', {
+    headers: {
+      'Accept': 'application/json',
+      'X-Requested-With': 'XMLHttpRequest'
+    }
+  })
+  .then(response => {
+    if (!response.ok) {
+      throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+    }
+    return response.json();
+  })
+  .then(data => {
+    updateDatabaseSize(data);
+  })
+  .catch(error => {
+    console.error('Error loading database size:', error);
+    const loading = document.getElementById('size-loading');
+    const count = document.getElementById('size-count');
+    loading.classList.add('d-none');
+    count.classList.remove('d-none');
+    count.innerHTML = '<span class="text-danger">Error</span>';
+  });
+  
+  // Load records data separately
+  fetch('<%= api_records_path %>', {
     headers: {
       'Accept': 'application/json',
       'X-Requested-With': 'XMLHttpRequest'
@@ -325,20 +361,17 @@ document.addEventListener('DOMContentLoaded', function() {
     }
     return response.json();
   })
-  .then(analytics => {
-    updateAnalyticsCards(analytics);
-    updateLargestTables(analytics);
+  .then(recordsData => {
+    updateRecordsData(recordsData);
   })
   .catch(error => {
-    console.error('Error loading analytics:', error);
-    // Update cards with error state
-    ['tables-loading', 'records-loading', 'relationships-loading', 'size-loading'].forEach(id => {
-      const loading = document.getElementById(id);
-      const count = document.getElementById(id.replace('-loading', '-count'));
-      loading.classList.add('d-none');
-      count.classList.remove('d-none');
-      count.innerHTML = '<span class="text-danger">Error</span>';
-    });
+    console.error('Error loading records data:', error);
+    // Update records-related UI with error state
+    const recordsLoading = document.getElementById('records-loading');
+    const recordsCount = document.getElementById('records-count');
+    recordsLoading.classList.add('d-none');
+    recordsCount.classList.remove('d-none');
+    recordsCount.innerHTML = '<span class="text-danger">Error</span>';
     
     showError('largest-tables-container', error.message);
   });

data/config/routes.rb

@@ -18,7 +18,13 @@ Dbviewer::Engine.routes.draw do
 
   # Homepage and API endpoints
   get "dashboard", to: "home#index", as: :dashboard
-  get "api/analytics", to: "home#analytics"
+
+  # Analytics API endpoints
+  get "api/analytics", to: "home#analytics" # Legacy/combined endpoint
+  get "api/records", to: "home#records"
+  get "api/tables", to: "home#tables_count"
+  get "api/relationships", to: "home#relationships_count"
+  get "api/database_size", to: "home#database_size"
   get "api/recent_queries", to: "home#recent_queries"
 
   root to: "home#index"

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.3"
+  VERSION = "0.4.6"
 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.3
+  version: 0.4.6
 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: