ar-query-matchers 0.4.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b63da3f9faf039d2e310b80cbafc3eb84b0eac6c7900c74c20dcb370d783c932
-  data.tar.gz: 8772744af1d74014b2556ee444f920c9514e500f85cb84b123ac983cd0b0fbd1
+  metadata.gz: ab18e9a530a6577ba47fbc78341913bc83ec6c2976dfd3404be8819d346fcab8
+  data.tar.gz: 9801846663ecc57468f79a66a7c12f170f9ddb2fef79d35aa33c36910c8d9a8a
 SHA512:
-  metadata.gz: c7a047769f644fcff1fa73f0d6a15cb4065dc99fe1a98cad614fd1f221f421a5abfe01850091a3a7d40dedcaaedbe12c29c594a58d70a2cee3849b645f938f39
-  data.tar.gz: b342d652bd7a2ad14b9294ac5d2a4d100c34dddd042b06749770eb3db753d0286912954552c8a946d57b5914e5e647f3087843ca05c294ca56fb936a817c3560
+  metadata.gz: aa331847dc1130257f6af7cc567e636ccedc8c7cecbd90383606f4c17050ab7c05546b51aa3cea040f1416082e45d98c04182341a13fddcfbbb66148183b9c43
+  data.tar.gz: 4becc7972b419b4e55d0f5cf55292ec8dfad6d6a1804bf9315c4368e842ec8a6c98506028b1ae7df41d2736f8a80b67fb745f1c9bb9e98328092db745baf8619

data/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.2] - 2021-05-26
+### Changed
+- Update MODEL_SQL_PATTERN to allow for more granular matches; remove MODEL_LOAD_PATTERN
+
+## [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
@@ -23,7 +35,9 @@ 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.4.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

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/load_counter.rb

@@ -21,7 +21,7 @@ module ArQueryMatchers
 
         # Matches unnamed SQL operations like the following:
         # "SELECT COUNT(*) FROM `users` ..."
-        MODEL_SQL_PATTERN = /SELECT .* FROM [`"](?<table_name>[^`"]+)[`"]/.freeze
+        MODEL_SQL_PATTERN = /SELECT (?:(?!SELECT).)* FROM [`"](?<table_name>[^`"]+)[`"]/.freeze
 
         def filter_map(name, sql)
           # First check for a `SELECT * FROM` query that ActiveRecord has

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,11 +75,11 @@ 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
 
@@ -87,6 +87,7 @@ module ArQueryMatchers
             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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar-query-matchers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Matan Zruya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 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