pg_eventstore 1.13.1 → 1.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8ddfb0310abc9f9b78b20c0f8c6466ad2ae585ce66fd7ecae7a94bd6fe179a6
-  data.tar.gz: 2e06fa6f70db70b61f867d33a02eb8c13b50937f6c5afc7cf29f670f8759a9af
+  metadata.gz: 5411bc50e9e33cb1e75d41e3e0955ea68b2f4964a431a039a773727e14575840
+  data.tar.gz: cb0d9c313a28ea13be313bd6c7f7760513b85ad3f4a660ab66588ef2fc1a6441
 SHA512:
-  metadata.gz: f31f6c07073da1a1f460cf65ec55056e1bc7ab28c72f69361cf2c77219ea529324eba85aebbd94cffecbcf3d0354c73b43ca9c3441a7dae39fbc91df8bce792f
-  data.tar.gz: 8b60ce11b14e5832d53f732690043c55662d5007a919d7a734199a55b4f07be7f1faa1ee13163dda12cac4e7772d6f7a12d57966a07ea021dd00b6cfee80a549
+  metadata.gz: 733b57829ff8883f24dd205b1aeb98ff39c2cf33c522ebcd11e9f1b984ee71844edf8cf907928a2cea729732f569b84b432461e8db264bf6d68e79d1f2b9a27b
+  data.tar.gz: fc6bfb9d2acbd4dc8cc3e9f981d5280aecdc3ecd8527a24bf7704309c9b2a52aff08f416e77da2279682ee474ab2c0ecbe014690fcff6969eda7b6199fd404e3

data/.rubocop.yml

@@ -0,0 +1,126 @@
+plugins:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: '3.0'
+  NewCops: enable
+  Exclude:
+    - 'benchmark/*'
+    - 'dev_scripts/**/*'
+
+Layout/LineLength:
+  Max: 120
+
+Layout/DotPosition:
+  EnforcedStyle: 'trailing'
+
+Naming/PredicateMethod:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/IndexedLet:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 6
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MatchArray:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/EmptyLineAfterExample:
+  Enabled: false
+
+RSpec/ImplicitSubject:
+  Enabled: false
+
+RSpec/BeEq:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+RSpec/ExpectChange:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/Semicolon:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RescueModifier:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FetchEnvVar:
+  Enabled: false
+
+Style/NumberedParameters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+Lint/SuppressedException:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [1.13.2]
+
+- Fix a bug that prevents correct processing of CLI commands using public API
+
 ## [1.13.1]
 
 - Do not modify public methods arguments

data/exe/pg-eventstore

@@ -1,15 +1,15 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "pg_eventstore"
-require "pg_eventstore/cli"
-require "logger"
+require 'pg_eventstore'
+require 'pg_eventstore/cli'
+require 'logger'
 
-logger = Logger.new(STDOUT)
+logger = Logger.new($stdout)
 logger.level = :info
-logger.progname = "pg_eventstore"
+logger.progname = 'pg_eventstore'
 logger.formatter = proc do |severity, time, progname, msg|
-  "\e[36m#{progname} | \e[0m#{time.utc.strftime("%FT%TZ")} #{severity}: #{msg}\n"
+  "\e[36m#{progname} | \e[0m#{time.utc.strftime('%FT%TZ')} #{severity}: #{msg}\n"
 end
 
 PgEventstore.logger = logger

data/lib/pg_eventstore/abstract_command.rb

@@ -14,7 +14,7 @@ module PgEventstore
     end
 
     def call(*, **)
-      raise NotImplementedError, "Implement #call in your child class."
+      raise NotImplementedError, 'Implement #call in your child class.'
     end
   end
 end

data/lib/pg_eventstore/callbacks.rb

@@ -121,11 +121,16 @@ module PgEventstore
     end
 
     # @return [Object] the result of the passed block
-    def run_around_callbacks(action, *args, **kwargs, &blk)
+    def run_around_callbacks(action, *args, **kwargs, &_blk)
       result = nil
       stack = [proc { result = yield if block_given? }]
       @callbacks[action][:around]&.reverse_each&.with_index do |callback, index|
-        stack.push(proc { callback.call(stack[index], *args, **kwargs); result })
+        stack.push(
+          proc {
+            callback.call(stack[index], *args, **kwargs)
+            result
+          }
+        )
       end
       stack.last.call(*args, **kwargs)
       result

data/lib/pg_eventstore/cli/commands/callback_handlers/start_cmd_handlers.rb

@@ -29,6 +29,7 @@ module PgEventstore
                 TEXT
               )
               raise unless TryUnlockSubscriptionsSet.try_unlock(manager.config_name, error.lock_id)
+
               retry
             end
           end

data/lib/pg_eventstore/cli/commands/start_subscriptions_command.rb

@@ -39,7 +39,7 @@ module PgEventstore
         def running_subscriptions?
           return true if @subscription_managers.any?(&:running?)
 
-          PgEventstore.logger&.warn("No subscriptions start ups were detected. Existing...")
+          PgEventstore.logger&.warn('No subscriptions start ups were detected. Existing...')
           false
         end
 
@@ -47,7 +47,7 @@ module PgEventstore
         def setup_killsig
           Kernel.trap('TERM') do
             Thread.new do
-              PgEventstore.logger&.info("Received TERM signal, stopping subscriptions and exiting...")
+              PgEventstore.logger&.info('Received TERM signal, stopping subscriptions and exiting...')
             end.join
             # Because the implementation uses Mutex - wrap it into Thread to bypass the limitations of Kernel#trap
             @subscription_managers.map do |manager|
@@ -69,14 +69,15 @@ module PgEventstore
 
         # @return [void]
         def keep_process_alive
-          PgEventstore.logger&.info("Startup is successful. Processing subscriptions...")
+          PgEventstore.logger&.info('Startup is successful. Processing subscriptions...')
           loop do
             # SubscriptionsManager#subscriptions_set becomes nil when everything gets stopped.
             if @subscription_managers.all? { |manager| manager.subscriptions_set.nil? }
-              PgEventstore.logger&.info("All subscriptions were gracefully shut down. Exiting now...")
+              PgEventstore.logger&.info('All subscriptions were gracefully shut down. Exiting now...')
               break
             end
             break unless @running
+
             sleep KEEP_ALIVE_INTERVAL
           end
         end

data/lib/pg_eventstore/cli/parser_options/metadata.rb

@@ -21,12 +21,12 @@ module PgEventstore
           to_parser_opts.hash
         end
 
-        # @param another [Object]
+        # @param other [Object]
         # @return [Boolean]
-        def ==(another)
-          return false unless another.is_a?(Metadata)
+        def ==(other)
+          return false unless other.is_a?(Metadata)
 
-          to_parser_opts == another.to_parser_opts
+          to_parser_opts == other.to_parser_opts
         end
         alias eql? ==
       end

data/lib/pg_eventstore/cli/parsers/default_parser.rb

@@ -8,14 +8,14 @@ module PgEventstore
           # @return [String]
           def banner
             <<~TEXT
-            Usage: pg-eventstore [options]
-                   pg-eventstore [command]
-        
-              Commands:
-                subscriptions     Start, stop subscriptions
-  
-              Options:
-          TEXT
+              Usage: pg-eventstore [options]
+                     pg-eventstore [command]
+
+                Commands:
+                  subscriptions     Start, stop subscriptions
+
+                Options:
+            TEXT
           end
         end
       end

data/lib/pg_eventstore/cli/parsers/subscription_parser.rb

@@ -9,9 +9,9 @@ module PgEventstore
           def banner
             <<~TEXT
               Usage: pg-eventstore subscriptions [command] [options]
-                
+
                 Commands:
-                  start     Start subscriptions. Example: pg-eventstore subscriptions start -r lib/my_subscriptions.rb 
+                  start     Start subscriptions. Example: pg-eventstore subscriptions start -r lib/my_subscriptions.rb
                   stop      Stop subscriptions. Example: pg-eventstore subscriptions stop
 
                 Options:

data/lib/pg_eventstore/cli/try_to_delete_subscriptions_set.rb

@@ -32,7 +32,10 @@ module PgEventstore
         # Wait for potential recover plus run interval and plus another second to allow potential processing of
         # "Ping" command. "Ping" command comes in prio, so it is guaranteed it will be processed as a first command.
         sleep RunnerRecoveryStrategies::RestoreConnection::TIME_BETWEEN_RETRIES + CommandsHandler::PULL_INTERVAL + 1
-        if subscriptions_set_commands_queries.find_by(subscriptions_set_id: subscriptions_set_id, command_name: cmd_name)
+        existing_cmd = subscriptions_set_commands_queries.find_by(
+          subscriptions_set_id: subscriptions_set_id, command_name: cmd_name
+        )
+        if existing_cmd
           # "Ping" command wasn't consumed. Related process must be dead.
           subscriptions_set_queries.delete(subscriptions_set_id)
           PgEventstore.logger&.info(

data/lib/pg_eventstore/cli.rb

@@ -10,14 +10,14 @@ require_relative 'cli/commands'
 module PgEventstore
   module CLI
     OPTIONS_PARSER = {
-      "subscriptions" => [Parsers::SubscriptionParser, ParserOptions::SubscriptionOptions].freeze
+      'subscriptions' => [Parsers::SubscriptionParser, ParserOptions::SubscriptionOptions].freeze,
     }.tap do |directions|
       directions.default = [Parsers::DefaultParser, ParserOptions::DefaultOptions].freeze
     end.freeze
 
     COMMANDS = {
-      ["subscriptions", "start"].freeze => Commands::StartSubscriptionsCommand,
-      ["subscriptions", "stop"].freeze => Commands::StopSubscriptionsCommand
+      %w[subscriptions start].freeze => Commands::StartSubscriptionsCommand,
+      %w[subscriptions stop].freeze => Commands::StopSubscriptionsCommand,
     }.freeze
 
     class << self
@@ -30,7 +30,7 @@ module PgEventstore
       # @return [Integer] exit code
       def execute(args)
         options_parser_class, options_class = OPTIONS_PARSER[args[0]]
-        command, parsed_options = options_parser_class.new(ARGV, options_class.new).parse
+        command, parsed_options = options_parser_class.new(args, options_class.new).parse
         return Commands::HelpCommand.new(parsed_options).call if parsed_options.help
         return COMMANDS[command].new(parsed_options).call if COMMANDS[command]
 

data/lib/pg_eventstore/commands/all_stream_read_grouped.rb

@@ -48,7 +48,7 @@ module PgEventstore
         stream_ids.map do |stream_id|
           filter = {
             streams: [{ context: partition.context, stream_name: partition.stream_name, stream_id: stream_id }],
-            event_types: [partition.event_type]
+            event_types: [partition.event_type],
           }
           options.merge(filter: filter, max_count: 1)
         end
@@ -60,7 +60,7 @@ module PgEventstore
       def build_filter_options_for_partitions(partition, options)
         filter = {
           streams: [{ context: partition.context, stream_name: partition.stream_name }],
-          event_types: [partition.event_type]
+          event_types: [partition.event_type],
         }
         options.merge(filter: filter, max_count: 1)
       end

data/lib/pg_eventstore/commands/event_modifiers/prepare_link_event.rb

@@ -13,6 +13,7 @@ module PgEventstore
           @partitions = {}
           @partition_queries = partition_queries
         end
+
         # @param event [PgEventstore::Event]
         # @param revision [Integer]
         # @return [PgEventstore::Event]

data/lib/pg_eventstore/commands/link_to.rb

@@ -28,12 +28,11 @@ module PgEventstore
       # @return [void]
       def check_events_presence(events)
         ids_from_db = queries.events.ids_from_db(events)
-        (events.map(&:id) - ids_from_db).tap do |missing_ids|
-          return if missing_ids.empty?
+        missing_ids = events.map(&:id) - ids_from_db
+        return if missing_ids.empty?
 
-          missing_event = events.find { |event| event.id == missing_ids.first }
-          raise NotPersistedEventError, missing_event
-        end
+        missing_event = events.find { |event| event.id == missing_ids.first }
+        raise NotPersistedEventError, missing_event
       end
     end
   end

data/lib/pg_eventstore/commands/multiple.rb

@@ -5,9 +5,7 @@ module PgEventstore
     # @!visibility private
     class Multiple < AbstractCommand
       def call(&blk)
-        queries.transactions.transaction do
-          yield
-        end
+        queries.transactions.transaction(&blk)
       end
     end
   end

data/lib/pg_eventstore/commands/regular_stream_read_paginated.rb

@@ -17,7 +17,7 @@ module PgEventstore
             end
 
             next_revision = calc_next_revision(events, options[:direction])
-            raise StopIteration if next_revision.negative?
+            raise StopIteration if next_revision < 0
           end
         end
       end

data/lib/pg_eventstore/config.rb

@@ -10,7 +10,7 @@ module PgEventstore
     #   @return [String] PostgreSQL connection URI docs
     #     https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS
     option(:pg_uri) do
-      ENV.fetch('PG_EVENTSTORE_URI') { 'postgresql://postgres:postgres@localhost:5432/eventstore' }
+      ENV.fetch('PG_EVENTSTORE_URI', 'postgresql://postgres:postgres@localhost:5432/eventstore')
     end
     # @!attribute max_count
     #   @return [Integer] Number of events to return in one response when reading from a stream

data/lib/pg_eventstore/connection.rb

@@ -63,7 +63,7 @@ module PgEventstore
     # A shorthand from ConnectionPool#with.
     # @yieldparam connection [PG::Connection] PostgreSQL connection instance
     # @return [Object] a value of a given block
-    def with(&blk)
+    def with(&_blk)
       should_retry = true
       @pool.with do |conn|
         yield conn
@@ -72,6 +72,7 @@ module PgEventstore
         # delay.
         conn.sync_reset
         raise unless should_retry
+
         should_retry = false
         retry
       end
@@ -85,6 +86,7 @@ module PgEventstore
     private
 
     # @return [ConnectionPool]
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def init_pool
       @pool ||= ConnectionPool.new(size: pool_size, timeout: pool_timeout) do
         PgConnection.new(uri).tap do |conn|
@@ -93,6 +95,7 @@ module PgEventstore
         end
       end
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
 
     # @return [PG::BasicTypeRegistry]
     def pg_type_registry

data/lib/pg_eventstore/errors.rb

@@ -220,6 +220,7 @@ module PgEventstore
     def initialize(stream, event_types)
       @stream = stream
       @event_types = event_types
+      super("Missing partitions for stream #{stream.inspect}, event types #{event_types.inspect}")
     end
   end
 
@@ -244,13 +245,14 @@ module PgEventstore
     end
   end
 
-  class WrappedException < Error
+  class WrappedException < StandardError
     attr_reader :original_exception
     attr_reader :extra
 
     def initialize(original_exception, extra)
       @original_exception = original_exception
       @extra = extra
+      super()
     end
   end
 end

data/lib/pg_eventstore/extensions/callbacks_extension.rb

@@ -71,6 +71,7 @@ module PgEventstore
         # @param action [String, Symbol]
         # @param method_name [Symbol]
         # @return [void]
+        # rubocop:disable Naming/PredicatePrefix
         def has_callbacks(action, method_name)
           visibility_method = visibility_method(method_name)
           m = Module.new do
@@ -81,6 +82,7 @@ module PgEventstore
           end
           prepend m
         end
+        # rubocop:enable Naming/PredicatePrefix
 
         private
 

data/lib/pg_eventstore/extensions/options_extension.rb

@@ -50,20 +50,20 @@ module PgEventstore
           @metadata = metadata
         end
 
-        # @param other_option [Object]
+        # @param other [Object]
         # @return [Boolean]
-        def ==(other_option)
-          return false unless other_option.is_a?(Option)
+        def ==(other)
+          return false unless other.is_a?(Option)
 
-          name == other_option.name
+          name == other.name
         end
 
-        # @param other_option [Object]
+        # @param other [Object]
         # @return [Boolean]
-        def eql?(other_option)
-          return false unless other_option.is_a?(Option)
+        def eql?(other)
+          return false unless other.is_a?(Option)
 
-          name.eql?(other_option.name)
+          name.eql?(other.name)
         end
 
         # @return [Integer]
@@ -73,8 +73,8 @@ module PgEventstore
       end
 
       class Options < Set
-        def add(o)
-          @hash[o] = o
+        def add(option)
+          @hash[option] = option
           self
         end
 

data/lib/pg_eventstore/extensions/using_connection_extension.rb

@@ -23,7 +23,7 @@ module PgEventstore
           Class.new(original_class).tap do |klass|
             klass.define_singleton_method(:connection) { PgEventstore.connection(config_name) }
             klass.class_eval do
-              [:to_s, :inspect, :name].each do |m|
+              %i[to_s inspect name].each do |m|
                 define_singleton_method(m, &original_class.method(m))
               end
             end

data/lib/pg_eventstore/pg_connection.rb

@@ -18,11 +18,13 @@ module PgEventstore
     def log(sql, params)
       return unless PgEventstore.logger&.debug?
 
-      sql = sql.gsub(/\$\d+/).each do |matched|
-        value = params[matched[1..].to_i - 1]
-        value = encode_value(value)
-        normalize_value(value)
-      end unless params&.empty?
+      unless params&.empty?
+        sql = sql.gsub(/\$\d+/).each do |matched|
+          value = params[matched[1..].to_i - 1]
+          value = encode_value(value)
+          normalize_value(value)
+        end
+      end
       PgEventstore.logger.debug(sql)
     end
 

data/lib/pg_eventstore/queries/event_queries.rb

@@ -48,18 +48,18 @@ module PgEventstore
         sql_builder.where_or('context = ? and stream_name = ? and type = ?', context, stream_name, event_type)
       end
       sql_builder.where('id = ANY(?::uuid[])', events.map(&:id))
-      PgEventstore.connection.with do |conn|
+      raw_events = PgEventstore.connection.with do |conn|
         conn.exec_params(*sql_builder.to_exec_params)
-      end.to_a.map { |attrs| attrs['id'] }
+      end.to_a
+      raw_events.map { |attrs| attrs['id'] }
     end
 
     # @param stream [PgEventstore::Stream]
     # @return [Integer, nil]
     def stream_revision(stream)
-      sql_builder = SQLBuilder.new.from('events').select('stream_revision').
-        where('context = ? and stream_name = ? and stream_id = ?', *stream.to_a).
-        order('stream_revision DESC').
-        limit(1)
+      sql_builder = SQLBuilder.new.from('events').select('stream_revision')
+      sql_builder.where('context = ? and stream_name = ? and stream_id = ?', *stream.to_a)
+      sql_builder.order('stream_revision DESC').limit(1)
       connection.with do |conn|
         conn.exec_params(*sql_builder.to_exec_params)
       end.to_a.dig(0, 'stream_revision')
@@ -86,14 +86,15 @@ module PgEventstore
       columns = %w[id data metadata stream_revision link_id link_partition_id type context stream_name stream_id]
 
       sql = <<~SQL
-        INSERT INTO events (#{columns.join(', ')}) 
-          VALUES #{sql_rows_for_insert.join(", ")} 
+        INSERT INTO events (#{columns.join(', ')})
+          VALUES #{sql_rows_for_insert.join(', ')}
           RETURNING *
       SQL
 
-      connection.with do |conn|
+      raw_events = connection.with do |conn|
         conn.exec_params(sql, values)
-      end.map do |raw_event|
+      end
+      raw_events.map do |raw_event|
         deserializer.without_middlewares.deserialize(raw_event)
       end
     end

data/lib/pg_eventstore/queries/partition_queries.rb

@@ -55,7 +55,7 @@ module PgEventstore
       end
 
       partition_sql = <<~SQL
-        INSERT INTO partitions (#{attributes.keys.join(', ')}) 
+        INSERT INTO partitions (#{attributes.keys.join(', ')})
           VALUES (#{Utils.positional_vars(attributes.values)}) RETURNING *
       SQL
       partition = connection.with do |conn|
@@ -87,7 +87,7 @@ module PgEventstore
       end
 
       partition_sql = <<~SQL
-        INSERT INTO partitions (#{attributes.keys.join(', ')}) 
+        INSERT INTO partitions (#{attributes.keys.join(', ')})
           VALUES (#{Utils.positional_vars(attributes.values)}) RETURNING *
       SQL
       partition = connection.with do |conn|
@@ -116,8 +116,8 @@ module PgEventstore
       return unless partition_required?(stream, event_type)
 
       context_partition = context_partition(stream) || create_context_partition(stream)
-      stream_name_partition = stream_name_partition(stream) ||
-        create_stream_name_partition(stream, context_partition['table_name'])
+      stream_name_partition =
+        stream_name_partition(stream) || create_stream_name_partition(stream, context_partition['table_name'])
 
       create_event_type_partition(stream, event_type, stream_name_partition['table_name'])
     end