1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
|
# frozen_string_literal: true
require "test_prof"
require_relative "./before_all"
module TestProf
# Just like `let`, but persist the result for the whole group.
# NOTE: Experimental and magical, for more control use `before_all`.
module LetItBe
class Configuration
# Define an alias for `let_it_be` with the predefined options:
#
# TestProf::LetItBe.configure do |config|
# config.alias_to :let_it_be_reloaded, reload: true
# end
def alias_to(name, **default_args)
LetItBe.define_let_it_be_alias(name, **default_args)
end
def register_modifier(key, &block)
raise ArgumentError, "Modifier #{key} is already defined for let_it_be" if LetItBe.modifiers.key?(key)
LetItBe.modifiers[key] = block
end
def default_modifiers
@default_modifiers ||= {}
end
end
class << self
def config
@config ||= Configuration.new
end
def configure
yield config
end
def modifiers
@modifiers ||= {}
end
def wrap_with_modifiers(mods, &block)
return block if mods.empty?
validate_modifiers! mods
-> {
record = instance_eval(&block)
mods.inject(record) do |rec, (k, v)|
LetItBe.modifiers.fetch(k).call(rec, v)
end
}
end
def module_for(group)
modules[group] ||= begin
Module.new.tap { |mod| group.prepend(mod) }
end
end
private
def modules
@modules ||= {}
end
def validate_modifiers!(mods)
unknown = mods.keys - modifiers.keys
return if unknown.empty?
raise ArgumentError, "Unknown let_it_be modifiers were used: #{unknown.join(", ")}. " \
"Available modifiers are: #{modifiers.keys.join(", ")}"
end
end
# Use uniq prefix for instance variables to avoid collisions
# We want to use the power of Ruby's unicode support)
# And we love cats!)
PREFIX = RUBY_ENGINE == "jruby" ? "@__jruby_is_not_cat_friendly__" : "@😸"
FROZEN_ERROR_HINT = "\nIf you are using `let_it_be`, you may want to pass `reload: true` or `refind: true` modifier to it."
def self.define_let_it_be_alias(name, **default_args)
define_method(name) do |identifier, **options, &blk|
let_it_be(identifier, **default_args.merge(options), &blk)
end
end
def let_it_be(identifier, **options, &block)
initializer = proc do
instance_variable_set(:"#{TestProf::LetItBe::PREFIX}#{identifier}", instance_exec(&block))
rescue FrozenError => e
e.message << TestProf::LetItBe::FROZEN_ERROR_HINT
raise
end
default_options = LetItBe.config.default_modifiers.dup
default_options.merge!(metadata[:let_it_be_modifiers]) if metadata[:let_it_be_modifiers]
options = default_options.merge(options)
before_all(&initializer)
let_accessor = LetItBe.wrap_with_modifiers(options) do
instance_variable_get(:"#{PREFIX}#{identifier}")
end
LetItBe.module_for(self).module_eval do
define_method(identifier) do
# Trying to detect the context (couldn't find other way so far)
if /\(:context\)/.match?(@__inspect_output)
instance_variable_get(:"#{PREFIX}#{identifier}")
else
# Fallback to let definition
super()
end
end
end
let(identifier, &let_accessor)
end
module Freezer
# Stoplist to prevent freezing objects and theirs associations that are defined
# with `let_it_be`'s `freeze: false` options during deep freezing.
#
# To only keep track of objects that are available in current example group,
# `begin` adds a new layer, and `rollback` removes a layer of unrelated objects
# along with rolling back the transaction where they were created.
#
# Stoplist holds records declared with `freeze: false` (so we do not freeze them even if they're used as
# associated records for frozen objects)
module Stoplist
class << self
def stop?(record)
@stoplist.any? { |layer| layer.include?(record) }
end
def stop!(record)
@stoplist.last.push(record)
end
def begin
@stoplist.push([])
end
def rollback
@stoplist.pop
end
end
# Stack of example group-related variable definitions
@stoplist = []
end
class << self
# Rerucsively freezes the object to detect modifications
def deep_freeze(record)
return if record.frozen?
return if Stoplist.stop?(record)
record.freeze
# Support `let_it_be` with `create_list`
return record.each { |rec| deep_freeze(rec) } if record.respond_to?(:each)
# Freeze associations as well.
return unless defined?(::ActiveRecord::Base)
return unless record.is_a?(::ActiveRecord::Base)
record.class.reflections.keys.each do |reflection|
# But only if they are already loaded. If not yet loaded, they weren't
# created by factories, and it's ok to mutate them.
next unless record.association(reflection.to_sym).loaded?
target = record.association(reflection.to_sym).target
deep_freeze(target) if target.is_a?(::ActiveRecord::Base) || target.respond_to?(:each)
end
end
end
end
end
end
if defined?(::ActiveRecord::Base)
require "test_prof/ext/active_record_refind"
using TestProf::Ext::ActiveRecordRefind
TestProf::LetItBe.configure do |config|
config.register_modifier :reload do |record, val|
next record unless val
next record.reload if record.is_a?(::ActiveRecord::Base)
if record.respond_to?(:map)
next record.map do |rec|
rec.is_a?(::ActiveRecord::Base) ? rec.reload : rec
end
end
record
end
config.register_modifier :refind do |record, val|
next record unless val
next record.refind if record.is_a?(::ActiveRecord::Base)
if record.respond_to?(:map)
next record.map do |rec|
rec.is_a?(::ActiveRecord::Base) ? rec.refind : rec
end
end
record
end
config.register_modifier :freeze do |record, val|
if val == false
TestProf::LetItBe::Freezer::Stoplist.stop!(record)
next record
end
TestProf::LetItBe::Freezer.deep_freeze(record)
record
end
end
end
RSpec::Core::ExampleGroup.extend TestProf::LetItBe
TestProf::BeforeAll.configure do |config|
config.before(:begin) do
TestProf::LetItBe::Freezer::Stoplist.begin
end
config.after(:rollback) do
TestProf::LetItBe::Freezer::Stoplist.rollback
end
end
RSpec.configure do |config|
config.after(:example) do |example|
if example.exception&.is_a?(FrozenError)
example.exception.message << TestProf::LetItBe::FROZEN_ERROR_HINT
end
end
end
|