ar-query-matchers 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e73f1af783ac0aea8a1342b20e01d139106e29c2c4048bf3d30086a13675f204
-  data.tar.gz: 64b309608ae8f52ba8d7a998ea0e7658eebb2ee7d11122d8e1c0934f042131b6
+  metadata.gz: 2bbbb0ab94d0e842a364dbe7d970900fa6bcdf2b6d9d3a0a2eb3cfac96df9efd
+  data.tar.gz: 6650c24207bd4a7d47077ec311b05530eab74dca5b097537ca554023f8cd92ce
 SHA512:
-  metadata.gz: 13b5fe44e89c7e0df944882d4d15dac2ff72b8fe3a679591c46b15015587159246c4e2344d2e604b6a31a0ee6dc5a450eacd85ef638d90d578f1b4073fca2f58
-  data.tar.gz: 61d48528375466023a71bf17ad2e453ec62ce5520f43200f88de94ff2f116522be3694fe2c0116f83093fa5f1087cf4774471143e63deb8f465dd03173bda8cd
+  metadata.gz: 1b548ed7b6d0d3ad9d144f2994846c84e087c420f5390cfe2ad957b3a598383c07576d5d51e5cb209bc589e928ad92fd7af56c1c40c73b198d510dab0721c50e
+  data.tar.gz: e27df0c699c8c2021d0e146f6070cba820226e2ca4dcc2258bcde3247356b4007600433cf928da00bda8585d1a32e8c638097ec95ecfa2e524db5e1194c4a5b4

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0] - 2022-01-27
+### Added
+- Changed the implementation of ArQueryMatchers::Queries::TableName to calculate distance of class name to table name to determine which class name is most likely. This changes how tables in `only_load_at_most_models` are calculated.
+
 ## [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.

data/README.md

@@ -16,7 +16,7 @@ If you'd like to pick that up, please have a look at: https://github.com/Gusto/a
 Include it in your Gemfile:
 ```ruby
 group :test do
-  gem 'ar-query-matchers', '~> 0.2.0', require: false
+  gem 'ar-query-matchers', '~> 0.7.0', require: false
 end
 ```
 
@@ -40,9 +40,10 @@ This gem defines a few categories of matchers:
 - **Update**: Which models are updated during a block
 
 Each matcher category includes 3 assertions, for example, for the Load category, you could use the following assertions:
-- **only_load_models**: Strict assertion, not other query is allowed.
+- **only_load_models**: Strict assertion of both models loaded and query counts. No other query is allowed.
+- **only_load_at_most_models**: Strict assertion of models loaded, with an upper bound on the number of queries allowed against each.
 - **not_load_models**: No models are allowed to be loaded.
-- **load_models**: Inclusion, other models are allowed to be loaded if not specified in the assertion.
+- **load_models**: Inclusion. Other models are allowed to be loaded if not specified in the assertion.
 
 
 **For example:** 
@@ -58,6 +59,17 @@ expect { some_code() }.to only_load_models(
 )
 ```
 
+The following spec will pass only if there are 4 or less SQL SELECTs that
+load User records (and 1 or less for both Address and Payroll respectively) _and_ no other models
+perform any SELECT queries.
+```ruby
+expect { some_code() }.to only_load_at_most_models(
+  'User' => 4,
+  'Address' => 1,
+  'Payroll' => 1,
+)
+```
+
 The following spec will pass only if there are no select queries.
 ```ruby
 expect { some_code() }.to not_load_models

data/lib/ar_query_matchers/queries/create_counter.rb

@@ -17,7 +17,7 @@ module ArQueryMatchers
       class CreateQueryFilter < QueryFilter
         # Matches unnamed SQL operations like the following:
         # "INSERT INTO `company_approval_details` ..."
-        TABLE_NAME_SQL_PATTERN = /INSERT INTO [`"](?<table_name>[^`"]+)[`"]/.freeze
+        TABLE_NAME_SQL_PATTERN = /INSERT INTO [`"](?<table_name>[^`"]+)[`"]/
 
         def filter_map(_name, sql)
           # for inserts, name is always 'SQL', we have to rely on pattern matching the query string.

data/lib/ar_query_matchers/queries/load_counter.rb

@@ -17,11 +17,11 @@ module ArQueryMatchers
       class LoadQueryFilter < Queries::QueryFilter
         # Matches named SQL operations like the following:
         # 'User Load'
-        MODEL_LOAD_PATTERN = /\A(?<model_name>[\w:]+) (Load|Exists)\Z/.freeze
+        MODEL_LOAD_PATTERN = /\A(?<model_name>[\w:]+) (Load|Exists)\Z/
 
         # Matches unnamed SQL operations like the following:
         # "SELECT COUNT(*) FROM `users` ..."
-        MODEL_SQL_PATTERN = /SELECT (?:(?!SELECT).)* FROM [`"](?<table_name>[^`"]+)[`"]/.freeze
+        MODEL_SQL_PATTERN = /SELECT (?:(?!SELECT).)* FROM [`"](?<table_name>[^`"]+)[`"]/
 
         def filter_map(name, sql)
           # First check for a `SELECT * FROM` query that ActiveRecord has

data/lib/ar_query_matchers/queries/query_counter.rb

@@ -71,7 +71,7 @@ module ArQueryMatchers
 
       # The 'marginalia' gem adds a line from the backtrace to the SQL query in
       # the form of a comment.
-      MARGINALIA_SQL_COMMENT_PATTERN = %r{/*line:(?<line>.*)'*/}.freeze
+      MARGINALIA_SQL_COMMENT_PATTERN = %r{/*line:(?<line>.*)'*/}
       private_constant :MARGINALIA_SQL_COMMENT_PATTERN
 
       def to_proc(queries)

data/lib/ar_query_matchers/queries/table_name.rb

@@ -31,9 +31,9 @@ module ArQueryMatchers
         # { 'users' => [User, AtoUser],
         #   'employees => [Employee, PandaFlows::StateFields] }
 
-        # Of all the models that share the same table name sort them by their
-        # relative ancestry and pick the one that all the rest inherit from
-        tables[table_name].min_by { |a, b| a.ancestors.include?(b) }
+        # Pick the class with the shortest distance to the table name
+        ideal_class_name = table_name.classify
+        tables[table_name].min_by { |a| DidYouMean::Levenshtein.distance(ideal_class_name, a.to_s) }
       end
     end
   end

data/lib/ar_query_matchers/queries/update_counter.rb

@@ -17,7 +17,7 @@ module ArQueryMatchers
       class UpdateQueryFilter < QueryFilter
         # Matches unnamed SQL operations like the following:
         # "UPDATE `bank_account_verifications` ..."
-        TABLE_NAME_SQL_PATTERN = /UPDATE [`"](?<table_name>[^`"]+)[`"]/.freeze
+        TABLE_NAME_SQL_PATTERN = /UPDATE [`"](?<table_name>[^`"]+)[`"]/
 
         def filter_map(_name, sql)
           # for updates, name is always 'SQL', we have to rely on pattern matching on the query string instead.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar-query-matchers
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Matan Zruya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Ruby test matchers for instrumenting ActiveRecord query counts