pg_eventstore 1.1.2 → 1.1.4

data/sig/pg_eventstore/subscriptions/subscription_feeder.rbs

@@ -0,0 +1,64 @@
+module PgEventstore
+  class SubscriptionFeeder
+    extend Forwardable
+    HEARTBEAT_INTERVAL: Integer
+
+    # _@param_ `config_name`
+    #
+    # _@param_ `set_name`
+    #
+    # _@param_ `max_retries` — max number of retries of failed SubscriptionsSet
+    #
+    # _@param_ `retries_interval` — a delay between retries of failed SubscriptionsSet
+    def initialize: (
+        config_name: Symbol,
+        set_name: String,
+        max_retries: Integer,
+        retries_interval: Integer
+      ) -> void
+
+    # _@param_ `runner`
+    def add: (PgEventstore::SubscriptionRunner runner) -> PgEventstore::SubscriptionRunner
+
+    def start_all: () -> void
+
+    def stop_all: () -> void
+
+    def force_lock!: () -> void
+
+    def read_only_subscriptions: () -> ::Array[PgEventstore::Subscription]
+
+    def read_only_subscriptions_set: () -> PgEventstore::SubscriptionsSet?
+
+    def lock_all: () -> void
+
+    def subscriptions_set: () -> PgEventstore::SubscriptionsSet
+
+    def feeder: () -> PgEventstore::SubscriptionRunnersFeeder
+
+    def attach_runner_callbacks: () -> void
+
+    def before_runner_started: () -> void
+
+    # _@param_ `error`
+    def after_runner_died: (StandardError error) -> void
+
+    # _@param_ `_error`
+    def restart_runner: (StandardError _error) -> void
+
+    def update_runner_restarts: () -> void
+
+    def process_async: () -> void
+
+    def ping_subscriptions_set: () -> void
+
+    def ping_subscriptions: () -> void
+
+    def after_runner_stopped: () -> void
+
+    # _@param_ `state`
+    def update_subscriptions_set_state: (String state) -> void
+
+    def assert_proper_state!: () -> void
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_feeder_commands/base.rbs

@@ -0,0 +1,45 @@
+module PgEventstore
+  module SubscriptionFeederCommands
+    class Base
+      include PgEventstore::Extensions::OptionsExtension
+      include PgEventstore::Extensions::BaseCommandExtension
+
+      # _@param_ `subscription_feeder`
+      def exec_cmd: (PgEventstore::SubscriptionFeeder subscription_feeder) -> void
+
+      def hash: () -> Integer
+
+      # _@param_ `another`
+      def eql?: (Object another) -> bool
+
+      # _@param_ `another`
+      def ==: (Object another) -> bool
+
+      def initialize: (**untyped options) -> void
+
+      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_accessor id: Integer?
+
+      attr_accessor name: String
+
+      attr_accessor subscriptions_set_id: Integer?
+
+      attr_accessor data: ::Hash[untyped, untyped]
+
+      attr_accessor created_at: Time?
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_feeder_commands/restore.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module SubscriptionFeederCommands
+    class Restore < PgEventstore::SubscriptionFeederCommands::Base
+      # _@param_ `subscription_feeder`
+      def exec_cmd: (PgEventstore::SubscriptionFeeder subscription_feeder) -> void
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_feeder_commands/start_all.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module SubscriptionFeederCommands
+    class StartAll < PgEventstore::SubscriptionFeederCommands::Base
+      # _@param_ `subscription_feeder`
+      def exec_cmd: (PgEventstore::SubscriptionFeeder subscription_feeder) -> void
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_feeder_commands/stop.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module SubscriptionFeederCommands
+    class Stop < PgEventstore::SubscriptionFeederCommands::Base
+      # _@param_ `subscription_feeder`
+      def exec_cmd: (PgEventstore::SubscriptionFeeder subscription_feeder) -> void
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_feeder_commands/stop_all.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module SubscriptionFeederCommands
+    class StopAll < PgEventstore::SubscriptionFeederCommands::Base
+      # _@param_ `subscription_feeder`
+      def exec_cmd: (PgEventstore::SubscriptionFeeder subscription_feeder) -> void
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_feeder_commands.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module SubscriptionFeederCommands
+    extend PgEventstore::Extensions::CommandClassLookupExtension
+
+    # _@param_ `cmd_name`
+    def self.command_class: ((String | Symbol) cmd_name) -> Class
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_handler_performance.rbs

@@ -0,0 +1,12 @@
+module PgEventstore
+  class SubscriptionHandlerPerformance
+    extend Forwardable
+    TIMINGS_TO_KEEP: Integer
+
+    def initialize: () -> void
+
+    def track_exec_time: () { () -> untyped } -> untyped
+
+    def average_event_processing_time: () -> Float
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_runner.rbs

@@ -0,0 +1,55 @@
+module PgEventstore
+  class SubscriptionRunner
+    extend Forwardable
+    MAX_EVENTS_PER_CHUNK: Integer
+    MIN_EVENTS_PER_CHUNK: Integer
+    INITIAL_EVENTS_PER_CHUNK: Integer
+
+    # _@param_ `stats`
+    #
+    # _@param_ `events_processor`
+    #
+    # _@param_ `subscription`
+    #
+    # _@param_ `restart_terminator`
+    def initialize: (
+        stats: PgEventstore::SubscriptionHandlerPerformance,
+        events_processor: PgEventstore::EventsProcessor,
+        subscription: PgEventstore::Subscription,
+        ?restart_terminator: _RestartTerminator?
+      ) -> void
+
+    def next_chunk_query_opts: () -> ::Hash[untyped, untyped]
+
+    def time_to_feed?: () -> bool
+
+    def next_chunk_global_position: () -> Integer
+
+    def estimate_events_number: () -> Integer
+
+    def attach_callbacks: () -> void
+
+    # _@param_ `action`
+    def track_exec_time: (Proc action, *untyped args) -> void
+
+    # _@param_ `current_position`
+    def update_subscription_stats: (Integer current_position) -> void
+
+    # _@param_ `state`
+    def update_subscription_state: (String state) -> void
+
+    def update_subscription_restarts: () -> void
+
+    # _@param_ `error`
+    def update_subscription_error: (StandardError error) -> void
+
+    # _@param_ `global_position`
+    def update_subscription_chunk_stats: (Integer global_position) -> void
+
+    # _@param_ `_error`
+    def restart_subscription: (StandardError _error) -> void
+
+    # Returns the value of attribute subscription.
+    attr_accessor subscription: PgEventstore::Subscription
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_runner_commands/base.rbs

@@ -0,0 +1,47 @@
+module PgEventstore
+  module SubscriptionRunnerCommands
+    class Base
+      include PgEventstore::Extensions::OptionsExtension
+      include PgEventstore::Extensions::BaseCommandExtension
+
+      # _@param_ `subscription_runner`
+      def exec_cmd: (PgEventstore::SubscriptionRunner subscription_runner) -> void
+
+      def hash: () -> Integer
+
+      # _@param_ `another`
+      def eql?: (Object another) -> bool
+
+      # _@param_ `another`
+      def ==: (Object another) -> bool
+
+      def initialize: (**untyped options) -> void
+
+      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_accessor id: Integer?
+
+      attr_accessor name: String
+
+      attr_accessor subscription_id: Integer?
+
+      attr_accessor subscriptions_set_id: Integer?
+
+      attr_accessor data: ::Hash[untyped, untyped]
+
+      attr_accessor created_at: Time?
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_runner_commands/reset_position.rbs

@@ -0,0 +1,11 @@
+module PgEventstore
+  module SubscriptionRunnerCommands
+    class ResetPosition < PgEventstore::SubscriptionRunnerCommands::Base
+      # _@param_ `data`
+      def self.parse_data: (::Hash[untyped, untyped] data) -> ::Hash[untyped, untyped]
+
+      # _@param_ `subscription_runner`
+      def exec_cmd: (PgEventstore::SubscriptionRunner subscription_runner) -> void
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_runner_commands/restore.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module SubscriptionRunnerCommands
+    class Restore < PgEventstore::SubscriptionRunnerCommands::Base
+      # _@param_ `subscription_runner`
+      def exec_cmd: (PgEventstore::SubscriptionRunner subscription_runner) -> void
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_runner_commands/start.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module SubscriptionRunnerCommands
+    class Start < PgEventstore::SubscriptionRunnerCommands::Base
+      # _@param_ `subscription_runner`
+      def exec_cmd: (PgEventstore::SubscriptionRunner subscription_runner) -> void
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_runner_commands/stop.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module SubscriptionRunnerCommands
+    class Stop < PgEventstore::SubscriptionRunnerCommands::Base
+      # _@param_ `subscription_runner`
+      def exec_cmd: (PgEventstore::SubscriptionRunner subscription_runner) -> void
+    end
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_runner_commands.rbs

@@ -0,0 +1,8 @@
+module PgEventstore
+  module SubscriptionRunnerCommands
+    extend PgEventstore::Extensions::CommandClassLookupExtension
+
+    # _@param_ `cmd_name`
+    def self.command_class: ((String | Symbol) cmd_name) -> Class
+  end
+end

data/sig/pg_eventstore/subscriptions/subscription_runners_feeder.rbs

@@ -0,0 +1,13 @@
+module PgEventstore
+  class SubscriptionRunnersFeeder
+    # _@param_ `config_name`
+    def initialize: (Symbol config_name) -> void
+
+    # _@param_ `runners`
+    def feed: (::Array[PgEventstore::SubscriptionRunner] runners) -> void
+
+    def connection: () -> PgEventstore::Connection
+
+    def subscription_queries: () -> PgEventstore::SubscriptionQueries
+  end
+end

data/sig/pg_eventstore/subscriptions/subscriptions_manager.rbs

@@ -0,0 +1,60 @@
+module PgEventstore
+  class SubscriptionsManager
+    extend Forwardable
+
+    # _@param_ `config`
+    #
+    # _@param_ `set_name`
+    #
+    # _@param_ `max_retries` — max number of retries of failed SubscriptionsSet
+    #
+    # _@param_ `retries_interval` — a delay between retries of failed SubscriptionsSet
+    def initialize: (
+        config: PgEventstore::Config,
+        set_name: String,
+        ?max_retries: Integer?,
+        ?retries_interval: Integer?
+      ) -> void
+
+    # _@param_ `subscription_name` — subscription's name
+    #
+    # _@param_ `handler` — subscription's handler
+    #
+    # _@param_ `options` — request options
+    #
+    # _@param_ `middlewares` — provide a list of middleware names to override a config's middlewares
+    #
+    # _@param_ `pull_interval` — an interval in seconds to determine how often to query new events of the given subscription.
+    #
+    # _@param_ `max_retries` — max number of retries of failed Subscription
+    #
+    # _@param_ `retries_interval` — a delay between retries of failed Subscription
+    #
+    # _@param_ `restart_terminator` — a callable object which, when called - accepts PgEventstore::Subscription object to determine whether restarts should be stopped(true - stops restarts, false - continues restarts)
+    def subscribe: (
+        String subscription_name,
+        handler: _SubscriptionHandler,
+        ?options: ::Hash[untyped, untyped],
+        ?middlewares: ::Array[Symbol]?,
+        ?pull_interval: Integer | Float,
+        ?max_retries: Integer,
+        ?retries_interval: Integer | Float,
+        ?restart_terminator: _RestartTerminator?
+      ) -> void
+
+    def subscriptions: () -> ::Array[PgEventstore::Subscription]
+
+    def subscriptions_set: () -> PgEventstore::SubscriptionsSet?
+
+    # _@param_ `middlewares`
+    #
+    # _@param_ `handler`
+    def create_event_handler: (::Array[Symbol]? middlewares, untyped handler) -> Proc
+
+    # _@param_ `middlewares`
+    def select_middlewares: (?::Array[Symbol]? middlewares) -> ::Array[PgEventstore::Middleware]
+
+    # Returns the value of attribute config.
+    attr_accessor config: PgEventstore::Config
+  end
+end

data/sig/pg_eventstore/subscriptions/subscriptions_set.rbs

@@ -0,0 +1,72 @@
+module PgEventstore
+  class SubscriptionsSet
+    include PgEventstore::Extensions::UsingConnectionExtension
+    include PgEventstore::Extensions::OptionsExtension
+
+    # _@param_ `attrs`
+    def self.create: (::Hash[untyped, untyped] attrs) -> PgEventstore::SubscriptionsSet
+
+    def self.subscriptions_set_queries: () -> PgEventstore::SubscriptionsSetQueries
+
+    # _@param_ `attrs`
+    def assign_attributes: (::Hash[untyped, untyped] attrs) -> ::Hash[untyped, untyped]
+
+    # _@param_ `attrs`
+    def update: (::Hash[untyped, untyped] attrs) -> ::Hash[untyped, untyped]
+
+    def delete: () -> void
+
+    # Dup the current object without assigned connection
+    def dup: () -> PgEventstore::SubscriptionsSet
+
+    def reload: () -> PgEventstore::SubscriptionsSet
+
+    def hash: () -> Integer
+
+    # _@param_ `another`
+    def eql?: (untyped another) -> bool
+
+    # _@param_ `another`
+    def ==: (untyped another) -> bool
+
+    def subscriptions_set_queries: () -> PgEventstore::SubscriptionsSetQueries
+
+    def initialize: (**untyped options) -> void
+
+    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_accessor id: Integer?
+
+    attr_accessor name: String?
+
+    attr_accessor state: String?
+
+    attr_accessor restart_count: Integer?
+
+    attr_accessor max_restarts_number: Integer?
+
+    attr_accessor time_between_restarts: Integer?
+
+    attr_accessor last_restarted_at: Time?
+
+    attr_accessor last_error: { 'class' => String, 'message' => String, 'backtrace' => Array[String] }?
+
+    attr_accessor last_error_occurred_at: Time?
+
+    attr_accessor created_at: Time?
+
+    attr_accessor updated_at: Time?
+  end
+end

data/sig/pg_eventstore/utils.rbs

@@ -0,0 +1,20 @@
+module PgEventstore
+  class Utils
+    # _@param_ `object`
+    def self.deep_transform_keys: (untyped object) { (untyped key) -> untyped } -> Object
+
+    # _@param_ `object`
+    def self.deep_dup: (untyped object) -> Object
+
+    # _@param_ `array`
+    #
+    # _@return_ — positional variables, based on array size. Example: "$1, $2, $3"
+    def self.positional_vars: (::Array[untyped] array) -> String
+
+    # _@param_ `error`
+    def self.error_info: (StandardError error) -> ::Hash[untyped, untyped]
+
+    # _@param_ `str`
+    def self.underscore_str: (String str) -> String
+  end
+end

data/sig/pg_eventstore/version.rbs

@@ -0,0 +1,3 @@
+module PgEventstore
+  VERSION: String
+end

data/sig/pg_eventstore/web/paginator/base_collection.rbs

@@ -0,0 +1,51 @@
+module PgEventstore
+  module Web
+    module Paginator
+      class BaseCollection
+        # _@param_ `config_name`
+        #
+        # _@param_ `starting_id`
+        #
+        # _@param_ `per_page`
+        #
+        # _@param_ `order` — :asc or :desc
+        #
+        # _@param_ `options` — additional options to filter the collection
+        def initialize: (
+            Symbol config_name,
+            starting_id: (String | Integer)?,
+            per_page: Integer,
+            order: Symbol,
+            ?options: ::Hash[untyped, untyped]
+          ) -> void
+
+        def collection: () -> ::Array[untyped]
+
+        def count: () -> Integer
+
+        def next_page_starting_id: () -> (String | Integer)?
+
+        def prev_page_starting_id: () -> (String | Integer)?
+
+        def total_count: () -> Integer
+
+        def connection: () -> PgEventstore::Connection
+
+        # Returns the value of attribute config_name.
+        attr_accessor config_name: Symbol
+
+        # Returns the value of attribute starting_id.
+        attr_accessor starting_id: (String | Integer)?
+
+        # Returns the value of attribute per_page.
+        attr_accessor per_page: Integer
+
+        # Returns the value of attribute order.
+        attr_accessor order: Symbol
+
+        # Returns the value of attribute options.
+        attr_accessor options: ::Hash[untyped, untyped]
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/paginator/event_types_collection.rbs

@@ -0,0 +1,15 @@
+module PgEventstore
+  module Web
+    module Paginator
+      class EventTypesCollection < PgEventstore::Web::Paginator::BaseCollection
+        PER_PAGE: Integer
+
+        def collection: () -> ::Array[::Hash[String, String]]
+
+        def next_page_starting_id: () -> String?
+
+        def direction_operator: () -> String
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/paginator/events_collection.rbs

@@ -0,0 +1,31 @@
+module PgEventstore
+  module Web
+    module Paginator
+      class EventsCollection < PgEventstore::Web::Paginator::BaseCollection
+        SQL_DIRECTIONS: ::Hash[String, Symbol]
+        PER_PAGE: ::Hash[String, Integer]
+        MAX_NUMBER_TO_COUNT: Integer
+
+        def collection: () -> ::Array[PgEventstore::Event]
+
+        def next_page_starting_id: () -> Integer?
+
+        def prev_page_starting_id: () -> Integer?
+
+        def total_count: () -> Integer
+
+        # _@param_ `event`
+        def event_global_position: (PgEventstore::Event event) -> Integer?
+
+        # _@param_ `sql_builder`
+        def estimate_count: (PgEventstore::SQLBuilder sql_builder) -> Integer
+
+        # _@param_ `sql_builder`
+        def regular_count: (PgEventstore::SQLBuilder sql_builder) -> Integer
+
+        # _@param_ `sql_builder`
+        def global_position: (PgEventstore::SQLBuilder sql_builder) -> Integer?
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/paginator/helpers.rbs

@@ -0,0 +1,38 @@
+module PgEventstore
+  module Web
+    module Paginator
+      module Helpers
+        # _@param_ `collection`
+        def previous_page_link: (PgEventstore::Web::Paginator::BaseCollection collection) -> String
+
+        # _@param_ `collection`
+        def next_page_link: (PgEventstore::Web::Paginator::BaseCollection collection) -> String
+
+        def first_page_link: () -> String
+
+        # _@param_ `per_page` — string representation of items per page. E.g. "10", "20", etc.
+        def per_page_url: (String per_page) -> String
+
+        # _@param_ `order` — "asc"/"desc"
+        def sort_url: (String order) -> String
+
+        # _@param_ `number` — total number of events by the current filter
+        def total_count: (Integer number) -> String
+
+        # _@param_ `number`
+        #
+        # _@param_ `delimiter`
+        def number_with_delimiter: (Integer number, ?delimiter: String) -> String
+
+        # _@param_ `event`
+        def stream_path: (PgEventstore::Event event) -> String
+
+        # _@param_ `starting_id`
+        def build_starting_id_link: ((String | Integer)? starting_id) -> String
+
+        # _@param_ `params`
+        def build_path: ((::Hash[untyped, untyped] | ::Array[untyped]) params) -> String
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/paginator/stream_contexts_collection.rbs

@@ -0,0 +1,15 @@
+module PgEventstore
+  module Web
+    module Paginator
+      class StreamContextsCollection < PgEventstore::Web::Paginator::BaseCollection
+        PER_PAGE: Integer
+
+        def collection: () -> ::Array[::Hash[String, String]]
+
+        def next_page_starting_id: () -> String?
+
+        def direction_operator: () -> String
+      end
+    end
+  end
+end

data/sig/pg_eventstore/web/paginator/stream_ids_collection.rbs

@@ -0,0 +1,15 @@
+module PgEventstore
+  module Web
+    module Paginator
+      class StreamIdsCollection < PgEventstore::Web::Paginator::BaseCollection
+        PER_PAGE: Integer
+
+        def collection: () -> ::Array[::Hash[String, String]]
+
+        def next_page_starting_id: () -> String?
+
+        def direction_operator: () -> String
+      end
+    end
+  end
+end