nexus_cqrs 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4dd646c794131960d2d27fb221171e28291c2f09b49e054143d7e95f535b507
-  data.tar.gz: b59b9059f4c2c040ea7df8a6432fa256a925750aa725583567046641faa1d7bf
+  metadata.gz: ba82d98a3e3c930a35f6d06960be706925bf96db44766686fb2db3460649a792
+  data.tar.gz: 96ecd8dd6f98fb2637cc740d45a52a7c5f488e1f058fb7ff32215d4a7e050a57
 SHA512:
-  metadata.gz: 856916ff055be3508b09832ff4512bb483089561e0439f8a24b58699a88034b6f2cfac9d6dda641022d7bae62305ab760d474257c1136282b5b1ea820cea5600
-  data.tar.gz: b4592c8cfb3108e11329d6501257efc6732cb5bc407336cacb5d6590250351c333836e12f06e81961cbe1200dcab8cd5c2e17302958e0f26bbad3f37fc191d1f
+  metadata.gz: d606496e70c6d987723a99b0620b20fc68370c06d7e5d891bb870375d4d16c5dd5c43c761f235e22deeddad2130951d32048ff9089fc9db94a138c96b3b8d050
+  data.tar.gz: 5af5eee683dfa8717038a7fe275eebb11c82b0c2b82bf24962c9083ecc22dca82e666d4324d90e17bae7729a3f999c0e7d2f2267f1e2b4fc28e7758c333cd2c4

data/.gitlab-ci.yml

@@ -1,5 +1,9 @@
 image: "ruby:2.7"
 
+stages:
+  - release
+  - test
+
 before_script:
   - sudo apt-get update -qq && sudo apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
   - ruby -v
@@ -13,4 +17,23 @@ rspec:
 
 rubocop:
   script:
-    - bundle exec rubocop
+    - bundle exec rubocop
+
+release:
+  stage: release
+  rules:
+    - if: '$CI_COMMIT_TAG'
+  script:
+    - mkdir -p ~/.gem
+    - cp /builds/pub/nexus_cqrs.tmp/RUBYGEMS_CREDENTIALS ~/.gem/credentials
+    - chmod 0600 ~/.gem/credentials
+    - gem update --system
+    - ruby --version
+    - gem env version
+    - sed -i "s/0.1.0/$CI_COMMIT_TAG/g" lib/nexus_cqrs/version.rb
+    - gem build nexus_cqrs.gemspec
+    - gem push nexus_cqrs*.gem
+  artifacts:
+    paths:
+      - gitlab-styles*.gem
+    expire_in: 30 days

data/.rspec

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

data/Gemfile

@@ -9,3 +9,4 @@ gem 'rubocop-shopify', "~> 1.0.4", require: false
 gem 'rspec'
 gem "generator_spec"
 gem 'thread_safe'
+gem 'ibsciss-middleware'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nexus_cqrs (0.0.8)
+    nexus_cqrs (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -36,17 +36,13 @@ GEM
       railties (>= 3.0.0)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
+    ibsciss-middleware (0.4.2)
     loofah (2.6.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
     minitest (5.14.1)
-    multi_json (1.15.0)
-    net-scp (3.0.0)
-      net-ssh (>= 2.6.5, < 7.0.0)
-    net-ssh (6.1.0)
-    net-telnet (0.1.1)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     parallel (1.19.2)
@@ -79,9 +75,6 @@ GEM
     rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-its (1.3.0)
-      rspec-core (>= 3.0.0)
-      rspec-expectations (>= 3.0.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
@@ -100,17 +93,6 @@ GEM
     rubocop-shopify (1.0.4)
       rubocop (>= 0.85, < 0.87)
     ruby-progressbar (1.10.1)
-    serverspec (2.41.5)
-      multi_json
-      rspec (~> 3.0)
-      rspec-its
-      specinfra (~> 2.72)
-    sfl (2.3)
-    specinfra (2.82.19)
-      net-scp
-      net-ssh (>= 2.7)
-      net-telnet (= 0.1.1)
-      sfl
     thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
@@ -123,11 +105,11 @@ PLATFORMS
 
 DEPENDENCIES
   generator_spec
+  ibsciss-middleware
   nexus_cqrs!
   rspec
   rubocop
   rubocop-shopify (~> 1.0.4)
-  serverspec
   thread_safe
 
 BUNDLED WITH

data/README.md

@@ -29,6 +29,32 @@ Generators can be used to aide in the creation of Commands and Queries:
 
 Once installed, a CommandBus is required to control the flow of Commands and/or Queries:
 
+### Middleware
+
+Middleware can be created by extending the base middleware:
+
+```ruby
+class MyMiddleware < NexusCqrs::BaseMiddleware
+  def call(command)
+    @next.call(command)
+  end
+end
+```
+
+The above middleware will pass responsibility for execution to the next responder in the chain.
+
+For more information on writing middleware see: https://github.com/Ibsciss/ruby-middleware
+
+When creating a bus, middleware can be attached like so:
+
+```ruby
+middleware_stack = Middleware::Builder.new do |b|
+  b.use MyMiddleware
+end
+
+command_bus = Bus.new(middleware: middleware_stack)
+```
+
 ## Development
 
 To contribute to this gem, simple pull the repository, run `bundle install` and run tests:

data/lib/generators/nexus_cqrs/command_generator.rb

@@ -22,7 +22,7 @@ module NexusCqrs
         template('register_cqrs_handlers.rb', handler_config)
       end
 
-      code_to_inject = "$COMMAND_EXECUTOR.register_command(#{full_name}, #{full_name}Handler)"
+      code_to_inject = "$COMMAND_EXECUTOR.register_command(#{full_name}, #{full_name}Handler.new)\n"
 
       inject_into_file(handler_config, code_to_inject, after: "# Register Commands\n")
     end

data/lib/generators/nexus_cqrs/query_generator.rb

@@ -22,7 +22,7 @@ module NexusCqrs
         template('register_cqrs_handlers.rb', handler_config)
       end
 
-      code_to_inject = "$QUERY_EXECUTOR.register_command(#{full_name}, #{full_name}Handler)"
+      code_to_inject = "$QUERY_EXECUTOR.register_command(#{full_name}, #{full_name}Handler.new)\n"
 
       inject_into_file(handler_config, code_to_inject, after: "# Register Queries\n")
     end

data/lib/nexus_cqrs.rb

@@ -1,3 +1,5 @@
+require 'nexus_cqrs/base_message'
+require 'nexus_cqrs/base_middleware'
 require 'nexus_cqrs/base_command'
 require 'nexus_cqrs/base_command_handler'
 require 'nexus_cqrs/base_query'

data/lib/nexus_cqrs/base_command.rb

@@ -1,4 +1,4 @@
 module NexusCqrs
-  class BaseCommand
+  class BaseCommand < BaseMessage
   end
 end

data/lib/nexus_cqrs/base_message.rb

@@ -0,0 +1,28 @@
+module NexusCqrs
+  class BaseMessage
+    def set_metadata(key, value)
+      @metadata = {} unless @metadata
+      @metadata[key.to_sym] = value
+    end
+
+    def metadata
+      @metadata || {}
+    end
+
+    def to_h
+      hash = instance_variables.each_with_object({}) do |var, acc|
+        acc[var.to_s[1..-1].to_sym] = instance_variable_get(var)
+      end
+      hash[:metadata] = @metadata || {}
+      hash
+    end
+
+    def policy_class
+      demodularised_class_name + 'Policy'
+    end
+
+    def demodularised_class_name
+      self.class.name.split('::').last
+    end
+  end
+end

data/lib/nexus_cqrs/base_middleware.rb

@@ -0,0 +1,11 @@
+module NexusCqrs
+  class BaseMiddleware
+    def initialize(next_)
+      @next = next_
+    end
+
+    # @param [BaseMessage] message
+    def call(message)
+    end
+  end
+end

data/lib/nexus_cqrs/base_query.rb

@@ -1,4 +1,4 @@
 module NexusCqrs
-  class BaseQuery
+  class BaseQuery < BaseMessage
   end
 end

data/lib/nexus_cqrs/base_query_handler.rb

@@ -1,6 +1,6 @@
 module NexusCqrs
   class BaseQueryHandler
-    def call(command)
+    def call(query)
     end
   end
 end

data/lib/nexus_cqrs/command_bus.rb

@@ -1,13 +1,15 @@
 require 'thread_safe'
+require 'middleware'
 
 module NexusCqrs
   class CommandBus
     UnregisteredHandler = Class.new(StandardError)
     MultipleHandlers    = Class.new(StandardError)
 
-    def initialize
+    def initialize(middleware: nil)
       @handlers =
         ThreadSafe::Cache.new
+      @middleware = middleware || Middleware::Builder.new
     end
 
     def register(klass, handler)
@@ -17,19 +19,23 @@ module NexusCqrs
     end
 
     def call(command)
-      unregistered_handler = proc { raise UnregisteredHandler, "Missing handler for #{command.class}" }
-
-      handlers
-        .fetch(command.class, &unregistered_handler)
-        .call(command)
+      runner = Middleware::Builder.new
+      runner.use(@middleware)
+      runner.use(->(command_) { handler_for_command(command_).call(command_) })
+      runner.call(command)
     end
 
     def registered_handlers
       handlers
     end
 
+    attr_reader :handlers
+
     private
 
-    attr_reader :handlers
+    def handler_for_command(command)
+      unregistered_handler = proc { raise UnregisteredHandler, "Missing handler for #{command.class}" }
+      handlers.fetch(command.class, &unregistered_handler)
+    end
   end
 end

data/lib/nexus_cqrs/helpers.rb

@@ -7,12 +7,16 @@ module NexusCqrs
 
     # Executes a CQRS Query
     def query(query)
-      command_executor.execute(query)
+      query_executor.execute(query)
     end
 
     # Provide access to the CQRS executor
     def command_executor
       @command_executor ||= $COMMAND_EXECUTOR
     end
+
+    def query_executor
+      @query_executor ||= $QUERY_EXECUTOR
+    end
   end
 end

data/lib/nexus_cqrs/version.rb

@@ -1,3 +1,3 @@
 module NexusCqrs
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_cqrs
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Dean Lovett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -38,6 +39,8 @@ files:
 - lib/nexus_cqrs.rb
 - lib/nexus_cqrs/base_command.rb
 - lib/nexus_cqrs/base_command_handler.rb
+- lib/nexus_cqrs/base_message.rb
+- lib/nexus_cqrs/base_middleware.rb
 - lib/nexus_cqrs/base_query.rb
 - lib/nexus_cqrs/base_query_handler.rb
 - lib/nexus_cqrs/command_bus.rb
@@ -63,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Core package for the nexus cqrs gem