nexus_cqrs 0.0.13 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdfe50446a77c51b914898af69e47f8cb90d5bbaf6b952570722bf22c5f1c216
-  data.tar.gz: 50117d1c8c04e2855a966357038ce57c71f39c527b240b36a57c5862058cc64e
+  metadata.gz: c4e6e4a145007fe8658503e9745e3be716436749d9bea2c714bca1d47b1ea4ab
+  data.tar.gz: aedbcb7c36185faf7d546e3ea5c268cba6642d0880a0a2c2cdf612e761f5096c
 SHA512:
-  metadata.gz: 8c2fce71a6eb75cf91a616dbaea01e6cc572a16d2ddc3d58036b61345e0c10d99120d24c15eb2c2fa02590131d4dc89ba2926ebd722a3d0555ff52de8801015b
-  data.tar.gz: 582a7d078d000a12fe16959bb20da9c4b65770d6dc6c4dc13e9e6f53aa5dce11768ba4b15771dd7e0c9dbec790fe8b547a35c7b38f4f7bd0b44b371395bf3d4d
+  metadata.gz: 83c240bd9f056d0d82e5437f52c45527be6092e83f6356c765bfa127153d8d5c5c660437598707fb470879606ede7c9fc1a28f11e42355401b177c29b37e7c45
+  data.tar.gz: 0dab29f1d52e3f4110cfb948ffbe425c342f682c01f1945ceced2385aa022201e84c7025b1cc7eb633110029efdf4e7b5e0366baf2b7466183a164a040df5ff3

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 $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:
+      - nexus_cqrs*.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,10 @@
 PATH
   remote: .
   specs:
-    nexus_cqrs (0.0.8)
+    nexus_cqrs (0.3.0)
+      generator_spec
+      ibsciss-middleware
+      thread_safe
 
 GEM
   remote: https://rubygems.org/
@@ -36,17 +39,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 +78,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 +96,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 +108,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:
@@ -36,4 +62,8 @@ To contribute to this gem, simple pull the repository, run `bundle install` and
 ```shell script
     bundle exec rspec
     bundle exec rubocop
-```
+```
+
+## Releasing
+
+The release process is tied to the git tags. Simply creating a new tag and pushing will trigger a new release to reubygems.

data/lib/generators/nexus_cqrs/USAGE

@@ -2,7 +2,7 @@ Description:
     Generates a new Query object, along with the QueryHandler
 
 Example:
-    rails generate cqrs:query GetUserById
+    rails generate cqrs:query GetUserById --permission
 
     This will create:
         app/domain/queries/get_user_by_id.rb

data/lib/generators/nexus_cqrs/command_generator.rb

@@ -1,30 +1,30 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module NexusCqrs
   class CommandGenerator < Rails::Generators::NamedBase
     source_root File.expand_path('templates', __dir__)
+    class_option :permission, type: :string, default: nil
 
     def copy_command_file
       file_path = class_name.underscore
 
+      @permission = options['permission']
+
       template('command.rb', "app/domain/commands/#{file_path}.rb")
       template('command_handler.rb', "app/domain/commands/#{file_path}_handler.rb")
 
-      register_command(class_name)
+      register_command
     end
 
     private
 
-    def register_command(full_name)
+    def register_command
       handler_config = 'config/initializers/register_cqrs_handlers.rb'
 
       unless File.exist?('config/initializers/register_cqrs_handlers.rb')
         template('register_cqrs_handlers.rb', handler_config)
       end
-
-      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
   end
 end

data/lib/generators/nexus_cqrs/query_generator.rb

@@ -1,30 +1,30 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module NexusCqrs
   class QueryGenerator < Rails::Generators::NamedBase
     source_root File.expand_path('templates', __dir__)
+    class_option :permission, type: :string, default: nil
 
     def copy_query_file
       file_path = class_name.underscore
 
+      @permission = options['permission']
+
       template('query.rb', "app/domain/queries/#{file_path}.rb")
       template('query_handler.rb', "app/domain/queries/#{file_path}_handler.rb")
 
-      register_query(class_name)
+      register_query
     end
 
     private
 
-    def register_query(full_name)
+    def register_query
       handler_config = 'config/initializers/register_cqrs_handlers.rb'
 
       unless File.exist?('config/initializers/register_cqrs_handlers.rb')
         template('register_cqrs_handlers.rb', handler_config)
       end
-
-      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
   end
 end

data/lib/generators/nexus_cqrs/templates/command_handler.rb

@@ -1,9 +1,26 @@
+# frozen_string_literal: true
 module Commands
-  class <%= class_name %>Handler < NexusCqrs::BaseCommandHandler
+  # Command handler
+  class <%= class_name %>Handler < BaseCommandHandler
+    <% if @permission %>include NexusCqrs::Helpers<% end %>
 
-    # call is where the Command is executed
+    # @param [<%= class_name %>] command
     def call(command)
+      <% if @permission %>authorize(command, Model)<% end %>
 
+      domain_event(command)
     end
+
+    private
+
+      def domain_event(command)
+        NexusDomainEvents::Event.new(
+          message_name: :ENTITY_WAS_ACTIONED,
+          actor: command.metadata[:current_user].member_id,
+          payload: {
+            object_id: command.id,
+          }
+        )
+      end
   end
 end

data/lib/generators/nexus_cqrs/templates/query_handler.rb

@@ -1,9 +1,10 @@
 module Queries
   class <%= class_name %>Handler < NexusCqrs::BaseQueryHandler
+    <% if @permission %>include NexusCqrs::Helpers<% end %>
 
-    # call is where the Query is executed
+    # @param [<%= class_name %>] command
     def call(command)
-
+      <% if @permission %>authorize(command, Model)<% end %>
     end
   end
 end

data/lib/generators/nexus_cqrs/templates/register_cqrs_handlers.rb

@@ -1,9 +1,26 @@
-command_bus = NexusCqrs::CommandBus.new
-query_bus = NexusCqrs::CommandBus.new
+# frozen_string_literal: true
+Rails.configuration.to_prepare do
 
-$COMMAND_EXECUTOR = NexusCqrs::CommandExecutor.new command_bus
-$QUERY_EXECUTOR = NexusCqrs::CommandExecutor.new query_bus
+  middleware_stack = Middleware::Builder.new do |b|
+    b.use(NexusCqrsAuth::AuthMiddleware)
+  end
 
-# Register Queries
+  command_bus = NexusCqrs::CommandBus.new(middleware: middleware_stack)
+  query_bus = NexusCqrs::CommandBus.new(middleware: middleware_stack)
 
-# Register Commands
+  $COMMAND_EXECUTOR = NexusCqrs::CommandExecutor.new(command_bus)
+  $QUERY_EXECUTOR = NexusCqrs::CommandExecutor.new(query_bus)
+
+  # Register Commands
+  $QUERY_EXECUTOR.configure_handlers do |executor|
+    # Manually registered queries should always go above the autoregister
+
+    executor.autoregister(NexusCqrs::BaseQuery, 'app/domain/queries')
+  end
+
+  $COMMAND_EXECUTOR.configure_handlers do |executor|
+    # Manually registered commands should always go above the autoregister
+
+    executor.autoregister(NexusCqrs::BaseCommand, 'app/domain/commands')
+  end
+end

data/lib/nexus_cqrs/base_command.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module NexusCqrs
-  class BaseCommand
+  class BaseCommand < BaseMessage
   end
 end

data/lib/nexus_cqrs/base_command_handler.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module NexusCqrs
   class BaseCommandHandler
     def call(command)

data/lib/nexus_cqrs/base_message.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+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,12 @@
+# frozen_string_literal: true
+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,5 @@
+# frozen_string_literal: true
 module NexusCqrs
-  class BaseQuery
+  class BaseQuery < BaseMessage
   end
 end

data/lib/nexus_cqrs/base_query_handler.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 module NexusCqrs
   class BaseQueryHandler
-    def call(command)
+    def call(query)
     end
   end
 end

data/lib/nexus_cqrs/command_bus.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
 require 'thread_safe'
+require 'middleware'
 
 module NexusCqrs
   class CommandBus
     UnregisteredHandler = Class.new(StandardError)
     MultipleHandlers    = Class.new(StandardError)
 
-    def initialize
-      @handlers =
-        ThreadSafe::Cache.new
+    def initialize(middleware: nil)
+      @handlers = ThreadSafe::Cache.new
+      @middleware = middleware || Middleware::Builder.new
     end
 
     def register(klass, handler)
@@ -17,19 +19,27 @@ module NexusCqrs
     end
 
     def call(command)
-      unregistered_handler = proc { raise UnregisteredHandler, "Missing handler for #{command.class}" }
-
-      handlers
-        .fetch(command.class.name, &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
 
-    private
+    def clear_handlers
+      @handlers = ThreadSafe::Cache.new
+    end
 
     attr_reader :handlers
+
+    private
+
+    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/command_executor.rb

@@ -1,24 +1,70 @@
+# frozen_string_literal: true
 module NexusCqrs
   class CommandExecutor
+    # @param [NexusCqrs::CommandBus] command_bus
     def initialize(command_bus)
       @bus = command_bus
+    end
+
+    def autoregister(base_class, dir = 'app/domain/commands', ignore_strings = ['.rb', 'app/domain/'])
+
+      # Iterate over the director passed and find all ruby files, removing unwanted parts of the string.
+      Dir["#{dir}/*.rb"].each do |file|
+        ignore_strings.each { |i|
+          file.slice!(i)
+        }
+        begin
+          # Constantize class name to constant to force rails to autoload this class
+          file.camelize.constantize
+        rescue NameError => e
+          puts "WARN: Tried to autoregister #{file.camelize} but class could not be found"
+        end
+      end
+
+      ObjectSpace.each_object(Class).select { |klass| klass < base_class }.each do |c|
+        handler_name = (c.to_s + "Handler")
+        begin
+          handler = handler_name.constantize.new
+        rescue NameError => e
+          Rails.logger.error "WARN: A command/query called `#{c}` tried to autoregister `#{handler_name}` but the class was not found"
+          next
+        end
 
-      register_commands
+        if handler.respond_to?(:call)
+          register_command(c, handler)
+        else
+          Rails.logger.error "WARN: A command/query called `#{c}` tried to autoregister `#{handler_name}` but the class did not have a `call` method"
+        end
+      end
     end
 
+    # Returns the bus used by this executor
+    #
+    # @return [NexusCqrs::CommandBus] command_bus
+    def command_bus
+      @bus
+    end
+
+    # @param [NexusCqrs::BaseCommand] command
     def execute(command)
       @bus.call(command)
     end
 
+    # @param [NexusCqrs::BaseCommandHandler] handler
     def register_command(klass, handler)
-      Rails.logger.debug("Registered #{klass} to #{handler}")
-      @bus.register(klass.name, handler)
+      @bus.register(klass, handler)
     end
 
-    private
+    def reregister_handlers
+      return if @register_handlers.nil?
+
+      @bus.clear_handlers
+      @register_handlers.call(self)
+    end
 
-    def register_commands
-      # TODO, Register Commands/Queries
+    def configure_handlers(&block)
+      @register_handlers = block
+      @register_handlers.call(self)
     end
   end
 end

data/lib/nexus_cqrs/helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module NexusCqrs
   module Helpers
     # Executes a CQRS Command

data/lib/nexus_cqrs/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module NexusCqrs
-  VERSION = '0.0.13'
+  VERSION = '0.3.0'
 end

data/lib/nexus_cqrs.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+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/nexus_cqrs.gemspec

@@ -17,4 +17,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.add_dependency('generator_spec')
+  spec.add_dependency('thread_safe')
+  spec.add_dependency('ibsciss-middleware')
 end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: nexus_cqrs
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.3.0
 platform: ruby
 authors:
 - Dean Lovett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
-dependencies: []
+date: 2021-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ibsciss-middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - dean.lovett@nexusmods.com
@@ -19,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -38,6 +81,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 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.31
 signing_key: 
 specification_version: 4
 summary: Core package for the nexus cqrs gem