dbviewer 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d16f8924e91f06f61088b4948397aa23530cd6e4a89e00ab483cc047ea5fc492
-  data.tar.gz: 98091d292dfe7c42f0644dc1734fb298f532cfc6f99e0176ff1ae517c8db1cc8
+  metadata.gz: fff65e39ec4f823de37b99cf4b60c49d998e56bf2ff10cde22e9d664ea193fdc
+  data.tar.gz: 3ad5a045ab31b37c8f8d7ae410499f9f16a9a10fe8a52a8b3161e331cb3f0f6a
 SHA512:
-  metadata.gz: a423fec219eaf8f40adde10a316cd4e45f33eb27d514ead5a0da735db3a475ac1ac430851cc347095106ca011dda72eae4ab68a01cba8ea8782ab132c99de8b6
-  data.tar.gz: 57594e053bf4bd1389da099fa91236af80e579bfc6f0ebd72da5081187c16a2343717c803632781bf39eb8d5281151cc8614def62c035b1b35dfd2f8946da631
+  metadata.gz: 72f824b283bd82504319fe5002d48d1f8a7cd29f4038773d4e75ff7c8e9ba250e27de2239eee36adac6ff10740e5779a5272f0c202f2bb1ccb32c586f94ea093
+  data.tar.gz: 655d0bd7d9ea5fc5c70e338b8bdea8dd000b8fd25984c267243598a02afcaff50ba185d80d123b9e2203148b82945f13ebc47d470ef900252887cdfe4134d3c6

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,70 @@ 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
+
 ## 🤌🏻 Contributing
 
 Bug reports and pull requests are welcome.

data/lib/dbviewer/engine.rb

@@ -2,9 +2,10 @@ module Dbviewer
   class Engine < ::Rails::Engine
     isolate_namespace Dbviewer
 
-    # Ensure lib directory is in the autoload path
-    config.autoload_paths << File.expand_path("../../", __FILE__)
-    config.eager_load_paths << File.expand_path("../../", __FILE__)
+    # Autoload lib directory
+    lib_path = File.expand_path("..", __dir__)
+    config.autoload_paths << lib_path
+    config.eager_load_paths << lib_path
 
     # Register generators
     config.app_generators do |g|
@@ -18,12 +19,14 @@ module Dbviewer
     end
 
     initializer "dbviewer.notifications" do
+      return unless Rails.env.development?
+
       ActiveSupport::Notifications.subscribe("sql.active_record") do |*args|
         event = ActiveSupport::Notifications::Event.new(*args)
 
         next if skip_internal_query?(event)
 
-        Logger.instance.add(event)
+        Dbviewer::Logger.instance.add(event)
       end
     end
 
@@ -33,10 +36,10 @@ module Dbviewer
       caller_locations = caller_locations(1)
       return false unless caller_locations
 
-      # Look for dbviewer in the call stack
-      caller_locations.any? { |l| l.path.include?("dbviewer") }
-    rescue
-      false
+      excluded_caller_locations = caller_locations.filter do |caller_location|
+        !caller_location.path.include?("lib/dbviewer/engine.rb")
+      end
+      excluded_caller_locations.any? { |l| l.path.include?("dbviewer") }
     end
   end
 end

data/lib/dbviewer/logger.rb

@@ -12,6 +12,7 @@ module Dbviewer
     def add(event)
       # Return early if query logging is disabled
       return unless Dbviewer.configuration.enable_query_logging
+      return if QueryParser.should_skip_query?(event)
 
       current_time = Time.now
       @storage.add({
@@ -20,7 +21,7 @@ module Dbviewer
         timestamp: current_time,
         duration_ms: event.duration.round(2),
         binds: QueryParser.format_binds(event.payload[:binds]),
-        request_id: event.transaction_id || current_time.to_i,
+        request_id: ActiveSupport::Notifications.instrumenter.id,
         thread_id: Thread.current.object_id.to_s,
         caller: event.payload[:caller]
       })

data/lib/dbviewer/query_parser.rb

@@ -22,36 +22,6 @@ module Dbviewer
          .gsub(/"[^"]*"/, '"X"')
     end
 
-    # Check if the query is from the DBViewer library
-    def self.from_dbviewer?(event)
-      # Check if the SQL itself references DBViewer tables
-      if event.payload[:sql].match(/\b(from|join|update|into)\s+["`']?dbviewer_/i)
-        return true
-      end
-
-      # Check the caller information if available
-      caller = event.payload[:caller]
-      if caller.is_a?(String) && caller.include?("/dbviewer/")
-        return true
-      end
-
-      # Check if query name indicates it's from DBViewer
-      if event.payload[:name].is_a?(String) &&
-         (event.payload[:name].include?("Dbviewer") || event.payload[:name].include?("DBViewer") || event.payload[:name] == "SQL")
-        return true
-      end
-
-      # Check for common DBViewer operations
-      sql = event.payload[:sql].downcase
-      if sql.include?("table_structure") ||
-         sql.include?("schema_migrations") ||
-         sql.include?("database_analytics")
-        return true
-      end
-
-      false
-    end
-
     # Format bind parameters for storage
     def self.format_binds(binds)
       return [] unless binds.respond_to?(:map)
@@ -68,5 +38,16 @@ module Dbviewer
     rescue
       []
     end
+
+    # Determine if a query should be skipped based on content
+    # Rails and ActiveRecord often run internal queries that are not useful for logging
+    def self.should_skip_query?(event)
+      event.payload[:name] == "SCHEMA" ||
+      event.payload[:sql].include?("SHOW TABLES") ||
+      event.payload[:sql].include?("sqlite_master") ||
+      event.payload[:sql].include?("information_schema") ||
+      event.payload[:sql].include?("schema_migrations") ||
+      event.payload[:sql].include?("pg_catalog")
+    end
   end
 end

data/lib/dbviewer/version.rb

@@ -1,3 +1,3 @@
 module Dbviewer
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbviewer
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Wailan Tirajoh