entities can only be written to by events by default

.gitignore

@@ -5,6 +5,7 @@
 /doc/
 /log/*.log
 /pkg/
+/spec/examples.txt
 /spec/reports/
 /tmp/
 .idea

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 1.3.0 - 2024-01-14
+### Changed
+- Prevent manual write access to the entity table by default. This is to prevent
+  accidental writes to the entity table. Use entity.enable_writes! to enable writes.
+
 ## 1.2.3 - 2024-01-11
 ### Changed
 - Fix rendering of deleted events

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eventsimple (1.2.3)
+    eventsimple (1.3.0)
       dry-struct (~> 1.6)
       dry-types (~> 1.7)
       pg (~> 1.4)
@@ -125,6 +125,11 @@ GEM
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
     erubi (1.12.0)
+    factory_bot (6.4.5)
+      activesupport (>= 5.0.0)
+    factory_bot_rails (6.4.3)
+      factory_bot (~> 6.4)
+      railties (>= 5.0.0)
     ffi (1.16.3)
     formatador (1.1.0)
     fuubar (2.5.1)
@@ -358,6 +363,7 @@ PLATFORMS
 DEPENDENCIES
   bundle-audit
   eventsimple!
+  factory_bot_rails
   fuubar
   git
   guard-rspec

README.md

@@ -342,6 +342,24 @@ Create a rake task to run the consumer
 ## Helper methods
 Some convenience methods are provided to help with common use cases.
 
+**`#enable_writes!`**
+Write access on entities is disabled by default outside of writes via events. Use this method to enable writes on an entity.
+
+```ruby
+  user = User.find_by(canonical_id: 'user-123')
+  user.enable_writes! do
+    user.reproject
+    user.save!
+  end
+```
+
+If you are using FactoryBot, you can add the following in your rails_helper.rb to enable writes on the entity:
+```ruby
+FactoryBot.define do
+  after(:build) { |model| model.enable_writes! if model.class.ancestors.include?(Eventsimple::Entity::InstanceMethods) }
+end
+``
+
 **`#reproject(at: nil)`**
 
 Reproject an entity from events (rebuilds in memory but does not persist the entity).

eventsimple.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'retriable', '~> 3.1'
 
   spec.add_development_dependency 'bundle-audit'
+  spec.add_development_dependency 'factory_bot_rails'
   spec.add_development_dependency 'fuubar'
   spec.add_development_dependency 'git'
   spec.add_development_dependency 'guard-rspec'

lib/eventsimple/entity.rb

@@ -11,6 +11,8 @@ def event_driven_by(event_klass, aggregate_id:, filter_attributes: [])
         autosave: false,
         validate: false
 
+      after_initialize :readonly!
+
       class_attribute :ignored_for_projection, default: []
 
       class_attribute :_filter_attributes
@@ -32,6 +34,15 @@ def projection_matches_events?
         attributes == reprojected.attributes
       end
 
+      def enable_writes!(&block)
+        @readonly = false
+
+        if block
+          yield
+          @readonly = true
+        end
+      end
+
       def reproject(at: nil)
         event_history = at ? events.where('created_at <= ?', at).load : events.load
         ignore_props = (DEFAULT_IGNORE_PROPS + ignored_for_projection).map(&:to_s)

lib/eventsimple/event.rb

@@ -90,7 +90,9 @@ def apply_and_persist
         apply(aggregate)
 
         # Persist!
+        aggregate.enable_writes!
         aggregate.save!
+        aggregate.readonly!
 
         self.aggregate = aggregate
       end

lib/eventsimple/version.rb

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

spec/dummy/spec/components/user_component/events/created_spec.rb

@@ -33,15 +33,7 @@
     end
 
     context 'when can_apply? check fails' do
-      let(:user) {
-        User.create(
-          canonical_id: canonical_id,
-          username: 'test-user',
-          email: '[email protected]',
-          created_at: Time.current,
-          updated_at: Time.current,
-        )
-      }
+      let(:user) { create(:user, canonical_id: canonical_id) }
 
       it_behaves_like 'an event in invalid state'
     end

spec/dummy/spec/components/user_component/events/rescued_invalid_transition_spec.rb

@@ -29,15 +29,7 @@
     end
 
     context 'when can_apply? check fails' do
-      let(:user) {
-        User.create(
-          canonical_id: canonical_id,
-          username: 'test-user',
-          email: '[email protected]',
-          created_at: Time.current,
-          updated_at: Time.current,
-        )
-      }
+      let(:user) { create(:user, canonical_id: canonical_id) }
 
       it_behaves_like 'an event in invalid state that is rescued'
     end

spec/dummy/spec/components/user_component/events/rescued_invalid_transition_with_reraise_spec.rb

@@ -28,15 +28,7 @@
     end
 
     context 'when can_apply? check fails' do
-      let(:user) {
-        User.create(
-          canonical_id: canonical_id,
-          username: 'test-user',
-          email: '[email protected]',
-          created_at: Time.current,
-          updated_at: Time.current,
-        )
-      }
+      let(:user) { create(:user, canonical_id: canonical_id) }
 
       it_behaves_like 'an event in invalid state'
     end

spec/dummy/spec/factories/user.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user do
+    canonical_id { SecureRandom.uuid }
+    username { 'test-user' }
+    email { '[email protected]' }
+    created_at { Time.current }
+    updated_at { Time.current }
+  end
+end