eventsimple 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 394c4820e133907b2e63fe826b7891ab2cd0fbc1f436683b667ac9cfee73e57a
-  data.tar.gz: 70508717fa8b8a1b2528a38044648c3748b63ffd721c606ec66fdf959e54b53a
+  metadata.gz: c49589e4a0e45a9149f99568927f76b0d17b1e6b22f73bb079edd1b27ea856cd
+  data.tar.gz: 95794663749d9759b1ddbb6867c6774ffc8df60a30449c408958fb68f7160dc3
 SHA512:
-  metadata.gz: 1150de14bcfc4580f7b2be46a406d602a29bcecb7b75aabd136215e8893fc8b4cc98fbfc29082cc1a7ac30cb7235e7ac81206e05532cdf260c74d8e68bf10176
-  data.tar.gz: 4d47af195c91593c5424c0f9a5316cd35e3c4aa9b135cbdb894fa86bcef72d899b1e6f1187afe063c627dbeb787d9bb0dfc310fc8de60ad0bbbf7d48cbbf4a60
+  metadata.gz: c134a1dfdf5e16e888b2c9018756819417205f924609b095001cbd2802e1c97e27f0268b93c6eada4c036162cf4086b33c72127c2539d9fcd085cca7ca11b24f
+  data.tar.gz: d8edcf526493068375fc706d04180f206c73fcb4fc57848e1fc6c5cabfcb09690235f3550a5f7b6ac67f230e94deb56f6a5a91097a43476660f8e5b4aabfb84f

data/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 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.
+
 ## 2.3.0 - 2026-02-24
 ### Added
 - Per-event metadata class: pass `metadata_class:` to `drives_events_for` to use a custom metadata class for that event (Class or String).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eventsimple (2.3.0)
+    eventsimple (2.5.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.3.0)
+  eventsimple (2.5.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/app/helpers/eventsimple/entities_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Eventsimple
+  module EntitiesHelper
+    def render_value(value)
+      case value
+      when nil
+        content_tag(:code, '-', class: 'entity-property')
+      when Hash, Array
+        content_tag(:div, '', class: 'json-viewer-target', data: { json: value.to_json })
+      else
+        content_tag(:code, value.to_s, class: 'entity-property')
+      end
+    end
+  end
+end

data/app/views/eventsimple/entities/show.html.erb

@@ -32,8 +32,8 @@
               <% @entity_changes.each do |property| %>
                 <tr class="<%= property[:is_changed] ? 'table-info' : '' %>">
                   <th scope="row"><%= property[:label] %></th>
-                  <td><code class="entity-property"><%= property[:historical_value].nil? ? '-' : property[:historical_value] %></code></td>
-                  <td><code class="entity-property"><%= property[:current_value].nil? ? '-' : property[:current_value] %></code></td>
+                  <td><%= render_value(property[:historical_value]) %></td>
+                  <td><%= render_value(property[:current_value]) %></td>
                 </tr>
               <% end %>
             </tbody>
@@ -64,7 +64,7 @@
                 <% @selected_event.data.to_h.each do |attr_name, attr_value| %>
                 <tr>
                   <td>&nbsp;&nbsp;&nbsp;&nbsp;<%= attr_name %></td>
-                  <td><code class="entity-property"><%= attr_value %></code></td>
+                  <td><%= render_value(attr_value) %></td>
                 </tr>
                 <% end %>
               <% end %>
@@ -75,7 +75,7 @@
               <% @selected_event.metadata.to_h.each do |attr_name, attr_value| %>
                 <tr>
                   <td>&nbsp;&nbsp;&nbsp;&nbsp;<%= attr_name %></td>
-                  <td><code class="entity-property">: <%= attr_value %></code></td>
+                  <td><%= render_value(attr_value) %></td>
                 </tr>
               <% end %>
             </tbody>

data/app/views/layouts/eventsimple/application.html.erb

@@ -25,6 +25,15 @@
     integrity: "sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo=",
     crossorigin: "anonymous"
   %>
+  <%= stylesheet_link_tag "https://cdn.jsdelivr.net/npm/jquery.json-viewer@1.5.0/json-viewer/jquery.json-viewer.css",
+    media: "all",
+    integrity: "sha256-rXfxviikI1RGZM3px6piq9ZL0YZuO5ETcO8+toY+DDY=",
+    crossorigin: "anonymous"
+  %>
+  <%= javascript_include_tag "https://cdn.jsdelivr.net/npm/jquery.json-viewer@1.5.0/json-viewer/jquery.json-viewer.js",
+    integrity: "sha256-Tbq6mI1/ZeudUckwCGhWMlV8S/Ae9cQRIf/yBDVg0Ek=",
+    crossorigin: "anonymous"
+  %>
 
   <%= render partial: 'eventsimple/shared/style' %>
 </head>
@@ -63,6 +72,10 @@
           query.set(param, value);
           link.attr("href",window.location.pathname + '?' + query.toString());
         });
+
+        $('.json-viewer-target').each(function () {
+          $(this).jsonViewer($(this).data('json'), { collapsed: true, withQuotes: true, withLinks: false });
+        });
       });
     </script>
 

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Eventsimple
-  VERSION = '2.3.0'
+  VERSION = '2.5.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.3.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Zulfiqar Ali
@@ -330,6 +330,7 @@ files:
 - app/controllers/eventsimple/entities_controller.rb
 - app/controllers/eventsimple/home_controller.rb
 - app/controllers/eventsimple/models_controller.rb
+- app/helpers/eventsimple/entities_helper.rb
 - app/views/eventsimple/entities/show.html.erb
 - app/views/eventsimple/home/index.html.erb
 - app/views/eventsimple/models/show.html.erb
@@ -362,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