eventsimple 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 552ecc441120517eee35f12c6ebef012611c7565730b4c0cdf180f2e58ab1d05
-  data.tar.gz: c5e55ce426acbf14f25dddcbc861a3eb8a3fac2635ce6d706dd97e90eb4151db
+  metadata.gz: 64f15c989c426a973f8d1689e098c0ea7947af521742bb8e70badf2b705ed162
+  data.tar.gz: 48de4621966b60aa7328e4eb51c383d2cb65a5862ce8301d9d754eca6cbc0d3e
 SHA512:
-  metadata.gz: dbeb3130ffe536969366bdfe22cb193310d045eac757eee98c894d7944f7ff0b31d6be889a068030432ff51d4adc6a50ff56c026c4b78f48f65e1e9356ff6967
-  data.tar.gz: a35d64be339e546d3dcbb48ff5f27d0385bca49d119d3b054ab970ae91458e76a42160871b252deab2ebaf2d65475052085fb9f9487132f4381f5c8139ad254f
+  metadata.gz: 6c0a3945fd3e5dc70798933b0058d91c79cea258ecbb895917e6f93a9d6e3cf404bd356f36332d8e072b2dcb7a4bdbb32b560696af4266e592bf34e115200904
+  data.tar.gz: d1f53a2cbdbe9f3c951368d52300db2e3fc692f2b9e76d39c179d8f37675e5ff6ff7735643e480b1b68c748bdc2cd8a6c0a2cbbd9e330827f2078b3b253ab5d4

data/CHANGELOG.md

@@ -6,6 +6,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 2.6.0 - 2026-05-01
+### Added
+- `Eventsimple::Types::*.encrypted` now accepts an optional
+  `key_provider:` keyword. When supplied, encryption/decryption goes
+  through that `ActiveRecord::Encryption::KeyProvider` instead of the
+  default keyed off `config.active_record.encryption.primary_key`.
+  Existing call sites (no `key_provider:`) keep using the global
+  config. Lets a single Rails app encrypt different event attributes
+  against different `KeyProvider`s — e.g. when collapsing a
+  microservice that used its own primary key (and possibly its own
+  derivation salt) into a host app whose globals are already used for
+  its own encrypted events.
+
+## 2.5.0 - 2026-04-26
+### Added
+- Entities and events now raise `ActiveRecord::ReadOnlyRecord` when persistence methods that bypass ActiveRecord's built-in readonly check are invoked (`delete`, `update_column(s)`, `update_attribute(!)`, `touch`, `toggle!`, `increment!`, `decrement!`). Relation-level bulk SQL (`insert` / `insert_all` / `upsert` / `upsert_all` / `update_all` / `delete_all` / `touch_all`) is guarded the same way.
+- `Eventsimple.enable_writes! { }` is the single API for opting in to writes (instance saves/updates and relation bulk SQL). While active, `readonly?` is bypassed for event-sourced models so `save`/`update`/`destroy` work inside the block.
+
+### Removed
+- Model instance `#enable_writes!` — calling it raises `Eventsimple::DeprecatedInstanceEnableWrites`. Use `Eventsimple.enable_writes! { ... }` instead.
+
 ## 2.4.0 - 2026-04-25
 ### Added
 - Collapsible JSON viewer for Hash and Array values in the admin UI.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eventsimple (2.4.0)
+    eventsimple (2.6.0)
       concurrent-ruby (>= 1.2.3)
       dry-struct (>= 1.8.0)
       dry-types (>= 1.7.0)
@@ -458,7 +458,7 @@ CHECKSUMS
   dry-types (1.9.0) sha256=7b656fe0a78d2432500ae1f29fefd6762f5a032ca7000e4f36bc111453d45d4d
   erb (6.0.1) sha256=28ecdd99c5472aebd5674d6061e3c6b0a45c049578b071e5a52c2a7f13c197e5
   erubi (1.13.1) sha256=a082103b0885dbc5ecf1172fede897f9ebdb745a4b97a5e8dc63953db1ee4ad9
-  eventsimple (2.4.0)
+  eventsimple (2.6.0)
   factory_bot (6.5.6) sha256=12beb373214dccc086a7a63763d6718c49769d5606f0501e0a4442676917e077
   factory_bot_rails (6.5.1) sha256=d3cc4851eae4dea8a665ec4a4516895045e710554d2b5ac9e68b94d351bc6d68
   ffi (1.17.3-aarch64-linux-gnu) sha256=28ad573df26560f0aedd8a90c3371279a0b2bd0b4e834b16a2baa10bd7a97068

data/lib/eventsimple/entity.rb

@@ -25,7 +25,7 @@ module Eventsimple
       has_many :events, class_name: event_klass.name.to_s,
         foreign_key: :aggregate_id,
         primary_key: aggregate_id,
-        dependent: :delete_all,
+        dependent: :restrict_with_exception,
         inverse_of: model_name.element.to_sym,
         autosave: false,
         validate: false
@@ -45,8 +45,11 @@ module Eventsimple
 
       Eventsimple.configuration.ui_visible_model_names |= [name]
 
+      include Readonly
       include InstanceMethods
       extend ClassMethods
+
+      Readonly.install_relation_guards!(self)
     end
 
     module InstanceMethods
@@ -56,16 +59,6 @@ module Eventsimple
         attributes == reprojected.attributes
       end
 
-      def enable_writes!(&block)
-        was_readonly = @readonly
-        @readonly = false
-
-        return unless block
-
-        yield self
-        @readonly = was_readonly
-      end
-
       def reproject(at: nil, skip_deleted: false)
         event_history = at ? events.where('created_at <= ?', at).load : events.load
 

data/lib/eventsimple/event.rb

@@ -75,8 +75,11 @@ module Eventsimple
       after_create :dispatch
       after_create :readonly!
 
+      include Readonly
       include InstanceMethods
       extend ClassMethods
+
+      Readonly.install_relation_guards!(self)
     end
 
     module InstanceMethods
@@ -123,8 +126,9 @@ module Eventsimple
         apply_timestamps(aggregate)
         apply(aggregate)
 
-        aggregate.enable_writes!
-        aggregate.save!
+        Eventsimple.enable_writes! do
+          aggregate.save!
+        end
         aggregate.readonly!
 
         self.aggregate = aggregate
@@ -141,16 +145,6 @@ module Eventsimple
       def aggregate=(aggregate)
         public_send(:"#{_aggregate_klass.model_name.element}=", aggregate)
       end
-
-      def enable_writes!(&block)
-        was_readonly = @readonly
-        @readonly = false
-
-        return unless block
-
-        yield self
-        @readonly = was_readonly
-      end
     end
 
     module ClassMethods

data/lib/eventsimple/readonly.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Eventsimple
+  # Raised when +#enable_writes!+ is called on a model instance. Use
+  # {Eventsimple.enable_writes!} instead.
+  DeprecatedInstanceEnableWrites = Class.new(StandardError)
+
+  # Closes gaps where writes bypass +readonly!+ (instance helpers like +delete+,
+  # +update_column+, relation SQL like +upsert+ / +delete_all+ / +update_all+).
+  # Raises +ActiveRecord::ReadOnlyRecord+ unless {Eventsimple.enable_writes!} is active.
+  module Readonly
+    THREAD_KEY = :eventsimple_class_writes_depth
+
+    module RelationMethods
+      RELATION_WRITE_METHODS = %i[
+        insert insert!
+        insert_all insert_all!
+        upsert upsert_all
+        update_all delete_all touch_all
+      ].freeze
+
+      RELATION_WRITE_METHODS.each do |method_name|
+        define_method(method_name) do |*args, **kwargs, &block|
+          _raise_relation_readonly! unless Readonly.class_writes_enabled?
+          super(*args, **kwargs, &block)
+        end
+      end
+
+      private
+
+      def _raise_relation_readonly!
+        raise ActiveRecord::ReadOnlyRecord, "#{model.name} is marked as readonly"
+      end
+    end
+
+    class << self
+      def install_relation_guards!(model_class)
+        ActiveRecord::Delegation.delegated_classes.each do |relation_base|
+          delegate_class = model_class.relation_delegate_class(relation_base)
+          next if delegate_class.ancestors.include?(RelationMethods)
+
+          delegate_class.prepend(RelationMethods)
+        end
+      end
+
+      def enable_writes!
+        Thread.current[THREAD_KEY] = Thread.current[THREAD_KEY].to_i + 1
+        yield
+      ensure
+        d = Thread.current[THREAD_KEY].to_i - 1
+        Thread.current[THREAD_KEY] = d.positive? ? d : nil
+      end
+
+      def class_writes_enabled?
+        Thread.current[THREAD_KEY].to_i.positive?
+      end
+    end
+
+    def readonly?
+      return false if Readonly.class_writes_enabled?
+
+      super
+    end
+
+    def enable_writes!(&_block)
+      raise DeprecatedInstanceEnableWrites, <<~MSG.squish
+        Use Eventsimple.enable_writes! { ... } instead of #{self.class.name}#enable_writes!
+      MSG
+    end
+
+    def delete
+      _raise_readonly_record_error if readonly?
+      super
+    end
+
+    def update_column(...)
+      _raise_readonly_record_error if readonly?
+      super
+    end
+
+    def update_columns(...)
+      _raise_readonly_record_error if readonly?
+      super
+    end
+
+    def update_attribute(...)
+      _raise_readonly_record_error if readonly?
+      super
+    end
+
+    def update_attribute!(...)
+      _raise_readonly_record_error if readonly?
+      super
+    end
+
+    def increment!(...)
+      _raise_readonly_record_error if readonly?
+      super
+    end
+
+    def decrement!(...)
+      _raise_readonly_record_error if readonly?
+      super
+    end
+
+    def toggle!(...)
+      _raise_readonly_record_error if readonly?
+      super
+    end
+
+    def touch(...)
+      _raise_readonly_record_error if readonly?
+      super
+    end
+  end
+end

data/lib/eventsimple/types/encrypted_type.rb

@@ -9,16 +9,17 @@ module Eventsimple
       include Dry::Types::Decorator
       include Dry::Types::Builder
 
-      def initialize(type, **options)
+      def initialize(type, key_provider: nil, **options)
         super
         @type = type
+        @key_provider = key_provider
         freeze
       end
 
       def meta(data = nil)
         return { eventsimple: true } if data.nil?
 
-        self.class.new(@type.meta(data))
+        self.class.new(@type.meta(data), key_provider: @key_provider)
       end
 
       def encrypt(value)
@@ -26,9 +27,13 @@ module Eventsimple
         return value if value == '' || (value.is_a?(::String) && value.blank?)
 
         string_value = serialize_value(value)
-        return string_value if ActiveRecord::Encryption::Encryptor.new.encrypted?(string_value)
+        return string_value if encryptor.encrypted?(string_value)
 
-        ActiveRecord::Encryption::Encryptor.new.encrypt(string_value)
+        if @key_provider
+          encryptor.encrypt(string_value, key_provider: @key_provider)
+        else
+          encryptor.encrypt(string_value)
+        end
       end
 
       def decrypt(value)
@@ -36,7 +41,11 @@ module Eventsimple
         return value if value == '' || (value.is_a?(::String) && value.blank?)
 
         decrypted = begin
-          ActiveRecord::Encryption::Encryptor.new.decrypt(value)
+          if @key_provider
+            encryptor.decrypt(value, key_provider: @key_provider)
+          else
+            encryptor.decrypt(value)
+          end
         rescue StandardError
           return value # Return original if decryption fails
         end
@@ -46,6 +55,10 @@ module Eventsimple
 
       private
 
+      def encryptor
+        ActiveRecord::Encryption::Encryptor.new
+      end
+
       def serialize_value(value)
         case value
         when Array, Hash

data/lib/eventsimple/types.rb

@@ -26,12 +26,12 @@ module Eventsimple
         end
       end
 
-      def encrypted
+      def encrypted(key_provider: nil)
         if respond_to?(:name) && name.to_s.include?('TrueClass') && name.to_s.include?('FalseClass')
           raise ArgumentError, 'Bool type does not support encryption'
         end
 
-        EncryptedType.new(self)
+        EncryptedType.new(self, key_provider: key_provider)
       end
     end
 

data/lib/eventsimple/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Eventsimple
-  VERSION = '2.4.0'
+  VERSION = '2.6.0'
 end

data/lib/eventsimple.rb

@@ -21,6 +21,7 @@ require 'eventsimple/event_dispatcher'
 require 'eventsimple/reactor'
 require 'eventsimple/invalid_transition'
 
+require 'eventsimple/readonly'
 require 'eventsimple/entity'
 require 'eventsimple/event'
 
@@ -36,5 +37,11 @@ module Eventsimple
     def configure
       yield(configuration)
     end
+
+    # Unlocks writes for event-sourced models for the duration of the block (instance +save+,
+    # relation +update_all+, +upsert+, +delete_all+, etc.).
+    def enable_writes!(&block)
+      Readonly.enable_writes!(&block)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eventsimple
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Zulfiqar Ali
@@ -363,6 +363,7 @@ files:
 - lib/eventsimple/outbox/models/cursor.rb
 - lib/eventsimple/reactor.rb
 - lib/eventsimple/reactor_worker.rb
+- lib/eventsimple/readonly.rb
 - lib/eventsimple/support/spec_helpers.rb
 - lib/eventsimple/types.rb
 - lib/eventsimple/types/encrypted_type.rb