nexus_cqrs 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24bafc3e27cbf1ef65d1e507bdb2798b67283c92c64b274bbf8818cfffa9618a
-  data.tar.gz: e653d3e7b76bc2173a780cf6128974afaecaba8278c0f39e56527ae442395cff
+  metadata.gz: c4e6e4a145007fe8658503e9745e3be716436749d9bea2c714bca1d47b1ea4ab
+  data.tar.gz: aedbcb7c36185faf7d546e3ea5c268cba6642d0880a0a2c2cdf612e761f5096c
 SHA512:
-  metadata.gz: 38a848d5da2a2a61116f1bb2f04df2fae1c0cb368e6482854e0f7896a9bfcd0b2baab39e58c223c2b1f5a1a0c62bc028c0dddf1d2daccebc7268010e9506559c
-  data.tar.gz: 6f7b0c32343f39b5b3eb61b9c4afb5cc338bbce81eeb5d998b0d0e1293fe1fa35984264f86ed8fbc8d1a0a29106602566a0ee00096951b4d54fc63ddb3d9f3d7
+  metadata.gz: 83c240bd9f056d0d82e5437f52c45527be6092e83f6356c765bfa127153d8d5c5c660437598707fb470879606ede7c9fc1a28f11e42355401b177c29b37e7c45
+  data.tar.gz: 0dab29f1d52e3f4110cfb948ffbe425c342f682c01f1945ceced2385aa022201e84c7025b1cc7eb633110029efdf4e7b5e0366baf2b7466183a164a040df5ff3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nexus_cqrs (0.1.0)
+    nexus_cqrs (0.3.0)
       generator_spec
       ibsciss-middleware
       thread_safe

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,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'
 

data/lib/nexus_cqrs/command_executor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module NexusCqrs
   class CommandExecutor
     # @param [NexusCqrs::CommandBus] command_bus
@@ -5,6 +6,45 @@ module NexusCqrs
       @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
+
+        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)

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.2.2'
+  VERSION = '0.3.0'
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_cqrs
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Dean Lovett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: generator_spec
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.2.31
 signing_key: 
 specification_version: 4
 summary: Core package for the nexus cqrs gem