1
0
Fork 0
mirror of https://github.com/thoughtbot/factory_bot.git synced 2022-11-09 11:43:51 -05:00
thoughtbot--factory_bot/lib/factory_bot/registry.rb
Christian Bruckmayer b86ec136b6
Raise KeyError instead of ArgumentError in Registry
to make use of did_you_mean gem.

The did_you_mean gem only supports NameError, NoMethodError
and KeyError. However, for NameError the message does also need
to match a certain format and we can not use a custom message
like 'Factory not registered ...'. Therefore using KeyError
is to only logical conclusion.

The did_you_mean gem makes use of the receiver attributes, but
in Ruby > 2.5 it is not possible to set the receiver and key attributes
on a KeyError (they are only set when the KeyError is raised in C).
We explored monkey patching KeyError for earlier versions of Ruby, but
it was a problematic solution.

Instead we can rescue the original KeyError, take the message from it,
which will already include the did_you_mean message, then customize
the message and re-raise a new KeyError with that customized message.
Starting in Ruby 2.6 this will not be necessary anymore
https://bugs.ruby-lang.org/issues/14313, so maybe we can get rid of it
for FactoryBot 6 or 7.

Fixes #992

Co-authored-by: Daniel Colson <danieljamescolson@gmail.com>
2018-12-16 22:25:04 -05:00

47 lines
905 B
Ruby

require "active_support/core_ext/hash/indifferent_access"
module FactoryBot
class Registry
include Enumerable
attr_reader :name
def initialize(name)
@name = name
@items = ActiveSupport::HashWithIndifferentAccess.new
end
def clear
@items.clear
end
def each(&block)
@items.values.uniq.each(&block)
end
def find(name)
@items.fetch(name)
rescue KeyError => key_error
raise key_error_with_custom_message(key_error)
end
alias :[] :find
def register(name, item)
@items[name] = item
end
def registered?(name)
@items.key?(name)
end
private
def key_error_with_custom_message(key_error)
message = key_error.message.sub("key not found", "#{@name} not registered")
error = KeyError.new(message)
error.set_backtrace(key_error.backtrace)
error
end
end
end