ruby_event_store-rom 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3af23fb98d5ccf4b0730bfd4da1dfea36b511d5b7d00e82158daaa7ed3ba6979
-  data.tar.gz: 741f05db9dc98c607888e5a3a07a8289a3d02094e8deecfcf48da150d6388954
+  metadata.gz: fd644498c9073a4fedae61d6bbc305373ce49f3b5a5dc474798905b2928b5013
+  data.tar.gz: 41947bff3903557aa6d816a5807165613c513f99fa8d4b97e84005628c4f6b31
 SHA512:
-  metadata.gz: f6846ccb455e16a59fe7a3e655f912f77998af55527d7e0c49278f52454d3d283e9113b70d7fff4289268dc13018d3b0ab4e0dcb774767a313078c8081e7d7fa
-  data.tar.gz: b02ae36dbe6641fda9bb4005821f220954f1ff09672736f2f895963ba0fa366442b1aa21100fee0b20663d9b718d5f66f2a28461419caf1b45c6589cefd92bc3
+  metadata.gz: e572f34403a3924f2ed6343b2bdb690d31d7cdb8e85f7eff0c44caafb3ece603224e7ad6dae950b2396124f709694904d539d811cc58847b6fa2e9aa4f04e9dd
+  data.tar.gz: 75a35e00b8bb953bd81c4a9a4b95596db5c555b4d813e6717ff5767b6bced436f346f5d5d09debcf044f16c7e71a585da132ea5e8ac32f56a1a97b9204ed342b

data/README.md

@@ -7,3 +7,47 @@ A Ruby Object Model (ROM) implementation of events repository for [Ruby Event St
 This version of the ROM adapter supports [rom-sql](https://github.com/rom-rb/rom-sql) at this time. It is an alternative to the ActiveRecord `EventRepository` implementation used in `rails_event_store` gem.
 
 [Read the docs to get started.](http://railseventstore.org/docs/repository/)
+
+## Setup
+
+### Rake tasks
+
+Add to your `Rakefile`
+
+```ruby
+require "ruby_event_store/rom/rake_task"
+```
+
+### Database migration
+
+A migration template can be found in [db/migrate/20210806000000_create_ruby_event_store_tables.rb](db/migrate/20210806000000_create_ruby_event_store_tables.rb).
+
+You can choose the type of the `data` and `metadata` columns by using the `DATA_TYPE` environment variable:
+
+```shell
+rake db:migrate DATA_TYPE='text' # or
+rake db:migrate DATA_TYPE='json' # or
+rake db:migrate DATA_TYPE='jsonb'
+```
+
+### Application
+
+```ruby
+# config/initializers/ruby_event_store.rb
+
+config = ROM::Configuration.new(:sql, ENV.fetch("DATABASE_URL"))
+RES_ROM_CONTAINER = RubyEventStore::ROM.setup(config)
+
+repository = RubyEventStore::ROM::EventRepository.new(
+  rom: RES_ROM_CONTAINER,
+  serializer: JSON # this setting is optional. Recommended when `data` and `metadata` are json(b) columns. 
+)
+
+event_store = RubyEventStore::Client.new(repository: repository)
+
+event_store.subscribe_to_all_events(RubyEventStore::LinkByCausationId.new(event_store: event_store))
+event_store.subscribe_to_all_events(RubyEventStore::LinkByCorrelationId.new(event_store: event_store))
+event_store.subscribe_to_all_events(RubyEventStore::LinkByEventType.new(event_store: event_store))
+
+EVENT_STORE = event_store
+```

data/lib/ruby_event_store/rom/changesets/update_events.rb

@@ -35,7 +35,7 @@ module RubyEventStore
             .dataset
             .insert_conflict(
               target: :event_id,
-              update: UPSERT_COLUMNS.each_with_object({}) { |column, memo| memo[column] = Sequel[:excluded][column] }
+              update: UPSERT_COLUMNS.each_with_object({}) { |column, memo| memo[column] = Sequel[:excluded][column] },
             )
             .multi_insert(to_a)
         end

data/lib/ruby_event_store/rom/event_repository.rb

@@ -17,12 +17,11 @@ module RubyEventStore
         handle_unique_violation do
           @unit_of_work.call do |changesets|
             changesets << @events.create_changeset(serialized_records)
-            changesets <<
-              @stream_entries.create_changeset(
-                event_ids,
-                stream,
-                @stream_entries.resolve_version(stream, expected_version)
-              )
+            changesets << @stream_entries.create_changeset(
+              event_ids,
+              stream,
+              @stream_entries.resolve_version(stream, expected_version),
+            )
           end
         end
 
@@ -34,12 +33,11 @@ module RubyEventStore
 
         handle_unique_violation do
           @unit_of_work.call do |changesets|
-            changesets <<
-              @stream_entries.create_changeset(
-                event_ids,
-                stream,
-                @stream_entries.resolve_version(stream, expected_version)
-              )
+            changesets << @stream_entries.create_changeset(
+              event_ids,
+              stream,
+              @stream_entries.resolve_version(stream, expected_version),
+            )
           end
         end
 
@@ -65,7 +63,7 @@ module RubyEventStore
       def has_event?(event_id)
         @events.exist?(event_id)
       rescue Sequel::DatabaseError => doh
-        raise doh unless doh.message =~ /PG::InvalidTextRepresentation.*uuid/
+        raise doh unless /PG::InvalidTextRepresentation.*uuid/.match?(doh.message)
         false
       end
 

data/lib/ruby_event_store/rom/relations/events.rb

@@ -34,20 +34,36 @@ module RubyEventStore
           where(event_type: types)
         end
 
-        def newer_than(time)
-          where { |r| r.events[:created_at] > time.localtime }
+        def newer_than(time, time_sort_by)
+          if time_sort_by == :as_of
+            where { |r| string.coalesce(r.events[:valid_at], r.events[:created_at]) > time.localtime }
+          else
+            where { |r| r.events[:created_at] > time.localtime }
+          end
         end
 
-        def newer_than_or_equal(time)
-          where { |r| r.events[:created_at] >= time.localtime }
+        def newer_than_or_equal(time, time_sort_by)
+          if time_sort_by == :as_of
+            where { |r| string.coalesce(r.events[:valid_at], r.events[:created_at]) >= time.localtime }
+          else
+            where { |r| r.events[:created_at] >= time.localtime }
+          end
         end
 
-        def older_than(time)
-          where { |r| r.events[:created_at] < time.localtime }
+        def older_than(time, time_sort_by)
+          if time_sort_by == :as_of
+            where { |r| string.coalesce(r.events[:valid_at], r.events[:created_at]) < time.localtime }
+          else
+            where { |r| r.events[:created_at] < time.localtime }
+          end
         end
 
-        def older_than_or_equal(time)
-          where { |r| r.events[:created_at] <= time.localtime }
+        def older_than_or_equal(time, time_sort_by)
+          if time_sort_by == :as_of
+            where { |r| string.coalesce(r.events[:valid_at], r.events[:created_at]) <= time.localtime }
+          else
+            where { |r| r.events[:created_at] <= time.localtime }
+          end
         end
 
         DIRECTION_MAP = { forward: %i[asc > <], backward: %i[desc < >] }.freeze

data/lib/ruby_event_store/rom/relations/stream_entries.rb

@@ -23,7 +23,7 @@ module RubyEventStore
         end
 
         def by_event_type(types)
-          join(:events).where(event_type: types)
+          join_events.where(event_type: types)
         end
 
         def by_stream_and_event_id(stream, event_id)
@@ -34,20 +34,36 @@ module RubyEventStore
           by_stream(stream).select(:position).order(Sequel.desc(:position)).first
         end
 
-        def newer_than(time)
-          join(:events).where { |r| r.events[:created_at] > time.localtime }
+        def newer_than(time, time_sort_by)
+          if time_sort_by == :as_of
+            join_events.where { |r| string.coalesce(r.events[:valid_at], r.events[:created_at]) > time.localtime }
+          else
+            join_events.where { |r| r.events[:created_at] > time.localtime }
+          end
         end
 
-        def newer_than_or_equal(time)
-          join(:events).where { |r| r.events[:created_at] >= time.localtime }
+        def newer_than_or_equal(time, time_sort_by)
+          if time_sort_by == :as_of
+            join_events.where { |r| string.coalesce(r.events[:valid_at], r.events[:created_at]) >= time.localtime }
+          else
+            join_events.where { |r| r.events[:created_at] >= time.localtime }
+          end
         end
 
-        def older_than(time)
-          join(:events).where { |r| r.events[:created_at] < time.localtime }
+        def older_than(time, time_sort_by)
+          if time_sort_by == :as_of
+            join_events.where { |r| string.coalesce(r.events[:valid_at], r.events[:created_at]) < time.localtime }
+          else
+            join_events.where { |r| r.events[:created_at] < time.localtime }
+          end
         end
 
-        def older_than_or_equal(time)
-          join(:events).where { |r| r.events[:created_at] <= time.localtime }
+        def older_than_or_equal(time, time_sort_by)
+          if time_sort_by == :as_of
+            join_events.where { |r| string.coalesce(r.events[:valid_at], r.events[:created_at]) <= time.localtime }
+          else
+            join_events.where { |r| r.events[:created_at] <= time.localtime }
+          end
         end
 
         DIRECTION_MAP = { forward: %i[asc > <], backward: %i[desc < >] }.freeze
@@ -74,9 +90,13 @@ module RubyEventStore
           if event_order_columns.empty?
             query.order { |r| stream_order_columns.map { |c| r[:stream_entries][c].public_send(order) } }
           else
-            query.join(:events).order { |r| event_order_columns.map { |c| r.events[c].public_send(order) } }
+            query.join_events.order { |r| event_order_columns.map { |c| r.events[c].public_send(order) } }
           end
         end
+
+        def join_events
+          dataset.opts[:join]&.map(&:table)&.include?(events.dataset.first_source_table) ? self : join(:events)
+        end
       end
     end
   end

data/lib/ruby_event_store/rom/repositories/events.rb

@@ -37,7 +37,7 @@ module RubyEventStore
             BatchEnumerator.new(
               specification.batch_size,
               specification.limit,
-              ->(offset, limit) { query_builder(serializer, query, offset: offset, limit: limit).to_ary }
+              ->(offset, limit) { query_builder(serializer, query, offset: offset, limit: limit).to_ary },
             ).each
           else
             query = query_builder(serializer, query, limit: (specification.limit if specification.limit?))
@@ -65,6 +65,18 @@ module RubyEventStore
 
         protected
 
+        def find_event_id_in_stream(specification_event_id, specification_stream_name)
+          stream_entries.by_stream_and_event_id(specification_stream_name, specification_event_id).fetch(:id)
+        rescue ::ROM::TupleCountMismatchError
+          raise EventNotFound.new(specification_event_id)
+        end
+
+        def find_event_id_globally(specification_event_id)
+          events.by_event_id(specification_event_id).one!.fetch(:id)
+        rescue ::ROM::TupleCountMismatchError
+          raise EventNotFound.new(specification_event_id)
+        end
+
         def read_scope(specification)
           direction = specification.forward? ? :forward : :backward
 
@@ -73,20 +85,14 @@ module RubyEventStore
           end
 
           if specification.stream.global?
-            offset_entry_id = events.by_event_id(specification.start).one!.fetch(:id) if specification.start
-            stop_entry_id = events.by_event_id(specification.stop).one!.fetch(:id) if specification.stop
+            offset_entry_id = find_event_id_globally(specification.start) if specification.start
+            stop_entry_id = find_event_id_globally(specification.stop) if specification.stop
 
             query = events.ordered(direction, offset_entry_id, stop_entry_id, specification.time_sort_by)
             query = query.map_with(:event_to_serialized_record, auto_struct: false)
           else
-            offset_entry_id =
-              stream_entries
-                .by_stream_and_event_id(specification.stream, specification.start)
-                .fetch(:id) if specification.start
-            stop_entry_id =
-              stream_entries
-                .by_stream_and_event_id(specification.stream, specification.stop)
-                .fetch(:id) if specification.stop
+            offset_entry_id = find_event_id_in_stream(specification.start, specification.stream) if specification.start
+            stop_entry_id = find_event_id_in_stream(specification.stop, specification.stream) if specification.stop
 
             query =
               stream_entries.ordered(
@@ -94,7 +100,7 @@ module RubyEventStore
                 specification.stream,
                 offset_entry_id,
                 stop_entry_id,
-                specification.time_sort_by
+                specification.time_sort_by,
               )
             query = query.combine(:event)
             query = query.map_with(:stream_entry_to_serialized_record, auto_struct: false)
@@ -102,10 +108,18 @@ module RubyEventStore
 
           query = query.by_event_id(specification.with_ids) if specification.with_ids
           query = query.by_event_type(specification.with_types) if specification.with_types?
-          query = query.older_than(specification.older_than) if specification.older_than
-          query = query.older_than_or_equal(specification.older_than_or_equal) if specification.older_than_or_equal
-          query = query.newer_than(specification.newer_than) if specification.newer_than
-          query = query.newer_than_or_equal(specification.newer_than_or_equal) if specification.newer_than_or_equal
+          query = query.older_than(specification.older_than, specification.time_sort_by) if specification.older_than
+          query =
+            query.older_than_or_equal(
+              specification.older_than_or_equal,
+              specification.time_sort_by,
+            ) if specification.older_than_or_equal
+          query = query.newer_than(specification.newer_than, specification.time_sort_by) if specification.newer_than
+          query =
+            query.newer_than_or_equal(
+              specification.newer_than_or_equal,
+              specification.time_sort_by,
+            ) if specification.newer_than_or_equal
           query
         end
 

data/lib/ruby_event_store/rom/repositories/stream_entries.rb

@@ -14,7 +14,7 @@ module RubyEventStore
               tuples << {
                 stream: stream.name,
                 position: resolved_version && resolved_version + index + POSITION_SHIFT,
-                event_id: event_id
+                event_id: event_id,
               }
             end
           end
@@ -29,7 +29,7 @@ module RubyEventStore
         def resolve_version(stream, expected_version)
           expected_version.resolve_for(
             stream,
-            lambda { |_stream| (stream_entries.max_position(stream) || {})[:position] }
+            lambda { |_stream| (stream_entries.max_position(stream) || {})[:position] },
           )
         end
 

data/lib/ruby_event_store/rom/unit_of_work.rb

@@ -32,7 +32,7 @@ module RubyEventStore
           before_retry:
             lambda do |_num, ex|
               env.logger.warn("RETRY TRANSACTION [#{self.class.name} => #{ex.class.name}] #{ex.message}")
-            end
+            end,
         ) { changesets.each(&:commit) }
       end
     end

data/lib/ruby_event_store/rom/version.rb

@@ -2,6 +2,6 @@
 
 module RubyEventStore
   module ROM
-    VERSION = "2.1.0"
+    VERSION = "2.3.0"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby_event_store-rom
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Joel Van Horn
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container
@@ -117,7 +116,7 @@ dependencies:
         version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -127,7 +126,7 @@ dependencies:
         version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 description: Implementation of events repository based on ROM for Ruby Event Store
 email: joel@joelvanhorn.com
 executables: []
@@ -163,7 +162,6 @@ metadata:
   source_code_uri: https://github.com/RailsEventStore/rails_event_store
   bug_tracker_uri: https://github.com/RailsEventStore/rails_event_store/issues
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,15 +169,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: ROM events repository for Ruby Event Store
 test_files: []