Module: EventSystem

Defined in:

lib/event_system.rb,
lib/event_system/event.rb,
lib/event_system/version.rb,
lib/event_system/storage/base.rb,
lib/event_system/configuration.rb,
lib/event_system/event_manager.rb,
lib/event_system/event_subscriber.rb,
lib/event_system/storage/file_store.rb,
lib/event_system/storage/memory_store.rb,
lib/event_system/visualization/timeline_generator.rb

Defined Under Namespace

Modules: EventSubscriber, Storage, Visualization Classes: Configuration, Error, Event, EventManager

Constant Summary

VERSION =

"0.1.0"

Class Method Summary

• .create_event(type, source = nil, data = {}) ⇒ EventSystem::Event

  Create a new event.

• .create_manager(config = nil) ⇒ EventSystem::EventManager

  Create a new event manager with default configuration.

• .version ⇒ String

  Get the current version.

Class Method Details

.create_event(type, source = nil, data = {}) ⇒ EventSystem::Event

Create a new event

Parameters:

• type (String, Symbol) —

  The event type

• source (Object) (defaults to: nil) —

  The event source

• data (Hash) (defaults to: {}) —

  Event data

Returns:

• (EventSystem::Event) —

  A new event instance

# File 'lib/event_system.rb', line 28

def self.create_event(type, source = nil, data = {})
  Event.new(type, source, data)
end

.create_manager(config = nil) ⇒ EventSystem::EventManager

Create a new event manager with default configuration

Parameters:

• config (Hash, EventSystem::Configuration, nil) (defaults to: nil) —

  Configuration options

Returns:

• (EventSystem::EventManager) —

  A new event manager instance

# File 'lib/event_system.rb', line 19

def self.create_manager(config = nil)
  EventManager.new(config)
end

.version ⇒ String

Get the current version

Returns:

• (String) —

  The current version

# File 'lib/event_system.rb', line 34

def self.version
  VERSION
end