query_guard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab42a4becef74dd106779b1e16f65f3e0178762531ede328212958cb36dbb2f5
+  data.tar.gz: e49b0e60d3ede416580c4e92e2f46142f3bbcc0c13da5ac9fde9024a001cccca
+SHA512:
+  metadata.gz: 756393f33c6e2c44650b377db916c3c516f5d49191ba9557461b8dfa9bcc8a977048fcf919b71c2ef101b0cb2bfe9f92fefe639ab88d28d01a09f9d565855046
+  data.tar.gz: 77f0b2337a0330922438eeb20ed1b946b0b0e1264622e577a4ad005cf7e9288efda5fafb34351d0691fa489cf2dc4f123c6ec8b1c9b4f413d1c5acf8fc770122

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-02
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Chitradevi36
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,10 @@
+# query_guard
+
+Guardrails for ActiveRecord queries per request: maximum query count, slow query flagging, and optional `SELECT *` blocking.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "query_guard"

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "Build gem"
+task :build do
+  sh "gem build query_guard.gemspec"
+end
+
+desc "Release: build and push to RubyGems"
+task :release do
+  version = File.read("lib/query_guard/version.rb")[/VERSION\s*=\s*["'](.+?)["']/, 1]
+  abort("Version not found") unless version
+  sh "gem build query_guard.gemspec"
+  sh "gem push query_guard-#{version}.gem"
+end

data/config/initializers/query_guard.rb

@@ -0,0 +1,9 @@
+QueryGuard.configure do |c|
+  c.enabled_environments      = %i[development test]  # Prod is usually off
+  c.max_queries_per_request   = 100                   # nil to disable
+  c.max_duration_ms_per_query = 100.0                 # nil to disable
+  c.block_select_star         = false
+  c.ignored_sql               = [/^PRAGMA /i, /^SAVEPOINT/i]
+  c.raise_on_violation        = false                 # true to raise 500
+  c.log_prefix                = "[QueryGuard]"
+end

data/lib/query_guard/config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module QueryGuard
+  class Config
+    attr_accessor :enabled_environments, :max_queries_per_request,
+                  :max_duration_ms_per_query, :block_select_star,
+                  :ignored_sql, :raise_on_violation, :log_prefix
+
+    def initialize
+      @enabled_environments     = %i[development test]
+      @max_queries_per_request  = 100
+      @max_duration_ms_per_query = 100.0   # ms; set to nil to disable
+      @block_select_star        = false
+      @ignored_sql              = [/^PRAGMA /i, /^BEGIN/i, /^COMMIT/i]
+      @raise_on_violation       = false
+      @log_prefix               = "[QueryGuard]"
+    end
+
+    def enabled?(env)
+      @enabled_environments.map(&:to_sym).include?(env.to_sym)
+    end
+  end
+end

data/lib/query_guard/middleware.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+module QueryGuard
+  class Error < StandardError; end
+
+  class Middleware
+    def initialize(app, config)
+      @app = app
+      @config = config
+    end
+
+    def call(env)
+      unless @config.enabled?(rails_env)
+        return @app.call(env)
+      end
+
+      Thread.current[:query_guard_stats] = { count: 0, total_duration_ms: 0.0, violations: [] }
+
+      status, headers, body = @app.call(env)
+      check_and_report!
+      [status, headers, body]
+    ensure
+      Thread.current[:query_guard_stats] = nil
+    end
+
+    private
+
+    def rails_env
+      if defined?(Rails) && Rails.respond_to?(:env)
+        Rails.env.to_sym
+      else
+        (ENV["RACK_ENV"] || ENV["APP_ENV"] || "development").to_sym
+      end
+    end
+
+    def logger
+      if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+        Rails.logger
+      else
+        @logger ||= Logger.new($stdout)
+      end
+    end
+
+    def check_and_report!
+      stats = Thread.current[:query_guard_stats] || { count: 0, violations: [] }
+      violations = stats[:violations].dup
+
+      if @config.max_queries_per_request && stats[:count] > @config.max_queries_per_request
+        violations << { type: :too_many_queries, count: stats[:count], limit: @config.max_queries_per_request }
+      end
+
+      return if violations.empty?
+
+      message = format_message(stats, violations)
+      logger.warn(message)
+
+      raise QueryGuard::Error, message if @config.raise_on_violation
+    end
+
+    def format_message(stats, violations)
+      details = violations.map do |v|
+        case v[:type]
+        when :too_many_queries
+          "too_many_queries: count=#{v[:count]} limit=#{v[:limit]}"
+        when :slow_query
+          "slow_query: #{v[:duration_ms]}ms SQL=#{truncate_sql(v[:sql])}"
+        when :select_star
+          "select_star: SQL=#{truncate_sql(v[:sql])}"
+        else
+          v[:type].to_s
+        end
+      end.join(" | ")
+
+      "#{@config.log_prefix} queries=#{stats[:count]} total_ms=#{stats[:total_duration_ms].round(2)} | #{details}"
+    end
+
+    def truncate_sql(sql, max = 200)
+      sql.length > max ? "#{sql[0, max]}..." : sql
+    end
+  end
+end

data/lib/query_guard/subscriber.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require "active_support/notifications"
+
+module QueryGuard
+  module Subscriber
+    SQL_EVENT = "sql.active_record"
+
+    def self.install!(config)
+      return if @installed
+      @config = config
+      @subscriber = ActiveSupport::Notifications.subscribe(SQL_EVENT) do |_, started, finished, _, payload|
+        stats = Thread.current[:query_guard_stats]
+        next unless stats # only track inside our middleware window
+
+        # Skip schema and ignored
+        name = payload[:name].to_s
+        next if name == "SCHEMA"
+
+        sql = payload[:sql].to_s
+        next if config.ignored_sql.any? { |r| r === sql }
+
+        duration_ms = (finished - started) * 1000.0
+        stats[:count] += 1
+        stats[:total_duration_ms] += duration_ms
+
+        if config.max_duration_ms_per_query && duration_ms > config.max_duration_ms_per_query
+          stats[:violations] << {
+            type: :slow_query,
+            duration_ms: duration_ms.round(2),
+            sql: sql
+          }
+        end
+
+        if config.block_select_star && sql =~ /\bSELECT\s+\*/i
+          stats[:violations] << { type: :select_star, sql: sql }
+        end
+      end
+      @installed = true
+    end
+
+    def self.uninstall!
+      return unless @installed && @subscriber
+      ActiveSupport::Notifications.unsubscribe(@subscriber)
+      @installed = false
+      @subscriber = nil
+    end
+  end
+end

data/lib/query_guard/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module QueryGuard
+  VERSION = "0.1.0"
+end

data/lib/query_guard.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require "active_support"
+require "active_support/notifications"
+require "query_guard/version"
+require "query_guard/config"
+require "query_guard/subscriber"
+require "query_guard/middleware"
+
+module QueryGuard
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+      self
+    end
+
+    def install!(app = nil)
+      # Install SQL subscriber once
+      Subscriber.install!(config)
+
+      # Install middleware (Rails or Rack)
+      if defined?(Rails) && Rails.respond_to?(:application) && Rails.application
+        # Use a Railtie-less insert for safety if called early
+        Rails.application.config.middleware.use(QueryGuard::Middleware, config)
+      elsif app
+        app.use(QueryGuard::Middleware, config)
+      end
+      self
+    end
+  end
+end
+
+# Auto-install for Rails via Railtie
+if defined?(Rails::Railtie)
+  class QueryGuard::Railtie < Rails::Railtie
+    initializer "query_guard.install" do |app|
+      QueryGuard.install!(app)
+    end
+  end
+end

data/sig/query_guard.rbs

@@ -0,0 +1,4 @@
+module QueryGuard
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: query_guard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chitradevi36
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: query_guard tracks SQL in Rails requests and warns/raises on excessive
+  count, slow queries, or SELECT * usage.
+email:
+- chitra.rajaguru123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/initializers/query_guard.rb
+- lib/query_guard.rb
+- lib/query_guard/config.rb
+- lib/query_guard/middleware.rb
+- lib/query_guard/subscriber.rb
+- lib/query_guard/version.rb
+- sig/query_guard.rbs
+homepage: https://github.com/Chitradevi36/query_guard
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Chitradevi36/query_guard
+  source_code_uri: https://github.com/Chitradevi36/query_guard
+  changelog_uri: https://github.com/Chitradevi36/query_guard/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Guardrails for ActiveRecord queries per request (count, slow SQL, SELECT
+  *).
+test_files: []