pg_eventstore 1.1.3 → 1.1.4

data/lib/pg_eventstore/subscriptions/commands_handler.rb

@@ -10,13 +10,15 @@ module PgEventstore
   class CommandsHandler
     extend Forwardable
 
-    RESTART_DELAY = 5 # seconds
-    PULL_INTERVAL = 1 # seconds
+    # @return [Integer] the delay in seconds between runner restarts
+    RESTART_DELAY = 5
+    # @return [Integer] seconds, how often to check for new commands
+    PULL_INTERVAL = 1
 
     def_delegators :@basic_runner, :start, :stop, :state, :stop_async, :wait_for_finish
 
     # @param config_name [Symbol]
-    # @param subscription_feeder [PgEventstore::SUbscriptionFeeder]
+    # @param subscription_feeder [PgEventstore::SubscriptionFeeder]
     # @param runners [Array<PgEventstore::SubscriptionRunner>]
     def initialize(config_name, subscription_feeder, runners)
       @config_name = config_name

data/lib/pg_eventstore/subscriptions/queries/subscription_command_queries.rb

@@ -3,6 +3,8 @@
 module PgEventstore
   # @!visibility private
   class SubscriptionCommandQueries
+    # @!attribute connection
+    #   @return [PgEventstore::Connection]
     attr_reader :connection
     private :connection
 
@@ -15,7 +17,7 @@ module PgEventstore
     # @param subscriptions_set_id [Integer]
     # @param command_name [String]
     # @param data [Hash]
-    # @return [PgEventstore::SubscriptionRunnerCommands::Abstract]
+    # @return [PgEventstore::SubscriptionRunnerCommands::Base]
     def find_or_create_by(subscription_id:, subscriptions_set_id:, command_name:, data:)
       transaction_queries.transaction do
         find_by(subscription_id: subscription_id, subscriptions_set_id: subscriptions_set_id, command_name: command_name) ||
@@ -26,7 +28,7 @@ module PgEventstore
     # @param subscription_id [Integer]
     # @param subscriptions_set_id [Integer]
     # @param command_name [String]
-    # @return [PgEventstore::SubscriptionRunnerCommands::Abstract, nil]
+    # @return [PgEventstore::SubscriptionRunnerCommands::Base, nil]
     def find_by(subscription_id:, subscriptions_set_id:, command_name:)
       sql_builder =
         SQLBuilder.new.
@@ -48,7 +50,7 @@ module PgEventstore
     # @param subscriptions_set_id [Integer]
     # @param command_name [String]
     # @param data [Hash]
-    # @return [PgEventstore::SubscriptionRunnerCommands::Abstract]
+    # @return [PgEventstore::SubscriptionRunnerCommands::Base]
     def create(subscription_id:, subscriptions_set_id:, command_name:, data:)
       sql = <<~SQL
         INSERT INTO subscription_commands (name, subscription_id, subscriptions_set_id, data) 
@@ -63,7 +65,7 @@ module PgEventstore
 
     # @param subscription_ids [Array<Integer>]
     # @param subscriptions_set_id [Integer]
-    # @return [Array<PgEventstore::SubscriptionRunnerCommands::Abstract>]
+    # @return [Array<PgEventstore::SubscriptionRunnerCommands::Base>]
     def find_commands(subscription_ids, subscriptions_set_id:)
       return [] if subscription_ids.empty?
 

data/lib/pg_eventstore/subscriptions/queries/subscription_queries.rb

@@ -3,6 +3,8 @@
 module PgEventstore
   # @!visibility private
   class SubscriptionQueries
+    # @!attribute connection
+    #   @return [PgEventstore::Connection]
     attr_reader :connection
     private :connection
 
@@ -73,7 +75,7 @@ module PgEventstore
 
     # @param id [Integer]
     # @param attrs [Hash]
-    # @param locked_by [Integer]
+    # @param locked_by [Integer, nil]
     # @return [Hash]
     # @raise [PgEventstore::RecordNotFound]
     # @raise [PgEventstore::WrongLockIdError]
@@ -118,7 +120,7 @@ module PgEventstore
     end
 
     # @param query_options [Hash{Integer => Hash}] runner_id/query options association
-    # @return [Hash{Integer => Hash}] runner_id/events association
+    # @return [Hash{Integer => Array<Hash>}] runner_id/events association
     def subscriptions_events(query_options)
       return {} if query_options.empty?
 

data/lib/pg_eventstore/subscriptions/queries/subscriptions_set_command_queries.rb

@@ -3,6 +3,8 @@
 module PgEventstore
   # @!visibility private
   class SubscriptionsSetCommandQueries
+    # @!attribute connection
+    #   @return [PgEventstore::Connection]
     attr_reader :connection
     private :connection
 
@@ -14,7 +16,7 @@ module PgEventstore
     # @param subscriptions_set_id [Integer]
     # @param command_name [String]
     # @param data [Hash]
-    # @return [PgEventstore::SubscriptionFeederCommands::Abstract]
+    # @return [PgEventstore::SubscriptionFeederCommands::Base]
     def find_or_create_by(subscriptions_set_id:, command_name:, data:)
       transaction_queries.transaction do
         find_by(subscriptions_set_id: subscriptions_set_id, command_name: command_name) ||
@@ -24,7 +26,7 @@ module PgEventstore
 
     # @param subscriptions_set_id [Integer]
     # @param command_name [String]
-    # @return [PgEventstore::SubscriptionFeederCommands::Abstract, nil]
+    # @return [PgEventstore::SubscriptionFeederCommands::Base, nil]
     def find_by(subscriptions_set_id:, command_name:)
       sql_builder =
         SQLBuilder.new.
@@ -42,7 +44,7 @@ module PgEventstore
     # @param subscriptions_set_id [Integer]
     # @param command_name [String]
     # @param data [Hash]
-    # @return [PgEventstore::SubscriptionFeederCommands::Abstract]
+    # @return [PgEventstore::SubscriptionFeederCommands::Base]
     def create(subscriptions_set_id:, command_name:, data:)
       sql = <<~SQL
         INSERT INTO subscriptions_set_commands (name, subscriptions_set_id, data) 
@@ -56,7 +58,7 @@ module PgEventstore
     end
 
     # @param subscriptions_set_id [Integer]
-    # @return [Array<PgEventstore::SubscriptionFeederCommands::Abstract>]
+    # @return [Array<PgEventstore::SubscriptionFeederCommands::Base>]
     def find_commands(subscriptions_set_id)
       sql_builder =
         SQLBuilder.new.select('*').

data/lib/pg_eventstore/subscriptions/queries/subscriptions_set_queries.rb

@@ -3,6 +3,8 @@
 module PgEventstore
   # @!visibility private
   class SubscriptionsSetQueries
+    # @!attribute connection
+    #   @return [PgEventstore::Connection]
     attr_reader :connection
     private :connection
 
@@ -63,6 +65,7 @@ module PgEventstore
 
     # @param id [Integer]
     # @param attrs [Hash]
+    # @return [Hash]
     def update(id, attrs)
       attrs = { updated_at: Time.now.utc }.merge(attrs)
       attrs_sql = attrs.keys.map.with_index(1) do |attr, index|

data/lib/pg_eventstore/subscriptions/runner_state.rb

@@ -6,6 +6,7 @@ module PgEventstore
   class RunnerState
     include Extensions::CallbacksExtension
 
+    # @return [Hash<Symbol => String>]
     STATES = %i(initial running halting stopped dead).to_h { [_1, _1.to_s.freeze] }.freeze
 
     def initialize

data/lib/pg_eventstore/subscriptions/subscription.rb

@@ -7,20 +7,20 @@ module PgEventstore
     include Extensions::OptionsExtension
 
     # @!attribute id
-    #   @return [Integer]
+    #   @return [Integer, nil]
     attribute(:id)
     # @!attribute set
-    #   @return [String] Subscription's set. Subscription should have unique pair of set and name.
+    #   @return [String, nil] Subscription's set. Subscription should have unique pair of set and name.
     attribute(:set)
     # @!attribute name
-    #   @return [String] Subscription's name. Subscription should have unique pair of set and name.
+    #   @return [String, nil] Subscription's name. Subscription should have unique pair of set and name.
     attribute(:name)
     # @!attribute total_processed_events
-    #   @return [Integer] total number of events, processed by this subscription
+    #   @return [Integer, nil] total number of events, processed by this subscription
     attribute(:total_processed_events)
     # @!attribute options
-    #   @return [Hash] subscription's options to be used to query events. See {SubscriptionManager#subscribe} for the
-    #     list of available options
+    #   @return [Hash, nil] subscription's options to be used to query events. See {SubscriptionManager#subscribe} for
+    #     the list of available options
     attribute(:options)
     # @!attribute current_position
     #   @return [Integer, nil] current Subscription's position. It is updated automatically each time an event is processed
@@ -34,29 +34,29 @@ module PgEventstore
     #     processed by the Subscription per second.
     attribute(:average_event_processing_time)
     # @!attribute restart_count
-    #   @return [Integer] the number of Subscription's restarts after its failure
+    #   @return [Integer, nil] the number of Subscription's restarts after its failure
     attribute(:restart_count)
     # @!attribute max_restarts_number
-    #   @return [Integer] maximum number of times the Subscription can be restarted
+    #   @return [Integer, nil] maximum number of times the Subscription can be restarted
     attribute(:max_restarts_number)
     # @!attribute time_between_restarts
-    #   @return [Integer] interval in seconds between retries of failed Subscription
+    #   @return [Integer, nil] interval in seconds between retries of failed Subscription
     attribute(:time_between_restarts)
     # @!attribute last_restarted_at
     #   @return [Time, nil] last time the Subscription was restarted
     attribute(:last_restarted_at)
     # @!attribute last_error
-    #   @return [Hash{'class' => String, 'message' => String, 'backtrace' => Array<String>}, nil] the information about
+    #   @return [Hash, nil] the information about
     #     last error caused when processing events by the Subscription.
     attribute(:last_error)
     # @!attribute last_error_occurred_at
     #   @return [Time, nil] the time when the last error occurred
     attribute(:last_error_occurred_at)
     # @!attribute chunk_query_interval
-    #   @return [Float] determines how often to pull events for the given Subscription in seconds
+    #   @return [Integer, Float, nil] determines how often to pull events for the given Subscription in seconds
     attribute(:chunk_query_interval)
-    # @!attribute chunk_query_interval
-    #   @return [Time] shows the time when last time events were fed to the event's processor
+    # @!attribute last_chunk_fed_at
+    #   @return [Time, nil] shows the time when last time events were fed to the event's processor
     attribute(:last_chunk_fed_at)
     # @!attribute last_chunk_greatest_position
     #   @return [Integer, nil] shows the greatest global_position of the last event in the last chunk fed to the event's
@@ -67,15 +67,15 @@ module PgEventstore
     #     means that the Subscription isn't locked yet by any subscription manager.
     attribute(:locked_by)
     # @!attribute created_at
-    #   @return [Time]
+    #   @return [Time, nil]
     attribute(:created_at)
     # @!attribute updated_at
-    #   @return [Time]
+    #   @return [Time, nil]
     attribute(:updated_at)
 
     class << self
       # @param subscriptions_set_id [Integer] SubscriptionsSet#id
-      # @param subscriptions [Array<PgEventstoreSubscription>]
+      # @param subscriptions [Array<PgEventstore::Subscription>]
       # @return [void]
       def ping_all(subscriptions_set_id, subscriptions)
         result = subscription_queries.ping_all(subscriptions_set_id, subscriptions.map(&:id))
@@ -111,6 +111,8 @@ module PgEventstore
     end
 
     # Locks the Subscription by the given lock id
+    # @param lock_id [Integer] SubscriptionsSet#id
+    # @param force [Boolean]
     # @return [PgEventstore::Subscription]
     def lock!(lock_id, force: false)
       self.id = subscription_queries.find_or_create_by(set: set, name: name)[:id]
@@ -144,7 +146,7 @@ module PgEventstore
       hash == another.hash
     end
 
-    # @param another [PgEventstore::SubscriptionsSet]
+    # @param another [Object]
     # @return [Boolean]
     def ==(another)
       return false unless another.is_a?(Subscription)

data/lib/pg_eventstore/subscriptions/subscription_feeder.rb

@@ -6,6 +6,7 @@ module PgEventstore
   class SubscriptionFeeder
     extend Forwardable
 
+    # @return [Integer] number of seconds between heartbeat updates
     HEARTBEAT_INTERVAL = 10 # seconds
 
     def_delegators :subscriptions_set, :id
@@ -30,6 +31,7 @@ module PgEventstore
 
     # Adds SubscriptionRunner to the set
     # @param runner [PgEventstore::SubscriptionRunner]
+    # @return [PgEventstore::SubscriptionRunner]
     def add(runner)
       assert_proper_state!
       @runners.push(runner)
@@ -56,6 +58,7 @@ module PgEventstore
 
     # Sets the force_lock flash to true. If set - all related Subscriptions will ignore their lock state and will be
     # locked by the new SubscriptionsSet.
+    # @return [void]
     def force_lock!
       @force_lock = true
     end
@@ -170,6 +173,7 @@ module PgEventstore
       @commands_handler.stop
     end
 
+    # @param state [String]
     # @return [void]
     def update_subscriptions_set_state(state)
       subscriptions_set.update(state: state)

data/lib/pg_eventstore/subscriptions/subscription_feeder_commands/base.rb

@@ -8,19 +8,19 @@ module PgEventstore
       include Extensions::BaseCommandExtension
 
       # @!attribute id
-      #   @return [Integer]
+      #   @return [Integer, nil]
       attribute(:id)
       # @!attribute name
       #   @return [String]
       attribute(:name) { self.class.name.split('::').last }
       # @!attribute subscriptions_set_id
-      #   @return [Integer]
+      #   @return [Integer, nil]
       attribute(:subscriptions_set_id)
       # @!attribute data
-      #   @return [Hash]
+      #   @return [Hash, nil]
       attribute(:data) { {} }
       # @!attribute created_at
-      #   @return [Time]
+      #   @return [Time, nil]
       attribute(:created_at)
 
       # @param subscription_feeder [PgEventstore::SubscriptionFeeder]

data/lib/pg_eventstore/subscriptions/subscription_handler_performance.rb

@@ -9,6 +9,7 @@ module PgEventstore
   class SubscriptionHandlerPerformance
     extend Forwardable
 
+    # @return [Integer] the number of measurements to keep
     TIMINGS_TO_KEEP = 100
 
     def_delegators :@lock, :synchronize
@@ -33,7 +34,7 @@ module PgEventstore
     # The average time required to process an event.
     # @return [Float]
     def average_event_processing_time
-      synchronize { @timings.size.zero? ? 0 : @timings.sum / @timings.size }
+      synchronize { @timings.size.zero? ? 0.0 : @timings.sum / @timings.size }
     end
   end
 end

data/lib/pg_eventstore/subscriptions/subscription_runner.rb

@@ -10,10 +10,15 @@ module PgEventstore
   class SubscriptionRunner
     extend Forwardable
 
+    # @return [Integer]
     MAX_EVENTS_PER_CHUNK = 1_000
+    # @return [Integer]
     MIN_EVENTS_PER_CHUNK = 10
+    # @return [Integer]
     INITIAL_EVENTS_PER_CHUNK = 10
 
+    # @!attribute subscription
+    #   @return [PgEventstore::Subscription]
     attr_reader :subscription
 
     def_delegators :@events_processor, :start, :stop, :stop_async, :feed, :wait_for_finish, :restore, :state, :running?,

data/lib/pg_eventstore/subscriptions/subscription_runner_commands/base.rb

@@ -8,22 +8,22 @@ module PgEventstore
       include Extensions::BaseCommandExtension
 
       # @!attribute id
-      #   @return [Integer]
+      #   @return [Integer, nil]
       attribute(:id)
       # @!attribute name
       #   @return [String]
       attribute(:name) { self.class.name.split('::').last }
       # @!attribute subscription_id
-      #   @return [Integer]
+      #   @return [Integer, nil]
       attribute(:subscription_id)
       # @!attribute subscriptions_set_id
-      #   @return [Integer]
+      #   @return [Integer, nil]
       attribute(:subscriptions_set_id)
       # @!attribute data
       #   @return [Hash]
       attribute(:data) { {} }
       # @!attribute created_at
-      #   @return [Time]
+      #   @return [Time, nil]
       attribute(:created_at)
 
       # @param subscription_runner [PgEventstore::SubscriptionRunner]

data/lib/pg_eventstore/subscriptions/subscriptions_manager.rb

@@ -25,6 +25,8 @@ module PgEventstore
   class SubscriptionsManager
     extend Forwardable
 
+    # @!attribute config
+    #   @return [PgEventstore::Config]
     attr_reader :config
     private :config
 
@@ -55,10 +57,10 @@ module PgEventstore
     # @option options [Hash] :filter provide it to filter events. It works the same way as a :filter option of
     #   {PgEventstore::Client#read} method. Filtering by both - event types and streams are available.
     # @param middlewares [Array<Symbol>, nil] provide a list of middleware names to override a config's middlewares
-    # @param pull_interval [Integer] an interval in seconds to determine how often to query new events of the given
-    #   subscription.
+    # @param pull_interval [Integer, Float] an interval in seconds to determine how often to query new events of the
+    #   given subscription.
     # @param max_retries [Integer] max number of retries of failed Subscription
-    # @param retries_interval [Float] a delay between retries of failed Subscription
+    # @param retries_interval [Integer, Float] a delay between retries of failed Subscription
     # @param restart_terminator [#call, nil] a callable object which, when called - accepts PgEventstore::Subscription
     #   object to determine whether restarts should be stopped(true - stops restarts, false - continues restarts)
     # @return [void]
@@ -103,7 +105,7 @@ module PgEventstore
     end
 
     # @param middlewares [Array, nil]
-    # @return [Array<Object<#serialize, #deserialize>>]
+    # @return [Array<PgEventstore::Middleware>]
     def select_middlewares(middlewares = nil)
       return config.middlewares.values unless middlewares
 

data/lib/pg_eventstore/subscriptions/subscriptions_set.rb

@@ -22,38 +22,38 @@ module PgEventstore
     end
 
     # @!attribute id
-    #   @return [Integer] It is used to lock the Subscription by updating Subscription#locked_by attribute
+    #   @return [Integer, nil] It is used to lock the Subscription by updating Subscription#locked_by attribute
     attribute(:id)
     # @!attribute name
-    #   @return [String] name of the set
+    #   @return [String, nil] name of the set
     attribute(:name)
     # @!attribute state
-    #   @return [String]
+    #   @return [String, nil]
     attribute(:state)
     # @!attribute restart_count
-    #   @return [Integer] the number of SubscriptionsSet's restarts after its failure
+    #   @return [Integer, nil] the number of SubscriptionsSet's restarts after its failure
     attribute(:restart_count)
     # @!attribute max_restarts_number
-    #   @return [Integer] maximum number of times the SubscriptionsSet can be restarted
+    #   @return [Integer, nil] maximum number of times the SubscriptionsSet can be restarted
     attribute(:max_restarts_number)
     # @!attribute time_between_restarts
-    #   @return [Integer] interval in seconds between retries of failed SubscriptionsSet
+    #   @return [Integer, nil] interval in seconds between retries of failed SubscriptionsSet
     attribute(:time_between_restarts)
     # @!attribute last_restarted_at
     #   @return [Time, nil] last time the SubscriptionsSet was restarted
     attribute(:last_restarted_at)
     # @!attribute last_error
-    #   @return [Hash{'class' => String, 'message' => String, 'backtrace' => Array<String>}, nil] the information about
+    #   @return [Hash, nil] the information about
     #     last error caused when pulling Subscriptions events.
     attribute(:last_error)
     # @!attribute last_error_occurred_at
     #   @return [Time, nil] the time when the last error occurred
     attribute(:last_error_occurred_at)
     # @!attribute created_at
-    #   @return [Time]
+    #   @return [Time, nil]
     attribute(:created_at)
     # @!attribute updated_at
-    #   @return [Time]
+    #   @return [Time, nil]
     attribute(:updated_at)
 
     # @param attrs [Hash]
@@ -100,7 +100,7 @@ module PgEventstore
       hash == another.hash
     end
 
-    # @param another [PgEventstore::SubscriptionsSet]
+    # @param another [Object]
     # @return [Boolean]
     def ==(another)
       return false unless another.is_a?(SubscriptionsSet)

data/lib/pg_eventstore/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module PgEventstore
-  VERSION = "1.1.3"
+  # @return [String]
+  VERSION = "1.1.4"
 end

data/lib/pg_eventstore/web/application.rb

@@ -157,8 +157,8 @@ module PgEventstore
         validate_subscription_cmd(params[:cmd])
         cmd_class = SubscriptionRunnerCommands.command_class(params[:cmd])
         SubscriptionCommandQueries.new(connection).find_or_create_by(
-          subscriptions_set_id: params[:set_id],
-          subscription_id: params[:id],
+          subscriptions_set_id: Integer(params[:set_id]),
+          subscription_id: Integer(params[:id]),
           command_name: cmd_class.new.name,
           data: cmd_class.parse_data(Hash(params[:data]))
         )
@@ -170,7 +170,7 @@ module PgEventstore
         validate_subscriptions_set_cmd(params[:cmd])
         cmd_class = SubscriptionFeederCommands.command_class(params[:cmd])
         SubscriptionsSetCommandQueries.new(connection).find_or_create_by(
-          subscriptions_set_id: params[:id],
+          subscriptions_set_id: Integer(params[:id]),
           command_name: cmd_class.new.name,
           data: cmd_class.parse_data(Hash(params[:data]))
         )
@@ -179,20 +179,20 @@ module PgEventstore
       end
 
       post '/delete_subscriptions_set/:id' do
-        SubscriptionsSetQueries.new(connection).delete(params[:id])
+        SubscriptionsSetQueries.new(connection).delete(Integer(params[:id]))
 
         redirect redirect_back_url(fallback_url: url('/subscriptions'))
       end
 
       post '/delete_subscription/:id' do
-        SubscriptionQueries.new(connection).delete(params[:id])
+        SubscriptionQueries.new(connection).delete(Integer(params[:id]))
 
         redirect redirect_back_url(fallback_url: url('/subscriptions'))
       end
 
       post '/delete_all_subscriptions' do
         params[:ids].each do |id|
-          SubscriptionQueries.new(connection).delete(id)
+          SubscriptionQueries.new(connection).delete(Integer(id))
         end
 
         redirect redirect_back_url(fallback_url: url('/subscriptions'))

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

@@ -4,7 +4,21 @@ module PgEventstore
   module Web
     module Paginator
       class BaseCollection
-        attr_reader :config_name, :starting_id, :per_page, :order, :options
+        # @!attribute config_name
+        #   @return [Symbol]
+        attr_reader :config_name
+        # @!attribute starting_id
+        #   @return [String, Integer, nil]
+        attr_reader :starting_id
+        # @!attribute per_page
+        #   @return [Integer]
+        attr_reader :per_page
+        # @!attribute order
+        #   @return [Symbol]
+        attr_reader :order
+        # @!attribute options
+        #   @return [Hash]
+        attr_reader :options
 
         # @param config_name [Symbol]
         # @param starting_id [String, Integer, nil]

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

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

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

@@ -4,17 +4,19 @@ module PgEventstore
   module Web
     module Paginator
       class EventsCollection < BaseCollection
+        # @return [Hash<String => Symbol>] SQL directions, string-to-symbol mapping
         SQL_DIRECTIONS = {
           'asc' => :asc,
           'desc' => :desc
         }.tap do |directions|
           directions.default = :desc
         end.freeze
+        # @return [Hash<String => Integer>] per page limits, string to Integer mapping
         PER_PAGE = %w[10 20 50 100 1000].to_h { [_1, _1.to_i] }.tap do |per_page|
           per_page.default = 10
         end.freeze
-        # Max number of events after which we don't perform the exact count and keep the estimate count instead because of
-        # the potential performance degradation.
+        # @return [Integer] max number of events after which we don't perform the exact count and keep the estimate
+        #   count instead because of the potential performance degradation.
         MAX_NUMBER_TO_COUNT = 10_000
 
         # @return [Array<PgEventstore::Event>]
@@ -68,8 +70,8 @@ module PgEventstore
 
         private
 
-        # @param event [PgEventstore::Eventg]
-        # @return [integer, nil]
+        # @param event [PgEventstore::Event]
+        # @return [Integer, nil]
         def event_global_position(event)
           event&.link&.global_position || event&.global_position
         end
@@ -93,6 +95,7 @@ module PgEventstore
           end.to_a.first['count_all']
         end
 
+        # @param sql_builder [PgEventstore::SQLBuilder]
         # @return [Integer, nil]
         def global_position(sql_builder)
           connection.with do |conn|

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

@@ -4,7 +4,7 @@ module PgEventstore
   module Web
     module Paginator
       module Helpers
-        # @param collection [PgEventstore::Paginator::BaseCollection]
+        # @param collection [PgEventstore::Web::Paginator::BaseCollection]
         # @return [String]
         def previous_page_link(collection)
           id = collection.prev_page_starting_id
@@ -16,7 +16,7 @@ module PgEventstore
         HTML
         end
 
-        # @param collection [PgEventstore::Paginator::BaseCollection]
+        # @param collection [PgEventstore::Web::Paginator::BaseCollection]
         # @return [String]
         def next_page_link(collection)
           id = collection.next_page_starting_id
@@ -98,7 +98,7 @@ module PgEventstore
         private
 
         # @param starting_id [String, Integer, nil]
-        # @param [String, nil]
+        # @return [String]
         def build_starting_id_link(starting_id)
           return 'javascript: void(0);' unless starting_id
 

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

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

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

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