ruby_event_store-active_record 2.9.0 → 2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42559ca51848ea6e388b9cfe5a73c9058691a4a2281000c6ba0da5f3899a40e
-  data.tar.gz: 17440ba2550814acb3bc4d0a9522570783ab21306c318dac218b85d98065f1e2
+  metadata.gz: 1625a6e2249c0ddac54baa8564bfece80a81b36a2e8cdd4fba198557b83e0ecf
+  data.tar.gz: 18ae89b42a29c0f562a6d93ce3c8264bf40f9d70ae975bd1a1a2124bc76b4ed1
 SHA512:
-  metadata.gz: 2870b19f168fd7730a9e3a1ab4cdfe7ec8d4c1ff3b9bda2d6f9a2f4a769a9e4c54f4fe85149525c1b4d5ee950151f01276fb17a079c1f1fd09753008dc80b3f7
-  data.tar.gz: 5c72abb8e403fb1e2a2f387943c04de84992ce7e6517feb0a457e949ef0c9b74eb3d6aabd60f2e7e15d85772b925e6a6e8c5e2ea5a65f66606460f881680a4d1
+  metadata.gz: 7ea84bed37d8183a5ee6ad111720c1c92bf36ced3651b8b72d02eb7d9c86c165133eaa22acac891d6e11403bada2e222e4f1e3ce1a0db061da50985456a0d0a0
+  data.tar.gz: a08404348cdbffef94a6f50968b67732b494d69e8f70f3adecbce84313dfe1b370debc870fcb147982cf6bf45d7f3c6ed6edf6bc16f6fac73fea03b6bbe96b52

data/lib/ruby_event_store/active_record/event_repository_reader.rb

@@ -114,11 +114,13 @@ module RubyEventStore
       end
 
       def as_of(spec)
-        Arel.sql("COALESCE(#{@event_klass.table_name}.valid_at, #{@event_klass.table_name}.created_at) #{order(spec)}")
+        expr = coalesce(@event_klass.arel_table[:valid_at], @event_klass.arel_table[:created_at])
+        spec.forward? ? expr.asc : expr.desc
       end
 
       def as_at(spec)
-        "#{@event_klass.table_name}.created_at #{order(spec)}"
+        expr = @event_klass.arel_table[:created_at]
+        spec.forward? ? expr.asc : expr.desc
       end
 
       def start_offset_condition(specification, record_id, search_in)
@@ -163,28 +165,32 @@ module RubyEventStore
         )
       end
 
+      def coalesce(*exprs)
+        Arel::Nodes::NamedFunction.new "COALESCE", exprs
+      end
+
       def time_comparison_field(specification)
         if specification.time_sort_by_as_of?
-          "COALESCE(#{@event_klass.table_name}.valid_at, #{@event_klass.table_name}.created_at)"
+          coalesce(@event_klass.arel_table[:valid_at], @event_klass.arel_table[:created_at])
         else
-          "#{@event_klass.table_name}.created_at"
+          @event_klass.arel_table[:created_at]
         end
       end
 
       def older_than_condition(specification)
-        ["#{time_comparison_field(specification)} < ?", specification.older_than]
+        time_comparison_field(specification).lt(specification.older_than)
       end
 
       def older_than_or_equal_condition(specification)
-        ["#{time_comparison_field(specification)} <= ?", specification.older_than_or_equal]
+        time_comparison_field(specification).lteq(specification.older_than_or_equal)
       end
 
       def newer_than_condition(specification)
-        ["#{time_comparison_field(specification)} > ?", specification.newer_than]
+        time_comparison_field(specification).gt(specification.newer_than)
       end
 
       def newer_than_or_equal_condition(specification)
-        ["#{time_comparison_field(specification)} >= ?", specification.newer_than_or_equal]
+        time_comparison_field(specification).gteq(specification.newer_than_or_equal)
       end
 
       def order(spec)

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RubyEventStore
+  module ActiveRecord
+    class EventIdIndexMigrationGenerator
+      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_event_id_index_to_event_store_events_in_streams_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_event_id_index_to_event_store_events_in_streams.rb")
+      end
+    end
+  end
+end

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

@@ -6,10 +6,11 @@ module RubyEventStore
     class MigrationGenerator
       DATA_TYPES = %w[binary json jsonb].freeze
 
-      def call(data_type, migration_path)
+      def call(data_type, database_adapter, migration_path)
         raise ArgumentError, "Invalid value for data type. Supported for options are: #{DATA_TYPES.join(", ")}." unless DATA_TYPES.include?(data_type)
+        VerifyDataTypeForAdapter.new.call(database_adapter, data_type)
 
-        migration_code = migration_code(data_type)
+        migration_code = migration_code(data_type, database_adapter)
         path = build_path(migration_path)
         write_to_file(migration_code, path)
         path
@@ -21,8 +22,16 @@ module RubyEventStore
         File.expand_path(path, __dir__)
       end
 
-      def migration_code(data_type)
-        migration_template(absolute_path("./templates"), "create_event_store_events").result_with_hash(migration_version: migration_version, data_type: data_type)
+      def migration_code(data_type, database_adapter)
+        migration_template(template_root(database_adapter), "create_event_store_events").result_with_hash(migration_version: migration_version, data_type: data_type)
+      end
+
+      def template_root(database_adapter)
+        absolute_path("./templates/#{template_directory(database_adapter)}")
+      end
+
+      def template_directory(database_adapter)
+        TemplateDirectory.for_adapter(database_adapter)
       end
 
       def migration_template(template_root, name)
@@ -30,7 +39,7 @@ module RubyEventStore
       end
 
       def migration_version
-        "[4.2]"
+        ::ActiveRecord::Migration.current_version
       end
 
       def timestamp
@@ -42,7 +51,7 @@ module RubyEventStore
       end
 
       def build_path(migration_path)
-        File.join( "#{migration_path}", "#{timestamp}_create_event_store_events.rb")
+        File.join("#{migration_path}", "#{timestamp}_create_event_store_events.rb")
       end
     end
   end

data/lib/ruby_event_store/active_record/generators/rails_event_id_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 RailsEventIdIndexMigrationGenerator < Rails::Generators::Base
+        class Error < Thor::Error
+        end
+
+        namespace "rails_event_store_active_record:migration_for_missing_event_id_index"
+
+        source_root File.expand_path(File.join(File.dirname(__FILE__), "../generators/templates"))
+
+        def create_migration
+          template "add_event_id_index_to_event_store_events_in_streams_template.erb",
+                   "db/migrate/#{timestamp}_add_event_id_index_to_event_store_events_in_streams.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/rails_migration_generator.rb

@@ -27,23 +27,35 @@ module RubyEventStore
       def initialize(*args)
         super
 
-        if DATA_TYPES.exclude?(options.fetch(:data_type))
+        if DATA_TYPES.exclude?(data_type)
           raise Error, "Invalid value for --data-type option. Supported for options are: #{DATA_TYPES.join(", ")}."
         end
+
+        VerifyDataTypeForAdapter.new.call(adapter, data_type)
+      rescue InvalidDataTypeForAdapter, UnsupportedAdapter => e
+        raise Error, e.message
       end
 
       def create_migration
-        template "create_event_store_events_template.erb", "db/migrate/#{timestamp}_create_event_store_events.rb"
+        template "#{template_directory}create_event_store_events_template.erb", "db/migrate/#{timestamp}_create_event_store_events.rb"
       end
 
       private
 
+      def template_directory
+        TemplateDirectory.for_adapter(adapter)
+      end
+
       def data_type
         options.fetch("data_type")
       end
 
+      def adapter
+        ::ActiveRecord::Base.connection.adapter_name.downcase
+      end
+
       def migration_version
-        "[4.2]"
+        ::ActiveRecord::Migration.current_version
       end
 
       def timestamp

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddEventIdIndexToEventStoreEventsInStreams < ActiveRecord::Migration[<%= migration_version %>]
+  def change
+    return if index_exists?(:event_store_events_in_streams, :event_id)
+
+    add_index :event_store_events_in_streams, [:event_id]
+  end
+end

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

@@ -1,55 +1,24 @@
 # frozen_string_literal: true
 
-class CreateEventStoreEvents < ActiveRecord::Migration<%= migration_version %>
+class CreateEventStoreEvents < ActiveRecord::Migration[<%= migration_version %>]
   def change
-    postgres =
-      ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
-    if postgres
-      create_table(:event_store_events_in_streams, id: :bigserial, force: false) do |t|
-        t.string      :stream,      null: false
-        t.integer     :position,    null: true
-        t.references  :event,       null: false, type: :uuid
-        t.datetime    :created_at,  null: false
-      end
-      add_index :event_store_events_in_streams, [:stream, :position], unique: true
-      add_index :event_store_events_in_streams, [:created_at]
-      add_index :event_store_events_in_streams, [:stream, :event_id], unique: true
-
-      create_table(:event_store_events, id: :bigserial, force: false) do |t|
-        t.references  :event,       null: false, type: :uuid
-        t.string      :event_type,  null: false
-        t.<%= data_type %>      :metadata
-        t.<%= data_type %>      :data, null: false
-        t.datetime    :created_at,  null: false
-        t.datetime    :valid_at,    null: true
-      end
-      add_index :event_store_events, :event_id, unique: true
-      add_index :event_store_events, :created_at
-      add_index :event_store_events, :valid_at
-      add_index :event_store_events, :event_type
-    else
-      create_table(:event_store_events_in_streams, force: false) do |t|
-        t.string      :stream,      null: false
-        t.integer     :position,    null: true
-        t.references  :event,       null: false, type: :string, limit: 36
-        t.datetime    :created_at,  null: false, precision: 6
-      end
-      add_index :event_store_events_in_streams, [:stream, :position], unique: true
-      add_index :event_store_events_in_streams, [:created_at]
-      add_index :event_store_events_in_streams, [:stream, :event_id], unique: true
+    create_table(:event_store_events_in_streams, force: false) do |t|
+      t.string      :stream,      null: false
+      t.integer     :position,    null: true
+      t.references  :event,       null: false, type: :string, limit: 36, index: false
+      t.datetime    :created_at,  null: false, precision: 6, index: true
+    end
+    add_index :event_store_events_in_streams, [:stream, :position], unique: true
+    add_index :event_store_events_in_streams, [:stream, :event_id], unique: true
+    add_index :event_store_events_in_streams, [:event_id]
 
-      create_table(:event_store_events, force: false) do |t|
-        t.references  :event,       null: false, type: :string, limit: 36
-        t.string      :event_type,  null: false
-        t.binary      :metadata
-        t.binary      :data,        null: false
-        t.datetime    :created_at,  null: false, precision: 6
-        t.datetime    :valid_at,    null: true,  precision: 6
-      end
-      add_index :event_store_events, :event_id, unique: true
-      add_index :event_store_events, :created_at
-      add_index :event_store_events, :valid_at
-      add_index :event_store_events, :event_type
+    create_table(:event_store_events, force: false) do |t|
+      t.references  :event,       null: false, type: :string, limit: 36, index: { unique: true }
+      t.string      :event_type,  null: false, index: true
+      t.binary      :metadata
+      t.binary      :data,        null: false
+      t.datetime    :created_at,  null: false, precision: 6, index: true
+      t.datetime    :valid_at,    null: true,  precision: 6, index: true
     end
   end
 end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class CreateEventStoreEvents < ActiveRecord::Migration[<%= migration_version %>]
+  def change
+    create_table(:event_store_events_in_streams, force: false) do |t|
+      t.string      :stream,      null: false
+      t.integer     :position,    null: true
+      t.references  :event,       null: false, type: :string, limit: 36, index: false
+      t.datetime    :created_at,  null: false, precision: 6, index: true
+    end
+    add_index :event_store_events_in_streams, [:stream, :position], unique: true
+    add_index :event_store_events_in_streams, [:stream, :event_id], unique: true
+    add_index :event_store_events_in_streams, [:event_id]
+
+    create_table(:event_store_events, force: false) do |t|
+      t.references  :event,       null: false, type: :string, limit: 36, index: { unique: true }
+      t.string      :event_type,  null: false, index: true
+      t.<%= data_type %>      :metadata
+      t.<%= data_type %>      :data,        null: false
+      t.datetime    :created_at,  null: false, precision: 6, index: true
+      t.datetime    :valid_at,    null: true,  precision: 6, index: true
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class CreateEventStoreEvents < ActiveRecord::Migration[<%= migration_version %>]
+  def change
+    create_table(:event_store_events_in_streams, id: :bigserial, force: false) do |t|
+      t.string      :stream,      null: false
+      t.integer     :position,    null: true
+      t.references  :event,       null: false, type: :uuid, index: false
+      t.datetime    :created_at,  null: false, type: :timestamp, precision: 6, index: true
+    end
+    add_index :event_store_events_in_streams, [:stream, :position], unique: true
+    add_index :event_store_events_in_streams, [:stream, :event_id], unique: true
+    add_index :event_store_events_in_streams, [:event_id]
+
+    create_table(:event_store_events, id: :bigserial, force: false) do |t|
+      t.references  :event,       null: false, type: :uuid, index: { unique: true }
+      t.string      :event_type,  null: false, index: true
+      t.<%= data_type %>      :metadata
+      t.<%= data_type %>      :data, null: false
+      t.datetime    :created_at,  null: false, type: :timestamp, precision: 6, index: true
+      t.datetime    :valid_at,    null: true, type: :timestamp, precision: 6, index: true
+    end
+  end
+end

data/lib/ruby_event_store/active_record/generators/templates/template_directory.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyEventStore
+  module ActiveRecord
+    class TemplateDirectory
+      def self.for_adapter(database_adapter)
+        case database_adapter.downcase
+        when "postgresql"
+          "postgres/"
+        when "mysql2"
+          "mysql/"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RubyEventStore
+  module ActiveRecord
+    InvalidDataTypeForAdapter = Class.new(StandardError)
+    UnsupportedAdapter = Class.new(StandardError)
+
+    class VerifyDataTypeForAdapter
+      SUPPORTED_POSTGRES_DATA_TYPES = %w[binary json jsonb].freeze
+      SUPPORTED_MYSQL_DATA_TYPES = %w[binary json].freeze
+      SUPPORTED_SQLITE_DATA_TYPES = %w[binary].freeze
+
+      def call(adapter, data_type)
+        raise UnsupportedAdapter, "Unsupported adapter" unless supported?(adapter)
+        raise InvalidDataTypeForAdapter, "MySQL2 doesn't support #{data_type}" if is_mysql2?(adapter) && !SUPPORTED_MYSQL_DATA_TYPES.include?(data_type)
+        raise InvalidDataTypeForAdapter, "sqlite doesn't support #{data_type}" if is_sqlite?(adapter) && supported_by_sqlite?(data_type)
+        raise InvalidDataTypeForAdapter, "PostgreSQL doesn't support #{data_type}" unless supported_by_postgres?(data_type)
+      end
+
+      private
+
+      private_constant :SUPPORTED_POSTGRES_DATA_TYPES, :SUPPORTED_MYSQL_DATA_TYPES, :SUPPORTED_SQLITE_DATA_TYPES
+
+      def supported?(adapter)
+        %w[mysql2 postgresql sqlite].include?(adapter.downcase)
+      end
+
+      def is_sqlite?(adapter)
+        adapter.downcase.eql?("sqlite")
+      end
+
+      def is_mysql2?(adapter)
+        adapter.downcase.eql?("mysql2")
+      end
+
+      def supported_by_sqlite?(data_type)
+        !SUPPORTED_SQLITE_DATA_TYPES.include?(data_type)
+      end
+
+      def supported_by_postgres?(data_type)
+        SUPPORTED_POSTGRES_DATA_TYPES.include?(data_type)
+      end
+    end
+  end
+end

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

@@ -2,11 +2,26 @@ require_relative "../generators/migration_generator"
 
 desc "Generate migration"
 task "db:migrations:copy" do
-  data_type = ENV["DATA_TYPE"] || raise("Specify data type (binary, json, jsonb): rake db:migrations:copy DATA_TYPE=json")
+  data_type =
+    ENV["DATA_TYPE"] || raise("Specify data type (binary, json, jsonb): rake db:migrations:copy DATA_TYPE=json")
+  ::ActiveRecord::Base.establish_connection(ENV["DATABASE_URL"])
+  database_adapter = ::ActiveRecord::Base.connection.adapter_name
 
-  path = RubyEventStore::ActiveRecord::MigrationGenerator
-           .new
-           .call(data_type, ENV["MIGRATION_PATH"] || "db/migrate")
+  path =
+    RubyEventStore::ActiveRecord::MigrationGenerator.new.call(
+      data_type,
+      database_adapter,
+      ENV["MIGRATION_PATH"] || "db/migrate"
+    )
 
   puts "Migration file created #{path}"
-end
+end
+
+desc "Generate migration for missing event_id index"
+task "db:migrations:fix_missing_event_id_index" do
+  ::ActiveRecord::Base.establish_connection(ENV["DATABASE_URL"])
+
+  path = RubyEventStore::ActiveRecord::EventIdIndexMigrationGenerator.new.call(ENV["MIGRATION_PATH"] || "db/migrate")
+
+  puts "Migration file created #{path}"
+end

data/lib/ruby_event_store/active_record/version.rb

@@ -2,6 +2,6 @@
 
 module RubyEventStore
   module ActiveRecord
-    VERSION = "2.9.0"
+    VERSION = "2.10"
   end
 end

data/lib/ruby_event_store/active_record.rb

@@ -2,6 +2,10 @@
 
 require_relative "active_record/generators/migration_generator"
 require_relative "active_record/generators/rails_migration_generator"
+require_relative "active_record/generators/templates/template_directory"
+require_relative "active_record/generators/verify_data_type_for_adapter"
+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/event"
 require_relative "active_record/with_default_models"
 require_relative "active_record/with_abstract_base_class"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_event_store-active_record
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: '2.10'
 platform: ruby
 authors:
 - Arkency
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_event_store
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '2.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -57,9 +57,16 @@ files:
 - lib/ruby_event_store/active_record/event.rb
 - lib/ruby_event_store/active_record/event_repository.rb
 - lib/ruby_event_store/active_record/event_repository_reader.rb
+- lib/ruby_event_store/active_record/generators/event_id_index_migration_generator.rb
 - lib/ruby_event_store/active_record/generators/migration_generator.rb
+- lib/ruby_event_store/active_record/generators/rails_event_id_index_migration_generator.rb
 - lib/ruby_event_store/active_record/generators/rails_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/create_event_store_events_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/create_event_store_events_template.erb
+- lib/ruby_event_store/active_record/generators/templates/template_directory.rb
+- lib/ruby_event_store/active_record/generators/verify_data_type_for_adapter.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
@@ -92,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Persistent event repository implementation for RubyEventStore based on ActiveRecord