dbviewer 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d16f8924e91f06f61088b4948397aa23530cd6e4a89e00ab483cc047ea5fc492
-  data.tar.gz: 98091d292dfe7c42f0644dc1734fb298f532cfc6f99e0176ff1ae517c8db1cc8
+  metadata.gz: 9f8d59c15a88c9b63e2765f80b554c2b2a0a33f82fdb094e1ed6f86fdf8dde20
+  data.tar.gz: d2bbe1fd8acae50c791ab4c32a061c78abbee095001e1647e32b4af4e6918753
 SHA512:
-  metadata.gz: a423fec219eaf8f40adde10a316cd4e45f33eb27d514ead5a0da735db3a475ac1ac430851cc347095106ca011dda72eae4ab68a01cba8ea8782ab132c99de8b6
-  data.tar.gz: 57594e053bf4bd1389da099fa91236af80e579bfc6f0ebd72da5081187c16a2343717c803632781bf39eb8d5281151cc8614def62c035b1b35dfd2f8946da631
+  metadata.gz: fcdf464a23ec52c45d85645ea0dcc9f57fe59c69b8452a68de7f000606d31d3e29c8b81ca237a228debc6884b57e8fb7a40500c1f02af550b3c5515456009ae5
+  data.tar.gz: 768b6cb0f7d67c0ecda6301c6a94471ad16a89f37c6164c8e4f976222f1e1f95720b17477e43811f4d9574c79c71e1f6e582471d0acf408b815aeba17b58c961

data/README.md

@@ -7,7 +7,6 @@ It's designed for development, debugging, and database analysis, offering a clea
 
 <img width="1470" alt="image" src="https://github.com/user-attachments/assets/0d2719ad-f5b4-4818-891d-5bff7be6c5c3" />
 
-
 ## ✨ Features
 
 - **Dashboard**: View a comprehensive dashboard with database analytics, largest tables, most complex tables, and recent SQL queries
@@ -270,6 +269,162 @@ The simplest way to update is using Bundler:
   rails server
   ```
 
+## 🛠️ Development Setup
+
+To set up the development environment for contributing to DBViewer:
+
+### Quick Setup
+
+Run the setup script to automatically configure your development environment:
+
+```bash
+bin/setup
+```
+
+This script will:
+
+- Install bundler and gem dependencies
+- Set up the test dummy Rails application
+- Create and seed the development database
+- Prepare the test environment
+- Clean up old logs and temporary files
+
+### Manual Setup
+
+If you prefer to set up manually:
+
+```bash
+# Install dependencies
+bundle install
+
+# Set up the dummy app database
+cd test/dummy
+bin/rails db:prepare
+bin/rails db:migrate
+bin/rails db:seed
+cd ../..
+
+# Prepare test environment
+cd test/dummy && bin/rails db:test:prepare && cd ../..
+```
+
+### Development Commands
+
+```bash
+# Start the development server
+cd test/dummy && bin/rails server
+
+# Run tests
+bundle exec rspec
+
+# Run code quality checks
+bin/rubocop
+
+# Open an interactive console
+bin/console
+
+# Build the gem
+gem build dbviewer.gemspec
+```
+
+### Testing Your Changes
+
+1. Start the dummy Rails application: `cd test/dummy && bin/rails server`
+2. Visit `http://localhost:3000/dbviewer` to test your changes
+3. The dummy app includes sample data across multiple tables to test various DBViewer features
+
+### Architecture Diagram
+```mermaid
+graph TB
+    subgraph "DBViewer Engine"
+        Engine[Engine<br/>Rails::Engine]
+        Config[Configuration<br/>Settings & Defaults]
+        SqlValidator[SqlValidator<br/>Query Validation]
+    end
+
+    subgraph "Controllers Layer"
+        HomeController[HomeController<br/>Dashboard & Overview]
+        TablesController[TablesController<br/>Table Operations]
+        LogsController[LogsController<br/>Query Logs]
+        ERDController[ERDController<br/>Entity Relationships]
+        APIController[API Controllers<br/>JSON Endpoints]
+    end
+
+    subgraph "Database Namespace"
+        Manager[Manager<br/>Database Operations]
+        CacheManager[CacheManager<br/>Caching Layer]
+        MetadataManager[MetadataManager<br/>Schema Information]
+        DynamicModelFactory[DynamicModelFactory<br/>ActiveRecord Models]
+    end
+
+    subgraph "Query Namespace"
+        QueryExecutor[Executor<br/>SQL Execution]
+        QueryLogger[Logger<br/>Query Logging]
+        QueryAnalyzer[Analyzer<br/>Performance Analysis]
+        QueryParser[Parser<br/>SQL Parsing]
+    end
+
+    subgraph "Datatable Namespace"
+        QueryOperations[QueryOperations<br/>Table Queries]
+        QueryParams[QueryParams<br/>Parameter Handling]
+    end
+
+    subgraph "Storage Namespace"
+        StorageBase[Base<br/>Storage Interface]
+        InMemoryStorage[InMemoryStorage<br/>Memory Storage]
+        FileStorage[FileStorage<br/>File Storage]
+    end
+
+    %% Configuration Dependencies (Decoupled)
+    Config -.->|"Dependency Injection"| Manager
+    Manager -->|"cache_expiry"| CacheManager
+    Manager -->|"config object"| QueryExecutor
+
+    %% Main Dependencies
+    Engine --> HomeController
+    Engine --> TablesController
+    Engine --> LogsController
+    Engine --> ERDController
+
+    Manager --> CacheManager
+    Manager --> MetadataManager
+    Manager --> DynamicModelFactory
+    Manager --> QueryOperations
+
+    CacheManager --> DynamicModelFactory
+    CacheManager --> MetadataManager
+
+    QueryOperations --> DynamicModelFactory
+    QueryOperations --> QueryExecutor
+    QueryOperations --> MetadataManager
+
+    QueryLogger --> StorageBase
+    StorageBase --> InMemoryStorage
+    StorageBase --> FileStorage
+
+    TablesController --> Manager
+    HomeController --> Manager
+    LogsController --> QueryLogger
+    APIController --> Manager
+    APIController --> QueryLogger
+
+    %% Decoupled Configuration Flow
+    Engine -.->|"setup()"| QueryLogger
+    Config -.->|"logging settings"| QueryLogger
+
+    classDef decoupled fill:#e1f5fe,stroke:#01579b,stroke-width:2px
+    classDef controller fill:#f3e5f5,stroke:#4a148c,stroke-width:2px
+    classDef database fill:#e8f5e8,stroke:#1b5e20,stroke-width:2px
+    classDef query fill:#fff3e0,stroke:#e65100,stroke-width:2px
+    classDef storage fill:#fce4ec,stroke:#880e4f,stroke-width:2px
+
+    class CacheManager,QueryLogger decoupled
+    class HomeController,TablesController,LogsController,ERDController,APIController controller
+    class Manager,MetadataManager,DynamicModelFactory database
+    class QueryExecutor,QueryAnalyzer,QueryParser query
+    class StorageBase,InMemoryStorage,FileStorage storage
+```
+
 ## 🤌🏻 Contributing
 
 Bug reports and pull requests are welcome.

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

@@ -10,7 +10,7 @@ module Dbviewer
 
     # Initialize the database manager
     def database_manager
-      @database_manager ||= ::Dbviewer::DatabaseManager.new
+      @database_manager ||= ::Dbviewer::Database::Manager.new
     end
 
     # Initialize the table query operations manager
@@ -46,23 +46,15 @@ module Dbviewer
 
     # 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
+      adapter_name = database_manager.connection.adapter_name.downcase
+      adapter_mappings = {
+        /mysql/i => "MySQL",
+        /postgres/i => "PostgreSQL",
+        /sqlite/i => "SQLite",
+        /oracle/i => "Oracle",
+        /sqlserver|mssql/i => "SQL Server"
+      }
+      adapter_mappings.find { |pattern, _| adapter_name =~ pattern }&.last || adapter_name.titleize
     rescue => e
       Rails.logger.error("Error retrieving adapter name: #{e.message}")
       "Unknown"
@@ -328,7 +320,7 @@ module Dbviewer
 
     # Export table data to CSV
     def export_table_to_csv(table_name, query_params = nil, include_headers = true)
-      records = database_manager.query_operations.table_records(table_name, query_params)
+      records = database_manager.table_query_operations.table_records(table_name, query_params)
 
       csv_data = CSV.generate do |csv|
         # Add headers if requested

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

@@ -0,0 +1,84 @@
+module Dbviewer
+  module Api
+    class EntityRelationshipDiagramsController < BaseController
+      before_action :set_tables
+
+      def relationships
+        # Fetch all relationships asynchronously
+        begin
+          @table_relationships = fetch_table_relationships
+          render_success({
+            relationships: @table_relationships,
+            status: "success"
+          })
+        rescue => e
+          Rails.logger.error("[DBViewer] Error fetching relationships: #{e.message}")
+          render json: {
+            relationships: [],
+            status: "error",
+            error: e.message
+          }, status: :internal_server_error
+        end
+      end
+
+      def table_relationships
+        # Fetch relationships for specific tables
+        table_names = params[:tables]&.split(",") || []
+
+        if table_names.blank?
+          render json: {
+            relationships: [],
+            status: "error",
+            error: "No tables specified"
+          }, status: :bad_request
+          return
+        end
+
+        begin
+          relationships = []
+
+          table_names.each do |table_name|
+            next unless @tables.any? { |t| t[:name] == table_name }
+
+            begin
+              metadata = fetch_table_metadata(table_name)
+              if metadata && metadata[:foreign_keys].present?
+                metadata[:foreign_keys].each do |fk|
+                  relationships << {
+                    from_table: table_name,
+                    to_table: fk[:to_table],
+                    from_column: fk[:column],
+                    to_column: fk[:primary_key],
+                    name: fk[:name]
+                  }
+                end
+              end
+            rescue => e
+              Rails.logger.error("[DBViewer] Error fetching relationships for #{table_name}: #{e.message}")
+              # Continue with other tables even if one fails
+            end
+          end
+
+          render_success({
+            relationships: relationships,
+            status: "success",
+            processed_tables: table_names
+          })
+        rescue => e
+          Rails.logger.error("[DBViewer] Error in table_relationships: #{e.message}")
+          render json: {
+            relationships: [],
+            status: "error",
+            error: e.message
+          }, status: :internal_server_error
+        end
+      end
+
+      private
+
+      def set_tables
+        @tables = fetch_tables
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module Dbviewer
       def fetch_recent_queries
         return [] unless query_logging_enabled?
 
-        Dbviewer::Logger.instance.recent_queries(limit: queries_limit)
+        Dbviewer::Query::Logger.instance.recent_queries(limit: queries_limit)
       end
 
       def query_logging_enabled?

data/app/controllers/dbviewer/entity_relationship_diagrams_controller.rb

@@ -1,19 +1,18 @@
 module Dbviewer
   class EntityRelationshipDiagramsController < ApplicationController
     def index
-      if @tables.present?
-        @table_relationships = fetch_table_relationships
-      else
-        @table_relationships = []
+      # Only show warning if no tables exist, but don't fetch relationships on initial load
+      if @tables.blank?
         flash.now[:warning] = "No tables found in database to generate ERD."
       end
 
       respond_to do |format|
-        format.html
+        format.html # Just render the HTML without relationships
         format.json do
+          # For JSON requests, return just tables initially
           render json: {
             tables: @tables,
-            relationships: @table_relationships
+            relationships: []
           }
         end
       end

data/app/controllers/dbviewer/logs_controller.rb

@@ -45,7 +45,7 @@ module Dbviewer
     end
 
     def dbviewer_logger
-      @dbviewer_logger ||= Dbviewer::Logger.instance
+      @dbviewer_logger ||= Dbviewer::Query::Logger.instance
     end
   end
 end

data/app/controllers/dbviewer/tables_controller.rb

@@ -11,7 +11,7 @@ module Dbviewer
     end
 
     def show
-      query_params = Dbviewer::TableQueryParams.new(
+      query_params = Dbviewer::Datatable::QueryParams.new(
         page: @current_page,
         per_page: @per_page,
         order_by: @order_by,
@@ -29,12 +29,6 @@ module Dbviewer
         @records = ActiveRecord::Result.new(column_names, [])
       end
 
-      # Fetch timestamp visualization data if the table has a created_at column
-      if has_timestamp_column?(@table_name)
-        @time_grouping = params[:time_group] || "daily"
-        @timestamp_data = fetch_timestamp_data(@table_name, @time_grouping)
-      end
-
       respond_to do |format|
         format.html # Default HTML response
         format.json do
@@ -76,7 +70,7 @@ module Dbviewer
       end
 
       include_headers = params[:include_headers] != "0"
-      query_params = Dbviewer::TableQueryParams.new(
+      query_params = Dbviewer::Datatable::QueryParams.new(
         page: @current_page,
         per_page: (params[:limit] || 10000).to_i,
         order_by: @order_by,

data/app/helpers/dbviewer/application_helper.rb

@@ -11,7 +11,7 @@ module Dbviewer
 
     # Helper to access the database manager
     def get_database_manager
-      @database_manager ||= ::Dbviewer::DatabaseManager.new
+      @database_manager ||= ::Dbviewer::Database::Manager.new
     end
 
     # Extract column type from columns info