akasha 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '09372b1685568c249f091ff1bbbf4915bb574b91'
-  data.tar.gz: 982ef7993d2087b2bd55f424228ba5bdf31d867a
+  metadata.gz: 4078cc01d0c132a3b675ed21de42246880643c49
+  data.tar.gz: 0562b5f9607dea81f47720c680d3f5517c5190e0
 SHA512:
-  metadata.gz: 59730ad9b8f01e86d5fdfd01945fea0586002972571595f03810d7af600f9d864a5d5c22fc1e7092a68067f6fd310c16f825980b8515d71f7933a05f2362dfc1
-  data.tar.gz: 1fb02d4091efe00a925af1ec4d15990c0cc0c61aaaf64a1c64de36a63dcc3eea3b73465d5e558880ad46393d90146dfb6a788d5e5544f7afcdf68bda67f38d78
+  metadata.gz: 114a107b63f0f25d9e21b5a00c8a4277885ca705ff7d324199a89e54004c41f410380608d7ba994e8d2f0e3dab220c8a09443c56ef36bc69c551f061d23b3366
+  data.tar.gz: 4ef66f8424b38a10ac6b8b4095e9a42f985babf00966d5e7d8928cc8fd588768cf1ee45baa516fe094a8b717ee560d44e5f5856028aa6af97eee806b88c3c1ca

data/.rubocop.yml

@@ -1,6 +1,16 @@
 Style/FrozenStringLiteralComment:
   Enabled: false
+Metrics/AbcSize:
+  Max: 17
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+    - akasha.gemspec
+Metrics/ClassLength:
+  Max: 110
 Metrics/LineLength:
   Max: 120
 Metrics/MethodLength:
   Max: 15
+Rails/Output:
+  Enabled: false

data/.travis.yml

@@ -1,6 +1,10 @@
 # Enables Travis to use their new container-based infrastructure
 sudo: false
 
+# Integration tests are using docker-compose
+services:
+  - docker
+
 # Build for Ruby
 language: ruby
 
@@ -15,35 +19,23 @@ before_install:
   - 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
+matrix:
+  include:
+    - rvm: 2.3.6
+    - rvm: 2.5.1
+    - env: INTEGRATION_TESTS=true
+
+# Define how to run your tests.
+script:
+  - |
+    # Run either integration tests or specs.
+    case "$INTEGRATION_TESTS" in
+      true) bin/integration-tests.sh ;;
+      *) bundle exec rspec --tag ~integration ;;
+    esac
+  # Check if conventions are being followed.
+  - bundle exec rake rubocop
 
 # Disable email notifications
-#notifications:
-#  disabled: true
-
-# notifications:
-#   webhooks:
-#     urls:
-#       - https://webhooks.gitter.im/e/c6dbb9323007dfcf81df
+notifications:
+ disabled: true

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Version 0.3.0
+
+* Asynchronous event listeners (`AsyncEventRouter`).
+* Simplified initialization of event- and command routers.
+* Remove dependency on the `http_event_store` gem.
+* `Event#metadata` is no longer OpenStruct.
+
 ## Version 0.2.0
 
 * Synchronous event listeners (see `examples/sinatra/app.rb`).

data/Dockerfile

@@ -0,0 +1,24 @@
+FROM ruby:2.5.1-alpine3.7
+RUN set -eux; \
+    apk update; \
+    apk add git openssl; \
+    apk add build-base libffi-dev
+
+ENV DOCKERIZE_VERSION v0.6.1
+RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
+    && tar -C /usr/local/bin -xzvf dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
+    && rm dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz
+
+COPY Gemfile /var/akasha/
+COPY Gemfile.lock /var/akasha/
+COPY akasha.gemspec /var/akasha/
+COPY lib/akasha/version.rb /var/akasha/lib/akasha/version.rb
+
+RUN set -eux; \
+    cd /var/akasha; \
+    bundle
+
+COPY . /var/akasha/
+WORKDIR /var/akasha/
+
+CMD dockerize -wait http://eventstore:2113 bundle exec rspec --tag integration

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Gem's dependencies in akasha.gemspec
 gemspec

data/Gemfile.lock

@@ -1,35 +1,46 @@
 PATH
   remote: .
   specs:
-    akasha (0.2.0)
-      http_event_store
+    akasha (0.3.0)
+      corefines (~> 1.11)
+      faraday (~> 0.15)
+      faraday_middleware
+      rack (~> 2.0)
+      retries (~> 0.0)
+      typhoeus (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.3.0)
     byebug (10.0.2)
     coderay (1.1.2)
+    corefines (1.11.0)
     diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
     faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
-    hashie (3.5.7)
-    http_event_store (0.2.2)
-      faraday
-      faraday_middleware
-      hashie
-      json
-    json (2.1.0)
+    ffi (1.9.25)
     method_source (0.9.0)
     multipart-post (2.0.0)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
+    rack (2.0.5)
+    rainbow (2.2.2)
+      rake
     rake (10.5.0)
+    retries (0.0.5)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -43,7 +54,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rspec-wait (0.0.9)
+      rspec (>= 3, < 4)
+    rubocop (0.50.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
     timecop (0.9.1)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -54,7 +78,9 @@ DEPENDENCIES
   pry-byebug
   rake (~> 10.0)
   rspec (~> 3.7)
-  timecop
+  rspec-wait (~> 0.0.9)
+  rubocop (~> 0.50)
+  timecop (~> 0.9)
 
 BUNDLED WITH
    1.16.2

data/README.md

@@ -20,74 +20,81 @@ 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.
+There is an example Sinatra app under `examples/sinatra` showing how to use the library in a web application.
+This library itself 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:, admin: false, **)
-    changeset.append(:user_signed_up, email: email, password: password, admin: admin)
-  end
-
-  def on_user_signed_up(email:, password:, admin:, **)
-    @email = email
-    @password = password
-    @admin = admin
-  end
-end
-
-
-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
-
-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
-```
-
-> Currently, only memory-based repository is supported.
-
-## Next steps
+## TODO
 
 - [x] Command routing (default and user-defined)
 - [x] Synchronous EventHandler
 - [x] HTTP Eventstore storage backend
-- [ ] Telemetry (Dogstatsd)
-- [ ] Event#id for better idempotence (validate this claim)
-- [ ] Namespacing for events and aggregates
+- [x] Event#id for better idempotence (validate this claim)
+- [x] Async EventHandlers (storing cursors in Eventstore, configurable durability guarantees)
+  - [x] Uniform intetrface for Client -- use Event.
+  - [x] Rewrite Client
+  - [x] Refactor Client code
+  - [x] Take care of created_at/updated_at (saved_at?)
+  - [x] Tests for HttpEventStore
+  - [x] Projections
+  - [x] Test for AsyncEventRouter using events not aggregate
+  - [x] BUG: Projection reorders events
+  - [x] Simplify AsyncEventRouter init
+  - [x] SyncEventRouter => EventRouter
+  - [x] Metadata not persisted
+- [x] Refactoring & simplification.
+  - [x] Hash-based event and command router
+  - [x] Do we need EventListener class? Yes.
+  - [x] Assymetry between data and metadata.
+  - [x] Faster shutdown.
+- [ ] Namespacing for events and aggregates and the projection
 - [ ] Version-based concurrency
-- [ ] Async EventHandlers (storing cursors in Eventstore, configurable durability guarantees)
+- [ ] Telemetry (Dogstatsd)
 - [ ] Socket-based Eventstore storage backend
 
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. See Running tests.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
+## Running tests
+
+Some tests require Eventstore to be running and available via `eventstore` host name. You can exclude these specs:
+
+```
+rspec --tag ~integration
+```
+
+The easiest way to run integration tests:
+
+```
+/bin/integration-tests.sh
+```
+
+This will use docker-compose to spin up containers containing the dependencies and tests themselves.
+
+Because it's pretty slow, you may want to spin up a docker container containing event store:
+
+```
+docker run -e EVENTSTORE_START_STANDARD_PROJECTIONS=true --name akasha-eventstore -it -p 2113:2113 -p 1113:1113 -d eventstore/eventstore
+```
+
+and use RSpec run just integration specs like so:
+
+```
+rspec --tag integration
+```
+
+or run all tests:
+
+```
+rspec
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/bilus/akasha.

data/Rakefile

@@ -1,6 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ['--rails', '--display-cop-names']
+end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/akasha.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Marcin Bilski']
   spec.email         = ['marcin@tooploox.com']
 
-  spec.summary       = %q{CQRS library for Ruby}
-  spec.description   = %q{A simple CQRS library for Ruby.}
-  spec.homepage      = "https://github.com/bilus/akasha"
+  spec.summary       = 'CQRS library for Ruby'
+  spec.description   = 'A simple CQRS library for Ruby.'
+  spec.homepage      = 'https://github.com/bilus/akasha'
   spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
@@ -23,11 +23,18 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'http_event_store'
+  spec.add_dependency 'faraday', '~> 0.15'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'typhoeus', '~> 1.3'
+  spec.add_dependency 'rack', '~> 2.0'
+  spec.add_dependency 'retries', '~> 0.0'
+  spec.add_dependency 'corefines', '~>1.11'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug'
   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'
+  spec.add_development_dependency 'rspec-wait', '~> 0.0.9'
+  spec.add_development_dependency 'rubocop', '~> 0.50'
+  spec.add_development_dependency 'timecop', '~> 0.9'
 end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "akasha"
+require 'bundler/setup'
+require 'akasha'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "akasha"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/integration-tests.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+# define some colors to use for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+NC='\033[0m'
+
+PROJECT=ci
+
+# kill and remove any running containers
+cleanup () {
+  docker-compose -p $PROJECT down
+}
+# catch unexpected failures, do cleanup and output an error message
+trap 'cleanup ; printf "${RED}Tests Failed For Unexpected Reasons${NC}\n"'\
+  HUP INT QUIT PIPE TERM
+cd docker
+echo "Starting tests"
+# build and run the composed services
+docker-compose -p $PROJECT up -d --build
+if [ $? -ne 0 ] ; then
+  printf "${RED}Docker Compose Failed${NC}\n"
+  exit -1
+fi
+echo "Waiting for tests to finish"
+# wait for the test service to complete and grab the exit code
+TEST_EXIT_CODE=`docker wait ${PROJECT}_tests_1`
+echo "Listing docker logs"
+# output the logs for the test (for clarity)
+docker logs ${PROJECT}_tests_1
+# inspect the output of the test and display respective message
+if [ -z ${TEST_EXIT_CODE+x} ] || [ "$TEST_EXIT_CODE" -ne 0 ] ; then
+  printf "${RED}Tests Failed${NC} - Exit Code: $TEST_EXIT_CODE\n"
+else
+  printf "${GREEN}Tests Passed${NC}\n"
+fi
+# call the cleanup fuction
+cleanup
+# exit the script with the same code as the test service code
+exit $TEST_EXIT_CODE