Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix ordering events description #3293

Merged
merged 2 commits into from
Jul 5, 2023
Merged

Fix ordering events description #3293

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b66b5b
Fix indentation of the Ordering Events description
knu Jul 5, 2023
b682c1f
Reformat the code with rubocop
knu Jul 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 14 additions & 9 deletions app/concerns/sortable_events.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ def description_events_order(*args)
module ClassMethods
def can_order_created_events!
raise 'Cannot order events for agent that cannot create events' if cannot_create_events?

prepend AutomaticSorter
end

Expand All @@ -27,7 +28,7 @@ def cannot_order_created_events?
end

def description_events_order(events = EVENTS_DESCRIPTION, events_order_key = EVENTS_ORDER_KEY)
<<-MD.lstrip
<<~MD
To specify the order of #{events}, set `#{events_order_key}` to an array of sort keys, each of which looks like either `expression` or `[expression, type, descending]`, as described as follows:

* _expression_ is a Liquid template to generate a string to be used as sort key.
Expand Down Expand Up @@ -75,8 +76,8 @@ def create_events(events)
count = events.count
events.each.with_index(1) do |event, position|
event.payload[:sort_info] = {
position: position,
count: count
position:,
count:
}
create_event(event)
end
Expand All @@ -90,13 +91,15 @@ def create_events(events)
module AutomaticSorter
def check
return super unless events_order || include_sort_info?

sorting_events do
super
end
end

def receive(incoming_events)
return super unless events_order || include_sort_info?

# incoming events should be processed sequentially
incoming_events.each do |event|
sorting_events do
Expand All @@ -121,17 +124,18 @@ def sorting_events(&block)
@sortable_events = []
yield
ensure
events, @sortable_events = sort_events(@sortable_events), nil
events = sort_events(@sortable_events)
@sortable_events = nil
create_events(events)
end
end

private

EXPRESSION_PARSER = {
'string' => ->string { string },
'number' => ->string { string.to_f },
'time' => ->string { Time.zone.parse(string) },
'string' => ->(string) { string },
'number' => ->(string) { string.to_f },
'time' => ->(string) { Time.zone.parse(string) },
}
EXPRESSION_TYPES = EXPRESSION_PARSER.keys.freeze

Expand All @@ -153,7 +157,8 @@ def validate_events_order(events_order_key = EVENTS_ORDER_KEY)
when nil, *EXPRESSION_TYPES
# ok
else
errors.add(:base, "second element of each #{events_order_key} tuple must be #{EXPRESSION_TYPES.to_sentence(last_word_connector: ' or ')}")
errors.add(:base,
"second element of each #{events_order_key} tuple must be #{EXPRESSION_TYPES.to_sentence(last_word_connector: ' or ')}")
break
end
if !desc.nil? && boolify(desc).nil?
Expand Down Expand Up @@ -181,7 +186,7 @@ def sort_events(events, events_order_key = EVENTS_ORDER_KEY)
string = interpolate_string(expression)
begin
EXPRESSION_PARSER[type || 'string'.freeze][string]
rescue
rescue StandardError
error "Cannot parse #{string.inspect} as #{type}; treating it as string"
string
end
Expand Down