sql_query_analyzer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab9aa8ae033ce267111f508bfa46c9d18fb4b50da0f8dc175719ab40a4a416eb
+  data.tar.gz: f6a8db3ac983476c5c26893a76f4ac127bf83a1fae1172df3f76618e2865752b
+SHA512:
+  metadata.gz: 7013b5496ff18a4753095df4850d3f6130567376a7157fc261848b56a970679c1da2aa55bfaf47f7423af5a4c4ad101e659137ee198342e7a291e2ea28fa25bf
+  data.tar.gz: 4f82e5a2bac1d408dfc9eb40f5b424125cedad911102790d81509a25e102e02fa12ed4da47efa97c360d920030ecdbf9dd320100e4cd9b9d9484ef7d3e7c39b1

data/lib/sql_query_analyzer/explain_analyzer.rb

@@ -0,0 +1,25 @@
+# lib/sql_query_analyzer/explain_analyzer.rb
+module SqlQueryAnalyzer
+  module ExplainAnalyzer
+    def explain_with_suggestions
+      explain_output = explain(analyze: true, verbose: true, costs: true, buffers: true, timing: true)
+
+      engine = SqlQueryAnalyzer::SuggestionEngine.new(explain_output, to_sql)
+      suggestions = engine.analyze
+
+      puts "\n=== EXPLAIN ANALYZE OUTPUT ===\n"
+      puts explain_output
+      puts "\n=== SUGGESTIONS ===\n"
+      suggestions.each do |suggestion|
+        puts "[#{suggestion.severity.to_s.upcase}] #{suggestion.message}"
+      end
+    rescue => e
+      puts "Error analyzing query: #{e.message}"
+    end
+  end
+end
+
+# Monkey patch it in Rails
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Relation.include(SqlQueryAnalyzer::ExplainAnalyzer)
+end

data/lib/sql_query_analyzer/suggestion_engine.rb

@@ -0,0 +1,52 @@
+# lib/sql_query_analyzer/suggestion_engine.rb
+module SqlQueryAnalyzer
+  class Suggestion
+    attr_reader :severity, :message
+
+    def initialize(severity, message)
+      @severity = severity
+      @message = message
+    end
+  end
+
+  class SuggestionEngine
+    def initialize(explain_output, sql = nil)
+      @explain_output = explain_output
+      @sql = sql
+    end
+
+    def analyze
+      suggestions = []
+
+      # Rule 1: Sequential Scan
+      if @explain_output.match?(/Seq Scan/i)
+        suggestions << Suggestion.new(:critical, "⚡ Sequential Scan detected. Consider adding indexes to avoid full table scans.")
+      end
+
+      # Rule 2: SELECT *
+      if @sql&.match?(/select\s+\*/i)
+        suggestions << Suggestion.new(:warning, "🚨 Query uses SELECT *. Selecting only needed columns is more efficient.")
+      end
+
+      # Rule 3: Sort operation
+      if @explain_output.match?(/Sort/i)
+        suggestions << Suggestion.new(:info, "📈 Sort detected. Consider adding an index to support ORDER BY.")
+      end
+
+      # Rule 4: Missing JOIN conditions
+      if @sql&.match?(/join/i) && !@sql.match?(/on/i)
+        suggestions << Suggestion.new(:critical, "⚡ JOIN without ON detected. May cause massive row combinations (CROSS JOIN).")
+      end
+
+      # Rule 5: High Rows estimation
+      if @explain_output.match?(/rows=(\d+)/)
+        rows = @explain_output.match(/rows=(\d+)/)[1].to_i
+        if rows > 100_000
+          suggestions << Suggestion.new(:critical, "🔥 High number of rows (#{rows}). Consider using WHERE conditions or LIMIT.")
+        end
+      end
+
+      suggestions
+    end
+  end
+end

data/lib/sql_query_analyzer/version.rb

@@ -0,0 +1,5 @@
+# lib/sql_query_analyzer/version.rb
+module SqlQueryAnalyzer
+  
+  VERSION = "0.1.0"
+end

data/lib/sql_query_analyzer.rb

@@ -0,0 +1,11 @@
+# lib/sql_query_analyzer.rb
+require "active_support"
+require "active_record"
+
+require "sql_query_analyzer/version"
+require "sql_query_analyzer/suggestion_engine"
+require "sql_query_analyzer/explain_analyzer"
+
+module SqlQueryAnalyzer
+  # Future configurations can go here
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: sql_query_analyzer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anoob Bava
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: A Ruby on Rails gem that analyzes SQL queries and suggests optimizations
+  like missing indexes, inefficient sorts, and risky joins.
+email:
+- anoob.bava@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sql_query_analyzer.rb
+- lib/sql_query_analyzer/explain_analyzer.rb
+- lib/sql_query_analyzer/suggestion_engine.rb
+- lib/sql_query_analyzer/version.rb
+homepage: https://github.com/anoobbava/sql_query_analyzer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: Explain ActiveRecord queries and get optimization suggestions.
+test_files: []