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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60c088b5a136a27e7cda68a413f8a46005c82f63ff30bb22eaadf70995390755
-  data.tar.gz: 2be1beb74c5716601305bd6771fb2f9ba8058879a609dcb4198c640a1a5f7cd9
+  metadata.gz: a03e79681fb7644c916a5f3c019a5e9484f8b7176e21b6c91beae9bd2d9eb520
+  data.tar.gz: 1a1d6f97aab26efa604ae32dd2d4b56164e4616ff87b2ffbfb84812e87e57a75
 SHA512:
-  metadata.gz: 24c9812af618e31c66520d52d79e6a7bf0b6695c8e99323136877061bcac6045f795bc4655af35d9aeca49bd2ed129b0227bc717544e4c5007df1493fb9fa65c
-  data.tar.gz: c6905a488bde5a20cd45cb636d59d9c0dcf2b459cbafda156da918a0fa4a71866b60ee014ede6ec242539ced60f6915ccbecb56848b411bda97ca8d6eb0b4a5f
+  metadata.gz: 960fb79a70f3875f606d67364227ad6b0af6440b18fed4e885a8a44614d61f484ad7cdc33e6040b114b568d320edcc045a212a9db0c570577a039bb7a04b09c6
+  data.tar.gz: 379ef8320c724772bcf9fc38dda46a86fa8a24a8690a9547a13973065dcebef9fae17f77a636e059463f91afbba2aa341164ddadbe900e58fb625d3f1b64a5c4

data/CHANGELOG.md

@@ -5,8 +5,25 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-## [0.3.0] - 2020-03-13
 
+## [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
@@ -18,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

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

@@ -15,24 +15,15 @@ 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 COUNT(*) FROM `users` ..."
-        MODEL_SQL_PATTERN = /SELECT .* FROM [`"](?<table_name>[^`"]+)[`"]/.freeze
-
-        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
+        # "SELECT * FROM `users` ..."
+        MODEL_SQL_PATTERN = /SELECT (?:(?!SELECT).)* FROM [`"](?<table_name>[^`"]+)[`"]/.freeze
 
-          # Fall back to pattern-matching on the table name in a COUNT and looking
+        def filter_map(_name, sql)
+          # Pattern-matching on the table name in a SELECT ... FROM 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.3.0
+  version: 0.5.2.pre.6
 platform: ruby
 authors:
 - Matan Zruya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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