eventsimple 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c19b9d4481185e75ebfbb32cde09d5e1cf27b4ce79dac12eaa9693ad0f3888df
-  data.tar.gz: 8907efcfdc5e08f43fa0e2f0682b3937d8866e16eaf22bf5ec34589e1d3ca8cf
+  metadata.gz: 638006c0e2d430bc3ef8e945b770495fecdfdf4eb96c2d7555c6f2b01d916884
+  data.tar.gz: b116ebfbc7fad79107f23236d249fcb1ece6a599cdd95b6489c9ca8c8dc4cf22
 SHA512:
-  metadata.gz: f2a911cfa42750ec24803938cdee68982c7456f845b78958e6a4970f37701749e647419baafb8c80a1bafd0d061abe12f409dee6456a50a1738fbd0436c09a1f
-  data.tar.gz: dd1f22f67d7d9d9ad88849c7e55db009e2a49b15f0a20a66387768ff03ef34e1ca100a23db829b3b09c99f978a3c7386636a2f0bd6e737743c602856cda1afa0
+  metadata.gz: 5cf51f1c191bd05e022bd105f056082c1b70b76b51435d74a8e241c9b2b8519a6ae874f0dd206c76101742466120415cade893695304fe5e086d7048a33f07d3
+  data.tar.gz: 6a37c35600d9cec4e4507a3fffecf42789e9a1108ffb5b6fcbaa1dfa6ea08554f7004a8abe5db0ae4786c2cb563e21be24de3f0e78ce14c2d2f686e63a4c006d

data/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

data/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

data/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).

data/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'

data/lib/eventsimple/entity.rb

@@ -11,6 +11,8 @@ module Eventsimple
         autosave: false,
         validate: false
 
+      after_initialize :readonly!
+
       class_attribute :ignored_for_projection, default: []
 
       class_attribute :_filter_attributes
@@ -32,6 +34,15 @@ module Eventsimple
         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)

data/lib/eventsimple/event.rb

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

data/lib/eventsimple/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventsimple
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Zulfiqar Ali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement