n_plus_one_control 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 394ec848692af46dd43c3a03a3315349c2aea19d174ff05ededa1ef825839ee0
-  data.tar.gz: 7e2a271fe8ae173b117d1fc514e33b6f08aa7c528e4ea476f5360591a28da6f8
+  metadata.gz: 48ad0338e6227c2b71a09254f3613db415d64fe5b40ee7df55ee1daddc46c0f5
+  data.tar.gz: c55895975614627ea2308dde866079bad496f5ddef81f295267f5b0d8b2670ac
 SHA512:
-  metadata.gz: 1f411b0c1539f517e0c4036570e274fe62327817722065551fce09307e15402c31185566343ddb9fd388324a71c5c8d7730fc938767397f5bbba60f103ffdccb
-  data.tar.gz: 21a4445b6dd7efa9dad9bbfe2ccf8708ae813e2e60ea424b60f7b00cf58bef1971d58b1392893f34e817a3834792b461536890ed38619a20e0f9bd770ab7ddfd
+  metadata.gz: b4f6b44d7ecccd6e3f53d65e4df916982b144b8381049ebec5659cdf5792cc9c1d1c7fdee22cb8610df155020220286cc2daf78a0dbe8b76fe6bceb778446c81
+  data.tar.gz: 63ac722a3b82c6c3263a79f0065f554352bf4ce2043bdec98f37139f8b21f441e9327bc575ff6e3bdde05e8eac95ce636615e74ed4e3415a0ae28312da43d2a7

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-## master (unreleased)
+## 0.6.0 (2020-11-27)
+
+- Fix table stats summary when queries use backticks to surround table names ([@andrewhampton][])
+- Add support to test for linear query. ([@caalberts][])
 
 ## 0.5.0 (2020-09-07)
 
@@ -26,3 +29,5 @@ Could be specified via `NPLUSONE_BACKTRACE` env var.
 
 [@Earendil95]: https://github.com/Earendil95
 [@palkan]: https://github.com/palkan
+[@caalberts]: https://github.com/caalberts
+[@andrewhampton]: https://github.com/andrewhampton

data/README.md

@@ -85,10 +85,10 @@ Availables modifiers:
 ```ruby
 # You can specify the RegExp to filter queries.
 # By default, it only considers SELECT queries.
-expect { subject }.to perform_constant_number_of_queries.matching(/INSERT/)
+expect { get :index }.to perform_constant_number_of_queries.matching(/INSERT/)
 
 # You can also provide custom scale factors
-expect { subject }.to perform_constant_number_of_queries.with_scale_factors(10, 100)
+expect { get :index }.to perform_constant_number_of_queries.with_scale_factors(10, 100)
 ```
 
 #### Using scale factor in spec
@@ -111,6 +111,21 @@ context "N+1", :n_plus_one do
 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.  
+
+```ruby
+context "when has linear query", :n_plus_one do
+  populate { |n| create_list(:post, n) }
+
+  specify do
+    expect { Post.find_each { |p| p.user.name } }
+      .to perform_linear_number_of_queries(slope: 1)
+  end
+end
+```
+
 ### Minitest
 
 First, add NPlusOneControl to your `test_helper.rb`:
@@ -132,6 +147,18 @@ def test_no_n_plus_one_error
 end
 ```
 
+You can also use `assert_perform_linear_number_of_queries` to test for linear queries:
+
+```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
+end
+```
+
 You can also specify custom scale factors or filter patterns:
 
 ```ruby

data/lib/n_plus_one_control.rb

@@ -6,7 +6,7 @@ require "n_plus_one_control/executor"
 # RSpec and Minitest matchers to prevent N+1 queries problem.
 module NPlusOneControl
   # Used to extract a table name from a query
-  EXTRACT_TABLE_RXP = /(insert into|update|delete from|from) ['"](\S+)['"]/i.freeze
+  EXTRACT_TABLE_RXP = /(insert into|update|delete from|from) ['"`](\S+)['"`]/i.freeze
 
   # Used to convert a query part extracted by the regexp above to the corresponding
   # human-friendly type
@@ -23,8 +23,13 @@ module NPlusOneControl
 
     attr_reader :default_matching
 
-    def failure_message(queries) # rubocop:disable Metrics/MethodLength
-      msg = ["Expected to make the same number of queries, but got:\n"]
+    FAILURE_MESSAGES = {
+      constant_queries: "Expected to make the same number of queries",
+      linear_queries: "Expected to make linear number of queries"
+    }
+
+    def failure_message(type, queries) # rubocop:disable Metrics/MethodLength
+      msg = ["#{FAILURE_MESSAGES[type]}, but got:\n"]
       queries.each do |(scale, data)|
         msg << "  #{data.size} for N=#{scale}\n"
       end

data/lib/n_plus_one_control/minitest.rb

@@ -26,7 +26,30 @@ module NPlusOneControl
 
       counts = queries.map(&:last).map(&:size)
 
-      assert counts.max == counts.min, NPlusOneControl.failure_message(queries)
+      assert counts.max == counts.min, NPlusOneControl.failure_message(:constant_queries, queries)
+    end
+
+    def assert_perform_linear_number_of_queries(
+      slope: 1,
+      populate: nil,
+      matching: nil,
+      scale_factors: nil,
+      warmup: nil
+    )
+
+      raise ArgumentError, "Block is required" unless block_given?
+
+      warming_up warmup
+
+      @executor = NPlusOneControl::Executor.new(
+        population: populate || population_method,
+        matching: matching || NPlusOneControl.default_matching,
+        scale_factors: scale_factors || NPlusOneControl.default_scale_factors
+      )
+
+      queries = @executor.call { yield }
+
+      assert linear?(queries, slope: slope), NPlusOneControl.failure_message(:linear_queries, queries)
     end
 
     def current_scale
@@ -42,6 +65,16 @@ module NPlusOneControl
     def population_method
       methods.include?(:populate) ? method(:populate) : nil
     end
+
+    def linear?(queries, slope:)
+      queries.each_cons(2).all? do |pair|
+        scales = pair.map(&:first)
+        query_lists = pair.map(&:last)
+
+        actual_slope = (query_lists[1].size - query_lists[0].size) / (scales[1] - scales[0])
+        actual_slope <= slope
+      end
+    end
   end
 end
 

data/lib/n_plus_one_control/rspec.rb

@@ -4,7 +4,8 @@ gem "rspec-core", ">= 3.5"
 
 require "n_plus_one_control"
 require "n_plus_one_control/rspec/dsl"
-require "n_plus_one_control/rspec/matcher"
+require "n_plus_one_control/rspec/matchers/perform_constant_number_of_queries"
+require "n_plus_one_control/rspec/matchers/perform_linear_number_of_queries"
 require "n_plus_one_control/rspec/context"
 
 module NPlusOneControl

data/lib/n_plus_one_control/rspec/{matcher.rb → matchers/perform_constant_number_of_queries.rb}

@@ -46,6 +46,6 @@
     raise "This matcher doesn't support negation"
   end
 
-  failure_message { |_actual| NPlusOneControl.failure_message(@queries) }
+  failure_message { |_actual| NPlusOneControl.failure_message(:constant_queries, @queries) }
 end
 # rubocop:enable  Metrics/BlockLength

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# rubocop:disable  Metrics/BlockLength
+::RSpec::Matchers.define :perform_linear_number_of_queries do |slope: 1|
+  supports_block_expectations
+
+  chain :with_scale_factors do |*factors|
+    @factors = factors
+  end
+
+  chain :matching do |pattern|
+    @pattern = pattern
+  end
+
+  chain :with_warming_up do
+    @warmup = true
+  end
+
+  match do |actual, *_args|
+    raise ArgumentError, "Block is required" unless actual.is_a? Proc
+
+    raise "Missing tag :n_plus_one" unless
+      @matcher_execution_context.respond_to?(:n_plus_one_populate)
+
+    populate = @matcher_execution_context.n_plus_one_populate
+    warmup = @warmup ? actual : @matcher_execution_context.n_plus_one_warmup
+
+    warmup.call if warmup.present?
+
+    @matcher_execution_context.executor = NPlusOneControl::Executor.new(
+      population: populate,
+      matching: nil,
+      scale_factors: @factors
+    )
+
+    @queries = @matcher_execution_context.executor.call(&actual)
+
+    @queries.each_cons(2).all? do |pair|
+      scales = pair.map(&:first)
+      query_lists = pair.map(&:last)
+
+      actual_slope = (query_lists[1].size - query_lists[0].size) / (scales[1] - scales[0])
+      actual_slope <= slope
+    end
+  end
+
+  match_when_negated do |_actual|
+    raise "This matcher doesn't support negation"
+  end
+
+  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.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n_plus_one_control
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-07 00:00:00.000000000 Z
+date: 2020-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +100,8 @@ files:
 - lib/n_plus_one_control/rspec.rb
 - lib/n_plus_one_control/rspec/context.rb
 - lib/n_plus_one_control/rspec/dsl.rb
-- lib/n_plus_one_control/rspec/matcher.rb
+- 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
 licenses:
@@ -111,7 +112,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,8 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: RSpec and Minitest matchers to prevent N+1 queries problem
 test_files: []