event_sourcery-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c44446ad62fb825fb92ea6d5b2172a710b6a903de6c3c319559bdd570f44294
-  data.tar.gz: 59f59a84434b1e5a56b28a1b5d1013003c01038083fafa490ef882f78b433255
+  metadata.gz: f691f46a44b4d5909efb60f1d87c2d463382c75dfed89877a26d1771162a7458
+  data.tar.gz: 1fca779982165b17b3aad6be86bff5e49123f5c9ec1e3d41bb4345e28bb95ded
 SHA512:
-  metadata.gz: ae8a0001888778819f8b9636644d6d1184e47fa8953901d99beb59f2d86c935e4114ad56e7b4055f2df93ae3e8a6c7ae949129be5149f7c631104480bd82e321
-  data.tar.gz: 9cb58b78bafec58bb05380f5723e6d270022fab2806b1f91b2667f4eba53733be44aa767ea78411e639ce9a201e2b9eabd9f153f615fd7f65e8846bc22166c50
+  metadata.gz: 5fa9870de94fb1d99733c1b7bb5c69b7a566454eb28279328ea7cc4eb7d9c326682008eb55ec843aff75d4075880be6ecb6de86e23554e74e7022468bac419c8
+  data.tar.gz: 43c35bc1f3efda9b5be3ea4aa1f5ad944f1c09aa4a0dfc383e5c485698332f9ee0f641bc9f8cbe96e8e743f292ae5dce6cbf375901c72b272e6951f4e3373a3a

data/README.md

@@ -2,7 +2,65 @@
 Short description and motivation.
 
 ## Usage
-How to use my plugin.
+
+### Commands
+
+EventSourcery::Rails adds an optional base class for commands to enforce
+instantiating commands with an `aggregate_id` and required parameters as keyword
+arguments. Defined attributes are available with an `attr_reader`.
+
+```ruby
+class AddUser < EventSourcery::Rails::Command
+  attributes :name, :email
+end
+
+AddUser.new # => raises ArgumentError.new("missing keywords: aggregate_id, name, email")
+
+command = AddUser.new(aggregate_id: 'aggregate-id',
+                      name: 'name',
+                      email: 'email')
+command.aggregate_id # => "aggregate-id"
+command.name # => "name"
+command.email # => "email"
+```
+
+### Command Handlers
+
+You can also optionally include `EventSourcery::Rails::CommandHandler` to use
+use a callback DSL for binding commands. This DSL allows your application code
+to use all command handlers with `#call`.
+
+**Todo**
+
+- [ ] Consider switching to a base class with common initializer and
+    `with_aggregate`
+- [ ] Introduce API for invoking all known command handlers with an array of
+    commands.
+
+```ruby
+class UserCommandHandler
+  include EventSourcery::Rails::CommandHandler
+
+  attr_reader :repository
+
+  def initialize(repository: EventSourceryRails.repository)
+    @repository = repository
+  end
+
+  on AddUser do |command|
+    aggregate = repository.load(UserAggregate, aggregate_id)
+    aggregate.add(name: command.name,
+                  email: command.email)
+    repository.save(aggregate)
+  end
+
+  on UpdateUserEmail do |command|
+    aggregate = repository.load(UserAggregate, aggregate_id)
+    aggregate.update_email(email: command.email)
+    repository.save(aggregate)
+  end
+end
+```
 
 ## Installation
 Add the following line to your Gemfile.
@@ -21,14 +79,14 @@ Next, your need to run the generator:
 $ rails generate event_sourcery_rails:install
 ```
 
-At this point you will have an initializer to configure EventSourcery and a
-rake file with the following tasks.
+At this point you will have an initializer to configure EventSourcery and the
+following Rake tasks.
 
-```
-rails event_sourcery:db:migrate # create the event sourcery schema
-rails event_sourcery:processors:setup # create projector schemas
-rails event_sourcery:processors:reset # drop and recreate projector schemas and data
-rails event_sourcery:processors:run # start event stream processors
+```bash
+$ rails event_sourcery:db:migrate # create the event sourcery schema
+$ rails event_sourcery:processors:setup # create projector schemas
+$ rails event_sourcery:processors:reset # drop and recreate projector schemas and data
+$ rails event_sourcery:processors:run # start event stream processors
 ```
 
 Typically you'll have the following in your Procfile.

data/lib/event_sourcery/rails/command.rb

@@ -0,0 +1,30 @@
+module EventSourcery
+  module Rails
+    class Command
+      attr_reader :aggregate_id
+
+      def initialize(aggregate_id:)
+        @aggregate_id = aggregate_id
+      end
+
+      def self.attributes(*attributes)
+        attr_reader *attributes
+
+        method_arguments = attributes.map { |arg| "#{arg}:" }.join(', ')
+        method_assignments = attributes.map { |arg| "@#{arg} = #{arg}" }.join(';')
+        method_attrs_to_hash = attributes.map { |arg| "#{arg}: #{arg}" }.join(',')
+
+        class_eval <<~CODE
+          def initialize(aggregate_id:, #{method_arguments})
+            @aggregate_id = aggregate_id
+            #{method_assignments}
+          end
+
+          def to_hash
+            {#{method_attrs_to_hash}}
+          end
+        CODE
+      end
+    end
+  end
+end

data/lib/event_sourcery/rails/command_handler.rb

@@ -0,0 +1,27 @@
+module EventSourcery
+  module Rails
+    module CommandHandler
+
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      def call(command)
+        return unless self.class.command_events.has_key?(command.class)
+        instance_exec command, &self.class.command_events[command.class]
+      end
+
+      private
+
+      module ClassMethods
+        def command_events
+          @command_events ||= {}
+        end
+
+        def on(command, &block)
+          self.command_events[command] = block
+        end
+      end
+    end
+  end
+end

data/lib/event_sourcery/rails/version.rb

@@ -1,5 +1,5 @@
 module EventSourcery
   module Rails
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/event_sourcery/rails.rb

@@ -2,6 +2,7 @@ require "event_sourcery/rails/railtie"
 
 module EventSourcery
   module Rails
-    # Your code goes here...
+    autoload :Command, "event_sourcery/rails/command"
+    autoload :CommandHandler, "event_sourcery/rails/command_handler"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_sourcery-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Baylor Rae'
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-09 00:00:00.000000000 Z
+date: 2019-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +78,8 @@ files:
 - README.md
 - Rakefile
 - lib/event_sourcery/rails.rb
+- lib/event_sourcery/rails/command.rb
+- lib/event_sourcery/rails/command_handler.rb
 - lib/event_sourcery/rails/generators/install_generator.rb
 - lib/event_sourcery/rails/generators/templates/event_sourcery.rake
 - lib/event_sourcery/rails/generators/templates/initializer.rb