n_plus_one_control 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 942639e351ee999dc4a113c237d9604878d296cc
-  data.tar.gz: 76d9b2b2fd28b02925ce4d219e3b5c6ac316d1fb
+SHA256:
+  metadata.gz: 292888473b7ae70cfdc9c8e9324170dfaf1d7048fc27a8c33a3ef09ee7b3fc3a
+  data.tar.gz: 99bf992bbe635524c8eaea3f6536f4813e05b4420bc1f26ecea8ab26fecfc0f1
 SHA512:
-  metadata.gz: 980d3feab9ebd9d9b51da847526a83ae0ed2b36e50509494d14bfad75578086b4c2ca6a6da60d5f518a6a2deb87c80af848c792046804e96b62249404f09535c
-  data.tar.gz: ef2d79c707712f2a578ba4ff513c1f03b6c4cf351b72381875188ac6a3730c1f73b3fd11ab7a0538f5d76f2d67a5b6fb4f57775218e1ac8b1a0877e6936bd0a9
+  metadata.gz: cd45056252d7ae15236e8ae5d5880c0bda50f741ac3cf2079a42f5870cf378fb52d791b444c57c25218428d52e046841a5a762708a18ad868103d9e17f0d30f1
+  data.tar.gz: b17d7be7d184ffa37ce4f6162b694928eb96968cc5f4e05e42971d68954709ed33c43b36c5549d49823ac2578103d9420cf713dd4f6cbc12880e885203a87bb4

data/.rubocop.yml

@@ -17,7 +17,10 @@ AllCops:
 Rails:
   Enabled: false
 
-Style/AccessorMethodName:
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
+Naming/AccessorMethodName:
   Enabled: false
 
 Style/TrivialAccessors:
@@ -37,7 +40,7 @@ Style/RegexpLiteral:
 Style/Lambda:
   Enabled: false
 
-Style/SpaceInsideStringInterpolation:
+Layout/SpaceInsideStringInterpolation:
   EnforcedStyle: no_space
 
 Style/ClassAndModuleChildren:

data/README.md

@@ -147,6 +147,56 @@ def test_no_n_plus_one_error
 end
 ```
 
+### With caching
+
+If you use caching you can face the problem when first request performs more DB queries than others. The solution is:
+
+```ruby
+# RSpec
+
+context "N + 1", :n_plus_one do
+  populate { |n| create_list :post, n }
+  
+  warmup { get :index } # cache something must be cached
+  
+  specify do
+    expect { get :index }.to perform_constant_number_of_queries
+  end
+end
+
+# Minitest
+
+def populate(n)
+  create_list(:post, n)
+end
+
+def warmup
+  get :index
+end
+
+def test_no_n_plus_one_error
+  assert_perform_constant_number_of_queries do
+    get :index
+  end
+end
+
+# or with params
+
+def test_no_n_plus_one
+  populate = ->(n) { create_list(:post, n) }
+  warmup = -> { get :index }
+  
+  assert_perform_constant_number_of_queries population: populate, warmup: warmup do
+    get :index
+  end
+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
+```
+
 ### Configuration
 
 There are some global configuration parameters (and their corresponding defaults):

data/lib/n_plus_one_control/minitest.rb

@@ -5,14 +5,21 @@ require "n_plus_one_control"
 module NPlusOneControl
   # Minitest assertions
   module MinitestHelper
+    def warming_up(warmup)
+      (warmup || methods.include?(:warmup) ? method(:warmup) : nil)&.call
+    end
+
     def assert_perform_constant_number_of_queries(
       populate: nil,
       matching: nil,
-      scale_factors: nil
+      scale_factors: nil,
+      warmup: nil
     )
 
       raise ArgumentError, "Block is required" unless block_given?
 
+      warming_up warmup
+
       queries = NPlusOneControl::Executor.call(
         population: populate || method(:populate),
         matching: matching || /^SELECT/i,

data/lib/n_plus_one_control/rspec/context.rb

@@ -16,4 +16,9 @@
     end
     ->(n) { ex.instance_exec(n, &ex.example_group.populate) }
   end
+
+  let(:n_plus_one_warmup) do |ex|
+    return if ex.example_group.warmup.nil?
+    -> { ex.instance_exec(&ex.example_group.warmup) }
+  end
 end

data/lib/n_plus_one_control/rspec/dsl.rb

@@ -2,8 +2,17 @@
 
 module NPlusOneControl
   module RSpec
-    # Extends RSpec ExampleGroup with populate method
+    # Extends RSpec ExampleGroup with populate & warmup methods
     module DSL
+      # Setup warmup block, wich will run before matching
+      # for example, if using cache, then later queries
+      # will perform less DB queries than first
+      def warmup
+        return @warmup unless block_given?
+
+        @warmup = Proc.new
+      end
+
       # Setup populate callback, which is used
       # to prepare data for each run.
       def populate

data/lib/n_plus_one_control/rspec/matcher.rb

@@ -12,6 +12,10 @@
     @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
 
@@ -19,6 +23,9 @@
       @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?
 
     # by default we're looking for select queries
     pattern = @pattern || /^SELECT/i
@@ -41,3 +48,4 @@
 
   failure_message { |_actual| NPlusOneControl.failure_message(@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.2.1"
+  VERSION = "0.3.0"
 end

data/spec/n_plus_one_control/rspec_spec.rb

@@ -81,4 +81,33 @@ describe NPlusOneControl::RSpec do
         .to perform_constant_number_of_queries.matching(/posts/)
     end
   end
+
+  context 'with warming up', :n_plus_one do
+    let(:cache) { double "cache" }
+
+    before do
+      allow(cache).to receive(:setup).and_return(:result)
+      allow(NPlusOneControl::Executor).to receive(:call) { raise StandardError }
+    end
+
+    populate { |n| create_list(:post, n) }
+
+    warmup { cache.setup }
+
+    it "runs warmup before calling Executor" do
+      expect(cache).to receive(:setup)
+      expect do
+        expect { Post.find_each(&:id) }.to perform_constant_number_of_queries
+      end.to raise_error StandardError
+    end
+  end
+
+  context 'with_warming_up', :n_plus_one do
+    populate { |n| create_list(:post, n) }
+
+    it "runs actual one more time" do
+      expect(Post).to receive(:all).exactly(3).times
+      expect { Post.all }.to perform_constant_number_of_queries.with_warming_up
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require "n_plus_one_control/rspec"
 require "benchmark"
 require "active_record"

data/tests/test_helper.rb

@@ -3,7 +3,7 @@
 require "minitest/autorun"
 require "minitest/pride"
 
-$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+$LOAD_PATH << File.expand_path('../lib', __dir__)
 Thread.abort_on_exception = true
 
 require "n_plus_one_control/minitest"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n_plus_one_control
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -196,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: RSpec and Minitest matchers to prevent N+1 queries problem