query_owl 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2654c621778910c1a0b1926398480e21b967f86c63ff45b642e635d80bfebcd0
-  data.tar.gz: 54245db5c8aa3a64869f3ce18b9c95b662d01ba58a042150ea551f19e1bf7299
+  metadata.gz: 9d6d1c90011594e84ad366b86242261eb507c646bbbd99567ee68e764f79fed3
+  data.tar.gz: 6b3d04a4eeba7e6cd61f77ac1c86d9267490cb68bc4bee375bf3fca39db21c48
 SHA512:
-  metadata.gz: 5d1a2a46359810b4f5e482097264c6d1d402c4344f5cf29b672d89a9c834c04e81936f07f3111454abf549e12c5a30614e6829c5d62563860de6b625220ce234
-  data.tar.gz: 41561e881c73aac6ed2ce8b7d3fc4f1a9f83d35fe92f4473713d274978451d9d7cd4ae7fada1af25739d3222457216ae13fdfb015b41bc8cf87116ee8aaa9b1a
+  metadata.gz: 48dd728246c8226b5fc04bf819e85712e8eaf5453d1fe77ca1ce3ba012f7399a52af50cffacb652c5958f2ab086c35270930fed9c093971b3e446bc3846f1756
+  data.tar.gz: 1f26cb6d3c28dccf5708446b4c9e17ce2f334af66ae8b0ed6c6d92eb36440818b4c1feff3cf4ef124f455e54e050641eadc8952aa0a8d59c5b2a4ed50672a8cf

data/lib/generators/query_owl/install/templates/initializer.rb

@@ -41,6 +41,19 @@ QueryOwl.configure do |config|
   # Controllers to skip — matched against the Rails controller name (e.g. "rails/health").
   # config.ignore_controllers = ["rails/health", "admin/metrics"]
 
+  # Test helper — opt-in RSpec matchers and Minitest assertions.
+  # Add to spec/rails_helper.rb (or test/test_helper.rb for Minitest):
+  #
+  #   require "query_owl/test_helper"
+  #   RSpec.configure { |c| c.include QueryOwl::TestHelper }
+  #   # or: class ActiveSupport::TestCase; include QueryOwl::TestHelper; end
+  #
+  # Then use: expect { }.not_to trigger_n_plus_one
+  #           expect { }.not_to trigger_slow_query
+  #           expect { }.not_to trigger_unused_eager_load
+  #           assert_no_n_plus_one { }
+  #           assert_no_slow_query { }
+
   # Notifiers receive each detected event via #call(event).
   # Defaults to [QueryOwl::Notifiers::Logger] which writes to Rails.logger.
   # Use Console for TTY-aware colorized output (yellow: N+1, red: slow query).

data/lib/query_owl/test_helper.rb

@@ -0,0 +1,85 @@
+require "query_owl"
+
+module QueryOwl
+  module TestHelper
+    # Runs block with QueryOwl's trackers active and returns detected events.
+    # Isolated from config.enabled and config.raise_on_n_plus_one.
+    def self.capture_events
+      QueryTracker.start!
+      EagerLoadTracker.start!
+      yield
+      queries    = QueryTracker.stop!
+      eager_data = EagerLoadTracker.stop!
+      Detector.detect_n_plus_one(queries) +
+        Detector.detect_slow_queries(queries) +
+        Detector.detect_unused_eager_loads(eager_data)
+    rescue
+      QueryTracker.stop!
+      EagerLoadTracker.stop!
+      raise
+    end
+
+    # RSpec block matchers — use with expect { }.to / not_to
+
+    def trigger_n_plus_one
+      EventTypeMatcher.new(:n_plus_one)
+    end
+
+    def trigger_slow_query
+      EventTypeMatcher.new(:slow_query)
+    end
+
+    def trigger_unused_eager_load
+      EventTypeMatcher.new(:unused_eager_load)
+    end
+
+    # Minitest assertions — call assert_no_n_plus_one { } inside a test method
+
+    def assert_no_n_plus_one(msg = nil, &block)
+      events = QueryOwl::TestHelper.capture_events(&block)
+      count  = events.count { |e| e[:type] == :n_plus_one }
+      assert count.zero?, msg || "Expected no N+1 queries, but #{count} detected"
+    end
+
+    def assert_no_slow_query(msg = nil, &block)
+      events = QueryOwl::TestHelper.capture_events(&block)
+      count  = events.count { |e| e[:type] == :slow_query }
+      assert count.zero?, msg || "Expected no slow queries, but #{count} detected"
+    end
+
+    class EventTypeMatcher
+      def initialize(type)
+        @type   = type
+        @events = []
+      end
+
+      def matches?(block)
+        @events = QueryOwl::TestHelper.capture_events(&block)
+        @events.any? { |e| e[:type] == @type }
+      end
+
+      def does_not_match?(block)
+        !matches?(block)
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      def failure_message
+        "expected block to trigger #{label} but none were detected"
+      end
+
+      def failure_message_when_negated
+        n = @events.count { |e| e[:type] == @type }
+        "expected block not to trigger #{label} but #{n} detected"
+      end
+
+      private
+
+        def label
+          @type.to_s.tr("_", " ")
+        end
+    end
+  end
+end

data/lib/query_owl/version.rb

@@ -1,3 +1,3 @@
 module QueryOwl
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: query_owl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -63,6 +63,7 @@ files:
 - lib/query_owl/notifiers/stdout.rb
 - lib/query_owl/query_tracker.rb
 - lib/query_owl/request_context.rb
+- lib/query_owl/test_helper.rb
 - lib/query_owl/version.rb
 - lib/tasks/query_owl_tasks.rake
 homepage: https://github.com/eclectic-coding/query_owl