event_sourcery-postgres 0.4.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e45ae5ad105bd165a2fb4b59be6032488ec925df
-  data.tar.gz: c36491b6e980803520d2b3a900207500f694b500
+SHA256:
+  metadata.gz: e0846cda7986faeccb438d159a1fe87e0388855b2a898a5703dbc95d8bbce425
+  data.tar.gz: c29112988c1049f8978e95c276f1bb96bfc1f5bdf36b491f68dad0dd9ac2b9ce
 SHA512:
-  metadata.gz: a86c88d7db9e0368d3ddbea1b6b7ce869d8f3465dd1bce3990f0038edffcb5712da10d4182fd0ce46427b2e3aa08b67b7da6712d7aec0abd16f766741a492556
-  data.tar.gz: 3f286cd47b3eb36e3b3e65929d6df0d51a1bc8762f1256d1b21c6f8041861fc8087bde5978989c7abb58d6f274add9dca368ca992105a12e5e7af6069e390dc7
+  metadata.gz: 38a3097e2582d651b4af1d421a4f431f888f09b8cc369f44c059276449f17e9dbac29a2f08bfc1eea7dbf9eae39eebcb3788d5f1d9d72f8702e309a7b3cfba14
+  data.tar.gz: c384b9737f5888df616f1dc776db9411616434f0025d5ef888d6ad273d9757ebecfec56ff5ee4dc9eca1e05553f5c3cc6dc375aecbb8a979c62e1199b7dbacfb

data/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
@@ -6,7 +7,53 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
-## [0.4.0] - 2017-6-21
+## [0.8.1] - 2020-10-02
+### Added
+- Add Ruby 2.6 and 2.7 to the CI test matrix.
+
+### Removed
+- Remove Ruby 2.2 from the CI test matrix.
+- Support for Boxen.
+
+### Fixed
+- Upgrade development dependency Rake to version 13. This resolves
+  [CVE-2020-8130](https://github.com/advisories/GHSA-jppv-gw3r-w3q8).
+
+- Resolve warnings raised when running on Ruby 2.7.
+
+## [0.8.0] - 2018-08-06
+### Added
+- Add a `on_events_recorded` config option, that defaults to a no-op proc, \
+  to handle any app specific logic after the events are recoded on `EventStore#sink`
+
+## [0.7.0] - 2018-05-23
+### Added
+- Add a `projector_transaction_size` config option to control how many events
+  are processed before the transaction is commited. The default value is 1 to
+  match the existing behavour.
+
+  We suggest setting this to match the number of events returned from the event
+  store subscription. This is [now configurable](https://github.com/envato/event_sourcery/pull/197)
+  in event_sourcery by configuring `subscription_batch_size`.
+
+### Removed
+- Remove upper bound version restriction on `sequel` gem. Now accepts versions
+  5 and higher.
+
+## [0.6.0] - 2018-01-02
+### Changed
+
+- Only send info log after processing a group of events
+
+### Removed
+  - Remove `processes_events` and `projects_events` as these have been [removed
+  in event_sourcery](https://github.com/envato/event_sourcery/pull/161).
+
+## [0.5.0] - 2017-07-27
+- First Version of YARD documentation.
+- Fix Sequel deprecation by globally loading pg extensions
+
+## [0.4.0] - 2017-06-21
 ### Changed
 - Reactors store the UUID of the event being processed in the `causation_id`
   of any emitted events. This replaces the old behaviour of storing id of the
@@ -19,27 +66,37 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Added index on the `events` table for `correlation_id` and `causation_id`
   columns.
 
-## [0.3.0] - 2017-6-16
+## [0.3.0] - 2017-06-16
 ### Changed
 - The event store persists the event `correlation_id` and `causation_id`.
   To facilitate this `correlation_id` and `causation_id` columns have been
   added to the `events` table and the `write_events` function has been
   altered. Event Sourcery apps will need to ensure these DB changes have
   been applied to use this version of Event Sourcery.
+- The emit_events method now accepts typed events instead of symbols
+- Remove dynamic emit events methods from reactors (e.g. emit_item_added)
 
-## [0.2.0] - 2017-6-1
+## [0.2.0] - 2017-06-01
 ### Changed
 - Make `EventSourcery::Postgres::OptimisedEventPollWaiter#shutdown` private
 - Updated `EventSourcery::Postgres::OptimisedEventPollWaiter#poll` to ensure that `#shutdown!` is run when an error is raised
 or when the loop stops
-- Remove dynamic emit events methods from reactors (e.g. emit_item_added)
-- The emit_events method now accepts typed events instead of symbols
 
 ### Added
 - Configure projector tracker table name via `EventSourcery::Postgres.configure`
 
-## [0.1.0] - 2017-5-26
+## 0.1.0 - 2017-05-26
 ### Changed
 - Imported code from the [event_sourcery](https://github.com/envato/event_sourcery).
 - Postgres related configuration is through `EventSourcery::Postgres.configure`
   instead of `EventSourcery.configure`.
+
+[Unreleased]: https://github.com/envato/event_sourcery-postgres/compare/v0.8.1...HEAD
+[0.8.1]: https://github.com/envato/event_sourcery-postgres/compare/v0.8.0...v0.8.1
+[0.8.0]: https://github.com/envato/event_sourcery-postgres/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/envato/event_sourcery-postgres/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/envato/event_sourcery-postgres/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/envato/event_sourcery-postgres/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/envato/event_sourcery-postgres/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/envato/event_sourcery-postgres/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/envato/event_sourcery-postgres/compare/v0.1.0...v0.2.0

data/README.md

@@ -22,7 +22,6 @@ gem 'event_sourcery-postgres'
 EventSourcery::Postgres.configure do |config|
   config.event_store_database = Sequel.connect(...)
   config.projections_database = Sequel.connect(...)
-  config.use_optimistic_concurrency = true
   config.write_events_function_name = 'writeEvents'
   config.events_table_name = :events
   config.aggregates_table_name = :aggregates
@@ -91,11 +90,8 @@ To release a new version:
 
 1. Update the version number in `lib/event_sourcery/postgres/version.rb`
 2. Get this change onto master via the normal PR process
-3. Run `gem_push=false be rake release`,
-   this will create a git tag for the version,
-   push tags up to GitHub, and package the code in a `.gem` file.
-4. Manually upload the generated gem file (`pkg/event_sourcery-postgres-#{version}.gem`) to
-   [rubygems.envato.com](https://rubygems.envato.com).
+3. Run `bundle exec rake release`, this will create a git tag for the
+   version, push tags up to GitHub, and upload the gem to rubygems.org.
 
 ## Contributing
 

data/event_sourcery-postgres.gemspec

@@ -12,6 +12,11 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Postgres event store for use with EventSourcery'
   spec.homepage      = 'https://github.com/envato/event_sourcery-postgres'
+  spec.metadata      = {
+                         'bug_tracker_uri' => 'https://github.com/envato/event_sourcery-postgres/issues',
+                         'changelog_uri'   => 'https://github.com/envato/event_sourcery-postgres/blob/master/CHANGELOG.md',
+                         'source_code_uri' => 'https://github.com/envato/event_sourcery-postgres',
+                       }
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(\.|bin/|Gemfile|Rakefile|script/|spec/)})
@@ -22,11 +27,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_dependency 'sequel', '~> 4.38'
+  spec.add_dependency 'sequel', '>= 4.38'
   spec.add_dependency 'pg'
   spec.add_dependency 'event_sourcery', '>= 0.14.0'
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'benchmark-ips'

data/lib/event_sourcery/postgres.rb

@@ -1,6 +1,5 @@
 require 'sequel'
 
-Sequel.extension :pg_json
 Sequel.default_timezone = :utc
 
 require 'event_sourcery'

data/lib/event_sourcery/postgres/config.rb

@@ -1,8 +1,7 @@
 module EventSourcery
   module Postgres
     class Config
-      attr_accessor :event_store_database,
-                    :lock_table_to_guarantee_linear_sequence_id_growth,
+      attr_accessor :lock_table_to_guarantee_linear_sequence_id_growth,
                     :write_events_function_name,
                     :events_table_name,
                     :aggregates_table_name,
@@ -10,10 +9,15 @@ module EventSourcery
                     :callback_interval_if_no_new_events,
                     :auto_create_projector_tracker,
                     :event_tracker,
-                    :projections_database,
-                    :event_store,
-                    :event_source,
-                    :event_sink
+                    :projector_transaction_size,
+                    :on_events_recorded
+
+      attr_writer :event_store,
+                  :event_source,
+                  :event_sink
+
+      attr_reader :event_store_database,
+                  :projections_database
 
       def initialize
         @lock_table_to_guarantee_linear_sequence_id_growth = true
@@ -24,6 +28,8 @@ module EventSourcery
         @callback_interval_if_no_new_events = 10
         @event_store_database = nil
         @auto_create_projector_tracker = true
+        @projector_transaction_size = 1
+        @on_events_recorded = ->(events) {}
       end
 
       def event_store
@@ -38,9 +44,25 @@ module EventSourcery
         @event_sink ||= ::EventSourcery::EventStore::EventSink.new(event_store)
       end
 
-      def projections_database=(sequel_connection)
-        @projections_database = sequel_connection
-        @event_tracker = Postgres::Tracker.new(sequel_connection)
+      def event_store_database=(db_connection)
+        setup_connection(db_connection)
+
+        @event_store_database = db_connection
+      end
+
+      def projections_database=(db_connection)
+        setup_connection(db_connection)
+
+        @projections_database = db_connection
+        @event_tracker = Postgres::Tracker.new(db_connection)
+      end
+
+      private
+
+      def setup_connection(db_connection)
+        return unless db_connection
+
+        db_connection.extension :pg_json
       end
     end
   end

data/lib/event_sourcery/postgres/event_store.rb

@@ -3,25 +3,39 @@ module EventSourcery
     class EventStore
       include EventSourcery::EventStore::EachByRange
 
-      def initialize(pg_connection,
+      def initialize(db_connection,
                      events_table_name: EventSourcery::Postgres.config.events_table_name,
                      lock_table: EventSourcery::Postgres.config.lock_table_to_guarantee_linear_sequence_id_growth,
                      write_events_function_name: EventSourcery::Postgres.config.write_events_function_name,
-                     event_builder: EventSourcery.config.event_builder)
-        @pg_connection = pg_connection
+                     event_builder: EventSourcery.config.event_builder,
+                     on_events_recorded: EventSourcery::Postgres.config.on_events_recorded)
+        @db_connection = db_connection
         @events_table_name = events_table_name
         @write_events_function_name = write_events_function_name
         @lock_table = lock_table
         @event_builder = event_builder
+        @on_events_recorded = on_events_recorded
       end
 
+      # Like water flowing into a sink eventually it will go down the drain
+      # into the goodness of the plumbing system.
+      # So to will the given events you put in this 'sink'. Except the plumbing
+      # system is the data base events table.
+      # This can raise db connection errors.
+      #
+      # @param event_or_events the event or events to save
+      # @param expected_version the version to save with the event, default nil
+      #
+      # @raise [DatabaseError] if something goes wrong with the database
+      # @raise [ConcurrencyError] if there was a concurrency conflict
       def sink(event_or_events, expected_version: nil)
         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)
-        @pg_connection.run(sql)
+        @db_connection.run(sql)
         log_events_saved(events)
+        on_events_recorded.call(events)
         true
       rescue Sequel::DatabaseError => e
         if e.message =~ /Concurrency conflict/
@@ -31,15 +45,29 @@ module EventSourcery
         end
       end
 
+      # Get the next set of events from the given event id. You can
+      # specify event types and a limit.
+      # Default limit is 1000 and the default event types will be all.
+      #
+      # @param id the event id to get next events from
+      # @param event_types the event types to filter, default nil = all
+      # @param limit the limit to the results, default 1000
+      #
+      # @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 = query.where(type: event_types) if event_types
-        query.map { |event_row| build_event(event_row) }
+        query.map { |event_row| build_event(**event_row) }
       end
 
+      # Get last event id for a given event types.
+      #
+      # @param event_types the type of event(s) to filter
+      #
+      # @return the latest event id
       def latest_event_id(event_types: nil)
         latest_event = events_table
         latest_event = latest_event.where(type: event_types) if event_types
@@ -51,14 +79,25 @@ module EventSourcery
         end
       end
 
+      # Get the events for a given aggregate id.
+      #
+      # @param aggregate_id the aggregate id to filter for
+      #
+      # @return [Array] of found events
       def get_events_for_aggregate_id(aggregate_id)
         events_table.where(aggregate_id: aggregate_id.to_str).order(:version).map do |event_hash|
-          build_event(event_hash)
+          build_event(**event_hash)
         end
       end
 
+      # Subscribe to events.
+      #
+      # @param from_id subscribe from a starting event id. default will be from the start.
+      # @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)
-        poll_waiter = OptimisedEventPollWaiter.new(pg_connection: @pg_connection, after_listen: after_listen)
+        poll_waiter = OptimisedEventPollWaiter.new(db_connection: @db_connection, after_listen: after_listen)
         args = {
           poll_waiter: poll_waiter,
           event_store: self,
@@ -68,17 +107,19 @@ module EventSourcery
           subscription_master: subscription_master,
           on_new_events: block
         }
-        EventSourcery::EventStore::Subscription.new(args).tap(&:start)
+        EventSourcery::EventStore::Subscription.new(**args).tap(&:start)
       end
 
       private
 
+      attr_reader :on_events_recorded
+
       def events_table
-        @pg_connection[@events_table_name]
+        @db_connection[@events_table_name]
       end
 
-      def build_event(data)
-        @event_builder.build(data)
+      def build_event(**data)
+        @event_builder.build(**data)
       end
 
       def write_events_sql(aggregate_id, events, expected_version)
@@ -123,7 +164,7 @@ module EventSourcery
                         else
                           value
                         end
-        @pg_connection.literal(wrapped_value)
+        @db_connection.literal(wrapped_value)
       end
 
       def log_events_saved(events)

data/lib/event_sourcery/postgres/optimised_event_poll_waiter.rb

@@ -4,8 +4,8 @@ module EventSourcery
     class OptimisedEventPollWaiter
       ListenThreadDied = Class.new(StandardError)
 
-      def initialize(pg_connection:, timeout: 30, after_listen: proc {})
-        @pg_connection = pg_connection
+      def initialize(db_connection:, timeout: 30, after_listen: proc {})
+        @db_connection = db_connection
         @timeout = timeout
         @events_queue = QueueWithIntervalCallback.new
         @after_listen = after_listen
@@ -65,7 +65,7 @@ module EventSourcery
       end
 
       def listen_for_new_events(loop: true, after_listen: nil, timeout: 30)
-        @pg_connection.listen('new_event',
+        @db_connection.listen('new_event',
                               loop: loop,
                               after_listen: after_listen,
                               timeout: timeout) do |_channel, _pid, _payload|

data/lib/event_sourcery/postgres/projector.rb

@@ -10,7 +10,6 @@ module EventSourcery
 
           class << self
             alias_method :project, :process
-            alias_method :projects_events, :processes_events
             alias_method :projector_name, :processor_name
           end
         end
@@ -18,23 +17,31 @@ module EventSourcery
 
       module InstanceMethods
         def initialize(tracker: EventSourcery::Postgres.config.event_tracker,
-                       db_connection: EventSourcery::Postgres.config.projections_database)
+                       db_connection: EventSourcery::Postgres.config.projections_database,
+                       transaction_size: EventSourcery::Postgres.config.projector_transaction_size)
           @tracker = tracker
           @db_connection = db_connection
+          @transaction_size = transaction_size
         end
 
         private
 
+        attr_reader :transaction_size
+
         def process_events(events, subscription_master)
-          events.each do |event|
+          events.each_slice(transaction_size) do |slice_of_events|
             subscription_master.shutdown_if_requested
+
             db_connection.transaction do
-              process(event)
-              tracker.processed_event(processor_name, event.id)
+              slice_of_events.each do |event|
+                process(event)
+                EventSourcery.logger.debug { "[#{processor_name}] Processed event: #{event.inspect}" }
+              end
+              tracker.processed_event(processor_name, slice_of_events.last.id)
             end
-            EventSourcery.logger.debug { "[#{processor_name}] Processed event: #{event.inspect}" }
-            EventSourcery.logger.info { "[#{processor_name}] Processed up to event id: #{events.last.id}" }
           end
+
+          EventSourcery.logger.info { "[#{processor_name}] Processed up to event id: #{events.last.id}" }
         end
       end
     end

data/lib/event_sourcery/postgres/reactor.rb

@@ -11,18 +11,29 @@ module EventSourcery
       end
 
       module ClassMethods
+        # Assign the types of events this reactor can emit.
+        #
+        # @param event_types the types of events this reactor can emit
         def emits_events(*event_types)
           @emits_event_types = event_types
         end
 
+        # @return [Array] an array of the types of events this reactor can emit
         def emit_events
           @emits_event_types ||= []
         end
 
+        # This will tell you if this reactor emits any type of event.
+        #
+        # @return [true, false] true if this emits events, false if not
         def emits_events?
           !emit_events.empty?
         end
 
+        # Will check if this reactor emits the given type of event.
+        #
+        # @param event_type the event type to check
+        # @return [true, false] true if it does emit the given event false if not
         def emits_event?(event_type)
           emit_events.include?(event_type)
         end

data/lib/event_sourcery/postgres/schema.rb

@@ -3,6 +3,12 @@ module EventSourcery
     module Schema
       module_function
 
+      # This will create the event store tables and functions
+      # (event, aggregates, tracker and create or update functions)
+      # for the given Postgres database.
+      # The default will be the one specified in the config.
+      #
+      # @param db the Postgres database to use
       def create_event_store(db: EventSourcery::Postgres.config.event_store_database,
                              events_table_name: EventSourcery::Postgres.config.events_table_name,
                              aggregates_table_name: EventSourcery::Postgres.config.aggregates_table_name,
@@ -12,6 +18,11 @@ module EventSourcery
         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.
+      # The defaults will be whats specified in config.
+      #
+      # @param db the Postgres database to use
+      # @param table_name the name of the events table
       def create_events(db: EventSourcery::Postgres.config.event_store_database,
                         table_name: EventSourcery::Postgres.config.events_table_name)
         db.run 'CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'
@@ -34,14 +45,27 @@ module EventSourcery
         end
       end
 
+      # Create the aggregates table. Needs the database and the table name.
+      # The defaults will be whats specified in config.
+      #
+      # @param db the Postgres database to use
+      # @param table_name the name of the aggregates table
       def create_aggregates(db: EventSourcery::Postgres.config.event_store_database,
                             table_name: EventSourcery::Postgres.config.aggregates_table_name)
         db.create_table(table_name) do
-          primary_key :aggregate_id, :uuid
+          uuid :aggregate_id, primary_key: true
           column :version, :bigint, default: 1
         end
       end
 
+      # Create the 'create or update' functions.
+      # Needs the database, table name, function name and aggregates table name.
+      # The defaults will be whats specified in config.
+      #
+      # @param db the Postgres database to use
+      # @param function_name the name of the write events function
+      # @param events_table_name the name of the events table
+      # @param aggregates_table_name the name of the aggregates table
       def create_or_update_functions(db: EventSourcery::Postgres.config.event_store_database,
                                      function_name: EventSourcery::Postgres.config.write_events_function_name,
                                      events_table_name: EventSourcery::Postgres.config.events_table_name,
@@ -138,6 +162,11 @@ $$ language plpgsql;
 SQL
       end
 
+      # Create the projector tracker table. Needs the database and the table name.
+      # The defaults will be whats specified in config.
+      #
+      # @param db the Postgres database to use
+      # @param table_name the name of the aggregates table
       def create_projector_tracker(db: EventSourcery::Postgres.config.projections_database,
                                    table_name: EventSourcery::Postgres.config.tracker_table_name)
         db.create_table(table_name) do

data/lib/event_sourcery/postgres/table_owner.rb

@@ -9,15 +9,23 @@ module EventSourcery
       end
 
       module ClassMethods
+        # Hash of the tables and their corresponding blocks.
+        #
+        # @return [Hash] hash keyed by table names and block values
         def tables
           @tables ||= {}
         end
 
+        # For the given table name assign to give block as the value.
+        #
+        # @param name the name of the table
+        # @param block the block of code to assign for the table
         def table(name, &block)
           tables[name] = block
         end
       end
 
+      # Create each table.
       def setup
         self.class.tables.each do |table_name, schema_block|
           prefixed_name = table_name_prefixed(table_name)
@@ -26,6 +34,7 @@ module EventSourcery
         super if defined?(super)
       end
 
+      # Reset by dropping each table.
       def reset
         self.class.tables.keys.each do |table_name|
           prefixed_name = table_name_prefixed(table_name)
@@ -37,6 +46,8 @@ module EventSourcery
         setup
       end
 
+      # 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, _|
           @db_connection.transaction do

data/lib/event_sourcery/postgres/tracker.rb

@@ -1,14 +1,21 @@
 module EventSourcery
   module Postgres
+    # This will set up a persisted event id tracker for processors.
     class Tracker
-      def initialize(connection = EventSourcery::Postgres.config.projections_database,
+
+      def initialize(db_connection = EventSourcery::Postgres.config.projections_database,
                      table_name: EventSourcery::Postgres.config.tracker_table_name,
                      obtain_processor_lock: true)
-        @connection = connection
+        @db_connection = db_connection
         @table_name = table_name.to_sym
         @obtain_processor_lock = obtain_processor_lock
       end
 
+      # Set up the given processor.
+      # This will create the projector tracker table if it does not exist.
+      # If given a processor_name it will then attempt to get a lock on the db.
+      #
+      # @param processor_name the name of the processor
       def setup(processor_name = nil)
         create_table_if_not_exists if EventSourcery::Postgres.config.auto_create_projector_tracker
 
@@ -24,6 +31,11 @@ module EventSourcery
         end
       end
 
+      # This will updated the tracker table to the given event id value
+      # for the given processor name.
+      #
+      # @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).
@@ -31,22 +43,38 @@ module EventSourcery
         true
       end
 
+      # This allows you to process an event and update the tracker table in
+      # a single transaction. Will yield the given block first then update the
+      # the tracker table to the give event id for the given processor name.
+      #
+      # @param processor_name the name of the processor to update
+      # @param event_id the event id number to update to
       def processing_event(processor_name, event_id)
-        @connection.transaction do
+        @db_connection.transaction do
           yield
           processed_event(processor_name, event_id)
         end
       end
 
+      # This will reset the tracker to the start (0) for the given processor name.
+      #
+      # @param processor_name the name of the processor to reset to 0
       def reset_last_processed_event_id(processor_name)
         table.where(name: processor_name.to_s).update(last_processed_event_id: 0)
       end
 
+      # This will return the last processed event id for the given processor name.
+      #
+      # @param processor_name the name of the processor you want to look up
+      # @return [Int, nil] the value of the last event_id processed
       def last_processed_event_id(processor_name)
         track_entry = table.where(name: processor_name.to_s).first
         track_entry[:last_processed_event_id] if track_entry
       end
 
+      # Will return an array of all known tracked processors.
+      #
+      # @return [Array] array of all known tracked processors
       def tracked_processors
         table.select_map(:name)
       end
@@ -54,7 +82,7 @@ module EventSourcery
       private
 
       def obtain_global_lock_on_processor(processor_name)
-        lock_obtained = @connection.fetch("select pg_try_advisory_lock(#{@track_entry_id})").to_a.first[:pg_try_advisory_lock]
+        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
@@ -63,7 +91,7 @@ module EventSourcery
       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: @connection, table_name: @table_name)
+          EventSourcery::Postgres::Schema.create_projector_tracker(db: @db_connection, table_name: @table_name)
         end
       end
 
@@ -77,11 +105,11 @@ module EventSourcery
       end
 
       def table
-        @connection[@table_name]
+        @db_connection[@table_name]
       end
 
       def tracker_table_exists?
-        @connection.table_exists?(@table_name)
+        @db_connection.table_exists?(@table_name)
       end
     end
   end

data/lib/event_sourcery/postgres/version.rb

@@ -1,5 +1,5 @@
 module EventSourcery
   module Postgres
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.8.1'.freeze
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: event_sourcery-postgres
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Envato
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.38'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.38'
 - !ruby/object:Gem::Dependency
@@ -56,30 +56,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - rubygems@envato.com
 executables: []
@@ -147,8 +147,11 @@ files:
 - lib/event_sourcery/postgres/version.rb
 homepage: https://github.com/envato/event_sourcery-postgres
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/envato/event_sourcery-postgres/issues
+  changelog_uri: https://github.com/envato/event_sourcery-postgres/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/envato/event_sourcery-postgres
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,9 +166,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Postgres event store for use with EventSourcery
 test_files: []