ar-query-matchers 0.5.2.pre.6 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a03e79681fb7644c916a5f3c019a5e9484f8b7176e21b6c91beae9bd2d9eb520
-  data.tar.gz: 1a1d6f97aab26efa604ae32dd2d4b56164e4616ff87b2ffbfb84812e87e57a75
+  metadata.gz: e73f1af783ac0aea8a1342b20e01d139106e29c2c4048bf3d30086a13675f204
+  data.tar.gz: 64b309608ae8f52ba8d7a998ea0e7658eebb2ee7d11122d8e1c0934f042131b6
 SHA512:
-  metadata.gz: 960fb79a70f3875f606d67364227ad6b0af6440b18fed4e885a8a44614d61f484ad7cdc33e6040b114b568d320edcc045a212a9db0c570577a039bb7a04b09c6
-  data.tar.gz: 379ef8320c724772bcf9fc38dda46a86fa8a24a8690a9547a13973065dcebef9fae17f77a636e059463f91afbba2aa341164ddadbe900e58fb625d3f1b64a5c4
+  metadata.gz: 13b5fe44e89c7e0df944882d4d15dac2ff72b8fe3a679591c46b15015587159246c4e2344d2e604b6a31a0ee6dc5a450eacd85ef638d90d578f1b4073fca2f58
+  data.tar.gz: 61d48528375466023a71bf17ad2e453ec62ce5520f43200f88de94ff2f116522be3694fe2c0116f83093fa5f1087cf4774471143e63deb8f465dd03173bda8cd

data/CHANGELOG.md

@@ -6,9 +6,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.5.2] - 2021-05-18
+## [0.7.0] - 2022-01-27
+### Added
+- A new matcher, `only_load_at_most_models`, will do a less-than-or-equal-to (<=) check on model counts. This is a method that makes tests less noisy as performance gets better.
+
+## [0.6.0] - 2022-01-05
+### Changed
+- Support Rails 7
+
+## [0.5.3] - 2021-05-26
+### Changed
+- Re-release of previous version due to accidental premature release
+
+## [0.5.2] - 2021-05-26
 ### Changed
-- Removes 'SELECT' from MODEL_SQL_PATTERN to allow for more granular SQL statement matching
+- Update MODEL_SQL_PATTERN to allow for more accurate matches against SQL strings
 
 ## [0.5.1] - 2020-11-19
 ### Changed

data/lib/ar_query_matchers/queries/create_counter.rb

@@ -23,7 +23,7 @@ module ArQueryMatchers
           # for inserts, name is always 'SQL', we have to rely on pattern matching the query string.
           select_from_table = sql.match(TABLE_NAME_SQL_PATTERN)
 
-          [TableName.new(select_from_table[:table_name])] if select_from_table
+          TableName.new(select_from_table[:table_name]) if select_from_table
         end
       end
     end

data/lib/ar_query_matchers/queries/load_counter.rb

@@ -15,15 +15,24 @@ module ArQueryMatchers
       end
 
       class LoadQueryFilter < Queries::QueryFilter
+        # Matches named SQL operations like the following:
+        # 'User Load'
+        MODEL_LOAD_PATTERN = /\A(?<model_name>[\w:]+) (Load|Exists)\Z/.freeze
+
         # Matches unnamed SQL operations like the following:
-        # "SELECT * FROM `users` ..."
+        # "SELECT COUNT(*) FROM `users` ..."
         MODEL_SQL_PATTERN = /SELECT (?:(?!SELECT).)* FROM [`"](?<table_name>[^`"]+)[`"]/.freeze
 
-        def filter_map(_name, sql)
-          # Pattern-matching on the table name in a SELECT ... FROM and looking
+        def filter_map(name, sql)
+          # First check for a `SELECT * FROM` query that ActiveRecord has
+          # helpfully named for us in the payload
+          match = name.match(MODEL_LOAD_PATTERN)
+          return ModelName.new(match[:model_name]) if match
+
+          # Fall back to pattern-matching on the table name in a COUNT and looking
           # up the table name from ActiveRecord's loaded descendants.
-          selects_from_table = sql.scan(MODEL_SQL_PATTERN)
-          selects_from_table.map { |(table_name)| TableName.new(table_name) } unless selects_from_table.empty?
+          select_from_table = sql.match(MODEL_SQL_PATTERN)
+          TableName.new(select_from_table[:table_name]) if select_from_table
         end
       end
     end

data/lib/ar_query_matchers/queries/query_counter.rb

@@ -81,13 +81,9 @@ module ArQueryMatchers
           # Given a `sql.active_record` event, figure out which model is being
           # accessed. Some of the simpler queries have a :name key that makes this
           # really easy. Others require parsing the SQL by hand.
-          results = @query_filter.filter_map(payload[:name] || '', payload[:sql] || '')
-
-          # Round to microseconds
-          results&.each do |result|
-            model_name = result.model_name
-            next unless model_name
+          model_name = @query_filter.filter_map(payload[:name] || '', payload[:sql] || '')&.model_name
 
+          if model_name
             comment = payload[:sql].match(MARGINALIA_SQL_COMMENT_PATTERN)
             queries[model_name][:lines] << comment[:line] if comment
             queries[model_name][:count] += 1

data/lib/ar_query_matchers/queries/update_counter.rb

@@ -22,7 +22,7 @@ module ArQueryMatchers
         def filter_map(_name, sql)
           # for updates, name is always 'SQL', we have to rely on pattern matching on the query string instead.
           select_from_table = sql.match(TABLE_NAME_SQL_PATTERN)
-          [TableName.new(select_from_table[:table_name])] if select_from_table
+          TableName.new(select_from_table[:table_name]) if select_from_table
         end
       end
     end

data/lib/ar_query_matchers.rb

@@ -97,6 +97,49 @@ module ArQueryMatchers
         end
       end
 
+      # The following will fail because the call to `User` is not expected, even
+      # though the Payroll count is correct:
+      #
+      #    expect {
+      #       Payroll.count
+      #       Payroll.count
+      #       User.count
+      #    }.to only_load_at_most_models(
+      #       'Payroll' => 2,
+      #    )
+      #
+      # The following will succeed because the counts are exact:
+      #
+      #    expect {
+      #       Payroll.count
+      #       Payroll.count
+      #       User.count
+      #    }.to only_load_at_most_models(
+      #       'Payroll' => 2,
+      #       'User' => 1,
+      #    )
+      #
+      RSpec::Matchers.define(:only_load_at_most_models) do |expected = {}|
+        include MatcherConfiguration
+        include MatcherErrors
+
+        match do |block|
+          @query_stats = Queries::LoadCounter.instrument(&block)
+          expected_queries = Utility.remove_superfluous_expectations(expected)
+          actual_queries = @query_stats.query_counts
+
+          all_models = expected_queries.keys | actual_queries.keys
+
+          all_models.each do |model|
+            expect(actual_queries[model] || 0).to be <= expected_queries[model]
+          end
+        end
+
+        def failure_text
+          expectation_failed_message('load at most')
+        end
+      end
+
       RSpec::Matchers.define(:not_load_any_models) do
         include MatcherConfiguration
         include MatcherErrors

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar-query-matchers
 version: !ruby/object:Gem::Version
-  version: 0.5.2.pre.6
+  version: 0.7.0
 platform: ruby
 authors:
 - Matan Zruya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +31,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -186,9 +188,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3.1
 signing_key: