n_plus_one_control 0.2.1 → 0.5.0

data/lib/n_plus_one_control/minitest.rb

@@ -8,21 +8,40 @@ module NPlusOneControl
     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?
 
-      queries = NPlusOneControl::Executor.call(
-        population: populate || method(:populate),
-        matching: matching || /^SELECT/i,
+      warming_up warmup
+
+      @executor = NPlusOneControl::Executor.new(
+        population: populate || population_method,
+        matching: matching || NPlusOneControl.default_matching,
         scale_factors: scale_factors || NPlusOneControl.default_scale_factors
-      ) { yield }
+      )
+
+      queries = @executor.call { yield }
 
       counts = queries.map(&:last).map(&:size)
 
       assert counts.max == counts.min, NPlusOneControl.failure_message(queries)
     end
+
+    def current_scale
+      @executor&.current_scale
+    end
+
+    private
+
+    def warming_up(warmup)
+      (warmup || methods.include?(:warmup) ? method(:warmup) : nil)&.call
+    end
+
+    def population_method
+      methods.include?(:populate) ? method(:populate) : nil
+    end
   end
 end
 

data/lib/n_plus_one_control/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module NPlusOneControl # :nodoc:
+  class Railtie < ::Rails::Railtie # :nodoc:
+    initializer "n_plus_one_control.backtrace_cleaner" do
+      ActiveSupport.on_load(:active_record) do
+        NPlusOneControl.backtrace_cleaner = lambda do |locations|
+          ::Rails.backtrace_cleaner.clean(locations)
+        end
+      end
+    end
+  end
+end

data/lib/n_plus_one_control/rspec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+gem "rspec-core", ">= 3.5"
+
 require "n_plus_one_control"
 require "n_plus_one_control/rspec/dsl"
 require "n_plus_one_control/rspec/matcher"
@@ -11,5 +13,6 @@ module NPlusOneControl
 end
 
 ::RSpec.configure do |config|
-  config.extend NPlusOneControl::RSpec::DSL, n_plus_one: true
+  config.extend NPlusOneControl::RSpec::DSL::ClassMethods, n_plus_one: true
+  config.include NPlusOneControl::RSpec::DSL, n_plus_one: true
 end

data/lib/n_plus_one_control/rspec/context.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
-::RSpec.shared_context "n_plus_one_control", n_plus_one: true do
+RSpec.shared_context "n_plus_one_control" do
   # Helper to access populate block from within example/matcher
   let(:n_plus_one_populate) do |ex|
-    if ex.example_group.populate.nil?
-      raise(
-        <<-MSG
-          Populate block is missing!
+    return if ex.example_group.populate.nil?
 
-          Please provide populate callback, e.g.:
-
-            populate { |n| n.times { create_some_stuff } }
-        MSG
-      )
-    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
+
+RSpec.configure do |config|
+  config.include_context "n_plus_one_control", n_plus_one: true
 end

data/lib/n_plus_one_control/rspec/dsl.rb

@@ -2,14 +2,32 @@
 
 module NPlusOneControl
   module RSpec
-    # Extends RSpec ExampleGroup with populate method
+    # Includes scale method into RSpec Example
     module DSL
-      # Setup populate callback, which is used
-      # to prepare data for each run.
-      def populate
-        return @populate unless block_given?
+      # Extends RSpec ExampleGroup with populate & warmup methods
+      module ClassMethods
+        # 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?
 
-        @populate = Proc.new
+          @warmup = Proc.new
+        end
+
+        # Setup populate callback, which is used
+        # to prepare data for each run.
+        def populate
+          return @populate unless block_given?
+
+          @populate = Proc.new
+        end
+      end
+
+      attr_accessor :executor
+
+      def current_scale
+        executor&.current_scale
       end
     end
   end

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,17 +23,20 @@
       @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
 
-    # by default we're looking for select queries
-    pattern = @pattern || /^SELECT/i
+    warmup.call if warmup.present?
 
-    @queries = NPlusOneControl::Executor.call(
+    pattern = @pattern || NPlusOneControl.default_matching
+
+    @matcher_execution_context.executor = NPlusOneControl::Executor.new(
       population: populate,
       matching: pattern,
-      scale_factors: @factors,
-      &actual
+      scale_factors: @factors
     )
 
+    @queries = @matcher_execution_context.executor.call(&actual)
+
     counts = @queries.map(&:last).map(&:size)
 
     counts.max == counts.min
@@ -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.5.0"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: n_plus_one_control
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,106 +80,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.8.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.49'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.49'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '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
-  of O(N)).\n\n    Example:\n\n      ```ruby\n      context \"N+1\", :n_plus_one do\n
-  \       populate { |n| create_list(:post, n) }\n\n        specify do\n          expect
-  { get :index }.to perform_constant_number_of_queries\n        end\n      end\n      ```\n
-  \ "
+  of O(N)).\n  "
 email:
 - dementiev.vm@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/n_plus_one_control.rb
 - lib/n_plus_one_control/executor.rb
 - lib/n_plus_one_control/minitest.rb
+- lib/n_plus_one_control/railtie.rb
 - 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/version.rb
-- n_plus_one_control.gemspec
-- spec/n_plus_one_control/executor_spec.rb
-- spec/n_plus_one_control/rspec_spec.rb
-- spec/n_plus_one_control_spec.rb
-- spec/spec_helper.rb
-- spec/support/post.rb
-- spec/support/user.rb
-- tests/minitest_test.rb
-- tests/test_helper.rb
 homepage: http://github.com/palkan/n_plus_one_control
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: http://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: 
 rdoc_options: []
 require_paths:
@@ -188,15 +119,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: RSpec and Minitest matchers to prevent N+1 queries problem

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/log/
-*.gem

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.rubocop.yml

@@ -1,74 +0,0 @@
-AllCops:
-  Include:
-    - 'lib/**/*.rb'
-    - 'lib/**/*.rake'
-    - 'spec/**/*.rb'
-  Exclude:
-    - 'bin/**/*'
-    - 'spec/dummy/**/*'
-    - 'tmp/**/*'
-    - 'Rakefile'
-    - 'Gemfile'
-    - '*.gemspec'
-  DisplayCopNames: true
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.4
-
-Rails:
-  Enabled: false
-
-Style/AccessorMethodName:
-  Enabled: false
-
-Style/TrivialAccessors:
-  Enabled: false
-
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*.rb'
-    - 'tests/**/*.rb'
-
-Style/StringLiterals: 
-  Enabled: false
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/Lambda:
-  Enabled: false
-
-Style/SpaceInsideStringInterpolation:
-  EnforcedStyle: no_space
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/BlockDelimiters:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-
-
-Metrics/MethodLength:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Metrics/AbcSize:
-  Max: 20
-
-Metrics/LineLength:
-  Max: 100
-  Exclude:
-    - 'spec/**/*.rb'
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Rails/Date:
-  Enabled: false
-
-Rails/TimeZone:
-  Enabled: false