akasha 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01eaf484143fe6572ed3efe8338c2b2fb1251bf2
-  data.tar.gz: 99b1cfb52b4cb781dd83b2c711d22cbb1ff27ace
+  metadata.gz: 1294447dab3ae4202502a232dcc069d06dcdbf5d
+  data.tar.gz: 296cfc35578c3f15a90d55f0f0ed1db018458541
 SHA512:
-  metadata.gz: f67f3ffbe4d1e75c4c514cff8770f8d8aa95948bafc8241bd1161d27e660765d2de0036d6578e7be60a3cc05f8bd1899400ad24b4461cc85d2b5fd36095ec3a0
-  data.tar.gz: 447548998189e251c818d4ab8dfb88b71b85e31aa5e70934d22fa6498b8703ba269ca331d71dde6c0f2936330b231c23dbfaf341b0533a78dabec0b98970e898
+  metadata.gz: 0b177423fce21ab067cee6c37f0d50e1d132056611791af3af17c56b2b8a2ba6ea20d76a11462e99459814b1ce24259ea86d01bc794818110da1ea49283fcbbc
+  data.tar.gz: 3cbe93b9aeafeca8b3541d01feaacfb6bdd0395bf3ed92d9be73a5ee7df3dfdb593deb8ad55e9d9647748f51a069ae881c9fd970aa473fc73f5087f63d012c3e

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,49 @@
+# Enables Travis to use their new container-based infrastructure
+sudo: false
+
+# Build for Ruby
+language: ruby
+
+# Enables caching for bundler
+cache: bundler
+
+# Passes arguments to bundle install (http://gembundler.com/man/bundle-install.1.html)
+# bundler_args:
+
+before_install:
+  - gem update --system
+  - gem update bundler
+
+# Specify which ruby versions you wish to run your tests on, each version will be used
+rvm:
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+
+# Define how to run your tests (defaults to `bundle exec rake` or `rake` depending on whether you have a `Gemfile`)
+script: "bundle exec rake"
+
+# Define tasks to be completed before and after tests run . Will allow folding of content on frontend
+#before_script:
+#  - command_1
+#  - command_2
+#
+#after_script:
+#  - command_1
+#  - command_2
+
+# Specify the recipients for email notification
+#notifications:
+#  recipients:
+#    - email-address-1
+#    - email-address-2
+
+# Disable email notifications
+#notifications:
+#  disabled: true
+
+# notifications:
+#   webhooks:
+#     urls:
+#       - https://webhooks.gitter.im/e/c6dbb9323007dfcf81df

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+
+## Version 0.1.0
+
+* Cleaner syntax for adding events to changesets: `changeset.append(:it_happened, foo: 'bar')`.
+* Support for command routing (`Akasha::CommandRouter`).
+
+
+## Version 0.0.1
+
+Initial release, basic functionality.

data/Gemfile.lock

@@ -1,12 +1,21 @@
 PATH
   remote: .
   specs:
-    akasha (0.0.1)
+    akasha (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
     diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -29,6 +38,7 @@ PLATFORMS
 DEPENDENCIES
   akasha!
   bundler (~> 1.16)
+  pry-byebug
   rake (~> 10.0)
   rspec (~> 3.7)
   timecop

data/README.md

@@ -20,31 +20,51 @@ Or install it yourself as:
 
 ## Usage
 
+The code below uses Sinatra to demonstrate how to use the library in a web application.
+This library makes no assumptions about any web framework, you can use it in any way you see fit.
+
 ```ruby
 require 'akasha'
-
+require 'sinatra'
 
 class User < Akasha::Aggregate
-  def sign_up(email, password)
-    changeset << Akasha::Event.new(:user_signed_up, email: email, password: password)
+  def sign_up(email:, password:, admin: false, **)
+    changeset << Akasha::Event.new(:user_signed_up, email: email, password: password, admin: admin)
   end
 
-  def on_user_signed_up(email:, password:, **_)
+  def on_user_signed_up(email:, password:, admin:, **)
     @email = email
     @password = password
+    @admin = admin
   end
 end
 
-def initialize
-   repository = Akasha::Repository.new(Akasha::Storage::MemoryEventStore.new)
-   Akasha::Aggregate.connect!(repository)
+
+before do
+  @router = Akasha::CommandRouter.new
+
+  # Aggregates will load from and save to in-memory storage.
+  repository = Akasha::Repository.new(Akasha::Storage::MemoryEventStore.new)
+  Akasha::Aggregate.connect!(repository)
+
+  # This is how you link commands to aggregates.
+  @router.register_default_route(:sign_up, User)
+
+  # Nearly identital to the default handling above but we're setting the admin
+  # flag to demo custom command handling.
+  @router.register_route(:sign_up_admin) do |aggregate_id, **data|
+    user = User.find_or_create(aggregate_id)
+    user.sign_up(email: data[:email], password: data[:password], admin: true)
+    user.save!
+  end
 end
 
-def handle_sign_up_command(params)
-  user = User.find_or_create(params[:id])
-  user.email = params[:email]
-  user.password = params[:password]
-  user.save!
+post '/users/:user_id' do # With CQRS client pass unique aggregate ids.
+  @router.route!(:sign_up,
+                 params[:user_id],
+                 email: params[:email],
+                 password: params[:password])
+  'OK'
 end
 ```
 
@@ -52,7 +72,7 @@ end
 
 ## Next steps
 
-- [ ] Command routing (default and user-defined)
+- [x] Command routing (default and user-defined)
 - [ ] EventHandler (relying only on Eventstore)
 - [ ] HTTP Eventstore storage backend
 - [ ] Namespacing for events and aggregates

data/akasha.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.7'
   spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'pry-byebug'
 end

data/lib/akasha.rb

@@ -1,4 +1,5 @@
 require 'akasha/event'
 require 'akasha/aggregate'
+require 'akasha/command_router'
 require 'akasha/repository'
 require 'akasha/storage/memory_event_store'

data/lib/akasha/aggregate.rb

@@ -8,7 +8,7 @@ module Akasha
   #
   # class User < Akasha::Aggregate
   #   def sign_up(email, password)
-  #     changeset << Akasha::Event.new(:user_signed_up, email: email, password: password)
+  #     changeset.append(:user_signed_up, email: email, password: password)
   #   end
   #
   #   def on_user_signed_up(email:, password:, **_)

data/lib/akasha/aggregate/syntax_helpers.rb

@@ -38,7 +38,9 @@ module Akasha
     module InstanceMethods
       # Saves the aggregate.
       def save!
+        return if changeset.empty?
         self.class.repository.save_aggregate(self)
+        changeset.clear!
       end
     end
   end

data/lib/akasha/changeset.rb

@@ -10,8 +10,18 @@ module Akasha
     end
 
     # Adds an event to the changeset.
-    def <<(event)
-      @events << event
+    def append(event_name, **data)
+      @events << Akasha::Event.new(event_name, **data)
+    end
+
+    # Returns true if no changes recorded.
+    def empty?
+      @events.empty?
+    end
+
+    # Clears the changeset.
+    def clear!
+      @events = []
     end
   end
 end

data/lib/akasha/command_router.rb

@@ -0,0 +1,36 @@
+require_relative 'command_router/default_handler'
+
+module Akasha
+  # Routes commands to their handlers.
+  class CommandRouter
+    # Raised when no corresponding target can be found for a command.
+    NotFoundError = Class.new(RuntimeError)
+
+    def initialize
+      @routes = {}
+    end
+
+    # Registers a custom route, specifying either a lambda or a block.
+    # If both lambda and block are specified, lambda takes precedence.
+    def register_route(command, lambda = nil, &block)
+      callable = lambda || block
+      @routes[command] = callable
+    end
+
+    # Registers a default route, mapping a command to an aggregate class.
+    # As a result, when `#route!` is called for that command, the aggregate
+    # will be loaded from repository, the command will be sent to the object
+    # to invoke the object's method, and finally the aggregate will be saved.
+    def register_default_route(command, aggregate_class)
+      register_route(command, DefaultHandler.new(aggregate_class))
+    end
+
+    # Routes a command to the registered target.
+    # Raises NotFoundError if no corresponding target can be found.
+    def route!(command, aggregate_id, **data)
+      handler = @routes[command]
+      return handler.call(command, aggregate_id, **data) if handler
+      raise NotFoundError, "Target for command #{command.inspect} not found"
+    end
+  end
+end

data/lib/akasha/command_router/default_handler.rb

@@ -0,0 +1,19 @@
+module Akasha
+  class CommandRouter
+    # Default command handler.
+    # Works by loading aggregate from the repo by id,
+    # invoking its method `command`, passing all data,
+    # and saving changes to the aggregate in the end.
+    class DefaultHandler
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def call(command, aggregate_id, **data)
+        aggregate = @klass.find_or_create(aggregate_id)
+        aggregate.public_send(command, **data)
+        aggregate.save!
+      end
+    end
+  end
+end

data/lib/akasha/version.rb

@@ -1,3 +1,3 @@
 module Akasha
-  VERSION='0.0.1'
+  VERSION='0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akasha
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Marcin Bilski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-03 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
 description: A simple CQRS library for Ruby.
 email:
 - marcin@tooploox.com
@@ -74,8 +88,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -88,6 +105,8 @@ files:
 - lib/akasha/aggregate.rb
 - lib/akasha/aggregate/syntax_helpers.rb
 - lib/akasha/changeset.rb
+- lib/akasha/command_router.rb
+- lib/akasha/command_router/default_handler.rb
 - lib/akasha/event.rb
 - lib/akasha/repository.rb
 - lib/akasha/storage/memory_event_store.rb