rails_simple_event_sourcing 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 686785bc4c8f52ae548b2880cb664b57d5a048925cda0f4cfe0d2962acbfdb3e
-  data.tar.gz: 9555f13015e4aaacdfe8ce8b4866ea8d5f6e1a19d0d4f0766b1d4b9c5b36a64e
+  metadata.gz: be05ef0dea303db4860a86e10e0ed0d62b5e03de00e07ee80ad374f95e20cc1e
+  data.tar.gz: 3eaaf851f72b6a84358e7908a55c2ddc437217467786fac57d658edcc4c70b30
 SHA512:
-  metadata.gz: ba9de2c72e6ff9c242da76379ae476aa1139bba37b58eb60dced8bd6c37de83dc3335e9d2f031a6ccf3930e7211f1bafc96c65647550a020e7dcd71e262207d2
-  data.tar.gz: 691d056df008df794ae8b4833295185eb0ee6f568b2f28b19d2ddbea79bec4069b64143a1c4723c685f49030be97c1e0f964d53ae451551efd1fc6813f4f7c39
+  metadata.gz: e19d692f980963be17d5adb2a55678a57be33fb65b04046215d44a1bd48181abfebcc2f3ea8d8cfaf4946570bcf8fb25b0abbc48e28fe7b6a85d253f4b51ca71
+  data.tar.gz: 65ad82bb88d8feae84ea47514debdd95532144830e07d65b36c4482f07ad095de5d374e2e6fb77dcace25984a885b8cc63b79fc729a3854f041b95129e4b923b

data/README.md

@@ -213,16 +213,47 @@ Events represent **facts** - things that have already happened in your system. T
 - Store immutable data about state changes
 - Use past tense naming (e.g., `CustomerCreated`, not `CreateCustomer`)
 - Define which aggregate (model) they apply to
-- Specify how to apply themselves to the aggregate
 - Are stored permanently in the event log
 
 **Key Concepts:**
 - `aggregate_class` - The model this event applies to (optional - some events may not modify models)
 - `event_attributes` - Fields stored in the event payload
-- `apply(aggregate)` - Method that applies the event to an aggregate instance
+- `apply(aggregate)` - **Optional** method that applies the event to an aggregate instance
 - `aggregate_id` - Links the event to a specific aggregate instance
 
-**Example - Create Event:**
+**Example - Basic Event (Automatic Application):**
+
+```ruby
+class Customer
+  module Events
+    class CustomerCreated < RailsSimpleEventSourcing::Event
+      aggregate_class Customer
+      event_attributes :first_name, :last_name, :email, :created_at, :updated_at
+    end
+  end
+end
+```
+
+**Automatic Attribute Application:**
+
+By default, all attributes declared in `event_attributes` will be **automatically applied** to the aggregate. You don't need to implement the `apply` method unless you have custom logic requirements.
+
+The default implementation sets each event attribute on the aggregate:
+```ruby
+# This happens automatically
+aggregate.first_name = first_name
+aggregate.last_name = last_name
+aggregate.email = email
+# ... and so on for all event_attributes
+```
+
+**Example - Custom Apply Method (When Needed):**
+
+You may still need to implement a custom `apply` method in certain cases:
+- Setting computed or derived values
+- Complex business logic during application
+- Handling nested objects or special data transformations
+- Setting the aggregate ID explicitly (though this is usually handled automatically)
 
 ```ruby
 class Customer
@@ -232,12 +263,13 @@ class Customer
       event_attributes :first_name, :last_name, :email, :created_at, :updated_at
 
       def apply(aggregate)
+        # Custom logic example
         aggregate.id = aggregate_id
-        aggregate.first_name = first_name
-        aggregate.last_name = last_name
-        aggregate.email = email
-        aggregate.created_at = created_at
-        aggregate.updated_at = updated_at
+        aggregate.full_name = "#{first_name} #{last_name}"  # Computed value
+        aggregate.email_normalized = email.downcase.strip   # Transformation
+
+        # You can still call super to apply remaining attributes automatically
+        super
       end
     end
   end
@@ -246,8 +278,8 @@ end
 
 **Understanding the Event Structure:**
 - `aggregate_class Customer` - Specifies which model this event modifies
-- `event_attributes` - Defines what data gets stored in the event's JSON payload
-- `apply(aggregate)` - Receives an aggregate instance and applies the event's changes to it
+- `event_attributes` - Defines what data gets stored in the event's JSON payload and what will be automatically applied
+- `apply(aggregate)` - Optional method; only implement if you need custom logic beyond automatic attribute assignment
 - `aggregate_id` - Auto-generated for creates, must be provided for updates/deletes
 
 **Note on aggregate_class:**
@@ -487,9 +519,7 @@ class Customer::Events::CustomerDeleted < RailsSimpleEventSourcing::Event
   aggregate_class Customer
   event_attributes :deleted_at
 
-  def apply(aggregate)
-    aggregate.deleted_at = deleted_at
-  end
+  # No need to implement apply - deleted_at will be automatically set on the aggregate
 end
 ```
 

data/app/models/rails_simple_event_sourcing/event.rb

@@ -10,14 +10,21 @@ module RailsSimpleEventSourcing
     belongs_to :eventable, polymorphic: true, optional: true
     alias aggregate eventable
 
+    # Validations
+    validates :version, presence: true, numericality: { only_integer: true, greater_than: 0 }
+    validates :version, uniqueness: { scope: :aggregate_id }, if: -> { aggregate_id.present? }
+
     # Callbacks for automatic aggregate lifecycle
     before_validation :setup_event_fields, on: :create
+    before_validation :set_version
     before_validation :apply_event_to_aggregate, on: :create, if: :aggregate_defined?
     before_save :persist_aggregate, if: :aggregate_defined?
 
-    # Must be implemented by subclasses
-    def apply(_aggregate)
-      raise NotImplementedError, "#{self.class}#apply must be implemented"
+    def apply(aggregate)
+      payload.each do |key, value|
+        aggregate.send("#{key}=", value) if aggregate.respond_to?("#{key}=")
+      end
+      aggregate
     end
 
     private
@@ -28,6 +35,17 @@ module RailsSimpleEventSourcing
       self.metadata = CurrentRequest.metadata&.compact&.presence
     end
 
+    def set_version
+      self.version ||= calculate_next_version
+    end
+
+    def calculate_next_version
+      return 1 unless aggregate_id
+
+      max_version = Event.where(aggregate_id:).maximum(:version) || 0
+      max_version + 1
+    end
+
     def apply_event_to_aggregate
       @aggregate_for_persistence = aggregate_repository.find_or_build(aggregate_id)
       self.eventable = @aggregate_for_persistence

data/db/migrate/20231231133250_create_rails_simple_event_sourcing_events.rb

@@ -7,6 +7,7 @@ class CreateRailsSimpleEventSourcingEvents < ActiveRecord::Migration[7.1]
       t.string :type, null: false
       t.string :event_type, null: false
       t.string :aggregate_id
+      t.integer :version, null: false
       t.jsonb :payload
       t.jsonb :metadata
 
@@ -15,6 +16,7 @@ class CreateRailsSimpleEventSourcingEvents < ActiveRecord::Migration[7.1]
       t.index :type
       t.index :event_type
       t.index :aggregate_id
+      t.index %i[aggregate_id version], unique: true, name: 'index_events_on_aggregate_id_and_version'
       t.index :payload, using: :gin
       t.index :metadata, using: :gin
     end

data/lib/rails_simple_event_sourcing/event_player.rb

@@ -14,7 +14,7 @@ module RailsSimpleEventSourcing
     private
 
     def load_event_stream
-      @aggregate.events.order(created_at: :asc)
+      @aggregate.events.order(version: :asc)
     end
 
     def apply_events(events)

data/lib/rails_simple_event_sourcing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsSimpleEventSourcing
-  VERSION = '1.0.1'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_simple_event_sourcing
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Damian Baćkowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-11 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg