n_plus_one_control 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9eb89619e16cb318f7c758c355c9578b1bbe10b446aa86a8e6a05402e5a3634
-  data.tar.gz: c441fc080ac62c150e21877868e8862175b22521d8cb12d3ce240d5153b2d7d7
+  metadata.gz: 0fed1df4b3bee8844b57b4d4201802361b5871d93db3fdb0132a4073fd56fc3a
+  data.tar.gz: 56649719e9b94ed7eb05ccf3c6236399a6a2a9394ce37574a8e58f079b1ff3b4
 SHA512:
-  metadata.gz: 5e5e62dcd9958539060f05f25758a24cfedaa17d3b78a0439c0dc2fbc649c8ba9467371c56aecc78f722c0426daf70db8dea94e5ab8ea86bdc2cfec93c83669a
-  data.tar.gz: 26cd504b1ca3ed20ce7b25f12a80ab3d8470a1ccefe66bc432af51005bbfd3bc30e3a770a04d7b4f528eac393581f56c2fa044034399c6741f7316b5444b22d2
+  metadata.gz: cae71e3487fb5210bd6dd76ae0cf7ee1bb310748a3e3a9cd95d893dc2eb99c6fa90c8482366897a7a2e6c8ed479780d337ef2e1284c266fef00e7b67f5f42dad
+  data.tar.gz: 270f6a75e499ffecd886d98739ccaa5f15ff60a7aebc1ebecc10cc0b2cfdd831137e482897d6ed217f0e60306e2b0350ef22d781a0475ad1a7dfda7563d6fc35

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 ## master
 
+## 0.7.0 (2023-02-17)
+
+- Added ability to specify the exact number of expected queries when using constant matchers. ([@akostadinov][], [@palkan][])
+
+For RSpec, you can add the `.exactly` modifier:
+
+```ruby
+expect { get :index }.to perform_constant_number_of_queries.exactly(1)
+```
+
+For Minitest, you can provide the expected number of queries as the first argument:
+
+```ruby
+assert_perform_constant_number_of_queries(0, **options) do
+  get :index
+end
+```
+
+- **Require Ruby 2.7+**.
+
+## 0.6.2 (2021-10-26)
+
+- Fix .ignore setting (.ignore setting was ignored by the Collector ;-))
+- Fix rspec matchers to allow expectations inside execution block
+
 ## 0.6.1 (2021-03-05)
 
 - Ruby 3.0 compatibility. ([@palkan][])
@@ -39,3 +64,4 @@ Could be specified via `NPLUSONE_BACKTRACE` env var.
 [@palkan]: https://github.com/palkan
 [@caalberts]: https://github.com/caalberts
 [@andrewhampton]: https://github.com/andrewhampton
+[@akostadinov]: https://github.com/akostadinov

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017-2020 Vladimir Dementyev
+Copyright (c) 2017-2023 Vladimir Dementyev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -17,6 +17,8 @@ NPlusOneControl works differently. It evaluates the code under consideration sev
 
 So, it's for _performance_ testing and not _feature_ testing.
 
+> Read also ["Squash N+1 queries early with n_plus_one_control test matchers for Ruby and Rails"](https://evilmartians.com/chronicles/squash-n-plus-one-queries-early-with-n-plus-one-control-test-matchers-for-ruby-and-rails).
+
 ### Why not just use [`bullet`](https://github.com/flyerhzm/bullet)?
 
 Of course, it's possible to use Bullet in tests (see more [here](https://evilmartians.com/chronicles/fighting-the-hydra-of-n-plus-one-queries)), but it's not a _silver bullet_: there can be both false positives and true negatives.
@@ -72,12 +74,33 @@ end
 
 ```ruby
 # BAD – won't work!
-
 subject { get :index }
 
 specify do
   expect { subject }.to perform_constant_number_of_queries
 end
+
+# GOOD
+specify do
+  expect { get :index }.to perform_constant_number_of_queries
+end
+
+# BAD — the `page` record would be removed from the database
+# but still present in RSpec (due to `let`'s memoization)
+let(:page) { create(:page) }
+
+populate { |n| create_list(:comment, n, page: page) }
+
+specify do
+  expect { get :show, params: {id: page.id} }.to perform_constant_number_of_queries
+end
+
+# GOOD
+# Ensure the record is created before `populate`
+let!(:page) { create(:page) }
+
+populate { |n| create_list(:comment, n, page: page) }
+# ...
 ```
 
 Availables modifiers:
@@ -89,6 +112,9 @@ expect { get :index }.to perform_constant_number_of_queries.matching(/INSERT/)
 
 # You can also provide custom scale factors
 expect { get :index }.to perform_constant_number_of_queries.with_scale_factors(10, 100)
+
+# You can specify the exact number of expected queries
+expect { get :index }.to perform_constant_number_of_queries.exactly(1)
 ```
 
 #### Using scale factor in spec
@@ -111,6 +137,20 @@ context "N+1", :n_plus_one do
 end
 ```
 
+### Expectations in execution block
+
+Both rspec matchers allows you to put additional expectations inside execution block to ensure that tested piece of code actually does what expected.
+
+```ruby
+context "N+1", :n_plus_one do
+  specify do
+    expect do
+      expect(my_query).to eq(actuall_results)
+    end.to perform_constant_number_of_queries
+  end
+end
+```
+
 #### Other available matchers
 
 `perform_linear_number_of_queries(slope: 1)` allows you to test that a query generates linear number of queries with the given slope.  
@@ -152,7 +192,7 @@ You can also use `assert_perform_linear_number_of_queries` to test for linear qu
 ```ruby
 def test_no_n_plus_one_error
   populate = ->(n) { create_list(:post, n) }
-  
+
   assert_perform_linear_number_of_queries(slope: 1, populate: populate) do
     Post.find_each { |p| p.user.name }
   end
@@ -177,6 +217,14 @@ assert_perform_constant_number_of_queries(
 end
 ```
 
+For the constant matcher, you can also specify the expected number of queries as the first argument:
+
+```ruby
+assert_perform_constant_number_of_queries(2, populate: populate) do
+  get :index
+end
+```
+
 It's possible to specify a filter via `NPLUSONE_FILTER` env var, e.g.:
 
 ```ruby
@@ -256,7 +304,7 @@ end
 If your `warmup` and testing procs are identical, you can use:
 
 ```ruby
-expext { get :index }.to perform_constant_number_of_queries.with_warming_up # RSpec only
+expect { get :index }.to perform_constant_number_of_queries.with_warming_up # RSpec only
 ```
 
 ### Configuration
@@ -288,7 +336,7 @@ NPlusOneControl.ignore = /^(BEGIN|COMMIT|SAVEPOINT|RELEASE)/
 # but can also track rom-rb events ('sql.rom') as well.
 NPlusOneControl.event = "sql.active_record"
 
-# configure transactional behavour for populate method
+# configure transactional behaviour for populate method
 # in case of use multiple database connections
 NPlusOneControl::Executor.tap do |executor|
   connections = ActiveRecord::Base.connection_handler.connection_pool_list.map(&:connection)
@@ -312,7 +360,7 @@ NPlusOneControl.backtrace_cleaner = ->(locations_array) { do_some_filtering(loca
 NPlusOneControl.backtrace_length = 1
 
 # Sometime queries could be too large to provide any meaningful insight.
-# You can configure an output length limit for quries in verbose mode by setting the follwing option
+# You can configure an output length limit for quries in verbose mode by setting the following option
 # NOTE: It could be specified via NPLUSONE_TRUNCATE env var
 NPlusOneControl.truncate_query_size = 100
 ```

data/lib/n_plus_one_control/executor.rb

@@ -21,6 +21,7 @@ module NPlusOneControl
 
       def callback(_name, _start, _finish, _message_id, values) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/LineLength
         return if %w[CACHE SCHEMA].include? values[:name]
+        return if values[:sql].match?(NPlusOneControl.ignore)
 
         return unless @pattern.nil? || (values[:sql] =~ @pattern)
 

data/lib/n_plus_one_control/minitest.rb

@@ -6,6 +6,7 @@ module NPlusOneControl
   # Minitest assertions
   module MinitestHelper
     def assert_perform_constant_number_of_queries(
+      exact = nil,
       populate: nil,
       matching: nil,
       scale_factors: nil,
@@ -26,7 +27,11 @@ module NPlusOneControl
 
       counts = queries.map(&:last).map(&:size)
 
-      assert counts.max == counts.min, NPlusOneControl.failure_message(:constant_queries, queries)
+      if exact
+        assert counts.all? { _1 == exact }, NPlusOneControl.failure_message(:number_of_queries, queries)
+      else
+        assert counts.max == counts.min, NPlusOneControl.failure_message(:constant_queries, queries)
+      end
     end
 
     def assert_perform_linear_number_of_queries(
@@ -59,7 +64,7 @@ module NPlusOneControl
     private
 
     def warming_up(warmup)
-      (warmup || methods.include?(:warmup) ? method(:warmup) : nil)&.call
+      (warmup || (methods.include?(:warmup) ? method(:warmup) : nil))&.call
     end
 
     def population_method

data/lib/n_plus_one_control/rspec/dsl.rb

@@ -6,7 +6,7 @@ module NPlusOneControl
     module DSL
       # Extends RSpec ExampleGroup with populate & warmup methods
       module ClassMethods
-        # Setup warmup block, wich will run before matching
+        # Setup warmup block, which will run before matching
         # for example, if using cache, then later queries
         # will perform less DB queries than first
         def warmup(&block)

data/lib/n_plus_one_control/rspec/matchers/perform_constant_number_of_queries.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable  Metrics/BlockLength
 ::RSpec::Matchers.define :perform_constant_number_of_queries do
   supports_block_expectations
 
@@ -12,11 +11,15 @@
     @pattern = pattern
   end
 
+  chain :exactly do |pattern|
+    @exactly = pattern
+  end
+
   chain :with_warming_up do
     @warmup = true
   end
 
-  match do |actual, *_args|
+  match(notify_expectation_failures: true) do |actual, *_args|
     raise ArgumentError, "Block is required" unless actual.is_a? Proc
 
     raise "Missing tag :n_plus_one" unless
@@ -32,20 +35,23 @@
     @matcher_execution_context.executor = NPlusOneControl::Executor.new(
       population: populate,
       matching: pattern,
-      scale_factors: @factors
+      scale_factors: @exactly ? [1] : @factors
     )
 
     @queries = @matcher_execution_context.executor.call(&actual)
 
     counts = @queries.map(&:last).map(&:size)
 
-    counts.max == counts.min
+    if @exactly
+      counts.all? { _1 == @exactly }
+    else
+      counts.max == counts.min
+    end
   end
 
   match_when_negated do |_actual|
     raise "This matcher doesn't support negation"
   end
 
-  failure_message { |_actual| NPlusOneControl.failure_message(:constant_queries, @queries) }
+  failure_message { |_actual| NPlusOneControl.failure_message(@exactly ? :number_of_queries : :constant_queries, @queries) }
 end
-# rubocop:enable  Metrics/BlockLength

data/lib/n_plus_one_control/rspec/matchers/perform_linear_number_of_queries.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable  Metrics/BlockLength
 ::RSpec::Matchers.define :perform_linear_number_of_queries do |slope: 1|
   supports_block_expectations
 
@@ -16,7 +15,7 @@
     @warmup = true
   end
 
-  match do |actual, *_args|
+  match(notify_expectation_failures: true) do |actual, *_args|
     raise ArgumentError, "Block is required" unless actual.is_a? Proc
 
     raise "Missing tag :n_plus_one" unless
@@ -50,4 +49,3 @@
 
   failure_message { |_actual| NPlusOneControl.failure_message(:linear_queries, @queries) }
 end
-# rubocop:enable  Metrics/BlockLength

data/lib/n_plus_one_control/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NPlusOneControl
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/lib/n_plus_one_control.rb

@@ -25,7 +25,8 @@ module NPlusOneControl
 
     FAILURE_MESSAGES = {
       constant_queries: "Expected to make the same number of queries",
-      linear_queries: "Expected to make linear number of queries"
+      linear_queries: "Expected to make linear number of queries",
+      number_of_queries: "Expected to make the specified number of queries"
     }
 
     def failure_message(type, queries) # rubocop:disable Metrics/MethodLength
@@ -59,9 +60,10 @@ module NPlusOneControl
       end
 
       before.keys.each do |k|
-        next if before[k] == after[k]
+        next if before[k] == after&.fetch(k, nil)
 
-        msg << "#{k}: #{before[k]} != #{after[k]}\n"
+        after_value = after ? " != #{after[k]}" : ""
+        msg << "#{k}: #{before[k]}#{after_value}\n"
       end
 
       msg

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n_plus_one_control
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2023-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.9'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.8.0
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.8.0
+        version: '6.0'
 description: "\n    RSpec and Minitest matchers to prevent N+1 queries problem.\n\n
   \   Evaluates code under consideration several times with different scale factors\n
   \   to make sure that the number of DB queries behaves as expected (i.e. O(1) instead
@@ -103,16 +103,16 @@ files:
 - lib/n_plus_one_control/rspec/matchers/perform_constant_number_of_queries.rb
 - lib/n_plus_one_control/rspec/matchers/perform_linear_number_of_queries.rb
 - lib/n_plus_one_control/version.rb
-homepage: http://github.com/palkan/n_plus_one_control
+homepage: https://github.com/palkan/n_plus_one_control
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: http://github.com/palkan/n_plus_one_control/issues
+  bug_tracker_uri: https://github.com/palkan/n_plus_one_control/issues
   changelog_uri: https://github.com/palkan/n_plus_one_control/blob/master/CHANGELOG.md
-  documentation_uri: http://github.com/palkan/n_plus_one_control
-  homepage_uri: http://github.com/palkan/n_plus_one_control
-  source_code_uri: http://github.com/palkan/n_plus_one_control
-post_install_message: 
+  documentation_uri: https://github.com/palkan/n_plus_one_control
+  homepage_uri: https://github.com/palkan/n_plus_one_control
+  source_code_uri: https://github.com/palkan/n_plus_one_control
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,15 +120,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: RSpec and Minitest matchers to prevent N+1 queries problem
 test_files: []