pg_eventstore 1.1.3 → 1.1.4

data/lib/pg_eventstore/web/paginator/stream_names_collection.rb

@@ -4,9 +4,10 @@ module PgEventstore
   module Web
     module Paginator
       class StreamNamesCollection < BaseCollection
+        # @return [Integer]
         PER_PAGE = 10
 
-        # @return [Array<Hash>]
+        # @return [Array<Hash<String => String>>]
         def collection
           @_collection ||=
             begin

data/lib/pg_eventstore/web/subscriptions/set_collection.rb

@@ -4,6 +4,8 @@ module PgEventstore
   module Web
     module Subscriptions
       class SetCollection
+        # @!attribute connection
+        #   @return [PgEventstore::Connection]
         attr_reader :connection
         private :connection
 

data/lib/pg_eventstore/web/subscriptions/subscriptions.rb

@@ -4,6 +4,8 @@ module PgEventstore
   module Web
     module Subscriptions
       class Subscriptions
+        # @!attribute connection
+        #   @return [PgEventstore::Connection]
         attr_reader :connection
         private :connection
 

data/lib/pg_eventstore/web/subscriptions/subscriptions_set.rb

@@ -4,6 +4,8 @@ module PgEventstore
   module Web
     module Subscriptions
       class SubscriptionsSet
+        # @!attribute connection
+        #   @return [PgEventstore::Connection]
         attr_reader :connection
         private :connection
 

data/lib/pg_eventstore/web/subscriptions/subscriptions_to_set_association.rb

@@ -4,7 +4,12 @@ module PgEventstore
   module Web
     module Subscriptions
       class SubscriptionsToSetAssociation
-        attr_reader :subscriptions_set, :subscriptions
+        # @!attribute subscriptions_set
+        #   @return [Array<PgEventstore::SubscriptionsSet>]
+        attr_reader :subscriptions_set
+        # @!attribute subscriptions
+        #   @return [Array<PgEventstore::Subscription>]
+        attr_reader :subscriptions
 
         # @param subscriptions_set [Array<PgEventstore::SubscriptionsSet>]
         # @param subscriptions [Array<PgEventstore::Subscription>]

data/lib/pg_eventstore.rb

@@ -18,6 +18,8 @@ require_relative 'pg_eventstore/subscriptions/subscriptions_manager'
 
 module PgEventstore
   class << self
+    # @!attribute mutex
+    #   @return [Thread::Mutex]
     attr_reader :mutex
     private :mutex
 
@@ -71,7 +73,7 @@ module PgEventstore
     # @param subscription_set [String]
     # @param max_retries [Integer, nil] max number of retries of failed SubscriptionsSet
     # @param retries_interval [Integer, nil] a delay between retries of failed SubscriptionsSet
-    # @return [PgEventstore::SubscriptionManager]
+    # @return [PgEventstore::SubscriptionsManager]
     def subscriptions_manager(config_name = :default, subscription_set:, max_retries: nil, retries_interval: nil)
       SubscriptionsManager.new(
         config: config(config_name),
@@ -87,10 +89,13 @@ module PgEventstore
       Client.new(config(name))
     end
 
+    # @return [Logger, nil]
     def logger
       @logger
     end
 
+    # @param logger [Logger, nil]
+    # @return [Logger, nil]
     def logger=(logger)
       @logger = logger
     end

data/rbs_collection.lock.yaml

@@ -0,0 +1,16 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: connection_pool
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: ac8b33799c494ea5b22e7dc850d53f99dc4849e9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,23 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  - name: sinatra
+    ignore: true
+
+# gems:
+#   # If you want to avoid installing rbs files for gems, you can specify them here.
+#   - name: GEM_NAME
+#     ignore: true

data/sig/interfaces/callback.rbs

@@ -0,0 +1,3 @@
+interface _Callback
+  def call: (*untyped args, **untyped kwargs) -> untyped
+end

data/sig/interfaces/event_class_resolver.rbs

@@ -0,0 +1,3 @@
+interface _EventClassResolver
+  def call: (String event_type) -> Class
+end

data/sig/interfaces/event_modifier.rbs

@@ -0,0 +1,3 @@
+interface _EventModifier
+  def call: (PgEventstore::Event event, Integer revision) -> PgEventstore::Event
+end

data/sig/interfaces/restart_terminator.rbs

@@ -0,0 +1,3 @@
+interface _RestartTerminator
+  def call: (PgEventstore::Subscription subscription) -> boolish
+end

data/sig/interfaces/subscription_handler.rbs

@@ -0,0 +1,3 @@
+interface _SubscriptionHandler
+  def call: (PgEventstore::Event event) -> void
+end

data/sig/pg/basic_type_registry.rbs

@@ -0,0 +1,21 @@
+module PG
+  class BasicTypeRegistry
+    public
+
+    def alias_type: (untyped format, untyped new, untyped old) -> untyped
+
+    def coders_for: (untyped format, untyped direction) -> untyped
+
+    alias define_default_types register_default_types
+
+    def register_coder: (untyped coder) -> untyped
+
+    def register_default_types: () -> untyped
+
+    def register_type: (untyped format, untyped name, untyped encoder_class, untyped decoder_class) -> untyped
+
+    private
+
+    def initialize: () -> void
+  end
+end

data/sig/pg/connection.rbs

@@ -0,0 +1,407 @@
+module PG
+  class Connection
+    include PG::Constants
+
+    def self.async_api=: (untyped enable) -> untyped
+
+    alias self.async_connect self.new
+
+    alias self.async_ping self.ping
+
+    def self.async_send_api=: (untyped enable) -> untyped
+
+    def self.conndefaults: () -> untyped
+
+    def self.conndefaults_hash: () -> untyped
+
+    alias self.connect self.new
+
+    def self.connect_hash_to_string: (untyped hash) -> untyped
+
+    def self.connect_start: (*untyped) -> untyped
+
+    def self.conninfo_parse: (untyped) -> untyped
+
+    def self.encrypt_password: (untyped, untyped) -> untyped
+
+    alias self.escape self.escape_string
+
+    def self.escape_bytea: (untyped) -> untyped
+
+    def self.escape_string: (untyped) -> untyped
+
+    def self.isthreadsafe: () -> untyped
+
+    def self.new: (*untyped args) ?{ (untyped) -> untyped } -> untyped
+
+    alias self.open self.new
+
+    def self.parse_connect_args: (*untyped args) -> untyped
+
+    def self.ping: (*untyped args) -> untyped
+
+    def self.quote_connstr: (untyped value) -> untyped
+
+    def self.quote_ident: (untyped) -> untyped
+
+    alias self.setdb self.new
+
+    alias self.setdblogin self.new
+
+    def self.sync_connect: (*untyped) -> untyped
+
+    def self.sync_ping: (*untyped) -> untyped
+
+    def self.unescape_bytea: (untyped) -> untyped
+
+    public
+
+    alias async_cancel cancel
+
+    alias async_describe_portal describe_portal
+
+    alias async_describe_prepared describe_prepared
+
+    alias async_encrypt_password encrypt_password
+
+    alias async_exec exec
+
+    alias async_exec_params exec_params
+
+    alias async_exec_prepared exec_prepared
+
+    alias async_flush flush
+
+    alias async_get_copy_data get_copy_data
+
+    alias async_get_last_result get_last_result
+
+    alias async_get_result get_result
+
+    alias async_isnonblocking isnonblocking
+
+    alias async_prepare prepare
+
+    alias async_put_copy_data put_copy_data
+
+    alias async_put_copy_end put_copy_end
+
+    alias async_query exec
+
+    alias async_reset reset
+
+    alias async_set_client_encoding set_client_encoding
+
+    alias async_setnonblocking setnonblocking
+
+    def backend_key: () -> untyped
+
+    def backend_pid: () -> untyped
+
+    def block: (*untyped) -> untyped
+
+    def cancel: () -> untyped
+
+    def check_socket: () -> untyped
+
+    alias client_encoding= set_client_encoding
+
+    alias close finish
+
+    def conndefaults: () -> untyped
+
+    def conndefaults_hash: () -> untyped
+
+    def connect_poll: () -> untyped
+
+    def connection_needs_password: () -> untyped
+
+    def connection_used_password: () -> untyped
+
+    def conninfo: () -> untyped
+
+    def conninfo_hash: () -> untyped
+
+    def consume_input: () -> untyped
+
+    def copy_data: (untyped sql, ?untyped coder) { (untyped) -> untyped } -> untyped
+
+    def db: () -> untyped
+
+    def decoder_for_get_copy_data: () -> untyped
+
+    def decoder_for_get_copy_data=: (untyped) -> untyped
+
+    def describe_portal: (untyped) -> untyped
+
+    def describe_prepared: (untyped) -> untyped
+
+    def discard_results: () -> untyped
+
+    def encoder_for_put_copy_data: () -> untyped
+
+    def encoder_for_put_copy_data=: (untyped) -> untyped
+
+    def encrypt_password: (untyped password, untyped username, ?untyped algorithm) -> untyped
+
+    def enter_pipeline_mode: () -> untyped
+
+    def error_message: () -> untyped
+
+    alias escape escape_string
+
+    def escape_bytea: (untyped) -> untyped
+
+    def escape_identifier: (untyped) -> untyped
+
+    def escape_literal: (untyped) -> untyped
+
+    def escape_string: (untyped) -> untyped
+
+    def exec: (*untyped) -> untyped
+
+    def exec_params: (*untyped) -> untyped
+
+    def exec_prepared: (*untyped) -> untyped
+
+    def exit_pipeline_mode: () -> untyped
+
+    def external_encoding: () -> untyped
+
+    def field_name_type: () -> untyped
+
+    def field_name_type=: (untyped) -> untyped
+
+    def finish: () -> untyped
+
+    def finished?: () -> untyped
+
+    def flush: () -> untyped
+
+    def get_client_encoding: () -> untyped
+
+    def get_copy_data: (?untyped async, ?untyped decoder) -> untyped
+
+    def get_last_result: () -> untyped
+
+    def get_result: () -> untyped
+
+    def host: () -> untyped
+
+    def hostaddr: () -> untyped
+
+    def inspect: () -> untyped
+
+    def internal_encoding: () -> untyped
+
+    def internal_encoding=: (untyped) -> untyped
+
+    def is_busy: () -> untyped
+
+    def isnonblocking: () -> untyped
+
+    def lo_close: (untyped) -> untyped
+
+    def lo_creat: (*untyped) -> untyped
+
+    def lo_create: (untyped) -> untyped
+
+    def lo_export: (untyped, untyped) -> untyped
+
+    def lo_import: (untyped) -> untyped
+
+    def lo_lseek: (untyped, untyped, untyped) -> untyped
+
+    def lo_open: (*untyped) -> untyped
+
+    def lo_read: (untyped, untyped) -> untyped
+
+    alias lo_seek lo_lseek
+
+    def lo_tell: (untyped) -> untyped
+
+    def lo_truncate: (untyped, untyped) -> untyped
+
+    def lo_unlink: (untyped) -> untyped
+
+    def lo_write: (untyped, untyped) -> untyped
+
+    alias loclose lo_close
+
+    alias locreat lo_creat
+
+    alias locreate lo_create
+
+    alias loexport lo_export
+
+    alias loimport lo_import
+
+    alias lolseek lo_lseek
+
+    alias loopen lo_open
+
+    alias loread lo_read
+
+    alias loseek lo_lseek
+
+    alias lotell lo_tell
+
+    alias lotruncate lo_truncate
+
+    alias lounlink lo_unlink
+
+    alias lowrite lo_write
+
+    def make_empty_pgresult: (untyped) -> untyped
+
+    alias nonblocking? isnonblocking
+
+    def notifies: () -> untyped
+
+    alias notifies_wait wait_for_notify
+
+    def options: () -> untyped
+
+    def parameter_status: (untyped) -> untyped
+
+    def pass: () -> untyped
+
+    def pipeline_status: () -> untyped
+
+    def pipeline_sync: () -> untyped
+
+    def port: () -> untyped
+
+    def prepare: (*untyped) -> untyped
+
+    def protocol_version: () -> untyped
+
+    def put_copy_data: (untyped buffer, ?untyped encoder) -> untyped
+
+    def put_copy_end: (*untyped args) -> untyped
+
+    alias query exec
+
+    def quote_ident: (untyped) -> untyped
+
+    def reset: () -> untyped
+
+    def reset_poll: () -> untyped
+
+    def reset_start: () -> untyped
+
+    def send_describe_portal: (untyped) -> untyped
+
+    def send_describe_prepared: (untyped) -> untyped
+
+    def send_flush_request: () -> untyped
+
+    def send_prepare: (*untyped) -> untyped
+
+    def send_query: (*untyped) -> untyped
+
+    def send_query_params: (*untyped) -> untyped
+
+    def send_query_prepared: (*untyped) -> untyped
+
+    def server_version: () -> untyped
+
+    def set_client_encoding: (untyped) -> untyped
+
+    def set_default_encoding: () -> untyped
+
+    def set_error_context_visibility: (untyped) -> untyped
+
+    def set_error_verbosity: (untyped) -> untyped
+
+    def set_notice_processor: () -> untyped
+
+    def set_notice_receiver: () -> untyped
+
+    def set_single_row_mode: () -> untyped
+
+    def setnonblocking: (untyped enabled) -> untyped
+
+    def socket: () -> untyped
+
+    def socket_io: () -> untyped
+
+    def ssl_attribute: (untyped) -> untyped
+
+    def ssl_attribute_names: () -> untyped
+
+    def ssl_attributes: () -> untyped
+
+    def ssl_in_use?: () -> untyped
+
+    def status: () -> untyped
+
+    def sync_cancel: () -> untyped
+
+    def sync_describe_portal: (untyped) -> untyped
+
+    def sync_describe_prepared: (untyped) -> untyped
+
+    def sync_encrypt_password: (*untyped) -> untyped
+
+    def sync_exec: (*untyped) -> untyped
+
+    def sync_exec_params: (*untyped) -> untyped
+
+    def sync_exec_prepared: (*untyped) -> untyped
+
+    def sync_flush: () -> untyped
+
+    def sync_get_copy_data: (*untyped) -> untyped
+
+    def sync_get_last_result: () -> untyped
+
+    def sync_get_result: () -> untyped
+
+    def sync_isnonblocking: () -> untyped
+
+    def sync_prepare: (*untyped) -> untyped
+
+    def sync_put_copy_data: (*untyped) -> untyped
+
+    def sync_put_copy_end: (*untyped) -> untyped
+
+    def sync_reset: () -> untyped
+
+    def sync_set_client_encoding: (untyped) -> untyped
+
+    def sync_setnonblocking: (untyped) -> untyped
+
+    def trace: (untyped) -> untyped
+
+    def transaction: () { (untyped) -> untyped } -> untyped
+
+    def transaction_status: () -> untyped
+
+    def tty: () -> untyped
+
+    def type_map_for_queries: () -> untyped
+
+    def type_map_for_queries=: (untyped) -> untyped
+
+    def type_map_for_results: () -> untyped
+
+    def type_map_for_results=: (untyped) -> untyped
+
+    def unescape_bytea: (untyped) -> untyped
+
+    def untrace: () -> untyped
+
+    def user: () -> untyped
+
+    def wait_for_notify: (*untyped) -> untyped
+
+    private
+
+    def async_connect_or_reset: (untyped poll_meth) -> untyped
+
+    def flush_data=: (untyped) -> untyped
+
+    def reset_start2: (untyped) -> untyped
+  end
+end