event_sourcery-postgres 0.9.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 824d15b46de51809119f1adec5708cab3e6e252dabeedc5257cda2b1c934a7bf
-  data.tar.gz: deea46e08d13e42d46d37ac7379ccc9782a87e5137710004ce1c922ad283f40d
+  metadata.gz: d0257d9a0f70fe078196251fc6de2944278cb2ddf7dda70e2125ce1217d62af6
+  data.tar.gz: 4ff91be144b82ec02988d7993a7094618e002ffce96ec7dfde1cde054fb15668
 SHA512:
-  metadata.gz: a9cf1a6d3aad1270378fa68855ca339a3a0bca8aa13c8c06c82da634b340a93822d73254da780fbc6ef7420f9901836ebd81d68cfe0c8c506584b1be3c50c028
-  data.tar.gz: 520be11bd4e97b6ecd07fcc995c613c4978dcb97509569d15fda3d28206acd41696db718d54bc54861f72a38e59bdaf61a18369aa09c60cc748991700cb5dc90
+  metadata.gz: 5cd37ea3284ab95e970e704bbabdb14c2160dd3a7612a48927fc99e15a72b074d8c704c0239a75256a158bf468df93c110dcaa0d0ce46da4f871ceb1fd0390c9
+  data.tar.gz: d9e5f9281bcc91bb364e1dd607065199b97f144118841183807ce78a3a7a0ab4997fc6e12a625d0f15aaf3b15076d769a03b56362e47201906539ed29d8fefb4

data/CHANGELOG.md

@@ -6,6 +6,33 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+
+[Unreleased]: https://github.com/envato/event_sourcery-postgres/compare/v1.0.1...HEAD
+
+## [1.0.1] - 2026-01-17
+
+### Changed
+
+- Resolve issues as identified by RuboCop ([#85]).
+
+[1.0.0]: https://github.com/envato/event_sourcery-postgres/compare/v1.0.0...v1.0.1
+[#85]: https://github.com/envato/event_sourcery-postgres/pull/85
+
+## [1.0.0] - 2025-12-28
+
+### Changed
+
+- Resolve issues as identified by RuboCop ([#78], [#82], [#83]).
+- Minor fixups in gem metadata ([#79]).
+- Remove support for older Ruby versions: Ruby 2.6 or greater is now required ([#80]).
+
+[1.0.0]: https://github.com/envato/event_sourcery-postgres/compare/v0.9.1...v1.0.0
+[#78]: https://github.com/envato/event_sourcery-postgres/pull/78
+[#79]: https://github.com/envato/event_sourcery-postgres/pull/79
+[#80]: https://github.com/envato/event_sourcery-postgres/pull/80
+[#82]: https://github.com/envato/event_sourcery-postgres/pull/82
+[#83]: https://github.com/envato/event_sourcery-postgres/pull/83
+
 ## [0.9.1] - 2022-01-20
 
 ### Changed
@@ -117,7 +144,6 @@ or when the loop stops
 - Postgres related configuration is through `EventSourcery::Postgres.configure`
   instead of `EventSourcery.configure`.
 
-[Unreleased]: https://github.com/envato/event_sourcery-postgres/compare/v0.9.1...HEAD
 [0.9.1]: https://github.com/envato/event_sourcery-postgres/compare/v0.9.0...v0.9.1
 [0.9.0]: https://github.com/envato/event_sourcery-postgres/compare/v0.8.1...v0.9.0
 [0.8.1]: https://github.com/envato/event_sourcery-postgres/compare/v0.8.0...v0.8.1

data/README.md

@@ -1,12 +1,10 @@
 # EventSourcery::Postgres
 
-[![Build Status](https://github.com/envato/event_sourcery-postgres/workflows/tests/badge.svg?branch=main)](https://github.com/envato/event_sourcery-postgres/actions?query=workflow%3Atests+branch%3Amain)
+[![Build Status](https://github.com/envato/event_sourcery-postgres/actions/workflows/test.yml/badge.svg)](https://github.com/envato/event_sourcery-postgres/actions/workflows/test.yml)
 
 ## Development Status
 
-EventSourcery is currently being used in production by multiple apps but we
-haven't finalized the API yet and things are still moving rapidly. Until we
-release a 1.0 things may change without first being deprecated.
+EventSourcery::Postgres is in production use at [Envato](http://envato.com).
 
 ## Installation
 

data/event_sourcery-postgres.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'event_sourcery/postgres/version'
 
@@ -12,27 +13,32 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Postgres event store for use with EventSourcery'
   spec.homepage      = 'https://github.com/envato/event_sourcery-postgres'
+  spec.license       = 'MIT'
+
   spec.metadata      = {
-                         'bug_tracker_uri' => 'https://github.com/envato/event_sourcery-postgres/issues',
-                         'changelog_uri'   => 'https://github.com/envato/event_sourcery-postgres/blob/HEAD/CHANGELOG.md',
-                         'source_code_uri' => 'https://github.com/envato/event_sourcery-postgres',
-                       }
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri' => "#{spec.homepage}/issues",
+    'changelog_uri' => "#{spec.homepage}/blob/HEAD/CHANGELOG.md",
+    'documentation_uri' => "https://www.rubydoc.info/gems/#{spec.name}/#{spec.version}",
+    'source_code_uri' => "#{spec.homepage}/tree/v#{spec.version}"
+  }
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(\.|bin/|Gemfile|Rakefile|script/|spec/)})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.required_ruby_version = '>= 2.6.0'
 
-  spec.add_dependency 'sequel', '>= 4.38'
-  spec.add_dependency 'pg'
   spec.add_dependency 'event_sourcery', '>= 0.14.0'
+  spec.add_dependency 'pg'
+  spec.add_dependency 'sequel', '>= 4.38'
+  spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'rubocop', '~> 1'
 end

data/lib/event_sourcery/postgres/config.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module EventSourcery
   module Postgres
+    # Configuration settings for the PostgreSQL event store and projections.
     class Config
       attr_accessor :lock_table_to_guarantee_linear_sequence_id_growth,
                     :write_events_function_name,

data/lib/event_sourcery/postgres/event_store.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module EventSourcery
   module Postgres
+    # PostgreSQL implementation of an event store for persisting and retrieving domain events.
     class EventStore
       include EventSourcery::EventStore::EachByRange
 
@@ -32,6 +35,7 @@ module EventSourcery
         events = Array(event_or_events)
         aggregate_ids = events.map(&:aggregate_id).uniq
         raise AtomicWriteToMultipleAggregatesNotSupported unless aggregate_ids.count == 1
+
         sql = write_events_sql(aggregate_ids.first, events, expected_version)
         @db_connection.run(sql)
         log_events_saved(events)
@@ -40,9 +44,9 @@ module EventSourcery
       rescue Sequel::DatabaseError => e
         if e.message =~ /Concurrency conflict/
           raise ConcurrencyError, "expected version was not #{expected_version}. Error: #{e.message}"
-        else
-          raise
         end
+
+        raise
       end
 
       # Get the next set of events from the given event id. You can
@@ -55,10 +59,11 @@ module EventSourcery
       #
       # @return [Array] array of found events
       def get_next_from(id, event_types: nil, limit: 1000)
-        query = events_table.
-          order(:id).
-          where(Sequel.lit('id >= ?', id)).
-          limit(limit)
+        query =
+          events_table
+          .order(:id)
+          .where(Sequel.lit('id >= ?', id))
+          .limit(limit)
         query = query.where(type: event_types) if event_types
         query.map { |event_row| build_event(event_row) }
       end
@@ -96,7 +101,7 @@ module EventSourcery
       # @param event_types the event_types to subscribe to, default all.
       # @param after_listen the after listen call back block. default nil.
       # @param subscription_master the subscription master block
-      def subscribe(from_id:, event_types: nil, after_listen: nil, subscription_master:, &block)
+      def subscribe(from_id:, subscription_master:, event_types: nil, after_listen: nil, &block)
         poll_waiter = OptimisedEventPollWaiter.new(db_connection: @db_connection, after_listen: after_listen)
         args = {
           poll_waiter: poll_waiter,
@@ -157,9 +162,10 @@ module EventSourcery
 
       def to_sql_literal(value)
         return 'null' unless value
-        wrapped_value = if Time === value
+
+        wrapped_value = if value.is_a?(Time)
                           value.iso8601(6)
-                        elsif Hash === value
+                        elsif value.is_a?(Hash)
                           Sequel.pg_json(value)
                         else
                           value

data/lib/event_sourcery/postgres/optimised_event_poll_waiter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EventSourcery
   module Postgres
     # Optimise poll interval with Postgres listen/notify
@@ -11,7 +13,7 @@ module EventSourcery
         @after_listen = after_listen
       end
 
-      def poll(after_listen: proc { }, &block)
+      def poll(after_listen: proc {}, &block)
         @events_queue.callback = proc do
           ensure_listen_thread_alive!
           block.call
@@ -52,7 +54,7 @@ module EventSourcery
         after_listen_callback = if after_listen
                                   proc do
                                     after_listen.call
-                                    @after_listen.call if @after_listen
+                                    @after_listen&.call
                                   end
                                 else
                                   @after_listen

data/lib/event_sourcery/postgres/projector.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module EventSourcery
   module Postgres
+    # Mixin providing projection capabilities for processing events into read models.
     module Projector
       def self.included(base)
         base.include(EventProcessing::EventStreamProcessor)
@@ -15,6 +18,7 @@ module EventSourcery
         end
       end
 
+      # Instance methods for projector event processing and tracking.
       module InstanceMethods
         def initialize(tracker: EventSourcery::Postgres.config.event_tracker,
                        db_connection: EventSourcery::Postgres.config.projections_database,

data/lib/event_sourcery/postgres/queue_with_interval_callback.rb

@@ -1,17 +1,25 @@
+# frozen_string_literal: true
+
 module EventSourcery
   module Postgres
+    # Queue that invokes a callback at regular intervals when no items are available.
     class QueueWithIntervalCallback < ::Queue
       attr_accessor :callback
 
-      def initialize(callback: proc {}, callback_interval: EventSourcery::Postgres.config.callback_interval_if_no_new_events, poll_interval: 0.1)
+      def initialize(
+        callback: proc {},
+        callback_interval: EventSourcery::Postgres.config.callback_interval_if_no_new_events,
+        poll_interval: 0.1
+      )
         @callback = callback
         @callback_interval = callback_interval
         @poll_interval = poll_interval
         super()
       end
 
-      def pop(non_block_without_callback = false)
+      def pop(non_block_without_callback = false) # rubocop:disable Style/OptionalBooleanParameter
         return super if non_block_without_callback
+
         pop_with_interval_callback
       end
 
@@ -21,6 +29,7 @@ module EventSourcery
         time = Time.now
         loop do
           return pop(true) unless empty?
+
           if @callback_interval && Time.now > time + @callback_interval
             @callback.call
             time = Time.now

data/lib/event_sourcery/postgres/reactor.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module EventSourcery
   module Postgres
+    # Mixin providing reactor capabilities for processing events and emitting new events in response.
     module Reactor
       UndeclaredEventEmissionError = Class.new(StandardError)
 
@@ -10,6 +13,7 @@ module EventSourcery
         base.include(InstanceMethods)
       end
 
+      # Class methods for declaring and querying emitted event types.
       module ClassMethods
         # Assign the types of events this reactor can emit.
         #
@@ -20,7 +24,7 @@ module EventSourcery
 
         # @return [Array] an array of the types of events this reactor can emit
         def emit_events
-          @emits_event_types ||= []
+          @emits_event_types ||= [] # rubocop:disable Naming/MemoizedInstanceVariableName
         end
 
         # This will tell you if this reactor emits any type of event.
@@ -39,6 +43,7 @@ module EventSourcery
         end
       end
 
+      # Instance methods for reactor initialisation and event emission.
       module InstanceMethods
         def initialize(tracker: EventSourcery::Postgres.config.event_tracker,
                        db_connection: EventSourcery::Postgres.config.projections_database,
@@ -48,11 +53,10 @@ module EventSourcery
           @event_source = event_source
           @event_sink = event_sink
           @db_connection = db_connection
-          if self.class.emits_events?
-            if event_sink.nil? || event_source.nil?
-              raise ArgumentError, 'An event sink and source is required for processors that emit events'
-            end
-          end
+          return unless self.class.emits_events?
+          return unless event_sink.nil? || event_source.nil?
+
+          raise ArgumentError, 'An event sink and source is required for processors that emit events'
         end
       end
 
@@ -61,19 +65,20 @@ module EventSourcery
       attr_reader :event_sink, :event_source
 
       def emit_event(event_or_hash, &block)
-        event = if Event === event_or_hash
+        event = if event_or_hash.is_a?(Event)
                   event_or_hash
                 else
                   Event.new(event_or_hash)
                 end
         raise UndeclaredEventEmissionError unless self.class.emits_event?(event.class)
+
         event = event.with(causation_id: _event.uuid, correlation_id: _event.correlation_id)
         invoke_action_and_emit_event(event, block)
-        EventSourcery.logger.debug { "[#{self.processor_name}] Emitted event: #{event.inspect}" }
+        EventSourcery.logger.debug { "[#{processor_name}] Emitted event: #{event.inspect}" }
       end
 
       def invoke_action_and_emit_event(event, action)
-        action.call(event.body) if action
+        action&.call(event.body)
         event_sink.sink(event)
       end
     end

data/lib/event_sourcery/postgres/schema.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module EventSourcery
   module Postgres
+    # Schema management for creating event store and projector tables in PostgreSQL.
     module Schema
       module_function
 
@@ -15,7 +18,12 @@ module EventSourcery
                              write_events_function_name: EventSourcery::Postgres.config.write_events_function_name)
         create_events(db: db, table_name: events_table_name)
         create_aggregates(db: db, table_name: aggregates_table_name)
-        create_or_update_functions(db: db, events_table_name: events_table_name, function_name: write_events_function_name, aggregates_table_name: aggregates_table_name)
+        create_or_update_functions(
+          db: db,
+          events_table_name: events_table_name,
+          function_name: write_events_function_name,
+          aggregates_table_name: aggregates_table_name
+        )
       end
 
       # Create the events table. Needs the database and the table name.
@@ -35,8 +43,9 @@ module EventSourcery
           column :version,        :bigint,  null: false
           column :correlation_id, :uuid
           column :causation_id,   :uuid
-          column :created_at,     :'timestamp without time zone', null: false, default: Sequel.lit("(now() at time zone 'utc')")
-          index [:aggregate_id, :version], unique: true
+          column :created_at,     :'timestamp without time zone', null: false,
+                                                                  default: Sequel.lit("(now() at time zone 'utc')")
+          index %i[aggregate_id version], unique: true
           index :uuid, unique: true
           index :type
           index :correlation_id
@@ -70,96 +79,96 @@ module EventSourcery
                                      function_name: EventSourcery::Postgres.config.write_events_function_name,
                                      events_table_name: EventSourcery::Postgres.config.events_table_name,
                                      aggregates_table_name: EventSourcery::Postgres.config.aggregates_table_name)
-        db.run <<-SQL
-create or replace function #{function_name}(_aggregateId uuid,
-                                            _eventTypes varchar[],
-                                            _expectedVersion int,
-                                            _bodies json[],
-                                            _createdAtTimes timestamp without time zone[],
-                                            _eventUUIDs uuid[],
-                                            _correlationIds uuid[],
-                                            _causationIds uuid[],
-                                            _lockTable boolean) returns void as $$
-declare
-currentVersion int;
-body json;
-eventVersion int;
-eventId text;
-index int;
-newVersion int;
-numEvents int;
-createdAt timestamp without time zone;
-begin
-numEvents := array_length(_bodies, 1);
-select version into currentVersion from #{aggregates_table_name} where aggregate_id = _aggregateId;
-if not found then
-  -- when we have no existing version for this aggregate
-  if _expectedVersion = 0 or _expectedVersion is null then
-    -- set the version to 1 if expected version is null or 0
-    insert into #{aggregates_table_name}(aggregate_id, version) values(_aggregateId, numEvents);
-    currentVersion := 0;
-  else
-    raise 'Concurrency conflict. Current version: 0, expected version: %', _expectedVersion;
-  end if;
-else
-  if _expectedVersion is null then
-    -- automatically increment the version
-    update #{aggregates_table_name} set version = version + numEvents where aggregate_id = _aggregateId returning version into newVersion;
-    currentVersion := newVersion - numEvents;
-  else
-    -- increment the version if it's at our expected version
-    update #{aggregates_table_name} set version = version + numEvents where aggregate_id = _aggregateId and version = _expectedVersion;
-    if not found then
-      -- version was not at expected_version, raise an error.
-      -- currentVersion may not equal what it did in the database when the
-      -- above update statement is executed (it may have been incremented by another
-      -- process)
-      raise 'Concurrency conflict. Last known current version: %, expected version: %', currentVersion, _expectedVersion;
-    end if;
-  end if;
-end if;
-index := 1;
-eventVersion := currentVersion + 1;
-if _lockTable then
-    -- Ensure this transaction is the only one writing events to guarantee
-    -- linear growth of sequence IDs.
-    -- Any value that won't conflict with other advisory locks will work.
-    -- The Postgres tracker currently obtains an advisory lock using it's
-    -- integer row ID, so values 1 to the number of ESP's in the system would
-    -- be taken if the tracker is running in the same database as your
-    -- projections.
-    perform pg_advisory_xact_lock(-1);
-end if;
-foreach body IN ARRAY(_bodies)
-loop
-  if _createdAtTimes[index] is not null then
-    createdAt := _createdAtTimes[index];
-  else
-    createdAt := now() at time zone 'utc';
-  end if;
+        db.run <<~SQL
+          create or replace function #{function_name}(_aggregateId uuid,
+                                                      _eventTypes varchar[],
+                                                      _expectedVersion int,
+                                                      _bodies json[],
+                                                      _createdAtTimes timestamp without time zone[],
+                                                      _eventUUIDs uuid[],
+                                                      _correlationIds uuid[],
+                                                      _causationIds uuid[],
+                                                      _lockTable boolean) returns void as $$
+          declare
+          currentVersion int;
+          body json;
+          eventVersion int;
+          eventId text;
+          index int;
+          newVersion int;
+          numEvents int;
+          createdAt timestamp without time zone;
+          begin
+          numEvents := array_length(_bodies, 1);
+          select version into currentVersion from #{aggregates_table_name} where aggregate_id = _aggregateId;
+          if not found then
+            -- when we have no existing version for this aggregate
+            if _expectedVersion = 0 or _expectedVersion is null then
+              -- set the version to 1 if expected version is null or 0
+              insert into #{aggregates_table_name}(aggregate_id, version) values(_aggregateId, numEvents);
+              currentVersion := 0;
+            else
+              raise 'Concurrency conflict. Current version: 0, expected version: %', _expectedVersion;
+            end if;
+          else
+            if _expectedVersion is null then
+              -- automatically increment the version
+              update #{aggregates_table_name} set version = version + numEvents where aggregate_id = _aggregateId returning version into newVersion;
+              currentVersion := newVersion - numEvents;
+            else
+              -- increment the version if it's at our expected version
+              update #{aggregates_table_name} set version = version + numEvents where aggregate_id = _aggregateId and version = _expectedVersion;
+              if not found then
+                -- version was not at expected_version, raise an error.
+                -- currentVersion may not equal what it did in the database when the
+                -- above update statement is executed (it may have been incremented by another
+                -- process)
+                raise 'Concurrency conflict. Last known current version: %, expected version: %', currentVersion, _expectedVersion;
+              end if;
+            end if;
+          end if;
+          index := 1;
+          eventVersion := currentVersion + 1;
+          if _lockTable then
+              -- Ensure this transaction is the only one writing events to guarantee
+              -- linear growth of sequence IDs.
+              -- Any value that won't conflict with other advisory locks will work.
+              -- The Postgres tracker currently obtains an advisory lock using it's
+              -- integer row ID, so values 1 to the number of ESP's in the system would
+              -- be taken if the tracker is running in the same database as your
+              -- projections.
+              perform pg_advisory_xact_lock(-1);
+          end if;
+          foreach body IN ARRAY(_bodies)
+          loop
+            if _createdAtTimes[index] is not null then
+              createdAt := _createdAtTimes[index];
+            else
+              createdAt := now() at time zone 'utc';
+            end if;
 
-  insert into #{events_table_name}
-    (uuid, aggregate_id, type, body, version, correlation_id, causation_id, created_at)
-  values
-    (
-      _eventUUIDs[index],
-      _aggregateId,
-      _eventTypes[index],
-      body,
-      eventVersion,
-      _correlationIds[index],
-      _causationIds[index],
-      createdAt
-    )
-  returning id into eventId;
+            insert into #{events_table_name}
+              (uuid, aggregate_id, type, body, version, correlation_id, causation_id, created_at)
+            values
+              (
+                _eventUUIDs[index],
+                _aggregateId,
+                _eventTypes[index],
+                body,
+                eventVersion,
+                _correlationIds[index],
+                _causationIds[index],
+                createdAt
+              )
+            returning id into eventId;
 
-  eventVersion := eventVersion + 1;
-  index := index + 1;
-end loop;
-perform pg_notify('new_event', eventId);
-end;
-$$ language plpgsql;
-SQL
+            eventVersion := eventVersion + 1;
+            index := index + 1;
+          end loop;
+          perform pg_notify('new_event', eventId);
+          end;
+          $$ language plpgsql;
+        SQL
       end
 
       # Create the projector tracker table. Needs the database and the table name.

data/lib/event_sourcery/postgres/table_owner.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module EventSourcery
   module Postgres
+    # Mixin providing table management capabilities for projectors and reactors.
     module TableOwner
       DefaultTableError = Class.new(StandardError)
       NoSuchTableError = Class.new(StandardError)
@@ -8,6 +11,7 @@ module EventSourcery
         base.extend(ClassMethods)
       end
 
+      # Class methods for defining and managing database tables.
       module ClassMethods
         # Hash of the tables and their corresponding blocks.
         #
@@ -36,11 +40,9 @@ module EventSourcery
 
       # Reset by dropping each table.
       def reset
-        self.class.tables.keys.each do |table_name|
+        self.class.tables.each_key do |table_name|
           prefixed_name = table_name_prefixed(table_name)
-          if @db_connection.table_exists?(prefixed_name)
-            @db_connection.drop_table(prefixed_name, cascade: true)
-          end
+          @db_connection.drop_table(prefixed_name, cascade: true) if @db_connection.table_exists?(prefixed_name)
         end
         super if defined?(super)
         setup
@@ -49,7 +51,7 @@ module EventSourcery
       # This will truncate all the tables and reset the tracker back to 0,
       # done as a transaction.
       def truncate
-        self.class.tables.each do |table_name, _|
+        self.class.tables.each_key do |table_name|
           @db_connection.transaction do
             prefixed_name = table_name_prefixed(table_name)
             @db_connection[prefixed_name].truncate

data/lib/event_sourcery/postgres/tracker.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module EventSourcery
   module Postgres
     # This will set up a persisted event id tracker for processors.
     class Tracker
-
       def initialize(db_connection = EventSourcery::Postgres.config.projections_database,
                      table_name: EventSourcery::Postgres.config.tracker_table_name,
                      obtain_processor_lock: true)
@@ -19,16 +20,14 @@ module EventSourcery
       def setup(processor_name = nil)
         create_table_if_not_exists if EventSourcery::Postgres.config.auto_create_projector_tracker
 
-        unless tracker_table_exists?
-          raise UnableToLockProcessorError, 'Projector tracker table does not exist'
-        end
+        raise UnableToLockProcessorError, 'Projector tracker table does not exist' unless tracker_table_exists?
 
-        if processor_name
-          create_track_entry_if_not_exists(processor_name)
-          if @obtain_processor_lock
-            obtain_global_lock_on_processor(processor_name)
-          end
-        end
+        return unless processor_name
+
+        create_track_entry_if_not_exists(processor_name)
+        return unless @obtain_processor_lock
+
+        obtain_global_lock_on_processor(processor_name)
       end
 
       # This will updated the tracker table to the given event id value
@@ -37,9 +36,9 @@ module EventSourcery
       # @param processor_name the name of the processor to update
       # @param event_id the event id number to update to
       def processed_event(processor_name, event_id)
-        table.
-          where(name: processor_name.to_s).
-          update(last_processed_event_id: event_id)
+        table
+          .where(name: processor_name.to_s)
+          .update(last_processed_event_id: event_id)
         true
       end
 
@@ -82,17 +81,18 @@ module EventSourcery
       private
 
       def obtain_global_lock_on_processor(processor_name)
-        lock_obtained = @db_connection.fetch("select pg_try_advisory_lock(#{@track_entry_id})").to_a.first[:pg_try_advisory_lock]
-        if lock_obtained == false
-          raise UnableToLockProcessorError, "Unable to get a lock on #{processor_name} #{@track_entry_id}"
-        end
+        lock_obtained = @db_connection.fetch("select pg_try_advisory_lock(#{@track_entry_id})")
+                                      .to_a.first[:pg_try_advisory_lock]
+        return unless lock_obtained == false
+
+        raise UnableToLockProcessorError, "Unable to get a lock on #{processor_name} #{@track_entry_id}"
       end
 
       def create_table_if_not_exists
-        unless tracker_table_exists?
-          EventSourcery.logger.info { "Projector tracker missing - attempting to create 'projector_tracker' table" }
-          EventSourcery::Postgres::Schema.create_projector_tracker(db: @db_connection, table_name: @table_name)
-        end
+        return if tracker_table_exists?
+
+        EventSourcery.logger.info { "Projector tracker missing - attempting to create 'projector_tracker' table" }
+        EventSourcery::Postgres::Schema.create_projector_tracker(db: @db_connection, table_name: @table_name)
       end
 
       def create_track_entry_if_not_exists(processor_name)

data/lib/event_sourcery/postgres/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module EventSourcery
   module Postgres
-    VERSION = '0.9.1'.freeze
+    VERSION = '1.0.1'
   end
 end

data/lib/event_sourcery/postgres.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sequel'
 
 Sequel.default_timezone = :utc
@@ -15,6 +17,7 @@ require 'event_sourcery/postgres/reactor'
 require 'event_sourcery/postgres/tracker'
 
 module EventSourcery
+  # PostgreSQL adapter for EventSourcery providing event store and projection capabilities.
   module Postgres
     def self.configure
       yield config

metadata

@@ -1,29 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: event_sourcery-postgres
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Envato
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sequel
+  name: event_sourcery
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.38'
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.38'
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +38,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: event_sourcery
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '4.38'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '4.38'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,62 +80,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description:
+        version: '1'
 email:
 - rubygems@envato.com
 executables: []
@@ -146,12 +158,14 @@ files:
 - lib/event_sourcery/postgres/tracker.rb
 - lib/event_sourcery/postgres/version.rb
 homepage: https://github.com/envato/event_sourcery-postgres
-licenses: []
+licenses:
+- MIT
 metadata:
+  allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/envato/event_sourcery-postgres/issues
   changelog_uri: https://github.com/envato/event_sourcery-postgres/blob/HEAD/CHANGELOG.md
-  source_code_uri: https://github.com/envato/event_sourcery-postgres
-post_install_message:
+  documentation_uri: https://www.rubydoc.info/gems/event_sourcery-postgres/1.0.1
+  source_code_uri: https://github.com/envato/event_sourcery-postgres/tree/v1.0.1
 rdoc_options: []
 require_paths:
 - lib
@@ -159,15 +173,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Postgres event store for use with EventSourcery
 test_files: []