event_sourcery-postgres 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05b4e104f8ead624e85b64116db8a9347ff6fd4b6b0af4abc8b4c60c0d49d926
-  data.tar.gz: c019944e4b6d194088945d8e7c9fe9cfd7a494fc6d8cba8f90df56cc839bfc24
+  metadata.gz: d0257d9a0f70fe078196251fc6de2944278cb2ddf7dda70e2125ce1217d62af6
+  data.tar.gz: 4ff91be144b82ec02988d7993a7094618e002ffce96ec7dfde1cde054fb15668
 SHA512:
-  metadata.gz: 76861f96df82c5ebe3de33f29de17ab6a86e9c5fd45fb72bb092469567eb8961d32e3fcf848e646023f5b12a5a1e9d5d2e6c8b292d15181ed2ea4d05e1b2b645
-  data.tar.gz: c59050c981cc4dac1ec32d5695a872351ed8bdc45ba5cb8a7d903c15fb06ea83ca13ce924db2095b62d6dda9d335302811522eed84ec8b568e116fac6a802706
+  metadata.gz: 5cd37ea3284ab95e970e704bbabdb14c2160dd3a7612a48927fc99e15a72b074d8c704c0239a75256a158bf468df93c110dcaa0d0ce46da4f871ceb1fd0390c9
+  data.tar.gz: d9e5f9281bcc91bb364e1dd607065199b97f144118841183807ce78a3a7a0ab4997fc6e12a625d0f15aaf3b15076d769a03b56362e47201906539ed29d8fefb4

data/CHANGELOG.md

@@ -7,7 +7,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/envato/event_sourcery-postgres/compare/v1.0.0...HEAD
+[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
 

data/README.md

@@ -4,9 +4,7 @@
 
 ## 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

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
     '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/event_sourcery-postgres/#{spec.version}",
+    'documentation_uri' => "https://www.rubydoc.info/gems/#{spec.name}/#{spec.version}",
     'source_code_uri' => "#{spec.homepage}/tree/v#{spec.version}"
   }
 

data/lib/event_sourcery/postgres/config.rb

@@ -2,6 +2,7 @@
 
 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

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module Postgres
+    # PostgreSQL implementation of an event store for persisting and retrieving domain events.
     class EventStore
       include EventSourcery::EventStore::EachByRange
 

data/lib/event_sourcery/postgres/optimised_event_poll_waiter.rb

@@ -54,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

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module Postgres
+    # Mixin providing projection capabilities for processing events into read models.
     module Projector
       def self.included(base)
         base.include(EventProcessing::EventStreamProcessor)
@@ -17,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

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module Postgres
+    # Queue that invokes a callback at regular intervals when no items are available.
     class QueueWithIntervalCallback < ::Queue
       attr_accessor :callback
 
@@ -16,7 +17,7 @@ module EventSourcery
         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

data/lib/event_sourcery/postgres/reactor.rb

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module Postgres
+    # Mixin providing reactor capabilities for processing events and emitting new events in response.
     module Reactor
       UndeclaredEventEmissionError = Class.new(StandardError)
 
@@ -12,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.
         #
@@ -22,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.
@@ -41,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,
@@ -75,7 +78,7 @@ module EventSourcery
       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

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module Postgres
+    # Schema management for creating event store and projector tables in PostgreSQL.
     module Schema
       module_function
 

data/lib/event_sourcery/postgres/table_owner.rb

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module Postgres
+    # Mixin providing table management capabilities for projectors and reactors.
     module TableOwner
       DefaultTableError = Class.new(StandardError)
       NoSuchTableError = Class.new(StandardError)
@@ -10,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.
         #
@@ -38,7 +40,7 @@ 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)
           @db_connection.drop_table(prefixed_name, cascade: true) if @db_connection.table_exists?(prefixed_name)
         end
@@ -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/version.rb

@@ -2,6 +2,6 @@
 
 module EventSourcery
   module Postgres
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/lib/event_sourcery/postgres.rb

@@ -17,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_sourcery-postgres
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Envato
@@ -164,8 +164,8 @@ 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
-  documentation_uri: https://www.rubydoc.info/gems/event_sourcery-postgres/1.0.0
-  source_code_uri: https://github.com/envato/event_sourcery-postgres/tree/v1.0.0
+  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
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Postgres event store for use with EventSourcery
 test_files: []