Class: PgEventstore::Event

Inherits:

Object

• Object
• PgEventstore::Event

Includes:

PgEventstore::Extensions::OptionsExtension

Defined in:

lib/pg_eventstore/event.rb,
sig/pg_eventstore/event.rbs

Constant Summary

LINK_TYPE =

Returns a type of link event.

Returns:

• (String) —

  a type of link event

'$>'

SYSTEM_SYMBOL =

Returns:

• (String)

"\u2592"

MARKERS_METADATA_KEY =

Returns:

• (String)

"#{SYSTEM_SYMBOL}m".freeze

PRIMARY_TABLE_NAME =

Returns:

• (String)

'events'

NON_EXISTING_EVENT_REVISION =

Returns:

• (Integer)

-1

SYSTEM_KEY_PREFIX =

Returns:

• (String)

Instance Attribute Summary

• #causation_id ⇒ String^?

  UUIDv7.

• #caused_by ⇒ PgEventstore::Event^?
• #correlation_id ⇒ String^?

  UUIDv7.

• #created_at ⇒ Time^?

  A timestamp an event was created at.

• #data ⇒ Hash

  Event's data.

• #feature_markers ⇒ Array<FeatureMarker>

  Feature-specific markers that can't be put under #markers.

• #global_position ⇒ Integer

  Event's position in "all" stream.

• #id ⇒ String

  UUIDv7.

• #link ⇒ PgEventstore::Event^?

  When resolve_link_tos: true option is provided during the read of events and event is a link event - this attribute will be pointing on that link.

• #link_global_position ⇒ Integer^?

  Global_position of an event the current event points to.

• #link_partition_id ⇒ Integer^?

  A partition id of an event the link event points to.

• #markers ⇒ Array<String>

  Event markers.

• #metadata ⇒ Hash

  Event's metadata.

• #stream ⇒ PgEventstore::Stream^?

  Event's stream.

• #stream_revision ⇒ Integer

  A revision of an event inside event's stream.

• #type ⇒ String

  Event type.

Instance Method Summary

• #==(other) ⇒ Boolean (also: #eql?)

  Implements comparison of PgEventstore::Event-s.

• #dup ⇒ self
• #hash ⇒ Integer
• #init_default_values ⇒ void
• #initialize ⇒ Event constructor

  A new instance of Event.

• #link? ⇒ Boolean

  Detect whether an event is a link event.

• #options_hash ⇒ ::Hash[untyped, untyped]
• #readonly! ⇒ Boolean
• #readonly? ⇒ Boolean
• #readonly_error ⇒ void
• #system? ⇒ Boolean

  Detect whether an event is a system event.

Methods included from PgEventstore::Extensions::OptionsExtension

included

Constructor Details

#initialize ⇒ Event

Returns a new instance of Event.

Parameters:

• options (Object)

# File 'sig/pg_eventstore/event.rbs', line 18

def initialize: (**untyped options) -> void

Instance Attribute Details

#causation_id ⇒ String^?

Returns UUIDv7.

Parameters:

• value (String, nil)

Returns:

• (String, nil) —

  UUIDv7

# File 'lib/pg_eventstore/event.rb', line 68

attribute(:causation_id)

#caused_by ⇒ PgEventstore::Event^?

Parameters:

• value (Event, nil)

Returns:

• (PgEventstore::Event, nil)

# File 'lib/pg_eventstore/event.rb', line 62

attribute(:caused_by)

#correlation_id ⇒ String^?

Returns UUIDv7.

Parameters:

• value (String, nil)

Returns:

• (String, nil) —

  UUIDv7

# File 'lib/pg_eventstore/event.rb', line 65

attribute(:correlation_id)

#created_at ⇒ Time^?

Returns a timestamp an event was created at.

Parameters:

• value (Time, nil)

Returns:

• (Time, nil) —

  a timestamp an event was created at

# File 'lib/pg_eventstore/event.rb', line 59

attribute(:created_at)

#data ⇒ Hash

Returns event's data.

Parameters:

• value (::Hash[untyped, untyped])

Returns:

• (Hash) —

  event's data

# File 'lib/pg_eventstore/event.rb', line 35

attribute(:data) { {} }

#feature_markers ⇒ Array<FeatureMarker>

Returns feature-specific markers that can't be put under #markers.

Parameters:

• value (::Array[FeatureMarker])

Returns:

• (Array<FeatureMarker>) —

  feature-specific markers that can't be put under #markers

# File 'lib/pg_eventstore/event.rb', line 41

attribute(:feature_markers) { [] }

#global_position ⇒ Integer

Returns event's position in "all" stream.

Parameters:

• value (Integer, nil)

Returns:

• (Integer) —

  event's position in "all" stream

# File 'lib/pg_eventstore/event.rb', line 26

attribute(:global_position)

#id ⇒ String

Returns UUIDv7.

Parameters:

• value (String, nil)

Returns:

• (String) —

  UUIDv7

# File 'lib/pg_eventstore/event.rb', line 20

attribute(:id) { SecureRandom.uuid_v7 }

#link ⇒ PgEventstore::Event^?

Returns when resolve_link_tos: true option is provided during the read of events and event is a link event - this attribute will be pointing on that link.

Parameters:

• value (Event, nil)

Returns:

• (PgEventstore::Event, nil) —

  when resolve_link_tos: true option is provided during the read of events and event is a link event - this attribute will be pointing on that link

# File 'lib/pg_eventstore/event.rb', line 56

attribute(:link)

#link_global_position ⇒ Integer^?

Returns global_position of an event the current event points to. If it is not nil, then the current event is a link.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil) —

  global_position of an event the current event points to. If it is not nil, then the current event is a link

# File 'lib/pg_eventstore/event.rb', line 48

attribute(:link_global_position)

#link_partition_id ⇒ Integer^?

Returns a partition id of an event the link event points to. It is used to load original event when resolve_link_tos: true option is provided when reading events.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil) —

  a partition id of an event the link event points to. It is used to load original event when resolve_link_tos: true option is provided when reading events.

# File 'lib/pg_eventstore/event.rb', line 52

attribute(:link_partition_id)

#markers ⇒ Array<String>

Returns event markers.

Parameters:

• value (::Array[String])

Returns:

• (Array<String>) —

  event markers

# File 'lib/pg_eventstore/event.rb', line 38

attribute(:markers) { [] }

#metadata ⇒ Hash

Returns event's metadata.

Parameters:

• value (::Hash[untyped, untyped])

Returns:

• (Hash) —

  event's metadata

# File 'lib/pg_eventstore/event.rb', line 44

attribute(:metadata) { {} }

#stream ⇒ PgEventstore::Stream^?

Returns event's stream.

Parameters:

• value (Stream, nil)

Returns:

• (PgEventstore::Stream, nil) —

  event's stream

# File 'lib/pg_eventstore/event.rb', line 29

attribute(:stream)

#stream_revision ⇒ Integer

Returns a revision of an event inside event's stream.

Parameters:

• value (Integer, nil)

Returns:

• (Integer) —

  a revision of an event inside event's stream

# File 'lib/pg_eventstore/event.rb', line 32

attribute(:stream_revision)

#type ⇒ String

Returns event type.

Parameters:

• value (String)

Returns:

• (String) —

  event type

# File 'lib/pg_eventstore/event.rb', line 23

attribute(:type) { self.class.name }

Instance Method Details

#==(other) ⇒ Boolean Also known as: eql?

Implements comparison of PgEventstore::Event-s. Two events matches if all of their attributes matches

Parameters:

• other (Object, PgEventstore::Event)

Returns:

• (Boolean)

# File 'lib/pg_eventstore/event.rb', line 73

def ==(other)
  return false unless other.is_a?(PgEventstore::Event)

  attributes_hash.except(:link) == other.attributes_hash.except(:link)
end

#dup ⇒ self

Returns:

• (self)

# File 'lib/pg_eventstore/event.rb', line 98

def dup
  self.class.new(**Utils.deep_dup(options_hash))
end

#hash ⇒ Integer

Returns:

• (Integer)

# File 'lib/pg_eventstore/event.rb', line 87

def hash
  attributes_hash.except(:link).hash
end

#init_default_values ⇒ void

This method returns an undefined value.

Parameters:

• options (::Hash[untyped, untyped])

# File 'sig/pg_eventstore/event.rbs', line 28

def init_default_values: (::Hash[untyped, untyped] options) -> void

#link? ⇒ Boolean

Detect whether an event is a link event

Returns:

• (Boolean)

# File 'lib/pg_eventstore/event.rb', line 82

def link?
  !link_global_position.nil?
end

#options_hash ⇒ ::Hash[untyped, untyped]

Returns:

• (::Hash[untyped, untyped])

# File 'sig/pg_eventstore/event.rbs', line 20

def options_hash: () -> ::Hash[untyped, untyped]

#readonly! ⇒ Boolean

Parameters:

• opt_name (Symbol)

Returns:

• (Boolean)

# File 'sig/pg_eventstore/event.rbs', line 22

def readonly!: (Symbol opt_name) -> bool

#readonly? ⇒ Boolean

Parameters:

• opt_name (Symbol)

Returns:

• (Boolean)

# File 'sig/pg_eventstore/event.rbs', line 24

def readonly?: (Symbol opt_name) -> bool

#readonly_error ⇒ void

This method returns an undefined value.

Parameters:

• opt_name (Symbol)

# File 'sig/pg_eventstore/event.rbs', line 26

def readonly_error: (Symbol opt_name) -> void

#system? ⇒ Boolean

Detect whether an event is a system event

Returns:

• (Boolean)

# File 'lib/pg_eventstore/event.rb', line 93

def system?
  type.start_with?('$')
end