Module: SolidusSupport::LegacyEventCompat::Bus

Defined in:
lib/solidus_support/legacy_event_compat/bus.rb

Overview

Compatibility for some event-driven operations

Class Method Summary collapse

Class Method Details

.publish(event_name, **payload) ⇒ Object

Publication of an event

If extensions want to support the legacy sytem, they need to use a compatible API. That means it’s not possible to publish an instance as event, which is something supported by Omnes but not the legacy adapter. Instead, a payload can be given. E.g.:

“‘ SolidusSupport::LegacyEventCompat::Bus.publish(:foo, bar: :baz) “`

Legacy subscribers will receive an ‘ActiveSupport::Notifications::Fanout`, while omnes subscribers will get an `Omnes::UnstructuredEvent`. Both instances are compatible as they implement a `#payload` method.

Parameters:

  • event_name (Symbol)
  • payload (Hash<Symbol, Any>) 


25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/solidus_support/legacy_event_compat/bus.rb', line 25

def self.publish(event_name, **payload)
  SolidusSupport.deprecator.warn(
    "SolidusSupport::LegacyEventCompat::Bus is deprecated and will be removed in solidus_support 1.0." \
    " Please use Spree::Bus.publish instead."
  )
  if SolidusSupport::LegacyEventCompat.using_legacy?
    Spree::Event.fire(event_name, payload)
  else
    Spree::Bus.publish(event_name, **payload, caller_location: caller_locations(1)[0])
  end
end