ar-query-matchers 0.2.0 → 0.5.2.pre.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5265f76d235538ee76fd8ed78d460357bd35efc1b9f96286cd674c646dfa9080
-  data.tar.gz: 368284e4b46d07c1331805e1224f15f66f82757a69dcc2d2eccb097331e154e9
+  metadata.gz: 2aaeaac19a8660c885b5ac75c32077ab6b0f835c53aaefa1bb3d3b7bab701fd4
+  data.tar.gz: 3746c66186e7d067fc82895a8d7bb90dc230eb7ddef7553ad2bb9631bd69d097
 SHA512:
-  metadata.gz: 6b6f19694c17e3462faccfcb5928e907a269947264f2a9902d7bcfb4a5ea0c88aeb99deff97198abbe5f42d25d6f844dcdff738967ef783e6a1230cadb3ce0aa
-  data.tar.gz: 55615a4c940d4dfdfbba8625fea16bcc64c537e31c31f690fc7fcc1d2b3ca7a775d5b68e145e472a478b0c8a787239fdc3c2cb8d42fbf66fcf581231499b4131
+  metadata.gz: 7d43af021387d6a1ea871bf13d876a512e19cf98eb702f85f9ff0446970c8f6bfbf40356d1eb0c1417664fd8b47ab4e8aab115785f06f8f22f547ab284dfa809
+  data.tar.gz: f8785fb4accfb4f7a2573ced84211769793cc72bb6784de3884665f39a63346ebcc83046e737e6fca3e56a9fd1dbafc563805800b49df32ee77951137c76f8aa

data/CHANGELOG.md

@@ -6,6 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.2] - 2021-05-18
+### Changed
+- Removes 'SELECT' from MODEL_SQL_PATTERN to allow for more granular SQL statement matching
+
+## [0.5.1] - 2020-11-19
+### Changed
+- Removes zero count expectations from hash before comparing
+
+## [0.5.0] - 2020-07-23
+### Changed
+- Add time information to query counter
+
+## [0.4.0] - 2020-07-20
+### Changed
+- Upgrade the Rails dependency to allow for Rails 6.1
+
+## [0.3.0] - 2020-03-13
+### Changed
+- Correct the Rails dependency to allow for Rails 6.0
+
 ## [0.2.0] - 2019-09-15
 ### Changed
 - Package the CHANGELOG and README in the gem.
@@ -15,6 +35,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - First versions as a public ruby gem.
 
-[Unreleased]: https://github.com/gusto/ar-query-matchers/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/gusto/ar-query-matchers/compare/v0.5.1...HEAD
+[0.5.1]: https://github.com/gusto/ar-query-matchers/releases/tag/v0.5.1
+[0.5.0]: https://github.com/gusto/ar-query-matchers/releases/tag/v0.5.0
+[0.4.0]: https://github.com/gusto/ar-query-matchers/releases/tag/v0.4.0
+[0.3.0]: https://github.com/gusto/ar-query-matchers/releases/tag/v0.3.0
 [0.2.0]: https://github.com/gusto/ar-query-matchers/releases/tag/v0.2.0
-[0.1.0]: https://github.com/gusto/ar-query-matchers/releases/tag/v0.1.0
+[0.1.0]: https://github.com/gusto/ar-query-matchers/releases/tag/v0.1.0

data/README.md

@@ -1,25 +1,28 @@
 ## AR Query Matchers
 ![badge](https://action-badges.now.sh/gusto/ar-query-matchers?action=Run%20Tests)
 
-These RSpec matchers allows guarding against N+1 queries by specifying
+These RSpec matchers allow guarding against N+1 queries by specifying
 exactly how many queries you expect each of your ActiveRecord models to perform.
 
-They also help us reason about the type of record interactions happening in a block of code.
+They could also help reasoning about which database interactions are happening inside a block of code.
 
 This pattern is a based on how Rails itself tests queries:
 https://github.com/rails/rails/blob/ac2bc00482c1cf47a57477edb6ab1426a3ba593c/activerecord/test/cases/test_case.rb#L104-L141
 
+Currently, this gem only supports RSpec matchers, but the code is meant to be adapted to support other testing frameworks.
+If you'd like to pick that up, please have a look at: https://github.com/Gusto/ar-query-matchers/issues/13
+
 ### Usage
 Include it in your Gemfile:
 ```ruby
 group :test do
-  gem 'ar-query-matchers', '~> 0.1.0', require: false
+  gem 'ar-query-matchers', '~> 0.2.0', require: false
 end
 ```
 
 Start using it: 
 ```ruby
-require 'ar-query-matchers'
+require 'ar_query_matchers'
 
 RSpec.describe Employee do
   it 'creating an employee creates exactly one record' do
@@ -31,7 +34,7 @@ end
 ```
 
 ### Matchers
-This module defines a few categories of matchers:
+This gem defines a few categories of matchers:
 - **Create**: Which models are created during a block
 - **Load**: Which models are fetched during a block
 - **Update**: Which models are updated during a block
@@ -55,7 +58,7 @@ expect { some_code() }.to only_load_models(
 )
 ```
 
-The following spec will pass only if there are exactly no select queries.
+The following spec will pass only if there are no select queries.
 ```ruby
 expect { some_code() }.to not_load_models
 ```
@@ -84,11 +87,9 @@ Expected to run queries to load models exactly {"Address"=>1, "Payroll"=>1, "Use
 ```
 
 ### High Level Design:
-The RSpec matcher delegates to the query counters, asserts expectations and formats error messages to provide meaningful failures.  
- 
- 
+The RSpec matcher delegates to "query counters", asserts expectations and formats error messages to provide meaningful failures.  
 The matchers are pretty simple, and delegate instrumentation into specialized QueryCounter classes.
-The QueryCounters are different classes instruments a ruby block by listening on all sql, parsing the queries and returning structured data describing the interactions.
+The QueryCounters are different classes which instrument a ruby block by listening on all sql, parsing the queries and returning structured data describing the interactions.
 
 ```                
   ┌────────────────────────────────────────────────────────────────────────────────────────┐

data/lib/ar_query_matchers.rb

@@ -3,9 +3,16 @@
 require 'ar_query_matchers/queries/create_counter'
 require 'ar_query_matchers/queries/load_counter'
 require 'ar_query_matchers/queries/update_counter'
+require 'bigdecimal'
 
 module ArQueryMatchers
   module ArQueryMatchers
+    class Utility
+      def self.remove_superfluous_expectations(expected)
+        expected.select { |_, v| v.positive? }
+      end
+    end
+
     module CreateModels
       # The following will succeed:
       #    expect {
@@ -22,7 +29,7 @@ module ArQueryMatchers
 
         match do |block|
           @query_stats = Queries::CreateCounter.instrument(&block)
-          expected == @query_stats.query_counts
+          Utility.remove_superfluous_expectations(expected) == @query_stats.query_counts
         end
 
         def failure_text
@@ -82,7 +89,7 @@ module ArQueryMatchers
 
         match do |block|
           @query_stats = Queries::LoadCounter.instrument(&block)
-          expected == @query_stats.query_counts
+          Utility.remove_superfluous_expectations(expected) == @query_stats.query_counts
         end
 
         def failure_text
@@ -146,7 +153,7 @@ module ArQueryMatchers
 
         match do |block|
           @query_stats = Queries::UpdateCounter.instrument(&block)
-          expected == @query_stats.query_counts
+          Utility.remove_superfluous_expectations(expected) == @query_stats.query_counts
         end
 
         def failure_text

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

@@ -21,18 +21,21 @@ module ArQueryMatchers
 
         # Matches unnamed SQL operations like the following:
         # "SELECT COUNT(*) FROM `users` ..."
-        MODEL_SQL_PATTERN = /SELECT .* FROM [`"](?<table_name>[^`"]+)[`"]/.freeze
+        MODEL_SQL_PATTERN = /FROM [`"](?<table_name>[^`"]+)[`"]/.freeze
 
-        def filter_map(name, sql)
+        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
+          #
+          # NOTE: This misses possible subqueries and prevents us from getting
+          # to the below matcher
+          # 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.
-          select_from_table = sql.match(MODEL_SQL_PATTERN)
-          TableName.new(select_from_table[:table_name]) if select_from_table
+          selects_from_table = sql.scan(MODEL_SQL_PATTERN)
+          selects_from_table.map { |(table_name)| TableName.new(table_name) } unless selects_from_table.empty?
         end
       end
     end

data/lib/ar_query_matchers/queries/query_counter.rb

@@ -62,7 +62,7 @@ module ArQueryMatchers
       # @param [block] block to instrument
       # @return [QueryStats] stats about all the SQL queries executed during the block
       def instrument(&block)
-        queries = Hash.new { |h, k| h[k] = { count: 0, lines: [] } }
+        queries = Hash.new { |h, k| h[k] = { count: 0, lines: [], time: BigDecimal(0) } }
         ActiveSupport::Notifications.subscribed(to_proc(queries), 'sql.active_record', &block)
         QueryStats.new(queries)
       end
@@ -75,18 +75,23 @@ module ArQueryMatchers
       private_constant :MARGINALIA_SQL_COMMENT_PATTERN
 
       def to_proc(queries)
-        lambda do |_name, _start, _finish, _message_id, payload|
+        lambda do |_name, start, finish, _message_id, payload|
           return if payload[:cached]
 
           # Given a `sql.active_record` event, figure out which model is being
-          # accessed. Some of the simpler queries have a :ame key that makes this
+          # accessed. Some of the simpler queries have a :name key that makes this
           # really easy. Others require parsing the SQL by hand.
-          model_name = @query_filter.filter_map(payload[:name] || '', payload[:sql] || '')&.model_name
+          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
 
-          if model_name
             comment = payload[:sql].match(MARGINALIA_SQL_COMMENT_PATTERN)
             queries[model_name][:lines] << comment[:line] if comment
             queries[model_name][:count] += 1
+            queries[model_name][:time] += (finish - start).round(6) # Round to microseconds
           end
         end
       end

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar-query-matchers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.2.pre.5
 platform: ruby
 authors:
 - Matan Zruya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-15 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +47,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +148,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: These RSpec matchers allows guarding against N+1 queries by specifying
+description: These RSpec matchers allow guarding against N+1 queries by specifying
   exactly how many queries you expect each of your ActiveRecord models to perform.
 email:
 - mzruya@gmail.com
@@ -186,11 +186,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Ruby test matchers for instrumenting ActiveRecord query counts