n_plus_one_control 0.1.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f39c7dee63a881210d82f9459af15c81969f6346
-  data.tar.gz: 1a303ce2a4b52354cf3b4036c1f925c017308097
+SHA256:
+  metadata.gz: b20b8f4269aac76f3da642b271b93ddee2adf508539bba6852e02225695de155
+  data.tar.gz: e739f342b4d46cc451229f3a065cb0e2b83ee28c301d99045d0f094e74bc137b
 SHA512:
-  metadata.gz: 4bd630b55700e20ba3cb00523d7e2b023819ffdfd802a1daae90e7532dfa86b8c4ac170378fde819b5810c694268df07d08b361c0fae84bbcbbfeff198a3e5fc
-  data.tar.gz: 6bc7a3c38fda5837c6f8a3e0cabc3a118ef0c95bb3ffc1066fae066fe9a86a7c14ac06876704326520594b91230b5e78c1015e00f6160ee1e5e3c58953e46396
+  metadata.gz: 74805b4ea497ff96bb882557ed8a14e04d32cf5ea5c62e9c65167647c880275aec9d0f8a405a298554e9cfecbb20049d99f630b977475a75122d847c7b27e1a9
+  data.tar.gz: 19063ec1fb2a84edcfd0e38075a3858e239a438803ffb40e03916bc8eb5d49dda9e8b03a30a60788e4e00f9c5484811740448fe3241e64658a78ccf884619321

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## master (unreleased)
+
+## 0.4.1 (2020-09-04)
+
+- Enhance failure message by showing differences in table hits. ([@palkan][])
+
+## 0.4.0 (2020-07-20)
+
+- Make scale factor available in tests via `#current_scale` method. ([@Earendil95][])
+
+- Start keeping a changelog. ([@palkan][])
+
+[@Earendil95]: https://github.com/Earendil95
+[@palkan]: https://github.com/palkan

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 palkan
+Copyright (c) 2017-2020 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

@@ -92,6 +92,26 @@ expect { ... }.to perform_constant_number_of_queries.matching(/INSERT/)
 expect { ... }.to perform_constant_number_of_queries.with_scale_factors(10, 100)
 ```
 
+#### Using scale factor in spec
+
+Let's suppose your action accepts parameter, which can make impact on the number of returned records:
+
+```ruby
+get :index, params: { per_page: 10 }
+```
+
+Then it is enough to just change `per_page` parameter between executions and do not recreate records in DB. For this purpose, you can use `current_scale` method in your example:
+
+```ruby
+context "N+1", :n_plus_one do
+  before { create_list :post, 3 }
+
+  specify do
+    expect { get :index, params: { per_page: current_scale } }.to perform_constant_number_of_queries
+  end
+end
+```
+
 ### Minitest
 
 First, add NPlusOneControl to your `test_helper.rb`:
@@ -147,6 +167,66 @@ def test_no_n_plus_one_error
 end
 ```
 
+As in RSpec, you can use `current_scale` factor instead of `populate` block:
+
+```ruby
+def test_no_n_plus_one_error
+  assert_perform_constant_number_of_queries do
+    get :index, params: { per_page: current_scale }
+  end
+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):
@@ -160,6 +240,14 @@ NPlusOneControl.default_scale_factors = [2, 3]
 # You can activate verbosity through env variable NPLUSONE_VERBOSE=1
 NPlusOneControl.verbose = false
 
+# Print table hits difference, for example:
+#
+#   Unmatched query numbers by tables:
+#     users (SELECT): 2 != 3
+#     events (INSERT): 1 != 2
+#
+self.show_table_stats = true
+
 # Ignore matching queries
 NPlusOneControl.ignore = /^(BEGIN|COMMIT|SAVEPOINT|RELEASE)/
 
@@ -167,6 +255,19 @@ NPlusOneControl.ignore = /^(BEGIN|COMMIT|SAVEPOINT|RELEASE)/
 # We track ActiveRecord event by default,
 # but can also track rom-rb events ('sql.rom') as well.
 NPlusOneControl.event = 'sql.active_record'
+
+# configure transactional behavour 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)
+
+  executor.transaction_begin = -> do
+    connections.each { |connection| connection.begin_transaction(joinable: false) }
+  end
+  executor.transaction_rollback = -> do
+    connections.each(&:rollback_transaction)
+  end
+end
 ```
 
 ## How does it work?
@@ -180,7 +281,7 @@ It may be useful to provide more matchers/assertions, for example:
 ```ruby
 
 # Actually, that means that it is N+1))
-assert_linear_number_of_queries { ... } 
+assert_linear_number_of_queries { ... }
 
 # But we can tune it with `coef` and handle such cases as selecting in batches
 assert_linear_number_of_queries(coef: 0.1) do
@@ -211,4 +312,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/palkan
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/n_plus_one_control.rb

@@ -5,17 +5,59 @@ 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
+
+  # Used to convert a query part extracted by the regexp above to the corresponding
+  # human-friendly type
+  QUERY_PART_TO_TYPE = {
+    "insert into" => "INSERT",
+    "update" => "UPDATE",
+    "delete from" => "DELETE",
+    "from" => "SELECT"
+  }.freeze
+
   class << self
-    attr_accessor :default_scale_factors, :verbose, :ignore, :event
+    attr_accessor :default_scale_factors, :verbose, :show_table_stats, :ignore, :event
 
-    def failure_message(queries)
+    def failure_message(queries) # rubocop:disable Metrics/MethodLength
       msg = ["Expected to make the same number of queries, but got:\n"]
       queries.each do |(scale, data)|
         msg << "  #{data.size} for N=#{scale}\n"
-        msg << data.map { |sql| "    #{sql}\n" }.join.to_s if verbose
       end
+
+      msg.concat(table_usage_stats(queries.map(&:last))) if show_table_stats
+
+      if verbose
+        queries.each do |(scale, data)|
+          msg << "  Queries for N=#{scale}\n"
+          msg << data.map { |sql| "    #{sql}\n" }.join.to_s
+        end
+      end
+
       msg.join
     end
+
+    def table_usage_stats(runs) # rubocop:disable Metrics/MethodLength
+      msg = ["\nUnmatched query numbers by tables:\n"]
+
+      before, after = runs.map do |queries|
+        queries.group_by do |query|
+          matches = query.match(EXTRACT_TABLE_RXP)
+          next unless matches
+
+          "  #{matches[2]} (#{QUERY_PART_TO_TYPE[matches[1].downcase]})"
+        end.transform_values(&:count)
+      end
+
+      before.keys.each do |k|
+        next if before[k] == after[k]
+
+        msg << "#{k}: #{before[k]} != #{after[k]}\n"
+      end
+
+      msg
+    end
   end
 
   # Scale factors to use.
@@ -25,6 +67,9 @@ module NPlusOneControl
   # Print performed queries if true
   self.verbose = ENV['NPLUSONE_VERBOSE'] == '1'
 
+  # Print table hits difference
+  self.show_table_stats = true
+
   # Ignore matching queries
   self.ignore = /^(BEGIN|COMMIT|SAVEPOINT|RELEASE)/
 

data/lib/n_plus_one_control/executor.rb

@@ -3,7 +3,7 @@
 module NPlusOneControl
   # Runs code for every scale factor
   # and returns collected queries.
-  module Executor
+  class Executor
     # Subscribes to ActiveSupport notifications and collect matching queries.
     class Collector
       def initialize(pattern)
@@ -21,35 +21,67 @@ module NPlusOneControl
 
       def callback(_name, _start, _finish, _message_id, values)
         return if %w[CACHE SCHEMA].include? values[:name]
+
         @queries << values[:sql] if @pattern.nil? || (values[:sql] =~ @pattern)
       end
     end
 
     class << self
-      def call(population:, scale_factors: nil, matching: nil)
-        raise ArgumentError, "Block is required!" unless block_given?
+      attr_accessor :transaction_begin
+      attr_accessor :transaction_rollback
+    end
+
+    attr_reader :current_scale
+
+    self.transaction_begin = -> do
+      ActiveRecord::Base.connection.begin_transaction(joinable: false)
+    end
+
+    self.transaction_rollback = -> do
+      ActiveRecord::Base.connection.rollback_transaction
+    end
+
+    def initialize(population: nil, scale_factors: nil, matching: nil)
+      @population = population
+      @scale_factors = scale_factors
+      @matching = matching
+    end
 
-        results = []
-        collector = Collector.new(matching)
+    # rubocop:disable Metrics/MethodLength
+    def call
+      raise ArgumentError, "Block is required!" unless block_given?
 
-        (scale_factors || NPlusOneControl.default_scale_factors).each do |scale|
-          with_transaction do
-            population.call(scale)
-            results << [scale, collector.call { yield }]
-          end
+      results = []
+      collector = Collector.new(matching)
+
+      (scale_factors || NPlusOneControl.default_scale_factors).each do |scale|
+        @current_scale = scale
+        with_transaction do
+          population&.call(scale)
+          results << [scale, collector.call { yield }]
         end
-        results
       end
+      results
+    end
+    # rubocop:enable Metrics/MethodLength
 
-      private
+    private
 
-      def with_transaction
-        return yield unless defined?(ActiveRecord)
-        ActiveRecord::Base.connection.begin_transaction(joinable: false)
-        yield
-      ensure
-        ActiveRecord::Base.connection.rollback_transaction
-      end
+    def with_transaction
+      transaction_begin.call
+      yield
+    ensure
+      transaction_rollback.call
+    end
+
+    def transaction_begin
+      self.class.transaction_begin
+    end
+
+    def transaction_rollback
+      self.class.transaction_rollback
     end
+
+    attr_reader :population, :scale_factors, :matching
   end
 end

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),
+      warming_up warmup
+
+      @executor = NPlusOneControl::Executor.new(
+        population: populate || population_method,
         matching: matching || /^SELECT/i,
         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/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,21 @@
       @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
 
-    @queries = NPlusOneControl::Executor.call(
+    @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 +49,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.1.3"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: n_plus_one_control
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.4.1
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2020-09-04 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
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: 0.61.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: 0.61.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +112,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -139,26 +139,16 @@ dependencies:
 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
@@ -167,19 +157,15 @@ files:
 - 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:
@@ -195,8 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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,71 +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/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

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in n_plus_one_control.gemspec
-gemspec

data/Rakefile

@@ -1,13 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
-require "rake/testtask"
-
-Rake::TestTask.new do |t|
-  t.test_files = FileList['tests/**/*_test.rb']
-end
-
-RuboCop::RakeTask.new
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => [:spec, :test, :rubocop]

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "n_plus_one_control"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/n_plus_one_control.gemspec

@@ -1,47 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'n_plus_one_control/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "n_plus_one_control"
-  spec.version       = NPlusOneControl::VERSION
-  spec.authors       = ["palkan"]
-  spec.email         = ["dementiev.vm@gmail.com"]
-
-  spec.summary       = "RSpec and Minitest matchers to prevent N+1 queries problem"
-  spec.required_ruby_version = '>= 2.0.0'
-  spec.description   = %{
-    RSpec and Minitest matchers to prevent N+1 queries problem.
-
-    Evaluates code under consideration several times with different scale factors
-    to make sure that the number of DB queries behaves as expected (i.e. O(1) instead of O(N)).
-
-    Example:
-
-      ```ruby
-      context "N+1", :n_plus_one do
-        populate { |n| create_list(:post, n) }
-
-        specify do
-          expect { get :index }.to perform_constant_number_of_queries
-        end
-      end
-      ```
-  }
-  spec.homepage      = "http://github.com/palkan/n_plus_one_control"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.5"
-  spec.add_development_dependency "minitest", "~> 5.9"
-  spec.add_development_dependency "factory_girl", "~> 4.8.0"
-  spec.add_development_dependency "rubocop", "~> 0.49"
-  spec.add_development_dependency "activerecord", "~> 5.1"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "pry-byebug"
-end

data/spec/n_plus_one_control/executor_spec.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe NPlusOneControl::Executor do
-  let(:populate) do
-    ->(n) { create_list(:post, n) }
-  end
-
-  let(:observable) do
-    -> { Post.find_each(&:user) }
-  end
-
-  it "raises when block is missing" do
-    expect { described_class.call(population: populate) }
-      .to raise_error(ArgumentError, "Block is required!")
-  end
-
-  it "raises when populate is missing" do
-    expect { described_class.call(&observable) }
-      .to raise_error(ArgumentError, /population/)
-  end
-
-  it "returns correct counts for default scales" do
-    result = described_class.call(
-      population: populate,
-      &observable
-    )
-
-    expect(result.size).to eq 2
-    expect(result.first[0]).to eq 2
-    expect(result.first[1].size).to eq 3
-    expect(result.last[0]).to eq 3
-    expect(result.last[1].size).to eq 4
-  end
-
-  it "returns correct counts for custom scales" do
-    result = described_class.call(
-      population: populate,
-      scale_factors: [5, 10, 100],
-      &observable
-    )
-
-    expect(result.size).to eq 3
-    expect(result.first[0]).to eq 5
-    expect(result.first[1].size).to eq 6
-    expect(result.second[0]).to eq 10
-    expect(result.second[1].size).to eq 11
-    expect(result.last[0]).to eq 100
-    expect(result.last[1].size).to eq 101
-  end
-
-  it "returns correct counts with custom match" do
-    result = described_class.call(
-      population: populate,
-      matching: /users/,
-      &observable
-    )
-
-    expect(result.first[0]).to eq 2
-    expect(result.first[1].size).to eq 2
-    expect(result.last[0]).to eq 3
-    expect(result.last[1].size).to eq 3
-  end
-end

data/spec/n_plus_one_control/rspec_spec.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe NPlusOneControl::RSpec do
-  context "when no N+1", :n_plus_one do
-    populate { |n| create_list(:post, n) }
-
-    specify do
-      expect { Post.preload(:user).find_each { |p| p.user.name } }
-        .to perform_constant_number_of_queries
-    end
-  end
-
-  context "when has N+1", :n_plus_one do
-    populate { |n| create_list(:post, n) }
-
-    specify do
-      expect do
-        expect { Post.find_each { |p| p.user.name } }
-          .to perform_constant_number_of_queries
-      end.to raise_error(RSpec::Expectations::ExpectationNotMetError)
-    end
-  end
-
-  context "when context is missing" do
-    specify do
-      expect do
-        expect { subject }.to perform_constant_number_of_queries
-      end.to raise_error(/missing tag/i)
-    end
-  end
-
-  context "when populate is missing", :n_plus_one do
-    specify do
-      expect do
-        expect { subject }.to perform_constant_number_of_queries
-      end.to raise_error(/please provide populate/i)
-    end
-  end
-
-  context "when negated" do
-    specify do
-      expect do
-        expect { subject }.not_to perform_constant_number_of_queries
-      end.to raise_error(/support negation/i)
-    end
-  end
-
-  context "when verbose", :n_plus_one do
-    populate { |n| create_list(:post, n) }
-
-    around(:each) do |ex|
-      NPlusOneControl.verbose = true
-      ex.run
-      NPlusOneControl.verbose = false
-    end
-
-    specify do
-      expect do
-        expect { Post.find_each { |p| p.user.name } }
-          .to perform_constant_number_of_queries
-      end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /select .+ from/i)
-    end
-  end
-
-  context "with scale_factors", :n_plus_one do
-    populate { |n| create_list(:post, n) }
-
-    specify do
-      expect { Post.find_each { |p| p.user.name } }
-        .to perform_constant_number_of_queries.with_scale_factors(1, 1)
-    end
-  end
-
-  context "with matching", :n_plus_one do
-    populate { |n| create_list(:post, n) }
-
-    specify do
-      expect { Post.find_each { |p| p.user.name } }
-        .to perform_constant_number_of_queries.matching(/posts/)
-    end
-  end
-end

data/spec/n_plus_one_control_spec.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe NPlusOneControl do
-  it "has a version number" do
-    expect(NPlusOneControl::VERSION).not_to be nil
-  end
-end

data/spec/spec_helper.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "n_plus_one_control/rspec"
-require "benchmark"
-require "active_record"
-require "factory_girl"
-require "pry-byebug"
-
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
-
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
-
-RSpec.configure do |config|
-  config.mock_with :rspec
-
-  config.order = :random
-  config.filter_run focus: true
-  config.run_all_when_everything_filtered = true
-
-  config.include FactoryGirl::Syntax::Methods
-
-  config.before(:each) do
-    ActiveRecord::Base.connection.begin_transaction(joinable: false)
-  end
-
-  config.after(:each) do
-    ActiveRecord::Base.connection.rollback_transaction
-  end
-end

data/spec/support/post.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-ActiveRecord::Schema.define do
-  create_table :posts do |t|
-    t.string :title
-    t.integer :user_id
-  end
-end
-
-class Post < ActiveRecord::Base
-  belongs_to :user
-end
-
-FactoryGirl.define do
-  factory :post do
-    title "Title"
-    user
-  end
-end

data/spec/support/user.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-ActiveRecord::Schema.define do
-  create_table :users do |t|
-    t.string :name
-  end
-end
-
-class User < ActiveRecord::Base
-  has_many :posts
-end
-
-FactoryGirl.define do
-  factory :user do
-    name "John"
-  end
-end

data/tests/minitest_test.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "test_helper"
-
-class TestMinitest < Minitest::Test
-  def test_no_n_plus_one_error
-    populate = ->(n) { create_list(:post, n) }
-
-    assert_perform_constant_number_of_queries(populate: populate) do
-      Post.preload(:user).find_each { |p| p.user.name }
-    end
-  end
-
-  def test_with_n_plus_one_error
-    populate = ->(n) { create_list(:post, n) }
-
-    e = assert_raises Minitest::Assertion do
-      assert_perform_constant_number_of_queries(populate: populate) do
-        Post.find_each { |p| p.user.name }
-      end
-    end
-
-    assert_match "Expected to make the same number of queries", e.message
-    assert_match "3 for N=2", e.message
-    assert_match "4 for N=3", e.message
-  end
-
-  def test_no_n_plus_one_error_with_scale_factors
-    populate = ->(n) { create_list(:post, n) }
-
-    assert_perform_constant_number_of_queries(
-      populate: populate,
-      scale_factors: [1, 1]
-    ) do
-      Post.find_each { |p| p.user.name }
-    end
-  end
-
-  def test_no_n_plus_one_error_with_matching
-    populate = ->(n) { create_list(:post, n) }
-
-    assert_perform_constant_number_of_queries(
-      populate: populate,
-      matching: /posts/
-    ) do
-      Post.find_each { |p| p.user.name }
-    end
-  end
-
-  def populate(n)
-    create_list(:post, n)
-  end
-
-  def test_fallback_to_populate_method
-    e = assert_raises Minitest::Assertion do
-      assert_perform_constant_number_of_queries do
-        Post.find_each { |p| p.user.name }
-      end
-    end
-
-    assert_match "Expected to make the same number of queries", e.message
-  end
-end

data/tests/test_helper.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require "minitest/autorun"
-require "minitest/pride"
-
-$LOAD_PATH << File.expand_path("../../lib", __FILE__)
-Thread.abort_on_exception = true
-
-require "n_plus_one_control/minitest"
-require "benchmark"
-require "active_record"
-require "factory_girl"
-require "pry-byebug"
-
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
-
-Dir["#{File.dirname(__FILE__)}/../spec/support/**/*.rb"].each { |f| require f }
-
-module TransactionalTests
-  def setup
-    ActiveRecord::Base.connection.begin_transaction(joinable: false)
-    super
-  end
-
-  def teardown
-    super
-    ActiveRecord::Base.connection.rollback_transaction
-  end
-end
-
-Minitest::Test.prepend TransactionalTests
-Minitest::Test.include FactoryGirl::Syntax::Methods