nexus_cqrs 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba82d98a3e3c930a35f6d06960be706925bf96db44766686fb2db3460649a792
-  data.tar.gz: 96ecd8dd6f98fb2637cc740d45a52a7c5f488e1f058fb7ff32215d4a7e050a57
+  metadata.gz: 22851e4cf72bdb9d4895163003f9ccaef81182f71ba64de7b9729c80f06ea40b
+  data.tar.gz: a39184dedf35d590ad9b7f3dab51facbd233fd5e9ec7ddeab27c714604c47018
 SHA512:
-  metadata.gz: d606496e70c6d987723a99b0620b20fc68370c06d7e5d891bb870375d4d16c5dd5c43c761f235e22deeddad2130951d32048ff9089fc9db94a138c96b3b8d050
-  data.tar.gz: 5af5eee683dfa8717038a7fe275eebb11c82b0c2b82bf24962c9083ecc22dca82e666d4324d90e17bae7729a3f999c0e7d2f2267f1e2b4fc28e7758c333cd2c4
+  metadata.gz: 5dd0e3cf9cb2014329a289bb94a9659144109988775709566996eb69aeaf663cc504ceb9cc83fb33b9e99fe2fc3e424c2584d0269d0b57564cecb148c1e0006c
+  data.tar.gz: 92497f3e118eb6bfad46e842fc0713fb64a8785ac0251296215003449593515c445de351c0afe9ff5f30efb9e5df1e0c4cf72c9c5c486ec253293c0e1e3094d4

data/.gitignore

@@ -9,3 +9,5 @@
 /.gem
 /spec/lib/tmp
 *.gem
+
+results/rubocop.html

data/.gitlab-ci.yml

@@ -25,7 +25,7 @@ release:
     - if: '$CI_COMMIT_TAG'
   script:
     - mkdir -p ~/.gem
-    - cp /builds/pub/nexus_cqrs.tmp/RUBYGEMS_CREDENTIALS ~/.gem/credentials
+    - cp $RUBYGEMS_CREDENTIALS ~/.gem/credentials
     - chmod 0600 ~/.gem/credentials
     - gem update --system
     - ruby --version
@@ -35,5 +35,5 @@ release:
     - gem push nexus_cqrs*.gem
   artifacts:
     paths:
-      - gitlab-styles*.gem
+      - nexus_cqrs*.gem
     expire_in: 30 days

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cqrs-core.gemspec

data/Gemfile.lock

@@ -1,104 +1,109 @@
 PATH
   remote: .
   specs:
-    nexus_cqrs (0.1.0)
+    nexus_cqrs (0.3.1)
+      generator_spec
+      ibsciss-middleware
+      thread_safe
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.3.2)
-      actionview (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.0.3.2)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     diff-lcs (1.4.4)
-    erubi (1.9.0)
+    erubi (1.10.0)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    i18n (1.8.5)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     ibsciss-middleware (0.4.2)
-    loofah (2.6.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      rake (>= 0.13)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.86.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.0.3, < 1.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
-    rubocop-shopify (1.0.4)
-      rubocop (>= 0.85, < 0.87)
-    ruby-progressbar (1.10.1)
-    thor (1.0.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-shopify (1.0.7)
+      rubocop (~> 1.4)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -62,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/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
 require 'bundler/gem_tasks'
 task(default: :spec)

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'cqrs/core'

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,25 @@
-command_bus = NexusCqrs::CommandBus.new
-query_bus = NexusCqrs::CommandBus.new
+# frozen_string_literal: true
+Rails.configuration.to_prepare do
+  middleware_stack = Middleware::Builder.new do |b|
+    b.use(NexusCqrsAuth::AuthMiddleware)
+  end
 
-$COMMAND_EXECUTOR = NexusCqrs::CommandExecutor.new command_bus
-$QUERY_EXECUTOR = NexusCqrs::CommandExecutor.new query_bus
+  command_bus = NexusCqrs::CommandBus.new(middleware: middleware_stack)
+  query_bus = NexusCqrs::CommandBus.new(middleware: middleware_stack)
 
-# Register Queries
+  $COMMAND_EXECUTOR = NexusCqrs::CommandExecutor.new(command_bus)
+  $QUERY_EXECUTOR = NexusCqrs::CommandExecutor.new(query_bus)
 
-# Register Commands
+  # 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,3 +1,4 @@
+# frozen_string_literal: true
 module NexusCqrs
   class BaseCommand < BaseMessage
   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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module NexusCqrs
   class BaseMessage
     def set_metadata(key, value)

data/lib/nexus_cqrs/base_middleware.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module NexusCqrs
   class BaseMiddleware
     def initialize(next_)

data/lib/nexus_cqrs/base_query.rb

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

data/lib/nexus_cqrs/base_query_handler.rb

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

data/lib/nexus_cqrs/command_bus.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'thread_safe'
 require 'middleware'
 
@@ -7,8 +8,7 @@ module NexusCqrs
     MultipleHandlers    = Class.new(StandardError)
 
     def initialize(middleware: nil)
-      @handlers =
-        ThreadSafe::Cache.new
+      @handlers = ThreadSafe::Cache.new
       @middleware = middleware || Middleware::Builder.new
     end
 
@@ -29,6 +29,10 @@ module NexusCqrs
       handlers
     end
 
+    def clear_handlers
+      @handlers = ThreadSafe::Cache.new
+    end
+
     attr_reader :handlers
 
     private

data/lib/nexus_cqrs/command_executor.rb

@@ -1,24 +1,73 @@
+# 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 do |i|
+          file.slice!(i)
+        end
+        begin
+          # Constantize class name to constant to force rails to autoload this class
+          file.camelize.constantize
+        rescue NameError
+          puts "WARN: Tried to autoregister #{file.camelize} but class could not be found"
+        end
+      end
 
-      register_commands
+      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
+          Rails.logger.error(
+            "WARN: A command `#{c}` tried to autoregister `#{handler_name}` but the class was not found"
+          )
+          next
+        end
+
+        if handler.respond_to?(:call)
+          register_command(c, handler)
+        else
+          Rails.logger.error(
+            "WARN: A command `#{c}` tried to autoregister `#{handler_name}` but `call` method did not exist"
+          )
+        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, 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.1.0'
+  VERSION = '0.3.1'
 end

data/lib/nexus_cqrs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'nexus_cqrs/base_message'
 require 'nexus_cqrs/base_middleware'
 require 'nexus_cqrs/base_command'

data/nexus_cqrs.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'lib/nexus_cqrs/version'
 
 Gem::Specification.new do |spec|
@@ -17,4 +18,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.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Dean Lovett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-30 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
@@ -66,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.31
 signing_key: 
 specification_version: 4
 summary: Core package for the nexus cqrs gem