pg_eventstore 2.0.0 → 3.0.0

data/sig/pg_eventstore/subscriptions/subscriptions_manager.rbs

@@ -3,46 +3,36 @@ module PgEventstore
     extend Forwardable
 
     @set_name: String
-    @subscription_feeder: PgEventstore::SubscriptionFeeder
-    @subscriptions_lifecycle: PgEventstore::SubscriptionsLifecycle
-    @subscriptions_set_lifecycle: PgEventstore::SubscriptionsSetLifecycle
-
-    def self.callbacks: () -> PgEventstore::Callbacks
-
-    # _@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
+    @subscription_feeder: SubscriptionFeeder
+    @subscriptions_lifecycle: SubscriptionsLifecycle
+    @subscriptions_set_lifecycle: SubscriptionsSetLifecycle
+
+    def self.callbacks: () -> Callbacks
+
     def initialize: (
-        config: PgEventstore::Config,
+        config: Config,
         set_name: String,
         ?max_retries: Integer?,
         ?retries_interval: Integer?,
         ?force_lock: bool
       ) -> void
 
+    def create_replication: (
+        String subscription_name,
+        Symbol primary_config_name,
+        ?options: ::Hash[untyped, untyped],
+        ?max_events_to_replicate: Integer,
+        ?pull_interval: Integer | Float,
+        ?max_retries: Integer,
+        ?retries_interval: Integer | Float,
+        ?restart_terminator: _RestartTerminator?,
+        ?failed_subscription_notifier: _FailedSubscriptionNotifier?,
+        ?graceful_shutdown_timeout: Integer | Float,
+        ?in_batches: bool,
+      ) -> void
+
     def config_name: () -> Symbol
 
-    # _@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 is invoked with PgEventstore::Subscription instance to determine whether restarts should be stopped(true - stops restarts, false - continues restarts)
-    #
-    # _@param_ `failed_subscription_notifier` - a callable object which is invoked with PgEventstore::Subscription instance and error instance after the related subscription died due to error and no longer can be automatically restarted due to max retries number reached. You can use this hook to send a notification about failed subscription.
     def subscribe: (
         String subscription_name,
         handler: _SubscriptionHandler,
@@ -54,26 +44,22 @@ module PgEventstore
         ?restart_terminator: _RestartTerminator?,
         ?failed_subscription_notifier: _FailedSubscriptionNotifier?,
         ?graceful_shutdown_timeout: Integer | Float,
+        ?in_batches: bool,
       ) -> void
 
-    def subscriptions: () -> ::Array[PgEventstore::Subscription]
+    def subscriptions: () -> ::Array[Subscription]
 
-    def subscriptions_set: () -> PgEventstore::SubscriptionsSet?
+    def subscriptions_set: () -> SubscriptionsSet?
 
-    # _@param_ `middlewares`
-    #
-    # _@param_ `handler`
-    def create_raw_event_handler: (::Array[Symbol]? middlewares, _SubscriptionHandler handler) -> _RawEventHandler
+    def deserializer: (::Array[Symbol]? middlewares) -> EventDeserializer
 
-    # _@param_ `middlewares`
-    def select_middlewares: (?::Array[Symbol]? middlewares) -> ::Array[PgEventstore::Middleware]
+    def select_middlewares: (?::Array[Symbol]? middlewares) -> ::Array[Middleware]
 
-    def start!: () -> PgEventstore::BasicRunner
+    def start!: () -> BasicRunner
 
-    def start: () -> PgEventstore::BasicRunner?
+    def start: () -> BasicRunner?
 
-    # Returns the value of attribute config.
-    attr_accessor config: PgEventstore::Config
+    attr_accessor config: Config
 
     private
 

data/sig/pg_eventstore/synchronized_array.rbs

@@ -0,0 +1,4 @@
+module PgEventstore
+  class SynchronizedArray[unchecked out Elem] < Array[Elem]
+  end
+end

data/sig/pg_eventstore/utils.rbs

@@ -1,35 +1,34 @@
 module PgEventstore
   class Utils
+    def self.assert!: (boolish truthy, String? message) -> void
+
+    def self.assert_node_role!: (Config config, Array[Symbol] expected_roles) -> void
+
     def self.benchmark: { -> untyped } -> Float
 
-    # _@param_ `object`
-    def self.deep_transform_keys: (untyped object) { (untyped key) -> untyped } -> Object
+    def self.deep_transform_keys: (untyped object) { (untyped key) -> untyped } -> untyped
 
-    # _@param_ `object`
-    def self.deep_dup: (untyped object) -> Object
+    def self.deep_dup: (untyped object) -> untyped
 
     def self.deprecation_warning: (String message) -> void
 
-    # _@param_ `array`
-    #
-    # _@return_ — positional variables, based on array size. Example: "$1, $2, $3"
+    def self.missing_implementation!: (untyped obj) -> void
+
     def self.positional_vars: (::Array[untyped] array) -> String
 
-    # _@param_ `error`
     def self.error_info: (StandardError error) -> ::Hash[untyped, untyped]
 
     def self.read_pid: (String file_path) -> String?
 
     def self.remove_file: (String file_path) -> void
 
-    # _@param_ `str`
     def self.underscore_str: (String str) -> String
 
     def self.original_global_position: (Hash[untyped, untyped] raw_event) -> Integer
 
-    def self.unwrap_exception: (WrappedException | StandardError wrapped_exception)-> StandardError
+    def self.unwrap_exception: (WrappedException | StandardError wrapped_exception) -> StandardError
 
-    def self.wrap_exception: (StandardError exception, **untyped extra)-> WrappedException
+    def self.wrap_exception: (StandardError exception, **untyped extra) -> WrappedException
 
     def self.write_to_file: (String file_path, String content) -> void
   end

data/sig/pg_eventstore/web/application.rbs

@@ -11,7 +11,7 @@ module PgEventstore
 
       def asset_url: (String path) -> String
 
-      def connection: -> PgEventstore::Connection
+      def connection: -> Connection
 
       def current_config: -> Symbol
 
@@ -19,13 +19,15 @@ module PgEventstore
 
       def escape_empty_string: (String? string) -> String?
 
-      def events_filter: -> Array[String]?
+      def events_filter: -> Array[String | Hash[untyped, untyped]]
 
       def flash_message=: (({ message: String, kind: String }) val)-> String
 
       def h: (String text) -> String
 
-      def paginated_json_response: (PgEventstore::Web::Paginator::BaseCollection collection) -> void
+      def markers_filter: -> Array[String]
+
+      def paginated_json_response: (Paginator::BaseCollection collection) -> void
 
       def redirect_back_url: (fallback_url: String) -> String
 
@@ -38,6 +40,14 @@ module PgEventstore
       def system_stream: -> String?
 
       def unescape_empty_string: (String? string) -> String?
+
+      def extract_event_types_filter: (Hash[untyped, untyped] options) -> Array[String | Hash[untyped, untyped]]
+
+      def extract_streams_filter: (Hash[untyped, untyped] options) -> Array[Hash[untyped, untyped]]
+
+      private
+
+      def normalize_markers: (Hash[untyped, untyped] hash) -> Array[String]
     end
   end
 end

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

@@ -2,6 +2,8 @@ module PgEventstore
   module Web
     module Paginator
       class BaseCollection
+        MIN_QUERY_SIZE_FOR_ADVANCE_SEARCH: Integer
+
         def initialize: (
             Symbol config_name,
             starting_id: (String | Integer)?,

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

@@ -18,6 +18,10 @@ module PgEventstore
         def next_page_starting_id: () -> String?
 
         def direction_operator: () -> String
+
+        private
+
+        def compute_event_type_filter: (SQLBuilder builder) -> void
       end
     end
   end

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

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

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

@@ -4,36 +4,27 @@ module PgEventstore
       module Helpers
         def empty_characters_fallback: (String str)-> String
 
-        # _@param_ `collection`
-        def previous_page_link: (PgEventstore::Web::Paginator::BaseCollection collection) -> String
+        def event_marker_path: (String marker) -> String
 
-        # _@param_ `collection`
-        def next_page_link: (PgEventstore::Web::Paginator::BaseCollection collection) -> String
+        def previous_page_link: (BaseCollection collection) -> String
+
+        def next_page_link: (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
+        def stream_path: (Stream stream) -> 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
+        def build_path: ((::Hash[untyped, untyped] | ::Array[untyped]) params, ?base_url: String) -> String
       end
     end
   end

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

@@ -0,0 +1,13 @@
+module PgEventstore
+  module Web
+    module Paginator
+      class MarkersCollection < BaseCollection
+        PER_PAGE: Maintenance
+
+        private
+
+        def direction_operator: -> String
+      end
+    end
+  end
+end

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

@@ -9,6 +9,10 @@ module PgEventstore
         def next_page_starting_id: () -> String?
 
         def direction_operator: () -> String
+
+        private
+
+        def compute_context_filter: (SQLBuilder builder) -> void
       end
     end
   end

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

@@ -9,6 +9,10 @@ module PgEventstore
         def next_page_starting_id: () -> String?
 
         def direction_operator: () -> String
+
+        private
+
+        def compute_stream_name_filter: (SQLBuilder builder) -> void
       end
     end
   end

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

@@ -0,0 +1,30 @@
+module PgEventstore
+  module Web
+    module Paginator
+      class StreamsCollection < BaseCollection
+        SQL_DIRECTIONS: ::Hash[String, Symbol]
+        PER_PAGE: ::Hash[String, Integer]
+        MAX_NUMBER_TO_COUNT: Integer
+
+        @collection: Array[Stream]
+        @total_count: Integer
+
+        def collection: -> Array[Stream]
+
+        def next_page_starting_id: -> Integer?
+
+        def prev_page_starting_id: -> Integer?
+
+        def total_count: -> Integer
+
+        private
+
+        def estimate_count: (SQLBuilder sql_builder) -> Integer
+
+        def regular_count: (SQLBuilder sql_builder) -> Integer
+
+        def starting_position: (SQLBuilder sql_builder) -> Integer?
+      end
+    end
+  end
+end

data/sig/pg_eventstore.rbs

@@ -1,20 +1,9 @@
 module PgEventstore
-  DEFAULT_CONFIG: Symbol
+  extend Extensions::ActsAsConfigurable
 
-  # _@param_ `name` — a name to assign to a config
-  #
-  # _@return_ — a result of the given block
-  def self.configure: (?name: Symbol) { (PgEventstore::Config) -> untyped } -> Object
+  attr_accessor logger: untyped
 
-  def self.available_configs: () -> ::Array[Symbol]
-
-  # _@param_ `name`
-  def self.config: (?Symbol name) -> PgEventstore::Config
-
-  # _@param_ `name`
-  def self.connection: (?Symbol name) -> PgEventstore::Connection
-
-  def self.maintenance: (?Symbol name) -> PgEventstore::Maintenance
+  def self.maintenance: (?Symbol name) -> Maintenance
 
   def self.subscriptions_manager: (
       ?Symbol config_name,
@@ -22,19 +11,12 @@ module PgEventstore
       ?max_retries: Integer?,
       ?retries_interval: Integer?,
       ?force_lock: bool
-    ) -> PgEventstore::SubscriptionsManager
-
-  # _@param_ `name`
-  def self.client: (?Symbol name) -> PgEventstore::Client
-
-  def self.logger: () -> Logger?
-
-  # _@param_ `logger`
-  def self.logger=: (Logger? logger) -> Logger?
+    ) -> SubscriptionsManager
 
-  def self.init_variables: () -> void
+  def self.client: (?Symbol name) -> Client
 
-  def self.mutex: () -> Thread::Mutex
+  private
 
-  def self.mutex=: (Thread::Mutex value) -> Thread::Mutex
+  def self.connection_options: (Config config) ->
+    { uri: String, pool_size: Integer, pool_timeout: Integer }
 end