Module: TestProf::FactoryDoctor

Extended by:
Logging
Defined in:
lib/test_prof/factory_doctor.rb,
lib/test_prof/factory_doctor/rspec.rb,
lib/test_prof/factory_doctor/fabrication_patch.rb,
lib/test_prof/factory_doctor/factory_bot_patch.rb

Overview

FactoryDoctor is a tool that helps you identify tests that perform unnecessary database queries.

Defined Under Namespace

Modules: FabricationPatch, FactoryBotPatch Classes: Configuration, RSpecListener, Result

Constant Summary collapse

IGNORED_QUERIES_PATTERN = 
%r{(
  pg_table|
  pg_attribute|
  pg_namespace|
  show\stables|
  show\ssearch_path|
  pragma|
  sqlite_master/rollback|
  \ATRUNCATE TABLE|
  \AALTER TABLE|
  \ABEGIN|
  \ACOMMIT|
  \AROLLBACK|
  \ARELEASE|
  \ASAVEPOINT
)}xi.freeze

Constants included from Logging

Logging::COLORS

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Logging

log

Class Attribute Details

.count ⇒ Object (readonly)

Returns the value of attribute count.



56
57
58
 
# File 'lib/test_prof/factory_doctor.rb', line 56

def count
  @count
end

.queries_count ⇒ Object (readonly)

Returns the value of attribute queries_count.



56
57
58
 
# File 'lib/test_prof/factory_doctor.rb', line 56

def queries_count
  @queries_count
end

.time ⇒ Object (readonly)

Returns the value of attribute time.



56
57
58
 
# File 'lib/test_prof/factory_doctor.rb', line 56

def time
  @time
end

Class Method Details

.config ⇒ Object 



58
59
60
 
# File 'lib/test_prof/factory_doctor.rb', line 58

def config
  @config ||= Configuration.new
end

.configure {|config| ... } ⇒ Object

Yields:



62
63
64
 
# File 'lib/test_prof/factory_doctor.rb', line 62

def configure
  yield config
end

.ignore ⇒ Object

Do not analyze code within the block



107
108
109
110
111
112
 
# File 'lib/test_prof/factory_doctor.rb', line 107

def ignore
  @ignored = true
  yield
ensure
  @ignored = false
end

.ignore! ⇒ Object 



114
115
116
 
# File 'lib/test_prof/factory_doctor.rb', line 114

def ignore!
  @ignored = true
end

.ignore? ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/test_prof/factory_doctor.rb', line 118

def ignore?
  @ignored == true
end

.init ⇒ Object

Patch factory lib, init counters



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/test_prof/factory_doctor.rb', line 67

def init
  reset!

  @running = false

  log :info, "FactoryDoctor enabled (event: \"#{config.event}\", threshold: #{config.threshold})"

  # Monkey-patch FactoryBot
  TestProf::FactoryBot::FactoryRunner.prepend(FactoryBotPatch) if
    defined?(TestProf::FactoryBot)

  # Monkey-patch Fabrication
  ::Fabricate.singleton_class.prepend(FabricationPatch) if
    defined?(::Fabricate)

  subscribe!

  @stamp = ENV["FDOC_STAMP"]

  RSpecStamp.config.tags = @stamp if stamp?
end

.result ⇒ Object 



102
103
104
 
# File 'lib/test_prof/factory_doctor.rb', line 102

def result
  Result.new(count, time, queries_count)
end

.stamp? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/test_prof/factory_doctor.rb', line 89

def stamp?
  !@stamp.nil?
end

.start ⇒ Object 



93
94
95
96
 
# File 'lib/test_prof/factory_doctor.rb', line 93

def start
  reset!
  @running = true
end

.stop ⇒ Object 



98
99
100
 
# File 'lib/test_prof/factory_doctor.rb', line 98

def stop
  @running = false
end

.within_factory(strategy) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/test_prof/factory_doctor.rb', line 122

def within_factory(strategy)
  return yield if ignore? || !running? || (strategy != :create)

  begin
    ts = TestProf.now if @depth.zero?
    @depth += 1
    @count += 1
    yield
  ensure
    @depth -= 1

    @time += (TestProf.now - ts) if @depth.zero?
  end
end