ruby_event_store-active_record 2.17.1 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b87772800a0cfa9041b04341fd4b652cb19ed7c651739986f80a7bf0bb17c873
-  data.tar.gz: 351574e60ba2f36792f689a45fd0bac8503a69bb4622173742147034c58e5d3d
+  metadata.gz: 4e59b38492f8cd12d3131547e67dacc272ef2dd0e6df85934fabdf115ea9489f
+  data.tar.gz: 63e1cefc86fb9e06396ea293edc9e52e1b3ef6cc161a25cf90f3a5fd6c07f3af
 SHA512:
-  metadata.gz: db286b07eac4402fd8a83a143d9501246b6cef625ee2bac0db42dc1a3dc979d48b3526e89ae990cda4202b2ac5187942e2356320fefaf915fec8a0f7c24530f8
-  data.tar.gz: 3dc022ad1801d62547c91e7b0f7967bbc0a564a147b00d2a67c024bd8859fb00e8c7b3647423db6c5bcc447e2b644727b879f01accc67826e0989f2f0cc84439
+  metadata.gz: ca70c4f361e079a0ce1734a5acc246524a2b619f910a3fcacabe3beeb1bbc44b8bdf49c87b3c70ae68818e3eb569687180f24b6f7b6d8938de8843372a981473
+  data.tar.gz: 7691d7f87960edf26d4c5ef89087ae6faef317cd0f12455fd9fbd6cbdd3ab4fb6c1126cedd981846d33aa3c88a9ff432e6da13b19a46de7ee4846f49487aa631

data/lib/rails_event_store_active_record.rb

@@ -2,4 +2,9 @@
 
 require "ruby_event_store/active_record"
 
+warn <<~EOW
+  The 'rails_event_store_active_record' gem has been renamed and is deprecated.
+  Please change your Gemfile or gemspec to use 'ruby_event_store-active_record' instead.
+EOW
+
 RailsEventStoreActiveRecord = RubyEventStore::ActiveRecord

data/lib/ruby_event_store/active_record/event_repository.rb

@@ -7,48 +7,23 @@ module RubyEventStore
 
       def initialize(model_factory: WithDefaultModels.new, serializer:)
         @serializer = serializer
-        @event_klass, @stream_klass = model_factory.call
-        if serializer == NULL && json_data_type?
-          warn <<~MSG
-            The data or metadata column is of a JSON/B type and expects a JSON string. 
-
-            Yet the repository serializer is configured as #{serializer} and it would not 
-            produce the expected JSON string. 
-
-            In ActiveRecord there's an implicit serialization to JSON for JSON/B column types 
-            that made it work so far. This behaviour is unfortunately also a source of undesired 
-            double serialization — first in the EventRepository, second in the ActiveRecord.
-            
-            In the past we've advised workarounds that introduced configuration incosistency 
-            with other data types and serialization formats, i.e. explicitly passing NULL serializer 
-            just for the JSON/B data types.
-
-            As of now this special ActiveRecord behaviour is disabled. You should be using JSON 
-            serializer back again:
-
-            RubyEventStore::ActiveRecord::EventRepository.new(serializer: JSON)
-          MSG
-        else
-          @event_klass.include(SkipJsonSerialization)
-        end
-        @repo_reader = EventRepositoryReader.new(@event_klass, @stream_klass, serializer)
-        @index_violation_detector = IndexViolationDetector.new(@event_klass.table_name, @stream_klass.table_name)
+        @model_factory = model_factory
       end
 
       def rescue_from_double_json_serialization!
-        if serializer == JSON && json_data_type?
-          @repo_reader.instance_eval { alias __record__ record }
+        if @serializer == JSON && json_data_type?(event_klass)
+          repo_reader.instance_eval { alias __record__ record }
 
-          @repo_reader.define_singleton_method :unwrap do |column_name, payload|
+          repo_reader.define_singleton_method :unwrap do |column_name, payload|
             if String === payload && payload.start_with?("\{")
               warn "Double serialization of #{column_name} column detected"
-              serializer.load(payload)
+              @serializer.load(payload)
             else
               payload
             end
           end
 
-          @repo_reader.define_singleton_method :record do |record|
+          repo_reader.define_singleton_method :record do |record|
             r = __record__(record)
 
             Record.new(
@@ -76,31 +51,31 @@ module RubyEventStore
       end
 
       def delete_stream(stream)
-        @stream_klass.where(stream: stream.name).delete_all
+        stream_klass.where(stream: stream.name).delete_all
       end
 
       def has_event?(event_id)
-        @repo_reader.has_event?(event_id)
+        repo_reader.has_event?(event_id)
       end
 
       def last_stream_event(stream)
-        @repo_reader.last_stream_event(stream)
+        repo_reader.last_stream_event(stream)
       end
 
       def read(specification)
-        @repo_reader.read(specification)
+        repo_reader.read(specification)
       end
 
       def count(specification)
-        @repo_reader.count(specification)
+        repo_reader.count(specification)
       end
 
       def update_messages(records)
-        hashes = records.map { |record| upsert_hash(record, record.serialize(serializer)) }
+        hashes = records.map { |record| upsert_hash(record, record.serialize(@serializer)) }
         for_update = records.map(&:event_id)
         start_transaction do
           existing =
-            @event_klass
+            event_klass
               .where(event_id: for_update)
               .pluck(:event_id, :id, :created_at)
               .reduce({}) { |acc, (event_id, id, created_at)| acc.merge(event_id => [id, created_at]) }
@@ -109,33 +84,31 @@ module RubyEventStore
             h[:id] = existing.fetch(h.fetch(:event_id)).at(0)
             h[:created_at] = existing.fetch(h.fetch(:event_id)).at(1)
           end
-          @event_klass.upsert_all(hashes)
+          event_klass.upsert_all(hashes)
         end
       end
 
       def streams_of(event_id)
-        @repo_reader.streams_of(event_id)
+        repo_reader.streams_of(event_id)
       end
 
       def position_in_stream(event_id, stream)
-        @repo_reader.position_in_stream(event_id, stream)
+        repo_reader.position_in_stream(event_id, stream)
       end
 
       def global_position(event_id)
-        @repo_reader.global_position(event_id)
+        repo_reader.global_position(event_id)
       end
 
       def event_in_stream?(event_id, stream)
-        @repo_reader.event_in_stream?(event_id, stream)
+        repo_reader.event_in_stream?(event_id, stream)
       end
 
       private
 
-      attr_reader :serializer
-
       def add_to_stream(event_ids, stream, expected_version)
         last_stream_version = ->(stream_) do
-          @stream_klass.where(stream: stream_.name).order("position DESC").first.try(:position)
+          stream_klass.where(stream: stream_.name).order("position DESC").first.try(:position)
         end
         resolved_version = expected_version.resolve_for(stream, last_stream_version)
 
@@ -150,7 +123,7 @@ module RubyEventStore
                 created_at: Time.now.utc,
               }
             end
-          @stream_klass.insert_all!(in_stream) unless stream.global?
+          stream_klass.insert_all!(in_stream) unless stream.global?
         end
         self
       rescue ::ActiveRecord::RecordNotUnique => e
@@ -167,7 +140,7 @@ module RubyEventStore
       end
 
       def detect_index_violated(message)
-        @index_violation_detector.detect(message)
+        index_violation_detector.detect(message)
       end
 
       def insert_hash(record, serialized_record)
@@ -196,11 +169,11 @@ module RubyEventStore
       end
 
       def start_transaction(&block)
-        @event_klass.transaction(requires_new: true, &block)
+        event_klass.transaction(requires_new: true, &block)
       end
 
       def link_to_stream_(event_ids, stream, expected_version)
-        (event_ids - @event_klass.where(event_id: event_ids).pluck(:event_id)).each { |id| raise EventNotFound.new(id) }
+        (event_ids - event_klass.where(event_id: event_ids).pluck(:event_id)).each { |id| raise EventNotFound.new(id) }
         add_to_stream(event_ids, stream, expected_version)
       end
 
@@ -208,16 +181,53 @@ module RubyEventStore
         hashes = []
         event_ids = []
         records.each do |record|
-          hashes << insert_hash(record, record.serialize(serializer))
+          hashes << insert_hash(record, record.serialize(@serializer))
           event_ids << record.event_id
         end
-        add_to_stream(event_ids, stream, expected_version) { @event_klass.insert_all!(hashes) }
+        add_to_stream(event_ids, stream, expected_version) { event_klass.insert_all!(hashes) }
       end
 
-      private
+      def model_klasses
+        @model_klasses ||= @model_factory.call.tap do |event_model, stream_model|
+          if @serializer == NULL && json_data_type?(event_model)
+            warn <<~MSG
+              The data or metadata column is of a JSON/B type and expects a JSON string.
+
+              Yet the repository serializer is configured as #{@serializer} and it would not
+              produce the expected JSON string.
+
+              In ActiveRecord there's an implicit serialization to JSON for JSON/B column types
+              that made it work so far. This behaviour is unfortunately also a source of undesired
+              double serialization — first in the EventRepository, second in the ActiveRecord.
+
+              In the past we've advised workarounds that introduced configuration incosistency
+              with other data types and serialization formats, i.e. explicitly passing NULL serializer
+              just for the JSON/B data types.
+
+              As of now this special ActiveRecord behaviour is disabled. You should be using JSON
+              serializer back again:
+
+              RubyEventStore::ActiveRecord::EventRepository.new(serializer: JSON)
+            MSG
+          else
+            event_model.include(SkipJsonSerialization)
+          end
+        end
+      end
+
+      def event_klass = model_klasses.first
+      def stream_klass = model_klasses.last
+
+      def repo_reader
+        @repo_reader ||= EventRepositoryReader.new(event_klass, stream_klass, @serializer)
+      end
+
+      def index_violation_detector
+        @index_violation_detector ||= IndexViolationDetector.new(event_klass.table_name, stream_klass.table_name)
+      end
 
-      def json_data_type?
-        %i[data metadata].any? { |attr| @event_klass.column_for_attribute(attr).type.start_with?("json") }
+      def json_data_type?(klass)
+        %i[data metadata].any? { |attr| klass.column_for_attribute(attr).type.start_with?("json") }
       end
     end
   end

data/lib/ruby_event_store/active_record/event_repository_reader.rb

@@ -34,7 +34,8 @@ module RubyEventStore
       end
 
       def count(spec)
-        read_scope(spec).count
+        scope_size = read_scope(spec).count # mutant:disable
+        scope_size
       end
 
       def streams_of(event_id)

data/lib/ruby_event_store/active_record/generators/rails_migration_generator.rb

@@ -27,7 +27,7 @@ module RubyEventStore
 
         @database_adapter = DatabaseAdapter.from_string(adapter_name, data_type)
       rescue UnsupportedAdapter => e
-        raise Error, e.message
+        raise Error, e
       rescue InvalidDataTypeForAdapter
         raise Error,
               "Invalid value for --data-type option. Supported for options are: #{DatabaseAdapter.from_string(adapter_name).supported_data_types.join(", ")}."

data/lib/ruby_event_store/active_record/generators/rails_valid_at_index_migration_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+begin
+  require "rails/generators"
+rescue LoadError
+end
+
+if defined?(Rails::Generators::Base)
+  module RubyEventStore
+    module ActiveRecord
+      class RailsValidAtIndexMigrationGenerator < Rails::Generators::Base
+        class Error < Thor::Error
+        end
+
+        namespace "rails_event_store_active_record:migration_for_valid_at_index"
+
+        source_root File.expand_path(File.join(File.dirname(__FILE__), "../generators/templates"))
+
+        def create_migration
+          template "add_valid_at_index_to_event_store_events_template.erb",
+                   "db/migrate/#{timestamp}_add_valid_at_index_to_event_store_events.rb"
+        end
+
+        private
+
+        def migration_version
+          ::ActiveRecord::Migration.current_version
+        end
+
+        def timestamp
+          Time.now.strftime("%Y%m%d%H%M%S")
+        end
+      end
+    end
+  end
+end

data/lib/ruby_event_store/active_record/generators/templates/add_valid_at_index_to_event_store_events_template.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddValidAtIndexToEventStoreEvents < ActiveRecord::Migration[<%= migration_version %>]
+  def change
+    return if index_exists?(:event_store_events, nil, name: "index_event_store_events_on_as_of")
+
+    add_index :event_store_events, "COALESCE(valid_at, created_at)", name: "index_event_store_events_on_as_of"
+  end
+end

data/lib/ruby_event_store/active_record/generators/templates/postgres/create_event_store_events_template.erb

@@ -11,6 +11,8 @@ class CreateEventStoreEvents < ActiveRecord::Migration[<%= migration_version %>]
       t.datetime    :valid_at,    null: true, type: :timestamp, precision: 6, index: true
     end
 
+    add_index :event_store_events, "COALESCE(valid_at, created_at)", name: "index_event_store_events_on_as_of"
+
     create_table(:event_store_events_in_streams, id: :bigserial, force: false) do |t|
       t.string      :stream,      null: false
       t.integer     :position,    null: true

data/lib/ruby_event_store/active_record/generators/valid_at_index_migration_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RubyEventStore
+  module ActiveRecord
+    class ValidAtIndexMigrationGenerator
+      def call(migration_path)
+        path = build_path(migration_path)
+        write_to_file(path)
+        path
+      end
+
+      private
+
+      def absolute_path(path)
+        File.expand_path(path, __dir__)
+      end
+
+      def migration_code
+        migration_template.result_with_hash(migration_version: migration_version)
+      end
+
+      def migration_template
+        ERB.new(
+          File.read(
+            File.join(absolute_path("./templates"), "add_valid_at_index_to_event_store_events_template.erb"),
+          ),
+        )
+      end
+
+      def migration_version
+        ::ActiveRecord::Migration.current_version
+      end
+
+      def timestamp
+        Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      def write_to_file(path)
+        File.write(path, migration_code)
+      end
+
+      def build_path(migration_path)
+        File.join("#{migration_path}", "#{timestamp}_add_valid_at_index_to_event_store_events.rb")
+      end
+    end
+  end
+end

data/lib/ruby_event_store/active_record/railtie.rb

@@ -3,6 +3,12 @@
 module RubyEventStore
   module ActiveRecord
     class Railtie < ::Rails::Railtie
+      initializer "ruby_event_store-active_record" do
+        ActiveSupport.on_load(:active_record) do
+          require_relative "../active_record/skip_json_serialization"
+          require_relative "../active_record/event"
+        end
+      end
     end
   end
 end

data/lib/ruby_event_store/active_record/tasks/migration_tasks.rake

@@ -23,6 +23,16 @@ task "db:migrations:fix_missing_event_id_index" do
   puts "Migration file created #{path}"
 end
 
+desc "Generate migration for adding valid_at index on event_store_events"
+task "db:migrations:add_valid_at_index" do
+  task = MigrationTask.new("db:migrations:add_valid_at_index")
+  task.establish_connection
+
+  path = RubyEventStore::ActiveRecord::ValidAtIndexMigrationGenerator.new.call(task.migration_path)
+
+  puts "Migration file created #{path}"
+end
+
 desc "Generate migration for adding foreign key on event_store_events_in_streams.event_id"
 task "db:migrations:add_foreign_key_on_event_id" do
   task = MigrationTask.new("db:migrations:add_foreign_key_on_event_id")

data/lib/ruby_event_store/active_record/version.rb

@@ -2,6 +2,6 @@
 
 module RubyEventStore
   module ActiveRecord
-    VERSION = "2.17.1"
+    VERSION = "2.19.0"
   end
 end

data/lib/ruby_event_store/active_record.rb

@@ -7,6 +7,8 @@ require_relative "active_record/generators/event_id_index_migration_generator"
 require_relative "active_record/generators/rails_event_id_index_migration_generator"
 require_relative "active_record/generators/foreign_key_on_event_id_migration_generator"
 require_relative "active_record/generators/rails_foreign_key_on_event_id_migration_generator"
+require_relative "active_record/generators/valid_at_index_migration_generator"
+require_relative "active_record/generators/rails_valid_at_index_migration_generator"
 require_relative "active_record/with_default_models"
 require_relative "active_record/with_abstract_base_class"
 require_relative "active_record/event_repository"
@@ -15,6 +17,9 @@ require_relative "active_record/event_repository_reader"
 require_relative "active_record/index_violation_detector"
 require_relative "active_record/pg_linearized_event_repository"
 require_relative "active_record/version"
-require_relative "active_record/skip_json_serialization"
-require_relative "active_record/event"
-require_relative "active_record/railtie" if defined?(Rails::Engine)
+if defined?(Rails::Engine)
+  require_relative "active_record/railtie"
+else
+  require_relative "active_record/skip_json_serialization"
+  require_relative "active_record/event"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_event_store-active_record
 version: !ruby/object:Gem::Version
-  version: 2.17.1
+  version: 2.19.0
 platform: ruby
 authors:
 - Arkency
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.17.1
+        version: 2.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.17.1
+        version: 2.19.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -63,14 +63,17 @@ files:
 - lib/ruby_event_store/active_record/generators/rails_event_id_index_migration_generator.rb
 - lib/ruby_event_store/active_record/generators/rails_foreign_key_on_event_id_migration_generator.rb
 - lib/ruby_event_store/active_record/generators/rails_migration_generator.rb
+- lib/ruby_event_store/active_record/generators/rails_valid_at_index_migration_generator.rb
 - lib/ruby_event_store/active_record/generators/templates/add_event_id_index_to_event_store_events_in_streams_template.erb
 - lib/ruby_event_store/active_record/generators/templates/add_foreign_key_on_event_id_to_event_store_events_in_streams_template.erb
+- lib/ruby_event_store/active_record/generators/templates/add_valid_at_index_to_event_store_events_template.erb
 - lib/ruby_event_store/active_record/generators/templates/create_event_store_events_template.erb
 - lib/ruby_event_store/active_record/generators/templates/mysql/add_foreign_key_on_event_id_to_event_store_events_in_streams_template.erb
 - lib/ruby_event_store/active_record/generators/templates/mysql/create_event_store_events_template.erb
 - lib/ruby_event_store/active_record/generators/templates/postgres/add_foreign_key_on_event_id_to_event_store_events_in_streams_template.erb
 - lib/ruby_event_store/active_record/generators/templates/postgres/create_event_store_events_template.erb
 - lib/ruby_event_store/active_record/generators/templates/postgres/validate_add_foreign_key_on_event_id_to_event_store_events_in_streams_template.erb
+- lib/ruby_event_store/active_record/generators/valid_at_index_migration_generator.rb
 - lib/ruby_event_store/active_record/index_violation_detector.rb
 - lib/ruby_event_store/active_record/pg_linearized_event_repository.rb
 - lib/ruby_event_store/active_record/railtie.rb
@@ -103,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Persistent event repository implementation for RubyEventStore based on ActiveRecord
 test_files: []