query_guard 0.4.2 → 0.5.0

data/lib/query_guard/uploader/no_op_uploader.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module QueryGuard
+  module Uploader
+    # No-op uploader that discards reports (default behavior).
+    #
+    # This is the default uploader when no remote API is configured.
+    # It silently discards reports, making the upload system completely optional.
+    #
+    # Use case:
+    # - Local development without remote API
+    # - CI/CD without SaaS platform integration
+    # - Organizations that don't want to send data to external services
+    class NoOpUploader < Interface
+      def initialize(config = nil)
+        @config = config
+      end
+
+      # Always succeeds, does nothing.
+      def upload(json_report, metadata = {})
+        UploadResult.new(
+          success: true,
+          uploader_name: name,
+          details: { discarded: true, bytes: json_report.bytesize }
+        )
+      end
+
+      # Always ready (no configuration needed).
+      def ready?
+        true
+      end
+
+      def name
+        'no-op'
+      end
+
+      def status
+        {
+          enabled: false,
+          mode: 'no-op',
+          description: 'Reports are discarded (upload disabled)'
+        }
+      end
+    end
+  end
+end

data/lib/query_guard/uploader/registry.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module QueryGuard
+  module Uploader
+    # Registry for selecting and instantiating uploaders.
+    #
+    # Provides a factory pattern for creating the appropriate uploader
+    # based on configuration.
+    class Registry
+      # Get the appropriate uploader for the given configuration.
+      #
+      # @param config [QueryGuard::Config] Configuration object
+      # @return [Interface] An uploader instance
+      def self.for_config(config)
+        uploader_type = config.uploader_type&.downcase || 'no-op'
+
+        case uploader_type
+        when 'http'
+          HttpUploader.new(config)
+        when 'no-op', 'noop', 'none', 'disabled', nil
+          NoOpUploader.new(config)
+        else
+          raise ArgumentError, "Unknown uploader type: #{uploader_type}. " \
+                               "Supported: 'http', 'no-op' (default)"
+        end
+      end
+
+      # List all available uploader types.
+      def self.available_uploaders
+        {
+          'no-op' => 'Local/no-op mode (default, no upload)',
+          'http' => 'HTTP API upload (for future SaaS platform)'
+        }
+      end
+    end
+  end
+end

data/lib/query_guard/uploader/upload_service.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module QueryGuard
+  module Uploader
+    # Service for uploading analysis reports.
+    #
+    # This is the main public API for uploading reports. It:
+    # - Coordinates with configured uploader
+    # - Handles errors gracefully
+    # - Provides logging/status information
+    # - Never blocks or raises exceptions
+    #
+    # Usage:
+    #   service = QueryGuard::Uploader::UploadService.new(config)
+    #   result = service.upload_report(json_string, trace_id: '...')
+    #   puts result.to_h if result.failed?
+    class UploadService
+      def initialize(config = nil)
+        @config = config || QueryGuard.config
+        @uploader = Registry.for_config(@config)
+      end
+
+      # Upload a JSON report from the configured JSON reporter.
+      #
+      # @param json_report [String] JSON string from JsonReporter#generate
+      # @param trace_id [String] Optional trace ID for distributed tracing
+      # @param request_id [String] Optional request ID
+      # @return [UploadResult] Result object (never raises)
+      def upload_report(json_report, trace_id: nil, request_id: nil)
+        metadata = {}
+        metadata[:trace_id] = trace_id if trace_id
+        metadata[:request_id] = request_id if request_id
+
+        @uploader.upload(json_report, metadata)
+      rescue StandardError => e
+        # Always return graceful result, never raise
+        UploadResult.new(
+          success: false,
+          uploader_name: @uploader.name,
+          error: "Unexpected error: #{e.message}"
+        )
+      end
+
+      # Get status information about the current uploader.
+      #
+      # @return [Hash] Status information
+      def status
+        {
+          uploader: @uploader.name,
+          ready: @uploader.ready?,
+          details: @uploader.status
+        }
+      end
+
+      # Check if uploader is ready and configured.
+      #
+      # @return [Boolean]
+      def ready?
+        @uploader.ready?
+      end
+
+      # Get the current uploader instance.
+      #
+      # @return [Interface] The active uploader
+      def uploader
+        @uploader
+      end
+
+      # Reconfigure with a new config object.
+      #
+      # @param config [QueryGuard::Config]
+      # @return [self]
+      def reconfigure(config)
+        @config = config
+        @uploader = Registry.for_config(@config)
+        self
+      end
+    end
+  end
+end

data/lib/query_guard/version.rb

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

data/lib/query_guard.rb

@@ -2,22 +2,63 @@
 require "active_support"
 require "active_support/notifications"
 require "query_guard/version"
+require "query_guard/core/query"
+require "query_guard/core/finding"
+require "query_guard/core/finding_builders"
+require "query_guard/core/context"
+require "query_guard/analysis/risk_level"
+require "query_guard/analysis/risk_detectors"
+require "query_guard/analysis/query_risk_classifier"
+require "query_guard/explain/adapter_interface"
+require "query_guard/explain/postgresql_adapter"
+require "query_guard/explain/plan_signals"
+require "query_guard/suggest/pattern_extractors"
+require "query_guard/suggest/index_suggester"
+require "query_guard/explain/explain_enricher"
+require "query_guard/analyzers/base"
+require "query_guard/analyzers/registry"
+require "query_guard/analyzers/slow_query_analyzer"
+require "query_guard/analyzers/query_count_analyzer"
+require "query_guard/analyzers/select_star_analyzer"
+require "query_guard/analyzers/query_risk_analyzer"
+require "query_guard/migrations/migration_risk_detectors"
+require "query_guard/migrations/migration_analyzer"
+require "query_guard/migrations/database_adapter"
+require "query_guard/migrations/postgresql_adapter"
+require "query_guard/migrations/table_size_resolver"
+require "query_guard/migrations/table_risk_analyzer"
+require "query_guard/budget"
+require "query_guard/fingerprint"
+require "query_guard/trace"
 require "query_guard/config"
+require "query_guard/store"
+require "query_guard/security"
 require "query_guard/subscriber"
+require "query_guard/action_controller_subscriber"
 require "query_guard/middleware"
 require "query_guard/client"
+require "query_guard/uploader/interface"
+require "query_guard/uploader/no_op_uploader"
+require "query_guard/uploader/http_uploader"
+require "query_guard/uploader/registry"
+require "query_guard/uploader/upload_service"
+require "query_guard/cli/source_metadata_collector"
+require "query_guard/cli/json_reporter"
+require "query_guard/cli/batch_report_formatter"
+require "query_guard/cli/paged_report_formatter"
+require "query_guard/cli/formatter"
+require "query_guard/cli/command"
 
 module QueryGuard
   class << self
     attr_accessor :client
-    # Keep config as a normal module ivar; no mattr_*
+
     def config
       @config ||= Config.new
     end
 
     def configure
       yield(config)
-      # Build a reusable HTTP client (whatever your Client class is)
       @client = Client.new(
         base_url: config.base_url,
         api_key:  config.api_key,
@@ -28,13 +69,10 @@ module QueryGuard
     end
 
     def install!(app = nil)
-      # Ensure config exists even if user didn't call configure
       config
-
-      # Install SQL subscriber once
       Subscriber.install!(config)
+      ActionControllerSubscriber.install!(config)
 
-      # Insert middleware
       if defined?(Rails) && Rails.respond_to?(:application) && Rails.application
         Rails.application.config.middleware.use(QueryGuard::Middleware, config)
       elsif app
@@ -43,10 +81,19 @@ module QueryGuard
 
       self
     end
+
+    def exporter
+      @exporter ||= QueryGuard::Exporter.new(config)
+    end
+
+    # Trace a block of code and capture query stats.
+    # Returns [result, report] tuple.
+    def trace(label, context: {}, &block)
+      Trace.trace(label, context: context, &block)
+    end
   end
 end
 
-# Auto-install for Rails via Railtie
 if defined?(Rails::Railtie)
   module QueryGuard
     class Railtie < Rails::Railtie

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_guard
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Chitradevi36
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-11-03 00:00:00.000000000 Z
+date: 2026-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,25 +44,94 @@ dependencies:
     - - "<"
       - !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.
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: Automatically detect risky migration patterns (unsafe column removal,
+  locking operations, data loss) before they reach production.
 email:
 - chitra.rajaguru123@gmail.com
-executables: []
+executables:
+- queryguard
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
 - CHANGELOG.md
+- DESIGN.md
+- INDEX.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- config/initializers/query_guard.rb
+- exe/queryguard
 - lib/query_guard.rb
+- lib/query_guard/action_controller_subscriber.rb
+- lib/query_guard/analysis/query_risk_classifier.rb
+- lib/query_guard/analysis/risk_detectors.rb
+- lib/query_guard/analysis/risk_level.rb
+- lib/query_guard/analyzers/base.rb
+- lib/query_guard/analyzers/query_count_analyzer.rb
+- lib/query_guard/analyzers/query_risk_analyzer.rb
+- lib/query_guard/analyzers/registry.rb
+- lib/query_guard/analyzers/select_star_analyzer.rb
+- lib/query_guard/analyzers/slow_query_analyzer.rb
+- lib/query_guard/budget.rb
+- lib/query_guard/cli.rb
+- lib/query_guard/cli/batch_report_formatter.rb
+- lib/query_guard/cli/command.rb
+- lib/query_guard/cli/commands/analyze.rb
+- lib/query_guard/cli/commands/check.rb
+- lib/query_guard/cli/formatter.rb
+- lib/query_guard/cli/json_reporter.rb
+- lib/query_guard/cli/paged_report_formatter.rb
+- lib/query_guard/cli/source_metadata_collector.rb
 - lib/query_guard/client.rb
 - lib/query_guard/config.rb
+- lib/query_guard/core/context.rb
+- lib/query_guard/core/finding.rb
+- lib/query_guard/core/finding_builders.rb
+- lib/query_guard/core/query.rb
+- lib/query_guard/explain/adapter_interface.rb
+- lib/query_guard/explain/explain_enricher.rb
+- lib/query_guard/explain/plan_signals.rb
+- lib/query_guard/explain/postgresql_adapter.rb
+- lib/query_guard/exporter.rb
+- lib/query_guard/fingerprint.rb
 - lib/query_guard/middleware.rb
+- lib/query_guard/migrations/database_adapter.rb
+- lib/query_guard/migrations/migration_analyzer.rb
+- lib/query_guard/migrations/migration_risk_detectors.rb
+- lib/query_guard/migrations/postgresql_adapter.rb
+- lib/query_guard/migrations/table_risk_analyzer.rb
+- lib/query_guard/migrations/table_size_resolver.rb
+- lib/query_guard/publish.rb
+- lib/query_guard/rspec.rb
+- lib/query_guard/security.rb
+- lib/query_guard/store.rb
 - lib/query_guard/subscriber.rb
+- lib/query_guard/suggest/index_suggester.rb
+- lib/query_guard/suggest/pattern_extractors.rb
+- lib/query_guard/trace.rb
+- lib/query_guard/uploader/http_uploader.rb
+- lib/query_guard/uploader/interface.rb
+- lib/query_guard/uploader/no_op_uploader.rb
+- lib/query_guard/uploader/registry.rb
+- lib/query_guard/uploader/upload_service.rb
 - lib/query_guard/version.rb
 - sig/query_guard.rbs
 homepage: https://github.com/Chitradevi36/query_guard
@@ -91,6 +160,5 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: Guardrails for ActiveRecord queries per request (count, slow SQL, SELECT
-  *).
+summary: Database migration safety analyzer for Rails
 test_files: []

data/.rspec

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

data/Rakefile

@@ -1,21 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-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