rails_simple_event_sourcing 1.0.7 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9415504de52817629c90a90ad0fff708ad8f829c768ed88485b8eae53f241c18
-  data.tar.gz: 2344f7a06e5c3b9dca5d0b6c98b1526ad73088c59cde9a0c64f2b5cb6a227ec6
+  metadata.gz: 2cdc3924ccf5cb03de4c576e06e36516187ab5743fdeacb7c4b543e1733af6ed
+  data.tar.gz: e8a6bcce2a7b918a9a55ffd37dcf11e31c4692c53678ae083a59213fdd39e29e
 SHA512:
-  metadata.gz: 3f2ec958c3dab2f9b398ed1bd0bfddec38fb13c720762ab57cc45c59091d9116f07af133601a19dae083ba5c40b32177cbfaa4809cb6af1a37cf569ed941693d
-  data.tar.gz: 32b8d673ca804d1ef03e5e55a561011fd052d70789afc078b9f8c7becff373d310bb2d24da411e6fc8a2fa869720a3aad487fbc4a93c5290cc2ce9a4f4d81c4d
+  metadata.gz: 2825950884885d9366e2586ddada26b272fc9551ba92caefe9be08c78569ad5df7243bef7b6fcf51f3e6529fc93dba1b455aacb7e7ed61b94ce9c40bd9ac0868
+  data.tar.gz: b8b2ec4ceca8ace0ec9f51185ac373008c73a11c0aa536d650d844464822c2e4bf6aa919d797aff36807ceca23f366ebbadaf94dcd78230b0ace007d0efd33c6

data/README.md

@@ -173,15 +173,45 @@ Handlers can be discovered in two ways:
 2. **Convention-based** - Using naming convention mapping (can be disabled via configuration)
 
 **Result Object:**
-The `Result` struct has three fields:
+The `Result` class has three fields:
 - `success?` - Boolean indicating if the operation succeeded
 - `data` - Data to return (usually the aggregate/model instance)
 - `errors` - Array or hash of error messages when `success?` is false
 
-**Helper Methods:**
-The base class provides convenience methods:
-- `success_result(data:)` - Creates a successful result
-- `failure_result(errors:)` - Creates a failed result
+Use the factory methods to build results:
+
+```ruby
+# Successful result
+RailsSimpleEventSourcing::Result.success(data: customer)
+
+# Failed result
+RailsSimpleEventSourcing::Result.failure(errors: { email: ["already taken"] })
+```
+
+It supports a chainable API for use in controllers:
+- `on_success { |data| }` - Executes the block (yielding `data`) if the result is successful
+- `on_failure { |errors| }` - Executes the block (yielding `errors`) if the result failed
+
+Both methods return `self`, so they can be chained. The predicate `success?` remains available for use in conditionals and tests.
+
+```ruby
+result = RailsSimpleEventSourcing::Result.success(data: customer)
+
+# Chainable (preferred in controllers)
+result
+  .on_success { |data| render json: data }
+  .on_failure { |errors| render json: { errors: }, status: :unprocessable_entity }
+
+# Predicate (preferred in tests)
+result.success? # => true
+result.data     # => #<Customer ...>
+result.errors   # => nil
+```
+
+**Helper Methods in Handlers:**
+Inside a command handler, `success` and `failure` are delegated to `RailsSimpleEventSourcing::Result`:
+- `success(data:)` - delegates to `RailsSimpleEventSourcing::Result.success`
+- `failure(errors:)` - delegates to `RailsSimpleEventSourcing::Result.failure`
 
 **Example - Basic Handler:**
 
@@ -198,11 +228,7 @@ class Customer
           updated_at: Time.zone.now
         )
 
-        # Using helper method (recommended)
-        success_result(data: event.aggregate)
-
-        # Or create Result directly
-        # RailsSimpleEventSourcing::Result.new(success?: true, data: event.aggregate)
+        success(data: event.aggregate)
       end
     end
   end
@@ -224,11 +250,11 @@ class Customer
           updated_at: Time.zone.now
         )
 
-        success_result(data: event.aggregate)
+        success(data: event.aggregate)
       rescue ActiveRecord::RecordNotUnique
-        failure_result(errors: ["Email has already been taken"])
+        failure(errors: ["Email has already been taken"])
       rescue StandardError => e
-        failure_result(errors: ["An error occurred: #{e.message}"])
+        failure(errors: ["An error occurred: #{e.message}"])
       end
     end
   end
@@ -358,13 +384,10 @@ class CustomersController < ApplicationController
       last_name: params[:last_name],
       email: params[:email]
     )
-    handler = RailsSimpleEventSourcing::CommandHandler.new(cmd).call
 
-    if handler.success?
-      render json: handler.data
-    else
-      render json: { errors: handler.errors }, status: :unprocessable_entity
-    end
+    RailsSimpleEventSourcing::CommandHandler.new(cmd).call
+      .on_success { |data| render json: data }
+      .on_failure { |errors| render json: { errors: }, status: :unprocessable_entity }
   end
 end
 ```
@@ -382,13 +405,10 @@ class CustomersController < ApplicationController
       last_name: params[:last_name],
       email: params[:email]
     )
-    handler = RailsSimpleEventSourcing::CommandHandler.new(cmd).call
 
-    if handler.success?
-      render json: handler.data
-    else
-      render json: { errors: handler.errors }, status: :unprocessable_entity
-    end
+    RailsSimpleEventSourcing::CommandHandler.new(cmd).call
+      .on_success { |data| render json: data }
+      .on_failure { |errors| render json: { errors: }, status: :unprocessable_entity }
   end
 end
 ```
@@ -399,13 +419,10 @@ end
 class CustomersController < ApplicationController
   def destroy
     cmd = Customer::Commands::Delete.new(aggregate_id: params[:id])
-    handler = RailsSimpleEventSourcing::CommandHandler.new(cmd).call
 
-    if handler.success?
-      head :no_content
-    else
-      render json: { errors: handler.errors }, status: :unprocessable_entity
-    end
+    RailsSimpleEventSourcing::CommandHandler.new(cmd).call
+      .on_success { head :no_content }
+      .on_failure { |errors| render json: { errors: }, status: :unprocessable_entity }
   end
 end
 ```
@@ -548,11 +565,11 @@ Mount the engine in your `config/routes.rb`:
 
 ```ruby
 Rails.application.routes.draw do
-  mount RailsSimpleEventSourcing::Engine, at: "/event-store"
+  mount RailsSimpleEventSourcing::Engine, at: "/events"
 end
 ```
 
-Then navigate to `/event-store` in your browser to access the viewer.
+Then navigate to `/events` in your browser to access the viewer.
 
 **Password Protection:**
 
@@ -564,11 +581,11 @@ In production you will likely want to restrict access to the events viewer.
 Rails.application.routes.draw do
   mount Rack::Auth::Basic.new(
     RailsSimpleEventSourcing::Engine,
-    "Event Store"
+    "Events"
   ) { |username, password|
     ActiveSupport::SecurityUtils.secure_compare(username, "admin") &
     ActiveSupport::SecurityUtils.secure_compare(password, Rails.application.credentials.event_sourcing_password || "secret")
-  }, at: "/event-store"
+  }, at: "/events"
 end
 ```
 
@@ -577,7 +594,7 @@ end
 ```ruby
 Rails.application.routes.draw do
   authenticate :user, ->(user) { user.admin? } do
-    mount RailsSimpleEventSourcing::Engine, at: "/event-store"
+    mount RailsSimpleEventSourcing::Engine, at: "/events"
   end
 end
 ```
@@ -639,10 +656,6 @@ class Customer < ApplicationRecord
 
   scope :active, -> { where(deleted_at: nil) }
   scope :deleted, -> { where.not(deleted_at: nil) }
-
-  def soft_delete
-    update(deleted_at: Time.current)
-  end
 end
 
 # Event

data/app/models/concerns/rails_simple_event_sourcing/read_only.rb

@@ -13,6 +13,10 @@ module RailsSimpleEventSourcing
         @write_access_enabled = true
       end
 
+      def disable_write_access!
+        @write_access_enabled = false
+      end
+
       private
 
       def write_access_enabled

data/app/models/rails_simple_event_sourcing/event.rb

@@ -14,10 +14,13 @@ module RailsSimpleEventSourcing
 
     before_validation :setup_for_create, on: :create
     before_save :persist_aggregate, if: :aggregate_defined?
+    after_create :disable_write_access!
 
     def apply(aggregate)
       payload.each do |key, value|
-        aggregate.send("#{key}=", value) if aggregate.respond_to?("#{key}=")
+        raise "Unknown attribute '#{key}' on #{aggregate.class}" unless aggregate.respond_to?("#{key}=")
+
+        aggregate.send("#{key}=", value)
       end
     end
 
@@ -67,6 +70,7 @@ module RailsSimpleEventSourcing
 
       aggregate_repository.save!(@aggregate)
       self.aggregate_id = @aggregate.id
+      @aggregate.disable_write_access!
     end
 
     def aggregate_repository

data/config/routes.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 RailsSimpleEventSourcing::Engine.routes.draw do
-  resources :events, only: [:index, :show]
-  root to: "events#index"
+  root to: "events#index", as: :events
+  get ":id", to: "events#show", as: :event
 end

data/lib/rails_simple_event_sourcing/command_handler.rb

@@ -9,7 +9,7 @@ module RailsSimpleEventSourcing
     end
 
     def call
-      return Result.new(success?: false, errors: @command.errors) unless @command.valid?
+      return Result.failure(errors: @command.errors) unless @command.valid?
 
       initialize_command_handler.call
     end

data/lib/rails_simple_event_sourcing/command_handlers/base.rb

@@ -3,20 +3,14 @@
 module RailsSimpleEventSourcing
   module CommandHandlers
     class Base
+      delegate :success, :failure, to: 'RailsSimpleEventSourcing::Result'
+
       def initialize(command:)
         @command = command
       end
 
       def call
-        raise NoMethodError, "You must implement #{self.class}#call"
-      end
-
-      def success_result(data: nil)
-        RailsSimpleEventSourcing::Result.new(success?: true, data:)
-      end
-
-      def failure_result(errors:)
-        RailsSimpleEventSourcing::Result.new(success?: false, errors:)
+        raise NotImplementedError, "You must implement #{self.class}#call"
       end
     end
   end

data/lib/rails_simple_event_sourcing/commands/base.rb

@@ -4,7 +4,6 @@ module RailsSimpleEventSourcing
   module Commands
     class Base
       include ActiveModel::Model
-      include ActiveModel::Validations
 
       attr_accessor :aggregate_id
     end

data/lib/rails_simple_event_sourcing/engine.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'concurrent'
 require_relative 'aggregate_repository'
 require_relative 'command_handler'
 require_relative 'command_handlers/base'

data/lib/rails_simple_event_sourcing/result.rb

@@ -1,5 +1,42 @@
 # frozen_string_literal: true
 
 module RailsSimpleEventSourcing
-  Result = Struct.new(:success?, :data, :errors, keyword_init: true)
+  class Result
+    attr_reader :data, :errors
+
+    def self.success(data: nil)
+      new(success: true, data:)
+    end
+
+    def self.failure(errors:)
+      new(success: false, errors:)
+    end
+
+    def initialize(success:, data: nil, errors: nil)
+      raise ArgumentError, 'Successful result cannot have errors' if success && errors
+      raise ArgumentError, 'Failed result cannot have data' if !success && data
+
+      @success = success
+      @data    = data
+      @errors  = errors
+    end
+
+    def success?
+      @success
+    end
+
+    def on_success(&block)
+      raise ArgumentError, 'Block required' unless block
+
+      block.call(data) if success?
+      self
+    end
+
+    def on_failure(&block)
+      raise ArgumentError, 'Block required' unless block
+
+      block.call(errors) unless success?
+      self
+    end
+  end
 end

data/lib/rails_simple_event_sourcing/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_simple_event_sourcing
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.9
 platform: ruby
 authors:
 - Damian Baćkowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-22 00:00:00.000000000 Z
+date: 2026-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.1.2
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement