-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enforce event registration #4226
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
# frozen_string_literal: true | ||
|
||
module Spree | ||
module Event | ||
# Registry of known events | ||
# | ||
# @api privte | ||
class Registry | ||
class Registration | ||
attr_reader :event_name, :caller_location | ||
|
||
def initialize(event_name:, caller_location:) | ||
@event_name = event_name | ||
@caller_location = caller_location | ||
end | ||
end | ||
|
||
attr_reader :registrations | ||
|
||
def initialize(registrations: []) | ||
@registrations = registrations | ||
end | ||
|
||
def register(event_name, caller_location: caller_locations(1)[0]) | ||
registration = registration(event_name) | ||
if registration | ||
raise <<~MSG | ||
Can't register #{event_name} event as it's already registered. | ||
|
||
The registration happened at: | ||
|
||
#{registration.caller_location} | ||
MSG | ||
else | ||
@registrations << Registration.new(event_name: event_name, caller_location: caller_location) | ||
end | ||
end | ||
|
||
def unregister(event_name) | ||
raise <<~MSG unless registered?(event_name) | ||
#{event_name} is not registered. | ||
|
||
Known events are: | ||
|
||
'#{event_names.join("' '")}' | ||
MSG | ||
|
||
@registrations.delete_if { |regs| regs.event_name == event_name } | ||
end | ||
|
||
def registration(event_name) | ||
registrations.find { |reg| reg.event_name == event_name } | ||
end | ||
|
||
def registered?(event_name) | ||
!registration(event_name).nil? | ||
end | ||
|
||
def event_names | ||
registrations.map(&:event_name) | ||
end | ||
|
||
def check_event_name_registered(event_name) | ||
return true if registered?(event_name) | ||
|
||
raise <<~MSG | ||
'#{event_name}' is not registered as a valid event name. | ||
#{suggestions_message(event_name)} | ||
|
||
All known events are: | ||
|
||
'#{event_names.join(" ")}' | ||
|
||
You can register the new events at the end of the `spree.rb` | ||
initializer: | ||
|
||
Spree::Event.register('#{event_name}') | ||
MSG | ||
end | ||
|
||
private | ||
|
||
def suggestions(event_name) | ||
dictionary = DidYouMean::SpellChecker.new(dictionary: event_names) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
|
||
dictionary.correct(event_name) | ||
end | ||
|
||
def suggestions_message(event_name) | ||
DidYouMean::PlainFormatter.new.message_for(suggestions(event_name)) | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra blank line?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Removed.