pg_eventstore 1.1.3 → 1.1.4

data/sig/pg/constants.rbs

@@ -0,0 +1,153 @@
+module PG
+  module Constants
+    CONNECTION_AUTH_OK: ::Integer
+
+    CONNECTION_AWAITING_RESPONSE: ::Integer
+
+    CONNECTION_BAD: ::Integer
+
+    CONNECTION_CHECK_STANDBY: ::Integer
+
+    CONNECTION_CHECK_TARGET: ::Integer
+
+    CONNECTION_CHECK_WRITABLE: ::Integer
+
+    CONNECTION_CONSUME: ::Integer
+
+    CONNECTION_GSS_STARTUP: ::Integer
+
+    CONNECTION_MADE: ::Integer
+
+    CONNECTION_NEEDED: ::Integer
+
+    CONNECTION_OK: ::Integer
+
+    CONNECTION_SETENV: ::Integer
+
+    CONNECTION_SSL_STARTUP: ::Integer
+
+    CONNECTION_STARTED: ::Integer
+
+    DEF_PGPORT: ::Integer
+
+    INVALID_OID: ::Integer
+
+    INV_READ: ::Integer
+
+    INV_WRITE: ::Integer
+
+    InvalidOid: ::Integer
+
+    PGRES_BAD_RESPONSE: ::Integer
+
+    PGRES_COMMAND_OK: ::Integer
+
+    PGRES_COPY_BOTH: ::Integer
+
+    PGRES_COPY_IN: ::Integer
+
+    PGRES_COPY_OUT: ::Integer
+
+    PGRES_EMPTY_QUERY: ::Integer
+
+    PGRES_FATAL_ERROR: ::Integer
+
+    PGRES_NONFATAL_ERROR: ::Integer
+
+    PGRES_PIPELINE_ABORTED: ::Integer
+
+    PGRES_PIPELINE_SYNC: ::Integer
+
+    PGRES_POLLING_FAILED: ::Integer
+
+    PGRES_POLLING_OK: ::Integer
+
+    PGRES_POLLING_READING: ::Integer
+
+    PGRES_POLLING_WRITING: ::Integer
+
+    PGRES_SINGLE_TUPLE: ::Integer
+
+    PGRES_TUPLES_OK: ::Integer
+
+    PG_DIAG_COLUMN_NAME: ::Integer
+
+    PG_DIAG_CONSTRAINT_NAME: ::Integer
+
+    PG_DIAG_CONTEXT: ::Integer
+
+    PG_DIAG_DATATYPE_NAME: ::Integer
+
+    PG_DIAG_INTERNAL_POSITION: ::Integer
+
+    PG_DIAG_INTERNAL_QUERY: ::Integer
+
+    PG_DIAG_MESSAGE_DETAIL: ::Integer
+
+    PG_DIAG_MESSAGE_HINT: ::Integer
+
+    PG_DIAG_MESSAGE_PRIMARY: ::Integer
+
+    PG_DIAG_SCHEMA_NAME: ::Integer
+
+    PG_DIAG_SEVERITY: ::Integer
+
+    PG_DIAG_SEVERITY_NONLOCALIZED: ::Integer
+
+    PG_DIAG_SOURCE_FILE: ::Integer
+
+    PG_DIAG_SOURCE_FUNCTION: ::Integer
+
+    PG_DIAG_SOURCE_LINE: ::Integer
+
+    PG_DIAG_SQLSTATE: ::Integer
+
+    PG_DIAG_STATEMENT_POSITION: ::Integer
+
+    PG_DIAG_TABLE_NAME: ::Integer
+
+    PQERRORS_DEFAULT: ::Integer
+
+    PQERRORS_SQLSTATE: ::Integer
+
+    PQERRORS_TERSE: ::Integer
+
+    PQERRORS_VERBOSE: ::Integer
+
+    PQPING_NO_ATTEMPT: ::Integer
+
+    PQPING_NO_RESPONSE: ::Integer
+
+    PQPING_OK: ::Integer
+
+    PQPING_REJECT: ::Integer
+
+    PQSHOW_CONTEXT_ALWAYS: ::Integer
+
+    PQSHOW_CONTEXT_ERRORS: ::Integer
+
+    PQSHOW_CONTEXT_NEVER: ::Integer
+
+    PQTRANS_ACTIVE: ::Integer
+
+    PQTRANS_IDLE: ::Integer
+
+    PQTRANS_INERROR: ::Integer
+
+    PQTRANS_INTRANS: ::Integer
+
+    PQTRANS_UNKNOWN: ::Integer
+
+    PQ_PIPELINE_ABORTED: ::Integer
+
+    PQ_PIPELINE_OFF: ::Integer
+
+    PQ_PIPELINE_ON: ::Integer
+
+    SEEK_CUR: ::Integer
+
+    SEEK_END: ::Integer
+
+    SEEK_SET: ::Integer
+  end
+end

data/sig/pg_eventstore/abstract_command.rbs

@@ -0,0 +1,11 @@
+module PgEventstore
+  class AbstractCommand
+    # _@param_ `queries`
+    def initialize: (PgEventstore::Queries queries) -> void
+
+    def call: () -> untyped
+
+    # Returns the value of attribute queries.
+    attr_accessor queries: PgEventstore::Queries
+  end
+end

data/sig/pg_eventstore/callbacks.rbs

@@ -0,0 +1,21 @@
+module PgEventstore
+  class Callbacks
+    def initialize: () -> void
+
+    # _@param_ `action` — an object, that represents your action. In most cases you want to use a symbol there
+    #
+    # _@param_ `filter` — callback filter. Supported values are :before, :after and :around
+    #
+    # _@param_ `callback`
+    def define_callback: (untyped action, Symbol filter, _Callback callback) -> void
+
+    # _@param_ `action` — an action to run
+    def run_callbacks: (untyped action, *untyped args, **untyped kwargs) ?{ () -> untyped } -> untyped
+
+    def run_before_callbacks: (untyped action, *untyped args, **untyped kwargs) -> void
+
+    def run_around_callbacks: (untyped action, *untyped args, **untyped kwargs) ?{ () -> untyped } -> untyped
+
+    def run_after_callbacks: (untyped action, *untyped args, **untyped kwargs) -> void
+  end
+end

data/sig/pg_eventstore/client.rbs

@@ -0,0 +1,67 @@
+module PgEventstore
+  class Client
+    # _@param_ `config`
+    def initialize: (PgEventstore::Config config) -> void
+
+    # _@param_ `stream`
+    #
+    # _@param_ `events_or_event`
+    #
+    # _@param_ `options`
+    #
+    # _@param_ `middlewares` — provide a list of middleware names to override a config's middlewares
+    def append_to_stream: (
+        PgEventstore::Stream stream,
+        (PgEventstore::Event | ::Array[PgEventstore::Event]) events_or_event,
+        ?options: ::Hash[untyped, untyped],
+        ?middlewares: ::Array[untyped]?
+      ) -> (PgEventstore::Event | ::Array[PgEventstore::Event])
+
+    def multiple: () { () -> untyped } -> untyped
+
+    # _@param_ `stream`
+    #
+    # _@param_ `options` — request options
+    #
+    # _@param_ `middlewares` — provide a list of middleware names to override a config's middlewares
+    def read: (PgEventstore::Stream stream, ?options: ::Hash[untyped, untyped], ?middlewares: ::Array[::Symbol]?) -> ::Array[PgEventstore::Event]
+
+    # _@param_ `stream`
+    #
+    # _@param_ `options` — request options
+    #
+    # _@param_ `middlewares`
+    #
+    # _@return_ — enumerator will yield PgEventstore::Event
+    def read_paginated: (PgEventstore::Stream stream, ?options: ::Hash[untyped, untyped], ?middlewares: ::Array[::Symbol]?) -> ::Enumerator[Array[PgEventstore::Event], void]
+
+    # _@param_ `stream`
+    #
+    # _@param_ `events_or_event`
+    #
+    # _@param_ `options`
+    #
+    # _@param_ `middlewares` — provide a list of middleware names to use. Defaults to empty array, meaning no middlewares will be applied to the "link" event
+    def link_to: (
+        PgEventstore::Stream stream,
+        (PgEventstore::Event | ::Array[PgEventstore::Event]) events_or_event,
+        ?options: ::Hash[untyped, untyped],
+        ?middlewares: ::Array[::Symbol]
+      ) -> (PgEventstore::Event | ::Array[PgEventstore::Event])
+
+    # _@param_ `middlewares`
+    def middlewares: (?::Array[::Symbol]? middlewares) -> ::Array[PgEventstore::Middleware]
+
+    def connection: () -> PgEventstore::Connection
+
+    def partition_queries: () -> PgEventstore::PartitionQueries
+
+    def transaction_queries: () -> PgEventstore::TransactionQueries
+
+    # _@param_ `middlewares`
+    def event_queries: (::Array[PgEventstore::Middleware] middlewares) -> PgEventstore::EventQueries
+
+    # Returns the value of attribute config.
+    attr_accessor config: PgEventstore::Config
+  end
+end

data/sig/pg_eventstore/commands/append.rbs

@@ -0,0 +1,33 @@
+module PgEventstore
+  module Commands
+    class Append < PgEventstore::AbstractCommand
+      # _@param_ `stream`
+      #
+      # _@param_ `events`
+      #
+      # _@param_ `options`
+      #
+      # _@param_ `event_modifier`
+      #
+      # _@return_ — persisted events
+      def call: (
+          PgEventstore::Stream stream,
+          *PgEventstore::Event events,
+          ?options: ::Hash[untyped, untyped],
+          ?event_modifier: _EventModifier
+        ) -> ::Array[PgEventstore::Event]
+
+      # _@param_ `stream`
+      #
+      # _@param_ `events`
+      def create_partitions: (PgEventstore::Stream stream, ::Array[PgEventstore::Event] events) -> void
+
+      # _@param_ `revision`
+      #
+      # _@param_ `expected_revision`
+      #
+      # _@param_ `stream`
+      def assert_expected_revision!: (Integer revision, (Symbol | Integer) expected_revision, PgEventstore::Stream stream) -> void
+    end
+  end
+end

data/sig/pg_eventstore/commands/event_modifiers/prepare_link_event.rbs

@@ -0,0 +1,24 @@
+module PgEventstore
+  module Commands
+    module EventModifiers
+      class PrepareLinkEvent
+        # _@param_ `partition_queries`
+        def initialize: (PgEventstore::PartitionQueries partition_queries) -> void
+
+        # _@param_ `event`
+        #
+        # _@param_ `revision`
+        def call: (PgEventstore::Event event, Integer revision) -> PgEventstore::Event
+
+        # _@param_ `event` — persisted event
+        #
+        # _@return_ — partition id
+        def partition_id: (PgEventstore::Event event) -> Integer
+
+        attr_reader partition_queries: PgEventstore::PartitionQueries
+
+        attr_reader partitions: Hash[untyped, untyped]
+      end
+    end
+  end
+end

data/sig/pg_eventstore/commands/event_modifiers/prepare_regular_event.rbs

@@ -0,0 +1,12 @@
+module PgEventstore
+  module Commands
+    module EventModifiers
+      class PrepareRegularEvent
+        # _@param_ `event`
+        #
+        # _@param_ `revision`
+        def call: (PgEventstore::Event event, Integer revision) -> PgEventstore::Event
+      end
+    end
+  end
+end

data/sig/pg_eventstore/commands/link_to.rbs

@@ -0,0 +1,17 @@
+module PgEventstore
+  module Commands
+    class LinkTo < PgEventstore::AbstractCommand
+      # _@param_ `stream`
+      #
+      # _@param_ `events`
+      #
+      # _@param_ `options`
+      #
+      # _@return_ — persisted events
+      def call: (PgEventstore::Stream stream, *PgEventstore::Event events, ?options: ::Hash[untyped, untyped]) -> ::Array[PgEventstore::Event]
+
+      # _@param_ `events`
+      def check_events_presence: (::Array[PgEventstore::Event] events) -> void
+    end
+  end
+end

data/sig/pg_eventstore/commands/multiple.rbs

@@ -0,0 +1,7 @@
+module PgEventstore
+  module Commands
+    class Multiple < PgEventstore::AbstractCommand
+      def call: () { () -> untyped } -> untyped
+    end
+  end
+end

data/sig/pg_eventstore/commands/read.rbs

@@ -0,0 +1,10 @@
+module PgEventstore
+  module Commands
+    class Read < PgEventstore::AbstractCommand
+      # _@param_ `stream`
+      #
+      # _@param_ `options` — request options
+      def call: (PgEventstore::Stream stream, ?options: ::Hash[untyped, untyped]) -> ::Array[PgEventstore::Event]
+    end
+  end
+end

data/sig/pg_eventstore/commands/regular_stream_read_paginated.rbs

@@ -0,0 +1,32 @@
+module PgEventstore
+  module Commands
+    class RegularStreamReadPaginated < PgEventstore::AbstractCommand
+      # _@param_ `stream`
+      #
+      # _@param_ `options`
+      %a{rbs:test:skip} def call: (PgEventstore::Stream stream, ?options: ::Hash[untyped, untyped]) -> ::Enumerator[Array[PgEventstore::Event], void]
+
+      # _@param_ `stream`
+      #
+      # _@param_ `options`
+      def calc_initial_revision: (PgEventstore::Stream stream, ::Hash[untyped, untyped] options) -> Integer
+
+      # _@param_ `events`
+      #
+      # _@param_ `max_count`
+      def end_reached?: (::Array[PgEventstore::Event] events, Integer max_count) -> bool
+
+      # _@param_ `events`
+      #
+      # _@param_ `revision`
+      #
+      # _@param_ `direction`
+      def calc_next_revision: (::Array[PgEventstore::Event] events, Integer revision, (String | Symbol)? direction) -> Integer
+
+      # _@param_ `direction`
+      def forwards?: ((String | Symbol)? direction) -> bool
+
+      def read_cmd: () -> PgEventstore::Commands::Read
+    end
+  end
+end

data/sig/pg_eventstore/commands/system_stream_read_paginated.rbs

@@ -0,0 +1,30 @@
+module PgEventstore
+  module Commands
+    class SystemStreamReadPaginated < PgEventstore::AbstractCommand
+      # _@param_ `stream`
+      #
+      # _@param_ `options`
+      %a{rbs:test:skip} def call: (PgEventstore::Stream stream, ?options: ::Hash[untyped, untyped]) -> ::Enumerator[Array[PgEventstore::Event], void]
+
+      # _@param_ `stream`
+      #
+      # _@param_ `options`
+      def calc_initial_position: (PgEventstore::Stream stream, ::Hash[untyped, untyped] options) -> Integer
+
+      # _@param_ `events`
+      #
+      # _@param_ `max_count`
+      def end_reached?: (::Array[PgEventstore::Event] events, Integer max_count) -> bool
+
+      # _@param_ `events`
+      #
+      # _@param_ `direction`
+      def calc_next_position: (::Array[PgEventstore::Event] events, (String | Symbol)? direction) -> Integer
+
+      # _@param_ `direction`
+      def forwards?: ((String | Symbol)? direction) -> bool
+
+      def read_cmd: () -> PgEventstore::Commands::Read
+    end
+  end
+end

data/sig/pg_eventstore/config.rbs

@@ -0,0 +1,51 @@
+module PgEventstore
+  class Config
+    include PgEventstore::Extensions::OptionsExtension
+
+    # _@param_ `name` — config's name. Its value matches the appropriate key in PgEventstore.config hash
+    def initialize: (name: Symbol, **untyped options) -> void
+
+    def connection_options: () -> ::Hash[untyped, untyped]
+
+    def options_hash: () -> ::Hash[untyped, untyped]
+
+    # _@param_ `opt_name`
+    def readonly!: (Symbol opt_name) -> bool
+
+    # _@param_ `opt_name`
+    def readonly?: (Symbol opt_name) -> bool
+
+    # _@param_ `opt_name`
+    def readonly_error: (Symbol opt_name) -> void
+
+    # _@param_ `options`
+    def init_default_values: (::Hash[untyped, untyped] options) -> void
+
+    attr_reader name: untyped
+
+    attr_accessor pg_uri: String
+
+    # _@return_ — Number of events to return in one response when reading from a stream
+    attr_accessor max_count: Integer
+
+    attr_accessor middlewares: ::Hash[Symbol, PgEventstore::Middleware]
+
+    attr_accessor event_class_resolver: _EventClassResolver
+
+    attr_accessor connection_pool_size: Integer
+
+    attr_accessor connection_pool_timeout: Integer
+
+    attr_accessor subscription_pull_interval: Float | Integer
+
+    attr_accessor subscription_max_retries: Integer
+
+    attr_accessor subscription_retries_interval: Integer
+
+    attr_accessor subscription_restart_terminator: _RestartTerminator?
+
+    attr_accessor subscriptions_set_max_retries: Integer
+
+    attr_accessor subscriptions_set_retries_interval: Integer
+  end
+end

data/sig/pg_eventstore/connection.rbs

@@ -0,0 +1,30 @@
+module PgEventstore
+  class Connection
+    module Ruby30Patch
+    end
+
+    include PgEventstore::Connection::Ruby30Patch
+
+    # _@param_ `uri` — PostgreSQL connection URI. Example: "postgresql://postgres:postgres@localhost:5432/eventstore"
+    #
+    # _@param_ `pool_size` — Connection pool size
+    #
+    # _@param_ `pool_timeout` — Connection pool timeout in seconds
+    def initialize: (uri: String, ?pool_size: Integer, ?pool_timeout: Integer) -> void
+
+    def with: () { (PG::Connection connection) -> untyped } -> untyped
+
+    def init_pool: () -> ConnectionPool[untyped]
+
+    def pg_type_registry: () -> PG::BasicTypeRegistry
+
+    # Returns the value of attribute uri.
+    attr_accessor uri: String
+
+    # Returns the value of attribute pool_size.
+    attr_accessor pool_size: Integer
+
+    # Returns the value of attribute pool_timeout.
+    attr_accessor pool_timeout: Integer
+  end
+end

data/sig/pg_eventstore/errors.rbs

@@ -0,0 +1,116 @@
+module PgEventstore
+  class Error < StandardError
+    def as_json: () -> ::Hash[untyped, untyped]
+
+    def to_h: () -> ::Hash[untyped, untyped]
+  end
+
+  class StreamNotFoundError < PgEventstore::Error
+    # _@param_ `stream`
+    def initialize: (PgEventstore::Stream stream) -> void
+
+    # Returns the value of attribute stream.
+    attr_accessor stream: PgEventstore::Stream
+  end
+
+  class SystemStreamError < PgEventstore::Error
+    # _@param_ `stream`
+    def initialize: (PgEventstore::Stream stream) -> void
+
+    attr_accessor stream: PgEventstore::Stream
+  end
+
+  class WrongExpectedRevisionError < PgEventstore::Error
+    # _@param_ `revision`
+    #
+    # _@param_ `expected_revision`
+    #
+    # _@param_ `stream`
+    def initialize: (revision: Integer, expected_revision: (Integer | Symbol), stream: PgEventstore::Stream) -> void
+
+    def user_friendly_message: () -> String
+
+    def expected_stream_exists: () -> String
+
+    def expected_no_stream: () -> String
+
+    def current_no_stream: () -> String
+
+    def unmatched_stream_revision: () -> String
+
+    def stream_descr: () -> String
+
+    attr_accessor stream: PgEventstore::Stream
+
+    attr_accessor revision: Integer
+
+    attr_accessor expected_revision: (Integer | Symbol)
+  end
+
+  class RecordNotFound < PgEventstore::Error
+    # _@param_ `table_name`
+    #
+    # _@param_ `id`
+    def initialize: (String table_name, (Integer | String) id) -> void
+
+    def user_friendly_message: () -> String
+
+    attr_accessor table_name: String
+
+    attr_accessor id: (Integer | String)
+  end
+
+  class SubscriptionAlreadyLockedError < PgEventstore::Error
+    # _@param_ `set` — subscriptions set name
+    #
+    # _@param_ `name` — subscription's name
+    #
+    # _@param_ `lock_id`
+    def initialize: (String set, String name, Integer lock_id) -> void
+
+    def user_friendly_message: () -> String
+
+    attr_accessor set: String
+
+    attr_accessor name: String
+
+    attr_accessor lock_id: Integer
+  end
+
+  class WrongLockIdError < PgEventstore::Error
+    # _@param_ `set` — subscriptions set name
+    #
+    # _@param_ `name` — subscription's name
+    #
+    # _@param_ `lock_id`
+    def initialize: (String set, String name, Integer lock_id) -> void
+
+    def user_friendly_message: () -> String
+
+    attr_accessor set: String
+
+    attr_accessor name: String
+
+    attr_accessor lock_id: Integer
+  end
+
+  class NotPersistedEventError < PgEventstore::Error
+    # _@param_ `event`
+    def initialize: (PgEventstore::Event event) -> void
+
+    def user_friendly_message: () -> String
+
+    attr_accessor event: PgEventstore::Event
+  end
+
+  class MissingPartitions < PgEventstore::Error
+    # _@param_ `stream`
+    #
+    # _@param_ `event_types`
+    def initialize: (PgEventstore::Stream stream, ::Array[String] event_types) -> void
+
+    attr_accessor stream: PgEventstore::Stream
+
+    attr_accessor event_types: ::Array[String]
+  end
+end

data/sig/pg_eventstore/event.rbs

@@ -0,0 +1,46 @@
+module PgEventstore
+  class Event
+    include PgEventstore::Extensions::OptionsExtension
+    LINK_TYPE: String
+
+    def ==: ((Object | PgEventstore::Event) other) -> bool
+
+    def link?: () -> bool
+
+    def system?: () -> bool
+
+    def initialize: (**untyped options) -> void
+
+    def options_hash: () -> ::Hash[untyped, untyped]
+
+    def readonly!: (Symbol opt_name) -> bool
+
+    def readonly?: (Symbol opt_name) -> bool
+
+    def readonly_error: (Symbol opt_name) -> void
+
+    def init_default_values: (::Hash[untyped, untyped] options) -> void
+
+    attr_accessor id: String?
+
+    attr_accessor type: String
+
+    attr_accessor global_position: Integer?
+
+    attr_accessor stream: PgEventstore::Stream?
+
+    attr_accessor stream_revision: Integer?
+
+    attr_accessor data: ::Hash[untyped, untyped]
+
+    attr_accessor metadata: ::Hash[untyped, untyped]
+
+    attr_accessor link_id: String?
+
+    attr_accessor link_partition_id: Integer?
+
+    attr_accessor link: PgEventstore::Event?
+
+    attr_accessor created_at: Time?
+  end
+end

data/sig/pg_eventstore/event_class_resolver.rbs

@@ -0,0 +1,6 @@
+module PgEventstore
+  class EventClassResolver
+    # _@param_ `event_type`
+    def call: (String? event_type) -> Class
+  end
+end