n_plus_one_control 0.3.0 → 0.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +33 -0
- data/LICENSE.txt +1 -1
- data/README.md +107 -15
- data/lib/n_plus_one_control.rb +102 -6
- data/lib/n_plus_one_control/executor.rb +63 -23
- data/lib/n_plus_one_control/minitest.rb +54 -9
- data/lib/n_plus_one_control/railtie.rb +13 -0
- data/lib/n_plus_one_control/rspec.rb +6 -2
- data/lib/n_plus_one_control/rspec/context.rb +7 -11
- data/lib/n_plus_one_control/rspec/dsl.rb +21 -12
- data/lib/n_plus_one_control/rspec/{matcher.rb → matchers/perform_constant_number_of_queries.rb} +6 -6
- data/lib/n_plus_one_control/rspec/matchers/perform_linear_number_of_queries.rb +53 -0
- data/lib/n_plus_one_control/version.rb +1 -1
- metadata +24 -93
- data/.gitignore +0 -11
- data/.rspec +0 -2
- data/.rubocop.yml +0 -77
- data/.travis.yml +0 -5
- data/Gemfile +0 -4
- data/Rakefile +0 -13
- data/bin/console +0 -14
- data/bin/setup +0 -8
- data/n_plus_one_control.gemspec +0 -47
- data/spec/n_plus_one_control/executor_spec.rb +0 -65
- data/spec/n_plus_one_control/rspec_spec.rb +0 -113
- data/spec/n_plus_one_control_spec.rb +0 -9
- data/spec/spec_helper.rb +0 -30
- data/spec/support/post.rb +0 -19
- data/spec/support/user.rb +0 -17
- data/tests/minitest_test.rb +0 -63
- data/tests/test_helper.rb +0 -32
data/.gitignore
DELETED
data/.rspec
DELETED
data/.rubocop.yml
DELETED
@@ -1,77 +0,0 @@
|
|
1
|
-
AllCops:
|
2
|
-
Include:
|
3
|
-
- 'lib/**/*.rb'
|
4
|
-
- 'lib/**/*.rake'
|
5
|
-
- 'spec/**/*.rb'
|
6
|
-
Exclude:
|
7
|
-
- 'bin/**/*'
|
8
|
-
- 'spec/dummy/**/*'
|
9
|
-
- 'tmp/**/*'
|
10
|
-
- 'Rakefile'
|
11
|
-
- 'Gemfile'
|
12
|
-
- '*.gemspec'
|
13
|
-
DisplayCopNames: true
|
14
|
-
StyleGuideCopsOnly: false
|
15
|
-
TargetRubyVersion: 2.4
|
16
|
-
|
17
|
-
Rails:
|
18
|
-
Enabled: false
|
19
|
-
|
20
|
-
Naming/UncommunicativeMethodParamName:
|
21
|
-
Enabled: false
|
22
|
-
|
23
|
-
Naming/AccessorMethodName:
|
24
|
-
Enabled: false
|
25
|
-
|
26
|
-
Style/TrivialAccessors:
|
27
|
-
Enabled: false
|
28
|
-
|
29
|
-
Style/Documentation:
|
30
|
-
Exclude:
|
31
|
-
- 'spec/**/*.rb'
|
32
|
-
- 'tests/**/*.rb'
|
33
|
-
|
34
|
-
Style/StringLiterals:
|
35
|
-
Enabled: false
|
36
|
-
|
37
|
-
Style/RegexpLiteral:
|
38
|
-
Enabled: false
|
39
|
-
|
40
|
-
Style/Lambda:
|
41
|
-
Enabled: false
|
42
|
-
|
43
|
-
Layout/SpaceInsideStringInterpolation:
|
44
|
-
EnforcedStyle: no_space
|
45
|
-
|
46
|
-
Style/ClassAndModuleChildren:
|
47
|
-
Enabled: false
|
48
|
-
|
49
|
-
Style/BlockDelimiters:
|
50
|
-
Exclude:
|
51
|
-
- 'spec/**/*.rb'
|
52
|
-
|
53
|
-
Lint/AmbiguousRegexpLiteral:
|
54
|
-
Enabled: false
|
55
|
-
|
56
|
-
|
57
|
-
Metrics/MethodLength:
|
58
|
-
Exclude:
|
59
|
-
- 'spec/**/*.rb'
|
60
|
-
|
61
|
-
Metrics/AbcSize:
|
62
|
-
Max: 20
|
63
|
-
|
64
|
-
Metrics/LineLength:
|
65
|
-
Max: 100
|
66
|
-
Exclude:
|
67
|
-
- 'spec/**/*.rb'
|
68
|
-
|
69
|
-
Metrics/BlockLength:
|
70
|
-
Exclude:
|
71
|
-
- 'spec/**/*.rb'
|
72
|
-
|
73
|
-
Rails/Date:
|
74
|
-
Enabled: false
|
75
|
-
|
76
|
-
Rails/TimeZone:
|
77
|
-
Enabled: false
|
data/.travis.yml
DELETED
data/Gemfile
DELETED
data/Rakefile
DELETED
@@ -1,13 +0,0 @@
|
|
1
|
-
require "bundler/gem_tasks"
|
2
|
-
require "rspec/core/rake_task"
|
3
|
-
require "rubocop/rake_task"
|
4
|
-
require "rake/testtask"
|
5
|
-
|
6
|
-
Rake::TestTask.new do |t|
|
7
|
-
t.test_files = FileList['tests/**/*_test.rb']
|
8
|
-
end
|
9
|
-
|
10
|
-
RuboCop::RakeTask.new
|
11
|
-
RSpec::Core::RakeTask.new(:spec)
|
12
|
-
|
13
|
-
task :default => [:spec, :test, :rubocop]
|
data/bin/console
DELETED
@@ -1,14 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
|
3
|
-
require "bundler/setup"
|
4
|
-
require "n_plus_one_control"
|
5
|
-
|
6
|
-
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
-
# with your gem easier. You can also use a different console, if you like.
|
8
|
-
|
9
|
-
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
-
# require "pry"
|
11
|
-
# Pry.start
|
12
|
-
|
13
|
-
require "irb"
|
14
|
-
IRB.start
|
data/bin/setup
DELETED
data/n_plus_one_control.gemspec
DELETED
@@ -1,47 +0,0 @@
|
|
1
|
-
# coding: utf-8
|
2
|
-
lib = File.expand_path('../lib', __FILE__)
|
3
|
-
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
-
require 'n_plus_one_control/version'
|
5
|
-
|
6
|
-
Gem::Specification.new do |spec|
|
7
|
-
spec.name = "n_plus_one_control"
|
8
|
-
spec.version = NPlusOneControl::VERSION
|
9
|
-
spec.authors = ["palkan"]
|
10
|
-
spec.email = ["dementiev.vm@gmail.com"]
|
11
|
-
|
12
|
-
spec.summary = "RSpec and Minitest matchers to prevent N+1 queries problem"
|
13
|
-
spec.required_ruby_version = '>= 2.0.0'
|
14
|
-
spec.description = %{
|
15
|
-
RSpec and Minitest matchers to prevent N+1 queries problem.
|
16
|
-
|
17
|
-
Evaluates code under consideration several times with different scale factors
|
18
|
-
to make sure that the number of DB queries behaves as expected (i.e. O(1) instead of O(N)).
|
19
|
-
|
20
|
-
Example:
|
21
|
-
|
22
|
-
```ruby
|
23
|
-
context "N+1", :n_plus_one do
|
24
|
-
populate { |n| create_list(:post, n) }
|
25
|
-
|
26
|
-
specify do
|
27
|
-
expect { get :index }.to perform_constant_number_of_queries
|
28
|
-
end
|
29
|
-
end
|
30
|
-
```
|
31
|
-
}
|
32
|
-
spec.homepage = "http://github.com/palkan/n_plus_one_control"
|
33
|
-
spec.license = "MIT"
|
34
|
-
|
35
|
-
spec.files = `git ls-files`.split($/)
|
36
|
-
spec.require_paths = ["lib"]
|
37
|
-
|
38
|
-
spec.add_development_dependency "bundler", "~> 1.10"
|
39
|
-
spec.add_development_dependency "rake", "~> 10.0"
|
40
|
-
spec.add_development_dependency "rspec", "~> 3.5"
|
41
|
-
spec.add_development_dependency "minitest", "~> 5.9"
|
42
|
-
spec.add_development_dependency "factory_girl", "~> 4.8.0"
|
43
|
-
spec.add_development_dependency "rubocop", "~> 0.49"
|
44
|
-
spec.add_development_dependency "activerecord", "~> 5.1"
|
45
|
-
spec.add_development_dependency "sqlite3"
|
46
|
-
spec.add_development_dependency "pry-byebug"
|
47
|
-
end
|
@@ -1,65 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require "spec_helper"
|
4
|
-
|
5
|
-
describe NPlusOneControl::Executor do
|
6
|
-
let(:populate) do
|
7
|
-
->(n) { create_list(:post, n) }
|
8
|
-
end
|
9
|
-
|
10
|
-
let(:observable) do
|
11
|
-
-> { Post.find_each(&:user) }
|
12
|
-
end
|
13
|
-
|
14
|
-
it "raises when block is missing" do
|
15
|
-
expect { described_class.call(population: populate) }
|
16
|
-
.to raise_error(ArgumentError, "Block is required!")
|
17
|
-
end
|
18
|
-
|
19
|
-
it "raises when populate is missing" do
|
20
|
-
expect { described_class.call(&observable) }
|
21
|
-
.to raise_error(ArgumentError, /population/)
|
22
|
-
end
|
23
|
-
|
24
|
-
it "returns correct counts for default scales" do
|
25
|
-
result = described_class.call(
|
26
|
-
population: populate,
|
27
|
-
&observable
|
28
|
-
)
|
29
|
-
|
30
|
-
expect(result.size).to eq 2
|
31
|
-
expect(result.first[0]).to eq 2
|
32
|
-
expect(result.first[1].size).to eq 3
|
33
|
-
expect(result.last[0]).to eq 3
|
34
|
-
expect(result.last[1].size).to eq 4
|
35
|
-
end
|
36
|
-
|
37
|
-
it "returns correct counts for custom scales" do
|
38
|
-
result = described_class.call(
|
39
|
-
population: populate,
|
40
|
-
scale_factors: [5, 10, 100],
|
41
|
-
&observable
|
42
|
-
)
|
43
|
-
|
44
|
-
expect(result.size).to eq 3
|
45
|
-
expect(result.first[0]).to eq 5
|
46
|
-
expect(result.first[1].size).to eq 6
|
47
|
-
expect(result.second[0]).to eq 10
|
48
|
-
expect(result.second[1].size).to eq 11
|
49
|
-
expect(result.last[0]).to eq 100
|
50
|
-
expect(result.last[1].size).to eq 101
|
51
|
-
end
|
52
|
-
|
53
|
-
it "returns correct counts with custom match" do
|
54
|
-
result = described_class.call(
|
55
|
-
population: populate,
|
56
|
-
matching: /users/,
|
57
|
-
&observable
|
58
|
-
)
|
59
|
-
|
60
|
-
expect(result.first[0]).to eq 2
|
61
|
-
expect(result.first[1].size).to eq 2
|
62
|
-
expect(result.last[0]).to eq 3
|
63
|
-
expect(result.last[1].size).to eq 3
|
64
|
-
end
|
65
|
-
end
|
@@ -1,113 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require "spec_helper"
|
4
|
-
|
5
|
-
describe NPlusOneControl::RSpec do
|
6
|
-
context "when no N+1", :n_plus_one do
|
7
|
-
populate { |n| create_list(:post, n) }
|
8
|
-
|
9
|
-
specify do
|
10
|
-
expect { Post.preload(:user).find_each { |p| p.user.name } }
|
11
|
-
.to perform_constant_number_of_queries
|
12
|
-
end
|
13
|
-
end
|
14
|
-
|
15
|
-
context "when has N+1", :n_plus_one do
|
16
|
-
populate { |n| create_list(:post, n) }
|
17
|
-
|
18
|
-
specify do
|
19
|
-
expect do
|
20
|
-
expect { Post.find_each { |p| p.user.name } }
|
21
|
-
.to perform_constant_number_of_queries
|
22
|
-
end.to raise_error(RSpec::Expectations::ExpectationNotMetError)
|
23
|
-
end
|
24
|
-
end
|
25
|
-
|
26
|
-
context "when context is missing" do
|
27
|
-
specify do
|
28
|
-
expect do
|
29
|
-
expect { subject }.to perform_constant_number_of_queries
|
30
|
-
end.to raise_error(/missing tag/i)
|
31
|
-
end
|
32
|
-
end
|
33
|
-
|
34
|
-
context "when populate is missing", :n_plus_one do
|
35
|
-
specify do
|
36
|
-
expect do
|
37
|
-
expect { subject }.to perform_constant_number_of_queries
|
38
|
-
end.to raise_error(/please provide populate/i)
|
39
|
-
end
|
40
|
-
end
|
41
|
-
|
42
|
-
context "when negated" do
|
43
|
-
specify do
|
44
|
-
expect do
|
45
|
-
expect { subject }.not_to perform_constant_number_of_queries
|
46
|
-
end.to raise_error(/support negation/i)
|
47
|
-
end
|
48
|
-
end
|
49
|
-
|
50
|
-
context "when verbose", :n_plus_one do
|
51
|
-
populate { |n| create_list(:post, n) }
|
52
|
-
|
53
|
-
around(:each) do |ex|
|
54
|
-
NPlusOneControl.verbose = true
|
55
|
-
ex.run
|
56
|
-
NPlusOneControl.verbose = false
|
57
|
-
end
|
58
|
-
|
59
|
-
specify do
|
60
|
-
expect do
|
61
|
-
expect { Post.find_each { |p| p.user.name } }
|
62
|
-
.to perform_constant_number_of_queries
|
63
|
-
end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /select .+ from/i)
|
64
|
-
end
|
65
|
-
end
|
66
|
-
|
67
|
-
context "with scale_factors", :n_plus_one do
|
68
|
-
populate { |n| create_list(:post, n) }
|
69
|
-
|
70
|
-
specify do
|
71
|
-
expect { Post.find_each { |p| p.user.name } }
|
72
|
-
.to perform_constant_number_of_queries.with_scale_factors(1, 1)
|
73
|
-
end
|
74
|
-
end
|
75
|
-
|
76
|
-
context "with matching", :n_plus_one do
|
77
|
-
populate { |n| create_list(:post, n) }
|
78
|
-
|
79
|
-
specify do
|
80
|
-
expect { Post.find_each { |p| p.user.name } }
|
81
|
-
.to perform_constant_number_of_queries.matching(/posts/)
|
82
|
-
end
|
83
|
-
end
|
84
|
-
|
85
|
-
context 'with warming up', :n_plus_one do
|
86
|
-
let(:cache) { double "cache" }
|
87
|
-
|
88
|
-
before do
|
89
|
-
allow(cache).to receive(:setup).and_return(:result)
|
90
|
-
allow(NPlusOneControl::Executor).to receive(:call) { raise StandardError }
|
91
|
-
end
|
92
|
-
|
93
|
-
populate { |n| create_list(:post, n) }
|
94
|
-
|
95
|
-
warmup { cache.setup }
|
96
|
-
|
97
|
-
it "runs warmup before calling Executor" do
|
98
|
-
expect(cache).to receive(:setup)
|
99
|
-
expect do
|
100
|
-
expect { Post.find_each(&:id) }.to perform_constant_number_of_queries
|
101
|
-
end.to raise_error StandardError
|
102
|
-
end
|
103
|
-
end
|
104
|
-
|
105
|
-
context 'with_warming_up', :n_plus_one do
|
106
|
-
populate { |n| create_list(:post, n) }
|
107
|
-
|
108
|
-
it "runs actual one more time" do
|
109
|
-
expect(Post).to receive(:all).exactly(3).times
|
110
|
-
expect { Post.all }.to perform_constant_number_of_queries.with_warming_up
|
111
|
-
end
|
112
|
-
end
|
113
|
-
end
|
data/spec/spec_helper.rb
DELETED
@@ -1,30 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
|
4
|
-
require "n_plus_one_control/rspec"
|
5
|
-
require "benchmark"
|
6
|
-
require "active_record"
|
7
|
-
require "factory_girl"
|
8
|
-
require "pry-byebug"
|
9
|
-
|
10
|
-
ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
|
11
|
-
|
12
|
-
Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
|
13
|
-
|
14
|
-
RSpec.configure do |config|
|
15
|
-
config.mock_with :rspec
|
16
|
-
|
17
|
-
config.order = :random
|
18
|
-
config.filter_run focus: true
|
19
|
-
config.run_all_when_everything_filtered = true
|
20
|
-
|
21
|
-
config.include FactoryGirl::Syntax::Methods
|
22
|
-
|
23
|
-
config.before(:each) do
|
24
|
-
ActiveRecord::Base.connection.begin_transaction(joinable: false)
|
25
|
-
end
|
26
|
-
|
27
|
-
config.after(:each) do
|
28
|
-
ActiveRecord::Base.connection.rollback_transaction
|
29
|
-
end
|
30
|
-
end
|
data/spec/support/post.rb
DELETED
@@ -1,19 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
ActiveRecord::Schema.define do
|
4
|
-
create_table :posts do |t|
|
5
|
-
t.string :title
|
6
|
-
t.integer :user_id
|
7
|
-
end
|
8
|
-
end
|
9
|
-
|
10
|
-
class Post < ActiveRecord::Base
|
11
|
-
belongs_to :user
|
12
|
-
end
|
13
|
-
|
14
|
-
FactoryGirl.define do
|
15
|
-
factory :post do
|
16
|
-
title "Title"
|
17
|
-
user
|
18
|
-
end
|
19
|
-
end
|
data/spec/support/user.rb
DELETED
@@ -1,17 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
ActiveRecord::Schema.define do
|
4
|
-
create_table :users do |t|
|
5
|
-
t.string :name
|
6
|
-
end
|
7
|
-
end
|
8
|
-
|
9
|
-
class User < ActiveRecord::Base
|
10
|
-
has_many :posts
|
11
|
-
end
|
12
|
-
|
13
|
-
FactoryGirl.define do
|
14
|
-
factory :user do
|
15
|
-
name "John"
|
16
|
-
end
|
17
|
-
end
|